Это старая версия документа!
Содержание
apiPymtManExchConfirm
Finish manual exchange
Request
ApiPymtManExchConfirmRequest
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| emds | optional | array of ManEmdPrice | |||
| fops | optional | Forms of payment | array of FopDetails | ||
| id | required | Local payment order ID | LocalPaymentOrderId | ||
| savePricingOnly | optional | false | boolean | ||
| tkts | optional | array of ManTktPrice |
Response
ApiPymtManExchConfirmResponse
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| newEmds | optional | Issued EMDs | array of EmdNum | ||
| newTickets | optional | Issued tickets | array of TicketStr | ||
| oldEmds | optional | Exchanged EMDs | array of EmdNum | ||
| oldTickets | optional | Exchanged tickets | array of TicketStr | ||
| penaltyEmds | optional | Issued penalty EMDs | array of EmdNum | ||
| pnr | required | Passenger name record | Pnr |
Definitions
ASvc
Segment-associated service
JSON type: object
| member | is optional | description | default | constraints | type | |
|---|---|---|---|---|---|---|
| emd | optional | EMD | EmdDesc | |||
| emdType | optional | EMD type | EmdType | |||
| nos | required | Name of service | EncString | |||
| passNum | required | Passenger number | PassNum | |||
| qtty | required | Quantity | Value at least 1 | number | ||
| rfic | required | Reason for issuance code | Rfic | |||
| rfisc | required | Reason for issuance subcode | Rfisc | |||
| segNum | required | Segment number | SegNum | |||
| ssr | optional | SSR code | SsrCode | |||
| status | required | Service status | SvcStatus | |||
| svcType | optional | Service type by S5 | ServiceType | |||
| type | required | Type of this SVC | Always equal ASVC | string |
Address
Address
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| address | optional | Address | EncString | ||
| airline | required | IATA airline designator | CompanyId | ||
| city | optional | City | EncString | ||
| country | required | IATA country designator | CountryId | ||
| passNum | required | Passenger number | PassNum | ||
| region | optional | Region | EncString | ||
| segNum | optional | Segment number | SegNum | ||
| type | required | Type of address | AddressType | ||
| zip | optional | Zip code | EncString |
AddressType
Type of address
JSON type: string
Enum of:
- R
Residence
- D
Destination
Agency
Agency identificator JSON type: string constraints:
Length at least 1
Length at most 9
AircraftTypeId
IATA aircraft designator
JSON type: string
constraints:
- Regular expression
^[0-9A-ZА-Я]{3}$
examples:
- 747
ArnkSegment
Land segment
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| type | required | Type of this segment | Always equal ARNK | string |
ArrStatus
Arrival segment status
JSON type: string
Enum of:
- HK
confirmed
- HN
on request
- LL
on request for waitlist
ArrivalSegment
Arrival segment
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| airline | required | IATA airline designator | CompanyId | ||
| arrDate | optional | Arrival date | Date | ||
| arrDateTimeUtc | optional | Arrival datetime in UTC | DateTimeZ | ||
| arrPoint | required | Arrival airport | PortOrCode | ||
| arrTime | optional | Arrival time | Time | ||
| bookTimeUtc | required | Time of latest change in UTC | DateTimeZ | ||
| depDate | required | Departure date | Date | ||
| depDateTimeUtc | optional | Departure datetime in UTC | DateTimeZ | ||
| depPoint | required | Departure airport | PortOrCode | ||
| depTime | optional | Departure time | Time | ||
| flight | required | Numeric part of flight number | FlightNumber | ||
| ns | required | Number of seats | Value at least 1 Value at most 999 | number | |
| rbd | required | Reservation booking designator | Rbd | ||
| status | required | Arrival segment status | ArrStatus | ||
| suffix | optional | Suffix letter of flight number | FlightSuffix | ||
| type | required | Type of this segment | Always equal ARRIVE | string |
Brand
Brand code
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| brandCode | required | Brand code | BrandCode | ||
| passNum | required | Passenger number | PassNum | ||
| segNum | required | Segment number | SegNum |
BrandCode
Brand code
JSON type: string
constraints:
- Length at least 1
- Length at most 10
examples:
- ECON
Cabin
Aircraft cabin
JSON type: string
constraints:
- Regular expression
^[A-Z]{1}$
examples:
- Y
ChangedBy
Who or what last changed this PNR
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| user | optional | Username, if who==USER | Length at least 1 Length at most 20 | string | |
| who | required | Who or what last changed this PNR | WhoMadeChanges |
CityPoint
City or port designator
JSON type: string
constraints:
- Regular expression
^[A-ZА-Я]{3}$
examples:
- MOW
- SVO
CompanyId
IATA airline designator
JSON type: string
constraints:
- Regular expression
^[0-9A-ZА-Я]{1,3}$
examples:
- FV
Contact
Contact
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| comment | optional | Contact comment | EncString | ||
| lang | optional | Contact language | Length at least 2 Length at most 2 | LangCode | |
| number | required | Contact number | EncString | ||
| passNum | optional | Passenger number | PassNum | ||
| type | required | Contact type | ContactType |
ContactType
Contact type
JSON type: string
Enum of:
- UNKNOWN
- HOME_PHONE
- WORK_PHONE
- FAX
- AGENT_CONTACT
- HOTEL_PHONE
- MOBILE_PHONE
- EMAIL
- AGENT_EMAIL
CountryId
IATA country designator
JSON type: string
constraints:
- Regular expression
^[0-9A-ZА-Я]{2}$
examples:
- RU
Coupon
Coupon number
JSON type: number
constraints:
- Value at least 1
- Value at most 4
examples:
- 2
CouponStatus
Eticket coupon status by IATA res 722
JSON type: string
constraints:
- Length at least 1
- Length at most 1
examples:
- O
- V
- F
CshInfo
Information about some partner’s properties for codeshare segment
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| airline | required | IATA airline designator | CompanyId | ||
| flight | required | Numeric part of flight number | FlightNumber | ||
| rbd | required | Reservation booking designator | Rbd | ||
| suffix | optional | Suffix letter of flight number | FlightSuffix |
CurrencyId
IATA currency designator
JSON type: string
constraints:
- Regular expression
^[A-ZА-Я]{3}$
examples:
- RUB
Date
Date without time in ISO 8601 format
JSON type: string constraints:
- Regular expression
^[0-9]{8}$
examples:
- 19991231
DateTime
Date and time in ISO 8601 format
JSON type: string
constraints:
- Regular expression
^[0-9]{8}T[0-9]{6}(.[0-9]{1,9})?$
examples:
- 19991231T232159
DateTimeZ
Date and time in ISO 8601 format
JSON type: string
constraints:
- Regular expression
^[0-9]{8}T[0-9]{6}(.[0-9]{1,9})?.*$
examples:
- 19991231T232159Z
- 19991231T232159+03
- 19991231T232159-0330
DistrSegment
Distributive segment
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| aircraftType | optional | IATA aircraft designator | AircraftTypeId | ||
| airline | required | IATA airline designator | CompanyId | ||
| arrDate | optional | Arrival date | Date | ||
| arrDateTimeUtc | optional | Arrival datetime in UTC | DateTimeZ | ||
| arrPoint | required | Arrival airport | PortId | ||
| arrTime | optional | Arrival time | Time | ||
| bookTimeUtc | required | Time of latest change in UTC | DateTimeZ | ||
| cabin | optional | Aircraft cabin | Cabin | ||
| cshOpr | optional | Information about some partner’s properties for codeshare segment | CshInfo | ||
| depDate | required | Departure date | Date | ||
| depDateTimeUtc | optional | Departure datetime in UTC | DateTimeZ | ||
| depPoint | required | Departure airport | PortId | ||
| depTime | optional | Departure time | Time | ||
| flight | required | Numeric part of flight number | FlightNumber | ||
| marriageId | optional | Marriage identfier | Value at least 1 Value at most 999999 | number | |
| ns | required | Number of seats | Value at least 1 Value at most 999 | number | |
| operatedBy | optional | Operating carrier disclosure | OperatingCarrier | ||
| rbd | required | Reservation booking designator | Rbd | ||
| ssp | optional | Special reserve code | SpecRes | ||
| status | required | Flight segment status | SegStatus | ||
| suffix | optional | Suffix letter of flight number | FlightSuffix | ||
| type | required | Type of this segment | Always equal DISTR | string |
DocNumber
Document number
JSON type: string
constraints:
- Length at least 1
- Length at most 70
- Regular expression
^[A-ZА-Я0-9]{1,20}$
DocType
Document type
JSON type: string
constraints:
- Regular expression
^[A-Z]{1,3}$
examples:
- PS
Document
Information about document
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| birthDate | optional | Date of birth | Date | ||
| citizenship | optional | Nationality | Nationality | ||
| country | optional | IATA country designator | CountryId | ||
| expDate | optional | Document expiration date | Date | ||
| firstGivenName | required | First given name | Length at least 1 Length at most 60 | EncString | |
| number | required | Document number | DocNumber | ||
| passNum | required | Passenger number | PassNum | ||
| secondGivenName | optional | Second given name | Length at least 1 Length at most 60 | EncString | |
| sex | optional | Passenger’s sex | Sex | ||
| surname | required | Surname | Length at least 1 Length at most 60 | EncString | |
| type | required | Document type | DocType |
EmdDesc
EMD
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| coupon | required | Coupon number | Coupon | ||
| number | required | Full EMD number | EmdNum |
EmdNum
Full EMD number
JSON type: string
constraints:
- Regular expression
^[A-ZА-Я0-9]{13}$
EmdTax
EMD tax
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| code | required | Tax code | string | ||
| sum | required | Sum | Price |
EmdType
EMD type
JSON type: string
Enum of:
- A
- S
EmdVoidTml
EMD void time limit
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| number | required | Full EMD number | EmdNum | ||
| timeLimit | required | Date and time in ISO 8601 format | DateTimeZ |
EncString
JSON type: string
FlightNumber
Numeric part of flight number
JSON type: number
constraints:
- Value at least 1
- Value at most 9999
examples:
- 101
FlightSuffix
Suffix letter of flight number
JSON type: string
constraints:
- Regular expression
^[A-Z]{1}$
examples:
- K
FopCode
Form of payment code
JSON type: string
constraints:
- Length at least 2
- Length at most 2
examples:
- CA
- CC
FopDetails
Form of payment details
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| auth | optional | Authorization information | FopAuth | ||
| code | required | Form of payment code | FopCode | ||
| num | optional | Form of payment type and/or number | EncString | ||
| type | optional | DEPRECATED: use .num | EncString |
FopInfo
Form of payment
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| authCode | optional | Authorization code | “” | string | |
| code | required | Form of payment code | FopCode | ||
| moved | optional | Is moved | false | boolean | |
| num | optional | Form of payment number | EncString | ||
| rrn | optional | RRN | “” | string | |
| sum | optional | Amount of money | MoneyAmount |
Fqt
Frequent traveler info
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| fqtv | required | Fqt program information | EncString | ||
| passNum | required | Passenger number | PassNum | ||
| segNum | optional | Segment number | SegNum | ||
| ssr | required | SSR code | SsrCode |
Group
Group
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| name | required | Group name | GroupName | ||
| ns | required | Seat count | number |
GroupName
Group name
JSON type: string
constraints:
- Length at least 1
- Length at most 50
Infant
Segment-related infant information
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| hasSeat | required | Whether an infant occupies a seat | boolean | ||
| passNum | required | Passenger number | PassNum | ||
| segNum | required | Segment number | SegNum | ||
| status | required | SSR status | SsrStatus |
InvSegment
Inventory segment
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| aircraftType | optional | IATA aircraft designator | AircraftTypeId | ||
| airline | required | IATA airline designator | CompanyId | ||
| arrDate | required | Arrival date | Date | ||
| arrDateTimeUtc | required | Arrival datetime in UTC | DateTimeZ | ||
| arrPoint | required | Arrival airport | PortId | ||
| arrTime | required | Arrival time | Time | ||
| bookTimeUtc | required | Time of latest change in UTC | DateTimeZ | ||
| cabin | optional | Aircraft cabin | Cabin | ||
| cshMrk | optional | Information about some partner’s properties for codeshare segment | CshInfo | ||
| cshOpr | optional | Information about some partner’s properties for codeshare segment | CshInfo | ||
| depDate | required | Departure date | Date | ||
| depDateTimeUtc | required | Departure datetime in UTC | DateTimeZ | ||
| depPoint | required | Departure airport | PortId | ||
| depTime | required | Departure time | Time | ||
| flight | required | Numeric part of flight number | FlightNumber | ||
| marriageId | optional | Marriage identfier | Value at least 1 Value at most 999999 | number | |
| ns | required | Number of seats | Value at least 1 Value at most 999 | number | |
| operatedBy | optional | Operating carrier disclosure | OperatingCarrier | ||
| rbd | required | Reservation booking designator | Rbd | ||
| ssp | optional | Special reserve code | SpecRes | ||
| status | required | Flight segment status | SegStatus | ||
| suffix | optional | Suffix letter of flight number | FlightSuffix | ||
| type | required | Type of this segment | Always equal INV | string |
LangCode
Language
JSON type: string
constraints:
- Length at least 2
- Length at most 2
LocalPaymentOrderId
Local payment order ID
JSON type: string
constraints:
- Length at least 15
- Length at most 15
ManConfFare
Confidential fare
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| amount | optional | Amount | MoneyAmount | ||
| method | optional | Net reporting method | number | ||
| netAmount | required | Net reporting amount | Price | ||
| text | optional | Text | “” | string |
ManEmdCpnPrice
EMD coupon price data
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| allowedSince | optional | Allowed since | Date | ||
| allowedUntil | optional | Allowed until | Date | ||
| fareExp | optional | FareExp UTC | DateTime | ||
| luggUnit | optional | Luggage unit | PiecesWeightUnits | ||
| luggage | optional | Luggage number | number | ||
| paySum | optional | Pay sum | Price | ||
| perUnitSum | optional | PerUnit sum | Price | ||
| sponsorInfo | optional | Sponsor info | string | ||
| svcNum | required | SVC number | number |
ManEmdPrice
Emd price data
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| addCollect | optional | Add collect sum | MoneyAmount | ||
| coupons | required | Coupons | At least 1 elements At most 16 elements | array of ManEmdCpnPrice | |
| emdType | required | Emd service type | EmdType | ||
| endorsement | optional | Endorsement | string | ||
| equiv | optional | Equivalent sum | MoneyAmount | ||
| exch | optional | Exchange rate | Price | ||
| fareCalc | required | FareCalc | string | ||
| fareRule | optional | Fare rule | string | ||
| fops | optional | Forms of payment | array of ManFopInfo | ||
| nonExchangeable | required | Non exchangeable | boolean | ||
| nonRefundable | required | Non refundable | boolean | ||
| passNum | required | Passenger number | number | ||
| payCurr | required | Payment currency | CurrencyId | ||
| priceType | required | Emd price type | PriceType | ||
| residual | optional | Residual data | ManResidual | ||
| serviceType | required | Emd service type | string | ||
| sponsorInfo | optional | Sponsor info | array of string | ||
| tarif | required | Tarif sum | Price | ||
| taxes | optional | Taxes | array of EmdTax | ||
| total | optional | Total amount | MoneyAmount | ||
| tourCode | optional | Tour code | string | ||
| vat | optional | Vat | Price | ||
| vatTax | optional | VatTax | Price | ||
| vatTaxZZ | optional | VatTaxZZ | Price |
ManFopInfo
Form of payment
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| authCode | optional | Authorization code | “” | string | |
| code | required | Form of payment code | FopCode | ||
| moved | optional | Is moved | false | boolean | |
| num | optional | Form of payment number | EncString | ||
| rrn | optional | RRN | “” | string | |
| sum | optional | Sum (total) | MoneyAmount | ||
| sumTick | optional | Sum (ticket only) | MoneyAmount |
ManResidual
Residual data
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| allowedSince | optional | Allowed since | Date | ||
| allowedUntil | optional | Allowed until | Date | ||
| date | required | Date | Date | ||
| equiv | optional | Equivalent sum | MoneyAmount | ||
| fops | optional | Forms of payment | array of FopInfo | ||
| point | required | IATA airport designator | PortId | ||
| secPoint | optional | IATA airport designator | PortId | ||
| tarif | required | Tarif sum | Price | ||
| taxes | optional | Taxes | array of EmdTax | ||
| total | required | Total sum | Price |
ManTktCpnBrand
Ticket coupon brand info
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| code | required | Brand code | BrandCode | ||
| name | required | Brand display name | string |
ManTktCpnPrice
Ticket coupon to manual exchange
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| allowedSince | optional | Allowed since | Date | ||
| allowedUntil | optional | Allowed until | Date | ||
| baseNote | required | Base note (base fare code) | string | ||
| brandInfo | optional | Brand info | ManTktCpnBrand | ||
| fareClass | required | Fare class | string | ||
| fareExp | optional | FareExp UTC | DateTime | ||
| fareRate | optional | Fare rate | Rate | ||
| fareRemark | optional | Fare remark | string | ||
| fareSum | required | Fare sum | Price | ||
| luggUnit | optional | Luggage unit | PiecesWeightUnits | ||
| luggage | required | Luggage number | number | ||
| note | required | Note (fare code) | string | ||
| otRate | optional | Reporting rate | Rate | ||
| otSum | optional | Reporting sum | Price | ||
| paySum | required | Pay sum | Price | ||
| segNum | required | Segment number | number | ||
| stopoverPermitted | optional | Stopover premitted | false | boolean | |
| taxes | optional | Ticket taxes | array of TktTaxFull |
ManTktPenalty
Penalty data
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| exch | optional | Exchange rate | Price | ||
| fops | optional | Forms of payment | array of FopInfo | ||
| segs | optional | Route | All elements are unique | array of SegNum | |
| tarif | required | Tarif sum | Price | ||
| total | required | Total sum | Price |
ManTktPrice
Ticket price data
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| addCollect | optional | Add collect sum | MoneyAmount | ||
| confFare | optional | Confidential fare | ManConfFare | ||
| coupons | required | Coupons | At least 1 elements At most 16 elements | array of ManTktCpnPrice | |
| endorsement | optional | Endorsement | string | ||
| equiv | optional | Equivalent sum | MoneyAmount | ||
| fareCalc | required | FareCalc | string | ||
| fops | optional | Forms of payment | array of ManFopInfo | ||
| passCtg | required | Passenger category | PassTypeCodeId | ||
| passNum | required | Passenger number | number | ||
| payCurr | required | Payment currency | CurrencyId | ||
| penalties | optional | Penalties | array of ManTktPenalty | ||
| priceType | required | Ticket price type | PriceType | ||
| rates | optional | Rates | string | ||
| residual | optional | Residual data | ManResidual | ||
| tarif | required | Tarif sum | Price | ||
| taxes | optional | Taxes | array of TktTaxShort | ||
| total | optional | Total amount | MoneyAmount | ||
| tourCode | optional | Tour code | string | ||
| vat | optional | Vat | Price | ||
| vatZZ | optional | VatZZ | Price |
MoneyAmount
Amount of money
JSON type: string
examples:
- 1234
- 567.89
- 85.5
Nationality
Nationality
JSON type: string
constraints:
- Length at least 2
- Length at most 3
OpenDateSegment
Open date segment
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| airline | required | IATA airline designator | CompanyId | ||
| arrPoint | required | Arrival airport | PortId | ||
| bookTimeUtc | required | Time of latest change in UTC | DateTimeZ | ||
| depPoint | required | Departure airport | PortId | ||
| flight | optional | Numeric part of flight number | FlightNumber | ||
| ns | required | Number of seats | Value at least 1 Value at most 999 | number | |
| rbd | required | Reservation booking designator | Rbd | ||
| suffix | optional | Suffix letter of flight number | FlightSuffix | ||
| type | required | Type of this segment | Always equal OPENDATE | string |
OperatingCarrier
Operating carrier disclosure
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| code | optional | IATA airline designator | CompanyId | ||
| name | optional | Carrier name | EncString |
PassNum
Passenger number
JSON type: number
constraints:
- Value at least 1
PassType
Passenger type
JSON type: string
Enum of:
- ADT
- CHD
- INF
PassTypeCodeId
Passenger type code
JSON type: string
Passenger
Information about passenger
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| firstName | required | First name | Length at least 1 Length at most 60 | EncString | |
| ns | required | Seat count | Value at least 0 | number | |
| parent | optional | Parent passenger number | PassNum | ||
| ptc | optional | Passenger type code | PassTypeCodeId | ||
| segs | optional | Confirmed flight segment numbers (for infants) | All elements are unique | array of SegNum | |
| surname | required | Surname | Length at least 1 Length at most 60 | EncString | |
| type | required | Passenger type | PassType |
PiecesWeightUnits
Luggage unit
JSON type: string
Enum of:
- P
- K
- L
Pnr
Passenger name record
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| addrs | optional | List of addresses | array of Address | ||
| airline | required | IATA airline designator | CompanyId | ||
| brands | optional | Brands | array of Brand | ||
| changedBy | required | Who or what last changed this PNR | ChangedBy | ||
| children | optional | List of children reclocs | array of Recloc | ||
| connections | optional | Connections | array of array of SegNum | ||
| contacts | optional | List of contacts | array of Contact | ||
| createDateTimeUtc | required | Time of creation in UTC | DateTimeZ | ||
| docs | optional | Documents | array of Document | ||
| fqts | optional | List of frequent traveler program information | array of Fqt | ||
| group | optional | Group | Group | ||
| infants | optional | List of infants | array of Infant | ||
| lut | required | Last update time in UTC | DateTimeZ | ||
| parent | optional | Record locator | Recloc | ||
| pax | optional | List of passengers | array of Passenger | ||
| pos | required | Point of sale that created this PNR | PnrPointOfSale | ||
| recloc | required | Record locator | Recloc | ||
| remarks | optional | List of remarks | array of Remark | ||
| remoteReclocs | optional | List of remote reclocs | array of PnrRemoteRecloc | ||
| segs | optional | List of segments | array of Segment | ||
| services | optional | List of services | array of Service | ||
| spaces | optional | List of spaces | array of Space | ||
| ssrs | optional | List of SSRs | array of Ssr | ||
| svcs | optional | List of optional services | array of Svc | ||
| tickets | optional | List of tickets | array of Ticket | ||
| timeLimit | optional | Date and time in ISO 8601 format | DateTimeZ | ||
| transfers | optional | Transfers | array of array of SegNum | ||
| version | required | Object version | Version | ||
| visas | optional | List of visas | array of Visa | ||
| voidTimeLimits | optional | Void time limits (UTC) | VoidTimeLimits |
PnrPointOfSale
Information about point of sale
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| agency | optional | Agency identificator | Agency | ||
| country | optional | Country | string | ||
| gds | required | Remote system’s name | Length at least 2 Length at most 3 | string | |
| location | optional | Closest city/port | string | ||
| oprId | optional | Operator ID | string | ||
| posId | optional | Agent ID | Length at least 1 Length at most 9 | string | |
| termId | optional | Terminal ID | string |
PnrRemoteRecloc
Information about the remote system
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| predPoint | required | Predpoint | PredPoint | ||
| recloc | optional | GDS record locator | RemoteRecloc |
PortId
IATA airport designator
JSON type: string
constraints:
- Regular expression
^[A-ZА-Я]{3}$
examples:
- SVO
PortOrCode
IATA airport designator
JSON type: string
constraints:
- Regular expression
^[A-ZА-Я]{3}$
examples:
- SVO
PredPoint
Predpoint
JSON type: string
constraints:
- Length at least 5
- Length at most 6
examples:
- MOW1H
- MOWBEK
Price
Price
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| amount | required | Amount of money | MoneyAmount | ||
| currency | required | IATA currency designator | CurrencyId |
PriceType
Price type
JSON type: string
Enum of:
- AutoPrice
- ManualPrice
- SemiAutoPrice
Rate
Rate
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| lhs | required | Price | Price | ||
| rhs | required | Price | Price |
Rbd
Reservation booking designator
JSON type: string constraints:
- Regular expression
^[A-Z]{1}$
examples:
- Y
Recloc
Record locator
JSON type: string
constraints:
- Regular expression
^[A-Z0-9]{6}$
examples:
- ABC123
Remark
Remark JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| airline | required | IATA airline designator | CompanyId | ||
| passNum | optional | Passenger number | PassNum | ||
| text | required | Remark text | EncString | ||
| type | required | Remark type | RemarkType |
RemarkType
Remark type
JSON type: string
Enum of:
- GENERAL
- ADDRESS
- PHONE
- WS
- EMAIL
RemoteRecloc
GDS record locator
JSON type: string
constraints:
- Regular expression
^[A-Z0-9]{5,15}$
examples:
- ABC123
Rfic
Reason for issuance code
JSON type: string
Enum of:
- A
- B
- C
- D
- E
- F
- G
- I
Rfisc
Reason for issuance subcode
JSON type: string
constraints:
- Regular expression
^[A-Z0-9]{3}$
examples:
- 0BF
RfiscGroupCode
Service group code
JSON type: string
constraints:
- Regular expression
^[A-Z]{2}$
examples:
- BG
SSvc
Segment-associated service
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| airline | required | IATA airline designator | CompanyId | ||
| date | required | Date without time in ISO 8601 format | Date | ||
| emd | optional | EMD | EmdDesc | ||
| nos | required | Name of service | EncString | ||
| passNum | required | Passenger number | PassNum | ||
| point | required | City or port designator | CityPoint | ||
| qtty | required | Quantity | Value at least 1 | number | |
| rfic | required | Reason for issuance code | Rfic | ||
| rfisc | required | Reason for issuance subcode | Rfisc | ||
| status | required | Service status | SvcStatus | ||
| svcType | optional | Service type by S5 | ServiceType | ||
| type | required | Type of this SVC | Always equal SSVC | string |
Seat
Seat number
JSON type: string
constraints:
- Regular expression
^[0-9]{1,4}[A-Z]$
examples:
- 10F
SegNum
Segment number
JSON type: number
constraints:
- Value at least 1
SegStatus
Flight segment status
JSON type: string
Enum of:
- HK
confirmed
- HN
on request
- LL
on request for waitlist
- HL
on waitlist
- SA
standby
- NC
not controlled
- XX
cancelled
- UN
unable
- UC
rejected
Segment
A flight segment
JSON type: object
One of:
- InvSegment
- DistrSegment
- ArrivalSegment
- OpenDateSegment
- ArnkSegment
Service
Service
JSON type: object
One of:
- SingleSsr
- SingleSpace
- SsrAsvc
- SpaceAsvc
- SingleAsvc
- SingleSsvc
ServiceType
Service type by S5
JSON type: string
constraints:
- Regular expression
^[A-Z]{1}$
examples:
- F
Sex
Passenger’s sex
JSON type: string
Enum of:
- M
- F
SingleAsvc
ASVC
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| emd | optional | EMD | EmdDesc | ||
| emdType | optional | EMD type | EmdType | ||
| freeText | required | SVC free text | EncString | ||
| nameOfService | required | SVC name of service | EncString | ||
| passNum | required | Passenger number | PassNum | ||
| qtty | required | Quantity | Value at least 1 | number | |
| rfic | required | Reason for issuance code | Rfic | ||
| rfisc | required | Reason for issuance subcode | Rfisc | ||
| rfiscGroup | optional | Service group code | RfiscGroupCode | ||
| segNum | required | Segment number | SegNum | ||
| serviceType | optional | Service type by S5 | ServiceType | ||
| status | required | Service status | SvcStatus | ||
| timeLimit | optional | Date and time in ISO 8601 format | DateTimeZ | ||
| type | required | Type of service | Always equal SingleAsvc | string |
SingleSpace
Space
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| passNum | optional | Passenger number | PassNum | ||
| seat | optional | Seat number | Seat | ||
| segNum | required | Segment number | SegNum | ||
| ssr | required | SSR code | SsrCode | ||
| status | required | SSR status | SsrStatus | ||
| type | required | Type of service | Always equal SingleSpace | string |
SingleSsr
SSR
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| airline | required | IATA airline designator | CompanyId | ||
| freeText | required | SSR free text | EncString | ||
| passNum | optional | Passenger number | PassNum | ||
| qtty | required | Quantity | Value at least 1 | number | |
| segNum | optional | Segment number | SegNum | ||
| ssr | required | SSR code | SsrCode | ||
| status | required | SSR status | SsrStatus | ||
| type | required | Type of service | Always equal SingleSsr | string |
SingleSsvc
SSVC
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| airline | required | IATA airline designator | CompanyId | ||
| dt | optional | Date without time in ISO 8601 format | Date | ||
| emd | optional | EMD | EmdDesc | ||
| freeText | required | SVC free text | EncString | ||
| nameOfService | required | SVC name of service | EncString | ||
| passNum | required | Passenger number | PassNum | ||
| point | required | City or port designator | CityPoint | ||
| qtty | required | Quantity | Value at least 1 | number | |
| rfic | required | Reason for issuance code | Rfic | ||
| rfisc | required | Reason for issuance subcode | Rfisc | ||
| rfiscGroup | optional | Service group code | RfiscGroupCode | ||
| secondaryPoint | optional | City or port designator | CityPoint | ||
| serviceType | optional | Service type by S5 | ServiceType | ||
| status | required | Service status | SvcStatus | ||
| timeLimit | optional | Date and time in ISO 8601 format | DateTimeZ | ||
| type | required | Type of service | Always equal SingleSsvc | string |
Space
Space
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| passNum | optional | Passenger number | PassNum | ||
| seat | optional | Seat number | Seat | ||
| segNum | required | Segment number | SegNum | ||
| ssr | required | SSR code | SsrCode | ||
| status | required | SSR status | SsrStatus |
SpaceAsvc
Space with ASVC
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| emd | optional | EMD | EmdDesc | ||
| emdType | optional | EMD type | EmdType | ||
| passNum | required | Passenger number | PassNum | ||
| rfic | required | Reason for issuance code | Rfic | ||
| rfisc | required | Reason for issuance subcode | Rfisc | ||
| rfiscGroup | optional | Service group code | RfiscGroupCode | ||
| seat | optional | Seat number | Seat | ||
| segNum | required | Segment number | SegNum | ||
| serviceType | optional | Service type by S5 | ServiceType | ||
| ssr | required | SSR code | SsrCode | ||
| status | required | Service status | SvcStatus | ||
| svcFreeText | required | SVC free text | EncString | ||
| svcNameOfService | required | SVC name of service | EncString | ||
| timeLimit | optional | Date and time in ISO 8601 format | DateTimeZ | ||
| type | required | Type of service | Always equal SpaceAsvc | string |
SpecRes
Special reservation code
JSON type: string
constraints:
- Regular expression
^[A-Z]{3}$
examples:
- RRR
Ssr
SSR
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| airline | required | IATA airline designator | CompanyId | ||
| passNum | optional | Passenger number | PassNum | ||
| qtty | required | Quantity | Value at least 1 | number | |
| segNum | optional | Segment number | SegNum | ||
| ssr | required | SSR code | SsrCode | ||
| status | required | SSR status | SsrStatus | ||
| text | required | SSR text | EncString |
SsrAsvc
SSR with ASVC
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| emd | optional | EMD | EmdDesc | ||
| emdType | optional | EMD type | EmdType | ||
| passNum | required | Passenger number | PassNum | ||
| qtty | required | Quantity | Value at least 1 | number | |
| rfic | required | Reason for issuance code | Rfic | ||
| rfisc | required | Reason for issuance subcode | Rfisc | ||
| rfiscGroup | optional | Service group code | RfiscGroupCode | ||
| segNum | required | Segment number | SegNum | ||
| serviceType | optional | Service type by S5 | ServiceType | ||
| ssr | required | SSR code | SsrCode | ||
| ssrFreeText | required | SSR free text | EncString | ||
| status | required | Service status | SvcStatus | ||
| svcFreeText | required | SVC free text | EncString | ||
| svcNameOfService | required | SVC name of service | EncString | ||
| timeLimit | optional | Date and time in ISO 8601 format | DateTimeZ | ||
| type | required | Type of service | Always equal SsrAsvc | string |
SsrCode
SSR code
JSON type: string
constraints:
- Regular expression
^[A-Z]{4}$
examples:
- XBAG
SsrStatus
SSR status
JSON type: string
Enum of:
- HK
confirmed
- HN
on request
- NO
ignored
- XX
cancelled
- UN
unable
- UC
rejected
Svc
Optional service
JSON type: object
One of:
- ASvc
- SSvc
SvcStatus
Service status
JSON type: string
Enum of:
- HK
confirmed, EMD is not required
- HD
confirmed, EMD is required HI confirmed, EMD is present
- HN
on request
- NO
ignored
- XX
cancelled
- UN
unable
- UC
rejected
Ticket
Ticket
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| coupon | optional | Coupon number | Coupon | ||
| couponStatus | optional | Eticket coupon status by IATA res 722 | CouponStatus | ||
| passNum | required | Passenger number | PassNum | ||
| segNum | required | Segment number | SegNum | ||
| ticket | required | Full ticket number | TicketStr |
TicketStr
Full ticket number
JSON type: string
constraints:
- Regular expression
^[A-ZА-Я0-9]{10,14}$
TicketVoidTml
Ticket void time limit
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| number | required | Full ticket number | TicketStr | ||
| timeLimit | required | Date and time in ISO 8601 format | DateTimeZ |
Time
Time of day in ISO 8601 format
JSON type: string
constraints:
- Regular expression
^[0-9]{2}:[0-9]{2}$
examples:
- 23:59
TktTaxFull
Ticket coupon refund tax information
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| arr | optional | Arrival | string | ||
| code | required | Tax code | string | ||
| dep | optional | Departure | string | ||
| fareRate | optional | Fare rate | Rate | ||
| fareSum | required | Fare sum | Price | ||
| fops | optional | Forms of payment | array of FopInfo | ||
| moved | optional | Is moved | false | boolean | |
| otRate | optional | Reporting rate | Rate | ||
| otSum | optional | Reporting sum | Price | ||
| paySum | required | Pay sum | Price | ||
| place | required | Ticket tax place | TktTaxPlace | ||
| rate | required | Ticket tax rate type | TktTaxRateType | ||
| refund | optional | Is refund | false | boolean | |
| subcode | optional | Tax subcode | string | ||
| type | required | Ticket tax type | TktTaxType |
TktTaxPlace
Ticket tax place
JSON type: string
Enum of:
- TICK
- KVIT
- GRAND_TOTAL
- PENALTY
TktTaxRateType
Tax currency recalc type
JSON type: string
Enum of:
- DIRECT
- FARE
TktTaxShort
Ticket tax short
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| code | required | Code | string | ||
| moved | optional | Is moved | false | boolean | |
| place | required | Ticket tax place | TktTaxPlace | ||
| subcode | optional | Subcode | string | ||
| sum | required | Sum | Price | ||
| type | required | Ticket tax type | TktTaxType |
TktTaxType
Ticket tax type
JSON type: string
Enum of:
- COMPANY
- AGENCY
- PENALTY
- SURCHARGE
- XF
- OB
Version
Object version
JSON type: string
constraints:
- Length at least 15
- Length at most 15
Visa
Visa
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| airline | required | IATA airline designator | CompanyId | ||
| birthPlace | required | Place of birth | EncString | ||
| country | optional | Visa country | CountryId | ||
| issueDate | optional | Date of visa issue | Date | ||
| issuePlace | required | Place of visa issue | EncString | ||
| number | required | Visa number | VisaNumber | ||
| passNum | required | Passenger number | PassNum | ||
| segNum | optional | Segment number | SegNum | ||
| type | required | Type of visa | VisaType |
VisaNumber
Visa number
JSON type: string
constraints:
- Length at least 1
- Length at most 25
VisaType
Type of visa
JSON type: string
Enum of:
- V
Visa
- R
Redress number
- K
Known traveller number
VoidTimeLimits
Void time limits (UTC)
JSON type: object
| member | is optional | description | default | constraints | type |
|---|---|---|---|---|---|
| emds | optional | List of EMD void time limits | array of EmdVoidTml | ||
| tkts | optional | List of ticket void time limits | array of TicketVoidTml |
WhoMadeChanges
Who or what last changed this PNR
JSON type: string
Enum of:
- RI
- TLG
- SYSTEM
- USER