CenResService

<back to all web services

InventoryBlockSummaryRequest

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

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type RequestStatus =
        | Success = 0
        | Warning = 1
        | Error = 2
        | NotAuthorized = 3
        | Failure = 4

    [<AllowNullLiteral>]
    type CenResResponse() = 
        member val Status:RequestStatus = new RequestStatus() with get,set
        member val StatusMessage:String = null with get,set
        member val RecordsReturned:Int32 = new Int32() with get,set
        member val RecordsAvailable:Int32 = new Int32() with get,set
        member val PageNumber:Int32 = new Int32() with get,set
        member val PageSize:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type InventoryBlockSummary() = 
        member val CendynPropertyID:String = null with get,set
        member val InventoryDay:DateTime = new DateTime() with get,set
        member val Count:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Sold:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LastUpdated:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type InventoryBlockSummaryResponse() = 
        inherit CenResResponse()
        member val Records:ResizeArray<InventoryBlockSummary> = new ResizeArray<InventoryBlockSummary>() with get,set

    [<AllowNullLiteral>]
    type InventoryBlockSummaryRequest() = 
        member val CendynPropertyId:String = null with get,set
        member val StartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        [<DataMember(Name="Limit")>]
        member val PageSize:Int32 = new Int32() with get,set

        [<DataMember(Name="Page")>]
        member val PageNumber:Int32 = new Int32() with get,set

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