Billiecart API

<back to all web services

CreateBookingRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
POST/bookings

export class PostOperationUnTenanted<TResponse> implements IPost
{

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

export class PostOperationTenanted<TResponse> extends PostOperationUnTenanted<TResponse> implements ITenantedRequest
{
    public organisationId?: string;

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

export class Booking implements IIdentifiableResource
{
    public startUtc: string;
    public endUtc: string;
    public borrowerId?: string;
    public carId?: string;
    public id?: string;

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

export class CreateBookingResponse
{
    public responseStatus?: ResponseStatus;
    public booking?: Booking;

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

export class CreateBookingRequest extends PostOperationTenanted<CreateBookingResponse>
{
    public carId?: string;
    public startUtc: string;
    public endUtc?: string;

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

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

POST /bookings HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"carId":"String","endUtc":null,"organisationId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"booking":{"borrowerId":"String","carId":"String","id":"String"}}