Data Schemas

Shift Schema

{
  "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
  "startTime": "2024-01-15T09:00:00Z",
  "endTime": "2024-01-15T17:00:00Z",
  "outletId": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
  "outletName": "Downtown Location",
  "roleId": "6ba7b812-9dad-11d1-80b4-00c04fd430c8",
  "roleName": "Server",
  "slots": 3,
  "assignedCandidates": [
    { "candidateId": "6ba7b813-9dad-11d1-80b4-00c04fd430c8" },
    { "candidateId": "6ba7b814-9dad-11d1-80b4-00c04fd430c8" }
  ]
}

Field	Type	Description
id	string (UUID)	Unique shift identifier
startTime	string (ISO 8601)	Shift start time
endTime	string (ISO 8601)	Shift end time
outletId	string (UUID)	Outlet identifier
outletName	string	Human-readable outlet name
roleId	string (UUID)	Job role identifier
roleName	string	Human-readable role name
slots	number	Number of positions to fill
assignedCandidates	array	Currently assigned candidates

Note

All IDs should be UUIDs. The outletId and roleId are used for entity mapping.

Candidate Schema

{
  "id": "6ba7b813-9dad-11d1-80b4-00c04fd430c8",
  "personalNumber": "YYYYMMDDXXXX",
  "firstName": "John",
  "lastName": "Doe",
  "address": "123 Main St",
  "postCode": "12345",
  "city": "Stockholm",
  "countryCode": "se",
  "email": "john@example.com",
  "phone": "+46701234567",
  "clearingNumber": "1234",
  "bankAccountNumber": "1234567890"
}

Field	Type	Description
id	string (UUID)	Candidate identifier in provider system
personalNumber	string	Swedish personal number (YYYYMMDDXXXX)
firstName	string	First name
lastName	string	Last name
address	string	Street address
postCode	string	Postal code
city	string	City
countryCode	string	ISO country code (e.g., “se”)
email	string	Email address
phone	string	Phone number (E.164 format recommended)
clearingNumber	string	Bank clearing number
bankAccountNumber	string	Bank account number

Extended Candidate Schema

For new candidate registration, additional fields are supported. See New Candidate Registration for details.