Skip to main content

SearchStakeHolderResponseBody

Response body for stakeholder search operations

errorstring

Error message (present only if there was an error)

Example: Your request could not be processed. Please try again later or contact support.
result object[]

Collection of stakeholders matching the search criteria

  • Array [
    • uidstring<uuid>required

    Unique identifier of the stakeholder

    Example: 123e4567-e89b-12d3-a456-426614174000
    typestringrequired

    Type of stakeholder (person or company)

    Example: person
    firstNamestring

    First name of the stakeholder (null for companies)

    Example: John
    lastNamestring

    Last name of the stakeholder (null for companies)

    Example: Doe
    namestringrequired

    Full name of the stakeholder (null for person, company name required)

    Example: Stonal
    sirenstring

    SIREN number of the companies (null for persons)

    Example: 123456789
    addressstring

    Address of the company

    postalCodestring

    Postal code of the company

    citystring

    City of the company

    externalCodestring

    External code of the company

    contactsDetails object[]required

    List of contact details of the stakeholder

  • Array [
    • phoneNumberstring

    Phone number of the contact

    Example: 0123456789
    additionalInfosstring

    Additional infos of the contact

    Example: Some additional infos
    emailstring

    Email address required for person and company

    Example: john.doe@example.com
  • ]
    • contracts object[]required

    Stakeholder contracts list

  • Array [
    • idstringrequired

    Id of the contract

    typestringrequired

    Type of the contract

    Example: LEASE
    codestringrequired

    Code of the contract

    labelstring

    Label of the contract

  • ]
    • isActivebooleanrequired

    Active status of the stakeholder

    faxstring

    Fax of the company

    functionstring

    Function of the person

  • ]
    • totalinteger<int64>

    Total number of stakeholders matching the search criteria

    Example: 42
    totalPagesinteger<int32>

    Total number of pages available

    Example: 5
    pageRequested object

    Information about the requested page

    pageinteger<int32>required

    Page number (zero-based)

    Example: 0
    sizeinteger<int32>required

    Number of items per page

    Example: 10
    sortstring

    Field used for sorting

    Example: name
    directionstring

    Sort direction (ASC or DESC)

    Example: ASC
    SearchStakeHolderResponseBody
    {
      "error": "Your request could not be processed. Please try again later or contact support.",
      "result": [
        {
          "uid": "123e4567-e89b-12d3-a456-426614174000",
          "type": "person",
          "firstName": "John",
          "lastName": "Doe",
          "name": "Stonal",
          "siren": 123456789,
          "address": "string",
          "postalCode": "string",
          "city": "string",
          "externalCode": "string",
          "contactsDetails": [
            {
              "phoneNumber": "0123456789",
              "additionalInfos": "Some additional infos",
              "email": "john.doe@example.com"
            }
          ],
          "contracts": [
            {
              "id": "string",
              "type": "LEASE",
              "code": "string",
              "label": "string"
            }
          ],
          "isActive": true,
          "fax": "string",
          "function": "string"
        }
      ],
      "total": 42,
      "totalPages": 5,
      "pageRequested": {
        "page": 0,
        "size": 10,
        "sort": "name",
        "direction": "ASC"
      }
    }