CCC API v8.12.0.0

GetRoles

The following routes are available for this service:
GET	/api/roles	List roles.

**GetRoles** Parameters:
Name	Parameter	Data Type	Required	Description
Page	query	String	No	The Page number being requested. Defaults to 1.
PageSize	query	String	No	The Page Size returned by the operation. Defaults to 25.

**RolesPagedResponse** Parameters:
Name	Parameter	Data Type	Required
PageSize	body	Integer	No
TotalPages	body	Integer	No
TotalItems	body	Integer	No
CurrentPage	body	Integer	No
Results	body	Role[]	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

**Role** Parameters:
Name	Parameter	Data Type	Required
Name	body	String	No
CreatedOn	body	DateTime	No
Guid	body	Guid	No

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/roles 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": [
    {
      "name": "String",
      "createdOn": "0001-01-01T00:00:00Z",
      "guid": "00000000000000000000000000000000"
    }
  ],
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  }
}