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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class 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(Validator="IsAuthenticated")
    public static class CustomFieldSlotsQuery implements ICompany
    {
        /**
        * Company id to find custom fields for
        */
        @ApiMember(Description="Company id to find custom fields for", ParameterType="query")
        public UUID CompanyId = null;

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

        /**
        * If you want to receive only free slots (not occupied).
        */
        @ApiMember(Description="If you want to receive only free slots (not occupied).")
        public Boolean FreeSlots = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public CustomFieldSlotsQuery setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getTable() { return Table; }
        public CustomFieldSlotsQuery setTable(String value) { this.Table = value; return this; }
        public Boolean isFreeSlots() { return FreeSlots; }
        public CustomFieldSlotsQuery setFreeSlots(Boolean value) { this.FreeSlots = value; return this; }
    }

    public static class CustomFieldSlotsQueryResponse
    {
        /**
        * Table to which the field belongs
        */
        @ApiMember(Description="Table to which the field belongs")
        public String Table = null;

        /**
        * Custom field id
        */
        @ApiMember(Description="Custom field id")
        public Integer Id = null;

        /**
        * Custom field column name
        */
        @ApiMember(Description="Custom field column name")
        public String Name = null;

        /**
        * The field datatype
        */
        @ApiMember(Description="The field datatype")
        public String Datatype = null;

        /**
        * If the slot is free or occupied
        */
        @ApiMember(Description="If the slot is free or occupied")
        public Boolean Occupied = null;
        
        public String getTable() { return Table; }
        public CustomFieldSlotsQueryResponse setTable(String value) { this.Table = value; return this; }
        public Integer getId() { return Id; }
        public CustomFieldSlotsQueryResponse setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public CustomFieldSlotsQueryResponse setName(String value) { this.Name = value; return this; }
        public String getDatatype() { return Datatype; }
        public CustomFieldSlotsQueryResponse setDatatype(String value) { this.Datatype = value; return this; }
        public Boolean isOccupied() { return Occupied; }
        public CustomFieldSlotsQueryResponse setOccupied(Boolean value) { this.Occupied = value; return this; }
    }

}

Java CustomFieldSlotsQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomFieldSlotsQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Datatype>String</Datatype>
  <Id>0</Id>
  <Name>String</Name>
  <Occupied>false</Occupied>
  <Table>String</Table>
</CustomFieldSlotsQueryResponse>