CenResService

<back to all web services

TransactionRequest

The following routes are available for this service:
GET/v2/transaction/{Query}/{CendynPropertyId}
GET/v2/transaction/{Query}
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.Models

Namespace Global

    Namespace Cendyn.CenRes.DataLib.Models

        Public Partial Class Transaction
            Public Overridable Property CendynPropertyID As String
            Public Overridable Property SourcePropertyID As String
            Public Overridable Property ExternalResID1 As String
            Public Overridable Property ExternalProfileID As String
            Public Overridable Property ExternalRefType As String
            Public Overridable Property ExternalRefID As String
            Public Overridable Property TransactionSource As String
            Public Overridable Property TransactionID As String
            Public Overridable Property TransactionGroup As String
            Public Overridable Property TransactionDate As Nullable(Of Date)
            Public Overridable Property FolioID As String
            Public Overridable Property FolioGroupingID As String
            Public Overridable Property TransactionCode As String
            Public Overridable Property Description As String
            Public Overridable Property CreditAmount As Nullable(Of Decimal)
            Public Overridable Property DebitAmount As Nullable(Of Decimal)
            Public Overridable Property NetAmount As Nullable(Of Decimal)
            Public Overridable Property DisplayOnInvoice As Nullable(Of Boolean)
            Public Overridable Property LedgerAccountNum As String
            Public Overridable Property CCTransactionType As String
            Public Overridable Property RoomNumber As String
            Public Overridable Property TransferType As String
            Public Overridable Property TransferredResID As String
            Public Overridable Property ReferenceNum As String
            Public Overridable Property PostedNights As Nullable(Of Integer)
            Public Overridable Property ItemQty As Nullable(Of Integer)
            Public Overridable Property UserID As String
            Public Overridable Property CurrencyCode As String
            Public Overridable Property Decimals As Nullable(Of Integer)
            Public Overridable Property CustomValue1 As Nullable(Of Decimal)
            Public Overridable Property CustomValue2 As Nullable(Of Decimal)
        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 Enum RequestStatus
            Success
            Warning
            [Error]
            NotAuthorized
            Failure
        End Enum

        Public Enum TransactionQueryType
            TransactionId
            LastUpdated
            TransactionDate
        End Enum

        Public Partial Class TransactionRequest
            Public Overridable Property CendynPropertyId As String
            Public Overridable Property TransactionSource As String
            Public Overridable Property Query As TransactionQueryType
            Public Overridable Property Id 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 TransactionResponse
            Inherits CenResResponse
            Public Sub New()
                Records = New List(Of Transaction)
            End Sub

            Public Overridable Property Records As List(Of Transaction)
        End Class
    End Namespace
End Namespace

VB.NET TransactionRequest 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/transaction/{Query}/{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","sourcePropertyID":"String","externalResID1":"String","externalProfileID":"String","externalRefType":"String","externalRefID":"String","transactionSource":"String","transactionID":"String","transactionGroup":"String","transactionDate":"0001-01-01T00:00:00.0000000","folioID":"String","folioGroupingID":"String","transactionCode":"String","description":"String","creditAmount":0,"debitAmount":0,"netAmount":0,"displayOnInvoice":false,"ledgerAccountNum":"String","ccTransactionType":"String","roomNumber":"String","transferType":"String","transferredResID":"String","referenceNum":"String","postedNights":0,"itemQty":0,"userID":"String","currencyCode":"String","decimals":0,"customValue1":0,"customValue2":0}],"status":"Success","statusMessage":"String","recordsReturned":0,"recordsAvailable":0,"pageNumber":0,"pageSize":0}