BokaMera.API.Host

CalculateTotalPriceOnService

The following routes are available for this service:
PUT	/services/{Id}/calculateprice	Calculate price on service	Calculate an price on a service.


export class RebateCodeTypeItem
{
    public Id: number;
    public Name: string;
    public Description: string;

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

export class AppliedRebateCodesResponse
{
    public RebateCodeSign: string;
    public RebateCodeValue: number;
    public RebateCodeType: RebateCodeTypeItem;
    public RebateCodeId: number;
    public RebateAmount: number;

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

export class TotalPricePriceDetail
{
    public Quantity: number;
    public Price: number;
    public VatAmount: number;
    public Description: string;

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

export class TotalPriceInformationResponse
{
    public PriceSign: string;
    public CurrencyId: string;
    public TotalPrice: number;
    public TotalVatAmount: number;
    public TotalPriceBeforeRebate: number;
    public AppliedCodes: AppliedRebateCodesResponse[];
    public PriceDetails: TotalPricePriceDetail[];

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

export class PriceInterval
{
    /** @description The start date and time for the price to be calculated. Normally the booking start datetime. */
    // @ApiMember(Description="The start date and time for the price to be calculated. Normally the booking start datetime.", IsRequired=true)
    public From: string;

    /** @description The end date and time for the price to be calculated.Normally the booking end datetime. If nothing entered it will use the service length. */
    // @ApiMember(Description="The end date and time for the price to be calculated.Normally the booking end datetime. If nothing entered it will use the service length.")
    public To?: string;

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

export class CalculateTotalPriceOnService 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 Id of the service */
    // @ApiMember(Description="Id of the service", IsRequired=true, ParameterType="path")
    public Id: number;

    /** @description The price interval to be used for calculations */
    // @ApiMember(Description="The price interval to be used for calculations", IsRequired=true)
    public Interval: PriceInterval;

    /** @description If you have selected to include the prices, here you can include the rebate codes */
    // @ApiMember(Description="If you have selected to include the prices, here you can include the rebate codes")
    public RebateCodeIds: number[];

    /** @description If you have selected to include the prices, here you can include the quantities to book to get the correct total price. */
    // @ApiMember(Description="If you have selected to include the prices, here you can include the quantities to book to get the correct total price.")
    public Quantities: QuantityToBook[];

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

export class QuantityToBook
{
    /** @description If service has a price, enter the price id for that price. If no price exists for the service set 0 as PriceId. If you put 0 and a price exists, it will use that price (only works if just one price exists for the current selected date to book) */
    // @ApiMember(Description="If service has a price, enter the price id for that price. If no price exists for the service set 0 as PriceId. If you put 0 and a price exists, it will use that price (only works if just one price exists for the current selected date to book)", IsRequired=true)
    public PriceId: number;

    /** @description Set the number of spots or resources you want to book on the specific price category */
    // @ApiMember(Description="Set the number of spots or resources you want to book on the specific price category", IsRequired=true)
    public Quantity: number;

    /** @description If the quantity you add should occupy a spot. Default is true. If no it will only be a row that includes price information. */
    // @ApiMember(Description="If the quantity you add should occupy a spot. Default is true. If no it will only be a row that includes price information.")
    public OccupiesSpot: boolean;

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

TypeScript CalculateTotalPriceOnService 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 /services/{Id}/calculateprice HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":0,"Interval":{"To":"0001-01-01T00:00:00"},"RebateCodeIds":[0],"Quantities":[{"PriceId":0,"Quantity":0,"OccupiesSpot":false}]}

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

{"PriceSign":"String","CurrencyId":"String","TotalPrice":0,"TotalVatAmount":0,"TotalPriceBeforeRebate":0,"AppliedCodes":[{"RebateCodeSign":"String","RebateCodeValue":0,"RebateCodeType":{"Id":0,"Name":"String","Description":"String"},"RebateCodeId":0,"RebateAmount":0}],"PriceDetails":[{"Quantity":0,"Price":0,"VatAmount":0,"Description":"String"}]}