POST api/v1/Message

Retrieve the list of system messages.
These will be returned when creating orders and customers in Caliq if there any any issues with the supplied data

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 system messages 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

Messages
NameDescriptionTypeAdditional information
MessagesList

Collection of Message

None.

Response Formats

application/json, text/json

Sample: 
{
  "MessagesList": [
    {
      "ID": 1,
      "Description": "sample string 2"
    },
    {
      "ID": 1,
      "Description": "sample string 2"
    }
  ]
}

application/xml, text/xml

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