POST api/v1/ProductImageType

Retrieve the list of supported image types. This is required when asking for an actual product image

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 supported image types as XML or JSON
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
503 Service Unavailable

ProductImageTypes
NameDescriptionTypeAdditional information
ImageTypeList

Collection of ProductImageType

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

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