Book Info method [ORS Documentation]

ors-soap-api:public:book_info

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

====== Book Info method ======

Returns booking information and current status.

===== Valid content types =====

  * ''pauschal''
  * ''hotel''
  * ''trips''
  * ''charter''
  * ''oneway''
  * ''extras''

===== Description =====

<code php>
public array book_info( array $searchData, array $headerData )
</code>

===== Parameters =====

  * ''searchData (array)'' : Required parameters: ''toc'', ''prc''
  * ''headerData (array)'' : [[soap_header|SOAP Header Information]]

===== Return values =====

Returns booking information and status.

<code>
Array
(
    [offerTripInfo] => 

    [response] => Array
        (
            [mid] => 205
            [ttp] => 219
            [bfee] => 10.7
            [paid] => 229.7
            [txt] => Status ok
            [status] => 3
        )

    [offer] => Array
        (
            [typ] => hotel
            [toc] => CMT
            [ton] => CMT d.o.o.
            [tocp] => 
            [htc] => SPU9904593
            [gid] => 2221635950235
            [hon] => Sveti Duh
            [oid] => 
            [desc] => 
            [zac] => CP
            [zan] => 
            [vpc] => OV
            [vpn] => 
            [svc] => 
            [stc] => 1
            [htn] => Camping + Festival Ticket
            [zhc] => 
            [zhn] => 
            [ahc] => 
            [ahn] => 
            [vnd] => 2014-08-17
            [bsd] => 2014-08-22
            [tdc] => 5
            [sub] => 
            [sid] => 
            [sin] => 
            [idp] => [IDP]
            [ovr] => 0
            [pic] => http://www.ors.si/giata-pics/2221635950235/full.jpg
        )

    [actions] => Array
        (
            [0] => Array
                (
                    [attributes] => Array
                        (
                            [ida] => 599
                            [idh] => 990
                        )

                    [discounts_per_pax] => Array
                        (
                            [0] => Array
                                (
                                    [pax] => Array
                                        (
                                            [0] => Array
                                                (
                                                    [attributes] => Array
                                                        (
                                                            [id] => 1
                                                        )

                                                    [discount] => Array
                                                        (
                                                            [0] => Array
                                                                (
                                                                    [attributes] => Array
                                                                        (
                                                                            [id] => 241721
                                                                            [disc_type] => tax
                                                                            [description] => TuristiÄna taksa plaÄana v agenciji
                                                                            [Discount] => 1
                                                                            [DiscountPercent] => 0
                                                                        )

                                                                )

                                                        )

                                                )

                                        )

                                )

                        )

                )

        )

    [operator] => Array
        (
            [act] => D
            [toc] => CMT
            [prc] => 1130312
            [bkc] => 20140814164649977
            [hsc] => 
            [agt] => 390733
        )

    [customer] => Array
        (
            [sur] => BENOIT
            [pre] => GINER
        )

    [services] => Array
        (
            [0] => Array
                (
                    [id] => 1
                    [typ] => H
                    [cod] => SPU9904593
                    [opt] => 2672,OV
                    [vnd] => 17082014
                    [bsd] => 22082014
                    [agn] => 1
                    [sst] => OK
                    [spc] => 219
                )

            [1] => Array
                (
                    [id] => 2
                    [typ] => EX
                    [cod] => 200491:4593
                    [opt] => 0,
                    [vnd] => 17082014
                    [bsd] => 17082014
                    [agn] => 1
                    [sst] => OK
                )

        )

    [travellers] => Array
        (
            [0] => Array
                (
                    [id] => 382311
                    [typ] => H
                    [sur] => BENOIT
                    [pre] => GINER
                    [age] => 
                    [tvp] => 219
                    [str] => 
                    [cty] => 
                    [zip] => 
                    [eml] => 
                    [tel] => 
                    [personalID] => 
                    [country] => 
                    [vatnr] => 
                    [promo] => 
                )

        )

    [info] => Array
        (
            [0] => Camping + Festival Ticket
            [1] => Category: *
            [2] => Product code: SPU9904593
            [3] => City: Sveti Duh
            [4] => CP, camping, dish washing, common shower, common toilet
            [5] => 5 X only rent (OV)
            [6] => 17.08.2014 - 22.08.2014
            [15] => --------------------------------------------------------------
            [16] => CRS powered by ORS XTREME
        )

    [exInfo] => Array
        (
            [0] => Array
                (
                    [txt] =>  - Tourist tax is paid at agency
                    [typ] => rmk
                )

        )

    [errorNr] => 
    [error] => 
    [xmlRes] => 
    [xmlReq] => 
)
</code>

===== Return parameters =====


  * ''offerTripInfo (array)'' : empty array
  * ''response (array)'' : booking status, message and a total price
    * ''mid'' : booking message ID (check [[Message IDs]] for a list of possible values)
    * ''txt'' : booking text message (message is in selected language and it depends on ''mid'' value)
    * ''status'' : booking status 
      * **1** : booking is ok
      * **3** : communication error (something went wrong with communication between ORS and touroperator).
    * ''ttp'' : total price for all passengers
    * ''bfee'' : booking fee
    * ''paid'' : already paid
  * ''offer (array)'' : offer info (when checking booking with more then one service booked then this array will contain only a general service information)
  * ''actions (array)'' : discounts / surcharges used with this booking
  * ''operator (array)'' : used action, touroperator info and booking number
    * ''act'' : action
    * ''toc'' : touroperator code
    * ''agt'' : agency number
    * ''prc'' : booking number
    * ''bkc'' : ORS internal booking number
  * ''customer (array)'' : customer info (to whom the reservation is made)
    * ''sur'' : last name
    * ''pre'' : first name
    * ''eml'' : email address
    * ''str'' : street
    * ''zip'' : zip code
    * ''cty'' : city
    * ''tel'' : telephone
    * ''mob'' : mobile
    * ''fax'' : fax number
  * ''services (array)'' : booked services
    * ''id'' : service sequence number
    * ''typ'' : service type
      * **H** : accommodation
      * **F** : flight
      * **EX** : extras
      * **T** : trip (round trip)
    * ''cod'' : product code
    * ''opt'' : service code
    * ''vnd'' : start date
    * ''bsd'' : end date
    * ''agn'' : a list of persons for this service (comma separated person IDs)
    * ''sst'' : service status
      * **OK** : service is booked
      * **XX** : service is cancelled
      * **OP** : service is in option state (waiting for timeout)
      * **RQ** : service is on request (waiting for a confirmation)
  * ''travellers (array)'' : passengers info
    * ''id'' : passenger sequence number
    * ''typ'' : passenger sex / type. Possible values: 
      * **H** : mr.
      * **D** : mrs.
      * **K** : child
      * **B** : baby (infant)
    * ''sur'' : last name
    * ''pre'' : first name
    * ''age'' : age / birthday
    * ''tvp'' : price for this person
    * ''str'' : street
    * ''cty'' : city
    * ''zip'' : zip code
    * ''eml'' : email
    * ''tel'' : telephone
    * ''personalID'' : personal ID number
    * ''country'' : ISO country code
  * ''info'' : touroperator information text. This text is directly from selectged touroperator and can be in different language. Usually this text contains important information about checked offer.
  * ''exInfo'' : extended touroperator information text
    * ''txt'' : text
    * ''typ'' : text type (rmk - remark), 
  * ''errorNr'' : error number
  * ''error'' : error message

===== Examples =====

  * Example of booking info request

<code php>
$searchParams = array(
  'toc' => 'ABC',                    // touroperator code
  'prc' => '1130312',                // booking number
);

// booking info
$info = $soapClient->orsxml_hotel_api_call( 'book_info', $searchParams, $headerData );
</code>

ors-soap-api/public/book_info.txt · Last modified: 2019/09/25 10:21 by admin