Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GET

/:site_number/individuals/find

Performs a search for a list of individuals based on First Name, Last Name or Goes By Name.

Example

Info
iconfalse

http://secure.accessacs.com/api_accessacs_mobile/v2/12345/individuals/find?q=John%20Doe
&pageIndex=0&pageSize=5

Notes

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

...

Within our example, the %20 represents a space. You can include this or simply use a space. In our example, to display the entire URL, the optional pageIndex and pageSize display on the next line. In actual usage, these two lines would be one.

Required Permissions

User with security rights to lookup individual information.

Request Header

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

username: "jadams"

password: "password231"

URI Parameters

sitenumber – The site number to gather data for.

...

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

Query String Parameters

q = [First Name | Last Name | Goes By Name]

...

                John

                John Doe

Return Data

Code Block
{
  "Page": [
    {
      "IndvId": 12,
      "FamId": 1234,
      "FamilyPosition": "Head",
      "Title": "Mr.",
      "FirstName": "Johnathon",
      "LastName": "Doe",
      "MiddleName": null,
      "GoesByName": "John",
      "Suffix": null"
    }
  ],
  "PageCount": 1,
  "PageIndex": 0,
  "PageSize": 5
}