BokaMera.API.Host

<back to all web services

UpdateHomepageSchedulerSettings

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/homepage/scheduler/settingsUpdate homepage scheduler settingsUpdate homepage scheduler settings on the company of the currently logged in user, only administrators are allowed to update homepage menu.

export class HomepageSchedulerServiceResponse
{
    /** @description The service id. */
    // @ApiMember(Description="The service id.")
    public Id: number;

    /** @description The service name. */
    // @ApiMember(Description="The service name.")
    public Name: string;

    /** @description The service description. */
    // @ApiMember(Description="The service description.")
    public Description: string;

    /** @description The service image url. */
    // @ApiMember(Description="The service image url.")
    public ImageUrl: string;

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

export class HomepageSchedulerResourceResponse
{
    /** @description The resource id. */
    // @ApiMember(Description="The resource id.")
    public Id: number;

    /** @description The resource name. */
    // @ApiMember(Description="The resource name.")
    public Name: string;

    /** @description The resource description. */
    // @ApiMember(Description="The resource description.")
    public Description: string;

    /** @description The resource image url. */
    // @ApiMember(Description="The resource image url.")
    public ImageUrl: string;

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

export class HomepageSchedulerFieldResponse
{
    /** @description The field id. */
    // @ApiMember(Description="The field id.")
    public Id: number;

    /** @description If the field should be shown on booking. */
    // @ApiMember(Description="If the field should be shown on booking.")
    public ShowOnBooking: boolean;

    /** @description If the field should be shown on tooltip. */
    // @ApiMember(Description="If the field should be shown on tooltip.")
    public ShowOnTooltip: boolean;

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

export class HomepageSchedulerFieldOptionsResponse
{
    /** @description The field id. */
    // @ApiMember(Description="The field id.")
    public Id: number;

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

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

    /** @description The field sort order when listing. */
    // @ApiMember(Description="The field sort order when listing.")
    public SortOrder: number;

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

export class ScheduleViewResponse
{
    public Id: number;
    public Name: string;

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

export class HomepageSchedulerSettingsQueryResponse
{
    /** @description The company id. */
    // @ApiMember(Description="The company id.")
    public CompanyId: string;

    /** @description If the user schedule is activated. */
    // @ApiMember(Description="If the user schedule is activated.")
    public Active: boolean;

    /** @description If the user schedule views id. */
    // @ApiMember(Description="If the user schedule views id.")
    public ScheduleViewId: number;

    /** @description If the user schedule time slots in minutes. */
    // @ApiMember(Description="If the user schedule time slots in minutes.")
    public ScheduleTimeSlotMinutes: number;

    /** @description If the user schedule time start time. */
    // @ApiMember(Description="If the user schedule time start time.")
    public StartTime?: string;

    /** @description If the user schedule time end time. */
    // @ApiMember(Description="If the user schedule time end time.")
    public EndTime?: string;

    /** @description If the user schedule should contain time exceptions. */
    // @ApiMember(Description="If the user schedule should contain time exceptions.")
    public ShowTimeExceptions: boolean;

    /** @description If allow booking in the scheduler. */
    // @ApiMember(Description="If allow booking in the scheduler.")
    public EnableBooking: boolean;

    /** @description The homepage schedule services that are selected */
    // @ApiMember(Description="The homepage schedule services that are selected")
    public Services: HomepageSchedulerServiceResponse[];

    /** @description The homepage schedule resources that are selected */
    // @ApiMember(Description="The homepage schedule resources that are selected")
    public Resources: HomepageSchedulerResourceResponse[];

    /** @description The homepage schedule fields that are selected */
    // @ApiMember(Description="The homepage schedule fields that are selected")
    public Fields: HomepageSchedulerFieldResponse[];

    /** @description The homepage schedule fields select from */
    // @ApiMember(Description="The homepage schedule fields select from")
    public FieldOptions: HomepageSchedulerFieldOptionsResponse[];

    /** @description The available schedule view options to choose from */
    // @ApiMember(Description="The available schedule view options to choose from")
    public ScheduleViewOptions: ScheduleViewResponse[];

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

export class HomepageSchedulerResource
{
    /** @description The resource id. */
    // @ApiMember(Description="The resource id.")
    public Id: number;

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

export class HomepageSchedulerService
{
    /** @description The service id. */
    // @ApiMember(Description="The service id.")
    public Id: number;

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

export class HomepageScheduleField
{
    /** @description The field id. */
    // @ApiMember(Description="The field id.", IsRequired=true)
    public Id: number;

    /** @description If the field showed on the booking. */
    // @ApiMember(Description="If the field showed on the booking.", IsRequired=true)
    public ShowOnBooking: boolean;

    /** @description If the field showed on the bookings tooltip. */
    // @ApiMember(Description="If the field showed on the bookings tooltip.", IsRequired=true)
    public ShowOnTooltip: boolean;

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

// @ValidateRequest(Validator="IsAuthenticated")
export class UpdateHomepageSchedulerSettings implements ICompany
{
    /** @description The company id, if empty will use the company id for the user you are logged in with. */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public CompanyId?: string;

    /** @description If the user schedule is activated. */
    // @ApiMember(Description="If the user schedule is activated.")
    public Active?: boolean;

    /** @description If the user schedule views id. */
    // @ApiMember(Description="If the user schedule views id.")
    public ScheduleViewId?: number;

    /** @description If the user schedule time slots in minutes. */
    // @ApiMember(Description="If the user schedule time slots in minutes.")
    public ScheduleTimeSlotMinutes?: number;

    /** @description If the user schedule time start time. */
    // @ApiMember(Description="If the user schedule time start time.")
    public StartTime?: string;

    /** @description If the user schedule time end time. */
    // @ApiMember(Description="If the user schedule time end time.")
    public EndTime?: string;

    /** @description If the user schedule should contain time exceptions. */
    // @ApiMember(Description="If the user schedule should contain time exceptions.")
    public ShowTimeExceptions?: boolean;

    /** @description If allow booking in the scheduler. */
    // @ApiMember(Description="If allow booking in the scheduler.")
    public EnableBooking?: boolean;

    /** @description What resources you want to be shown in scheduler. */
    // @ApiMember(Description="What resources you want to be shown in scheduler.")
    public Resources: HomepageSchedulerResource[];

    /** @description What services you want to be shown in scheduler. */
    // @ApiMember(Description="What services you want to be shown in scheduler.")
    public Services: HomepageSchedulerService[];

    /** @description What fields you want to be shown in scheduler. */
    // @ApiMember(Description="What fields you want to be shown in scheduler.")
    public Fields: HomepageScheduleField[];

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

TypeScript UpdateHomepageSchedulerSettings DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /homepage/scheduler/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Active":false,"ScheduleViewId":0,"ScheduleTimeSlotMinutes":0,"StartTime":"00:00:00","EndTime":"00:00:00","ShowTimeExceptions":false,"EnableBooking":false,"Resources":[{"Id":0}],"Services":[{"Id":0}],"Fields":[{"Id":0,"ShowOnBooking":false,"ShowOnTooltip":false}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Active":false,"ScheduleViewId":0,"ScheduleTimeSlotMinutes":0,"StartTime":"00:00:00","EndTime":"00:00:00","ShowTimeExceptions":false,"EnableBooking":false,"Services":[{"Id":0,"Name":"String","Description":"String"}],"Resources":[{"Id":0,"Name":"String","Description":"String"}],"Fields":[{"Id":0,"ShowOnBooking":false,"ShowOnTooltip":false}],"FieldOptions":[{"Id":0,"Name":"String","Description":"String","SortOrder":0}],"ScheduleViewOptions":[{"Id":0,"Name":"String"}]}