BokaMera.API.Host

<back to all web services

RecurringScheduleIntervalsQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
GET/schedules/recurring/intervalsGet the schedule intervalsGet the schedule intervals. Note: This must not be the same as the available times.

export class ScheduleIntervalsQueryResponse
{
    public From: string;
    public To: string;
    public Duration: string;

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

// @ValidateRequest(Validator="IsAuthenticated")
export class RecurringScheduleIntervalsQuery implements ICompany, IInterval
{
    /** @description Company to show services for */
    // @ApiMember(Description="Company to show services for", ParameterType="query")
    public CompanyId?: string;

    /** @description From what datetime to show times */
    // @ApiMember(DataType="dateTime", Description="From what datetime to show times", IsRequired=true, ParameterType="query")
    public From: string;

    /** @description To what datetime to show times */
    // @ApiMember(DataType="dateTime", Description="To what datetime to show times", IsRequired=true, ParameterType="query")
    public To: string;

    /** @description Here you can select one of the resource, if none is selected it will show available times for all */
    // @ApiMember(Description="Here you can select one of the resource, if none is selected it will show available times for all", ParameterType="query")
    public ResourceIds: number[];

    public ResponseStatus: ResponseStatus;

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

TypeScript RecurringScheduleIntervalsQuery 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 /schedules/recurring/intervals HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ScheduleIntervalsQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Duration>PT0S</Duration>
  <From>0001-01-01T00:00:00</From>
  <To>0001-01-01T00:00:00</To>
</ScheduleIntervalsQueryResponse>