Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated with new look + changes from Cindy

Description

GET

/:site_number/connections/:connection_type_id?include_self

Returns the complete details of a Connectionconnection. 

Example

Info

IncludeSelf parameter will include yourself in the TeamMember List when true. The default is IncludeSelf =false.

Request Verb

GET

URL

https
Code Block
iconfalse

http://secure.accessacs.com/api_accessacs_mobile/v2/

<sitenumber>

12345/connections/

<ConnectionId>

1234?IncludeSelf=

<bool>

Request Header

...

Query Parameters

...

true

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.

connectionId – The Connection ID you want to return data for.

IncludeSelf – Includes yourself in the TeamMember connection_type_id – The connection id for the type of connection you are selecting. Values from Connection Type API.

 

Query String Parameters

include_self  To include yourself in the Team Member List when set to trueTrue. The default value is IncludeSelf =falseFalse.

...

Return Data

Code Block
{
    "FamId": 01492,
    "FamilyConnection": falsetrue,
    "DateCreated": "93/2429/20072004",
    "Comment": null,
    "OpenField": null,
    "PermissionLevel": "All",
    "Responses": [
        {
            "RespID": 4,
            "Resp_Desc": "V-New in Town"
        }
    ],
    "ConnectionId": 20861071,
    "ConnectionTypeId": 126,
    "ConnectionTypeDescription": "NewOutreach MemberTeam LetterContact",
    "ContactType": "Outward",
    "DueDate": "104/155/20102004",
  "Comment": null,
  "DueDateLong": "FridayMonday, OctoberApril 1505, 20102004",
    "Completed": false,
    "TeamMemberCount": 10,
    "ContactInformation": {
        "Country": "USA",
        "Company": null,
        "Address": "Sunbrook111 TowersHome Ave",
        "Address2": "1411 Brittany Dr Apt A"null,
        "City": "Florence",
        "State": "SC",
        "Zipcode": "29501-6281",
        "CityStateZip": "Florence, SC 29501-6281",
        "Email": "travis.tinker@acstechnologies.com"null,
        "EmailListed": true,
        "PhoneNumber": null,
        "Extension": null"111-111-1111",
        "PhoneListed": true,
        "IndvId": 76945,
        "FamId": 10421492,
        "FamilyPosition": "Head",
        "Title": null"Mr.",
        "FirstName": "JamesJonathan",
        "LastName": "AaronDoe",
        "MiddleName": "P"null,
        "GoesByName": "JimJon",
        "Suffix": null,
        "PictureUrl": <Full""
Picture Url>     },
    "TeamMembers": [
        {
            "IndvId": 287,
            "FamId": 1155,
            "FamilyPosition": "Head",
            "Title": "Rev.",
            "FirstName": "Jerry",
            "LastName": "Davis",
            "MiddleName": null,
            "GoesByName": null,
            "Suffix": null,
            "PictureUrl": null
        }
    ]
}