Generate matrix comparison report
curl --request POST \
--url https://connect.fordje.com/v1/reports/matrix \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"ahj_ids": [
1,
2,
3
],
"data_point_type_ids": [
10,
20,
30
]
}
'import requests
url = "https://connect.fordje.com/v1/reports/matrix"
payload = {
"ahj_ids": [1, 2, 3],
"data_point_type_ids": [10, 20, 30]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({ahj_ids: [1, 2, 3], data_point_type_ids: [10, 20, 30]})
};
fetch('https://connect.fordje.com/v1/reports/matrix', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"response_type": "success",
"description": "Generated matrix for 2 AHJ(s)",
"data": {
"ahjs": [
{
"id": 42,
"name": "City of Austin",
"type": "city",
"state_code": "TX",
"geoid": "4805000"
},
{
"id": 89,
"name": "Travis County",
"type": "county",
"state_code": "TX",
"geoid": "48453"
}
],
"data_point_types": [
{
"id": 10,
"name": "Permit Required",
"description": "Whether a permit is required for this work type",
"unit_of_measure": "boolean",
"category_ids": [
53
]
},
{
"id": 11,
"name": "Permit Fee",
"description": "Base fee for a residential permit application",
"unit_of_measure": "USD",
"category_ids": [
53
]
},
{
"id": 12,
"name": "Permit Turnaround Time",
"description": "Typical review time for a complete permit application",
"unit_of_measure": "days",
"category_ids": [
53
]
}
],
"rows": [
{
"ahj": {
"id": 42,
"name": "City of Austin",
"type": "city",
"state_code": "TX",
"geoid": "4805000"
},
"values": {
"10": {
"value": "Yes",
"reference": "Austin Municipal Code",
"section": "25-1-21"
},
"11": {
"value": "$150.00",
"reference": "Austin Fee Schedule",
"section": "Sec. 25-12-3"
},
"12": {
"value": "10 business days",
"reference": "Austin Development Services",
"section": "Residential Review SLA"
}
}
},
{
"ahj": {
"id": 89,
"name": "Travis County",
"type": "county",
"state_code": "TX",
"geoid": "48453"
},
"values": {
"10": {
"value": "Yes",
"reference": "Travis County Development Regulations",
"section": "Ch. 482"
},
"11": {
"value": "$125.00",
"reference": "Travis County Fee Schedule",
"section": "Sec. 3.1"
},
"12": {
"value": "15 business days",
"reference": "Travis County Development Regulations",
"section": "Ch. 482.4"
}
}
}
]
},
"warnings": [
{
"code": "AHJ_ACCESS_DENIED",
"message": "1 AHJ(s) excluded: not in your subscription.",
"excluded_ahj_ids": [
112
],
"unmatched_geoids": []
}
]
}{
"description": "Access denied",
"error": "AHJ_ACCESS_DENIED",
"response_type": "error",
"status_code": 403
}{
"description": "Access denied",
"error": "AHJ_ACCESS_DENIED",
"response_type": "error",
"status_code": 403
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"description": "Access denied",
"error": "AHJ_ACCESS_DENIED",
"response_type": "error",
"status_code": 403
}{
"description": "Access denied",
"error": "AHJ_ACCESS_DENIED",
"response_type": "error",
"status_code": 403
}Reports
Generate matrix comparison report
Generate a comparison matrix with AHJs as rows and data point types as columns. Only AHJs your organization has access to are included. Unauthorized AHJs are excluded with a warning. A cell is null when the AHJ has no value for that data point type; reference and section are null when no citation is recorded.
POST
/
v1
/
reports
/
matrix
Generate matrix comparison report
curl --request POST \
--url https://connect.fordje.com/v1/reports/matrix \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"ahj_ids": [
1,
2,
3
],
"data_point_type_ids": [
10,
20,
30
]
}
'import requests
url = "https://connect.fordje.com/v1/reports/matrix"
payload = {
"ahj_ids": [1, 2, 3],
"data_point_type_ids": [10, 20, 30]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({ahj_ids: [1, 2, 3], data_point_type_ids: [10, 20, 30]})
};
fetch('https://connect.fordje.com/v1/reports/matrix', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"response_type": "success",
"description": "Generated matrix for 2 AHJ(s)",
"data": {
"ahjs": [
{
"id": 42,
"name": "City of Austin",
"type": "city",
"state_code": "TX",
"geoid": "4805000"
},
{
"id": 89,
"name": "Travis County",
"type": "county",
"state_code": "TX",
"geoid": "48453"
}
],
"data_point_types": [
{
"id": 10,
"name": "Permit Required",
"description": "Whether a permit is required for this work type",
"unit_of_measure": "boolean",
"category_ids": [
53
]
},
{
"id": 11,
"name": "Permit Fee",
"description": "Base fee for a residential permit application",
"unit_of_measure": "USD",
"category_ids": [
53
]
},
{
"id": 12,
"name": "Permit Turnaround Time",
"description": "Typical review time for a complete permit application",
"unit_of_measure": "days",
"category_ids": [
53
]
}
],
"rows": [
{
"ahj": {
"id": 42,
"name": "City of Austin",
"type": "city",
"state_code": "TX",
"geoid": "4805000"
},
"values": {
"10": {
"value": "Yes",
"reference": "Austin Municipal Code",
"section": "25-1-21"
},
"11": {
"value": "$150.00",
"reference": "Austin Fee Schedule",
"section": "Sec. 25-12-3"
},
"12": {
"value": "10 business days",
"reference": "Austin Development Services",
"section": "Residential Review SLA"
}
}
},
{
"ahj": {
"id": 89,
"name": "Travis County",
"type": "county",
"state_code": "TX",
"geoid": "48453"
},
"values": {
"10": {
"value": "Yes",
"reference": "Travis County Development Regulations",
"section": "Ch. 482"
},
"11": {
"value": "$125.00",
"reference": "Travis County Fee Schedule",
"section": "Sec. 3.1"
},
"12": {
"value": "15 business days",
"reference": "Travis County Development Regulations",
"section": "Ch. 482.4"
}
}
}
]
},
"warnings": [
{
"code": "AHJ_ACCESS_DENIED",
"message": "1 AHJ(s) excluded: not in your subscription.",
"excluded_ahj_ids": [
112
],
"unmatched_geoids": []
}
]
}{
"description": "Access denied",
"error": "AHJ_ACCESS_DENIED",
"response_type": "error",
"status_code": 403
}{
"description": "Access denied",
"error": "AHJ_ACCESS_DENIED",
"response_type": "error",
"status_code": 403
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"description": "Access denied",
"error": "AHJ_ACCESS_DENIED",
"response_type": "error",
"status_code": 403
}{
"description": "Access denied",
"error": "AHJ_ACCESS_DENIED",
"response_type": "error",
"status_code": 403
}Authorizations
Body
application/json
Response
Matrix with AHJs as rows and data point types as columns
Standard response envelope for all Fordje Connect API endpoints.
Was this page helpful?