BokaMera.API.Host

<back to all web services

CustomFieldSlotsQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/customfields/slotsFind all slots to store custom fields data inGet all available slots that are avaialble to store data in
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 CustomFieldSlotsQueryResponse() = 
        ///<summary>
        ///Table to which the field belongs
        ///</summary>
        [<ApiMember(Description="Table to which the field belongs")>]
        member val Table:String = null with get,set

        ///<summary>
        ///Custom field id
        ///</summary>
        [<ApiMember(Description="Custom field id")>]
        member val Id:Int32 = new Int32() with get,set

        ///<summary>
        ///Custom field column name
        ///</summary>
        [<ApiMember(Description="Custom field column name")>]
        member val Name:String = null with get,set

        ///<summary>
        ///The field datatype
        ///</summary>
        [<ApiMember(Description="The field datatype")>]
        member val Datatype:String = null with get,set

        ///<summary>
        ///If the slot is free or occupied
        ///</summary>
        [<ApiMember(Description="If the slot is free or occupied")>]
        member val Occupied:Boolean = new Boolean() 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 CustomFieldSlotsQuery() = 
        ///<summary>
        ///Company id to find custom fields for
        ///</summary>
        [<ApiMember(Description="Company id to find custom fields for", ParameterType="query")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///Table to which the field belongs
        ///</summary>
        [<ApiMember(Description="Table to which the field belongs", IsRequired=true)>]
        member val Table:String = null with get,set

        ///<summary>
        ///If you want to receive only free slots (not occupied).
        ///</summary>
        [<ApiMember(Description="If you want to receive only free slots (not occupied).")>]
        member val FreeSlots:Nullable<Boolean> = new Nullable<Boolean>() with get,set

F# CustomFieldSlotsQuery 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.

GET /customfields/slots HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Table: String,
	Id: 0,
	Name: String,
	Datatype: String,
	Occupied: False
}