POST api/BackOffice/HandleWorkFlowCreation

Receive an new order to create workflow

Request Information

URI Parameters

None.

Body Parameters

GenericWorkFlowRequest request object

GenericWorkFlowRequest
NameDescriptionTypeAdditional information
Details

GenericWorkFlowDetails

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: 
{
  "Details": {
    "ExternalPassangerRequest": {
      "Passangers": [
        {
          "ID": "sample string 1",
          "FIRST_NAME": "sample string 2",
          "LAST_NAME": "sample string 3",
          "DOB": {
            "DAY": 1,
            "MONTH": 2,
            "YEAR": 3
          },
          "ADDRESS": "sample string 4",
          "CITY": "sample string 5",
          "COUNTRY": "sample string 6",
          "ZIP": 7,
          "M_PHONE": "sample string 8",
          "EMAIL": "sample string 9",
          "GENDER": 0,
          "PTC": 0,
          "PASSPORT": {
            "PASSPORT_NO": "sample string 1",
            "CREAT_DATE": {
              "DAY": 1,
              "MONTH": 2,
              "YEAR": 3
            },
            "EXPIRATION_DATE": {
              "DAY": 1,
              "MONTH": 2,
              "YEAR": 3
            },
            "CONTRY_OF_BIRTH": "sample string 2"
          }
        },
        {
          "ID": "sample string 1",
          "FIRST_NAME": "sample string 2",
          "LAST_NAME": "sample string 3",
          "DOB": {
            "DAY": 1,
            "MONTH": 2,
            "YEAR": 3
          },
          "ADDRESS": "sample string 4",
          "CITY": "sample string 5",
          "COUNTRY": "sample string 6",
          "ZIP": 7,
          "M_PHONE": "sample string 8",
          "EMAIL": "sample string 9",
          "GENDER": 0,
          "PTC": 0,
          "PASSPORT": {
            "PASSPORT_NO": "sample string 1",
            "CREAT_DATE": {
              "DAY": 1,
              "MONTH": 2,
              "YEAR": 3
            },
            "EXPIRATION_DATE": {
              "DAY": 1,
              "MONTH": 2,
              "YEAR": 3
            },
            "CONTRY_OF_BIRTH": "sample string 2"
          }
        }
      ]
    },
    "Product": {
      "ProductId": "sample string 1",
      "Amount": 2.1,
      "Currency": "sample string 3",
      "FreeText": "sample string 4"
    },
    "TourCode": "sample string 1",
    "ReservationIdentifier": "sample string 2",
    "AutoCompleteStatus": 0,
    "AgentClockId": 3,
    "AccountCode": "sample string 4",
    "TripNumber": "sample string 5",
    "DataSource": "sample string 6",
    "AxCompany": "sample string 7"
  },
  "UserName": "sample string 1",
  "Salt": 2,
  "Digest": "sample string 3"
}

application/xml, text/xml

Sample: 
<GenericWorkFlowRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" UserName="sample string 1" Salt="2" Digest="sample string 3">
  <Details>
    <ReservationIdentifier>sample string 2</ReservationIdentifier>
    <AutoCompleteStatus>None</AutoCompleteStatus>
    <AgentClockId>3</AgentClockId>
    <AccountCode>sample string 4</AccountCode>
    <TripNumber>sample string 5</TripNumber>
    <DataSource>sample string 6</DataSource>
    <AxCompany>sample string 7</AxCompany>
    <ExternalPassangerRequest>
      <Passangers>
        <ExternalPassanger>
          <ID>sample string 1</ID>
          <FIRST_NAME>sample string 2</FIRST_NAME>
          <LAST_NAME>sample string 3</LAST_NAME>
          <DOB>
            <DAY>1</DAY>
            <MONTH>2</MONTH>
            <YEAR>3</YEAR>
          </DOB>
          <ADDRESS>sample string 4</ADDRESS>
          <CITY>sample string 5</CITY>
          <COUNTRY>sample string 6</COUNTRY>
          <ZIP>7</ZIP>
          <M_PHONE>sample string 8</M_PHONE>
          <EMAIL>sample string 9</EMAIL>
          <GENDER>M</GENDER>
          <PTC>NONE</PTC>
          <PASSPORT>
            <PASSPORT_NO>sample string 1</PASSPORT_NO>
            <CREAT_DATE>
              <DAY>1</DAY>
              <MONTH>2</MONTH>
              <YEAR>3</YEAR>
            </CREAT_DATE>
            <EXPIRATION_DATE>
              <DAY>1</DAY>
              <MONTH>2</MONTH>
              <YEAR>3</YEAR>
            </EXPIRATION_DATE>
            <CONTRY_OF_BIRTH>sample string 2</CONTRY_OF_BIRTH>
          </PASSPORT>
        </ExternalPassanger>
        <ExternalPassanger>
          <ID>sample string 1</ID>
          <FIRST_NAME>sample string 2</FIRST_NAME>
          <LAST_NAME>sample string 3</LAST_NAME>
          <DOB>
            <DAY>1</DAY>
            <MONTH>2</MONTH>
            <YEAR>3</YEAR>
          </DOB>
          <ADDRESS>sample string 4</ADDRESS>
          <CITY>sample string 5</CITY>
          <COUNTRY>sample string 6</COUNTRY>
          <ZIP>7</ZIP>
          <M_PHONE>sample string 8</M_PHONE>
          <EMAIL>sample string 9</EMAIL>
          <GENDER>M</GENDER>
          <PTC>NONE</PTC>
          <PASSPORT>
            <PASSPORT_NO>sample string 1</PASSPORT_NO>
            <CREAT_DATE>
              <DAY>1</DAY>
              <MONTH>2</MONTH>
              <YEAR>3</YEAR>
            </CREAT_DATE>
            <EXPIRATION_DATE>
              <DAY>1</DAY>
              <MONTH>2</MONTH>
              <YEAR>3</YEAR>
            </EXPIRATION_DATE>
            <CONTRY_OF_BIRTH>sample string 2</CONTRY_OF_BIRTH>
          </PASSPORT>
        </ExternalPassanger>
      </Passangers>
    </ExternalPassangerRequest>
    <Product>
      <ProductId>sample string 1</ProductId>
      <Amount>2.1</Amount>
      <Currency>sample string 3</Currency>
      <FreeText>sample string 4</FreeText>
    </Product>
    <TourCode>sample string 1</TourCode>
  </Details>
</GenericWorkFlowRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GenericWorkFlowResponse response object

GenericWorkFlowResponse
NameDescriptionTypeAdditional information
Result

The result of the operation

 WebOperationResult

None.

Response Formats

application/json, text/json

Sample: 
{
  "Result": {
    "Success": true,
    "Message": "sample string 2",
    "Extra1": "sample string 3",
    "Extra2": "sample string 4",
    "Extra3": "sample string 5"
  }
}

application/xml, text/xml

Sample: 
<GenericWorkFlowResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Result>
    <Success>true</Success>
    <Message>sample string 2</Message>
    <Extra1>sample string 3</Extra1>
    <Extra2>sample string 4</Extra2>
    <Extra3>sample string 5</Extra3>
  </Result>
</GenericWorkFlowResponse>