User Tools

Site Tools


ors-soap-api:public:json_api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
ors-soap-api:public:json_api [2017/12/13 15:52]
admin [Requests]
ors-soap-api:public:json_api [2023/03/08 12:42] (current)
admin
Line 7: Line 7:
 ===== PHP Example ===== ===== PHP Example =====
  
-<code json> 
 # JSON search region request example # JSON search region request example
 +
 +<code json>
 { {
   "​requestType":"​search",​   "​requestType":"​search",​
Line 28: Line 29:
     "​pass":"​[password]",​     "​pass":"​[password]",​
     "​agid":"​[agency-id]"​     "​agid":"​[agency-id]"​
 +    "​api-key":"​[your-api-key]"​
   }   }
 } }
Line 62: Line 64:
 ^ Name ^ Description ^ Example ^ ^ Name ^ Description ^ Example ^
 | requestType | a type of request | search | | requestType | a type of request | search |
-| action | which action to take | regions |+| action | which action to take (same name as SOAP methods) ​| regions |
 | search | search parameters | "​epc":"​2",​ "​typ":"​hotel",​ ...| | search | search parameters | "​epc":"​2",​ "​typ":"​hotel",​ ...|
 | header | [[soap_header]] | check example below | | header | [[soap_header]] | check example below |
Line 68: Line 70:
  
  
-There are 4 types of **requestType**available:+There are 4 types of **requestType** available:
  
   * search : for searching regions, offers and trips   * search : for searching regions, offers and trips
Line 75: Line 77:
   * book   : to create registrations,​ booking, cancellations   * book   : to create registrations,​ booking, cancellations
  
-Each request must also have an ''​action''​ which is named the same as SOAP api call methods. +So fo example if you wish to search for hotels in a selected region, you create request like so:
- +
-So fo example if you wich to search for hotels in a selected region, you create request like so:+
  
 <code json> <code json>
Line 96: Line 96:
     "​pass":"​[password]",​     "​pass":"​[password]",​
     "​agid":"​[agency-id]"​     "​agid":"​[agency-id]"​
 +    "​api-key":"​[your-api-key]"​
   }   }
 } }
Line 107: Line 108:
   "​errorNr":​2001,​   "​errorNr":​2001,​
   "​error":​{"​msg":"​Invalid (or missing) action"​}   "​error":​{"​msg":"​Invalid (or missing) action"​}
 +  "​rqid"​ : "​request-id"​
 } }
 </​code>​ </​code>​
  
 On **success** you will get a JSON string which is the same structure as you would get with SOAP requests. Please check [[soap_calls]] for details. On **success** you will get a JSON string which is the same structure as you would get with SOAP requests. Please check [[soap_calls]] for details.
ors-soap-api/public/json_api.1513176721.txt.gz · Last modified: 2017/12/13 15:52 by admin