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.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    [ValidateRequest("IsAuthenticated")]
    public partial class CreateNewsItem
        : ICompany
    {
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///The news item header, keep this short and concise
        ///</summary>
        [ApiMember(Description="The news item header, keep this short and concise", IsRequired=true)]
        public virtual string Heading { get; set; }

        ///<summary>
        ///The news body text
        ///</summary>
        [ApiMember(Description="The news body text", IsRequired=true)]
        public virtual string Body { get; set; }

        ///<summary>
        ///Valid url to a image associated with the news
        ///</summary>
        [ApiMember(Description="Valid url to a image associated with the news")]
        public virtual Uri ImageUrl { get; set; }

        ///<summary>
        ///The timestamp from which the newsitem should be visible from
        ///</summary>
        [ApiMember(Description="The timestamp from which the newsitem should be visible from", IsRequired=true)]
        public virtual DateTime From { get; set; }

        ///<summary>
        ///The timestamp to which the newsitem should be visible to
        ///</summary>
        [ApiMember(Description="The timestamp to which the newsitem should be visible to", IsRequired=true)]
        public virtual DateTime To { get; set; }
    }

    public partial class NewsItemQueryResponse
    {
        ///<summary>
        ///The news item id
        ///</summary>
        [ApiMember(Description="The news item id")]
        public virtual int Id { get; set; }

        ///<summary>
        ///Heading of the news item
        ///</summary>
        [ApiMember(Description="Heading of the news item")]
        public virtual string Heading { get; set; }

        ///<summary>
        ///Body of the news item
        ///</summary>
        [ApiMember(Description="Body of the news item")]
        public virtual string Body { get; set; }

        ///<summary>
        ///Url to a image associated with the news
        ///</summary>
        [ApiMember(Description="Url to a image associated with the news")]
        public virtual Uri ImageUrl { get; set; }

        ///<summary>
        ///The timestamp from which the newsitem should be visible from
        ///</summary>
        [ApiMember(Description="The timestamp from which the newsitem should be visible from", IsRequired=true)]
        public virtual DateTime From { get; set; }

        ///<summary>
        ///The timestamp to which the newsitem should be visible to
        ///</summary>
        [ApiMember(Description="The timestamp to which the newsitem should be visible to", IsRequired=true)]
        public virtual DateTime To { get; set; }

        ///<summary>
        ///The timestamp when news was created
        ///</summary>
        [ApiMember(Description="The timestamp when news was created", IsRequired=true)]
        public virtual DateTime Created { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# CreateNewsItem DTOs

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.

POST /news HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	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
		}
	}
}