Page tree

GET

/:site_number/individual/:indiviudal_id/connections?include_self&include_open

Returns an individual's connection history.

Example

https://secure.accessacs.com/api_accessacs_mobile/v2/12345/individuals/1234/connections?

&includeSelf=true&includeOpen=false&pageIndex=0&pageSize=50

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 rights to view Outreach History

Request Header

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

username: "jadams"

password: "password231"

URL Parameters

site_number – The site number to gather data for.

individual_id The person you are getting details for.  Values from Individual Search 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. 

Query String Parameters

include_self  To include yourself in the returned information. The default value is True.

include_open  Includes open connections in the returned results.   The default value is False.

Return Data

{
  "Page": [
    {
      "ConnectionId": 2130,
      "ConnectionTypeId": 11,
      "ConnectionTypeDescription": "Follow-Up Contact",
      "ContactType": "Outward",
      "DueDate": "6/1/2009",
      "Comment": null,
      "DueDateLong": "Monday, June 01, 2009",
      "Completed": true,
      "TeamMemberCount": 1,
      "ContactInformation": {
        "IndvId": 76,
        "FamId": 1042,
        "FamilyPosition": "Head",
        "Title": "Mr.",
        "FirstName": "James",
        "LastName": "Aaron",
        "MiddleName": null,
        "GoesByName": "Jim",
        "Suffix": null,
        "PictureUrl": ""
      },
      "TeamMembers": []
    },
      {
      "ConnectionId": 2105,
      "ConnectionTypeId": 2,
      "ConnectionTypeDescription": "Repeat Visitor",
      "ContactType": "Inward",
      "DueDate": "8/20/2007",
      "Comment": "teacher",
      "DueDateLong": "Monday, August 20, 2007",
      "Completed": true,
      "TeamMemberCount": 0,
      "ContactInformation": {
        "IndvId": 76,
        "FamId": 1042,
        "FamilyPosition": "Head",
        "Title": "Mr.",
        "FirstName": "James",
        "LastName": "Aaron",
        "MiddleName": null,
        "GoesByName": "Jim",
        "Suffix": null,
        "PictureUrl": ""
      },
      "TeamMembers": []
    },
   {
      "ConnectionId": 32,
      "ConnectionTypeId": 4,
      "ConnectionTypeDescription": "Deacon Contact",
      "ContactType": "Outward",
      "DueDate": "3/31/1998",
      "Comment": "Jane is the former Jane McLeod.",
      "DueDateLong": "Tuesday, March 31, 1998",
      "Completed": true,
      "TeamMemberCount": 0,
      "ContactInformation": {
        "IndvId": 76,
        "FamId": 1042,
        "FamilyPosition": "Head",
        "Title": "Mr.",
        "FirstName": "James",
        "LastName": "Aaron",
        "MiddleName": null,
        "GoesByName": "Jim",
        "Suffix": null,
        "PictureUrl": ""
      },
      "TeamMembers": []
    }
  ],
  "PageCount": 1,
  "PageIndex": 0,
  "PageSize": 50
}