| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /news/{Id} | Update a news item | Update a news item to the company of the currently logged in user, only administrators are allowed to update news items. |
|---|
"use strict";
export class NewsItemQueryResponse {
/** @param {{Id?:number,Heading?:string,Body?:string,ImageUrl?:string,From?:string,To?:string,Created?:string,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The news item id */
Id;
/**
* @type {string}
* @description Heading of the news item */
Heading;
/**
* @type {string}
* @description Body of the news item */
Body;
/**
* @type {string}
* @description Url to a image associated with the news */
ImageUrl;
/**
* @type {string}
* @description The timestamp from which the newsitem should be visible from */
From;
/**
* @type {string}
* @description The timestamp to which the newsitem should be visible to */
To;
/**
* @type {string}
* @description The timestamp when news was created */
Created;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class UpdateNewsItem {
/** @param {{CompanyId?:string,Id?:number,Heading?:string,Body?:string,ImageUrl?:string,From?:string,To?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?string}
* @description The company id, if empty will use the company id for the user you are logged in with. */
CompanyId;
/**
* @type {number}
* @description Id of the newsitem to update */
Id;
/**
* @type {string}
* @description The news item header, keep this short and concise */
Heading;
/**
* @type {string}
* @description The news body text */
Body;
/**
* @type {string}
* @description Valid url to a image associated with the news */
ImageUrl;
/**
* @type {string}
* @description The timestamp from which the newsitem should be visible from */
From;
/**
* @type {string}
* @description The timestamp to which the newsitem should be visible to */
To;
}
JavaScript UpdateNewsItem DTOs
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.
PUT /news/{Id} HTTP/1.1
Host: api.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
Id: 0,
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
}
}
}