createAllocation

Overview

This method allocates one or more existing contacts to clients, client groups, cost centres or divisions in a single request.

This method requires the Contacts:Create permission to be associated with your role.

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'Contacts:Create'.

Only roles with a stored link to this permission in [gb_role_api_permissions] can run this api.

HTTP Method

Use the HTTP Method 'POST' for consuming this web service.

URL Examples

https://api.demo.catch-e.com/fm/contact/allocations https://api.{{environment}}.catch-e.com/fm/contact/allocations https://api.test.catch-e.com/fm/contact/allocations

Input Fields (JSON)

Send an array of allocations.

Key	Format	Notes	Mandatory
contact_id	string	The contact to allocate.	No
table_name	string	The table to allocate the contact to. Allowed values: `fm_clients`, `fm_client_groups`, `fm_client_cost_centres`, `fm_client_divisions`.	No
record_id	string	The record id in that table, e.g. the client id from `fm_clients`.	No
status_flag	string	Status of the contact allocation. Allowed values: `active`, `deleted`. Default `active`.	No

Example

[ { "contact_id": "345", "table_name": "fm_clients", "record_id": "1234" }, { "contact_id": "345", "table_name": "fm_client_cost_centres", "record_id": "56" } ]

Response Details

Success

201 - Created

Returns the new allocations as an array.

Field	Format	Notes
contact_id	string	Contact Id.
table_name	string	Values: `fm_clients`, `fm_client_groups`, `fm_client_cost_centres`, `fm_client_divisions`.
record_id	string	The record id in that table, e.g. the client id from `fm_clients`.
status_flag	string	Values: `active`, `inactive`.

[ { "contact_id": "345", "table_name": "fm_clients", "record_id": "1234", "status_flag": "active" } ]

Error Response Details

Validation Message	Comments
401 - Unauthorized	1. You have not authenticated before running this API or 2. The token_timeout of the current session has passed. You need to authenticate again.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized" }

Validation Message	Comments
403 - Forbidden	- You do not have permissions for this request. - Go to System Roles and enter 'web_services' - Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden" }

Validation Message	Comments
406 - Not Acceptable	The Accept header of the request does not match a response format this API supports.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Acceptable", "status": 406, "detail": "Not Acceptable" }

Validation Message	Comments
415 - Unsupported Media Type	The Content-Type of the request is not supported by this API.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unsupported Media Type", "status": 415, "detail": "Not Acceptable" }

Validation Message	Comments
422 - Unprocessable Entity	One or more input fields failed validation. The field name and message are returned in `validation_messages`.

{ "warning_messages": {}, "validation_messages": { "fieldName": { "validationExceptionCode": "A textual description of the validation exception" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

Validation Message	Comments
500 - Internal Error	An unexpected error occurred on the server.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }

Validation Message	Comments
default - Unexpected Error	Any other unexpected error.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }