Users

Get Producers

Changed on

Retrieves users matching the given query parameters.

get/api/user/v1/producers

Request

  • The document declares no server URL.
  • Auth
    OpenID Connect (http://localhost:6999/realms/agate/.well-known/openid-configuration, scopes: agridata.ch.Agridata_Support)

Query parameters

filterobject

Column filters in the form '<column>:<value>[,<value>]', multiple filters separated by ';'. Values of the same column are combined with OR, filters on different columns with AND. Duplicate values are ignored. The filterable columns are documented per endpoint.

languagestring

language code for multilingual fields. Must be supported by application.

pageinteger

page number

searchTermstring

string to search for in the resource

sizeinteger

page size

sortByobject

List of field names to sort by. Default is ascending prefix with - for descending

Response

OK

totalItemsinteger required

Total number of items across all pages.

totalPagesinteger required

Total number of pages available.

currentPageinteger required

Current page number (0-based ).

pageSizeinteger required

Number of items per page.

Example response

{
  "items": [
    {
      "agateLoginId": "1234567",
      "ktIdP": "ZH123456",
      "uid": "CHE123456789",
      "givenName": "Anna",
      "familyName": "Muster",
      "email": "anna.muster@example.com",
      "phoneNumber": "+41331234567",
      "mobileNumber": "+41791234567",
      "addressStreet": "Bahnhofstrasse 10",
      "addressLocality": "Zürich",
      "addressPostalCode": "8001",
      "addressCountry": "CH",
      "lastLoginDate": "2022-03-10T12:15:50",
      "userPreferences": {
        "mainMenuOpened": true,
        "activeUid": "CHE123456789",
        "dismissedMigratedIds": [
          "a5b1d2e3-4f6a-2b7c-6d0e-9f1a3b5c7d9e"
        ],
        "hasSeenConsentRequestTourIntro": true
      },
      "lastAcceptedAgbDate": "2022-03-10T12:15:50",
      "enforceAgbAcceptanceFrom": "2022-03-10T12:15:50"
    }
  ],
  "totalItems": 42,
  "totalPages": 5,
  "currentPage": 1,
  "pageSize": 10
}

Changes

  • 75957f6bdc66Revision changes
    • warning

      added the new EXPORT_CAPACITY_EXHAUSTED enum value to the response property for the response status

    • warning

      added the new EXPORT_CAPACITY_EXHAUSTED enum value to the response property for the response status

    • warning

      added the new EXPORT_LIMIT_EXCEEDED enum value to the response property for the response status

    • warning

      added the new EXPORT_LIMIT_EXCEEDED enum value to the response property for the response status

  • 1aa7b6ad5bccRevision changes
    • warning

      added the new UID_CLAIM_MISSING enum value to the response property for the response status

    • warning

      added the new UID_CLAIM_MISSING enum value to the response property for the response status