POST api/v1/CustomerChange

Returns a collection of customers which have been added or updated in Caliq since a supplied date
This list can then be used to request full customer data

Request Information

URI Parameters

None.

Body Parameters

CustomerChangeParams

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
ChangesSince	List customers changed on and since YYYYMMDD. If supplied empty then all customers will be returned	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ChangesSince": "sample string 1",
  "apiKey": "sample string 1"
}

application/xml, text/xml

Sample:

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

Response Information

Resource Description

Returns:
200 OK Returns collection of customer id's and account codes
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
204 No Content if no customers were updated or added since the date supplied 503 Service Unavailable

CustomerChanges

Name	Description	Type	Additional information
CustomerChangeList		Collection of ChangedCustomer	None.

Response Formats

application/json, text/json

Sample:

{
  "CustomerChangeList": [
    {
      "ID": 1,
      "AccountNo": "sample string 2"
    },
    {
      "ID": 1,
      "AccountNo": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<CustomerChanges xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ChangedCustomer>
    <ID>1</ID>
    <AccountNo>sample string 2</AccountNo>
  </ChangedCustomer>
  <ChangedCustomer>
    <ID>1</ID>
    <AccountNo>sample string 2</AccountNo>
  </ChangedCustomer>
</CustomerChanges>