CenResService

<back to all web services

InventoryBlockSummaryRequest

The following routes are available for this service:
GET/v2/inventoryblock/summary/{CendynPropertyId}
GET/v2/inventoryblock/summary
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    public static class InventoryBlockSummaryRequest
    {
        public String cendynPropertyId = null;
        public Date startDate = null;
        public Date endDate = null;
        @DataMember(Name="Limit")
        @SerializedName("Limit")
        public Integer pageSize = null;

        @DataMember(Name="Page")
        @SerializedName("Page")
        public Integer pageNumber = null;
        
        public String getCendynPropertyId() { return cendynPropertyId; }
        public InventoryBlockSummaryRequest setCendynPropertyId(String value) { this.cendynPropertyId = value; return this; }
        public Date getStartDate() { return startDate; }
        public InventoryBlockSummaryRequest setStartDate(Date value) { this.startDate = value; return this; }
        public Date getEndDate() { return endDate; }
        public InventoryBlockSummaryRequest setEndDate(Date value) { this.endDate = value; return this; }
        public Integer getPageSize() { return pageSize; }
        public InventoryBlockSummaryRequest setPageSize(Integer value) { this.pageSize = value; return this; }
        public Integer getPageNumber() { return pageNumber; }
        public InventoryBlockSummaryRequest setPageNumber(Integer value) { this.pageNumber = value; return this; }
    }

    public static class InventoryBlockSummaryResponse extends CenResResponse
    {
        public ArrayList<InventoryBlockSummary> records = null;
        
        public ArrayList<InventoryBlockSummary> getRecords() { return records; }
        public InventoryBlockSummaryResponse setRecords(ArrayList<InventoryBlockSummary> value) { this.records = value; return this; }
    }

    public static class CenResResponse
    {
        public RequestStatus status = null;
        public String statusMessage = null;
        public Integer recordsReturned = null;
        public Integer recordsAvailable = null;
        public Integer pageNumber = null;
        public Integer pageSize = null;
        
        public RequestStatus getStatus() { return status; }
        public CenResResponse setStatus(RequestStatus value) { this.status = value; return this; }
        public String getStatusMessage() { return statusMessage; }
        public CenResResponse setStatusMessage(String value) { this.statusMessage = value; return this; }
        public Integer getRecordsReturned() { return recordsReturned; }
        public CenResResponse setRecordsReturned(Integer value) { this.recordsReturned = value; return this; }
        public Integer getRecordsAvailable() { return recordsAvailable; }
        public CenResResponse setRecordsAvailable(Integer value) { this.recordsAvailable = value; return this; }
        public Integer getPageNumber() { return pageNumber; }
        public CenResResponse setPageNumber(Integer value) { this.pageNumber = value; return this; }
        public Integer getPageSize() { return pageSize; }
        public CenResResponse setPageSize(Integer value) { this.pageSize = value; return this; }
    }

    public static enum RequestStatus
    {
        Success,
        Warning,
        Error,
        NotAuthorized,
        Failure;
    }

    public static class InventoryBlockSummary
    {
        public String cendynPropertyID = null;
        public Date inventoryDay = null;
        public Integer count = null;
        public Integer sold = null;
        public Date lastUpdated = null;
        
        public String getCendynPropertyID() { return cendynPropertyID; }
        public InventoryBlockSummary setCendynPropertyID(String value) { this.cendynPropertyID = value; return this; }
        public Date getInventoryDay() { return inventoryDay; }
        public InventoryBlockSummary setInventoryDay(Date value) { this.inventoryDay = value; return this; }
        public Integer getCount() { return count; }
        public InventoryBlockSummary setCount(Integer value) { this.count = value; return this; }
        public Integer getSold() { return sold; }
        public InventoryBlockSummary setSold(Integer value) { this.sold = value; return this; }
        public Date getLastUpdated() { return lastUpdated; }
        public InventoryBlockSummary setLastUpdated(Date value) { this.lastUpdated = value; return this; }
    }

}

Java 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>