GET api/ContactList/{auth}
Select the list of contact for user
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| auth |
Authorization token |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
ContactListResp| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful |
Used to determine if method call was successful (true) or failure (false) |
boolean |
None. |
| ErrorMessage |
The error message if method call was not successful |
string |
None. |
| Contacts | Collection of ContactListItem |
None. |
Response Formats
application/json, text/json
Sample:
{
"Contacts": [
{
"ContactListGUID": "sample string 1",
"ContactName": "sample string 6",
"ContactTitle": "sample string 7",
"EmailAddress": "sample string 8",
"MobilePhone": "sample string 10",
"OfficePhone": "sample string 9",
"SectionName": "sample string 5",
"SequenceNumber": 4,
"UserGUID": "sample string 2",
"UserGroupGUID": "sample string 3"
},
{
"ContactListGUID": "sample string 1",
"ContactName": "sample string 6",
"ContactTitle": "sample string 7",
"EmailAddress": "sample string 8",
"MobilePhone": "sample string 10",
"OfficePhone": "sample string 9",
"SectionName": "sample string 5",
"SequenceNumber": 4,
"UserGUID": "sample string 2",
"UserGroupGUID": "sample string 3"
}
],
"ErrorMessage": "sample string 2",
"IsSuccessful": true
}
application/xml, text/xml
Sample:
<ContactListResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
<Contacts>
<ContactListItem>
<ContactListGUID>sample string 1</ContactListGUID>
<ContactName>sample string 6</ContactName>
<ContactTitle>sample string 7</ContactTitle>
<EmailAddress>sample string 8</EmailAddress>
<MobilePhone>sample string 10</MobilePhone>
<OfficePhone>sample string 9</OfficePhone>
<SectionName>sample string 5</SectionName>
<SequenceNumber>4</SequenceNumber>
<UserGUID>sample string 2</UserGUID>
<UserGroupGUID>sample string 3</UserGroupGUID>
</ContactListItem>
<ContactListItem>
<ContactListGUID>sample string 1</ContactListGUID>
<ContactName>sample string 6</ContactName>
<ContactTitle>sample string 7</ContactTitle>
<EmailAddress>sample string 8</EmailAddress>
<MobilePhone>sample string 10</MobilePhone>
<OfficePhone>sample string 9</OfficePhone>
<SectionName>sample string 5</SectionName>
<SequenceNumber>4</SequenceNumber>
<UserGUID>sample string 2</UserGUID>
<UserGroupGUID>sample string 3</UserGroupGUID>
</ContactListItem>
</Contacts>
<ErrorMessage>sample string 2</ErrorMessage>
<IsSuccessful>true</IsSuccessful>
</ContactListResp>