/api/v1/scan/resolve

POST

const url = 'https://example.com/api/v1/scan/resolve';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"text":"example","format":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/scan/resolve \
  --header 'Content-Type: application/json' \
  --data '{ "text": "example", "format": "example" }'

Request Body^required

application/json

object

text

required

string

<= 2048 characters

format

string

<= 40 characters

Example^generated

{
  "text": "example",
  "format": "example"
}

Responses

200

Default Response

application/json

Any of:

object

outcome

required

string

Allowed values: open

target

required

object

kind

required

string

Allowed values: thing place

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

locationId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Example

{
  "outcome": "open",
  "target": {
    "kind": "thing"
  }
}

/api/v1/scan/resolve

Request Bodyrequired

Examplegenerated

Responses

200

Example

Request Body^required

Example^generated