GET contactLists/{contactListId}/fields

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

Description: Get a specific ContactList's fields

Request Information

URI Parameters

Name	Description	Type	Additional information
contactListId		integer	Required

Body Parameters

None

Response Information

Description

Successful Response - OK (200):

Response Content : Collection of ContactSchemaField

Name	Description	Type	Additional information
Id	The id of the ContactSchema Field	integer	None.
Name	The Name of the Field - used for Filtering,etc...	string	None.
DefaultValue	The Default value of the Field, if not other value is applied	string	None.
MapType	The Type of Field	string	None.
Position	The position of the field in the Contact Schema's Field List	integer	None.
ContactSchemaFieldValues	The list of values for the field	Collection of ContactSchemaFieldValue	None.

Response Codes:

200 - OK
- The specified Contactlist's fields 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 was not found.
500 - InternalServerError
- An error occurred while processing this request.

Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Name": "sample string 2",
    "DefaultValue": "sample string 3",
    "MapType": "sample string 4",
    "Position": 5,
    "ContactSchemaFieldValues": [
      {
        "Id": 1,
        "Value": "sample string 2",
        "Order": 3,
        "InUse": true
      },
      {
        "Id": 1,
        "Value": "sample string 2",
        "Order": 3,
        "InUse": true
      }
    ]
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "DefaultValue": "sample string 3",
    "MapType": "sample string 4",
    "Position": 5,
    "ContactSchemaFieldValues": [
      {
        "Id": 1,
        "Value": "sample string 2",
        "Order": 3,
        "InUse": true
      },
      {
        "Id": 1,
        "Value": "sample string 2",
        "Order": 3,
        "InUse": true
      }
    ]
  }
]

application/csp-report

Sample:

[{"Id":1,"Name":"sample string 2","DefaultValue":"sample string 3","MapType":"sample string 4","Position":5,"ContactSchemaFieldValues":[{"Id":1,"Value":"sample string 2","Order":3,"InUse":true},{"Id":1,"Value":"sample string 2","Order":3,"InUse":true}]},{"Id":1,"Name":"sample string 2","DefaultValue":"sample string 3","MapType":"sample string 4","Position":5,"ContactSchemaFieldValues":[{"Id":1,"Value":"sample string 2","Order":3,"InUse":true},{"Id":1,"Value":"sample string 2","Order":3,"InUse":true}]}]

application/xml, text/xml

Sample:

<ArrayOfContactSchemaField xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO">
  <ContactSchemaField>
    <ContactSchemaFieldValues>
      <ContactSchemaFieldValue>
        <Id>1</Id>
        <InUse>true</InUse>
        <Order>3</Order>
        <Value>sample string 2</Value>
      </ContactSchemaFieldValue>
      <ContactSchemaFieldValue>
        <Id>1</Id>
        <InUse>true</InUse>
        <Order>3</Order>
        <Value>sample string 2</Value>
      </ContactSchemaFieldValue>
    </ContactSchemaFieldValues>
    <DefaultValue>sample string 3</DefaultValue>
    <Id>1</Id>
    <MapType>sample string 4</MapType>
    <Name>sample string 2</Name>
    <Position>5</Position>
  </ContactSchemaField>
  <ContactSchemaField>
    <ContactSchemaFieldValues>
      <ContactSchemaFieldValue>
        <Id>1</Id>
        <InUse>true</InUse>
        <Order>3</Order>
        <Value>sample string 2</Value>
      </ContactSchemaFieldValue>
      <ContactSchemaFieldValue>
        <Id>1</Id>
        <InUse>true</InUse>
        <Order>3</Order>
        <Value>sample string 2</Value>
      </ContactSchemaFieldValue>
    </ContactSchemaFieldValues>
    <DefaultValue>sample string 3</DefaultValue>
    <Id>1</Id>
    <MapType>sample string 4</MapType>
    <Name>sample string 2</Name>
    <Position>5</Position>
  </ContactSchemaField>
</ArrayOfContactSchemaField>