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 4 Current »

Siden opdateres automatisk til at afspejle koden.

Metoder

CreateSubJobcenter (POST /v1/Jobcenter/{jobcenterKode})

Metoden anvendes til at oprette et subjobcenter til et hovedjobcenter.

Tilladte organisationer

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

Scope

eksternedata.jobcenter.write

Input

ElementTypeDetaljerForekomstBeskrivelse
jobcenterKode [Path]int321hovedJobcenterKode
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
requestBodyCreateSubJobcenterRequestDto1
-    jobcenterNavnstringLength: 1-1001Jobcentrets navn.
-    telefonnummerstringPattern: (\+)?[0-9]{3,20}0 - 1Telefonnummer inkl.internationalt prefix
-    faxnummerstringPattern: (\+)?[0-9]{3,20}0 - 1Jobcentrets faxnummer
-    hjemmesidestringLength: 0-500 - 1Jobcentrets hjemmeside
-    adresseStrukturJobcenterAdresseDto0 - 1
-    -    vejnavnstringLength: 1-401Vejnavn.
-    -    bygningsnummerstringPattern: ^([1-9][0-9]{0,2}[a-zA-Z]?)(-[1-9][0-9]{0,2}[a-zA-Z]?)?$
MinLength: 1
1Numerisk husnummer, inklusive valgfri bogstav, som identificerer en bestemt adgang til en bygning, en grund eller et anlæg etc. Tillad eventuelt bindestreg (-): 14E-14F
-    -    etagestringPattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9]0 - 1Etagenummer
-    -    sideDoerstringLength: 1-40 - 1Dør-angivelse, fx th.
-    -    postnummerstringPattern: [0-9]{4}
MinLength: 1
1Navn på bygning
-    -    bynavnstringLength: 1-201Navn på bygning
-    -    landekodestringPattern: [a-z,A-Z]{3}|[a-z,A-Z]{2}|[0-9]{4}|[0-9]{3}0 - 1Dette er en støttetype til CountryIdentificationCodeType.
Det regulære udtryk er et valg for de 4 forskellige regulære udtryk for de forskellige formater. ISO 3166 standard, alpha 2: [a-z,A-Z]{2}.
Eksempel "DK" for Danmark. ISO 3166 standard, alpha 3: [a-z,A-Z]{3}. Eksempel "DKN" for Danmark. UN Statistics Divisions country codes: [0-9]{3}.
Eksempel "208" for Danmark AuthorityCode from the Central Office of Civil Registration: [0-9]{4}. Eksempel "5100" for Danmark.
-    jobcenterAabningstiderJobcenterAabningstiderDtoCollection1Jobcentrets åbningstider
-    -    JobcenterAabningstiderDtoJobcenterAabningstiderDto0 - *
-    -    -    ugedagint32Pattern: [1-7]{1}1Ugedag for angivelse af åbningstid og lukketid.
-    -    -    aabningstidspunktstringPattern: ((([0-1])([0-9]))|(([2])([0-3]))):([0-5])([0-9])|[ ]{5}
MinLength: 1
1Åbningstid
-    -    -    aabningstidSluttidspunktstringPattern: ((([0-1])([0-9]))|(([2])([0-3]))):([0-5])([0-9])|[ ]{5}
MinLength: 1
1Lukketid.
-    jobcenterTelefontiderSamlingJobcenterTelefontiderDtoCollection1Jobcentrets telefonåbningstider
-    -    JobcenterTelefontiderDtoJobcenterTelefontiderDto0 - *
-    -    -    ugedagint32Pattern: [1-7]{1}1Ugedag for angivelse af telefontid.
-    -    -    aabningstidspunktstringPattern: ((([0-1])([0-9]))|(([2])([0-3]))):([0-5])([0-9])|[ ]{5}
MinLength: 1
1Telefon åbningstid.
-    -    -    aabningstidSluttidspunktstringPattern: ((([0-1])([0-9]))|(([2])([0-3]))):([0-5])([0-9])|[ ]{5}
MinLength: 1
1Telefon åbningstid sluttidspunkt
-    jobcenterIntroduktionstekststringLength: 0-30000 - 1Introduktionstekst til jobcentret.

Output

ElementTypeDetaljerForekomstBeskrivelse
responseint321

Fejlkoder

FejlkodeFejltekstBeskrivelse
4459Validationerror- Max. 4 different opening hours for jobcenter allowedValidationerror- Max. 4 different opening hours for jobcenter allowed
4575You are not authorized to execute the operationYou are not authorized to execute the operation
4695Det angivne jobcenter findes ikkeDet angivne jobcenter findes ikke
70005
4700The weekday must be between 1 and 5The weekday must be between 1 and 5
4701The hour must be between 00:01 and 23:59. Opening hour must be before closing hourThe hour must be between 00:01 and 23:59. Opening hour must be before closing hour
9123Valid interval between 00:01 and 23:59 with no overlap and opening hour before closing hour.Valid interval between 00:01 and 23:59 with no overlap and opening hour before closing hour.
9124The time format is invalid. The allowed format is [HH:mm] (E.g. 13:45)The time format is invalid. The allowed format is [HH:mm] (E.g. 13:45)

GetJobcenterOplysninger (GET /v1/Jobcenter/{jobcenterKode})

Denne metode benyttes til at hente jobcenterets adresse, kontaktoplysninger, åbningstider, telefontider, som kan medsendes til eksempelvis dagpengemodtagere.

Scope

Ikke defineret

Input

ElementTypeDetaljerForekomstBeskrivelse
jobcenterKode [Path]int321

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetJobcenterOplysningerResponseDto1
-    jobcenterOplysningerGetJobcenterOplysningerDto1
-    -    jobcenterNavnstringLength: 1-1001Jobcentrets navn.
-    -    telefonnummerstringPattern: (\+)?[0-9]{3,20}0 - 1Telefonnummer inkl.internationalt prefix
-    -    faxnummerstringPattern: (\+)?[0-9]{3,20}0 - 1Jobcentrets faxnummer
-    -    hjemmesidestringLength: 0-500 - 1Jobcentrets hjemmeside
-    -    adresseStrukturJobcenterAdresseDto0 - 1
-    -    -    vejnavnstringLength: 1-401Vejnavn.
-    -    -    bygningsnummerstringPattern: ^([1-9][0-9]{0,2}[a-zA-Z]?)(-[1-9][0-9]{0,2}[a-zA-Z]?)?$
MinLength: 1
1Numerisk husnummer, inklusive valgfri bogstav, som identificerer en bestemt adgang til en bygning, en grund eller et anlæg etc. Tillad eventuelt bindestreg (-): 14E-14F
-    -    -    etagestringPattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9]0 - 1Etagenummer
-    -    -    sideDoerstringLength: 1-40 - 1Dør-angivelse, fx th.
-    -    -    postnummerstringPattern: [0-9]{4}
MinLength: 1
1Navn på bygning
-    -    -    bynavnstringLength: 1-201Navn på bygning
-    -    -    landekodestringPattern: [a-z,A-Z]{3}|[a-z,A-Z]{2}|[0-9]{4}|[0-9]{3}0 - 1Dette er en støttetype til CountryIdentificationCodeType.
Det regulære udtryk er et valg for de 4 forskellige regulære udtryk for de forskellige formater. ISO 3166 standard, alpha 2: [a-z,A-Z]{2}.
Eksempel "DK" for Danmark. ISO 3166 standard, alpha 3: [a-z,A-Z]{3}. Eksempel "DKN" for Danmark. UN Statistics Divisions country codes: [0-9]{3}.
Eksempel "208" for Danmark AuthorityCode from the Central Office of Civil Registration: [0-9]{4}. Eksempel "5100" for Danmark.
-    -    jobcenterAabningstiderJobcenterAabningstiderDtoCollection1Jobcentrets åbningstider
-    -    -    JobcenterAabningstiderDtoJobcenterAabningstiderDto0 - *
-    -    -    -    ugedagint32Pattern: [1-7]{1}1Ugedag for angivelse af åbningstid og lukketid.
-    -    -    -    aabningstidspunktstringPattern: ((([0-1])([0-9]))|(([2])([0-3]))):([0-5])([0-9])|[ ]{5}
MinLength: 1
1Åbningstid
-    -    -    -    aabningstidSluttidspunktstringPattern: ((([0-1])([0-9]))|(([2])([0-3]))):([0-5])([0-9])|[ ]{5}
MinLength: 1
1Lukketid.
-    -    jobcenterTelefontiderSamlingJobcenterTelefontiderDtoCollection1Jobcentrets telefonåbningstider
-    -    -    JobcenterTelefontiderDtoJobcenterTelefontiderDto0 - *
-    -    -    -    ugedagint32Pattern: [1-7]{1}1Ugedag for angivelse af telefontid.
-    -    -    -    aabningstidspunktstringPattern: ((([0-1])([0-9]))|(([2])([0-3]))):([0-5])([0-9])|[ ]{5}
MinLength: 1
1Telefon åbningstid.
-    -    -    -    aabningstidSluttidspunktstringPattern: ((([0-1])([0-9]))|(([2])([0-3]))):([0-5])([0-9])|[ ]{5}
MinLength: 1
1Telefon åbningstid sluttidspunkt
-    -    jobcenterIntroduktionstekststringLength: 0-30000 - 1Introduktionstekst til jobcentret.
-    -    erVirksomhedscenterboolean1Indikation på at subjobcentret er et virksomhedscenter

Fejlkoder

FejlkodeFejltekstBeskrivelse
4695Det angivne jobcenter findes ikkeDet angivne jobcenter findes ikke

UpdateJobcenterOplysninger (PUT /v1/Jobcenter/{jobcenterKode})

Denne metode benyttes til at gemme ændringer til jobcenterets adresse, kontaktoplysninger, åbningstider og/eller telefontider.

Tilladte organisationer

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

Scope

eksternedata.jobcenter.write

Input

ElementTypeDetaljerForekomstBeskrivelse
jobcenterKode [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
requestBodyUpdateJobcenterOplysningerRequestDto1
-    jobcenterNavnstringLength: 1-1001Jobcentrets navn.
-    telefonnummerstringPattern: (\+)?[0-9]{3,20}0 - 1Telefonnummer inkl.internationalt prefix
-    faxnummerstringPattern: (\+)?[0-9]{3,20}0 - 1Jobcentrets faxnummer
-    hjemmesidestringLength: 0-500 - 1Jobcentrets hjemmeside
-    adresseStrukturJobcenterAdresseDto0 - 1
-    -    vejnavnstringLength: 1-401Vejnavn.
-    -    bygningsnummerstringPattern: ^([1-9][0-9]{0,2}[a-zA-Z]?)(-[1-9][0-9]{0,2}[a-zA-Z]?)?$
MinLength: 1
1Numerisk husnummer, inklusive valgfri bogstav, som identificerer en bestemt adgang til en bygning, en grund eller et anlæg etc. Tillad eventuelt bindestreg (-): 14E-14F
-    -    etagestringPattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9]0 - 1Etagenummer
-    -    sideDoerstringLength: 1-40 - 1Dør-angivelse, fx th.
-    -    postnummerstringPattern: [0-9]{4}
MinLength: 1
1Navn på bygning
-    -    bynavnstringLength: 1-201Navn på bygning
-    -    landekodestringPattern: [a-z,A-Z]{3}|[a-z,A-Z]{2}|[0-9]{4}|[0-9]{3}0 - 1Dette er en støttetype til CountryIdentificationCodeType.
Det regulære udtryk er et valg for de 4 forskellige regulære udtryk for de forskellige formater. ISO 3166 standard, alpha 2: [a-z,A-Z]{2}.
Eksempel "DK" for Danmark. ISO 3166 standard, alpha 3: [a-z,A-Z]{3}. Eksempel "DKN" for Danmark. UN Statistics Divisions country codes: [0-9]{3}.
Eksempel "208" for Danmark AuthorityCode from the Central Office of Civil Registration: [0-9]{4}. Eksempel "5100" for Danmark.
-    jobcenterAabningstiderJobcenterAabningstiderDtoCollection1Jobcentrets åbningstider
-    -    JobcenterAabningstiderDtoJobcenterAabningstiderDto0 - *
-    -    -    ugedagint32Pattern: [1-7]{1}1Ugedag for angivelse af åbningstid og lukketid.
-    -    -    aabningstidspunktstringPattern: ((([0-1])([0-9]))|(([2])([0-3]))):([0-5])([0-9])|[ ]{5}
MinLength: 1
1Åbningstid
-    -    -    aabningstidSluttidspunktstringPattern: ((([0-1])([0-9]))|(([2])([0-3]))):([0-5])([0-9])|[ ]{5}
MinLength: 1
1Lukketid.
-    jobcenterTelefontiderSamlingJobcenterTelefontiderDtoCollection1Jobcentrets telefonåbningstider
-    -    JobcenterTelefontiderDtoJobcenterTelefontiderDto0 - *
-    -    -    ugedagint32Pattern: [1-7]{1}1Ugedag for angivelse af telefontid.
-    -    -    aabningstidspunktstringPattern: ((([0-1])([0-9]))|(([2])([0-3]))):([0-5])([0-9])|[ ]{5}
MinLength: 1
1Telefon åbningstid.
-    -    -    aabningstidSluttidspunktstringPattern: ((([0-1])([0-9]))|(([2])([0-3]))):([0-5])([0-9])|[ ]{5}
MinLength: 1
1Telefon åbningstid sluttidspunkt
-    jobcenterIntroduktionstekststringLength: 0-30000 - 1Introduktionstekst til jobcentret.

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
4459Validationerror- Max. 4 different opening hours for jobcenter allowedValidationerror- Max. 4 different opening hours for jobcenter allowed
4575You are not authorized to execute the operationYou are not authorized to execute the operation
4695Det angivne jobcenter findes ikkeDet angivne jobcenter findes ikke
4700The weekday must be between 1 and 5The weekday must be between 1 and 5
4701The hour must be between 00:01 and 23:59. Opening hour must be before closing hourThe hour must be between 00:01 and 23:59. Opening hour must be before closing hour
9122Name change is not allowed. Only DFDG is authorized to change the name of main jobcentersName change is not allowed. Only DFDG is authorized to change the name of main jobcenters
9123Valid interval between 00:01 and 23:59 with no overlap and opening hour before closing hour.Valid interval between 00:01 and 23:59 with no overlap and opening hour before closing hour.
9124The time format is invalid. The allowed format is [HH:mm] (E.g. 13:45)The time format is invalid. The allowed format is [HH:mm] (E.g. 13:45)

GetJobcenterListe (GET /v1/Jobcenter)

Denne metode returnerer en liste indeholdende alle jobcentre, med oplysninger om det enkelte jobcenter. Dog kun jobcentre hvor der også er registreret adresseoplysninger.

Scope

Ikke defineret

Input

ElementTypeDetaljerForekomstBeskrivelse

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetJobcenterListeResponseDto1
-    jobcenterSamlingJobcenterDtoCollection1Liste over jobcentre
-    -    JobcenterDtoJobcenterDto0 - *
-    -    -    jobcenterkodeint32Pattern: [1-9][0-9]{4}1Jobcentres adresse
-    -    -    jobcenterOplysningerGetJobcenterOplysningerDto1
-    -    -    -    jobcenterNavnstringLength: 1-1001Jobcentrets navn.
-    -    -    -    telefonnummerstringPattern: (\+)?[0-9]{3,20}0 - 1Telefonnummer inkl.internationalt prefix
-    -    -    -    faxnummerstringPattern: (\+)?[0-9]{3,20}0 - 1Jobcentrets faxnummer
-    -    -    -    hjemmesidestringLength: 0-500 - 1Jobcentrets hjemmeside
-    -    -    -    adresseStrukturJobcenterAdresseDto0 - 1
-    -    -    -    -    vejnavnstringLength: 1-401Vejnavn.
-    -    -    -    -    bygningsnummerstringPattern: ^([1-9][0-9]{0,2}[a-zA-Z]?)(-[1-9][0-9]{0,2}[a-zA-Z]?)?$
MinLength: 1
1Numerisk husnummer, inklusive valgfri bogstav, som identificerer en bestemt adgang til en bygning, en grund eller et anlæg etc. Tillad eventuelt bindestreg (-): 14E-14F
-    -    -    -    -    etagestringPattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9]0 - 1Etagenummer
-    -    -    -    -    sideDoerstringLength: 1-40 - 1Dør-angivelse, fx th.
-    -    -    -    -    postnummerstringPattern: [0-9]{4}
MinLength: 1
1Navn på bygning
-    -    -    -    -    bynavnstringLength: 1-201Navn på bygning
-    -    -    -    -    landekodestringPattern: [a-z,A-Z]{3}|[a-z,A-Z]{2}|[0-9]{4}|[0-9]{3}0 - 1Dette er en støttetype til CountryIdentificationCodeType.
Det regulære udtryk er et valg for de 4 forskellige regulære udtryk for de forskellige formater. ISO 3166 standard, alpha 2: [a-z,A-Z]{2}.
Eksempel "DK" for Danmark. ISO 3166 standard, alpha 3: [a-z,A-Z]{3}. Eksempel "DKN" for Danmark. UN Statistics Divisions country codes: [0-9]{3}.
Eksempel "208" for Danmark AuthorityCode from the Central Office of Civil Registration: [0-9]{4}. Eksempel "5100" for Danmark.
-    -    -    -    jobcenterAabningstiderJobcenterAabningstiderDtoCollection1Jobcentrets åbningstider
-    -    -    -    -    JobcenterAabningstiderDtoJobcenterAabningstiderDto0 - *
-    -    -    -    -    -    ugedagint32Pattern: [1-7]{1}1Ugedag for angivelse af åbningstid og lukketid.
-    -    -    -    -    -    aabningstidspunktstringPattern: ((([0-1])([0-9]))|(([2])([0-3]))):([0-5])([0-9])|[ ]{5}
MinLength: 1
1Åbningstid
-    -    -    -    -    -    aabningstidSluttidspunktstringPattern: ((([0-1])([0-9]))|(([2])([0-3]))):([0-5])([0-9])|[ ]{5}
MinLength: 1
1Lukketid.
-    -    -    -    jobcenterTelefontiderSamlingJobcenterTelefontiderDtoCollection1Jobcentrets telefonåbningstider
-    -    -    -    -    JobcenterTelefontiderDtoJobcenterTelefontiderDto0 - *
-    -    -    -    -    -    ugedagint32Pattern: [1-7]{1}1Ugedag for angivelse af telefontid.
-    -    -    -    -    -    aabningstidspunktstringPattern: ((([0-1])([0-9]))|(([2])([0-3]))):([0-5])([0-9])|[ ]{5}
MinLength: 1
1Telefon åbningstid.
-    -    -    -    -    -    aabningstidSluttidspunktstringPattern: ((([0-1])([0-9]))|(([2])([0-3]))):([0-5])([0-9])|[ ]{5}
MinLength: 1
1Telefon åbningstid sluttidspunkt
-    -    -    -    jobcenterIntroduktionstekststringLength: 0-30000 - 1Introduktionstekst til jobcentret.
-    -    -    -    erVirksomhedscenterboolean1Indikation på at subjobcentret er et virksomhedscenter

Fejlkoder

FejlkodeFejltekstBeskrivelse
4695Det angivne jobcenter findes ikkeDet angivne jobcenter findes ikke

UpdateVirksomhedscenter (PUT /v1/Jobcenter/{jobcenterKode}/action/opdatervirksomhedscenter)

Metoden benyttes til at opdatere om et subjobcenter har status af virksomhedscenter.

Tilladte organisationer

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

Scope

eksternedata.jobcenter.write

Input

ElementTypeDetaljerForekomstBeskrivelse
jobcenterKode [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
requestBodyUpdateVirksomhedscenterRequestDto1
-    erVirksomhedscenterboolean1Indikation på at subjobcentret er et virksomhedscenter

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
4575You are not authorized to execute the operationYou are not authorized to execute the operation
4695Det angivne jobcenter findes ikkeDet angivne jobcenter findes ikke
70004Hovedjobcentret har allerede 1 virksomhedscenter. Der må kun være 1 per hovedjobcenterHovedjobcentret har allerede 1 virksomhedscenter. Der må kun være 1 per hovedjobcenter

GetJobcenterCodeList (GET /v1/Jobcenter/JobcenterCodeList)

Metoden benyttes til at hente jobcentre og relationen til kommunerne.

Scope

Ikke defineret

Input

ElementTypeDetaljerForekomstBeskrivelse

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetJobcenterCodeListResponseDto1
-    jobcenterJobcenterKommuneRelationDtoCollection1Liste over jobcentre og kommuner som jobcentret repræsenterer
-    -    JobcenterKommuneRelationDtoJobcenterKommuneRelationDto0 - *
-    -    -    jobcenterkodeint32Pattern: [0-9]{5}1Jobcentrets kode
-    -    -    jobcenternavnstringLength: 1-1001Jobcentrets navn
-    -    -    kommunerKommuneDtoCollection1Kommuner som jobcentret repræsenterer
-    -    -    -    KommuneDtoKommuneDto0 - *
-    -    -    -    -    kommunekodeint32Pattern: [0-9]{3}1Kommunekode

Fejlkoder

Ingen fejlkoder

  • No labels