[HTTP GET] ~/contactLists/{contactListId}

Description: Get a specific ContactList

Request Information

ODATA Queryable

URI Parameters

NameDescriptionTypeAdditional information
contactListId

integer

Required

Body Parameters

None

Response Information

Description

Successful Response - OK (200):

Response Content : 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
    • The specified Contactlist 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.
  • 404 - NotFound
    • The specified Contactlist was not found.
  • 500 - InternalServerError
    • An error occurred while processing this request.

Formats

application/json, text/json

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

application/csp-report

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

application/xml, text/xml

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