CenResService

<back to all web services

InventoryBlockSummaryRequest

The following routes are available for this service:
GET/v2/inventoryblock/summary/{CendynPropertyId}
GET/v2/inventoryblock/summary
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CenResSS.ServiceModel;
using Cendyn.CenRes.DataLib.ViewModels;

namespace Cendyn.CenRes.DataLib.ViewModels
{
    public partial class InventoryBlockSummary
    {
        public virtual string CendynPropertyID { get; set; }
        public virtual DateTime InventoryDay { get; set; }
        public virtual int? Count { get; set; }
        public virtual int? Sold { get; set; }
        public virtual DateTime? LastUpdated { get; set; }
    }

}

namespace CenResSS.ServiceModel
{
    public partial class CenResResponse
    {
        public virtual RequestStatus Status { get; set; }
        public virtual string StatusMessage { get; set; }
        public virtual int RecordsReturned { get; set; }
        public virtual int RecordsAvailable { get; set; }
        public virtual int PageNumber { get; set; }
        public virtual int PageSize { get; set; }
    }

    public partial class InventoryBlockSummaryRequest
    {
        public virtual string CendynPropertyId { get; set; }
        public virtual DateTime? StartDate { get; set; }
        public virtual DateTime? EndDate { get; set; }
        [DataMember(Name="Limit")]
        public virtual int PageSize { get; set; }

        [DataMember(Name="Page")]
        public virtual int PageNumber { get; set; }
    }

    public partial class InventoryBlockSummaryResponse
        : CenResResponse
    {
        public InventoryBlockSummaryResponse()
        {
            Records = new List<InventoryBlockSummary>{};
        }

        public virtual List<InventoryBlockSummary> Records { get; set; }
    }

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

}

C# 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>