POST api/TourTransactions/v2/Confirmation/Demo
Request Information
URI Parameters
None.
Body Parameters
ChooseConfirmationTourTransactionBindingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| PaymentChoice | PaymentGatewayChoice |
None. |
|
| CustomValue | decimal number |
None. |
|
| Id |
Tour transaction ID |
string |
Required |
| Confirmation |
An enumeration used to confirm, cancel, or approve transaction |
ConfirmationType |
Required |
| SupplementPayment | Collection of SupplementPayableBindingModel |
None. |
|
| UpdateGuest | UpdateGuestBindingModel |
None. |
|
| CancellationReasonId | integer |
None. |
|
| CancellationReasonNote | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"PaymentChoice": 0,
"CustomValue": 1.0,
"Id": "sample string 1",
"Confirmation": 0,
"SupplementPayment": [
{
"PaymentValue": 1.0,
"Id": 1,
"Qty": 1
},
{
"PaymentValue": 1.0,
"Id": 1,
"Qty": 1
}
],
"UpdateGuest": {
"AdultPax": 1,
"ChildPax": 2,
"InfantPax": 3,
"RoomAllocation": {
"SharingRoomQty": 1,
"ChildSharingRoomQty": 2,
"SingleRoomQty": 3,
"ChildSingleRoomQty": 4,
"ExtraBedQty": 5,
"ChildExtraBedQty": 6,
"SharingBedQty": 7,
"BabyCrib": 8,
"NoBed": 9
},
"Guests": [
{
"Id": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3",
"TourTransactionId": "sample string 4",
"IdentityNbr": "sample string 5",
"IdentityType": "sample string 6",
"GuestType": 76,
"GuestCategory": "sample string 7",
"GuestTitle": "sample string 8",
"CountryId": "sample string 9",
"IsActive": true
},
{
"Id": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3",
"TourTransactionId": "sample string 4",
"IdentityNbr": "sample string 5",
"IdentityType": "sample string 6",
"GuestType": 76,
"GuestCategory": "sample string 7",
"GuestTitle": "sample string 8",
"CountryId": "sample string 9",
"IsActive": true
}
]
},
"CancellationReasonId": 1,
"CancellationReasonNote": "sample string 2"
}
application/xml, text/xml
Sample:
<ChooseConfirmationTourTransactionBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TripPlannerAPI.Models.DTO">
<CancellationReasonId>1</CancellationReasonId>
<CancellationReasonNote>sample string 2</CancellationReasonNote>
<Confirmation>Confirm</Confirmation>
<Id>sample string 1</Id>
<SupplementPayment>
<SupplementPayableBindingModel>
<Id>1</Id>
<Qty>1</Qty>
<PaymentValue>1</PaymentValue>
</SupplementPayableBindingModel>
<SupplementPayableBindingModel>
<Id>1</Id>
<Qty>1</Qty>
<PaymentValue>1</PaymentValue>
</SupplementPayableBindingModel>
</SupplementPayment>
<UpdateGuest>
<AdultPax>1</AdultPax>
<ChildPax>2</ChildPax>
<Guests>
<TourTransactionDetailGuestBindingModel>
<CountryId>sample string 9</CountryId>
<FirstName>sample string 2</FirstName>
<GuestCategory>sample string 7</GuestCategory>
<GuestTitle>sample string 8</GuestTitle>
<GuestType>TOURLEADER</GuestType>
<Id>1</Id>
<IdentityNbr>sample string 5</IdentityNbr>
<IdentityType>sample string 6</IdentityType>
<IsActive>true</IsActive>
<LastName>sample string 3</LastName>
<TourTransactionId>sample string 4</TourTransactionId>
</TourTransactionDetailGuestBindingModel>
<TourTransactionDetailGuestBindingModel>
<CountryId>sample string 9</CountryId>
<FirstName>sample string 2</FirstName>
<GuestCategory>sample string 7</GuestCategory>
<GuestTitle>sample string 8</GuestTitle>
<GuestType>TOURLEADER</GuestType>
<Id>1</Id>
<IdentityNbr>sample string 5</IdentityNbr>
<IdentityType>sample string 6</IdentityType>
<IsActive>true</IsActive>
<LastName>sample string 3</LastName>
<TourTransactionId>sample string 4</TourTransactionId>
</TourTransactionDetailGuestBindingModel>
</Guests>
<InfantPax>3</InfantPax>
<RoomAllocation>
<BabyCrib>8</BabyCrib>
<ChildExtraBedQty>6</ChildExtraBedQty>
<ChildSharingRoomQty>2</ChildSharingRoomQty>
<ChildSingleRoomQty>4</ChildSingleRoomQty>
<ExtraBedQty>5</ExtraBedQty>
<NoBed>9</NoBed>
<SharingBedQty>7</SharingBedQty>
<SharingRoomQty>1</SharingRoomQty>
<SingleRoomQty>3</SingleRoomQty>
</RoomAllocation>
</UpdateGuest>
<CustomValue>1</CustomValue>
<PaymentChoice>Deposit</PaymentChoice>
</ChooseConfirmationTourTransactionBindingModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ConfirmationDemoViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| SupplementPayable | decimal number |
None. |
|
| TermPayable | decimal number |
None. |
|
| TotalPriceForCustomer | decimal number |
None. |
|
| CurrencyId | string |
None. |
|
| ConfirmationToken | string |
None. |
|
| PaymentGateAwayChoices | Collection of SimplePaymentMethodRelatedToCountry |
None. |
|
| Information | string |
None. |
|
| OutstandingBill | decimal number |
None. |
|
| Shortfall | decimal number |
None. |
|
| CompanyBalance | decimal number |
None. |
Response Formats
application/json, text/json
Sample:
{
"SupplementPayable": 1.0,
"TermPayable": 2.0,
"TotalPriceForCustomer": 3.0,
"CurrencyId": "sample string 4",
"ConfirmationToken": "sample string 5",
"PaymentGateAwayChoices": [
{
"PaymentGateAwayChoice": "sample string 1"
},
{
"PaymentGateAwayChoice": "sample string 1"
}
],
"Information": "sample string 6",
"OutstandingBill": 7.0,
"Shortfall": 8.0,
"CompanyBalance": 9.0
}
application/xml, text/xml
Sample:
<ConfirmationDemoViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TripPlannerAPI.Models.DTO">
<CompanyBalance>9</CompanyBalance>
<ConfirmationToken>sample string 5</ConfirmationToken>
<CurrencyId>sample string 4</CurrencyId>
<Information>sample string 6</Information>
<OutstandingBill>7</OutstandingBill>
<PaymentGateAwayChoices>
<SimplePaymentMethodRelatedToCountry>
<PaymentGateAwayChoice>sample string 1</PaymentGateAwayChoice>
</SimplePaymentMethodRelatedToCountry>
<SimplePaymentMethodRelatedToCountry>
<PaymentGateAwayChoice>sample string 1</PaymentGateAwayChoice>
</SimplePaymentMethodRelatedToCountry>
</PaymentGateAwayChoices>
<Shortfall>8</Shortfall>
<SupplementPayable>1</SupplementPayable>
<TermPayable>2</TermPayable>
<TotalPriceForCustomer>3</TotalPriceForCustomer>
</ConfirmationDemoViewModel>