Resolutions

Use these methods to manage resolutions that are added to client requests if they are rejected.

GET[host]/api/v2/resolutions

Get a list of resolutions

GET[host]/v2/resolutions/{resolutionId}

Get resolution details

POST[host]/v2/resolutions

Add a new resolution

PUT[host]/v2/resolutions/{resolutionId}

PATCH[host]/v2/resolutions/{resolutionId}

Update a resolution

DELETE[host]/v2/resolutions{resolutionId}

Delete a resolution

GET[host]/api/v2/resolutions/types

Get a list of resolution types

GET[host]/v2/resolutions/types/{typeId}

Get resolution type details

POST[host]/v2/resolutions/types

Add a new resolution type

PUT[host]/v2/resolutions/types/{typeId}

PATCH[host]/v2/resolutions/types/{typeId}

Update a resolution type

DELETE[host]/v2/resolutions/types/{typeID}

Delete a resolution type

Get a list of resolutions

Use this method to obtain a list of resolutions created in the Back Office.

To obtain detailed information about a specific resolution, use a separate method to get resolution details.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Query parameters:

The following filter parameters are available for this method:

enabled

If true, a resolution can be used to resolve client requests; otherwise, false.

name

The resolution name (such as Document rejected).

type

The identifier of a resolution type.

Refer to the Query parameters section in the API Overview for details on applying filter parameters.

GET[host]/api/v2/resolutions

curl --location -g --request GET 'https://host.name/api/v2/resolutions?limit=10&offset=0&filter[enabled]=true&filter[name]=Document rejected&filter[type]=1' \
--header 'Authorization: Bearer <token>'

Response

A response contains an array of Resolution objects providing information about the resolutions that correspond to the query parameters included in the request.

Get resolution details

Use this method to obtain detailed information about a specified resolution.

To obtain a list of resolutions created in the Back Office, use a separate method to get a list of resolutions.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

resolutionId required

The resolution identifier.

GET[host]/v2/resolutions/{resolutionId}

curl --location --request GET 'https://host.name/api/v2/resolutions/1' \
--header 'Authorization: Bearer <token>'

Response

A response contains a Resolution object providing information about the specified resolution.

Add a new resolution

Use this method to add a new resolution.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Body:

Specify the following parameters for a resolution:

enabled boolean required

If true, a resolution can be used to resolve client requests; otherwise, false.

name string required

The resolution name (such as Document rejected).

typeId integer

The identifier of a resolution type.

POST[host]/v2/resolutions

curl --location --request POST 'https://host.name/api/v2/resolutions' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "enabled": true,
  "name": "Document rejected",
  "typeId": 1
}'

Response

A response includes a Resolution object providing information about the added resolution.

Update a resolution

Use this method to update a specified resolution.

Note

Instead of the method described below, you can use a similar method that uses the HTTP verbĀ PATCH.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

resolutionId required

The resolution identifier.

Body:

The following field values can be updated for a specified resolution:

enabled boolean

If true, a resolution can be used to resolve client requests; otherwise, false.

name string

The resolution name (such as Document rejected).

typeId integer

The identifier of a resolution type.

PUT[host]/v2/resolutions/{resolutionId}

curl --location --request PUT 'https://host.name/api/v2/resolutions/1' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "enabled": true,
  "name": "Document rejected",
  "typeId": 1
}'

Response

A response includes a Resolution object providing information about the resolution that was updated.

Delete a resolution

Use this method to delete a specified resolution.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

resolutionId required

The resolution identifier.

DELETE[host]/v2/resolutions/{resolutionId}

curl --location --request DELETE 'https://host.name/api/v2/resolutions/1' \
--header 'Authorization: Bearer <token>'

Response

In case of success, no response body is returned.

Get a list of resolution types

Use this method to obtain a list of resolution types created in the Back Office.

To obtain detailed information about a specific resolution type, use a separate method to get resolution type details.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Query parameters:

The following filter parameters are available for this method:

enabled

If true, resolutions can be assigned this type; otherwise, false.

name

The resolution type name.

Refer to the Query parameters section in the API Overview for details on applying filter parameters.

GET[host]/api/v2/resolutions/types

curl --location -g --request GET 'https://host.name/api/v2/resolutions/types?limit=10&offset=0&filter[enabled]=true&filter[name]=SNS Resolution Type' \
--header 'Authorization: Bearer <token>'

Response

A response contains an array of Resolution Type objects providing information about the resolution types that correspond to the query parameters included in the request.

Get resolution type details

Use this method to obtain detailed information about a specified resolution type.

To obtain a list of resolution types created in the Back Office, use a separate method to get a list of resolution types.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

typeId required

The resolution type identifier.

GET[host]/v2/resolutions/types/{typeId}

curl --location --request GET 'https://host.name/api/v2/resolutions/types/1' \
--header 'Authorization: Bearer <token>'

Response

A response contains a Resolution Type object providing information about the specified resolution type.

Add a new resolution type

Use this method to add a new resolution type.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Body:

Specify the following parameters for a resolution type:

enabled boolean required

If true, resolutions can be assigned this type; otherwise, false.

name string required

The resolution type name.

POST[host]/v2/resolutions/types

curl --location --request POST 'https://host.name/api/v2/resolutions/types' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "enabled": true,
  "name": "SNS Resolution Type"
}'

Response

A response includes a Resolution Type object providing information about the added resolution type.

Update a resolution type

Use this method to update a specified resolution type.

Note

Instead of the method described below, you can use a similar method that uses the HTTP verbĀ PATCH.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

typeId required

The resolution type identifier.

Body:

The following field values can be updated for a specified resolution type:

enabled boolean

If true, resolutions can be assigned this type; otherwise, false.

name string

The resolution type name.

PUT[host]/v2/resolutions/types/{typeId}

curl --location --request PUT 'https://host.name/api/v2/resolutions/types/1' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "enabled": true,
  "name": "PassBase Resolution Type"
}'

Response

A response includes a Resolution Type object providing information about the resolution type that was updated.

Delete a resolution type

Use this method to delete a specified resolution type.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

typeId required

The resolution type identifier.

DELETE[host]/v2/resolutions/types/{typeId}

curl --location --request DELETE 'https://host.name/api/v2/resolutions/types/1' \
--header 'Authorization: Bearer <token>'

Response

In case of success, no response body is returned.