# Calendars

---

- [All Calendars](#all-calendars)
- [Single Calendar](#calendar)
- [Create a Calendar](#create-calendar)
- [Update a Calendar](#update-calendar)
- [Delete a Calendar](#delete-calendar)

<a name="all-calendars"></a>
## All Calendars

You can get a list of all the calendars 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 | `calendars` | Default |

### Results
```json
{
    "data": [
        {
            "id": 3,
            "name": "Georgian Calendar",
            "entry": "\n<p>Lorem Ipsum</p>\n",
            "image": "{path}",
            "image_full": "{url}",
            "image_thumb": "{url}",
            "is_private": false,
            "entity_id": 78,
            "tags": [],
            "created_at": {
                "date": "2017-10-31 18:19:47.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "created_by": null,
            "updated_at": {
                "date": "2018-09-20 09:17:41.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "updated_by": 1,
            "type": "Primary",
            "date": "311-2-3",
            "parameters": null,
            "months": [
              {
                "name": "January",
                "length": 31,
                "type": "standard"
              },
              {
                "name": "February",
                "length": 5,
                "type": "intercalary"
              }
            ],
            "years": [],
            "seasons": [],
            "moons": [],
            "suffix": "BC",
            "has_leap_year": true,
            "leap_year_amount": 4,
            "leap_year_month": 2,
            "leap_year_offset": 3,
            "leap_year_start": 233
        }
    ]
}
```


<a name="calendar"></a>
## Calendar

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

| Method | Endpoint| Headers |
| :- |   :-   |  :-  |
| GET/HEAD | `calendars/{calendar.id}` | Default |

### Results
```json
{
    "data": {
        "id": 3,
        "name": "Georgian Calendar",
        "entry": "\n<p>Lorem Ipsum</p>\n",
        "image": "{path}",
        "image_full": "{url}",
        "image_thumb": "{url}",
        "is_private": false,
        "entity_id": 78,
        "tags": [],
        "created_at": {
            "date": "2017-10-31 18:19:47.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "created_by": null,
        "updated_at": {
            "date": "2018-09-20 09:17:41.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "updated_by": 1,
        "type": "Primary",
        "date": "311-2-3",
        "parameters": null,
        "months": [
          {
            "name": "January",
            "length": 31,
            "type": "standard"
          },
          {
            "name": "February",
            "length": 5,
            "type": "intercalary"
          }
        ],
        "years": [],
        "seasons": [],
        "moons": [],
        "suffix": "BC",
        "has_leap_year": true,
        "leap_year_amount": 4,
        "leap_year_month": 2,
        "leap_year_offset": 3,
        "leap_year_start": 233
    }
    
}
```


<a name="create-calendar"></a>
## Create a Calendar

To create a calendar, use the following endpoint.

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

### Body

| Parameter | Type | Detail |
| :- |   :-   |  :-  |
| `name` | `string` (Required) | Name of the calendar |
| `type` | `string` | The calendar's type |
| `current_year` | `integer` | The current calendar year |
| `current_month` | `integer` | The current calendar month |
| `current_day` | `integer` | The current calendar day |
| `tags` | `array` | Array of tag ids |
| `month_name` | `array` (required, min 2) | Array of month names |
| `month_length` | `array` | Array of month lengths |
| `month_type` | `array` | Array of month types (standard or intercalary) |
| `weekday` | `array` (required, min 2) | Array of weekday names |
| `year_name` | `array` | Array of year names |
| `year_number` | `array` | Array of year numbers |
| `moon_name` | `array` | Array of moon names |
| `moon_fullmoon` | `array` | Array of when (every how many days) a full moon occurs |
| `epoch_name` | `array` | Array of epoch names |
| `season_name` | `array` | Array of season names |
| `season_month` | `array` | Array of seasons month start |
| `season_day` | `array` | Array of seasons day start |
| `has_leap_year` | `boolean` | Whether the calendar has leap years |
| `leap_year_amount` | `integer` | The amount of leap days |
| `leap_year_offset` | `integer` | Every how many years the leap days occur |
| `leap_year_start` | `integer` | The year from which the leap days start occurring  |
| `tags` | `array` | Array of tag ids |
| `tags` | `array` | Array of tag ids |
| `tags` | `array` | Array of tag ids |
| `is_private` | `boolean` | If the calendar is only visible to `admin` members of the campaign |
| `image` | `stream` | Stream to file uploaded to the calendar |
| `image_url` | `string` | URL to a picture to be used for the calendar |

### Results

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


<a name="update-calendar"></a>
## Update a Calendar

To update a calendar, use the following endpoint.

| Method | Endpoint| Headers |
| :- |   :-   |  :-  |
| PUT/PATCH | `calendars/{calendar.id}` | Default |

### Body

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

### Results

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


<a name="delete-calendar"></a>
## Delete a Calendar

To delete a calendar, use the following endpoint.

| Method | Endpoint| Headers |
| :- |   :-   |  :-  |
| DELETE | `calendars/{calendar.id}` | Default |

### Results

> {success} Code 200 with JSON.