| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| 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. |
|---|
namespace BokaMera.API.ServiceModel.Dtos
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type NewsItemQueryResponse() =
///<summary>
///The news item id
///</summary>
[<ApiMember(Description="The news item id")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///Heading of the news item
///</summary>
[<ApiMember(Description="Heading of the news item")>]
member val Heading:String = null with get,set
///<summary>
///Body of the news item
///</summary>
[<ApiMember(Description="Body of the news item")>]
member val Body:String = null with get,set
///<summary>
///Url to a image associated with the news
///</summary>
[<ApiMember(Description="Url to a image associated with the news")>]
member val ImageUrl:Uri = null with 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)>]
member val From:DateTime = new DateTime() with 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)>]
member val To:DateTime = new DateTime() with get,set
///<summary>
///The timestamp when news was created
///</summary>
[<ApiMember(Description="The timestamp when news was created", IsRequired=true)>]
member val Created:DateTime = new DateTime() with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<ValidateRequest(Validator="IsAuthenticated")>]
[<AllowNullLiteral>]
type CreateNewsItem() =
///<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.")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with 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)>]
member val Heading:String = null with get,set
///<summary>
///The news body text
///</summary>
[<ApiMember(Description="The news body text", IsRequired=true)>]
member val Body:String = null with get,set
///<summary>
///Valid url to a image associated with the news
///</summary>
[<ApiMember(Description="Valid url to a image associated with the news")>]
member val ImageUrl:Uri = null with 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)>]
member val From:DateTime = new DateTime() with 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)>]
member val To:DateTime = new DateTime() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<CreateNewsItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Body>String</Body>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<From>0001-01-01T00:00:00</From>
<Heading>String</Heading>
<ImageUrl i:nil="true" />
<To>0001-01-01T00:00:00</To>
</CreateNewsItem>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<NewsItemQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Body>String</Body>
<Created>0001-01-01T00:00:00</Created>
<From>0001-01-01T00:00:00</From>
<Heading>String</Heading>
<Id>0</Id>
<ImageUrl i:nil="true" />
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<To>0001-01-01T00:00:00</To>
</NewsItemQueryResponse>