Page tree

GET

/:site_number/individuals/:individual_id/comments /:comment_type_id

Returns a list of the comments for the supplied Comment Type Id for an individual.

Example

https://secure.accessacs.com/api_accessacs_mobile/v2/12345/individuals/76/comments/2

Notes

pageIndex and pageSize are not required for the API to work properly. These fields allow you to limit the number of records returned at one time and the point when you begin pulling information. If you do not enter this information, the index default is 0 and the size default is 50.  

For example, you are looking for all the individuals with the first name John. 300 records match your criteria. If you leave the defaults, the first 50 matches display. If you change the pageIndex to 2, the next 50 matches are returned.

Required Permissions

The user must fall into one of the categories below:

  • System Administration

  • A user with the following rights:

    • Ability to Add/View Comments

    • Full rights to at least one Comment Type

    • Ability to locate a person or search for a member

    • Lay Leaders can only cew comments for individuals they are a leader of.

Request Header

Basic Authorization is used to determine security rights for the user credentials supplied using the following parameters.

u sername : "jadams"

password : "password231"

URL Parameters

site_number – The site number to gather data for.

individual_id  – The individual requesting comments for.   Values from   Individual Search API.

comment_type_id  – Id for the specific comment you are requesting details for.  Values from Individuals Comment List API.

pageIndex  –  (Optional) Page number for the search results; begins with the 0 value entered for the first set of results.

pageSize  –  (Optional) Number of results to return per page.  

Return Data

{
  "Page": [
    {
      "CommentKey": 18,
      "CommentTypeID": 1,
      "CommentType": "Crisis Date",
      "CommentDate": "05/29/2007",
      "CommentBody": "Jim's father, J. C. Aaron, diagnosed with cancer.  Mr. Aaron lives in Plano. Tx.",
      "CommentColor": "fabe28"
    }
  ],
  "PageCount": 1,
  "PageIndex": 0,
  "PageSize": 10
}