Contacts APIs
-
List Contacts
Description: Returns an array of Contacts for the given Contact list.Usage:
GET api/ContactLists/Contacts/List/{ListCode}/{RowIndex}/{PageSize}
Parameter Type Source Description ListCode Int32 FromUri Unique numerical code that identifies the contact list RowIndex Int32 FromUri the starting row index for the page to get records from. The first row starts with 0. PageSize Int32 FromUri the total number of records to return in a page Returns:
Array of Contact objects
Examples:
<!-- Intent: gets the list of contacts in the contact list with ListCode 123456. This will return the first 5 rows. GET to the following url http://api.v4.swiftreach.com/api/ContactLists/Contacts/List/123456/1/5 --> <!-- No XML input is required --> <!-- example return value --> <ArrayOfContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.ContactLists"> <Contact> <Addresses> <AddressProfile> <Address1>14 Industrial Ave</Address1> <Address2></Address2> <AddressGuid>22748f25-07b8-459c-bcef-ce2ba851a84c</AddressGuid> <City>Mahwah</City> <County></County> <IsPrimary>false</IsPrimary> <Label>Office</Label> <Latitude>41.052698269486427</Latitude> <Longitude>-74.121656566858292</Longitude> <PostalCode>07430</PostalCode> <State>NJ</State> </AddressProfile> </Addresses> <ChangeStamp>2012-09-11T15:19:05.457</ChangeStamp> <ChangedByUser>sample</ChangedByUser> <CreateStamp>2012-09-11T15:04:02.833</CreateStamp> <CreatedByUser>sample</CreatedByUser> <Email>info@swiftreach.com</Email> <EntityGuid>736c8340-e23b-4c23-aaa1-f55cfdb391bb</EntityGuid> <EntityName>Bob</EntityName> <Fax> </Fax> <Pager></Pager> <PagerNetwork>0</PagerNetwork> <Phones> <PhoneProfile> <AnsDetectionOverride>UseDefault</AnsDetectionOverride> <Extension></Extension> <OptInSMS>true</OptInSMS> <Phone>2012361344</Phone> <PhoneLabel>Mobile</PhoneLabel> <PhoneType>phonetype_voice</PhoneType> </PhoneProfile> </Phones> <PinCode></PinCode> <SMSNetwork>0</SMSNetwork> <SMSPhone></SMSPhone> <SpokenLanguage>English</SpokenLanguage> <Tag></Tag> <UserDefined /> </Contact> </ArrayOfContact>