POST api/v1/CustomerServiceLevel

Retrieve the list of customer service levels.
It may be desirable to tell Caliq than an customer needs a specific service leevl rather than the default
Leave null/0 to use the default customer service level or specify the ID to use
The service level is an optional field when creating a customer

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 service levels 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

CustomerServiceLevels
NameDescriptionTypeAdditional information
ServiceLevelList

Collection of CustomerServiceLevel

None.

Response Formats

application/json, text/json

Sample: 
{
  "ServiceLevelList": [
    {
      "ID": 64,
      "Description": "sample string 2"
    },
    {
      "ID": 64,
      "Description": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<CustomerServiceLevels xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Level>
    <ID>64</ID>
    <Description>sample string 2</Description>
  </Level>
  <Level>
    <ID>64</ID>
    <Description>sample string 2</Description>
  </Level>
</CustomerServiceLevels>