Get LocalityCategory entities.

GETRequest

import { RecranetApiClient } from "@recranet/sdk";

const client = new RecranetApiClient({ apiKey: process.env.RECRANET_API_KEY! });

const result = await client.localityCategories.list({
  organization: 0,
});

Responses

200400

Response 200

Successful response

application/json

Example responseGenerated from schema

[
  {
    "id": 0,
    "name": "name",
    "locale": "locale",
    "displayName": "displayName",
    "excerpt": "excerpt",
    "disclaimer": "disclaimer",
    "description": "description",
    "address": "address",
    "postalCode": "postalCode",
    "locality": "locality",
    "municipality": 0,
    "region": "region",
    "country": "country",
    "latitude": "latitude",
    "longitude": "longitude",
    "public": true,
    "root": {
      "id": 1000
    },
    "parent": {
      "id": 1000
    }
  }
]

Response 400

Bad request

application/json

Example 1

{
  "statusCode": 400,
  "description": "Bad request",
  "errors": [
    "Bad request"
  ]
}

Query parameters

• organizationnumberrequired

Returns

Array of LocalityCategory

Schema shown for 200 · application/json

• idnumber
• namestring
• excerptstringoptional
• disclaimerstringoptional
• descriptionstringoptional
• addressstringoptional
• postalCodestringoptional
• localitystringoptional
• municipalitynumberoptional
• regionstringoptional
• countrystringoptional
• latitudestringoptional
• longitudestringoptional
• localestring
• publicbooleanoptional
  Default: true
• rootobjectoptional
  Show 1 property

  • idnumberoptional
• parentobjectoptional
  Show 1 property

  • idnumberoptional
• displayNamestring