positions

Position records relate to a job title a person holds within an employment. This can be a temporary, casual or permanent position. A person normally holds one or more positions in an employment at any time

Add a Position

SecuritybearerAuth

Request

Request Body schema: application/vnd.api+json

Position to be added

object

Responses

200

Position Response

400

Bad Request

401

Unauthorized - Authorization Required

422

Unprocessable Entity

default

General Error

post/positions

Request samples

Payload
curl
C#
Java
PHP

application/vnd.api+json

{"data": {"type": "positions",
"attributes": {"startDate": "2001-11-17",
"toDate": "2002-11-30",
"positionTitle": "Office Manager",
"isTeaching": false,
"fullTimeHoursPerWeek": 35,
"fullTimeHoursPerAnnum": 1280,
"fullTimeDaysPerweek": 5,
"fullTimeDaysPerAnnum": 250,
"fullTimeWeeksPerAnnum": 37,
"EmploymentId": "Z0012",
"leavingDate": "2022-06-16",
"continuousServiceStartDate": "2022-06-16",
"employmentStatus": null,
"externalId": null
},
"relationships": {"employer": {"data": {"id": "1",
"type": "employers"
}
},
"person": {"data": {"id": "4b30b724-26e1-4fcb-90f0-92936523133c",
"type": "people"
}
},
"location": {"data": {"id": "4d07d27b-a4ea-4e40-b65f-c4fd73507bf5",
"type": "locations"
}
},
"payroll": {"data": {"id": "7fcba8e6-397f-4be2-a9f0-8d53fcf48ab5",
"type": "payrolls"
}
},
"employment": {"data": {"id": "906264f1-2dff-4f72-a10b-59918cf738d7",
"type": "employments"
}
}
}
}
}

Response samples

200
400
401
422
default

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions"
},
"data": {"0": {"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"type": "positions",
"attributes": {"startDate": "2001-11-17",
"toDate": "2002-11-30",
"positionTitle": "Office Manager",
"isTeaching": false,
"fullTimeHoursPerWeek": 35,
"fullTimeHoursPerAnnum": 1280,
"fullTimeDaysPerweek": 5,
"fullTimeDaysPerAnnum": 250,
"fullTimeWeeksPerAnnum": 37,
"EmploymentId": "Z0012",
"leavingDate": "2022-06-16",
"continuousServiceStartDate": "2022-06-16",
"employmentStatus": null,
"externalId": null
},
"relationships": {"employment": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/employments",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/employments",
"data": {"type": "employments",
"id": "322f1e59-573d-1d93-7c01-3b6303abe9be"
}
}
},
"employer": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/employer",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/employer"
},
"data": {"type": "employers",
"id": "69049d80-0887-fd71-2197-75605a257ce6"
}
},
"person": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/person",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/person"
},
"data": {"type": "people",
"id": "1dec1ded-116f-b026-4cd0-f3d8b771baed"
}
},
"location": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/location",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/location"
},
"data": {"type": "locations",
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
},
"payroll": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/payroll",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/payroll"
},
"data": {"type": "payrolls",
"id": "7fcba8e6-397f-4be2-a9f0-8d53fcf48ab5"
}
}
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}

Get Positions

SecuritybearerAuth

Request

query Parameters

page[number]	number >= 1 The page number Example: page[number]=1
page[size]	number >= 1 The number of items per page Example: page[size]=1

Responses

200

Positions response - Array

401

Unauthorized - Authorization Required

default

General Error

get/positions

Request samples

curl
C#
Java
PHP

Response samples

200
401
default

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions"
},
"data": [{"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03",
"type": "positions",
"attributes": {"startDate": "2001-11-17",
"toDate": "2002-11-30",
"positionTitle": "Office Manager",
"isTeaching": false,
"fullTimeHoursPerWeek": 35,
"fullTimeHoursPerAnnum": 1280,
"fullTimeDaysPerweek": 5,
"fullTimeDaysPerAnnum": 250,
"fullTimeWeeksPerAnnum": 37,
"EmploymentId": "Z0012",
"leavingDate": "2022-06-16",
"continuousServiceStartDate": "2022-06-16",
"employmentStatus": null,
"externalId": null
},
"relationships": {"employment": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/employments",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/employments",
"data": {"type": "employments",
"id": "322f1e59-573d-1d93-7c01-3b6303abe9be"
}
}
},
"employer": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/employer",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/employer"
},
"data": {"type": "employers",
"id": "69049d80-0887-fd71-2197-75605a257ce6"
}
},
"person": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/person",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/person"
},
"data": {"type": "people",
"id": "1dec1ded-116f-b026-4cd0-f3d8b771baed"
}
},
"location": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/location",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/location"
},
"data": {"type": "locations",
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
},
"payroll": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/payroll",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/payroll"
},
"data": {"type": "payrolls",
"id": "7fcba8e6-397f-4be2-a9f0-8d53fcf48ab5"
}
}
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}
]
}

Get Position by ID

Get Position by ID (Cintra Position ID)

SecuritybearerAuth

Request

path Parameters

required

string <guid>

Position ID

Example: 906264f1-2dff-4f72-a10b-59918cf738d7

Responses

200

Position Response

400

Bad Request

401

Unauthorized - Authorization Required

404

Not Found

422

Unprocessable Entity

default

General Error

get/positions{id}

Request samples

curl
C#
Java
PHP

Response samples

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions"
},
"data": {"0": {"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"type": "positions",
"attributes": {"startDate": "2001-11-17",
"toDate": "2002-11-30",
"positionTitle": "Office Manager",
"isTeaching": false,
"fullTimeHoursPerWeek": 35,
"fullTimeHoursPerAnnum": 1280,
"fullTimeDaysPerweek": 5,
"fullTimeDaysPerAnnum": 250,
"fullTimeWeeksPerAnnum": 37,
"EmploymentId": "Z0012",
"leavingDate": "2022-06-16",
"continuousServiceStartDate": "2022-06-16",
"employmentStatus": null,
"externalId": null
},
"relationships": {"employment": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/employments",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/employments",
"data": {"type": "employments",
"id": "322f1e59-573d-1d93-7c01-3b6303abe9be"
}
}
},
"employer": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/employer",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/employer"
},
"data": {"type": "employers",
"id": "69049d80-0887-fd71-2197-75605a257ce6"
}
},
"person": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/person",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/person"
},
"data": {"type": "people",
"id": "1dec1ded-116f-b026-4cd0-f3d8b771baed"
}
},
"location": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/location",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/location"
},
"data": {"type": "locations",
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
},
"payroll": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/payroll",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/payroll"
},
"data": {"type": "payrolls",
"id": "7fcba8e6-397f-4be2-a9f0-8d53fcf48ab5"
}
}
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}

Update an Existing Position

Update an existing position by ID (Cintra position ID)

SecuritybearerAuth

Request

path Parameters

required

string <guid>

Position ID

Example: 906264f1-2dff-4f72-a10b-59918cf738d7

Request Body schema: application/vnd.api+json

Position object that needs to be updated (partial update)

object

Responses

200

Position Response

400

Bad Request

401

Unauthorized - Authorization Required

404

Not Found

422

Unprocessable Entity

default

General Error

patch/positions{id}

Request samples

Payload
curl
C#
Java
PHP

application/vnd.api+json

{"data": {"type": "positions",
"attributes": {"startDate": "2001-11-17",
"toDate": "2002-11-30",
"positionTitle": "Office Manager",
"isTeaching": false,
"fullTimeHoursPerWeek": 35,
"fullTimeHoursPerAnnum": 1280,
"fullTimeDaysPerweek": 5,
"fullTimeDaysPerAnnum": 250,
"fullTimeWeeksPerAnnum": 37,
"EmploymentId": "Z0012",
"leavingDate": "2022-06-16",
"continuousServiceStartDate": "2022-06-16",
"employmentStatus": null,
"externalId": null
},
"relationships": {"employer": {"data": {"id": "1",
"type": "employers"
}
},
"person": {"data": {"id": "4b30b724-26e1-4fcb-90f0-92936523133c",
"type": "people"
}
},
"location": {"data": {"id": "4d07d27b-a4ea-4e40-b65f-c4fd73507bf5",
"type": "locations"
}
},
"payroll": {"data": {"id": "7fcba8e6-397f-4be2-a9f0-8d53fcf48ab5",
"type": "payrolls"
}
},
"employment": {"data": {"id": "906264f1-2dff-4f72-a10b-59918cf738d7",
"type": "employments"
}
}
},
"id": "906264f1-2dff-4f72-a10b-59918cf738d7"
}
}

Response samples

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions"
},
"data": {"0": {"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"type": "positions",
"attributes": {"startDate": "2001-11-17",
"toDate": "2002-11-30",
"positionTitle": "Office Manager",
"isTeaching": false,
"fullTimeHoursPerWeek": 35,
"fullTimeHoursPerAnnum": 1280,
"fullTimeDaysPerweek": 5,
"fullTimeDaysPerAnnum": 250,
"fullTimeWeeksPerAnnum": 37,
"EmploymentId": "Z0012",
"leavingDate": "2022-06-16",
"continuousServiceStartDate": "2022-06-16",
"employmentStatus": null,
"externalId": null
},
"relationships": {"employment": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/employments",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/employments",
"data": {"type": "employments",
"id": "322f1e59-573d-1d93-7c01-3b6303abe9be"
}
}
},
"employer": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/employer",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/employer"
},
"data": {"type": "employers",
"id": "69049d80-0887-fd71-2197-75605a257ce6"
}
},
"person": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/person",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/person"
},
"data": {"type": "people",
"id": "1dec1ded-116f-b026-4cd0-f3d8b771baed"
}
},
"location": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/location",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/location"
},
"data": {"type": "locations",
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
},
"payroll": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/payroll",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/payroll"
},
"data": {"type": "payrolls",
"id": "7fcba8e6-397f-4be2-a9f0-8d53fcf48ab5"
}
}
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}

Delete Position

SecuritybearerAuth

Request

path Parameters

required

string <guid>

Position ID

Example: 906264f1-2dff-4f72-a10b-59918cf738d7

Responses

204

400

Bad Request

401

Unauthorized - Authorization Required

404

Not Found

422

Unprocessable Entity

default

General Error

delete/positions{id}

Request samples

curl
C#
Java
PHP

Response samples

400
401
404
422
default

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/positions"
},
"errors": [{"id": "de4e1bd5-9223-435a-b56d-1b0190a12313",
"status": 400,
"title": "Unable authenticate client",
"detail": "No further detail is available"
}
]
}

➔ Next to reasons for change rate