Notes & Attachments

REST API: Notes & Attachments

Using the REST API, you can create notes and attachments within your AMS+ account. For auditing purposes, you may not update or delete notes or attachments in AMS+ via API.

Note & Attachment Resources

• Create
• List
• Examples

Create

RESOURCE URL

https://app.agencybloc.com/api/v1/notes/create

REQUIRED POST PARAMETERS

You must POST the following parameters via the body of the request. Parameters found in the querystring of the request will be ignored:

The entityType parameter must be one of the following values:

• Agent
• Group
• Individual
• Policy

ADDITIONAL POST PARAMETERS

For each note/attachment record (“collection”), a note body and note subject are required.

Along with each note, you can also post up to 5 files (optional). For each file within a collection, a filename must be supplied as well as a valid URL or base64 encoded file. You may post up to 5 Notes/Attachment collections, with each one containing up to 5 files.

See the Examples section at the end for text files with demo data.

RESPONSE

A return response will be generated after you have consumed the API. Upon successfully creating a new note inside your AMS+ account, you will get a return status of 200 along with the noteID as seen below.

{
"Agencybloc Response": {
 "Status":"200",
 "note_ids":[123456],
 "Action":"create"
 }

Exception Responses

The exception responses will include status, title, and message and be in JSON format.

{
  "Agencybloc Response": {
     "Exception": {
        "Status":"Status Code",
        "Title":"Title of Error",
        "Message":"Error Message"
      }
   }
}

List

RESOURCE URL

https://app.agencybloc.com/api/v1/notes/list

REQUIRED POST PARAMETERS

Returns a JSON list of note & attachment objects. Notes are ordered by modification date, newest to oldest, with the contained attachments ordered by filename.

RESPONSE

A return response will be generated after you have consumed the API. Upon successfully creating a new note inside your AMS+ account, you will get a return status of 200 along with the noteID as seen below.

{
     "Agencybloc Response":
     {
        "Status":"200",
        "notes":
        [
            {	
	         "note_id":1,
                 "body_text":"Not Pinned - No attachments",
                 "create_datetime":"7/9/2018 11:10:22 AM",
                 "create_username":"John Doe",
                 "update_datetime":"7/9/2018 11:10:22 AM",
                 "update_username":"John Doe",
                 "subject_text":"Note Number 2 - Not Pinned",
                 "pinned":"0",
                 "Attachments":[]
            },
            {	
	         "note_id":2,
                 "body_text":"Pinned Note",
                 "create_datetime":"7/9/2018 11:09:59 AM",
                 "create_username":"John Doe",
                 "update_datetime":"7/9/2018 11:09:59 AM",
                 "update_username":"John Doe",
                 "subject_text":"Note Number 1 - Pinned",
                 "pinned":"1",
                 "Attachments":
                 [
                     {
                          "file_name":"Bagel.png",
                          "file_url":"Download.aspx?f=61507_bagel.png\u0026type=7"
                     }
                 ]
            }
        ],
        "Action":"list"
     }
}

Exception Responses

The exception responses will include status, title, and message and be in JSON format.

{
  "Agencybloc Response": {
     "Exception": {
        "Status":"Status Code",
        "Title":"Title of Error",
        "Message":"Error Message"
      }
   }
}

Examples

The attached files demonstrate the naming conventions for a single note with a single attached file (minimum functional implementation of notes & attachments) and 5 five notes with 5 attached files per note (25 files, maximum functional implementation at this time).

Note: The parameters in the text files are not URL encoded for readability purposes. Depending on your API endpoint or integration you may need to include additional parameters to complete your request.