Search travel agents
|Purpose||Get a list of travel agents. Use if developing a solution to allow creation of bookings assigned to specific travel agents.|
|Notes||Allows searching by several criteria, returns basic information about the agent plus a booking_key that can be used when creating bookings.|
For use by tour operators only, not available for those accessing the API with Marketplace Agent credentials.
PHP examples use the PHP Client Library with SimpleXML
C# examples use the .Net Client Library
VB examples use the .Net Client Library
|order||Default order is by name, set to toprecent to order by number of recent bookings|
|agent_id||If you know the agent ID use this, returns a single record|
|agent_group||Load agents from a specific group. Exact match only|
|q||Search agent name/code, returns partial matches|
|filter||Set to staff_ui to limit results to those agents that have had bookings assigned to them by staff - useful if an account contains many agents with only a small subset that will be assigned bookings by staff|
|per_page||Number of results to return per page. Max is 500.|
|page||Integer for which page number to return. Default is page 1|
|request||Confirmation of the request that you sent|
|error||Any error message returned, if there is no error this will just contain the text OK|
|total_agent_count||Total number of agents returned by the search (i.e. not just the number on this page)|
There will be one agent node for each result on this page.
Each agent node contains the following child nodes.