## Endpoint: `/api/bulletin/create_alert_bullet/`
**Method**: `POST`
**Description**: Create a new Shift Note on a specific alert.
### Parameters
|Parameter|Type|Required|Description|Example Value|
|---|---|---|---|---|
|None|-|-|No parameters required|-|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Request Payload
{
"customer": "{Customerid}",
"alert": "{Alertid}",
"body": "{BODY}",
"title": "{TITLE}",
"public": true
}
### Example Response
{
"id": <Alertid>,
... NOTE DETAILS ...
}
---
## Endpoint: `/api/bulletin/
**Method**: `GET`
**Description**: Retrieve all the memos.
### Parameters
| Parameter | Type | Required | Description | Example Value |
| --------- | ------- | -------- | ---------------------------------- | ------------- |
| customer | integer | Yes | Unique identifier for the customer | 99 |
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Response
bullets": [
{
"id": memo_id,
"created_by_name": "<UserName>",
"last_updated_by_name": "<UserName>",
"customer_name": "<CustomerName>",
... MEMO DETAILS ...
}
]
---
## Endpoint: `/api/bulletin/`
**Method**: `POST`
**Description**: Create a new memo.
### Parameters
|Parameter|Type|Required|Description|Example Value|
|---|---|---|---|---|
|None|-|-|No parameters required|-|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Request Payload
{
"body": "{BODY}",
"customer": "{Customerid}",
"description": "{Description}",
"public": true,
"to_group": null,
"to_user": null,
"from_time": "2024-11-04T14:46:00.000Z",
"to_time": "2024-11-11T14:50:00.000Z"
}
### Example Response
{
"id": <Memoid>,
... MEMO DETAILS ...
}
---
## Endpoint: `/api/bulletin/{id}/`
**Method**: `GET`
**Description**: Retrieve specific memo details based on the ID.
### Parameters
|Parameter|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`id`|string|Yes|Unique identifier for the bulletin or memo.|`12345`|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Response
{
"id": <Memoid>,
... MEMO DETAILS ...
}
---
## Endpoint: `/api/bulletin/{id}/`
**Method**: `PUT`
**Description**: Update an existing memo note.
### Parameters
|Parameter|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`id`|string|Yes|Unique identifier for the bulletin or memo.|`12345`|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Request Body (if applicable)
{
"body": "{BODY}",
"customer": "{Customerid}",
"description": "{Description}",
"public": true,
"to_group": null,
"to_user": null,
"from_time": "2024-11-04T14:46:00.000Z",
"to_time": "2024-11-11T14:50:00.000Z"
}
### Example Response
###### Updated details (Payload we've sent)
---
## Endpoint: `/api/bulletin/{id}/`
**Method**: `DELETE`
**Description**: Delete a specific memo by ID.
### Parameters
|Parameter|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`id`|string|Yes|Unique identifier for the bulletin or memo.|`12345`|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Response
`1`
`This response means that the request has succeeded`
---
## Endpoint: `/api/bulletin/get_unread_count/`
**Method**: `GET`
**Description**: Get the number of unread notifications on the memos screen.
### Parameters
|Parameter|Type|Required|Description|Example Value|
|---|---|---|---|---|
|None|-|-|No parameters required|-|
### Headers
| Header | Type | Required | Description | Example Value |
| --------------- | ------ | -------- | ------------------------------- | ---------------- |
| `Authorization` | string | Yes | Bearer token for authentication | `Bearer <token>` |
### Example Response
`1`
---