Page tree

GET

/:site_number/connections?include_complete&include_self

Returns a list of connections.

Example

https://secure.accessacs.com/api_accessacs_mobile/v2/12345/connections?includeCompleted=false&includeSelf=true&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 the following rights:

    • Ability to assign contacts

    • View rights to at least one Connection Type

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.

include_completed – Will include all completed connections in returned data. The default setting is False.

include_self – Includes yourself in the TeamMember List when set to True. The default setting is False.

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": [
   {
      "ConnectionId": 2034,
      "ConnectionTypeId": 6,
      "ConnectionTypeDescription": "Outreach Team Contact",
      "ContactType": "Outward",
      "DueDate": "3/16/2007",
      "Comment": null,
      "DueDateLong": "Friday, March 16, 2007",
      "Completed": false,
      "TeamMemberCount": 0,
      "ContactInformation": {
        "IndvId": 1149,
        "FamId": 1658,
        "FamilyPosition": "Head",
        "Title": "Mr.",
        "FirstName": "William",
        "LastName": "Kenton",
        "MiddleName": "R",
        "GoesByName": "Bill",
        "Suffix": "Jr",
        "PictureUrl": ""
      },
      "TeamMembers": []
    },
    {
      "ConnectionId": 2038,
      "ConnectionTypeId": 14,
      "ConnectionTypeDescription": "Phone Call",
      "ContactType": "Outward",
      "DueDate": "3/20/2007",
      "Comment": null,
      "DueDateLong": "Tuesday, March 20, 2007",
      "Completed": false,
      "TeamMemberCount": 0,
      "ContactInformation": {
        "IndvId": 1151,
        "FamId": 1659,
        "FamilyPosition": "Head",
        "Title": null,
        "FirstName": "Mark",
        "LastName": "Smith",
        "MiddleName": "D",
        "GoesByName": null,
        "Suffix": null,
        "PictureUrl": ""
      },
      "TeamMembers": []
    },
    {
      "ConnectionId": 2147,
      "ConnectionTypeId": 1,
      "ConnectionTypeDescription": "Pastor Contact",
      "ContactType": "Outward",
      "DueDate": "6/5/2013",
      "Comment": null,
      "DueDateLong": "Wednesday, June 05, 2013",
      "Completed": false,
      "TeamMemberCount": 3,
      "ContactInformation": {
        "IndvId": 76,
        "FamId": 1042,
        "FamilyPosition": "Head",
        "Title": "Mr.",
        "FirstName": "James",
        "LastName": "Aaron",
        "MiddleName": null,
        "GoesByName": "Jim",
        "Suffix": null,
        "PictureUrl": ""
      },
      "TeamMembers": [
        {
          "IndvId": 76,
          "FamId": 1042,
          "FamilyPosition": "Head",
          "Title": "Mr.",
          "FirstName": "James",
          "LastName": "Aaron",
          "MiddleName": null,
          "GoesByName": "Jim",
          "Suffix": null,
          "PictureUrl": ""
        },
        {
          "IndvId": 858,
          "FamId": 1445,
          "FamilyPosition": "Head",
          "Title": "Mr.",
          "FirstName": "Donald",
          "LastName": "Absher",
          "MiddleName": null,
          "GoesByName": null,
          "Suffix": null,
          "PictureUrl": ""
        },
        {
          "IndvId": 970,
          "FamId": 1506,
          "FamilyPosition": "Head",
          "Title": "Mr.",
          "FirstName": "Patrick",
          "LastName": "Abbott",
          "MiddleName": null,
          "GoesByName": null,
          "Suffix": null,
          "PictureUrl": ""
        }
      ]
    },
  "PageCount": 1,
  "PageIndex": 0,
  "PageSize": 50
}