BokaMera.API.Host

TestDateSchedule

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
POST	/schedules/date/test	Test date schedule	Test date schedule, only administrators are allowed to test schedules.


export class ExceptionText
{
    public Reason: string;
    public ReasonPublic: string;

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

export class AvailableTimesSum implements IAvailableTime
{
    public From: string;
    public To: string;
    public Free: number;
    public FreeSpots: number;
    public ExceptionTexts: ExceptionText[];

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

export class AvailableTimesResponse
{
    public CompanyId: string;
    public ServiceId: number;
    public TimesFreeTextSingle: string;
    public TimesFreeTextMultiple: string;
    public Times: AvailableTimesSum[];

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

export class AddDateScheduleDate
{
    /** @description The from date for the timeslot */
    // @ApiMember(Description="The from date for the timeslot", IsRequired=true)
    public From: string;

    /** @description The to date for the timeslot */
    // @ApiMember(Description="The to date for the timeslot", IsRequired=true)
    public To: string;

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

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class TestDateSchedule implements ICompany, IInterval
{
    /** @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 The dates for the schedule. This is the actual timeslots. */
    // @ApiMember(Description="The dates for the schedule. This is the actual timeslots.", IsRequired=true)
    public ScheduleDates: AddDateScheduleDate[];

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

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

    /** @description The Service Duration */
    // @ApiMember(Description="The Service Duration")
    public ServiceId?: number;

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

TypeScript TestDateSchedule 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.

POST /schedules/date/test HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TestDateSchedule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <From>0001-01-01T00:00:00</From>
  <ScheduleDates>
    <AddDateScheduleDate>
      <From>0001-01-01T00:00:00</From>
      <To>0001-01-01T00:00:00</To>
    </AddDateScheduleDate>
  </ScheduleDates>
  <ServiceId>0</ServiceId>
  <To>0001-01-01T00:00:00</To>
</TestDateSchedule>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AvailableTimesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <ServiceId>0</ServiceId>
  <Times>
    <AvailableTimesSum>
      <ExceptionTexts i:nil="true" />
      <Free>0</Free>
      <FreeSpots>0</FreeSpots>
      <From>0001-01-01T00:00:00</From>
      <To>0001-01-01T00:00:00</To>
    </AvailableTimesSum>
  </Times>
  <TimesFreeTextMultiple>String</TimesFreeTextMultiple>
  <TimesFreeTextSingle>String</TimesFreeTextSingle>
</AvailableTimesResponse>