Skip to content

Added main info for Admin administrator endpoint.Responses yet to follow #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pzhuravlenkobb wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Added main info for Admin administrator endpoint.Responses yet to follow #83

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e0b34e
Added main info for Admin administrator endpoint.Responses yet to follow
May 21, 2018
149df53
fixed the layout + more
May 23, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
267 changes: 267 additions & 0 deletions docs/rest-api/Administrator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,267 @@
# Administrator

Purpose of this API endpoint is to create / update / find an administrator for a company. This will allow access to manipulate all of the Business entities in Bookingbug as an administrator. Use-cases for the use of this api endpoint include member of staff rotation / access change requests and access terminations. This api endpoint allows functions such as: list, read, create, update, delete and find_by_ref.
This is an admin API endpoint and to make any changes, it is necessary to authenticate as an existing administrator and use the auth-token to run any of the API calls below. The details on how to do this can be viewed on the authentication page.

## List Administrators

The LIST end-point will return a list of all administrators based on the company id that was passed in the URL parameter.

<div class="tabs">
<ul class="tabs__menu">
<li class="current"><a href="#tab-1">cURL</a></li>
</ul>

<div class="tab">
<div id="tab-1" class="tab__content">
<pre>
```
curl -X GET \
https://{host}.bookingbug.com/api/v1/admin/{company_id}/administrators?page=1&per_page=30 \
-H 'App-id: {app-id}' \
-H 'App-key: {app-key}' \
-H 'auth-token: {auth-token}' \
-H 'content-type: application/json' \
-H 'Cache-Control: no-cache' \
```
</pre>
</div>
<div id="tab-2" class="tab__content">
<pre>
```
response here
```
</pre>
</div>
</div>
</div>

## Read Administrator


<div class="tabs">
<ul class="tabs__menu">
<li class="current"><a href="#tab-1">cURL</a></li>
</ul>

<div class="tab">
<div id="tab-1" class="tab__content">
<pre>
```
curl -X GET \
https://{host}.bookingbug.com/api/v1/admin/{company_id}/administrators/12 \
-H 'App-id: {app-id}' \
-H 'App-key: {app-key}' \
-H 'auth-token: {auth-token}' \
-H 'content-type: application/json' \
-H 'Cache-Control: no-cache' \
```
</pre>
</div>
<div id="tab-2" class="tab__content">
<pre>
```
response here
```
</pre>
</div>
</div>
</div>

## Create an Administrator

This is an example of how it is possible to create an Administrator account.

#### Parameters

<table class="pure-table">
<thead>
<tr>
<th>Name</th>
<th>Datatype</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td>string</td>
<td>Name of the administrator</td>
</tr>
<tr>
<td>email</td>
<td>string</td>
<td>Email of the administrator</td>
</tr>
<tr>
<td>role</td>
<td>string</td>
<td>Role of the Administrator, "owner", "admin, "user", "callcentre"</td>
</tr>
<tr>
<td>password</td>
<td>string</td>
<td>Password_for_the_administrator</td>
</tr>
<tr>
<td>password_confirmation</td>
<td>string</td>
<td>Password_for_the_administrator</td>
</tr>
</tbody>
</table>

<div class="tabs">
<ul class="tabs__menu">
<li class="current"><a href="#tab-1">cURL</a></li>
</ul>
<div class="tab">
<div id="tab-1" class="tab__content">
<pre>
```
curl -X GET \
https://{host}.bookingbug.com/api/v1/admin/{company_id}/administrators/12 \
-H 'App-id: {app-id}' \
-H 'App-key: {app-key}' \
-H 'auth-token: {auth-token}' \
-H 'content-type: application/json' \
-H 'Cache-Control: no-cache' \
```
</pre>
</div>
<div id="tab-2" class="tab__content">
<pre>
```
response here
```
</pre>
</div>
</div>
</div>


## Update Administrator

Please proceed with caution and ensure that there is another admin who can administer the company at the right permission level, otherwise there is a risk that the admin who's access is being updated could get locked out.

#### Parameters

<table class="pure-table">
<thead>
<tr>
<th>Name</th>
<th>Datatype</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td>string</td>
<td>Name of the administrator (required when updating an administrator)</td>
</tr>
<tr>
<td>role</td>
<td>string</td>
<td>Role of the Administrator, "owner", "admin, "user", "callcentre"</td>
</tr>
<tr>
<td>reference</td>
<td>string</td>
<td>External reference</td>
</tr>
</tbody>
</table>

<div class="tabs">
<ul class="tabs__menu">
<li class="current"><a href="#tab-1">cURL</a></li>
</ul>
<div class="tab">
<div id="tab-1" class="tab__content">
<pre>
```
curl -X PUT \
https://{host}.bookingbug.com/api/v1/admin/{company_id}/administrators/12 \
-H 'App-id: {app-id}' \
-H 'App-key: {app-key}' \
-H 'auth-token: {auth-token}' \
-H 'content-type: application/json' \
-H 'Cache-Control: no-cache' \
-d '{
"name": "John Smith",
"role": "admin",
"reference": "new_external_reference"
}'
```
</pre>
</div>
<div id="tab-2" class="tab__content">
<pre>
```
response here
```
</pre>
</div>
</div>
</div>

## Find By Ref Administrator

<div class="tabs">
<ul class="tabs__menu">
<li class="current"><a href="#tab-1">cURL</a></li>
</ul>
<div class="tab">
<div id="tab-1" class="tab__content">
<pre>
```
curl -X GET \
https://{host}.bookingbug.com/api/v1/admin/{company_id}/administrators/find_by_ref/new_external_reference \
-H 'App-id: {app-id}' \
-H 'App-key: {app-key}' \
-H 'auth-token: {auth-token}' \
-H 'content-type: application/json' \
-H 'Cache-Control: no-cache' \
```
</pre>
</div>
<div id="tab-2" class="tab__content">
<pre>
```
response here
```
</pre>
</div>
</div>
</div>

## Delete Administrator

<div class="tabs">
<ul class="tabs__menu">
<li class="current"><a href="#tab-1">cURL</a></li>
</ul>
<div class="tab">
<div id="tab-1" class="tab__content">
<pre>
```
curl -X DELETE \
https://{host}.bookingbug.com/api/v1/admin/{company_id}/administrators/12 \
-H 'App-id: {app-id}' \
-H 'App-key: {app-key}' \
-H 'auth-token: {auth-token}' \
-H 'content-type: application/json' \
-H 'Cache-Control: no-cache' \
```
</pre>
</div>
<div id="tab-2" class="tab__content">
<pre>
```
response here
```
</pre>
</div>
</div>
</div>