CCC API v8.4.0.0

<back to all web services

GetServiceSkus

The following routes are available for this service:
GET/api/services/{ServiceGuid}/skusGet the ServiceSkus assigned to a Service.
GetServiceSkus Parameters:
NameParameterData TypeRequiredDescription
ServiceGuidpathGuidYesGuid of the Service.
SkuGuidqueryGuidNoFilter by the guid of the Sku that was originally used to assign the ServiceSku.
AssignedDatequeryDateTimeNoFilter by searching for ServiceSkus with an AssignedDate greater than this parameter.
EndedDatequeryDateTimeNoFilter by searching for ServiceSkus with an EndedDate less than this parameter.
PagequeryIntegerNoThe Page number being requested. Defaults to 1.
PageSizequeryIntegerNoThe Page Size returned by the operation. Defaults to 25.
ServiceSkusPagedResponse Parameters:
NameParameterData TypeRequiredDescription
PageSizebodyIntegerNo
TotalPagesbodyIntegerNo
TotalItemsbodyIntegerNo
CurrentPagebodyIntegerNo
ResultsbodyServiceSku[]No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ServiceSku Parameters:
NameParameterData TypeRequiredDescription
ServiceSkuGuidbodyGuidNo
ServiceSkuBundleGuidbodyGuidNo
SkuGuidbodyGuidNo
NameformstringNo
AssignedDatebodyDateTimeNo
EndedDatebodyDateTimeNo
BillingMetricformstringNo

Allowable Values

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

Allowable Values

  • true
  • false

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/services/{ServiceGuid}/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": [
    {
      "serviceSkuGuid": "00000000000000000000000000000000",
      "serviceSkuBundleGuid": "00000000000000000000000000000000",
      "skuGuid": "00000000000000000000000000000000",
      "name": "String",
      "assignedDate": "0001-01-01T00:00:00Z",
      "endedDate": "0001-01-01T00:00:00Z",
      "billingMetric": "String",
      "quantity": 0,
      "unitPrice": 0,
      "description": "String",
      "isEditable": false
    }
  ],
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  }
}