CenResService

<back to all web services

InventoryBlockSummaryRequest

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

Namespace Global

    Namespace Cendyn.CenRes.DataLib.ViewModels

        Public Partial Class InventoryBlockSummary
            Public Overridable Property CendynPropertyID As String
            Public Overridable Property InventoryDay As Date
            Public Overridable Property Count As Nullable(Of Integer)
            Public Overridable Property Sold As Nullable(Of Integer)
            Public Overridable Property LastUpdated As Nullable(Of Date)
        End Class
    End Namespace

    Namespace CenResSS.ServiceModel

        Public Partial Class CenResResponse
            Public Overridable Property Status As RequestStatus
            Public Overridable Property StatusMessage As String
            Public Overridable Property RecordsReturned As Integer
            Public Overridable Property RecordsAvailable As Integer
            Public Overridable Property PageNumber As Integer
            Public Overridable Property PageSize As Integer
        End Class

        Public Partial Class InventoryBlockSummaryRequest
            Public Overridable Property CendynPropertyId As String
            Public Overridable Property StartDate As Nullable(Of Date)
            Public Overridable Property EndDate As Nullable(Of Date)
            <DataMember(Name:="Limit")>
            Public Overridable Property PageSize As Integer

            <DataMember(Name:="Page")>
            Public Overridable Property PageNumber As Integer
        End Class

        Public Partial Class InventoryBlockSummaryResponse
            Inherits CenResResponse
            Public Sub New()
                Records = New List(Of InventoryBlockSummary)
            End Sub

            Public Overridable Property Records As List(Of InventoryBlockSummary)
        End Class

        Public Enum RequestStatus
            Success
            Warning
            [Error]
            NotAuthorized
            Failure
        End Enum
    End Namespace
End Namespace

VB.NET 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>