Cancellation Reason List

URI	/v1/general/cancellation_reasons
URI Parameters	n/a
Methods	GET

GET /v1/general/cancellation_reasons

Gets the cancellation reasons to be used in cancelling accounts and partners.

Scope	n/a
Query Selector Parameters	n/a
Query Pagination Parameters	page (int) page_size (int)
Query Sorting Parameters	order_by (string const) – REASON_ID\|REASON_NAME order_dir (string const) – ASC\|DESC
Request Body Parameters	n/a
Response Attributes	reason_id (int) description (string) requires_note (bool) – If true, when the reason is used to cancel an account or partner, the note cannot be blank

Example JSON

Request:

GET /v1/general/cancellation_reasons HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Accept: application/json

Response:

HTTP/1.1 200 OK

Content-Type: application/json

{

"page": 1,

"page_size": 10,

"count": 2,

"links": [

{

"rel": "first",

"href": "https://api.intronis.com/v1/general/cancellation_reasons?page=1"

},

],

"list": [

{

"reason_id": 1,

"description": "Customer has gone out of business",

"requires_note": false

},

{

"reason_id": 2,

"description": "Other",

"requires_note": true

}

]

}

Example XML

Request:

GET /v1/general/cancellation_reasons HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Accept: application/xml

Response:

HTTP/1.1 200 OK

Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>

<reason_id>1</reason_id>

<description>Customer has gone out of business</description>

<requires_note>false</requires_note>

</reason>

<reason_id>2</reason_id>

<description>Other</description>

<requires_note>true</requires_note>

</reason>

</list>