ContactLists APIs
-
List Contact Lists
Description: Returns an array of existing ContactListsUsage:
GET api/ContactLists/List
Returns:
Array of ContactLists
Examples:
<!-- Intent: get a list of available contact lists GET to the following url http://api.v4.swiftreach.com/api/ContactLists/List --> <!-- No XML input is required --> <!-- example return value --> <ArrayOfContactList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.ContactLists"> <ContactList> <ChangeStamp>2013-03-25T23:46:08.82</ChangeStamp> <ChangedByUser>pbacigalupi</ChangedByUser> <CreateStamp>2013-03-23T16:05:33.937</CreateStamp> <CreatedByUser>pbacigalupi</CreatedByUser> <DeleteLocked>false</DeleteLocked> <Description>Peter Test</Description> <ExposeHomePortal>false</ExposeHomePortal> <ExposeVisitorPortal>false</ExposeVisitorPortal> <ListCode>668487</ListCode> <ListName>Peter Test</ListName> <ListSize>1</ListSize> <ListType>List</ListType> <PendingApprovalCount>0</PendingApprovalCount> <SubscriptionRequiresApproval>false</SubscriptionRequiresApproval> </ContactList> <ContactList> <ChangeStamp>2013-03-21T13:13:40.27</ChangeStamp> <ChangedByUser>sample</ChangedByUser> <CreateStamp>2013-03-21T13:13:17.477</CreateStamp> <CreatedByUser>sample</CreatedByUser> <DeleteLocked>false</DeleteLocked> <Description></Description> <ExposeHomePortal>false</ExposeHomePortal> <ExposeVisitorPortal>false</ExposeVisitorPortal> <ListCode>668477</ListCode> <ListName>Nick - Test New</ListName> <ListSize>1</ListSize> <ListType>List</ListType> <PendingApprovalCount>0</PendingApprovalCount> <SubscriptionRequiresApproval>false</SubscriptionRequiresApproval> </ContactList> </ArrayOfContactList>
-
Verify Contact List Exists
Description: Verifies that a contact list exists for the given list codeUsage:
GET api/ContactLists/Exists/{ListCode}
Parameter Type Source Description ListCode Int32 FromUri The numerical list code that uniquely identifies the contact list Returns:
True if the contact list exists.
Examples:
<!-- Intent:verifies thatcontact list with ListCode of 668487 exists GET to the following url http://api.v4.swiftreach.com/api/ContactLists/Exists/668487 --> <!-- No XML input is required --> <!-- example return value --> <boolean>true</boolean>
-
Create New Contact List
Description: Creates a new contact list and returns the new ListCodeUsage:
POST api/ContactLists/Create
Parameter Type Source Description ListProfile ContactList FromBody The ContactList object to create. Returns:
Returns the unique numerical ListCode that identifies the new contact list.
Examples:
<!-- Intent: create a new contact list POST to the following url http://api.v4.swiftreach.com/api/ContactLists/Create --> <!-- No XML input is required --> <ContactList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema/SwiftReach.Swift911.Core.ContactLists"> <DeleteLocked>false</DeleteLocked> <Description>Peter Test</Description> <ExposeHomePortal>false</ExposeHomePortal> <ExposeVisitorPortal>false</ExposeVisitorPortal> <ListName>Test Contacts</ListName> <ListType>List</ListType> <SubscriptionRequiresApproval>false</SubscriptionRequiresApproval> </ContactList> <!-- example return value --> <int>123456</int>
-
Update Properties of Contact List
Description: Updates the properties for the given contact list.Usage:
PUT api/ContactLists/Update/{ListCode}
Parameter Type Source Description ListCode Int32 FromUri The numerical list code that uniquely identifies the contact list ListProfile ContactList FromBody The ContactList object with the updated properties. Returns:
Returns 0 on success.
Examples:
<!-- Intent: update contact list with list code 123456 PUT to the following url http://api.v4.swiftreach.com/api/ContactLists/Update/123456 --> <!-- No XML input is required --> <ContactList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema/SwiftReach.Swift911.Core.ContactLists"> <ListCode>123456</ListCode> <DeleteLocked>false</DeleteLocked> <Description>Peter Test</Description> <ExposeHomePortal>false</ExposeHomePortal> <ExposeVisitorPortal>false</ExposeVisitorPortal> <ListName>Test Contacts</ListName> <ListType>List</ListType> <SubscriptionRequiresApproval>false</SubscriptionRequiresApproval> </ContactList> <!-- example return value --> <int>0</int>
-
Delete a Contact List
Description: Deletes the contact listUsage:
DELETE api/ContactLists/Delete/{ListCode}
Parameter Type Source Description ListCode Int32 FromUri The numerical list code that uniquely identifies the contact list Returns:
Returns 0 on success.
Examples:
<!-- Intent: Delete the contact list with ListCode of 123456 DELETE to the following url http://api.v4.swiftreach.com/api/ContactLists/Delete/123456 --> <!-- No XML input is required --> <!-- example return value --> <int>0</int>
-
Get Profile of a Contact List
Description: Returns the profile for the specified contact listUsage:
GET api/ContactLists/{ListCode}
Parameter Type Source Description ListCode Int32 FromUri The numerical list code that uniquely identifies the contact list Returns:
The ContactList profile object for the given list code.
Examples:
<!-- Intent: get a the profile of contact list with ListCode of 668487 GET to the following url http://api.v4.swiftreach.com/api/ContactLists/668487 --> <!-- No XML input is required --> <!-- example return value --> <ContactList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.ContactLists"> <ChangeStamp>2013-03-25T23:46:08.82</ChangeStamp> <ChangedByUser>pbacigalupi</ChangedByUser> <CreateStamp>2013-03-23T16:05:33.937</CreateStamp> <CreatedByUser>pbacigalupi</CreatedByUser> <DeleteLocked>false</DeleteLocked> <Description>Peter Test</Description> <ExposeHomePortal>false</ExposeHomePortal> <ExposeVisitorPortal>false</ExposeVisitorPortal> <ListCode>668487</ListCode> <ListName>Peter Test</ListName> <ListSize>1</ListSize> <ListType>List</ListType> <PendingApprovalCount>0</PendingApprovalCount> <SubscriptionRequiresApproval>false</SubscriptionRequiresApproval> </ContactList>