API docs by Redocly

Right To Work API (v1.1)

Download OpenAPI specification:

Enrollment API

updateEnrollment

path Parameters
siteId
required
string
externalId
required
string
Request Body schema: application/json
required
id
string
externalId
string
siteId
string
name
string
firstName
string
lastName
string
email
string
phone
string
firstDayAtSite
string <date>
lastDayAtSite
string <date>
rightToWork
string
Enum: "EU_CITIZEN" "SWE_WORK_PERMIT" "SWE_WORK_PERMIT_EXEMPTION_TEMPORARY_WORK_IN_CONNECTION_WITH_CONSTRUCTION" "SWE_WORK_PERMIT_EXEMPTION_ICT" "SWE_WORK_PERMIT_EXEMPTION_SPECIALIST" "SWE_WORK_PERMIT_EXEMPTION_LMA" "SWE_WORK_PERMIT_EXEMPTION_MACHINE_INSTALLATION_OR_REPAIR_EMERGENCY"
rightToWorkId
string
contractorName
string
contractorOrgNumber
string
contractorCountry
string
contractorFTaxNumber
string
mainContractorName
string
mainContractorOrgNumber
string
Array of objects (Document)
contact
string
contactEmail
string
contactPhone
string
projects
Array of strings

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "externalId": "string",
  • "siteId": "string",
  • "name": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phone": "string",
  • "firstDayAtSite": "2019-08-24",
  • "lastDayAtSite": "2019-08-24",
  • "rightToWork": "EU_CITIZEN",
  • "rightToWorkId": "string",
  • "contractorName": "string",
  • "contractorOrgNumber": "string",
  • "contractorCountry": "string",
  • "contractorFTaxNumber": "string",
  • "mainContractorName": "string",
  • "mainContractorOrgNumber": "string",
  • "documents": [
    ],
  • "contact": "string",
  • "contactEmail": "string",
  • "contactPhone": "string",
  • "projects": [
    ]
}

getEnrollment

path Parameters
siteId
required
string
externalId
required
string

Responses

enrollEnding

path Parameters
siteId
required
string
externalId
required
string
query Parameters
endDate
required
string <date>

Responses

updateEnrollmentById

path Parameters
id
required
string
Request Body schema: application/json
required
name
string
firstName
string
lastName
string
email
string
phone
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phone": "string"
}

enrollEndingById

path Parameters
id
required
string
query Parameters
endDate
required
string <date>

Responses

enroll

Request Body schema: application/json
required
id
string
externalId
string
siteId
string
name
string
firstName
string
lastName
string
email
string
phone
string
firstDayAtSite
string <date>
lastDayAtSite
string <date>
rightToWork
string
Enum: "EU_CITIZEN" "SWE_WORK_PERMIT" "SWE_WORK_PERMIT_EXEMPTION_TEMPORARY_WORK_IN_CONNECTION_WITH_CONSTRUCTION" "SWE_WORK_PERMIT_EXEMPTION_ICT" "SWE_WORK_PERMIT_EXEMPTION_SPECIALIST" "SWE_WORK_PERMIT_EXEMPTION_LMA" "SWE_WORK_PERMIT_EXEMPTION_MACHINE_INSTALLATION_OR_REPAIR_EMERGENCY"
rightToWorkId
string
contractorName
string
contractorOrgNumber
string
contractorCountry
string
contractorFTaxNumber
string
mainContractorName
string
mainContractorOrgNumber
string
Array of objects (Document)
contact
string
contactEmail
string
contactPhone
string
projects
Array of strings

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "externalId": "string",
  • "siteId": "string",
  • "name": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phone": "string",
  • "firstDayAtSite": "2019-08-24",
  • "lastDayAtSite": "2019-08-24",
  • "rightToWork": "EU_CITIZEN",
  • "rightToWorkId": "string",
  • "contractorName": "string",
  • "contractorOrgNumber": "string",
  • "contractorCountry": "string",
  • "contractorFTaxNumber": "string",
  • "mainContractorName": "string",
  • "mainContractorOrgNumber": "string",
  • "documents": [
    ],
  • "contact": "string",
  • "contactEmail": "string",
  • "contactPhone": "string",
  • "projects": [
    ]
}

getSites

Responses

Order API

order

Request Body schema: application/json
required
costCenter
string
email
string
firstName
string
lastName
string
phone
string
ordererEmail
string
orgNumber
string

Responses

Request samples

Content type
application/json
{
  • "costCenter": "string",
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "phone": "string",
  • "ordererEmail": "string",
  • "orgNumber": "string"
}