Oversiktsliste

Generell informasjon

Her finner du informasjon om tilgjengelige APIer for innsending av nye registreringer i oversiktslistene, samt uthenting av data fra disse.

Samtlige APIer er avhengig av kontraktId. Denne finner du under menypunktet Kontrakt -> Informasjon når du har valgt ønsket kontrakt i ELRAPP web.

Innsending av oversiktsliste

APIet for innsending tar inn en liste av objekter med properties som vist i eksemplet under. Du kan sende inn en liste med kun 1 objekt dersom du ønsker å sende inn 1 registrering av gangen. Du kan velge om du ønsker å sende datoInn og datoUt, dato og timer eller kun dato. Resterende properties er obligatoriske.

Eksempel på kall hvor dato og timer benyttes:

POST /oversiktsliste/v2/{kontraktId} HTTP/1.1
Content-Type: application/json
Authorization: ApiKey 1b9a1439-25ef-436e-8558-49ae982f9689

[
  {
    "Kortnummer": 12345633, //gyldig hmskortnummer
    "KontraktId": 4255,
    "DatoInn": null, // sendes inn som type DateTime eller null
    "DatoUt": null, // sendes inn som type DateTime eller null
    "Dato": "2021-01-16T00:00:00", // sendes inn som type DateTime eller null
    "Timer": 8, // anntall timer jobbet den dagen
    "Fornavn": "Test3", // fornavn til eier av hmskort
    "Etternavn": "testesen3", // etternavn til eier av hmskort
    "Orgnummer": "1",
    "Fdato": "1998-03-11", // fødselsdato til eier av hmskort
    "HmsUtlopsdato": "2025-03-11"
  }
]

Kallet returnerer en liste av innsendte objekter

[
"oversiktslisteObject": {
    "id": 5,
    "kortnummer": 12345634,
    "kontraktId": 4255,
    "datoInn": null,
    "datoUt": null,
    "dato": "2021-01-16T00:00:00",
    "timer": 7,
    "datoOpprettet": "2023-01-17T10:57:06.0528921+01:00",
    "opprettetAv": "JOSHAU",
    "fornavn": "Test3",
    "etternavn": "testesen3",
    "orgnummer": "1",
    "fdato": "1998-03-11",
    "hmsUtlopsdato": "2025-03-11T00:00:00"
  }
]

Uthenting av oversiktsliste

Uthenting basert på Orgnummer

GET /oversiktsliste/v2/{kontraktId}/entreprenor?Orgnummer=12345678 HTTP/1.1
Content-Type: application/json
Authorization: ApiKey 1b9a1439-25ef-436e-8558-49ae982f9689

Kallet returnerer en liste over registreringer basert på kontraktIdog Orgnummer

Uthenting basert på tidsperiode

GET /oversiktsliste/v2/{kontraktId}/periode HTTP/1.1
Content-Type: application/json
Authorization: ApiKey 1b9a1439-25ef-436e-8558-49ae982f9689

GET-endepunktet har 2 query-parametere. Disse er fraDato og tilDato disse oppgis i formatet år-måned-dato eksempel: 2023-01-12

Uthenting basert på dato

GET /oversiktsliste/v2/{kontraktId}/dato HTTP/1.1
Content-Type: application/json
Authorization: ApiKey 1b9a1439-25ef-436e-8558-49ae982f9689

GET-endepunktet har 1 query-parametere. Parametere er dato og oppgis i formatet år-måned-dato eksempel: 2023-01-12

GET-kallet returnerer en liste over registreringer på innsendt dato.

Uthenting alle på kontrakt

GET /oversiktsliste/v2/{kontraktId} HTTP/1.1
Content-Type: application/json
Authorization: ApiKey 1b9a1439-25ef-436e-8558-49ae982f9689

Kallet returnerer alle registreringer på valgt kontrakt. For å få tilgang til dette må brukeren bak API-nøkkelen ha en byggherre-rolle eller være tilknyttet hovedentreprenøren på kontrakten.

Uthenting basert på HMS-kort

GET /oversiktsliste/v2/{kontraktId}/kort HTTP/1.1
Content-Type: application/json
Authorization: ApiKey 1b9a1439-25ef-436e-8558-49ae982f9689

GET-endepunktet har 1 query-parametere. Parametere er kort og er ett 8 siffret nummer

GET-kallet returnerer en liste over registreringer på innsendt kortnummer.