POST api/v1/UserDefined

Retrieve the list of user defined fields.
Caliq supports multiple user defined fields(UDF) against products and customers. Each UDF has a description and can eaither be a simple text field or a selectable list.

Request Information

URI Parameters

None.

Body Parameters

Params
NameDescriptionTypeAdditional information
apiKey

Please contact Caliq support to get your key

string

Required

Max length: 30

Request Formats

application/json, text/json

Sample: 
{
  "apiKey": "sample string 1"
}

application/xml, text/xml

Sample: 
<Params xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
</Params>

Response Information

Resource Description

Returns:
200 OK Returns a list of active user defined field specifications as XML or JSON
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
204 No Content if there are no matching records in Caliq
503 Service Unavailable

UserDefined
NameDescriptionTypeAdditional information
UDF

Collection of UserDefinedUDF

None.

Response Formats

application/json, text/json

Sample: 
{
  "UDF": [
    {
      "AppliesTo": "sample string 1",
      "Code": "sample string 2",
      "Description": "sample string 3",
      "Type": "sample string 4",
      "Values": [
        {
          "Value": "sample string 1"
        },
        {
          "Value": "sample string 1"
        }
      ]
    },
    {
      "AppliesTo": "sample string 1",
      "Code": "sample string 2",
      "Description": "sample string 3",
      "Type": "sample string 4",
      "Values": [
        {
          "Value": "sample string 1"
        },
        {
          "Value": "sample string 1"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample: 
<UserDefined xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <UDF>
    <AppliesTo>sample string 1</AppliesTo>
    <Code>sample string 2</Code>
    <Description>sample string 3</Description>
    <Type>sample string 4</Type>
    <Values>
      <Value>sample string 1</Value>
    </Values>
    <Values>
      <Value>sample string 1</Value>
    </Values>
  </UDF>
  <UDF>
    <AppliesTo>sample string 1</AppliesTo>
    <Code>sample string 2</Code>
    <Description>sample string 3</Description>
    <Type>sample string 4</Type>
    <Values>
      <Value>sample string 1</Value>
    </Values>
    <Values>
      <Value>sample string 1</Value>
    </Values>
  </UDF>
</UserDefined>