BokaMera.API.Host

<back to all web services

AvaiableTimesGroupedQuery

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 AvailableTimesGroupedDates
{
    public Group: string;
    public Times: AvailableTimesSum[];

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

export class AvailableTimesGroupedDatesResponse
{
    public CompanyId: string;
    public ServiceId: number;
    public TimesFreeTextSingle: string;
    public TimesFreeTextMultiple: string;
    public Items: AvailableTimesGroupedDates[];

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

export class AvailableTimesResourceTypeResource
{
    /** @description The resourcetype id */
    // @ApiMember(Description="The resourcetype id")
    public ResourceTypeId: number;

    /** @description The resource id */
    // @ApiMember(Description="The resource id")
    public ResourceId: number;

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

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

    /** @description Service id */
    // @ApiMember(Description="Service id", IsRequired=true, ParameterType="path")
    public ServiceId: number;

    /** @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 Here you can select one of the resource in each resourcetype connected to the service, if none is selected it will show available times for all */
    // @ApiMember(Description="Here you can select one of the resource in each resourcetype connected to the service, if none is selected it will show available times for all", ParameterType="query")
    public Resources: AvailableTimesResourceTypeResource[];

    /** @description Here you select number of resources to book (in each resourcetype). Default is 1. */
    // @ApiMember(Description="Here you select number of resources to book (in each resourcetype). Default is 1.", ParameterType="query")
    public NumberOfResources: number;

    /** @description If you want to include the connected resourcetypes and resources */
    // @ApiMember(Description="If you want to include the connected resourcetypes and resources", ParameterType="query")
    public ShowPerResource: boolean;

    /** @description Both start and time time should be inside test interval. Default is false which means only start time needs to be inside. */
    // @ApiMember(DataType="bool", Description="Both start and time time should be inside test interval. Default is false which means only start time needs to be inside.", ParameterType="query")
    public InsideSearchInterval: boolean;

    /** @description The duration you want to book. Needs to withing the service Min and Max. If not set it will use the service duration */
    // @ApiMember(DataType="bool", Description="The duration you want to book. Needs to withing the service Min and Max. If not set it will use the service duration", ParameterType="query")
    public Duration?: number;

    public ResponseStatus: ResponseStatus;

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

TypeScript AvaiableTimesGroupedQuery DTOs

GET /services/{ServiceId}/availabletimes/grouped HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml

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

<AvailableTimesGroupedDatesResponse 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>
  <Items>
    <AvailableTimesGroupedDates>
      <Group>0001-01-01T00:00:00</Group>
      <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>
    </AvailableTimesGroupedDates>
  </Items>
  <ServiceId>0</ServiceId>
  <TimesFreeTextMultiple>String</TimesFreeTextMultiple>
  <TimesFreeTextSingle>String</TimesFreeTextSingle>
</AvailableTimesGroupedDatesResponse>