CCC API v8.4.0.0

<back to all web services

GetSkus

The following routes are available for this service:
GET/api/partners/{PartnerGuid}/skus/Get a Partners Skus.
GetSkus Parameters:
NameParameterData TypeRequiredDescription
PartnerGuidpathGuidYesGuid of the Partner.
SkuBundleGuidqueryGuidNoGuid of the parent SkuBundle.
StatusqueryStringNoGets only Skus matching this Status. Defaults to Active

Allowable Values

  • Active
  • Disabled
PagequeryIntegerNoThe Page number being requested. Defaults to 1.
PageSizequeryIntegerNoThe Page Size returned by the operation. Defaults to 25.
SkusPagedResponse Parameters:
NameParameterData TypeRequiredDescription
PageSizebodyIntegerNo
TotalPagesbodyIntegerNo
TotalItemsbodyIntegerNo
CurrentPagebodyIntegerNo
ResultsbodySku[]No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
Sku Parameters:
NameParameterData TypeRequiredDescription
SkuGuidbodyGuidNo
NameformstringNo
BillingMetricformstringNo

Allowable Values

  • NoMetric
  • ProUsersCount
  • NumberOfMessagesEntitlement
  • NumberOfMessagesOverage
  • DataTransfer50GbEntitlement
  • DataTransferAmountInGbEntitlement
  • DataTransferAmountPerUserInGbEntitlement
  • DataTransferAmountInGbOverage
  • MftDataTransfer50GbEntitlement
  • MftDataTransferAmountInGbEntitlement
  • MftDataTransferAmountPerUserInGbEntitlement
  • MftDataTransferAmountInGbOverage
QuantitybodyIntegerNo
UnitPricebodyDecimalNo
DescriptionformstringNo
StatusformstringNo

Allowable Values

  • Active
  • Disabled

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/partners/{PartnerGuid}/skus/ HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json

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

{
  "pageSize": 0,
  "totalPages": 0,
  "totalItems": 0,
  "currentPage": 0,
  "results": [
    {
      "skuGuid": "00000000000000000000000000000000",
      "name": "String",
      "billingMetric": "String",
      "quantity": 0,
      "unitPrice": 0,
      "description": "String",
      "status": "String"
    }
  ],
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  }
}