createContactType

Overview

This method creates one or more contact types 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/types https://api.{{environment}}.catch-e.com/fm/contact/types https://api.test.catch-e.com/fm/contact/types

Input Fields (Header)

Key	Format	Notes	Mandatory
Audit-User-Id	string	(Optional) User Id to use for audit purposes. Up to 5 digits. Requires the Audit:UserIdOverride permission.	No

Input Fields (JSON)

Send an array of contact types.

Key	Format	Notes	Mandatory
description	string	The contact type.	No
report_type	string	Allowed values: `periodic-lease`, `combined`, `recharge`, `recharge-fuel`, `pay-run`, `pay-run-reports`.	No
status_flag	string	Allowed values: `active`, `inactive`. Default `active`.	No

Example

[ { "description": "Billing Contact", "report_type": "periodic-lease" }, { "description": "Pay Run Contact", "report_type": "pay-run" } ]

Response Details

Success

201 - Created

Returns the new contact types. Each record in _embedded.contact_types contains:

Field	Format	Notes
contact_type_id	string
description	string
report_type	string	Values: `periodic-lease`, `combined`, `recharge`, `recharge-fuel`, `pay-run`, `pay-run-reports`.
status_flag	string	Values: `active`, `inactive`.

{ "_links": { "self": { "href": "https://api.catch-e.loc/fm/contact/types?page=1" } }, "_embedded": { "contact_types": [ { "_links": { "self": { "href": "https://api.catch-e.loc/fm/contact/types/6" } }, "contact_type_id": "6", "description": "Billing Contact", "report_type": "periodic-lease", "status_flag": "active" }, { "_links": { "self": { "href": "https://api.catch-e.loc/fm/contact/types/7" } }, "contact_type_id": "7", "description": "Pay Run Contact", "report_type": "pay-run", "status_flag": "active" } ] }, "page_count": 1, "page_size": 25, "total_items": 2, "page": 1 }

Error Response Details

Validation Message	Comments
401 - Unauthorized	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" }