CenResService

<back to all web services

InventoryBlockSummaryRequest

The following routes are available for this service:
GET/v2/inventoryblock/summary/{CendynPropertyId}
GET/v2/inventoryblock/summary

export enum RequestStatus
{
    Success = 'Success',
    Warning = 'Warning',
    Error = 'Error',
    NotAuthorized = 'NotAuthorized',
    Failure = 'Failure',
}

export class CenResResponse
{
    public status?: RequestStatus;
    public statusMessage?: string;
    public recordsReturned?: number;
    public recordsAvailable?: number;
    public pageNumber?: number;
    public pageSize?: number;

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

export class InventoryBlockSummary
{
    public cendynPropertyID?: string;
    public inventoryDay?: string;
    public count?: number;
    public sold?: number;
    public lastUpdated?: string;

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

export class InventoryBlockSummaryResponse extends CenResResponse
{
    public records?: InventoryBlockSummary[];

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

export class InventoryBlockSummaryRequest
{
    public cendynPropertyId?: string;
    public startDate?: string;
    public endDate?: string;
    // @DataMember(Name="Limit")
    public pageSize?: number;

    // @DataMember(Name="Page")
    public pageNumber?: number;

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

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

GET /v2/inventoryblock/summary/{CendynPropertyId} HTTP/1.1 
Host: cert.cendyn.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"records":[{"cendynPropertyID":"String","inventoryDay":"0001-01-01T00:00:00.0000000","count":0,"sold":0,"lastUpdated":"0001-01-01T00:00:00.0000000"}],"status":"Success","statusMessage":"String","recordsReturned":0,"recordsAvailable":0,"pageNumber":0,"pageSize":0}