[HTTP GET] ~/contactLists

Description: Gets a list of ContactLists

Request Information

ODATA Queryable

URI Parameters

None.

Body Parameters

None

Response Information

Description

Successful Response - OK (200):

A collection of ContactLists

Response Content : Collection of ContactsList

NameDescriptionTypeAdditional information
Id

The Id of the Contact List

 integer

None.
Name

The Name of the ContactList

 string

None.
Count

The Number of Contacts within the ContactList

 integer

None.

Response Codes:

  • 200 - OK
    • List of ContactsLists was retrieved and returned successfully.
  • 401 - Unauthorized
    • Request has been denied as it lacks valid Authentication credentials.
  • 403 - Forbidden
    • The user does not have the relevant permissions to perform this action.
  • 500 - InternalServerError
    • An error occurred while processing this request.

Formats

application/json, text/json

Sample: 
[
  {
    "Id": 1,
    "Name": "sample string 2",
    "Count": 3
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "Count": 3
  }
]

application/csp-report

Sample: 
[{"Id":1,"Name":"sample string 2","Count":3},{"Id":1,"Name":"sample string 2","Count":3}]

application/xml, text/xml

Sample: 
<ArrayOfContactsList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO">
  <ContactsList>
    <Count>3</Count>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </ContactsList>
  <ContactsList>
    <Count>3</Count>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </ContactsList>
</ArrayOfContactsList>