Siden opdateres automatisk til at afspejle koden. CodeFirst.
...
Element | Type | Detaljer | Forekomst | Beskrivelse | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
x-civilRegistrationIdentifier [Header] | string | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Beskrivelse af cpr | ||||||||
x-requestId [Header] | string |
| 1 | Unikt 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 | ||||||||
fravaerIdentifier[Route] | guid | Pattern: [requestBody | CreateSygemeldingRequestDto | 1 | ||||||||
- Sygemelding | SygemeldingType | 1 | Angivelse af sygemeldingselementer. | |||||||||
- fravaerIdentifier | guid | Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} | 0 - 1 | Nøgle for den tilhørende fraværsregistrering. | requestBody | CreateSygemeldingRequestDto | 1 | - Sygemelding | SygemeldingType | 1 | Angivelse af sygemeldingselementer. | Id hvis dette kendes eksternt på oprettelsestidspunktet |
- - Startdato | dateTime | 1 | Startdato for fravær | |||||||||
- - Slutdato | dateTime | 0 - 1 | Slutdato for fravær | |||||||||
- - fravaerType | FravaerTypeCodeList CodeListItemIdentifierType | MaxInclusive: 10000 | 1 | Typeangivelse for fravær | ||||||||
- - Fravaerskommentar | FravaersKommentarType | Length: 0-1500 | 0 - 1 | Kommentar til fraværsoprettelsen | ||||||||
- - Fravaersafslutningsaarsag | FravaersafslutningsaarsagTypeCodeList CodeListItemIdentifierType | MaxInclusive: 10000 | 0 - 1 | Identifikation af årsagstype for fravær. | ||||||||
- - Anmeldelsesdato | dateTime | 1 | Anmeldelsesdato. | |||||||||
- - Ledighedsgrad | LedighedsgradTypeCodeList | 0 - 1 | Ledighedsgrad. | |||||||||
- - Arbejdsgiver | ArbejdsgiverDto | 0 - 1 | Virksomhedsinformation på borgers arbejdsgiver ved sygemelding fra beskæftigelse. | |||||||||
- - - Pnummer | ProductionUnitIdentifierType | Length: 10 | 0 - 1 | En P-enhed får tildelt et entydigt identifikationsnummer, et P-nummer, som er et 10-cifret nummer. Et P-nummer vil altid være tilknyttet et CVR-nummer. | ||||||||
- - - cvrEnhedsid | CVRnumberIdentifierType | Length: 8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. | ||||||||
- - Afmelding | CancelUnemploymentEnrollmentType | 0 - 1 | Kombination af elementer i afmeldingen. | |||||||||
- - - Afmeldedato | dateTime | 1 | Afslutningsdato for det aktuelle tilmeldeforhold. | |||||||||
- - - Afmeldingsaarsag | 1 | Afmeldeårsag for det aktuelle tilmeldeforhold. |
...
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
| guid | Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} | 1 | Unik identifikation for den oprettede entitet |
CreateIllnessResponse | CreateIllnessResponseType | 1 | ||
- AbsenceIdentifier | guid | Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} | 1 | Nøgle for den tilhørende fraværsregistrering. |
ReportIllnessResponse | ReportIllnessResponseType |
| 1 | Response ved tilmelding fra Jobnet |
| IllnessReceiptType |
| 1 | Kvittering for registreringen indeholdende. |
| dateTime |
| 1 | Hændelsesdato for registreringen i det fælles datagrundlag. |
| guid | Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} | 1 | Unikt ID for sygemeldingen. |
| PersonNameStructureType |
| 1 | Borgers navn. |
| string |
| 1 | Borgers personnummer. |
| string | Length: 0-3000 | 0 - 1 | Kvitteringstekst .til borgeren |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1014 | Failed to validate message | The submitted message could not be validated |
1001 | Invalid cpr | The submitted cpr is either to long or short or contains data not interpretable as a date |
1010 | Unknown cpr | The submitted cpr is unknown to the system |
4322 | The cancellation date must be today, maximum 30 days after or 60 in case of a less intensive effort | The cancellation date must be today, maximum 30 days after or 60 in case of a less intensive effort |
4339 | Only clients Tilmeldt uden ydelse can have the unemploymentstatus ikke ledig | Only clients Tilmeldt uden ydelse can have the unemploymentstatus ikke ledig |
4340 | The submitted CauseTypeIdentifier is invalid | The submitted CauseTypeIdentifier is invalid |
4367 | The person is not enrolled | The person is not enrolled |
4405 | The person with specified cpr is dead | The person with specified cpr is dead |
4575 | You are not authorized | You are not authorized to execute the operation |
4685 | The reported absence has a start date before todays date | The reported absence has a start date before todays date |
4686 | This person must have an active contact group registration | This person must have an active contactgroupregistration |
4980 | Cause type identifier is required when setting illness end date | Cause type identifier is required when setting illness end date |
4966 | Registration cannot be completed because start date is more than 4 weeks in the past | Registration cannot be completed because start date is more than 4 weeks in the past |
4637 | The reported absence overlaps an existing absence of the same type | The reported absence overlaps an existing absence of the same type |
4990 | Illness is not possible because of open enrollment | Illness is not possible because of open enrollment |
5013 | Unemployment-level must be set when current ContactGroup is 1, Dagpengemodtager | Unemployment-level must be set when current ContactGroup is 1, Dagpengemodtager |
5014 | Unemployment-level only valid when current ContactGroup is 1, Dagpengemodtager | Unemployment-level only valid when current ContactGroup is 1, Dagpengemodtager |
5016 | Cvr number is required when contact group is 24, Sygedagpengemodtager for beskæftigelse | Cvr number is required when contact group is 24, Sygedagpengemodtager for beskæftigelse |
5019 | CVR and P number are not allowed for the contactgroup | CVR and P number are not allowed for the contactgroup |
5020 | Registration cannot be completed because start date is more than 60 days in the past | Registration cannot be completed because start date is more than 60 days in the past |
6052 | Codelist value is only for internal use | Codelist value is only for internal use |
7061 | AbsenceCause is not coherent with contact group. | AbsenceCause is not coherent with contact group. |
8082 | CVR is not valid for paper form. | CVR is not valid for paper form. |
9361 | AbsenceCause is illegal for this AbsenceType | AbsenceCause is illegal for this AbsenceType |
9362 | Illness NotificationDate must be today or earlier | Illness NotificationDate must be today or earlier |
...
Element | Type | Detaljer | Forekomst | Beskrivelse | |
---|---|---|---|---|---|
-civilRegistrationIdentifier [Header] | string | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Beskrivelse af cpr | |
x-requestId [Header] | string |
| 1 | Unikt 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 | |
fravaerIdentifier [Path] | uuid |
| 1 |
| |
requestBody | CreateSygemeldingRequestDto | 1 | |||
- Sygemelding | SygemeldingType | 1 | Angivelse af sygemeldingselementer. | ||
- - Startdato | dateTime | 1 | Startdato for fravær | ||
- - Slutdato | dateTime | 0 - 1 | Slutdato for fravær | ||
- - fravaerType | FravaerTypeCodeList CodeListItemIdentifierType | 1 | Typeangivelse for fravær | ||
- - Fravaerskommentar | FravaersKommentarType | Length: 0-1500 | 0 - 1 | Kommentar til fraværsoprettelsen | |
- - Fravaersafslutningsaarsag | FravaersafslutningsaarsagTypeCodeList CodeListItemIdentifierType | MaxInclusive: 10000 | 0 - 1 | Afslutningsårsag for fravær | |
- - Anmeldelsesdato | dateTime | 1 | Anmeldelsesdato. | ||
- - Ledighedsgrad | LedighedsgradTypeCodeList | 0 - 1 | Ledighedsgrad. | ||
(CompanyIdentifier) | ArbejdsgiverDto | 0 - 1 | Virksomhedsinformation på borgers arbejdsgiver ved sygemelding fra beskæftigelse. | ||
- - - Pnummer | ProductionUnitIdentifierType | Length: 10 | 0 - 1 | En P-enhed får tildelt et entydigt identifikationsnummer, et P-nummer, som er et 10-cifret nummer. Et P-nummer vil altid være tilknyttet et CVR-nummer. | |
- - - cvrEnhedsid | CVRnumberIdentifierType | Length: 8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. | |
- Tilmelding |
| 0 - 1 | Indeholder data til en registrering af tilmelding. | ||
| - Klientkategori
| GUID | 0 - 1 | Id som medsendes i de tilfælde hvor ekstern aftager har et lokalt id ved oprettelsen | |
- - Klientkategori | 1 | Typeangivelse for tilmeldekategori. | |||
- - Tilmeldingsdato | dateTime | 1 | Tilmeldedatoen hvor det angivne tilmeldeforhold starter. Dette er datoen, hvor den ledige har henvendt sig enten gennem Jobnet eller Jobcentret. | ||
- - Ledighedsgrad | 1 | Typeangivelse for ledighedsstatus ved tilmelding. | |||
- - Joboensker | JoboenskeDtoCollection | 1 | Liste af stillingsbetegnelser. | ||
- - - JoboenskeDto | JoboenskeDto | 0 - * | |||
- - - - ConceptUriDa | string | 1 | Unik ESCO STAR identifikation på stillingsbetegnelse. | ||
- - - - AliasIdentifier | guid | Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} | 0 - 1 | Unik ESCO STAR identifikation på alias. | |
- - - - HarUddannelse | boolean | 1 | Angivelse af om personen har uddannelse for den angivne stillingsbetegnelse. | ||
- - - - AarSidstBrugt | int | 1 | Angivelse hvornår personen senest var aktiv indenfor stillingen. | ||
- - - - maanederMedErfaring | int | 1 | Angivelse hvor mange måneder personen har erfaring fra stillingen. | ||
- - Emailadresse | EmailAddressIdentifierType | Pattern: ([^>\(\)\[\]\\,;:@\s]{0,191}@[^>\(\)\[\]\\,;:@\s]{1,64}) | 0 - 1 | Emailadresse som tidligere skulle angives ved tilmelding fra Jobnet for at kunne bekræfte timeldingen digitalt til borger. Løses med dialogmodul hvis vi ikke har emailadresse på borger | |
- Kontaktgruppe | KontaktgrupperDto | 0 - 1 | Angivelse af kontaktgruppeelement. ContactGroupIdentifier skal kun angives ved opdatering af eksisterende kontaktgruppe. | ||
- - kontaktgruppeId | guid | Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} | 1 | Unik nøgle for denne kontaktgruppe. | |
- - Starttidspunkt | dateTime | 1 | Startdato for kontaktgruppe. | ||
- - Sluttidspunkt | dateTime | 0 - 1 | Slutdato for kontaktgruppe. | ||
- - Haendelsestidspunkt | dateTime | 0 - 1 | Hændelsesdato for kontaktgruppen. | ||
- - kontaktgruppeType | VisiteringOgStatus.KontaktgruppeTypeCodeList [UDV] | MaxInclusive: 10000000 | 1 | Kontaktgruppen, som den ledige har på beregnings-tidspunkt. | |
- - berigtigelseskommentar | string | Length: 0-1500 | 0 - 1 | Kommentar til berigtigelse af en registrering. |
...
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
CreateRecoveryResponse | CreateRecoveryResponseType | 1 | ||
- AbsenceIdentifier | guid | Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} | 1 | Nøgle for den tilhørende fraværsregistrering. |
- EnrollmentIdentifier | guid | Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} | 0 - 1 | Nøgle for den tilhørende tilmelderegistrering. |
- ContactGroupIdentifier | guid | Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} | 0 - 1 | Nøgle for den tilhørende kontaktgrupperegistrering. |
- EventDate | dateTime | 1 | Hændelsestidspunkt for registrering I DFDG. | |
ReportIllnessRecoveryResponse | ReportIllnessRecoveryResponseType |
| 1 | Response ved kald fra Jobnet |
| IllnessReceiptType |
| 1 | Kvittering for registreringen indeholdende. |
| dateTime |
| 1 | Hændelsesdato for registreringen i det fælles datagrundlag. |
| guid | Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} | 1 | Unikt ID for sygemeldingen. |
| PersonNameStructureType |
| 1 | Borgers navn. |
| string |
| 1 | Borgers personnummer. |
| string | Length: 0-3000 | 0 - 1 | Kvitteringstekst .til borgeren |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1001 | Invalid cpr | The submitted cpr is either to long or short or contains data not interpretable as a date |
1010 | Unknown cpr | The submitted cpr is unknown to the system |
1014 | Failed to validate message | The submitted message could not be validated |
4313 | Invalid client category type | The submitted client category type is no recognized as a valid client category type |
4314 | Invalid current unemployment status type identifier | The submitted identifier is not recognized as a valid unemployment status type identifier |
4316 | Enrollment overlap | The submitted enrollment date lies within or before an existing enrollment period |
4318 | One or more profession is invalid | The submitted request contains one or more invalid profession identifiers |
4405 | The person with specified cpr is dead | The person with specified cpr is dead |
4417 | Client must be a member of an unemploymentfund to be an unemploymentfundrecipient | Client must be a member of an unemploymentfund to be an unemploymentfundrecipient |
4615 | This absenceregistration must have an end-date | This absenceregistration must have an end-date |
4637 | The reported absence overlaps an existing absence of the same type | The reported absence overlaps an existing absence of the same type |
4645 | This person has a absenceregistration that conflicts with this Contactgroup | This person has a absenceregistration that conflicts with this Contactgroup |
4646 | The ContactGroupTypeIdentifier cannot be changed | The ContactGroupTypeIdentifier cannot be changed |
4647 | The Startdate cannot be changed | The Startdate cannot be changed |
4648 | The Enddate cannot be before todays date | The Enddate cannot be before todays date |
4669 | The enddate must not be earlier than the start date | The enddate must not be earlier than the start date |
4685 | The reported absence has a start date before todays date | The reported absence has a start date before todays date |
4686 | This person must have an active contact group registration | This person must have an active contactgroupregistration |
4698 | Parameter is negative | Parameter is negative |
4710 | The submitted value of YearLastUsed is not a valid year | The submitted value of YearLastUsed is not a valid year |
4725 | This person cannot be enrolled because the person has a temporary foreign address registered | This person cannot be enrolled because the person has a temporary foreign address registered |
4749 | The enrollment date must be of todays date | The enrollment date must be of todays date |
4750 | The client has an absence registration that does not allow enrollment | The client has an absence registration that does not allow enrollment |
4919 | The contact group can not be ended due to an active enrollment | The contact group can not be ended due to an active enrollment |
4575 | You are not authorized | You are not authorized to execute the operation |
4731 | Registration is not allowed because of an illegal combination of the contactgroup and enrollment | Registration is not allowed because of an illegal combination of the contactgroup and enrollment |
4966 | Registration cannot be completed because start date is more than 4 weeks in the past | Registration cannot be completed because start date is more than 4 weeks in the past |
4980 | Cause type identifier is required when setting illness end date | Cause type identifier is required when setting illness end date |
4990 | Illness is not possible because of open enrollment | Illness is not possible because of open enrollment |
4992 | The person must be enrolled or contactgroup ended | The person must be enrolled or contactgroup ended |
4993 | The person has an open illness | The person has an open illness |
5010 | When absence end date is today, Enrollment date must not be today. | When absence end date is today, Enrollment date must not be today. |
6052 | Codelist value is only for internal use | Codelist value is only for internal use |
7061 | AbsenceCause is not coherent with contact group. | AbsenceCause is not coherent with contact group. |
8063 | EventTime must be equal to or before contactgroup start. | EventTime must be equal to or before contactgroup start. |
8065 | EventTime can not be changed. | EventTime can not be changed. |
9148 | The current category does not allow enrollment. | The current category does not allow enrollment. |
9331 | It is not allowed to create the ContactGroup for jobcenter | It is not allowed to create the ContactGroup for jobcenter |
9361 | AbsenceCause is illegal for this AbsenceType | AbsenceCause is illegal for this AbsenceType |
...
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1001 | Invalid cpr | The submitted cpr is either to long or short or contains data not interpretable as a date |
1010 | Unknown cpr | The submitted cpr is unknown to the system |
1014 | Failed to validate message | The submitted message could not be validated |
4405 | The person with specified cpr is dead | The person with specified cpr is dead |
4575 | You are not authorized | You are not authorized to execute the operation |
9171 | The additional information registration does not exist | The additional information registration does not exist |
9172 | The additionalInformationOnAbsenceTypeIdentifier cant be changed | The additionalInformationOnAbsenceTypeIdentifier cant be changed |
DeleteSygemelding (DELETE /v1/Sygemelding/{fravaerIdentifier}/{Berigtigelseskommentar})
Denne metode bruges til at slette en sygemelding
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
---|---|---|---|---|---|---|---|---|
A-kasse |
| X |
|
|
|
|
|
|
JobCenter |
| X |
|
| X |
|
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
visiteringogstatus.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
x-civilRegistrationIdentifier [Header] | string | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Beskrivelse af cpr |
x-requestId [Header] | string |
| 1 | Unikt 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 |
Berigtigelseskommentar [Query] (CorrectionComment) | BerigtigelseskommentarType | Length: 0-1500 | 0 - 1 | Kommentarfelt til at beskrive en berigtigelse af en registering. |
Output
Standard empty response
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1001 | Invalid cpr | The submitted cpr is either to long or short or contains data not interpretable as a date |
xxx | Sygefravær kan kun slettes hvis de ikke har fået en Nemrefusionsidentifier endnu | |
9417 | A correction comment is required when deleting this type of a present or historic absence | A correction comment is required when deleting this type of a present or historic absence |
>>>>>Herunder Jobnetspecifikke metoder som ikke er afklarede
GetSygefravaertilstand (Tidl. GetIllnessState - forventes implementeret på VoSStatusService)
Metode til at hente hvilke muligheder borgeren har ift. registrering af sygdom - sygemelding.
Tilladte organisationer
Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere | |
---|---|---|---|---|---|---|---|---|
STAR | X |
Scope
visiteringogstatus.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetSygdomStateRequest | GetSygdomStateRequestType | 1 | ||
x-civilRegistrationIdentifier [Header] | string | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Borgers personnummer. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetSygdomStateResponse | GetSygdomStateResponseType | 1 | ||
- ErSygdomTilladt | boolean | 1 |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1001 | Invalid cpr | The submitted cpr is either to long or short or contains data not interpretable as a date |
1010 | Unknown cpr | The submitted cpr is unknown to the system |
1014 | Failed to validate message | The submitted message could not be validated |