/api/v1/codes/{code}/claim

POST

const url = 'https://example.com/api/v1/codes/example/claim';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"thingId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'
};

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/codes/example/claim \
  --header 'Content-Type: application/json' \
  --data '{ "thingId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Parameters

Path Parameters

code

required

string

>= 1 characters <= 32 characters

Request Body^required

application/json

Any of:

object

thingId

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^generated

{
  "thingId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

Default Response

application/json

object

outcome

required

string

Allowed values: claimed

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)$/

Example

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

/api/v1/codes/{code}/claim

Parameters

Path Parameters

Request Bodyrequired

Examplegenerated

Responses

200

Example

Request Body^required

Example^generated