Skip to main content

SearchStakeHolderResponseBody

Response body for stakeholder search operations

errorstring

Error message (present only if there was an error)

Default value: ##default
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>

    Unique identifier of the stakeholder

    Default value: ##default
    Example: 123e4567-e89b-12d3-a456-426614174000
    typestring

    Type of stakeholder (person or company)

    Default value: ##default
    Example: person
    firstNamestring

    First name of the stakeholder (null for companies)

    Default value: ##default
    Example: John
    lastNamestring

    Last name of the stakeholder (null for companies)

    Default value: ##default
    Example: Doe
    namestring

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

    Default value: ##default
    Example: Stonal
    sirenstring

    SIREN number of the companies (null for persons)

    Default value: ##default
    Example: 123456789
    addressstring

    Address of the company

    Default value: ##default
    postalCodestring

    Postal code of the company

    Default value: ##default
    citystring

    City of the company

    Default value: ##default
    externalCodestring

    External code of the company

    Default value: ##default
    contactsDetails object[]

    List of contact details of the stakeholder

  • Array [
    • phoneNumberstring

    Phone number of the contact

    Default value: ##default
    Example: 0123456789
    additionalInfosstring

    Additional infos of the contact

    Default value: ##default
    Example: Some additional infos
    emailstring

    Email address required for person and company

    Default value: ##default
    Example: john.doe@example.com
    creationDatestring

    Date of creation of the contact

    Default value: ##default
    Example: 2020-01-01
  • ]
    • contracts object[]

    Stakeholder contracts list

  • Array [
    • idstring

    Id of the contract

    Default value: ##default
    typestring

    Type of the contract

    Default value: ##default
    Example: LEASE
    codestring

    Code of the contract

    Default value: ##default
    labelstring

    Label of the contract

    Default value: ##default
    assetUidsstring[]

    Asset stonal ids linked of the contract

    Default value: ##default
  • ]
    • isActiveboolean

    Active status of the stakeholder

    Default value: false
    faxstring

    Fax of the company

    Default value: ##default
    functionstring

    Function of the person

    Default value: ##default
    creationDatestring

    Date of creation of the stakeholder

    Default value: ##default
    Example: 2024-01-15
    updatedAtstring

    Date of last update of the stakeholder

    Default value: ##default
    Example: 2024-11-10T14:30:00
  • ]
    • totalinteger<int64>

    Total number of stakeholders matching the search criteria

    Default value: ##default
    Example: 42
    totalPagesinteger<int32>

    Total number of pages available

    Default value: ##default
    Example: 5
    pageRequested object

    Information about the requested page

    pageinteger<int32>

    Page number (zero-based)

    Default value: ##default
    Example: 0
    sizeinteger<int32>

    Number of items per page

    Default value: ##default
    Example: 10
    sortstring

    Field used for sorting

    Default value: ##default
    Example: name
    directionstring

    Sort direction (ASC or DESC)

    Default value: ##default
    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": "##default",
          "postalCode": "##default",
          "city": "##default",
          "externalCode": "##default",
          "contactsDetails": [
            {
              "phoneNumber": "0123456789",
              "additionalInfos": "Some additional infos",
              "email": "john.doe@example.com",
              "creationDate": "2020-01-01"
            }
          ],
          "contracts": [
            {
              "id": "##default",
              "type": "LEASE",
              "code": "##default",
              "label": "##default",
              "assetUids": [
                "string"
              ]
            }
          ],
          "isActive": false,
          "fax": "##default",
          "function": "##default",
          "creationDate": "2024-01-15",
          "updatedAt": "2024-11-10T14:30:00"
        }
      ],
      "total": 42,
      "totalPages": 5,
      "pageRequested": {
        "page": 0,
        "size": 10,
        "sort": "name",
        "direction": "ASC"
      }
    }