# Organisations

---

- [All Organisations](#all-organisations)
- [Single Organisation](#organisation)
- [Organisation Members](#organisation-members)
- [Create a Organisation](#create-organisation)
- [Update a Organisation](#update-organisation)
- [Delete a Organisation](#delete-organisation)

<a name="all-organisations"></a>
## All Organisations

You can get a list of all the organisations of a campaign by using the following endpoint.

> {warning} Don't forget that all endpoints documented here need to be prefixed with `api/{{version}}/campaigns/{campaign.id}/`.


| Method | Endpoint| Headers |
| :- |   :-   |  :-  |
| GET/HEAD | `organisations` | Default |

### Results
```json
{
    "data": [
        {
            "id": 1,
            "name": "Tiamat Cultists",
            "entry": "\n<p>Lorem Ipsum.</p>\n",
            "image": "{path}",
            "image_full": "{url}",
            "image_thumb": "{url}",
            "is_private": true,
            "entity_id": 5,
            "tags": [],
            "created_at": {
                "date": "2017-10-31 10:55:08.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "created_by": 1,
            "updated_at": {
                "date": "2018-09-20 09:18:58.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "updated_by": 1,
            "location_id": 4,
            "organisation_id": 4,
            "type": "Kingdom",
            "members": 3
        }
    ]
}
```


<a name="organisation"></a>
## Organisation

To get the details of a single organisation, use the following endpoint.

| Method | Endpoint| Headers |
| :- |   :-   |  :-  |
| GET/HEAD | `organisations/{organisation.id}` | Default |

### Results
```json
{
    "data": {
        "id": 1,
        "name": "Tiamat Cultists",
        "entry": "\n<p>Lorem Ipsum.</p>\n",
        "image": "{path}",
        "image_full": "{url}",
        "image_thumb": "{url}",
        "is_private": true,
        "entity_id": 5,
        "tags": [],
        "created_at": {
            "date": "2017-10-31 10:55:08.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "created_by": 1,
        "updated_at": {
            "date": "2018-09-20 09:18:58.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "updated_by": 1,
        "location_id": 4,
        "organisation_id": 4,
        "type": "Kingdom",
        "members": 3
    }
    
}
```


<a name="organisation-members"></a>
## Organisation Members

To get the members of an organisation, use the following endpoint.

| Method | Endpoint| Headers |
| :- |   :-   |  :-  |
| GET/HEAD | `organisations/{organisation.id}/organisation_members` | Default |

### Results
```json
{
    "data": {
        "character_id": 11,
        "created_at": {
            "date": "2017-11-02 11:30:54.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "created_by": 1,
        "id": 6,
        "is_private": false,
        "organisation_id": 1,
        "role": "Leader",
        "updated_at": {
            "date": "2017-11-02 11:30:54.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "updated_by": 1
    }
}
```

> {info} Adding (`POST`), Updating (`PUT`, `PATCH`) and Deleting (`DELETE`) a member from an organisation can also be done using the same patterns as for other endpoints.


<a name="create-organisation"></a>
## Create a Organisation

To create a organisation, use the following endpoint.

| Method | Endpoint| Headers |
| :- |   :-   |  :-  |
| POST | `organisations` | Default |

### Body

| Parameter | Type | Detail |
| :- |   :-   |  :-  |
| `name` | `string` (Required) | Name of the organisation |
| `type` | `string` | Type of organisation |
| `organisation_id` | `integer` | The parent organisation |
| `location_id` | `integer` | The organisation's location |
| `tags` | `array` | Array of tag ids |
| `is_private` | `boolean` | If the organisation is only visible to `admin` members of the campaign |
| `image` | `stream` | Stream to file uploaded to the organisation |
| `image_url` | `string` | URL to a picture to be used for the organisation |

### Results

> {success} Code 200 with JSON body of the new organisation.


<a name="update-organisation"></a>
## Update a Organisation

To update a organisation, use the following endpoint.

| Method | Endpoint| Headers |
| :- |   :-   |  :-  |
| PUT/PATCH | `organisations/{organisation.id}` | Default |

### Body

The same body parameters are available as for when creating a organisation.

### Results

> {success} Code 200 with JSON body of the updated organisation.


<a name="delete-organisation"></a>
## Delete a Organisation

To delete a organisation, use the following endpoint.

| Method | Endpoint| Headers |
| :- |   :-   |  :-  |
| DELETE | `organisations/{organisation.id}` | Default |

### Results

> {success} Code 200 with JSON.