Get All Delegates

Gets the citizen users delegated by the logged-in user.

Resource Information

Scopeusers

Deprecated scope name:   get_citizenaccess_citizens_delegates

App TypeCitizen
Authorization TypeAccess token
URI /v4/citizenaccess/citizens/delegates?userName={userName}&name={name}&delegateStatus={delegateStatus}&offset={offset}&limit={limit}&lang={lang}
HTTP MethodGET
Automation Version(s)7.3.3.5

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
delegateStatusstringNoPENDING | ACCEPT | REJECT | EXPIREDThe status of the delegate request.7.3.3.5
langStringNo Indicates the language applied.7.3.3.5
limitlongNo Indicates the number of items that are returned in each page.7.3.3.5
namestringNo The name of the object to be queried.7.3.3.5
offsetlongNo Indicates the offset start of each page by the number specified.7.3.3.5
userNamestringNo The login name of the user to be queried.7.3.3.5

Example

Sample Request Head

GET https://apis.accela.com/v4/citizenaccess/citizens/delegates

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.3.5
result.delegateStatusstringThe status of the delegate request.7.3.3.5
result.idlongThe delegate id.7.3.3.5
result.invitationMessagestringThe invitation message sent to the delegate.7.3.3.5
result.namestringThe delegate's nick name.7.3.3.5
result.permissions[]result.permissions{}Contains delegate permission attributes.7.3.3.5
result.permissions.amendAllowedbooleanIf true, the delegate is allowed to amend records.7.3.3.5
result.permissions.createRecordAllowedbooleanIf true, the delegate is allowed to create records.7.3.3.5
result.permissions.documentAllowedbooleanIf true, the delegate is allowed to manage documents.7.3.3.5
result.permissions.inspectionAllowedbooleanIf true, the delegate is allowed to manage inspections.7.3.3.5
result.permissions.levelstringThe permission level.7.3.3.5
result.permissions.levelValuestringThe value for the permission level, as configured in Automation.7.3.3.5
result.permissions.paymentAllowedbooleanIf true, the delegate is allowed to make payments.7.3.3.5
result.permissions.renewalAllowedbooleanIf true, the delegate is allowed to renew records.7.3.3.5
result.permissions.viewRecordAllowedbooleanIf true, the delegate is allowed to view records.7.3.3.5
result.userNamestringThe delegate's login name.7.3.3.5
statusintegerThe record status.7.3.3.5

Example

Sample Response Body

{
  "result": [
    {
      "name": "testdelegate",
      "permissions": [
        {
          "level": "MODULE",
          "levelValue": "Building",
          "paymentAllowed": false,
          "createRecordAllowed": false,
          "renewalAllowed": false,
          "documentAllowed": false,
          "amendAllowed": false,
          "viewRecordAllowed": true,
          "inspectionAllowed": false
        }
      ],
      "id": 8775,
      "userName": "apiextuser2@accela.com",
      "invitationMessage": "You are invited",
      "delegateStatus": "PENDING"
    }
  ],
  "status": 200,
  "page": {
    "offset": 0,
    "limit": 25,
    "hasmore": false
  }
}