The following release notes contain information about significant changes and enhancements introduced to the AMPAREX practice management software.
1. API adjustments in detail
The individual API changes are described in detail here. Eine komplette Beschreibung der API ist hier zu finden.
2. Api Change Log
2.1. What's New
- POST/alias/{alias}/protected/articles/detailedsearch Get a list of detailed articles
- POST/alias/{alias}/protected/cashdeskbalances/search Get a list of cashdeskbalances
- GET/alias/{alias}/protected/cashdeskbalances/{id} Get one specific cashdeskbalance by id
- POST/alias/{alias}/protected/customers/{id}/documents Create a new document for customer archive
- GET/alias/{alias}/protected/customers/{id}/marketingcontacts Get marketingcontacts for specific customer
- GET/alias/{alias}/protected/deliveries/orderbyfields Get possible fields for orderby of delivery fields
- POST/alias/{alias}/protected/deliveries/search Get a list of deliveries
- GET/alias/{alias}/protected/deliveries/{id} Get one specific delivery by id
- POST/alias/{alias}/protected/documnettemplates/search Get a list of document templates
- GET/alias/{alias}/protected/mainversions/orderbyfields Get possible fields for orderby of mainversion fields
- POST/alias/{alias}/protected/mainversions/search Get a list of mainversions
- GET/alias/{alias}/protected/mainversions/{id} Get one specific mainversion by id
- GET/alias/{alias}/protected/marketingcontacts/orderbyfields Get possible fields for orderby of marketingcontact fields
- POST/alias/{alias}/protected/marketingcontacts/search Get a list of marketingcontacts
- GET/alias/{alias}/protected/marketingcontacts/{id} Get one specific marketingcontact by id
- GET/alias/{alias}/protected/servicecontracts/orderbyfields Get possible fields for orderby of servicecontract fields
- POST/alias/{alias}/protected/servicecontracts/search Get a list of servicecontracts
- GET/alias/{alias}/protected/servicecontracts/{id} Get one specific servicecontract by id
- POST/alias/{alias}/protected/treatments/search Get a list of treatments
- POST/alias/{alias}/protected/treatments/{id}/documents/search Get a list of treatment documents (without binary)
- GET/alias/{alias}/protected/treatments/{id}/documents/{did}/binary Get document of treatment as blob
- GET/alias/{alias}/protected/treatments/{id}/invoices Get all documents of all types for one specific treatment
- POST/alias/{alias}/protected/versions Create a version
- GET/alias/{alias}/protected/versions/LTS/latest Get latest LTS-Version
- GET/alias/{alias}/protected/versions/LTS/latest/stable Get latest stable LTS-Version
- GET/alias/{alias}/protected/versions/STS/latest Get latest STS-Version
- GET/alias/{alias}/protected/versions/STS/latest/stable Get latest stable STS-Version
- GET/alias/{alias}/protected/versions/orderbyfields Get possible fields for orderby of version fields
- POST/alias/{alias}/protected/versions/search Get a list of versions
- GET/alias/{alias}/protected/versions/{id} Get one specific version by id
- PATCH/alias/{alias}/protected/versions/{id} Update a version
- GET/alias/{alias}/protected/versions/{mainVersion}/latest Get latest version for given main version
- GET/alias/{alias}/protected/versions/{mainVersion}/latest/stable Get latest stable version for given main version
- PATCH/alias/{alias}/protected/customers/{cid}/documents/{did} Update document with given id
2.2. What's Deleted
2.3. What's Deprecated
2.4. What's Changed
- POST/alias/{alias}/login
2.4.1. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/addresses
2.4.2. Request
- Changed body: 'application/json'
2.4.3. Schema
2.4.4. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/addresses/search
2.4.5. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- PATCH/alias/{alias}/protected/addresses/{id}
2.4.6. Request
- Changed body: 'application/json'
2.4.7. Schema
2.4.8. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/appointmentplanner/booking
2.4.9. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/appointmentplanner/freebusy
2.4.10. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/appointmentplanner/synchronize
2.4.11. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/appointments
2.4.12. Request
- Changed body: 'application/json'
2.4.13. Schema
2.4.14. Response
- New response : [409]//Conflict - the slot for the appointment is overbooked
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/appointments/search
2.4.15. Request
- Changed body: 'application/json'
2.4.16. Schema
2.4.17. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.18. Schema
- GET/alias/{alias}/protected/appointments/{id}
2.4.19. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.20. Schema
- Changed response : [200]//OK
- PATCH/alias/{alias}/protected/appointments/{id}
2.4.21. Request
- Changed body: 'application/json'
2.4.22. Schema
2.4.23. Response
- New response : [409]//Conflict - the slot for the appointment is overbooked
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/appointmenttemplates/search
2.4.24. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/articleitems/search
2.4.25. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/articleitems/stockamounts
2.4.26. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/articles/salesprices/search
2.4.27. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/articles/search
2.4.28. Request
- Changed body: 'application/json'
2.4.29. Schema
2.4.30. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.31. Schema
- GET/alias/{alias}/protected/articles/{id}
2.4.32. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.33. Schema
- Changed response : [200]//OK
- POST/alias/{alias}/protected/audiograms/search
2.4.34. Request
- Changed body: 'application/json'
2.4.35. Schema
2.4.36. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.37. Schema
- GET/alias/{alias}/protected/audiograms/{id}
2.4.38. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.39. Schema
- Changed response : [200]//OK
- POST/alias/{alias}/protected/availabilities
2.4.40. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/availabilities/search
2.4.41. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.42. Schema
- GET/alias/{alias}/protected/availabilities/{id}
2.4.43. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.44. Schema
- Changed response : [200]//OK
- PATCH/alias/{alias}/protected/availabilities/{id}
2.4.45. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/axlogin
2.4.46. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/branches/search
2.4.47. Request
- Changed body: 'application/json'
2.4.48. Schema
2.4.49. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.50. Schema
- GET/alias/{alias}/protected/branches/{id}
2.4.51. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.52. Schema
- Changed response : [200]//OK
- POST/alias/{alias}/protected/brands/search
2.4.53. Request
- Changed body: 'application/json'
2.4.54. Schema
2.4.55. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.56. Schema
- GET/alias/{alias}/protected/brands/{id}
2.4.57. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.58. Schema
- Changed response : [200]//OK
- POST/alias/{alias}/protected/changeUser
2.4.59. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/colors/search
2.4.60. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/comments
2.4.61. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/comments/search
2.4.62. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.63. Schema
- GET/alias/{alias}/protected/comments/{id}
2.4.64. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.65. Schema
- Changed response : [200]//OK
- PATCH/alias/{alias}/protected/comments/{id}
2.4.66. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/companies/search
2.4.67. Request
- Changed body: 'application/json'
2.4.68. Schema
2.4.69. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.70. Schema
- GET/alias/{alias}/protected/companies/{id}
2.4.71. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.72. Schema
- Changed response : [200]//OK
- POST/alias/{alias}/protected/contactlenses
2.4.73. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/contactlenses/search
2.4.74. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.75. Schema
- GET/alias/{alias}/protected/contactlenses/{id}
2.4.76. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.77. Schema
- Changed response : [200]//OK
- POST/alias/{alias}/protected/customers
2.4.78. Request
- Changed body: 'application/json'
2.4.79. Schema
2.4.80. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/customers/search
2.4.81. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.82. Schema
- GET/alias/{alias}/protected/customers/{cid}/documents/{did}
2.4.83. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.84. Schema
- Changed response : [200]//OK
- GET/alias/{alias}/protected/customers/{id}
2.4.85. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.86. Schema
- Changed response : [200]//OK
- PATCH/alias/{alias}/protected/customers/{id}
2.4.87. Request
- Changed body: 'application/json'
2.4.88. Schema
2.4.89. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/customers/{id}/documents/search
2.4.90. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.91. Schema
- POST/alias/{alias}/protected/doctors/search
2.4.92. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.93. Schema
- GET/alias/{alias}/protected/doctors/{id}
2.4.94. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.95. Schema
- Changed response : [200]//OK
- POST/alias/{alias}/protected/glasses/search
2.4.96. Request
- Changed body: 'application/json'
2.4.97. Schema
2.4.98. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.99. Schema
- GET/alias/{alias}/protected/glasses/{id}
2.4.100. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.101. Schema
- Changed response : [200]//OK
- POST/alias/{alias}/protected/healthinsurance/search
2.4.102. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/hearingcares/search
2.4.103. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/invoice/search
2.4.104. Request
- Changed body: 'application/json'
2.4.105. Schema
2.4.106. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.107. Schema
- GET/alias/{alias}/protected/invoice/{id}
2.4.108. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.109. Schema
- Changed response : [200]//OK
- POST/alias/{alias}/protected/lenseoptions/search
2.4.110. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/lensetypes/search
2.4.111. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/logout
2.4.112. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/marketingactions/search
2.4.113. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.114. Schema
- GET/alias/{alias}/protected/marketingactions/{id}
2.4.115. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.116. Schema
- Changed response : [200]//OK
- POST/alias/{alias}/protected/marketingcampaigns/search
2.4.117. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.118. Schema
- GET/alias/{alias}/protected/marketingcampaigns/{id}
2.4.119. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.120. Schema
- Changed response : [200]//OK
- POST/alias/{alias}/protected/orders/search
2.4.121. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/principals
2.4.122. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/principals/search
2.4.123. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- PATCH/alias/{alias}/protected/principals/{id}
2.4.124. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/programmoves/search
2.4.125. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/properties/articletypes/search
2.4.126. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/properties/predefinedproperties/search
2.4.127. Request
- Changed body: 'application/json'
2.4.128. Schema
2.4.129. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.130. Schema
- GET/alias/{alias}/protected/properties/predefinedproperties/{id}
2.4.131. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.132. Schema
- Changed response : [200]//OK
- POST/alias/{alias}/protected/properties/propertytypes/search
2.4.133. Request
- Changed body: 'application/json'
2.4.134. Schema
2.4.135. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.136. Schema
- GET/alias/{alias}/protected/properties/propertytypes/{id}
2.4.137. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.138. Schema
- Changed response : [200]//OK
- POST/alias/{alias}/protected/resources
2.4.139. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/resources/search
2.4.140. Request
- Changed body: 'application/json'
2.4.141. Schema
2.4.142. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.143. Schema
- GET/alias/{alias}/protected/resources/{id}
2.4.144. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.145. Schema
- Changed response : [200]//OK
- PATCH/alias/{alias}/protected/resources/{id}
2.4.146. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/servers/search
2.4.147. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/staffs
2.4.148. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/staffs/search
2.4.149. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- PATCH/alias/{alias}/protected/staffs/{id}
2.4.150. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/treatments/salesorder
2.4.151. Request
- Changed body: 'application/json'
2.4.152. Schema
2.4.153. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- GET/alias/{alias}/protected/treatments/therapeutics/{id}
2.4.154. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.155. Schema
- Changed response : [200]//OK
- GET/alias/{alias}/protected/treatments/{id}
2.4.156. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.157. Schema
- Changed response : [200]//OK
- GET/alias/{alias}/protected/treatments/{id}/doctors
2.4.158. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.159. Schema
- Changed response : [200]//OK
- POST/alias/{alias}/protected/views
2.4.160. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- POST/alias/{alias}/protected/views/search
2.4.161. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.162. Schema
- GET/alias/{alias}/protected/views/{id}
2.4.163. Response
- Changed response : [200]//OK
- Changed body: 'application/json'
2.4.164. Schema
- Changed response : [200]//OK
- PATCH/alias/{alias}/protected/views/{id}
2.4.165. Response
- New response : [422]//Unprocessable Entity - The given entity is not valid for that request