BokaMera.API.Host

CreateNewsItem

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
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.

"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 CreateNewsItem {
    /** @param {{CompanyId?:string,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 {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 CreateNewsItem DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /news HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Heading":"String","Body":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}