Ga naar inhoud
buildinglinksbuildinglinks

Where an object's indeling comes from

GET
/api/v1/objects/{object}/topology
curl --request GET \
  --url https://example.com/api/v1/objects/example/topology \
  --cookie bl_%3Cslug%3E_session=%3Cbl_%3Cslug%3E_session%3E

The chosen source of the indeling of a building (decisions #71), and the candidates: own sources that provide it, and suppliers appointed for it.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
object
required
string

The object id, e.g. nl.bag.pand.0014100040022681.

Responses

Section titled “Responses”

200

Section titled “200”

OK.

Media typeapplication/json

Where the indeling of an object comes from, and what it could come from.

object
object
required
string
choice
One of:
null
candidates
required

Own sources whose koppeling provides the indeling, and suppliers appointed for it.

Array<object>
object
kind
required

source or delegation.

string
id
required
string
name
required

The source’s name, or the supplier’s.

string
state

Candidates of kind delegation: the state of the delegation.

string | null

Example generated

{
  "object": "example",
  "choice": {
    "kind": "example",
    "id": "example",
    "name": "example",
    "state": "example"
  },
  "candidates": [
    {
      "kind": "example",
      "id": "example",
      "name": "example",
      "state": "example"
    }
  ]
}

401

Section titled “401”

No valid session, DPoP-bound token or API key.

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

403

Section titled “403”

The caller lacks the role this operation needs; or a change with the session cookie came from a page of another site (cross_site_request, decisions #83).

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}