BokaMera.API.Host

<back to all web services

DeleteNewsItem

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
DELETE/news/{Id}Delete a news itemDelete a news item for the currently logged in user, only administrators are allowed to delete news items.
DeleteNewsItem Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
IdpathintYesId of the newsitem to delete
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 .jsv suffix or ?format=jsv

HTTP + JSV

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

DELETE /news/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
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
		}
	}
}