Associations

Allows you to get information about your associations.

Currently allowing the following protocols:

• GET ONLY

Request URL

GET End Point

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

Parameter Descriptions

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

• assocCode (Association Code); Ability to filter by association.

Paramter Types

• mgmtId: string (required)

• assocCode: string (optional)

Response Body

The response object:

{
    "AssociationIdLink": string,
    "Associationname": string,
    "Address1": string,
    "Address2": string,
    "City": string,
    "State": string,
    "Zip": string,
    "Numberofunits": int,
    "Website": string,
    "ManagerId": int,
    "ManagerName": string,
    "AssistantManagerId": int,
    "AssistantManagerName": string,
    "ServicePackageId": ,int
    "AssocTypeId": int,
    "RegionId": int,
    "RegionName": string,
    "OfficeId": int,
    "OfficeName": string
}

The following shows example data being returned

[
  {
    "AssociationIdLink": "00000",
    "Associationname": "Brighton Homeowners' Association, Inc.",
    "Address1": "P.O. Box 79032",
    "Address2": "",
    "City": "Charlotte",
    "State": "NC",
    "Zip": "28271-7047",
    "Numberofunits": 177,
    "Website": "www.BrightonHoa.com",
    "ManagerId": 211,
    "ManagerName": "Annie Houston",
    "AssistantManagerId": 0,
    "AssistantManagerName": null,
    "ServicePackageId": 0,
    "AssocTypeId": 4,
    "RegionId": 0,
    "RegionName": null,
    "OfficeId": 0,
    "OfficeName": null
  },
  {
    "AssociationIdLink": "00000",
    "Associationname": "Sunset at Linda Vista Village",
    "Address1": "P.O. Box 79032",
    "Address2": "",
    "City": "Charlotte",
    "State": "NC",
    "Zip": "28271-7047",
    "Numberofunits": 121,
    "Website": "",
    "ManagerId": 26,
    "ManagerName": "Sam Smith",
    "AssistantManagerId": 0,
    "AssistantManagerName": null,
    "ServicePackageId": 0,
    "AssocTypeId": 1,
    "RegionId": 0,
    "RegionName": null,
    "OfficeId": 0,
    "OfficeName": null
  }
]

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.