CCC API v8.12.0.0

<back to all web services

PublicGetAsset

The following routes are available for this service:
GET/api/public/assets/{AssetCode}
PublicGetAsset Parameters:
NameParameterData TypeRequiredDescription
AssetCodequeryStringNoThe asset code.
PublicGetAssetResponse Parameters:
NameParameterData TypeRequiredDescription
ServiceGuidbodyGuidNo
ServiceStatusformServiceStatusNo
ServiceNameformstringNo
ServiceCodeformstringNo
AssetGuidbodyGuidNo
AssetTypebodyAssetTypeNo

Allowable Values

  • Attachment
  • Message
  • User
WebAppAssetLinkformstringNo
BrandingformDictionary<string, string>No
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.

GET /api/public/assets/{AssetCode} HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json

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

{
  "serviceGuid": "00000000000000000000000000000000",
  "serviceStatus": "Blocked",
  "serviceName": "String",
  "serviceCode": "String",
  "assetGuid": "00000000000000000000000000000000",
  "assetType": "String",
  "webAppAssetLink": "String",
  "branding": {
    "String": "String"
  },
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  }
}