CINC API

Correspondance Template

Allows you to get information about your correspondance templates.

Currently allowing the following protocols:

  • GET ONLY

Request URL

GET End Point

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

Parameter Descriptions

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

Paramter Types

  • mgmtId: string (required)

Response Body

The response object:

{
    "numCorrTemplateID": int,
    "numAssocID": int,
    "txtCorrName": string,
    "txtCorrTemplate": string,
    "numTmplTypeID": int,
    "numPaperSourceID": int,
    "numNewEditorSave": bool
}

The following shows example data being returned

[
{
    "numCorrTemplateID": 23,
    "numAssocID": 2,
    "txtCorrName": "MW - Rental Property Update",
    "txtCorrTemplate": "<HTML xmlns:st1 = \"urn:schemas-microsoft-com:office:smarttags\" xmlns:o = \"urn:schemas-microsoft-com:office:office\"><HEAD>\r\n<META content=\"MSHTML 6.00.6000.16414\" name=GENERATOR></HEAD>\r\n<BODY><SPAN><SPAN></SPAN></SPAN>\r\n<P align=center><SPAN><SPAN><FONT face=\"Times New Roman\"><IMG height=79 alt=\"\" src=\"/uploaddocs/chmg/images/New%20HOA%20Logo%20Color.jpg\" width=320 border=0><BR></P>\r\n<DIV align=center>\r\n<HR>\r\n<SPAN><FONT size=2>[^address1^]&nbsp;• [^city^],&nbsp;[^assocstate^] [^zip^] • [^associationphone^] • Fax [^associationfax^]<BR>[^associationwebsite^]<BR></FONT></SPAN><SPAN><FONT face=\"Times New Roman\"></DIV>\r\n<DIV align=center>\r\n<HR>\r\n</FONT></SPAN><BR></FONT></SPAN></SPAN></DIV><SPAN><SPAN></SPAN></SPAN><SPAN><FONT face=\"Times New Roman\"><SPAN><SPAN></SPAN></SPAN></FONT></SPAN><FONT face=\"Times New Roman\">\r\n<P>[^TodayLong^]<BR><BR>[^txtOwnerNameAddress^]</FONT></P>\r\n<P><FONT face=\"Times New Roman\"><BR>Dear [^txtOwnerName^]:</FONT></P>\r\n<P><FONT face=\"Times New Roman\">In reviewing our records, we have determined that the property at&nbsp;[^txtPropertyAddress1^] is a rental property, and we are missing the required information, or the previous Lease has expired.</FONT></P>\r\n<P><FONT face=\"Times New Roman\">Pursuant to the Declarations of Covenants and Restrictions we respectfully request that you forward the required information to the association within 15 days from the date of this letter.</FONT></P>\r\n<BLOCKQUOTE dir=ltr style=\"MARGIN-RIGHT: 0px\">\r\n<P align=left><B><SPAN><FONT face=\"Times New Roman\">(c) In the event an Owner shall rent or lease his or her Lot such Owner shall immediately give to the Association in writing:<BR></FONT></SPAN></B><B><SPAN><FONT face=\"Times New Roman\">(i) the name of the tenant and the Lot rented or leased;<BR></FONT></SPAN></B><B><SPAN><FONT face=\"Times New Roman\">(ii) the current address of such Owner;<BR></FONT></SPAN></B><B><SPAN><FONT face=\"Times New Roman\">(iii) a true and complete copy of the lease or rental agreement; and<BR></FONT></SPAN></B><FONT face=\"Times New Roman\"><B><SPAN>(iv) the certification of the Owner that the tenant has been given a copy of this Declaration, any applicable amendments, the Bylaws and the Rules and Regulations and that such tenant has been advised of any obligations he may have thereunder as a tenant.</SPAN></B></FONT></P></BLOCKQUOTE>\r\n<P><SPAN><FONT face=\"Times New Roman\">If you did not recieve a copy of the Declaration of Covenants at closing, you may obtain one at our website.</FONT></SPAN></P>\r\n<P><FONT face=\"Times New Roman\">Thank you for your help in this matter.</FONT></P>\r\n<P><FONT face=\"Times New Roman\">Sincerely,</FONT></P>\r\n<P><FONT face=\"Times New Roman\">The Board of Directors for the [^associationname^]</FONT><FONT face=\"Times New Roman\"><SPAN style=\"FONT-FAMILY: Georgia\"><FONT size=2><BR></FONT></SPAN></FONT></P></BODY></HTML>",
    "numTmplTypeID": 1,
    "numPaperSourceID": -1,
    "numNewEditorSave": false
  },
  {
    "numCorrTemplateID": 40,
    "numAssocID": 2,
    "txtCorrName": "7.02 Unlawful Activity",
    "txtCorrTemplate": "<HTML><HEAD>\r\n<META content=\"MSHTML 6.00.2900.3199\" name=GENERATOR></HEAD>\r\n<BODY>\r\n<P><SPAN><FONT face=\"Times New Roman\" size=2><SPAN style=\"mso-bidi-font-size: 13.0pt\"><FONT size=2><FONT size=3>We would like to remind you that the Declaration of Covenants, Conditions and Restrictions for&nbsp;[^associationname^] states:<SPAN style=\"mso-bidi-font-weight: bold\"> </SPAN></FONT></FONT></SPAN><EM>7.02. <U>Unlawful Activity. </U>No unlawful activity shall be conducted on any Lot or in any other part of the Property. Nothing shall be done within the Property that is an unreasonable annoyance, inconvenience or nuisance to the residents of the Property, or that unreasonably interferes with the quiet enjoyment of occupants of Lots. No doorways, walkways or streets shall be obstructed in any manner which would interfere with their use for ingress or egress in the event of fire, earthquake or other emergency.<BR><BR></EM><FONT size=3><SPAN class=718303215-09112007>IF fines or sanctions are imposed, the Board of Directors has set a minimum [^ViolationFineFrequency^] fine of [^ViolationFineAmount^] for this type of violation.</SPAN></FONT></FONT></SPAN></P></BODY></HTML>",
    "numTmplTypeID": 4,
    "numPaperSourceID": -1,
    "numNewEditorSave": false
  },
]

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.