Overview over changes made to the Handyman API and Common API related to Handyman Office versions.
Detailed documentation is at:
| Common API | api.gsgroup.io |
| Handyman API |
Example: Dependent of Handyman API configuration in the Handyman ControlCenter |
Version 9.6.5
New features
Authorisation per endpoint
It is now possible to restrict access for each endpoint when using a token based authorisation. This will usually be of interest when you need to give partners/contractors access to your Handyman via API access in a special integration scenario. Please contact GSGoup for more information how to use this feature.
Support for both internal and external address for HM-API URL
Depending on infrastructure it may be necessary to have two URLs configured if server reports in Handyman Mobile cannot be reached with the current API URL. Configuration is done in Handyman ControlCenter. Please contact GSGroup if this is an issue.
ServiceBusSender
Handyman Office and Sync support posting messages to Azure Service bus to signal what orders or other entities needs to be exported from Handyman. This is used in API-based integrations to have a message based integration flow. More documentation will come later.
New APIs
| Endpoint | Purpose | Comment |
| weboffice/quotes |
|
|
| messagelogs | Insert messages to Handymans message log. |
Useful for logging exceptions from integrations so that it will be easier to troubleshoot. Also to be used for logging normal events related to import/export of data. See here for instructions on how to use |
Changes in existing APIs
| Endpoint | Change | Comment |
| all order endpoints with dates | DateTimeBehaviour paramteter is added to support writing and reading dates as UTC value |
Possible values:
|
|
SyncStatus field added |
0 = not sent to ERP For material and salary codes registrations, quantity should be <> 0 before sending to ERP.
When record is updated, it is automatically set to 2
See here for description of minimum records for updated SyncStatus. |
| orders | DoNotSetAsPassive is now handled as in the XML API. |
Set to "true" to avoid finished orders to på historical until ERP has completed the order. |
|
orders/salarycodes |
Removed requirement for mandatory fields
|
|
|
orders/material |
Removed requirement for mandatory fields
|
|
|
orders |
ExternaID will now not be overwritten if empty or not provided |
|
|
orders/document |
Metadata can now be changed without providing the document binary data |
|
|
orders |
Message field for orders is now supporting configuration per contract and concatenating with manual text:
|
|
|
Swagger update - "parameter." prefix removed from complex parameter objects |
||
|
|
Improved error feedback if post/get requests fail |
Versjon 9.6.4
Important fixes
| Endpoint | Fix | Comment |
| orders |
Location creates new address every time. BackofficeID or HsID had no effect. |
|
| settings |
Logo was not returned as image/binary |
Versjon 9.6.3
Important fixes
| Endpoint | Fix | Comment |
| orders |
InvoiceStatus was not updated |
|
| orders | EstimatedHours was mandatory field | Requirement removed |
| orders/material | locking rules was not correct | |
| orders | Location validation rules is too strict | Common API only. Used same rules as for customer addresses. Now less strict. |