CCC API v8.4.0.0

<back to all web services

GetPartnerCollections

The following routes are available for this service:
GET/api/partners/{PartnerGuid}/collectionsGets a list of Collections that a Partner has access to.
GetPartnerCollections Parameters:
NameParameterData TypeRequiredDescription
PartnerGuidpathGuidYesThe Guid of the Partner
ResellerCollection Parameters:
NameParameterData TypeRequiredDescription
IsDefaultCollectionForSitebodyBooleanNo
Collection Parameters:
NameParameterData TypeRequiredDescription
CollectionGuidbodyGuidNo
NameformstringNo
CollectionCodeformstringNo
StatusformstringNo

Allowable Values

  • Active
  • Disabled
CreatedOnformDateTimeNo
ServicesApiBaseUrlformstringNo
SiteGuidbodyGuidNo
SiteEndpointbodySiteEndpointNo
SiteEndpoint Parameters:
NameParameterData TypeRequiredDescription
SiteGuidbodyGuidNo
GuidbodyGuidNo
NamebodyStringNo
SiteVersionbodyStringNo
DescriptionbodyStringNo
UrlbodyStringNo
CreatedOnbodyDateTimeNo

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}/collections HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

[]