VeBox RestAPI Changelog

v7.00 - Stable

New features:

• Rank: location rank based on each location total sales in a given period for a specific component category (loc_sales/max_company_sales; -1 if no sale is present).
  1. Add a location rank sorting option: rank(UUID, start, end).
  2. You can filter the locations by rank
  3. If you sort by rank, the location total sales and its rank is returned along with location data
• New concept: Fields.

  You can restrict the returned data of a GET by specifying the header "Fields", i.e. a comma-separated list of the class fields to be returned (the core will be always returned). If this header is not present, the whole entity will be returned as usual. Currently available only for locations.

• Add INDEPENDENT company type (e8636a7f-de16-4289-b632-eb9c356b82f5): a hybrid between customer and technician
• Add delete location/guid/hierarchy/type in order to drop a specific hierarchy from a location; only available if you are either the owner or that hierarchy company
• POST support/recovery/account to recover user's credentials. It sends the username and an OTP to the given mail.

  Use support/recovery/password in order to set a new password with the given OTP. Cannot be accessed by authenticated users.

• POST /users: An authenticated user can create new users having specific roles in the company he is in;
• POST/PUT/DELETE /users/{guid}/roles: An authenticated user can change the roles of an user in the same company he is in;
• POST/DELETE /users/{guid}/ban: An authenticated user can enable/disable an user in the same company he is in;
• GET /users/{guid}/: Reads the target user's data. Requires MANAGE_USER permission.
• GET /users: Searches among the users in the same company with filters.
• POST /filters/users: Creates a reusable filter for user search (look at JSONUserFilter).
• v7 DELETE users/{guid}/credentials/password An authenticated user can force a password reset. Requires MANAGE_USER permission.
• v7 DELETE users/{guid} An authenticated user can delete permanently an user in the same company. Requires MANAGE_USER permission and you can't delete yourself.
• v7 GET users/current/roles/managed An authenticated user can see which roles/permissions are available in his own company. Requires MANAGE_USER permission.

Modified:

• Equipment filter: the fields 'code', 'exactMatch', 'searchDeviceCode' are deprecated in favor of SearchKey object: you can now search by 'code', 'manufacturer_code', 'name', 'installed device code' or 'installed device customer code', any combinations, either looking for partial or the whole key.
• 'privacyPolicyAccepted' is now deprecated in favor of 'termsOfServiceOk'; the new privacy policy can be confirmed with 'privacyPolicyOK'
• New state in JSONPlanogram: JSONDispenser.EditType.IN_EDITING
• The field JSONDiagnostic.orderValue is deprecated in favor of JSONType.orderValue
• The field JSONAggregation.value is deprecated in favor of JSONAggregation.data: the latter contains the whole diagnostic data referring to the specified aggregation.
• The location fields installedEquipment, equipmentWithDevice, activeAlarms are deprecated in favor of statistics obj.
• Added 2 new diagnostic aggregations: FIRST and LAST
• Add customerOriented field in JSONCompany
• It is not possible to change location category once it is set as "warehouse"
• Simplify user creation: allow the full user specification in a single call
• Add field incompleteData in user to mark users that still don't have the account completed
• Claim: technical device claim is now possible only if the location does not have a technician yet
• PUT users/current/credentials You can now change the user email.
• New sync process (v7) [EXPERIMENTAL, must be tested on iOS/Android]
  • POST users/current/sync now returns 202 in case of success; it has also a new location header which links to the GET request.
  • GET users/current/sync now returns 200 in case of waiting/failed; The response (SyncInfo) is now wrapped in a JSONStatus objects, which has info about the request status (OK, PENDING, KO). In case of success, the request returns 303 and it has a location header which links to the usual GET /media request.
• v7 JSONUserModel changed: roles and permissions field are deprecated in favor of rolesAndPermissions.

v6 - Deprecated

New features:

• GET devices/{guid}/configuration -> returns the current server/bluetooth configuration for the device
• GET devices/{guid}/configuration/backbone -> gives the sinottico along with its default ones
• PUT devices/{guid}/installations/current -> now supports only 1 installation per device, using the default configuration if needed
• GET devices/models/... -> returns the device models
• GET diagnostics/types/{guid}/tree -> returns the diagnostic type hierarchy having root from the given type

Modified:

• Diagnostic filter does not support anymore the fields "diagnosticTypeGuids" and "numberOfPixels"
• Removed deprecated fields "type" and "parentType" in company
• There is an hierarchy in the diagnostic types as well (max 2 levels deep); derived diagnostics inherit the type of their father through the field "sourceDiagnosticType". Base diagnostic will have this field set to null
• Diagnostic type now has supportHaccp property
• Device model now has configurable property
• Haccp configuration now depends on the diagnostic type too, and an equipment can define multiple haccp. The configuration was shifted from the equipment details to the diagnostic endpoints
• GET /devices and /devices/guid now return a list of deviceInstallations
• POST /devices/guid/installations/current has become a PUT; if the device is configurable, the default configuration will be applied. DuplicateAction won't be thrown anymore
• PUT /equipment/guid/installations/current has a new parameter, 'moveLinked'; if true, every equipment linked to this equipment's device will be moved as well

Fix:

• DELETE /devices/{guid}/installations/current/{installationGuid} /devices/{guid}/installations/current now works properly as intended. The date is now optional.