BokaMera.API.Host

<back to all web services

CreateNewsItem

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/newsAdd a news itemAdd a news item to the company of the currently logged in user, only administrators are allowed to add news items.
CreateNewsItem Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
HeadingbodystringYesThe news item header, keep this short and concise
BodybodystringYesThe news body text
ImageUrlbodyUriNoValid url to a image associated with the news
FrombodyDateTimeYesThe timestamp from which the newsitem should be visible from
TobodyDateTimeYesThe timestamp to which the newsitem should be visible to
NewsItemQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe news item id
HeadingformstringNoHeading of the news item
BodyformstringNoBody of the news item
ImageUrlformUriNoUrl to a image associated with the news
FromformDateTimeYesThe timestamp from which the newsitem should be visible from
ToformDateTimeYesThe timestamp to which the newsitem should be visible to
CreatedformDateTimeYesThe timestamp when news was created
ResponseStatusformResponseStatusNo

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: api.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"}}}