OK
Encompass.Api (1.0)
Download OpenAPI description
Languages
Servers
Mock server
https://docs.encompassfi.com/_mock/reference/sandbox/
- Mock server
https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/departments
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/departments' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"workplaceId": "string",
"employees": [
"string"
],
"contractors": [
"string"
]
}'Response
application/json
{ "id": "string", "companyId": "string", "workplace": { "id": "string", "name": "string", "active": true, "address": { … } }, "name": "string", "active": true, "assignedEmployees": 0, "assignedContractors": 0 }
- Mock server
https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/departments
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/departments?id=string&workplaceId=string&search=string&active=true&includeSearch=true&includeId=true&includeWorkplaceId=true&page=1&pageSize=10'Response
application/json
{ "hasResources": true, "totalResources": 0, "totalPages": 0, "pageSize": 0, "currentPage": 0, "previousPage": 0, "nextPage": 0, "results": [ { … } ] }
- Mock server
https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/departments/{departmentId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/departments/{departmentId}'Response
application/json
{ "id": "string", "companyId": "string", "workplace": { "id": "string", "name": "string", "active": true, "address": { … } }, "name": "string", "active": true, "assignedEmployees": 0, "assignedContractors": 0 }
- Mock server
https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/departments/{departmentId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/departments/{departmentId}' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"active": true,
"workplaceId": "string",
"employeeIds": [
"string"
],
"contractorIds": [
"string"
]
}'Response
application/json
{ "id": "string", "companyId": "string", "workplace": { "id": "string", "name": "string", "active": true, "address": { … } }, "name": "string", "active": true, "assignedEmployees": 0, "assignedContractors": 0 }