| 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. |
|---|
export class NewsItemQueryResponse
{
/** @description The news item id */
// @ApiMember(Description="The news item id")
public Id: number;
/** @description Heading of the news item */
// @ApiMember(Description="Heading of the news item")
public Heading: string;
/** @description Body of the news item */
// @ApiMember(Description="Body of the news item")
public Body: string;
/** @description Url to a image associated with the news */
// @ApiMember(Description="Url to a image associated with the news")
public ImageUrl: string;
/** @description The timestamp from which the newsitem should be visible from */
// @ApiMember(Description="The timestamp from which the newsitem should be visible from", IsRequired=true)
public From: string;
/** @description The timestamp to which the newsitem should be visible to */
// @ApiMember(Description="The timestamp to which the newsitem should be visible to", IsRequired=true)
public To: string;
/** @description The timestamp when news was created */
// @ApiMember(Description="The timestamp when news was created", IsRequired=true)
public Created: string;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<NewsItemQueryResponse>) { (Object as any).assign(this, init); }
}
// @ValidateRequest(Validator="IsAuthenticated")
export class UpdateNewsItem implements ICompany
{
/** @description The company id, if empty will use the company id for the user you are logged in with. */
// @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
public CompanyId?: string;
/** @description Id of the newsitem to update */
// @ApiMember(Description="Id of the newsitem to update", IsRequired=true, ParameterType="path")
public Id: number;
/** @description The news item header, keep this short and concise */
// @ApiMember(Description="The news item header, keep this short and concise", IsRequired=true)
public Heading: string;
/** @description The news body text */
// @ApiMember(Description="The news body text", IsRequired=true)
public Body: string;
/** @description Valid url to a image associated with the news */
// @ApiMember(Description="Valid url to a image associated with the news")
public ImageUrl: string;
/** @description The timestamp from which the newsitem should be visible from */
// @ApiMember(Description="The timestamp from which the newsitem should be visible from", IsRequired=true)
public From: string;
/** @description The timestamp to which the newsitem should be visible to */
// @ApiMember(Description="The timestamp to which the newsitem should be visible to", IsRequired=true)
public To: string;
public constructor(init?: Partial<UpdateNewsItem>) { (Object as any).assign(this, init); }
}
TypeScript 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: testapi.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
}
}
}