Versions Compared

Key

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

Siden opdateres automatisk til at afspejle koden. er manuelt oprettet og opdateres kun manuelt

Metoder

Table of Contents
maxLevel2

CreateFravaer

Denne metode bruges til at oprette en fraværsregistrering som ikke er sygdomsrelateret

Scope

Ikke defineret

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

requestBody

1

- FravaerType
(AbsenceTypeIdentifier)

CodeListItemIdentifierType AbsenceTypeIdentifier

MaxInclusive: 10000

1

Typeangivelse for fravær.

- Startdato
(StartDate)

dateTime

1

Startdato for fravær

- Slutdato
(EndDate)

dateTime

0 - 1

Slutdato for fravær

- Fravaerskommentar
(AbsenceComment)

AbsenceCommentType
Base: string

Length: 0-1500

0 - 1

Kommenteret fravær.

- Anmeldelsesdato
(NotificationDate)

dateTime

1

Anmeldelsesdato

- Fravaersafslutningsaarsag
(AbsenceCauseTypeIdentifier)

CodeListItemIdentifierType AbsenceCauseTypeIdentifier

MaxInclusive: 10000

0 - 1

Årsagen til at fraværet afsluttes

...

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

requestBody

1

- FravaerType
(AbsenceTypeIdentifier)

CodeListItemIdentifierType

MaxInclusive: 10000

1

Typeangivelse for fravær.

- Startdato
(StartDate)

dateTime

1

Startdato for fravær

- Slutdato
(EndDate)

dateTime

0 - 1

Slutdato for fravær

- FravaersKommentar Fravaerskommentar
AbsenceComment

FravaersKommentarTypeFravaerskommentarType
Base: string

Length: 0-1500

0 - 1

Kommenteret fravær.

- Anmeldelsesdato

(NotificationDate)

dateTime

1

Anmeldelsesdato

- Fravaersafslutningsaarsag

(AbsenceCauseTypeIdentifier)

CodeListItemIdentifierType AbsenceCauseTypeIdentifier

MaxInclusive: 10000

0 - 1

Årsagen til at fraværet afsluttes

- Berigtigelseskommentar
(CorrectionComment)

BerigtigelseskommentarType
(CorrectionCommentType)
Base: string

Length: 0-1500

0 - 1

Kommentarfelt til at beskrive en berigtigelse af en registering.

...

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

1003

Duration is negative

The reported duration is negative, start date is greater than end date

1010

Unknown cpr

The submitted cpr is unknown to the system

4334

The duration lies outside an active enrollment

The reported duration lies outside an active current enrollment

4335

Change not allowed, either the old date or new date lies before today

Change not allowed, either the old date or new date lies before today

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

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

4615

This absenceregistration must have an end-date

This absenceregistration must have an end-date

4618

This absence registration may not have a duration longer than 3 months

This absence registration may not have a duration longer than 3 months

4622

This absence registration may not have a duration longer than 30 days

This absence registration may not have a duration longer than 30 days

4623

This absence registration may not have a duration longer than 28 days

This absence registration may not have a duration longer than 28 days

4631

This absence registration may not have a duration longer than 54 weeks

This absence registration may not have a duration longer than 54 weeks

4632

The specified Absenceregistration is not known to the system

The specified Absenceregistration is not known to the system

4633

The end date when changing a reported absenceperiod cannot be in the past

The end date when changing a reported absenceperiod cannot be in the past

4635

The reported startdate is in the past and cannot be changed

The reported startdate is in the past and cannot be changed

4637

The reported absence overlaps an existing absence of the same type

The reported absence overlaps an existing absence of the same type

4638

This absence registration may not have a duration longer than 14 days

This absence registration may not have a duration longer than 14 days

4682

The specified absence is not registered with this client

The specified absence is not registered with this client

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

4688

This absence registration may not have a duration longer than 10 weeks

This absence registration may not have a duration longer than 10 weeks

4689

The client must be enrolled to register this absence type

The client must be enrolled to register this absence type

4690

The client must have a CV to register this absence type

The client must have a CV to register this absence type

4691

The reported absence has a start date before 13 days from todays date

The reported absence has a start date before 13 days from todays date

4693

The client must have a registered personcategory to register this absence type

The client must have a registered personcategory to register this absence type

4696

The absencetype cannot be different from the registred

The absencetype cannot be different from the registred

4704

This submitted enddate must be earlier than the 18th year birthday

This submitted enddate must be earlier than the 18th year birthday

4761

It is not possible to update this illness because enddate is in the past

It is not possible to update this illness because enddate is in the past

4771

Prevented from personal attendance is not allowed for people in this contactgroup

Prevented from personal attendance is not allowed for people in this contactgroup

4772

Expected full time work within 13 week is not allowed for people in this contactgroup

Expected full time work within 13 week is not allowed for people in this contactgroup

4773

Work partially resumed is not allowed for people in this contactgroup

Work partially resumed is not allowed for people in this contactgroup

4774

Planned operation within 13 weeks is not allowed for people in this contactgroup

Planned operation within 13 weeks is not allowed for people in this contactgroup

4775

Illness prevents personal attendance is not allowed for people in this contactgroup

Illness prevents personal attendance is not allowed for people in this contactgroup

4776

This absence registration may not have a duration longer than 13 weeks

This absence registration may not have a duration longer than 13 weeks

4796

Expected to return to full time within 14 days after next contact is not allowed for this contactgr

Expected to return to full time within 14 days after next contact is not allowed for this contactgroup

4797

Follow up with no contact is not allowed for people in this contactgroup/personcategory combination

Follow up with no contact is not allowed for people in this contactgroup/personcategory combination

4798

This absence registration may not have a duration longer than 15 weeks

This absence registration may not have a duration longer than 15 weeks

4795

The absence comment may not contain html

The absence comment may not contain html

4809

The correction comment may not contain html

The correction comment may not contain html

4939

This absence registration may not have a duration longer than 6 weeks

This absence registration may not have a duration longer than 6 weeks

4940

Absence work distribution is not allowed for people in this contactgroup/personcategory combination

Absence work distribution is not allowed for people in this contactgroup/personcategory combination

4941

Absence efterloen within 6 weeks is not allowed for people in this contactgroup/personcategory combi

Absence efterloen within 6 weeks is not allowed for people in this contactgroup/personcategory combination

4942

Absence pension within 6 weeks is not allowed for people in this contactgroup/personcategory combi

Absence pension within 6 weeks is not allowed for people in this contactgroup/personcategory combination

4943

Absence work within 6 weeks is not allowed for people in this contactgroup/personcategory combi

Absence work within 6 weeks is not allowed for people in this contactgroup/personcategory combination

4944

Absence maternity leave within 6 weeks not allowed for people in this contactgroup/personcat. combi

Absence maternity leave within 6 weeks is not allowed for people in this contactgroup/personcategory combination

4963

Registration cannot be completed because start date is in the past

Registration cannot be completed because start date is in the past

4964

Registration cannot be completed because start date is more than 7 days in the past

Registration cannot be completed because start date is more than 7 days in the past

4965

Registration cannot be completed because start date is more than 13 days in the past

Registration cannot be completed because start date is more than 13 days in the past

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

4967

Registration cannot be completed because start date is more than 8 weeks in the past

Registration cannot be completed because start date is more than 8 weeks in the past

4968

Registration cannot be completed because start date is before the latest person category

Registration cannot be completed because start date is before the latest person category

4969

Registration cannot be completed because end date is more than 7 days in the past

Registration cannot be completed because end date is more than 7 days in the past

4974

Vacation on socialaid is not allowed for people in this contactgroup/personcategory combination

Vacation on socialaid is not allowed for people in this contactgroup/personcategory combination

4980

Cause type identifier is required when setting illness end date

Cause type identifier is required when setting illness end date

4981

Absence comment required when updating illness start date and end date

Absence comment required when updating illness start date and end date

4990

Illness is not possible because of open enrollment

Illness is not possible because of open enrollment

6008

This absence registration may not have a duration longer than 190 days

This absence registration may not have a duration longer than 190 days

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.

8295

CorrectionComent is required when updating this absenceType

CorrectionComent is required when updating this absenceType

8296

This absence cannot be registered while there is an open InterviewDeadline

This absence cannot be registered while there is an open InterviewDeadline

8298

The StartDate cannot be updated.

The StartDate cannot be updated.

9173

This absence registration may not have a duration longer than 12 months

This absence registration may not have a duration longer than 12 months

9359

AbsenceCauseType is required when end date is set on Meeting program with unemployment fund.

AbsenceCauseType is required when end date is set on Meeting program with unemployment fund.

9360

Absence end date must be todays date or later

Absence end date must be todays date or later

9361

AbsenceCause is illegal for this AbsenceType

AbsenceCause is illegal for this AbsenceType

9376

AbsenceCauseType is specified without an absence end date

AbsenceCauseType is specified without an absence end date

9422

This absence registration may not have a duration longer than 6 months

This absence registration may not have a duration longer than 6 months

9423

This absence registration may not have a duration longer than 5 years

This absence registration may not have a duration longer than 5 years

9449

This absence registration may not have a duration longer than 5 days

This absence registration may not have a duration longer than 5 days

DeleteFravaer (DELETE /v1/GetFravaer/{x-requestId}/{RettelsesKommentar})

...

Denne metode bruges til at slette en fraværsregistrering

Scope

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

DeleteFravaerResponse
(DeleteAbsenceResponse)

DeleteFravaerResponseType
(DeleteAbsenceResponseType)

1

- ServiceKvitering
(ServiceReceipt)

ServiceKviteringType
(ServiceReceiptType)

1

Servicekvittering

- - EventDato
(EventDate)

dateTime

1

Tidspunkt for transaktionen eller registrering.

- - x-requestId
(MessageIdentifier)

guid
Base: string

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

1

Unik identifikation af transaktion eller registrering.

Element

Type

Detaljer

Forekomst

Beskrivelse

DeleteFravaerRequest
(DeleteAbsenceRequest)

DeleteFravaerRequestType
(DeleteAbsenceRequestType)

1

- x-requestId

guid
Base: x-civilRegistrationIdentifier [Header]

string

Pattern: ((((0[0-9a-fA-F]{8}-1-9]|1[0-9a-fA-F]{4}-9]|2[0-9a-fA-F]{4}-9]|3[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

1

Unik identifikation af transaktion eller registrering.

- RettelsesKommentar
(CorrectionComment)

RettelsesKommentarType
(CorrectionCommentType)
Base: string

Length: 0-1500

0 - 1

Kommentarfelt til at beskrive en berigtigelse af en registering.

Output

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

requestBody

1

  • Berigtigelseskommentar

(CorrectionComment)

BerigtigelseskommentarType
(CorrectionCommentType)
Base: string

Length: 0-1500

0 - 1

Kommentarfelt til at beskrive en berigtigelse af en registering.

Output

Standard empty response

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

4575

You are not authorized

You are not authorized to execute the operation

4632

The specified Absenceregistration is not known to the system

The specified Absenceregistration is not known to the system

4634

It is not allowed to delete this registration because the start date is in the past

It is not allowed to delete this registration because the start date is in the past

4682

The specified absence is not registered with this client

The specified absence is not registered with this client

4761

It is not possible to update this illness because enddate is in the past

It is not possible to update this illness because enddate is in the past

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

GetFravaer(GET /v1/GetFravaer/{x-civilRegistrationIdentifier}) ¤(Jesper verificering)

Denne metode bruges til at hente fraværsregistreringer

Scope

Ikke defineret

Input

...

Element

...

Type

...

Detaljer

...

Forekomst

...

Beskrivelse

...

GetFravaerResponse

...

GetFravaerResponseType

...

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

...

Beskrivelse af cpr

...

of a present or historic absence

GetFravaer(GET /v1/GetFravaer/{x-civilRegistrationIdentifier})

Denne metode bruges til at hente fraværsregistreringer

Scope

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

GetFravaerRequest

GetFravaerRequestType

1

Fravaer

FravaerDtoCollection

Samling af alle Fravaer brugeren har haft eller har lige nu

- FravaerType

(Absence)

FravaerType
(AbsenceType)

1

Indeholder data til en fraværsregistrering

- -  x-civilRegistrationIdentifier

GetFravaerRequest

GetFravaerRequestType

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

-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Borgers personnummer.

- - FravaersTypeId

[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

GetFravaerResponse

GetFravaerResponseType

1

Fravaer

FravaerDtoCollection

Samling af alle Fravaer brugeren har haft eller har lige nu

- FravaerType

(Absence)

FravaerType
(AbsenceType)

1

Indeholder data til en fraværsregistrering

- - FravaerType

(AbsenceTypeIdentifier)

CodeListItemIdentifierType

MaxInclusive: 10000

1

Typeangivelse for fravær.

- - StartDato Startdato

(StartDate)

dateTime

1

Startdato for fravær

- - SlutDato Slutdato

(EndDate)

dateTime

0 - 1

Slutdato for fravær

- - FravaersKommentar Fravaerskommentar

(AbsenceComment)

AbsenceCommentTypeFravaerskommentarType
Base: string

Length: 0-1500

0 - 1

Kommenteret fravær.

- - Anmeldelsesdato

(NotificationDate)

dateTime

1

Anmeldelsesdato

- - Fravaersafslutningsaarsag

(AbsenceCauseTypeIdentifier)

CodeListItemIdentifierType AbsenceCauseTypeIdentifier

MaxInclusive: 10000

0 - 1

Årsagen til at fraværet afsluttes

...

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

GetFravaer (GET /v1/GetFravaer/{x-civilRegistrationIdentifier}/{x-requestId})

...

Denne metode bruges til at hente specifik fraværsregistrering

...

Element

Type

Detaljer

Forekomst

Beskrivelse

GetFravaerResponse

GetFravaerResponseType

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

Beskrivelse af cpr

  • x-requestId [Path]

(MessageIdentifier)

guid
Base: string

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

1

Unik identifikation af transaktion eller registrering.

...

Element

Type

Detaljer

Forekomst

Beskrivelse

GetFravaerRequest

GetFravaerRequestType

1

  • FravaerType

(Absence)

FravaerType
(AbsenceType)

1

Indeholder data til en fraværsregistrering

  • -  x-civilRegistrationIdentifier

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.

  • - FravaersTypeId FravaerType

(AbsenceTypeIdentifier)

CodeListItemIdentifierType

MaxInclusive: 10000

1

Typeangivelse for fravær.

  • - StartDato Startdato

(StartDate)

dateTime

1

Startdato for fravær

  • - SlutDato Slutdato

(EndDate)

dateTime

0 - 1

Slutdato for fravær

  • - FravaersKommentar Fravaerskommentar

(AbsenceComment)

AbsenceCommentTypeFravaerskommentarType
Base: string

Length: 0-1500

0 - 1

Kommenteret fravær.

  • Anmeldelsesdato

(NotificationDate)

dateTime

1

Anmeldelsesdato

  • Fravaersafslutningsaarsag

(AbsenceCauseTypeIdentifier)

CodeListItemIdentifierType AbsenceCauseTypeIdentifier

MaxInclusive: 10000

0 - 1

Årsagen til at fraværet afsluttes

...