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

export class CustomFieldSlotsQueryResponse
{
    /** @description Table to which the field belongs */
    // @ApiMember(Description="Table to which the field belongs")
    public Table: string;

    /** @description Custom field id */
    // @ApiMember(Description="Custom field id")
    public Id: number;

    /** @description Custom field column name */
    // @ApiMember(Description="Custom field column name")
    public Name: string;

    /** @description The field datatype */
    // @ApiMember(Description="The field datatype")
    public Datatype: string;

    /** @description If the slot is free or occupied */
    // @ApiMember(Description="If the slot is free or occupied")
    public Occupied: boolean;

    public constructor(init?: Partial<CustomFieldSlotsQueryResponse>) { (Object as any).assign(this, init); }
}

// @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")
export class CustomFieldSlotsQuery implements ICompany
{
    /** @description Company id to find custom fields for */
    // @ApiMember(Description="Company id to find custom fields for", ParameterType="query")
    public CompanyId?: string;

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

    /** @description If you want to receive only free slots (not occupied). */
    // @ApiMember(Description="If you want to receive only free slots (not occupied).")
    public FreeSlots?: boolean;

    public constructor(init?: Partial<CustomFieldSlotsQuery>) { (Object as any).assign(this, init); }
}

TypeScript CustomFieldSlotsQuery DTOs

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

HTTP + CSV

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

{"Table":"String","Id":0,"Name":"String","Datatype":"String","Occupied":false}