A record which represents a consumable message. These are consumed by different IHotelPaymentDelivery implementations. The IHotelPaymentDelivery consume these to deliver payment via fax, email, or other integrations (sertifi) to a hotel. User: Kurt Stauffer Date: 9/20/13 Time: 8:36 AM
| name | data type | type | namespace | min/max occurs | constraints | description |
|---|---|---|---|---|---|---|
| analyticStatus | analyticStatus | element | 0/1 | The analytical status for the delivery of this virtual payment. | ||
| attempt | int | element | 1/1 | required int | The number of times delivery has been attempted for this queue | |
| confirmationRecipient | string | element | 0/1 | Todo: Who is the confirmation recipient supposed to be? | ||
| confirmationSent | boolean | element | 1/1 | required boolean | A flag to indicate that an email was sent to the booking agent (or hpl settings overrides) The email confirms that either: A fax was sent/failed OR A confirmation was sent/failed to send to Sertifi. If we are sending with Sertifi, and it is successful, we set this to true without emailing the agent. | |
| consumeTime | dateTime | element | 0/1 | The time at which fax delivery will be attempted by the consumer. | ||
| dailyFax | boolean | element | 1/1 | required boolean | An old indicator that this is the latest fax. | |
| emailSuccess | boolean | element | 1/1 | required boolean | todo: is this a indicator that an email was delivered to the hotel as payment or as an indicator that we emailed an agent? | |
| faxQueue | faxQueue | element | 0/1 | |||
| finish | dateTime | element | 0/1 | The time at which the consumer finished processing this record. | ||
| hasErrors | boolean | element | 1/1 | required boolean | Whether ANY error was encountered while trying to generate and deliver payment | |
| hotelEmail | string | element | 0/1 | |||
| hotelSegment | hotelSegment | element | 0/1 | The hotel segment that this payment is for. Hotel segments can have many payment queues created depending on the need. | ||
| itinerary | itinerary | element | 0/1 | The itinerary that this payment is for. Itineraries can have many payments associated with them. | ||
| latestCheckin | boolean | element | 1/1 | required boolean | Whether this is the latest HplQueue for this RecordLocator and Segment | |
| logs | list of hplLog | element | 0/unbounded | |||
| notes | string | element | 0/1 | |||
| segmentNumber | int | element | 1/1 | required int | The segment number that this references in the GDS. Newer implementations will not need to rely on this. | |
| start | string | element | 0/1 | The time at which the consumer began processing this record. | ||
| timestamp | dateTime | element | 0/1 | The time at which this record was created. | ||
| virtualCard | virtualPaymentCard | element | 0/1 | The generated virtual card for this payment | ||
Properties inherited from baseHibernateEntity |
||||||
| id | long | element | 0/1 | The unique internal ID of the object. | ||
| version | long | element | 0/1 | For internal use only. This is the serialization recorder for optimistic locking of several objects between sessions. | ||
Properties inherited from baseEntity |
||||||
| violations | list of simpleViolation | element | 0/unbounded | A list of constraint violations, if any, that this object has. | ||
Example
<hplQueue>
<timestamp>...</timestamp>
<itinerary>
<recordLocator>...</recordLocator>
<agentName>...</agentName>
<client>
<status/>
<parentClient/>
<accountNumber>...</accountNumber>
<name>...</name>
<type/>
</client>
<office>
<pcc>...</pcc>
<name>...</name>
<address1>...</address1>
<address2>...</address2>
<address3>...</address3>
<city>...</city>
<state>...</state>
<zip>...</zip>
<parentCompany/>
<active>...</active>
<branch>...</branch>
<clientPrefix>...</clientPrefix>
<profileSettings/>
<afterHoursNumber>...</afterHoursNumber>
<collectVoidLogs>...</collectVoidLogs>
<gds/>
<arcNumber>...</arcNumber>
<logo>...</logo>
<logoLink>...</logoLink>
<afterHoursInternationalNumber>...</afterHoursInternationalNumber>
<tollFreeNumber>...</tollFreeNumber>
<phoneNumber>...</phoneNumber>
<onlineOffice/>
<showTmcAppLinks>...</showTmcAppLinks>
<vipTollFree>...</vipTollFree>
<vipAfterHours>...</vipAfterHours>
<cityCode/>
<tmcHeadQuarters>...</tmcHeadQuarters>
</office>
<departureDate>...</departureDate>
<completionDate>...</completionDate>
<importDate>...</importDate>
<gds>
<code>...</code>
<name>...</name>
<enabled>...</enabled>
</gds>
<latest>...</latest>
<citySummary>...</citySummary>
<departureCity>
<code>...</code>
<countryCode>...</countryCode>
<latitude>...</latitude>
<longitude>...</longitude>
<name>...</name>
<stateOrCountry>...</stateOrCountry>
<airportName>...</airportName>
<region/>
<timeZone/>
<retentionOnly>...</retentionOnly>
<position>...</position>
<unique>...</unique>
<alias>...</alias>
</departureCity>
<arrivalCity>
<code>...</code>
<countryCode>...</countryCode>
<latitude>...</latitude>
<longitude>...</longitude>
<name>...</name>
<stateOrCountry>...</stateOrCountry>
<airportName>...</airportName>
<region/>
<timeZone/>
<retentionOnly>...</retentionOnly>
<position>...</position>
<unique>...</unique>
<alias>...</alias>
</arrivalCity>
<arrivalDate>...</arrivalDate>
<utcArrivalDate>...</utcArrivalDate>
<startDate>...</startDate>
<endDate>...</endDate>
<purpose>...</purpose>
<explanation>...</explanation>
<authorizationCode>...</authorizationCode>
<costCenterCode>...</costCenterCode>
<departmentCode>...</departmentCode>
<clientCode>...</clientCode>
<regionCode>...</regionCode>
<billable>...</billable>
<travelerCode>...</travelerCode>
<managerCode>...</managerCode>
<projectCode>...</projectCode>
<status>
<name>...</name>
<position>...</position>
</status>
<observers>
<status/>
<parentClient/>
<accountNumber>...</accountNumber>
<name>...</name>
<type/>
</observers>
<id>...</id>
<version>...</version>
</itinerary>
<hotelSegment>
<frequentGuestNumber>...</frequentGuestNumber>
<corporateDiscountNumber>...</corporateDiscountNumber>
<guestName>...</guestName>
<numberOfRooms>...</numberOfRooms>
<notes>...</notes>
<checkIn>...</checkIn>
<checkOut>...</checkOut>
<roomDescription>...</roomDescription>
<roomType>...</roomType>
<cancellationNumber>...</cancellationNumber>
<cancellationPolicy>...</cancellationPolicy>
<guaranteeRequirements>...</guaranteeRequirements>
<guaranteeInformation>...</guaranteeInformation>
<checkOutPenalty>...</checkOutPenalty>
<numberOfGuests>...</numberOfGuests>
<numberOfChildren>...</numberOfChildren>
<hotel>
<address1>...</address1>
<address2>...</address2>
<phone1>...</phone1>
<phone2>...</phone2>
<fax>...</fax>
<zip>...</zip>
<city/>
<vendor/>
<latitude>...</latitude>
<sertifiCode>...</sertifiCode>
<googlePlaceId>...</googlePlaceId>
<longitude>...</longitude>
<propertyName>...</propertyName>
<propertyCodes/>
</hotel>
<rateInfo>...</rateInfo>
<rateDesc>...</rateDesc>
<totalAmount>...</totalAmount>
<taxRate>...</taxRate>
<taxCharge>...</taxCharge>
<addCharge>...</addCharge>
<specialPrint>...</specialPrint>
<commissionAmount>...</commissionAmount>
<utcCheckIn>...</utcCheckIn>
<utcCheckOut>...</utcCheckOut>
<number>...</number>
<confirmationNumber>...</confirmationNumber>
<status/>
<startDate>...</startDate>
<endDate>...</endDate>
<inGds>...</inGds>
<itinerary/>
</hotelSegment>
<segmentNumber>...</segmentNumber>
<start>...</start>
<finish>...</finish>
<notes>...</notes>
<hasErrors>...</hasErrors>
<faxQueue>
<timestamp>...</timestamp>
<start>...</start>
<end>...</end>
<faxNumber>...</faxNumber>
<recipientName>...</recipientName>
<subject>...</subject>
<text>...</text>
<documents>
<documentPath>...</documentPath>
</documents>
<faxTransId>...</faxTransId>
<faxError>
<code>...</code>
<error>...</error>
</faxError>
<status>
<code>...</code>
<status>...</status>
<shortStatus>...</shortStatus>
<retryOnFail>...</retryOnFail>
</status>
<id>...</id>
<version>...</version>
</faxQueue>
<hotelEmail>...</hotelEmail>
<emailSuccess>...</emailSuccess>
<dailyFax>...</dailyFax>
<confirmationSent>...</confirmationSent>
<confirmationRecipient>...</confirmationRecipient>
<logs>
<timestamp>...</timestamp>
<action>...</action>
<message>...</message>
<inError>...</inError>
<transactionId>...</transactionId>
<id>...</id>
<version>...</version>
</logs>
<attempt>...</attempt>
<virtualCard>
<createdDate>...</createdDate>
<type>
<code>...</code>
<name>...</name>
</type>
<uid>...</uid>
<number>...</number>
<activeFromDate>...</activeFromDate>
<activeToDate>...</activeToDate>
<expireDate>...</expireDate>
<cvc>...</cvc>
<amount>...</amount>
<canceled>...</canceled>
<canceledDate>...</canceledDate>
<id>...</id>
<version>...</version>
</virtualCard>
<analyticStatus>
<name>...</name>
<percentage>...</percentage>
<id>...</id>
<version>...</version>
</analyticStatus>
<latestCheckin>...</latestCheckin>
<consumeTime>...</consumeTime>
<id>...</id>
<version>...</version>
<violations/>
</hplQueue>