Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Siden opdateres automatisk til at afspejle koden. CodeFirst.

...

Element

Type

Detaljer

Forekomst

Beskrivelse

x-civilRegistrationIdentifier [Header]
(PersonCivilRegistrationIdentifier)

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
Base: string

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
(CreateIllnessRequest)

CreateSygemeldingRequestDto
(CreateIllnessRequestType)

1

-    Sygemelding
(AbsenceItem)

SygemeldingType
(AbsenceItemType)

1

Angivelse af sygemeldingselementer.

-    -    Startdato
(StartDate)

dateTime

1

Startdato for fravær

-    -    Slutdato
(EndDate)

dateTime

0 - 1

Slutdato for fravær

-    -    fravaerType
(AbsenceTypeIdentifier)

FravaerTypeCodeList

CodeListItemIdentifierType
AbsenceTypeIdentifier
(AbsenceTypeIdentifierType)

MaxInclusive: 10000

1

Typeangivelse for fravær

-    -    Fravaerskommentar
(AbsenceComment)

FravaersKommentarType
Base: string

Length: 0-1500

0 - 1

Kommentar til fraværsoprettelsen

-    -    Fravaersafslutningsaarsag
(AbsenceCauseTypeIdentifier)

FravaersafslutningsaarsagTypeCodeList

CodeListItemIdentifierType
(AbsenceCauseTypeIdentifierType)

MaxInclusive: 10000

0 - 1

Identifikation af årsagstype for fravær.

-    -    Anmeldelsesdato
(NotificationDate)

dateTime

1

Anmeldelsesdato.

-    -    Ledighedsgrad
(CurrentUnemploymentStatusTypeIdentifier)

LedighedsgradTypeCodeList
(CurrentUnemploymentStatusTypeIdentifierType)

0 - 1

Ledighedsgrad.

-    -    Arbejdsgiver
(CompanyIdentifier)

ArbejdsgiverDto
(CompanyIdentifierType)

0 - 1

Virksomhedsinformation på borgers arbejdsgiver ved sygemelding fra beskæftigelse.

-    -    -    Pnummer
(ProductionUnitIdentifier)

ProductionUnitIdentifierType
Base: string

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
(CVRnumberIdentifier)

CVRnumberIdentifierType
Base: string

Length: 8

1

CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed.

-    -     AfmeldingAfmelding
(CancelEnrollmentItem)

CancelUnemploymentEnrollmentType
(CancelEnrollmentItemType)

0 - 1

Kombination af elementer i afmeldingen.

-    -    Afmeldedato    - Afmeldedato
(CancellationDate)

dateTime

1

Afslutningsdato for det aktuelle tilmeldeforhold.

-    -    -     AfmeldingsaarsagAfmeldingsaarsag
(RemovalCauseTypeIdentifier)

RemovalCauseTypeIdentifierType

1

Afmeldeårsag for det aktuelle tilmeldeforhold.

...

Element

Type

Detaljer

Forekomst

Beskrivelse

fravaerIdentifier [Path]
(AbsenceIdentifier)

uuid

 

1

 

x-civilRegistrationIdentifier [Header]
(PersonCivilRegistrationIdentifier)

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.

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

requestBody
(UpdateIllnessRequest)

UpdateSygemeldingRequestDto
(UpdateIllnessRequestType)

1

-    Sygemelding
(AbsenceItem)

SygemeldingType
(AbsenceItemType)

1

Angivelse af sygemeldingselementer.

-    -    Startdato
(StartDate)

dateTime

1

Startdato for fravær

-    -    Slutdato
(EndDate)

dateTime

0 - 1

Slutdato for fravær

-    -    fravaerType
(AbsenceTypeIdentifier)

AbsenceTypeIdentifierType

1

Typeangivelse for fravær

-    -    Fravaerskommentar
(AbsenceComment)

string

Length: 0-1500

0 - 1

Kommentar til fraværsoprettelsen

-    -    Fravaersafslutningsaarsag
(AbsenceCauseTypeIdentifier)

AbsenceCauseTypeIdentifierType

0 - 1

Afslutningsårsag for fravær

-    -    Anmeldelsesdato
(NotificationDate)

dateTime

1

Anmeldelsesdato.

-    -    Ledighedsgrad
(CurrentUnemploymentStatusTypeIdentifier)

CurrentUnemploymentStatusTypeIdentifierType

0 - 1

Ledighedsgrad.

  • -    Arbejdsgiver

(CompanyIdentifier)

ArbejdsgiverDto
(CompanyIdentifierType)

0 - 1

Virksomhedsinformation på borgers arbejdsgiver ved sygemelding fra beskæftigelse.

-    -    -    Pnummer
(ProductionUnitIdentifier)

ProductionUnitIdentifierType
Base: string

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
(CVRnumberIdentifier)

CVRnumberIdentifierType
Base: string

Length: 8

1

CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed.

-    Afmelding   -  Afmelding
(CancelEnrollmentItem)

CancelEnrollmentItemType

0 - 1

Kombination af elementer i afmeldingen.

-    -    Afmeldedato   -  Afmeldedato
(CancellationDate)

dateTime

1

Afslutningsdato for det aktuelle tilmeldeforhold.

-    -    Afmeldingsaarsag   -  Afmeldingsaarsag
(RemovalCauseTypeIdentifier)

RemovalCauseTypeIdentifierType

1

Afmeldeårsag for det aktuelle tilmeldeforhold.

...

>>>>>Herunder Jobnetspecifikke metoder som ikke er afklarede

ReportIllness (Sammenlægges med Createsygmelding? UDESTÅR)

Metoden giver mulighed at oprette en ny 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

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

ReportIllnessRequest

ReportIllnessRequestType

1

-    PersonCivilRegistrationIdentifier

PersonCivilRegistrationIdentifierType
Base: 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.

-    RegistrationDate

dateTime

1

Hændelsesdatoen for registreringen.

-    StartDate

dateTime

1

Startdato for registreringen.

-    EndDate

dateTime

0 - 1

Slutdato for registreringen.

-    CurrentUnemploymentStatusTypeIdentifier

CurrentUnemploymentStatusTypeIdentifierType

0 - 1

Ledighedsgrad.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

ReportIllnessResponse

ReportIllnessResponseType

1

-    IllnessReceipt

IllnessReceiptType

1

Kvittering for registreringen indeholdende.

-    -    EventDate

dateTime

1

Hændelsesdato for registreringen i det fælles datagrundlag.

-    -    IllnessIdentifier

guid
Base: string

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.

-    -    PersonNameStructure

PersonNameStructureType

1

Borgers navn.

-    -    PersonCivilRegistrationIdentifier

string

1

Borgers personnummer.

-    -    ReceiptText

string

Length: 0-3000

1

Kvitteringstekst.

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

4339

Only clients Tilmeldt uden ydelse can have the unemploymentstatus ikke ledig

Only clients Tilmeldt uden ydelse can have the unemploymentstatus ikke ledig

4614

The absence registration is not allowed due to invalid overlap between absence types

The absence registration is not allowed due to invalid overlap between absence types

4637

The reported absence overlaps an existing absence of the same type

The reported absence overlaps an existing absence of the same type

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

9337

Call to SetFlexijobApproved failed

Call to SetFlexijobApproved failed

9344

Missing or incorrect data, profile cannot be retrieved

Missing or incorrect data, profile cannot be retrieved

9345

Missing or incorrect data gives warning

Missing or incorrect data gives warning

ReportIllnessRecovery (Sammenlægges med CreateRaskmelding? UDESTÅR)

Metoden giver mulighed at raskmelde borgeren.

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

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

ReportIllnessRecoveryRequest

ReportIllnessRecoveryRequestType

1

-    PersonCivilRegistrationIdentifier

PersonCivilRegistrationIdentifierType
Base: 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.

-    RegistrationDate

dateTime

1

Hændelsesdatoen for registreringen.

-    IllnessIdentifier

guid
Base: string

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, hvorpå der skal foretages en raskmelding.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

ReportIllnessRecoveryResponse

ReportIllnessRecoveryResponseType

1

-    IllnessReceipt

IllnessReceiptType

1

Kvittering for registreringen indeholdende.

-    -    EventDate

dateTime

1

Hændelsesdato for registreringen i det fælles datagrundlag.

-    -    IllnessIdentifier

guid
Base: string

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.

-    -    PersonNameStructure

PersonNameStructureType

1

Borgers navn.

-    -    PersonCivilRegistrationIdentifier

string

1

Borgers personnummer.

-    -    ReceiptText

string

Length: 0-3000

1

Kvitteringstekst.

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

6006

There is no open illness from work for this person

There is no open illness from work for this person

9337

Call to SetFlexijobApproved failed

Call to SetFlexijobApproved failed

9346

Call to CVServiceForDFDG failed

Call to CVServiceForDFDG failed

ReportIllnessRecoveryAndBook (Komposit? UDESTÅR)

Metoden giver mulighed at raskmelde borgeren og samtidigt oprettet en booking.

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

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

ReportIllnessRecoveryAndBookRequest

ReportIllnessRecoveryAndBookRequestType

1

-    PersonCivilRegistrationIdentifier

PersonCivilRegistrationIdentifierType
Base: 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.

-    RegistrationDate

dateTime

1

Hændelsesdatoen for registreringen.

-    IllnessIdentifier

guid
Base: string

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, hvorpå der skal foretages en raskmelding.

-    SamtaleformType

InterviewContactTypeIdentifierType

0 - 1

Angivelse af afholdelsesform for indkaldelse.

-    BookingStartTime

dateTime

1

Starttidspunktet på booking.

-    InterviewOptionID

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

-    CaseWorkerIdentifier

string

0 - 1

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

ReportIllnessRecoveryAndBookResponse

ReportIllnessRecoveryAndBookResponseType

1

-    IllnessReceipt

IllnessReceiptType

1

Kvittering for registreringen indeholdende.

-    -    EventDate

dateTime

1

Hændelsesdato for registreringen i det fælles datagrundlag.

-    -    IllnessIdentifier

guid
Base: string

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.

-    -    PersonNameStructure

PersonNameStructureType

1

Borgers navn.

-    -    PersonCivilRegistrationIdentifier

string

1

Borgers personnummer.

-    -    ReceiptText

string

Length: 0-3000

1

Kvitteringstekst.

-    IndkaldelseId

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Identifier for den oprettede indkaldelse

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

4769

The connection to an external bookingsystem could not be established

The connection to an external bookingsystem could not be established

4783

The BookingTime cannot be before todays date

The BookingTime cannot be before todays date

4819

The BookingStartTime is no longer available

The BookingStartTime is no longer available

4822

Could not find the caseworker with the specified CVR-RID

Could not find the caseworker with the specified CVR-RID

6006

There is no open illness from work for this person

There is no open illness from work for this person

8108

The specified InterviewOptionID is not active or is unknown to the system

The specified InterviewOptionID is not active or is unknown to the system

8109

The booking time is NOT within the allowed range of dates for this interview option

The booking time is NOT within the allowed range of dates for this interview option

8111

An error occured when trying to look up the supplied PersonCivilRegistrationIdentifier

An error occured when trying to look up the supplied PersonCivilRegistrationIdentifier

8273

Citizen already has a booking of type Jobsamtale.

Citizen already has a booking of type Jobsamtale.

8288

Booking is later than deadline of existing InterviewDeadline with same InterviewType.

Booking is later than deadline of existing InterviewDeadline with same InterviewType.

9003

The interview supervisor specified is not allowed for this interview option

The interview supervisor specified is not allowed for this interview option

9018

Selfbooking failed because an External bookingsystem configuration is missing

Selfbooking failed because an External bookingsystem configuration is missing

9337

Call to SetFlexijobApproved failed

Call to SetFlexijobApproved failed

9346

Call to CVServiceForDFDG failed

Call to CVServiceForDFDG failed

GetSygefravaertilstand (Tidl. GetIllnessState)

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
(GetIllnessStateRequest)

GetSygdomStateRequestType

1

x-civilRegistrationIdentifier [Header]
(-    PersonCivilRegistrationIdentifierType)

string
(PersonCivilRegistrationIdentifierType)
Base: 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
(IsIllnessAllowed)

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