temando api r1 13 developers guide copy

Download Temando API r1 13 Developers Guide Copy

Post on 19-Oct-2015

93 views

Category:

Documents

4 download

Embed Size (px)

DESCRIPTION

Temando API manual

TRANSCRIPT

  • Temando Api Release 1.13

    Developer Documentation

    Temando IT Department

    1st Edition July 2009

  • Temando API R1.13 Temando

    July 2009 Page 1

    Contents

    1. INTRODUCTION ............................................................................................................................... 3 1.1. PURPOSE ........................................................................................................................................ 3 1.2. REVISION HISTORY ......................................................................................................................... 3 1.3. NAMESPACES ................................................................................................................................. 5 1.4. DOCUMENT CONVENTIONS ............................................................................................................ 6 1.5. TERMINOLOGY ............................................................................................................................... 6 1.6. REFERENCES .................................................................................................................................. 8

    2. API OVERVIEW ................................................................................................................................ 9 2.1. SOAP MESSAGES ......................................................................................................................... 10 2.2. USER AUTHENTICATION ............................................................................................................... 14 2.3. ERROR HANDLING ........................................................................................................................ 15 2.4. RESTRICTIONS AND LIMITATIONS ................................................................................................. 16

    2.4.1. Access Rights ....................................................................................................................... 16 2.4.2. General ................................................................................................................................ 16

    2.5. PROCESS GUIDE ........................................................................................................................... 17 2.5.1. Get Quotes and Make a Booking (Client User) ................................................................... 17 2.5.2. Retrieve and Book Requests (Carrier User) ........................................................................ 19 2.5.3. Retrieve/Register Client, Get Quotes and Make a Booking (Affiliate User) ........................ 20

    2.6. COMMON OPERATIONS ................................................................................................................. 24 2.6.1. getQuotesByRequest ............................................................................................................ 26 2.6.2. makeBookingByRequest ...................................................................................................... 31 2.6.3. getRequest ........................................................................................................................... 39 2.6.4. getRequestsRequiringBooking ............................................................................................. 45 2.6.5. addBookingDetails .............................................................................................................. 49 2.6.6. updateTrackingDetails ........................................................................................................ 52 2.6.7. createClient ......................................................................................................................... 54 2.6.8. updateClient ........................................................................................................................ 57 2.6.9. getClient .............................................................................................................................. 59 2.6.10. getManifest .......................................................................................................................... 62 2.6.11. confirmManifest ................................................................................................................... 70 2.6.12. cancelRequest ...................................................................................................................... 77 2.6.13. createLocation ..................................................................................................................... 79 2.6.14. updateLocation .................................................................................................................... 81 2.6.15. getLocations ........................................................................................................................ 83 2.6.16. updateRequest ..................................................................................................................... 86

    2.7. SOAP FAULTS .............................................................................................................................. 92 2.7.1. Err_Service01 ...................................................................................................................... 92 2.7.2. Err_Service02 ...................................................................................................................... 93 2.7.3. Err_Service03 ...................................................................................................................... 93 2.7.4. Err_Connection01 ............................................................................................................... 93 2.7.5. Err_Connection02 ............................................................................................................... 94 2.7.6. Err_Connection03 ............................................................................................................... 94 2.7.7. Err_Access01....................................................................................................................... 94 2.7.8. Err_Access02....................................................................................................................... 95 2.7.9. Err_Access03....................................................................................................................... 95 2.7.10. Err_Access04....................................................................................................................... 96 2.7.11. Err_Access05....................................................................................................................... 96 2.7.12. Err_Access06....................................................................................................................... 96 2.7.13. Err_Access07....................................................................................................................... 97 2.7.14. Err_Access08....................................................................................................................... 97 2.7.15. Err_Access09....................................................................................................................... 98 2.7.16. Err_Format ......................................................................................................................... 98

  • Temando API R1.13 Temando

    July 2009 Page 2

    2.7.17. Err_Payment01 ................................................................................................................. 101 2.7.18. Err_Payment02 ................................................................................................................. 101 2.7.19. Err_Payment03 ................................................................................................................. 102 2.7.20. Err_Payment04 ................................................................................................................. 102 2.7.21. Err_Permission01 ............................................................................................................. 102 2.7.22. Err_Permission02 ............................................................................................................. 103 2.7.23. Err_State01 ....................................................................................................................... 103 2.7.24. Err_State02 ....................................................................................................................... 104 2.7.25. Err_State03 ....................................................................................................................... 104 2.7.26. Err_State04 ....................................................................................................................... 104 2.7.27. Err_State05 ....................................................................................................................... 105 2.7.28. Err_State06 ....................................................................................................................... 105 2.7.29. Err_State07 ....................................................................................................................... 106 2.7.30. Err_State08 ....................................................................................................................... 106 2.7.31. Err_State09 ....................................................................................................................... 107 2.7.32. Err_State10 ....................................................................................................................... 107 2.7.33. Err_State11 ................