Bruke API for å legge inn / oppdatere ansatte i Capitech

Her finner du informasjon om hvordan API kan benyttes for å legge inn ansatte i Capitech fra et eksternt system som kilde for ansatte. 

EmployeeAPI - upsertEmployee 

I dette API endepunktet kan en legge inn eller oppdatere ansatte for angitt klient (firma) 

Endepunktet er api/public/v1/Employee/upsertEmployee

Upsert prinsipp

Våre Upsert API endepunkter vil automatisk håndtere at evt. eksisterende record (ansatt i dette tilfelle) oppdateres dersom den finnes fra før, hvis den ikke finnes vil den automatisk opprettes som ny record. Dette gjør det enklere og mer effektivt å realisere integrasjoner da eksternt system ikke trenger å sjekke / vite om recorden finnes fra før eller ikke. 

Beskrivelse av Request parametere

Her er en beskrivelse og forklaring av hvilke parametre en kan benytte for å legge inn / oppdatere ansatte. En kan få mer detaljer via mouseover på hhv. request parameter og retur felter i API oversikt. 

Returdata

Her er en beskrivelse og forklaring av returdata en får fra dette API og hva det i praksis kan benyttes til. 

Eksempel på request

Her er et eksempel på en request med et minimum av data mot api/public/v1/Employee/upsertEmployee

{
"accessToken": "gyldigaccesstokenher",
"externalSystemId": "Agresso",
"clientId": 100,
"employeeId": 100888,
"fullName": "Line Hansen",
"firstName": null,
"surname": null,
"address1": "Bergtoppen 5",
"address2": null,
"countryCode": "NO",
"postalCode": "6500",
"cellphoneNumber": null,
"phoneNumber": null,
"phoneNumber2": null,
"emailAddress": null,
"gender": "K",
"socialSecurityNumber": null,
"employeeStartDate": null,
"employeeEndDate": null,
"employeeSeniorityDate": null,
"authenticationId": null,
"externalId": null,
"active": 0,
"wageGroupId": null,
"departmentId": null,
"taskId": null,
"costCarrierId": null,
"statisticsGroupCode": "F",
"externalCorrelationId": null
}