Bruke API for å hente vakter fra Operativ Plan i Capitech
Her finner du informasjon om hvordan API kan benyttes for å hente ut planlagte vakter fra Operativ Plan i Capitech for gjenbruk i andre systemer.
Operativ Plan
er planlagte vakter på faktiske datoer i kalender, med eller uten ansatt tildelt.
Vakter kan legges inn direkte i Operativ Plan eller rulles ut til Operativ Plan fra “maler” i Grunnplan. Les mer om Operativ Plan her
Grunnplan
er “maler” med ansatte og vakter over x uker som rullerer. Disse kan rulles ut for ønskede perioder i Operativ Plan. Les mer om Grunnplaner her
I korte trekk
Logg på kundens API portal med en gyldig bruker med tilgang til API og hent ut et accessToken. Dette gjøres via endepunkt /api/public/v1/Access/login
F.eks dinbedrift.capitech.no/APIKjør en request mot API for Operativ plan med ønskede parameter for f. eks datointervall, klient (selskap) og evt. andre kriterier.
Dette gjøres via endepunkt api/public/v1/OperationalPlan
OperationalPlan API - OperationalPlan
Beskrivelse av Request parametere
Her er en beskrivelse og forklaring av hvilke parametre en kan benytte for å hente ut planlagte vakter. En kan få mer detaljer via mouseover på hhv. request parameter og retur felter i API oversikt.
Parameter | Påkrevd | Beskrivelse | Merknad |
|---|---|---|---|
accessToken | Ja | Token fra Login. | Kreves for å få svar på API request |
clientId | Ja | Klientnummer for hvilket firma en skal hente timer på | |
fromDate | Ja | Fradato for ønsket periode i format yyyy-mm-dd | Fra og med |
toDate | Ja | Tildato for ønsket periode i format yyyy-mm-dd | Til og med |
employeeIdFilter | Nei | Filter for å kun hente vakter på angitte ansattnr | Liste over ansattnr f.eks [10,50,80] |
departmentIdFilter | Nei | Filter for å hente kun vakter på angitte avdelingsnr | Liste over avdelinger f.eks [20,30,40] |
competenceIdFilter | Nei | Filter for å hente kun vakter med angitt kompetanse | Liste over kompetanse f.eks [12,18] |
taskIdFilter | Nei | Filter for å hente kun vakter på angitte arbeidsoppgaver | Liste over kompetanse f.eks [60,80,84,88] |
orderIdFilter | Nei | Filter for å hente kun vakter med angitt ordre | Liste over ordrer f.eks [10,12,16] |
projectIdFilter | Nei | Filter for å hente kun vakter med angitt prosjekt | Liste over prosjekter f.eks [200,210,310] |
subprojectIdFilter | Nei | Filter for å hente kun vakter med angitt underprosjekt | Liste over underprosjekter f.eks [60,62] |
phasetIdFilter | Nei | Filter for å hente kun vakter med angitt fase | Liste over faser f.eks [80,90] |
freeDimension1IdFilter | Nei | Filter for å hente kun vakter med Fri dimensjon 1 | Liste over fri dimensjon 1 f.eks [10,12,16] |
freeDimension2IdFilter | Nei | Filter for å hente kun vakter med Fri dimensjon 2 | Liste over fri dimensjon 2 f.eks [22,24,36] |
substituteProviderIdFilter | Nei | Filter for å hente kun vakter med angitt vikarbyrå | Liste over fri vikarbyrå f.eks [1,2] |
Returdata
Her er en beskrivelse og forklaring av returdata en får fra dette fravær API og hva det i praksis kan benyttes til.
Felt | Beskrivelse | Eksempel | Merknad |
|---|---|---|---|
Id | Id | 21211 | En unik id for hver enkelt vakt i Operativ Plan |
clientid | Klientnr | 100 | Klientnr er et unikt nr for hvert enkelt firma. For konsernkunder kjøres en request for hvert enkelt firma. |
createdOn | Opprettet dato og klokkeslett | 2025-07-10 08:02:00.000 |
|
createdBy | Brukernavn som opprettet vakten | trineg |
|
updatedOn | Sist endret dato og klokkeslett | 2025-07-11 14:05:00.000 |
|
updatedBy | Brukernavn som sist endret vakten | larsb |
|
name | Vakt navn | D7 |
|
description | Vakt beskrivelse | Dagvakt D7 |
|
notes | Notat | Forlenget en time fordi … | Notat på vakt |
start | Start dato og tid | 2026-02-07T12:00:00+01:00 |
|
end | Slutt | 2026-02-07T15:00:00+01:00 |
|
startTime |
| 07:00:00 |
|
endTime |
| 16:00:00 |
|
period |
| 07:00 - 16:00 |
|
shortDutyDescription | Kort vakt info | D7 - 07:00 til 16:00 |
|
longDutyDescription |
| D7 - 07:00 til 16:00 - Dagvakt |
|
hours | Timer | 8.5 | Vakt lengde netto |
newStart | Ikke i bruk pt |
|
|
newEnd | Ikke i bruk pt |
|
|
newHours | Ikke i bruk pt |
|
|
count | Antall vakter | 1 | Det kan finnes vakt med f.eks antall 4. Dette er kun aktuelt for ledige vakter uten ansatt |
substituteDutyId | Id på vikarvakt | 21286 | Om denne har verdi har vakten fått vikar |
previousDutyId | Id på opprinnelig vakt | 21285 | Om denne har verdi er dette en vikarvakt |
hasSubstituteNeed | Vikarbehov | true | Er meldt behov for vikar |
substituteProviderId | Vikarbyrå nr | 4 |
|
substituteProviderName | Vikarbyrå navn | Vikarius |
|
exchangeDutyId | Ikke i bruk pt |
|
|
shiftRotationRollOutId | Utrulling nr |
| Referanse til Grunnplan utrullingsnr |
dutyDefinitionId | Vakt Id | 26 | Id på vakt i register |
employeeid | Ansattnr | 103 | Om null er vakten ikke tildelt en ansatt (ledig) |
employeeFullName | ansattnavn | Ola Danielsen | |
employeeDepartmentId | Ansatt Avdelingsnr | 150 | Avdelingen den ansatte har som standard |
employeeDepartmentName | Ansatt Avdelingsnavn | Lager | Avdelingen den ansatte har som standard |
departmentId | Avdelingsnr | 595 | På denne vakten |
departmentId | Avdelingsnavn | Teknisk | På denne vakten |
competenceRoleId | Kompetanse Id | 15 |
|
competenceRoleName | Kompetanse navn | Kokk |
|
taskId | Arbeidsoppgave nr | 12 |
|
taskName | Arbeidsoppgave navn | Dokumentasjon |
|
orderId | Ordre nr | 80 |
|
orderName | Ordre navn | Bergheim 2108 |
|
projectId | Prosjekt nr | 200 |
|
projectName | Prosjektnavn | Svanvik Vest |
|
subProjectId | Underprosjekt nr | 15 | Underdimensjon av Prosjekt |
subProjectName | Underprosjekt navn | Svanvik Opsjon A |
|
phaseId | Fase nr | 10 | Underdimensjon av underprosjekt |
phaseName | Fase navn | Svanvik Tillegg |
|
freeDimension1Id | Fri dimensjon 1 nr | 10 |
|
freeDimension1Name | Fri dimensjon 1 navn | Ordinær |
|
freeDimension2Id | Fri dimensjon 2 nr | 50 |
|
freeDimension2Name | Fri dimensjon 2 navn |
|
|
Returnerer alle vakter innenfor angitt periode og filter som er angitt
Begrensninger
Om returdata overstiger 1000 records vil forespørselen avvises, avgrens med kortere datointervall eller andre filter for å redusere mengde.
Tips
Du kan se mer detaljer om API parametere og returdata i en demoløsning her Demosalg.capitech.no/API