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 .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 /v2/inventoryblock/summary/{CendynPropertyId} HTTP/1.1 
Host: cert.cendyn.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InventoryBlockSummaryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CenResSS.ServiceModel">
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <RecordsAvailable>0</RecordsAvailable>
  <RecordsReturned>0</RecordsReturned>
  <Status>Success</Status>
  <StatusMessage>String</StatusMessage>
  <Records xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cendyn.CenRes.DataLib.ViewModels">
    <d2p1:InventoryBlockSummary>
      <d2p1:CendynPropertyID>String</d2p1:CendynPropertyID>
      <d2p1:Count>0</d2p1:Count>
      <d2p1:InventoryDay>0001-01-01T00:00:00</d2p1:InventoryDay>
      <d2p1:LastUpdated>0001-01-01T00:00:00</d2p1:LastUpdated>
      <d2p1:Sold>0</d2p1:Sold>
    </d2p1:InventoryBlockSummary>
  </Records>
</InventoryBlockSummaryResponse>