Introduction

To retrieve a list of supported professions on the Platform, the Thinksurance Public API V1 (referred to as "the API") provides a dedicated endpoint designed specifically for this purpose. This endpoint enables consumers to retrieve either the complete list of professions used to map all business to them.

Endpoint

To retrieve professions, consumers are required to send an HTTP POST request to the /api/professions endpoint. This endpoint requires the security token, obtained during the Authentication process on the API, as an integral component of the JSON payload within the body of the request.

Action name	get professions
HTTP path	/api/professions
HTTP method	POST

Attributes of the HTTP request

token	string	required	A security token provided from Authentication endpoint.

Attributes of the HTTP response

Success response
JSON array of objects containing:
id	int	required	An unique identifier of the profession.
name	string	required	A profession’s name.
Failed response
error	string	required	It contains a reason for the failed request.

Examples

This section shows examples of different HTTP requests and responses associated with the endpoint /api/professions.

HTTP Request

# HTTP POST
# /api/professions
# 'Content-Type': 'application/json'
# 'Accept': 'application/json'
{
  "token": "some long string value"
}

Successful HTTP Response

# HTTP 200 status code
# 'Content-Type': 'application/json'
[
  {
    "id": 1,
    "name": "Profession1"
  },
  {
    "id": 2,
    "name": "Profession2"
  }
]

Failed HTTP Response

# HTTP 200 status code
# 'Content-Type': 'application/json'
{
  "error": "API User is not existing or deactivated."
}

Get Professions

Introduction

Endpoint

Attributes of the HTTP request

Attributes of the HTTP response

Examples