POST api/BackOffice/HandleTransportationRegistration

Receive a transportation reservation

Request Information

URI Parameters

None.

Body Parameters

Transportation reservation request object

TransportationReservationRequest
NameDescriptionTypeAdditional information
CurrencyCode

Currency code (USD/EUR/ILS/...)

 string

Required
UniqueClientId

the client id in the back office like PRVT

 string

Required
SupplierBackOfficeID

The supplier id in the back office

 string

Required
IsPrivate

if the user is a private user

 boolean

Required
ClientPrice

The amount paid by the client

 decimal number

Required
SupplierPrice

The amount to the supplier

 decimal number

Required
PricesIncludingVAT

Indicates if the prices includes VAT or not.

 boolean

Required
OrderId

The unique order ID in the requested reservation system(GTP/UBUS/...) The extra field for the digest

 string

Required
Routes

a collection of routes in the reservation

 Collection of Route

Required
UserClockId

The user identifer in the back office

 integer

Required
OrdererPaxId

The ID of the pax that create the reservation. The pax must be in the back office

 string

Required
UserName

The provided user name.

 string

Required
Salt

A random number(at least 9 digits)

 integer

Required
Digest

A digest of the user credentials and the request

 string

Required

Request Formats

application/json, text/json

Sample: 
{
  "CurrencyCode": "USD",
  "UniqueClientId": "PRVT",
  "SupplierBackOfficeID": "100105",
  "IsPrivate": true,
  "ClientPrice": 1000.0,
  "SupplierPrice": 900.0,
  "PricesIncludingVAT": true,
  "OrderId": "1234567",
  "Routes": [
    {
      "DepartureDateAndTime": "2025-04-26T00:03:30.47052+00:00",
      "Origin": "New Jersey EWR Airport",
      "Destination": "New York Police Station",
      "Distance": 55.8
    }
  ],
  "UserClockId": 5009,
  "OrdererPaxId": "AM5751958",
  "UserName": "AmsalemWebIL",
  "Salt": 962402951,
  "Digest": "BQK3a9W6k90CrHO6XD+PbtpIQpX52z5iHL77S0oWocdz4SJv9huLC8HOKeQuYgCuZn5rGQYw46/+Vnt+KpR1rQ=="
}

application/xml, text/xml

Sample: 
<TransportationReservationRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" UserName="AmsalemWebIL" Salt="962402951" Digest="BQK3a9W6k90CrHO6XD+PbtpIQpX52z5iHL77S0oWocdz4SJv9huLC8HOKeQuYgCuZn5rGQYw46/+Vnt+KpR1rQ==">
  <CurrencyCode>USD</CurrencyCode>
  <UniqueClientId>PRVT</UniqueClientId>
  <SupplierBackOfficeID>100105</SupplierBackOfficeID>
  <IsPrivate>true</IsPrivate>
  <ClientPrice>1000</ClientPrice>
  <SupplierPrice>900</SupplierPrice>
  <PricesIncludingVAT>true</PricesIncludingVAT>
  <OrderId>1234567</OrderId>
  <Routes>
    <Route>
      <DepartureDateAndTime>2025-04-26T00:03:30.47052+00:00</DepartureDateAndTime>
      <Origin>New Jersey EWR Airport</Origin>
      <Destination>New York Police Station</Destination>
      <Distance>55.8</Distance>
    </Route>
  </Routes>
  <UserClockId>5009</UserClockId>
  <OrdererPaxId>AM5751958</OrdererPaxId>
</TransportationReservationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Transportation reservation response object

TransportationReservationResponse
NameDescriptionTypeAdditional information
BackOfficeIdentifier

The back office product identifier (5-123124)

 string

None.
TripNumber

Backoffice trip number

 string

None.
Result

a base result object

 WebOperationResult

None.

Response Formats

application/json, text/json

Sample: 
{
  "BackOfficeIdentifier": "5-123456",
  "TripNumber": null,
  "Result": {
    "Success": true,
    "Message": "",
    "Extra1": null,
    "Extra2": null,
    "Extra3": null
  }
}

application/xml, text/xml

Sample: 
<TransportationReservationResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <BackOfficeIdentifier>5-123456</BackOfficeIdentifier>
  <Result>
    <Success>true</Success>
    <Message />
  </Result>
</TransportationReservationResponse>