Partner Web Services Placeorder V2 Service Manual

Partner Web Services PlaceOrder v2 Service Manual Version 2.0.54 Contents 1 Introduction .................................................................................................................................... 10 1.1 Overview .................................................................................................................................. 10 1.2 Supporting Resources .......................................................................................................... 10 2 Service Overview ............................................................................................................................. 11 2.1 Subscription to Autodesk ..................................................................................................... 11 2.1.1 Renewable Order Model ................................................................................................ 11 2.1.2 Maintenance to Subscription (M2S) ........................................................................... 12 2.1.3 Positive Extension End-Date ....................................................................................... 12 2.1.4 Multi-User trade in ........................................................................................................ 13 2.1.5 Deal Discount Approval ................................................................................................ 14 2.1.6 Premium Initial Orders .................................................................................................. 15 2.1.7 Premium Renewals and True-up ................................................................................. 15 2.1.8 Cloud Credits purchase ................................................................................................. 16 2.1.9 NFR (Not for Resale) purchase ................................................................................... 16 3 Service Endpoints ........................................................................................................................... 17 4 Pilot Run and Go Live .................................................................................................................... 18 5 Request/Response Schema ......................................................................................................... 19 5.1 Request .................................................................................................................................... 19 5.1.1 High-Level Entity Relationship model ...................................................................... 19 5.1.2 Low-Level Entity Relationship model ....................................................................... 20 5.1.3 Detailed Request JSON Structure ............................................................................... 21 5.2 Response .................................................................................................................................. 37 5.2.1 High-Level Entity Relationship model ...................................................................... 37 5.2.2 Detailed Response JSON Structure ........................................................................... 38 6 Sample Requests/Responses ...................................................................................................... 39 AUTODESK PlaceOrder v2 Service Reference Manual 2 6.1 Initial Order ............................................................................................................................. 39 6.2 Additions – Add seats ........................................................................................................... 41 6.3 Additions – Add products .................................................................................................... 42 6.4 Renewals .................................................................................................................................. 44 6.5 Premium Renewals and True-ups ...................................................................................... 45 6.6 Positive extension ................................................................................................................. 47 6.7 Maintenance-to-Subscription switch ............................................................................... 48 6.8 Multi-User trade in ................................................................................................................ 50 7 Formatting standards ................................................................................................................... 53 8 Error Messages ............................................................................................................................... 53 8.1 System Error codes ............................................................................................................... 53 8.2 Service Error Codes ............................................................................................................... 54 8.3 Asynchronous Error Codes .................................................................................................. 61 Appendix A: Pro-Rating logic .............................................................................................................. 61 Appendix B: Contract Extension policies (DRAFT) ......................................................................... 61 Appendix C: Multi-user Trade-in ........................................................................................................ 62 Timelines .............................................................................................................................................. 62 Transition ............................................................................................................................................. 62 Multi-user trade-in eligibility ......................................................................................................... 64 Products not eligible for the multi-user trade-in offer ............................................................ 64 Appendix D: Premium Renewals and True-up use cases ............................................................. 65 True-up scenario with one Primary Admin and one Team: ...................................................... 65 True-up scenario with one Primary Admin and multiple Teams ............................................ 66 True-up scenario with multiple Primary Admins ....................................................................... 67 True-up scenario with multiple True-ups corresponding to multiple Primary Admins ... 69 True-down scenario with one Primary Admin and one Team: ................................................. 71 AUTODESK PlaceOrder v2 Service Reference Manual 3 Tables Table 1: Contract extension example ................................................................................................ 13 Table 2: Service endpoints .................................................................................................................... 17 Table 3: Detailed JSON Request Structure for Initial Orders (Renewal) ................................. 23 Table 4: Detailed JSON Request Structure for Additions to existing Orders (Renewal) ..... 26 Table 5: Detailed JSON Request Structure for Renew Orders .................................................... 29 Table 6: Detailed JSON Request Structure for M2S Orders ......................................................... 31 Table 7: Detailed JSON Request Structure for Multi-User Trade-in Orders ............................ 34 Table 8: Account JSON Model ............................................................................................................. 35 Table 9: Contact JSON Model .............................................................................................................. 36 Table 10: Detailed JSON Response Structure ................................................................................. 38 Table 11: Authentication Error Codes ................................................................................................ 54 Table 12: Application Error Codes ....................................................................................................... 60 Table 13: Pro-Rating Logic ................................................................................................................... 61 Figures Figure 1: Contract extension example ............................................................................................... 13 Figure 2: Request High-Level JSON Schema Model ...................................................................... 19 Figure 3: Request Low-Level Entity Model ...................................................................................... 20 Figure 4: Response High-Level JSON Schema Model ................................................................... 37 Figure 5: before & after the Multi-user Trade-in ........................................................................... 63 Figure 6: Trade-in calendar ................................................................................................................. 63 AUTODESK PlaceOrder v2 Service Reference Manual 4 Revision History Version Date Author Comments 2.0.0 Jan 17, 2017 Abdullah Sahin • Initial version of PlaceOrder API v2 2.0.1 Mar 16, 2017 Jordi Gilabert • Updated the Low-Level entity relationship Model in 5.1.2

Load more