CenResService

<back to all web services

TransactionRequest

The following routes are available for this service:
GET/v2/transaction/{Query}/{CendynPropertyId}
GET/v2/transaction/{Query}
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 Transaction() = 
        member val CendynPropertyID:String = null with get,set
        member val SourcePropertyID:String = null with get,set
        member val ExternalResID1:String = null with get,set
        member val ExternalProfileID:String = null with get,set
        member val ExternalRefType:String = null with get,set
        member val ExternalRefID:String = null with get,set
        member val TransactionSource:String = null with get,set
        member val TransactionID:String = null with get,set
        member val TransactionGroup:String = null with get,set
        member val TransactionDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val FolioID:String = null with get,set
        member val FolioGroupingID:String = null with get,set
        member val TransactionCode:String = null with get,set
        member val Description:String = null with get,set
        member val CreditAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val DebitAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val NetAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val DisplayOnInvoice:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val LedgerAccountNum:String = null with get,set
        member val CCTransactionType:String = null with get,set
        member val RoomNumber:String = null with get,set
        member val TransferType:String = null with get,set
        member val TransferredResID:String = null with get,set
        member val ReferenceNum:String = null with get,set
        member val PostedNights:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ItemQty:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val UserID:String = null with get,set
        member val CurrencyCode:String = null with get,set
        member val Decimals:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CustomValue1:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val CustomValue2:Nullable<Decimal> = new Nullable<Decimal>() with get,set

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

    type TransactionQueryType =
        | TransactionId = 0
        | LastUpdated = 1
        | TransactionDate = 2

    [<AllowNullLiteral>]
    type TransactionRequest() = 
        member val CendynPropertyId:String = null with get,set
        member val TransactionSource:String = null with get,set
        member val Query:TransactionQueryType = new TransactionQueryType() with get,set
        member val Id: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# TransactionRequest 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/transaction/{Query}/{CendynPropertyId} HTTP/1.1 
Host: cert.cendyn.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TransactionResponse 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>
    <Transaction>
      <CCTransactionType>String</CCTransactionType>
      <CendynPropertyID>String</CendynPropertyID>
      <CreditAmount>0</CreditAmount>
      <CurrencyCode>String</CurrencyCode>
      <CustomValue1>0</CustomValue1>
      <CustomValue2>0</CustomValue2>
      <DebitAmount>0</DebitAmount>
      <Decimals>0</Decimals>
      <Description>String</Description>
      <DisplayOnInvoice>false</DisplayOnInvoice>
      <ExternalProfileID>String</ExternalProfileID>
      <ExternalRefID>String</ExternalRefID>
      <ExternalRefType>String</ExternalRefType>
      <ExternalResID1>String</ExternalResID1>
      <FolioGroupingID>String</FolioGroupingID>
      <FolioID>String</FolioID>
      <ItemQty>0</ItemQty>
      <LedgerAccountNum>String</LedgerAccountNum>
      <NetAmount>0</NetAmount>
      <PostedNights>0</PostedNights>
      <ReferenceNum>String</ReferenceNum>
      <RoomNumber>String</RoomNumber>
      <SourcePropertyID>String</SourcePropertyID>
      <TransactionCode>String</TransactionCode>
      <TransactionDate>0001-01-01T00:00:00</TransactionDate>
      <TransactionGroup>String</TransactionGroup>
      <TransactionID>String</TransactionID>
      <TransactionSource>String</TransactionSource>
      <TransferType>String</TransferType>
      <TransferredResID>String</TransferredResID>
      <UserID>String</UserID>
    </Transaction>
  </Records>
</TransactionResponse>