Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
POST | /homepage/images | Add a new homepage image | Add a new homepage image to the company of the currently logged in user, only administrators are allowed to add support cases. |
---|
namespace BokaMera.API.ServiceModel.Dtos
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type HomepageImageQueryResponse() =
///<summary>
///The company id.
///</summary>
[<ApiMember(Description="The company id.")>]
member val CompanyId:Guid = new Guid() with get,set
///<summary>
///The homepage image id.
///</summary>
[<ApiMember(Description="The homepage image id.")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The image title.
///</summary>
[<ApiMember(Description="The image title.")>]
member val Title:String = null with get,set
///<summary>
///The image description.
///</summary>
[<ApiMember(Description="The image description.")>]
member val Description:String = null with get,set
///<summary>
///The image url.
///</summary>
[<ApiMember(Description="The image url.")>]
member val ImageUrl:Uri = null with get,set
[<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
[<ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)>]
[<ValidateRequest(Validator="IsAuthenticated")>]
[<AllowNullLiteral>]
type CreateHomepageImage() =
///<summary>
///Enter the company id, if blank company id and you are an admin, your company id will be used.
///</summary>
[<ApiMember(Description="Enter the company id, if blank company id and you are an admin, your company id will be used.", IsRequired=true)>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///The image title.
///</summary>
[<ApiMember(Description="The image title.")>]
member val Title:String = null with get,set
///<summary>
///The image description.
///</summary>
[<ApiMember(Description="The image description.")>]
member val Description:String = null with get,set
///<summary>
///The image url.
///</summary>
[<ApiMember(Description="The image url.")>]
member val ImageUrl:Uri = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /homepage/images HTTP/1.1
Host: api.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
Title: String,
Description: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { Id: 0, Title: String, Description: String }