You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: jurisdiction/README.md
+32-19Lines changed: 32 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,9 @@ This specification details the purpose, use cases, and schema for Jurisdictions.
8
8
9
9
-[Background](#background)
10
10
-[Beta Feature](#beta-feature)
11
+
-[Authorization](#authorization)
11
12
-[Use Cases](#use-cases)
12
13
-[Distribution](#distribution)
13
-
-[REST](#rest)
14
14
-[Schema](#schema)
15
15
-[REST Endpoints](#rest-endpoints)
16
16
-[Flat Files](#flat-files)
@@ -33,12 +33,22 @@ A jurisdiction is:
33
33
- Purview to make rules over physical boundaries and modal boundaries (e.g. a jurisdiction could be for taxis only)
34
34
- A way of tracking revisions in an agency's authority
35
35
36
+
[Top][toc]
37
+
36
38
## Beta Feature
37
39
38
40
The Jurisdictions API and all of its endpoints are marked as a [beta feature](https://github.com/openmobilityfoundation/mobility-data-specification/blob/feature-metrics/general-information.md#beta-features) starting in the 1.1.0 release. It has not been tested in real world scenarios, and may be adjusted in future releases.
39
41
40
42
**[Beta feature](https://github.com/openmobilityfoundation/mobility-data-specification/blob/feature-metrics/general-information.md#beta-features)**: _Yes (as of 1.1.0)_. [Leave feedback](https://github.com/openmobilityfoundation/mobility-data-specification/issues/673)
41
43
44
+
[Top][toc]
45
+
46
+
### Authorization
47
+
48
+
This endpoint should be made public. Authorization is not required.
49
+
50
+
[Top][toc]
51
+
42
52
## Use Cases
43
53
44
54
### 1. Defining boundaries and what the vehicle state `elsewhere` means
@@ -64,25 +74,13 @@ Example: A SaaS company contracts with Miami-Dade County to provide MDS. There a
64
74
Example: The City of Miami has different data visualization tools from the city of Coral Gables
65
75
Those tools can be granted data access from the SaaS tool based on the jurisdiction's stable identifier.
66
76
67
-
[Top](#table-of-contents)
77
+
[Top][toc]
68
78
69
79
## Distribution
70
80
71
-
Jurisdictions can be served by agencies through the following REST API, or via [flat-files](#flat-files). Agencies should make the endpoints public and non-authenticated.
72
-
73
-
### REST
74
-
75
-
All response fields must use `lower_case_with_underscores`.
76
-
77
-
Responses must set the `Content-Type` header, as specified in the [Provider versioning](../provider/README.md#versioning) section. They must also specify the current API version being served in the JSON-formatted response body, under the `version` key.
78
-
79
-
Response bodies must be a `UTF-8` encoded JSON object.
80
-
81
-
#### HTTP Response Codes
81
+
Jurisdictions can be served by agencies through the following REST API, or via [flat-files](#flat-files). See [Authorization](#authorization).
82
82
83
-
The response to a client request must include a valid HTTP status code defined in the [IANA HTTP Status Code Registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml)
84
-
85
-
[Top](#table-of-contents)
83
+
[Top][toc]
86
84
87
85
## Schema
88
86
@@ -116,9 +114,23 @@ Formatted in JSON, a Jurisdiction object should look like this:
116
114
"timestamp": Timestamp
117
115
}
118
116
```
117
+
[Top][toc]
119
118
120
119
## REST Endpoints
121
120
121
+
### Format
122
+
123
+
All response fields must use `lower_case_with_underscores`.
124
+
125
+
Responses must set the `Content-Type` header, as specified in the [Provider versioning](../provider/README.md#versioning) section. They must also specify the current API version being served in the JSON-formatted response body, under the `version` key.
126
+
127
+
Response bodies must be a `UTF-8` encoded JSON object.
128
+
129
+
### HTTP Response Codes
130
+
131
+
The response to a client request must include a valid HTTP status code defined in the [IANA HTTP Status Code Registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml)
132
+
133
+
122
134
### GET /Jurisdictions
123
135
124
136
Gets all of an agency's Jurisdictions. Served by agencies.
@@ -150,7 +162,7 @@ Response codes:
150
162
- 404 - not found
151
163
- 500 - Server error
152
164
153
-
[Top](#table-of-contents)
165
+
[Top][toc]
154
166
155
167
## Flat Files
156
168
@@ -165,14 +177,15 @@ The publishing Agency should establish and communicate to interested parties how
165
177
166
178
The `updated` field in the payload wrapper should be set to the time of publishing a revision, so that it is simple to identify a changed file.
167
179
168
-
[Top](#table-of-contents)
180
+
[Top][toc]
169
181
170
182
## Examples
171
183
172
184
See the [Jurisdiction Examples](examples/README.md) for a sample `jurisdictions.json` file.
173
185
174
186
See the [Geography Examples](/geography/examples/README.md) for an example `geographies.json`.
0 commit comments