Skip to content

Roles

Use this endpoint to obtain details on Adaptix's roles (administrators).

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
<?php
use Adaptix\AdaptixApi;
use Adaptix\Auth\ApiAuth;

// ...
$initAuth = new ApiAuth();
$auth     = $initAuth->newAuth($settings);
$apiUrl   = "https://your-adaptix.ai";
$api      = new AdaptixApi();
$roleApi  = $api->newApi("roles", $auth, $apiUrl);

Get Role

1
2
3
4
<?php

//...
$role = $roleApi->get($id);

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{  
  "role":{  
    "isPublished":true,
    "dateAdded":"2016-11-09T15:24:32+00:00",
    "createdBy":1,
    "createdByUser":"John Doe",
    "dateModified":null,
    "modifiedBy":null,
    "modifiedByUser":null,
    "id":13,
    "name":"API test role",
    "description":"created via AIP",
    "isAdmin":false,
    "rawPermissions":{  
      "email:emails":[  
        "viewown",
        "viewother"
      ]
    }
  }
}
Get an individual role by ID.

HTTP Request

GET /roles/ID

Response

Expected Response Code: 200

See JSON code example.

Role Properties

Name Type Description
id int ID of the contact
dateAdded datetime Date/time contact was created
createdBy int ID of the role that created the contact
createdByRole string Name of the role that created the contact
dateModified datetime/null Date/time contact was last modified
modifiedBy int ID of the role that last modified the contact
modifiedByRole string Name of the role that last modified the contact
name string Name of the role
description string Description of the role
isAdmin boolean Whether the role has full access or only some
rawPermissions array List of roles

List Contact Roles

1
2
3
4
<?php

//...
$roles = $roleApi->getList($searchFilter, $start, $limit, $orderBy, $orderByDir, $publishedOnly, $minimal);

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{  
  "total":9,
  "roles":[  
    {  
      "isPublished":true,
      "dateAdded":"2016-08-01T11:51:32+00:00",
      "createdBy":1,
      "createdByUser":"John Doe",
      "dateModified":null,
      "modifiedBy":null,
      "modifiedByUser":null,
      "id":2,
      "name":"view email",
      "description":null,
      "isAdmin":false,
      "rawPermissions":{  
        "email:emails":[  
          "viewown",
          "viewother"
        ]
      }
    },
    [...]
  ]
}

HTTP Request

GET /roles

Response

Expected Response Code: 200

See JSON code example.

Role Properties

Name Type Description
id int ID of the contact
dateAdded datetime Date/time contact was created
createdBy int ID of the role that created the contact
createdByRole string Name of the role that created the contact
dateModified datetime/null Date/time contact was last modified
modifiedBy int ID of the role that last modified the contact
modifiedByRole string Name of the role that last modified the contact
name string Name of the role
description string Description of the role
isAdmin boolean Whether the role has full access or only some
rawPermissions array List of roles

Create Role

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
<?php 

$data = array(
    'name' => 'API test role',
    'description' => 'created via AIP',
    'rawPermissions' => array (
        'email:emails' => 
        array (
            'viewown',
            'viewother',
        ),
    )
);

$role = $roleApi->create($data);
Create a new role.

HTTP Request

POST /roles/new

Post Parameters

Name Description
name string
description string
isAdmin boolean
rawPermissions array

Response

Expected Response Code: 201

Properties

Same as Get Role.

Edit Role

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
<?php

$id   = 1;
$data = array(
    'name' => 'API test role',
    'description' => 'created via AIP',
    'rawPermissions' => array (
        'email:emails' => 
        array (
            'editown',
            'editother',
        ),
    )
);

// Create new a role of ID 1 is not found?
$createIfNotFound = true;

$role = $roleApi->edit($id, $data, $createIfNotFound);
Edit a new role. Role that this supports PUT or PATCH depending on the desired behavior.

PUT creates a role if the given ID does not exist and clears all the role information, adds the information from the request. PATCH fails if the role with the given ID does not exist and updates the role field values with the values form the request.

HTTP Request

To edit a role and return a 404 if the role is not found:

PATCH /roles/ID/edit

To edit a role and create a new one if the role is not found:

PUT /roles/ID/edit

Post Parameters

Name Description
name string
description string
isAdmin boolean
rawPermissions array

Response

If PUT, the expected response code is 200 if the role was edited or 201 if created.

If PATCH, the expected response code is 200.

Properties

Same as Get Role.

Delete Role

1
2
3
<?php

$role = $roleApi->delete($id);
Delete a role.

HTTP Request

DELETE /roles/ID/delete

Response

Expected Response Code: 200

Properties

Same as Get Role.