CCC API v8.12.0.0

<back to all web services

SetServiceImage

The following routes are available for this service:
POST/api/services/{ServiceGuid}/images/{ImageType}Set a Services image.The HttpRequest's Files property must contain a single valid image file ,in other words, a valid image file must be POSTed along with the request. The file name will be ignored.
SetServiceImage Parameters:
NameParameterData TypeRequiredDescription
ServiceGuidpathGuidYesThe ServiceGuid you want to apply the image to
ImageTypebodyStringNoThe type of service image you want to set

Allowable Values

  • FavIco
  • Banner
  • Square24x
  • Square48x
  • Square64x
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/services/{ServiceGuid}/images/{ImageType} HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{
  "serviceGuid": "00000000000000000000000000000000",
  "imageType": "String"
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  }
}