CINC API

Correspondance Status

Allows you to get information about your correspondance types.

Currently allowing the following protocols:

  • GET ONLY

Request URL

GET End Point

https://yourcustomerdatabase.cincsys.com/api/management/{mgmtId}/homeowners/correspondencestatus

Parameter Descriptions

  • mgmtId (Management Id): Pass your management ID.

Paramter Types

  • mgmtId: string (required)

Response Body

The response object:

{
    "numStatusID": int,
    "txtDescription": string,
    "numCorrTemplateID": int,
    "numAccStatus": int
}

The following shows example data being returned

[
  {
    "numStatusID": 1,
    "txtDescription": "Open",
    "numCorrTemplateID": 0,
    "numAccStatus": 1
  },
  {
    "numStatusID": 2,
    "txtDescription": "Closed",
    "numCorrTemplateID": 0,
    "numAccStatus": 0
  },
]

Response Codes

200 - OK: Everything worked as expected.

400 - Bad Request: The request was unacceptable, often due to missing a required parameter.

401 - Unauthorized: No valid API key provided.

402 - Request Failed: The parameters were valid but the request failed.

403 - Forbidden: The API key doesn't have permission to perform the request.

404 - Not Found: The requested resource doesn't exist.