GET

/:site_number/orgs?q=[string]&lvl=:level_type_id

Returns detailed information on the Organization identified by Organization ID.

Example

https://secure.accessacs.com/api_accessacs_mobile/v2/12345/orgs?q=church&lvl=4&pageIndex=0&pageSize=5

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:

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.

level_type_id  – The identification number of the type of organization you want to return data for.  Values from Organization Level Types API.  (optional)  If you chose not to include this field, remove the &lvl from the get statement.

Query String Parameters

q = [Organization Name]  (Optional)  If you chose not to include this option, remove q= from the get statement.

     Examples:  [Church]

               A Church

               church

              A

Return Data

{
    "Page": [
        {
            "OrgId": 1113,
            "LevelTypeId": 4,
            "Name": "A Church",
            "RefName": "A Church",
            "Address": "2002 Cyp Rd, Florence  SC  29505-6815",
            "Phone": "843-555-1113",
            "Email": "anemailaddress@emailhost.com"
        },
        {
            "OrgId": 826,
            "LevelTypeId": 4,
            "Name": "B Church",
            "RefName": "B Church",
            "Address": "201 Court, Simpsonville  SC  29681-6606",
            "Phone": "843-555-1111",
            "Email": "anemailaddress@emailhost.com"
        },
        {
            "OrgId": 622,
            "LevelTypeId": 4,
            "Name": "C Church",
            "RefName": "C Church",
            "Address": "3829 Palm Dr, Florence  SC  29506-8345",
            "Phone": "843-888-8888",
            "Email": "anemailaddress@emailhost.com"
        }
    ],
    "PageCount": 1,
    "PageIndex": 0,
    "PageSize": 50
}

Notes

You do not have to have a query string at all to run this api.  This is how the example would look:

http://secure.accessacs.com/api_accessacs_mobile/v2/12345/orgs?pageIndex=0&pageSize=5