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 .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}