PUT api/v2/objects/list

ListObject

Request Information

URI Parameters

None.

Body Parameters

The query

Name	Type	Additional information
OrganizationId	universally unique identifier	None.
Name	StringExpressionQueryFilterList	None.
Description	StringExpressionQueryFilterList	None.
Street	StringExpressionQueryFilterList	None.
StreetNumber	StringExpressionQueryFilterList	None.
PostalCode	StringExpressionQueryFilterList	None.
Locality	StringExpressionQueryFilterList	None.
Kind	RelationalExpressionQueryFilterListOfNullableOfObjectKind	None.
Select	ListObjectQuerySelect	Required
Sort	Collection of ListObjectQuerySort	Required Default value:
PageNumber	integer (32 bits)	Required Default value: 1
PageSize	integer (32 bits)	Required Default value: 100

Request Formats

application/json

Sample:

{
  "OrganizationId": "00000000-0000-0000-0000-000000000000",
  "Name": {
    "Filters": [
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      },
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      }
    ]
  },
  "Description": {
    "Filters": [
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      },
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      }
    ]
  },
  "Street": {
    "Filters": [
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      },
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      }
    ]
  },
  "StreetNumber": {
    "Filters": [
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      },
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      }
    ]
  },
  "PostalCode": {
    "Filters": [
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      },
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      }
    ]
  },
  "Locality": {
    "Filters": [
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      },
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      }
    ]
  },
  "Kind": {
    "Filters": [
      {
        "Value": "Building",
        "ExpressionKind": "Equal",
        "IsIncludeNullValues": true
      },
      {
        "Value": "Building",
        "ExpressionKind": "Equal",
        "IsIncludeNullValues": true
      }
    ]
  },
  "Select": {
    "Name": true,
    "Description": true,
    "Street": true,
    "StreetNumber": true,
    "PostalCode": true,
    "Locality": true,
    "AdministrativeArea": true,
    "CountryId": true,
    "CountryName": true,
    "Kind": true,
    "CadastralIdentificationNumber": true,
    "Email": true,
    "TelephoneNumber": true,
    "TotalFloorArea": true,
    "ConstructionYear": true,
    "HasImage": true
  },
  "Sort": [
    "Name",
    "Name"
  ],
  "PageNumber": 1,
  "PageSize": 1
}

Response Information

Resource Description

ListObjectQueryResult

Name	Description	Type	Additional information
Objects		Collection of ListObjectQueryResultObject	Required
Count		integer (32 bits)	Range: inclusive between 0 and 2147483647

Response Formats

application/json

Sample:

{
  "Objects": [
    {
      "ObjectId": "00000000-0000-0000-0000-000000000000",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Street": "sample string 3",
      "StreetNumber": "sample string 4",
      "PostalCode": "sample string 5",
      "Locality": "sample string 6",
      "AdministrativeArea": "sample string 7",
      "CountryId": "00000000-0000-0000-0000-000000000000",
      "CountryName": "sample string 8",
      "Kind": "Building",
      "CadastralIdentificationNumber": "sample string 9",
      "Email": "sample string 10",
      "TelephoneNumber": "sample string 11",
      "TotalFloorArea": 1,
      "ConstructionYear": 1,
      "HasImage": true
    },
    {
      "ObjectId": "00000000-0000-0000-0000-000000000000",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Street": "sample string 3",
      "StreetNumber": "sample string 4",
      "PostalCode": "sample string 5",
      "Locality": "sample string 6",
      "AdministrativeArea": "sample string 7",
      "CountryId": "00000000-0000-0000-0000-000000000000",
      "CountryName": "sample string 8",
      "Kind": "Building",
      "CadastralIdentificationNumber": "sample string 9",
      "Email": "sample string 10",
      "TelephoneNumber": "sample string 11",
      "TotalFloorArea": 1,
      "ConstructionYear": 1,
      "HasImage": true
    }
  ],
  "Count": 1
}