GET /external/api/v3/customerdatacolumn

Gets a list of customer data columns.

Request Information

URI Parameters

Name	Description	Type	Additional information	Nullable
Required	Filter required customer data columns. If null - both will be included in the resultset.	boolean	None	True
Archived	Filter archived customer data columns. If null - both will be included in the resultset.	boolean	None	True
CustomerDataColumnIds	Filter on customer data column ids.	Collection of integer	None	False

Body Parameters

None.

Response Information

Resource Description

List of customer data columns.

GetCustomerDataColumnResponse

Name	Description	Type	Additional information	Nullable
CustomerDataColumns		Collection of CustomerDataColumn	None	False

Response Formats

application/json, text/json

Sample:

{
  "CustomerDataColumns": [
    {
      "Id": 1,
      "Required": true,
      "Archived": true,
      "Name": "sample string 4",
      "DisplayName": "sample string 5"
    },
    {
      "Id": 1,
      "Required": true,
      "Archived": true,
      "Name": "sample string 4",
      "DisplayName": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:

<GetCustomerDataColumnResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V1.Responses">
  <CustomerDataColumns xmlns:d2p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
    <d2p1:CustomerDataColumn>
      <d2p1:Archived>true</d2p1:Archived>
      <d2p1:DisplayName>sample string 5</d2p1:DisplayName>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 4</d2p1:Name>
      <d2p1:Required>true</d2p1:Required>
    </d2p1:CustomerDataColumn>
    <d2p1:CustomerDataColumn>
      <d2p1:Archived>true</d2p1:Archived>
      <d2p1:DisplayName>sample string 5</d2p1:DisplayName>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 4</d2p1:Name>
      <d2p1:Required>true</d2p1:Required>
    </d2p1:CustomerDataColumn>
  </CustomerDataColumns>
</GetCustomerDataColumnResponse>

Response Status Codes

Status Code	Name	Description
200	OK	The request has succeeded.
400	Bad Request	Fulfilling the request would cause an invalid state. Request needs modification.
401	Unauthorized	Missing or invalid authentication token.
403	Forbidden	Server refuses to authorize the request.
408	Request Timeout	The server timed out waiting for the request.
429	Too Many Requests	Too many requests in a given amount of time.
500	Internal Server Error	The server encountered an unexpected condition which prevented it from fulfilling the request.
503	Service Unavailable	The server is unable to proces the request at the moment, try again later.