Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Siden opdateres automatisk til at afspejle koden.

Metoder

GetProductionUnit (GET /pNumber)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

Ikke defineret

Input

ElementTypeDetaljerForekomstBeskrivelse
pNumber [Query]string1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetProductionUnitResponseDto1
-    cvrNumberstringMinLength: 11
-    productionUnitGetProductionUnitDetailsDto1
-    -    namestringLength: 1-801
-    -    mainAddressstring0 - 1
-    -    citystringLength: 1-801
-    -    municipalityCodeint32Length: 1-800 - 1
-    -    phoneNumberstring0 - 1
-    -    emailstringLength: 4-40 - 1
-    -    homePagestring0 - 1
-    -    descriptionstringLength: 0-5000 - 1
-    -    activityStateIdint321
-    -    isDisabledboolean0 - 1
-    -    idint321
-    -    pNumberstring0 - 1
-    -    customerNumberint320 - 1
-    -    visitAddressstring0 - 1
-    -    postalCodestring0 - 1
-    -    logoIdint320 - 1
-    -    createdTimestampdate-time0 - 1
-    -    lastUpdatedTimestampdate-time0 - 1
-    -    unregistrationTimestampdate-time0 - 1

Fejlkoder

FejlkodeFejltekstBeskrivelse
120033Generel fejlGenerel fejl

UpdateProductionUnit (PUT /pNumber)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

Ikke defineret

Input

ElementTypeDetaljerForekomstBeskrivelse
x-requestId [Header]string1Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars
requestBodyUpdateProductionUnitRequestDto1
-    cvrNumberstringMinLength: 11
-    productionUnitCreateProductionUnitDetailsDto1
-    -    namestringLength: 1-801
-    -    mainAddressstring0 - 1
-    -    citystringLength: 1-801
-    -    municipalityCodeint32Length: 1-800 - 1
-    -    phoneNumberstring0 - 1
-    -    emailstringLength: 4-40 - 1
-    -    homePagestring0 - 1
-    -    descriptionstringLength: 0-5000 - 1
-    -    logoIdint320 - 1
-    -    activityStateIdint321
-    -    isDisabledboolean0 - 1
-    -    pNumberstringMinLength: 11
-    -    visitAddressstringLength: 1-801
-    -    postalCodestringLength: 4-41

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
120033Generel fejlGenerel fejl
120212Inputtet følger ikke formatet for et CVR-nummer (8 cifre).Inputtet følger ikke formatet for et CVR-nummer (8 cifre).
120201CVR-nummeret findes ikke i CVR-registeret.CVR-nummeret findes ikke i CVR-registeret.
120202Forkerte data fra CVR-registeret.Forkerte data fra CVR-registeret.

DeleteProductionUnit (DELETE /pNumber)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

Ikke defineret

Input

ElementTypeDetaljerForekomstBeskrivelse
pNumber [Query]string1
x-requestId [Header]string1Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
120033Generel fejlGenerel fejl

CreateLogo (POST /logo/{pNumber})

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

Ikke defineret

Input

ElementTypeDetaljerForekomstBeskrivelse
pNumber [Path]string1
x-requestId [Header]string1Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars
requestBodyCreateProductionUnitLogoRequestDto1
-    logoProductionUnitLogoDto1
-    -    fileNamestring0 - 1
-    -    imagebase64Binary0 - 1
-    -    imageTypestring0 - 1

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
120033Generel fejlGenerel fejl
1014The submitted message is not validThe submitted message is not valid
120204Virksomheden findes ikke i databasen.Virksomheden findes ikke i databasen.

GetLogo (GET /logo/{pNumber})

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

Ikke defineret

Input

ElementTypeDetaljerForekomstBeskrivelse
pNumber [Path]string1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetProductionUnitLogoResponseDto1
-    logoGetProductionUnitLogoDto0 - 1
-    -    fileNamestring0 - 1
-    -    imagebase64Binary0 - 1
-    -    imageTypestring0 - 1
-    -    idint321

Fejlkoder

FejlkodeFejltekstBeskrivelse
120033Generel fejlGenerel fejl
1014The submitted message is not validThe submitted message is not valid

UpdateLogo (PUT /logo/{pNumber})

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

Ikke defineret

Input

ElementTypeDetaljerForekomstBeskrivelse
pNumber [Path]string1
x-requestId [Header]string1Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars
requestBodyUpdateProductionUnitLogoRequestDto1
-    logoProductionUnitLogoDto1
-    -    fileNamestring0 - 1
-    -    imagebase64Binary0 - 1
-    -    imageTypestring0 - 1

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
120033Generel fejlGenerel fejl
1014The submitted message is not validThe submitted message is not valid
120204Virksomheden findes ikke i databasen.Virksomheden findes ikke i databasen.

DeleteLogo (DELETE /logo/{pNumber})

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

Ikke defineret

Input

ElementTypeDetaljerForekomstBeskrivelse
pNumber [Path]string1
x-requestId [Header]string1Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
120033Generel fejlGenerel fejl
1014The submitted message is not validThe submitted message is not valid

GetLogoById (GET /logo/by-id/{id})

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

Ikke defineret

Input

ElementTypeDetaljerForekomstBeskrivelse
id [Path]int321

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetProductionUnitLogoByIdResponseDto1
-    logoGetProductionUnitLogoDto0 - 1
-    -    fileNamestring0 - 1
-    -    imagebase64Binary0 - 1
-    -    imageTypestring0 - 1
-    -    idint321

Fejlkoder

FejlkodeFejltekstBeskrivelse
120033Generel fejlGenerel fejl
1014The submitted message is not validThe submitted message is not valid

DeleteLogoById (DELETE /logo/by-id/{id})

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

Ikke defineret

Input

ElementTypeDetaljerForekomstBeskrivelse
id [Path]int321
x-requestId [Header]string1Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
120033Generel fejlGenerel fejl
1014The submitted message is not validThe submitted message is not valid

SearchProductionUnits (GET /search)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

Ikke defineret

Input

ElementTypeDetaljerForekomstBeskrivelse
PNumber [Query]stringLength: 10-100 - 1
Name [Query]stringLength: 1-3000 - 1
IncludeLockedCompanies [Query]boolean0 - 1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseSearchProductionUnitsResponseDto1
-    productionUnitsGetProductionUnitDetailsDtoCollection0 - 1
-    -    GetProductionUnitDetailsDtoGetProductionUnitDetailsDto0 - *
-    -    -    namestringLength: 1-801
-    -    -    mainAddressstring0 - 1
-    -    -    citystringLength: 1-801
-    -    -    municipalityCodeint32Length: 1-800 - 1
-    -    -    phoneNumberstring0 - 1
-    -    -    emailstringLength: 4-40 - 1
-    -    -    homePagestring0 - 1
-    -    -    descriptionstringLength: 0-5000 - 1
-    -    -    activityStateIdint321
-    -    -    isDisabledboolean0 - 1
-    -    -    idint321
-    -    -    pNumberstring0 - 1
-    -    -    customerNumberint320 - 1
-    -    -    visitAddressstring0 - 1
-    -    -    postalCodestring0 - 1
-    -    -    logoIdint320 - 1
-    -    -    createdTimestampdate-time0 - 1
-    -    -    lastUpdatedTimestampdate-time0 - 1
-    -    -    unregistrationTimestampdate-time0 - 1

Fejlkoder

FejlkodeFejltekstBeskrivelse
120033Generel fejlGenerel fejl

UpdateJobAdStatusFromBatch (PUT /v1/JobAdBatch/updatestatus)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

virksomhedsindsats.jobannonce.staronly.write

Input

ElementTypeDetaljerForekomstBeskrivelse
x-requestId [Header]string1Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars

Output

ElementTypeDetaljerForekomstBeskrivelse
responseUpdateJobAdStatusFromBatchResponseDto1
-    totalJobsint321
-    succeededJobsint321

Fejlkoder

FejlkodeFejltekstBeskrivelse
120033Generel fejlGenerel fejl

ArchiveToJobAdDeleted (PUT /v1/JobAdBatch/archivedeleted)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

virksomhedsindsats.jobannonce.staronly.write

Input

ElementTypeDetaljerForekomstBeskrivelse
jobAdId [Query]int321
isDeleteAutomatic [Query]boolean1
x-requestId [Header]string1Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
120033Generel fejlGenerel fejl

ArchiveJobAdStatus (PUT /v1/JobAdBatch/archivestatus)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

virksomhedsindsats.jobannonce.staronly.write

Input

ElementTypeDetaljerForekomstBeskrivelse
jobAdId [Query]int321
x-requestId [Header]string1Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
120033Generel fejlGenerel fejl

CleanUpArchive (PUT /v1/JobAdBatch/cleanuparchive)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

virksomhedsindsats.jobannonce.staronly.write

Input

ElementTypeDetaljerForekomstBeskrivelse
daysToKeepJobAds [Query]int321
x-requestId [Header]string1Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
120033Generel fejlGenerel fejl

CleanupJobAd (PUT /v1/JobAdBatch/cleanupjobad)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

virksomhedsindsats.jobannonce.staronly.write

Input

ElementTypeDetaljerForekomstBeskrivelse
jobAdId [Query]int321
x-requestId [Header]string1Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
120033Generel fejlGenerel fejl

GetJobAdsReadyToArchive (GET /v1/JobAdBatch/readytoarchive)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

virksomhedsindsats.jobannonce.staronly.read

Input

ElementTypeDetaljerForekomstBeskrivelse
daysToKeepJobAds [Query]int321

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetJobAdsReadyToArchiveResponseDto1
-    jobAdIdsint32Collection1
-    -    int32int320 - *

Fejlkoder

FejlkodeFejltekstBeskrivelse
120033Generel fejlGenerel fejl

GetQueuedAnkiroEvents (GET /v1/JobAdBatch/ankiroqueue)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

virksomhedsindsats.jobannonce.staronly.read

Input

ElementTypeDetaljerForekomstBeskrivelse

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetQueuedAnkiroEventsResponseDto1
-    eventsQueuedAnkiroEventDtoCollection1
-    -    QueuedAnkiroEventDtoQueuedAnkiroEventDto0 - *
-    -    -    jobAdIdint321
-    -    -    ankiroEventint321
-    -    -    createdAtdate-time1

Fejlkoder

FejlkodeFejltekstBeskrivelse
120033Generel fejlGenerel fejl

DeleteQueuedAnkiroEventsForJobAd (POST /v1/JobAdBatch/ankiroqueue)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

virksomhedsindsats.jobannonce.staronly.write

Input

ElementTypeDetaljerForekomstBeskrivelse
x-requestId [Header]string1Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars
requestBodyDeleteQueuedAnkiroEventsForJobAdRequestDto1
-    jobAdIdsint32Collection1
-    -    int32int320 - *

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
120033Generel fejlGenerel fejl

RegisterActiveBatchJob (POST /v1/JobAdBatch/registeractivebatchjob)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

virksomhedsindsats.jobannonce.staronly.write

Input

ElementTypeDetaljerForekomstBeskrivelse
x-requestId [Header]string1Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars
requestBodyRegisterActiveBatchJobRequestDto1
-    batchJobNamestringLength: 1-2551
-    staleThresholdSecondsint320 - 1

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
120033Generel fejlGenerel fejl
120100Instance of batch job is already active.Instance of batch job is already active.

DeleteActiveBatchJob (DELETE /v1/JobAdBatch/deleteactivebatchjob)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

virksomhedsindsats.jobannonce.staronly.write

Input

ElementTypeDetaljerForekomstBeskrivelse
batchJobName [Query]stringMaxLength: 2551
x-requestId [Header]string1Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
120033Generel fejlGenerel fejl
  • No labels