[HTTP GET] ~/contactLists/{contactListId}/linkeddata

Description: Get a list of Linked Data for a specific contact list

Request Information

ODATA Queryable

URI Parameters

NameDescriptionTypeAdditional information
contactListId

integer

Required

Body Parameters

None

Response Information

Description

Successful Response - OK (200):

Response Content : Collection of LinkedData

NameDescriptionTypeAdditional information
Id

The ID of the Linked Data List

 integer

None.
ContactListId

The ID of the Linked Data's ContactList

 integer

None.
Name

The Name of the Linked Data List

 string

None.
Type

The type of the Linked Data List - Contact(Transactional) or Lookup

 string

None.
IsPublic

If the LinkedData List is accessible without Authorisation

 boolean

None.

Response Codes:

  • 200 - OK
    • The specified Linked Data were 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 or Linked Data were not found.
  • 500 - InternalServerError
    • An error occurred while processing this request.

Formats

application/json, text/json

Sample: 
[
  {
    "Id": 1,
    "ContactListId": 2,
    "Name": "sample string 3",
    "Type": "sample string 4",
    "IsPublic": true
  },
  {
    "Id": 1,
    "ContactListId": 2,
    "Name": "sample string 3",
    "Type": "sample string 4",
    "IsPublic": true
  }
]

application/csp-report

Sample: 
[{"Id":1,"ContactListId":2,"Name":"sample string 3","Type":"sample string 4","IsPublic":true},{"Id":1,"ContactListId":2,"Name":"sample string 3","Type":"sample string 4","IsPublic":true}]

application/xml, text/xml

Sample: 
<ArrayOfLinkedData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO">
  <LinkedData>
    <ContactListId>2</ContactListId>
    <Id>1</Id>
    <IsPublic>true</IsPublic>
    <Name>sample string 3</Name>
    <Type>sample string 4</Type>
  </LinkedData>
  <LinkedData>
    <ContactListId>2</ContactListId>
    <Id>1</Id>
    <IsPublic>true</IsPublic>
    <Name>sample string 3</Name>
    <Type>sample string 4</Type>
  </LinkedData>
</ArrayOfLinkedData>