Check whether a unit can be vaulted - Endstate API

Check whether a unit can be vaulted

curl --request GET \
  --url https://api2.endstate.io/v1/units/{unit_id}/vault-eligibility \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api2.endstate.io/v1/units/{unit_id}/vault-eligibility"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api2.endstate.io/v1/units/{unit_id}/vault-eligibility', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api2.endstate.io/v1/units/{unit_id}/vault-eligibility",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api2.endstate.io/v1/units/{unit_id}/vault-eligibility"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api2.endstate.io/v1/units/{unit_id}/vault-eligibility")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "vaultable": true,
  "vault": {
    "id": "33333333-3333-4333-8333-333333333333",
    "name": "Alliance Vault"
  },
  "request_id": null
}

GET

/

v1

/

units

/

{unit_id}

/

vault-eligibility

Check whether a unit can be vaulted

curl --request GET \
  --url https://api2.endstate.io/v1/units/{unit_id}/vault-eligibility \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api2.endstate.io/v1/units/{unit_id}/vault-eligibility"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api2.endstate.io/v1/units/{unit_id}/vault-eligibility', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api2.endstate.io/v1/units/{unit_id}/vault-eligibility",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api2.endstate.io/v1/units/{unit_id}/vault-eligibility"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api2.endstate.io/v1/units/{unit_id}/vault-eligibility")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "vaultable": true,
  "vault": {
    "id": "33333333-3333-4333-8333-333333333333",
    "name": "Alliance Vault"
  },
  "request_id": null
}

Authorizations

Authorization

string

header

required

Use Authorization: Bearer end_sess_* for V2 browser session tokens (e.g. end_sess_ZW5kc3RhdGUtZXhhbXBsZS1zZXNzaW9uLXRva2VuAAA).

Path Parameters

unit_id

string<uuid>

required

Unit id.

Example:

"33333333-3333-4333-8333-333333333333"

Response

The default vault and whether the unit can go to it.

vaultable

boolean

required

Whether the owner can vault the item into vault now: the unit is issued, its collection is active, it is not vaulted and has no open vault request, and the vault takes new items. Ownership is checked when the owner approves.

Example:

true

vault

object | null

required

The brand's default vault, where a vaulted item goes. Null when the brand has none that takes new items.

Show child attributes

request_id

string<uuid> | null

required

The item's vault request while its owner can still cancel it, so a page finds it again after a reload. Null when there is none, including once the item is vaulted.

Example:

null