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
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
{
    [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("IsAuthenticated")]
    public partial class CustomFieldSlotsQuery
        : ICompany
    {
        ///<summary>
        ///Company id to find custom fields for
        ///</summary>
        [ApiMember(Description="Company id to find custom fields for", ParameterType="query")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///Table to which the field belongs
        ///</summary>
        [ApiMember(Description="Table to which the field belongs", IsRequired=true)]
        public virtual string Table { 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).")]
        public virtual bool? FreeSlots { get; set; }
    }

    public partial class CustomFieldSlotsQueryResponse
    {
        ///<summary>
        ///Table to which the field belongs
        ///</summary>
        [ApiMember(Description="Table to which the field belongs")]
        public virtual string Table { get; set; }

        ///<summary>
        ///Custom field id
        ///</summary>
        [ApiMember(Description="Custom field id")]
        public virtual int Id { get; set; }

        ///<summary>
        ///Custom field column name
        ///</summary>
        [ApiMember(Description="Custom field column name")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The field datatype
        ///</summary>
        [ApiMember(Description="The field datatype")]
        public virtual string Datatype { get; set; }

        ///<summary>
        ///If the slot is free or occupied
        ///</summary>
        [ApiMember(Description="If the slot is free or occupied")]
        public virtual bool Occupied { get; set; }
    }

}

C# 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
}