CCC API v8.4.0.0

<back to all web services

GetPartnerAdminUsers

The following routes are available for this service:
GET/api/partners/{PartnerGuid}/usersGets a paged list of Partners AdminUsers.
GetPartnerAdminUsers Parameters:
NameParameterData TypeRequiredDescription
PartnerGuidpathGuidYesThe Partner you want to get AdminUsers for.
PagequeryStringNoThe Page number being requested. Defaults to 1.
PageSizequeryStringNoThe Page Size returned by the operation. Defaults to 25.
AdminUsersPagedResponse Parameters:
NameParameterData TypeRequiredDescription
PageSizebodyIntegerNo
TotalPagesbodyIntegerNo
TotalItemsbodyIntegerNo
CurrentPagebodyIntegerNo
ResultsbodyAdminUser[]No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
AdminUser Parameters:
NameParameterData TypeRequiredDescription
UserGuidbodyGuidNo
EmailAddressformstringNo
UserTypeGuidbodyGuidNo
CreatedOnbodyDateTimeNo
UserTypeformAdminUserEnumNo

Allowable Values

  • SuperUser
  • Partner
  • Reseller
  • Service
StatusformAdminUserStatusEnumNo

Allowable Values

  • Active
  • Disabled
PermissionsformList<string>No
RolesformList<string>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/partners/{PartnerGuid}/users 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": [
    {
      "userGuid": "00000000000000000000000000000000",
      "emailAddress": "String",
      "userTypeGuid": "00000000000000000000000000000000",
      "createdOn": "0001-01-01T00:00:00Z",
      "userType": "SuperUser",
      "status": "Active",
      "permissions": [
        "String"
      ],
      "roles": [
        "String"
      ]
    }
  ],
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  }
}