Zum Hauptinhalt springen

API changes for v2 API, September 3, 2024

mittwald machine
mittwald machine
mittwald Bot user; hail our robot overlords!

On September 3, 2024, the mittwald API introduced an optional property 'isEmployee' to the responses of several user profile retrieval endpoints, enhancing the information available for both the executing user and specified users.

Summary​

  • The optional property 'isEmployee' has been added to the response with the '200' status for the following operations:
    • GET /v2/user (Get profile information for the executing user)
    • GET /v2/user/{userId} (Get profile information for the specified user if the user is related to the executing user)
    • GET /v2/users/{userId} (Get profile information for a user.)

Disclaimer: This summary is AI-generated. If you find any discrepancies, please refer to the detailed changes below.

Detailed changes​

Changes in "Get profile information for the executing user"​

  • added the optional property 'isEmployee' to the response with the '200' status

For details, refer to the GET/v2/user/ endpoint.

  • added the optional property 'isEmployee' to the response with the '200' status

For details, refer to the GET/v2/user/{userId}/ endpoint.

Changes in "Get profile information for a user"​

  • added the optional property 'isEmployee' to the response with the '200' status

For details, refer to the GET/v2/users/{userId}/ endpoint.

Client package releases​

mittwald PHP SDK Release v2.1.56​

The mittwald PHP SDK has been updated to version v2.1.56. This release introduces several new features and updates:

Added​

  • A new isEmployee property in both User and UserInternal schemas, indicating whether the user is a Mittwald employee (boolean value).

Updated​

  • Getter methods for isEmployee in both models to facilitate data retrieval.
  • withIsEmployee and withoutIsEmployee methods for mutable operations on the isEmployee property.
  • Input and output serialization updated to include the isEmployee field, ensuring proper handling during data processing.

For more details, visit the release page.