BokaMera.API.Host

<back to all web services

ExportRebateCode

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/rebatecodes/{RebateCodeId}/reportsGet a report as a PDF fileGet a PDF report.

export enum SendReceiptMethod
{
    Email = 1,
    PdfExport = 2,
}

// @ValidateRequest(Validator="IsAuthenticated")
export class ExportRebateCode implements ICompany
{
    /** @description Id of the rebate code */
    // @ApiMember(Description="Id of the rebate code", IsRequired=true, ParameterType="path")
    public RebateCodeId: number;

    /** @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;

    public SendReceiptMethod: SendReceiptMethod;

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

TypeScript ExportRebateCode 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 /rebatecodes/{RebateCodeId}/reports HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />