| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /news | Add a news item | Add a news item to the company of the currently logged in user, only administrators are allowed to add news items. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | body | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
| Heading | body | string | Yes | The news item header, keep this short and concise |
| Body | body | string | Yes | The news body text |
| ImageUrl | body | Uri | Yes | Valid url to a image associated with the news |
| From | body | DateTime | Yes | The timestamp from which the newsitem should be visible from |
| To | body | DateTime | Yes | The timestamp to which the newsitem should be visible to |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The news item id |
| Heading | form | string | Yes | Heading of the news item |
| Body | form | string | Yes | Body of the news item |
| ImageUrl | form | Uri | Yes | Url to a image associated with the news |
| From | form | DateTime | Yes | The timestamp from which the newsitem should be visible from |
| To | form | DateTime | Yes | The timestamp to which the newsitem should be visible to |
| Created | form | DateTime | Yes | The timestamp when news was created |
| ResponseStatus | form | ResponseStatus | Yes |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /news HTTP/1.1
Host: api.bookmore.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
Heading: String,
Body: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
Heading: String,
Body: String,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}