Shopping Cart
Retrieve access plans for a facility
Returns the access plans for the specified facility with all related items.
GET
/
shopping
/
{portfolio}
/
v1
/
shopping-cart
/
access-plans
/
{facilityUuid}
Retrieve access plans for a facility
curl --request GET \
--url https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/access-plans/{facilityUuid} \
--header 'x-api-key: <x-api-key>'import requests
url = "https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/access-plans/{facilityUuid}"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/access-plans/{facilityUuid}', 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://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/access-plans/{facilityUuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <x-api-key>"
],
]);
$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://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/access-plans/{facilityUuid}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/access-plans/{facilityUuid}")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/access-plans/{facilityUuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body[
{
"accessPlanUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"itemType": {
"itemTypeUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"itemTypeName": "<string>",
"description": "<string>",
"category": "<string>",
"isRecurring": true,
"isRequiredAtMoveIn": true,
"isRequiredAtTransfer": true,
"isReadOnly": true,
"isTaxable": true,
"taxCode": "<string>",
"isActive": true,
"isProratedAtMoveIn": true,
"feeType": "<string>",
"fixedFeeAmount": 123,
"feePercentage": 123
},
"accessPlanDayRules": [
{
"isOpen": false,
"accessStartTime": "<string>",
"accessEndTime": "<string>",
"accessPlanDayRuleUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accessPlanUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"name": "<string>",
"isDefault": true,
"isLegacy": true,
"vendorName": "<string>",
"facilities": [
{
"facilityUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"facilityName": "<string>"
}
],
"planNameDescription": "<string>",
"isManagedByVendor": true
}
]Headers
Api key required to authenticate your request. Please reach out to monument for a key.
Example:
"monument-2230012-2312321"
Path Parameters
Response
200 - application/json
The access plans for the specified facility with all related items
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
Retrieve access plans for a facility
curl --request GET \
--url https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/access-plans/{facilityUuid} \
--header 'x-api-key: <x-api-key>'import requests
url = "https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/access-plans/{facilityUuid}"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/access-plans/{facilityUuid}', 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://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/access-plans/{facilityUuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <x-api-key>"
],
]);
$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://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/access-plans/{facilityUuid}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/access-plans/{facilityUuid}")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/access-plans/{facilityUuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body[
{
"accessPlanUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"itemType": {
"itemTypeUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"itemTypeName": "<string>",
"description": "<string>",
"category": "<string>",
"isRecurring": true,
"isRequiredAtMoveIn": true,
"isRequiredAtTransfer": true,
"isReadOnly": true,
"isTaxable": true,
"taxCode": "<string>",
"isActive": true,
"isProratedAtMoveIn": true,
"feeType": "<string>",
"fixedFeeAmount": 123,
"feePercentage": 123
},
"accessPlanDayRules": [
{
"isOpen": false,
"accessStartTime": "<string>",
"accessEndTime": "<string>",
"accessPlanDayRuleUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accessPlanUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"name": "<string>",
"isDefault": true,
"isLegacy": true,
"vendorName": "<string>",
"facilities": [
{
"facilityUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"facilityName": "<string>"
}
],
"planNameDescription": "<string>",
"isManagedByVendor": true
}
]
