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
import Foundation
import ServiceStack

// @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")
public class CustomFieldSlotsQuery : ICompany, Codable
{
    /**
    * Company id to find custom fields for
    */
    // @ApiMember(Description="Company id to find custom fields for", ParameterType="query")
    public var companyId:String?

    /**
    * Table to which the field belongs
    */
    // @ApiMember(Description="Table to which the field belongs", IsRequired=true)
    public var table:String

    /**
    * If you want to receive only free slots (not occupied).
    */
    // @ApiMember(Description="If you want to receive only free slots (not occupied).")
    public var freeSlots:Bool?

    required public init(){}
}

public class CustomFieldSlotsQueryResponse : Codable
{
    /**
    * Table to which the field belongs
    */
    // @ApiMember(Description="Table to which the field belongs")
    public var table:String

    /**
    * Custom field id
    */
    // @ApiMember(Description="Custom field id")
    public var id:Int

    /**
    * Custom field column name
    */
    // @ApiMember(Description="Custom field column name")
    public var name:String

    /**
    * The field datatype
    */
    // @ApiMember(Description="The field datatype")
    public var datatype:String

    /**
    * If the slot is free or occupied
    */
    // @ApiMember(Description="If the slot is free or occupied")
    public var occupied:Bool

    required public init(){}
}


Swift 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: api.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
}