Skip to content

Commit 89211a2

Browse files
committed
Jurisdiction Response codes
1 parent 9fdd486 commit 89211a2

File tree

1 file changed

+37
-9
lines changed

1 file changed

+37
-9
lines changed

jurisdiction/README.md

+37-9
Original file line numberDiff line numberDiff line change
@@ -130,10 +130,14 @@ Responses must set the `Content-Type` header, as specified in the [Provider vers
130130

131131
Response bodies must be a `UTF-8` encoded JSON object.
132132

133+
[Top][toc]
134+
133135
### HTTP Response Codes
134136

135137
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)
136138

139+
[Top][toc]
140+
137141
### Get Jurisdictions
138142

139143
Gets all of an agency's Jurisdictions. Served by agencies.
@@ -150,11 +154,18 @@ _Query Parameters:_
150154
| ------------ | --------- | --- | ---------------------------------------------- |
151155
| `effective` | Timestamp | O | See the state of all the Jurisdictions (i.e. which ones are effective) at that point in time. If not supplied, the default is to show only Jurisdictions that are currently in effect. |
152156

153-
Response codes:
157+
#### Responses
158+
159+
_Possible HTTP Status Codes_:
160+
200,
161+
400 (with parameter),
162+
404,
163+
406,
164+
500
154165

155-
- 200 - success
156-
- 403 - unauthorized
157-
- 500 - server error
166+
See [Responses][responses], [Bulk Responses][bulk-responses], and [schema][schema] for details.
167+
168+
[Top][toc]
158169

159170
### GET Jurisdiction
160171

@@ -178,12 +189,16 @@ _Query Parameters:_
178189
| ------------ | --------- | --- | ---------------------------------------------- |
179190
| `effective` | Timestamp | O | See the version of the Jurisdiction that was in effect at that point in time. |
180191

181-
Response codes:
192+
#### Responses
193+
194+
_Possible HTTP Status Codes_:
195+
200,
196+
400 (with parameter),
197+
404,
198+
406,
199+
500
182200

183-
- 200 - Success
184-
- 403 - Unauthorized
185-
- 404 - not found
186-
- 500 - Server error
201+
See [Responses][responses], [Bulk Responses][bulk-responses], and [schema][schema] for details.
187202

188203
[Top][toc]
189204

@@ -200,6 +215,16 @@ The publishing Agency should establish and communicate to interested parties how
200215

201216
The `last_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.
202217

218+
### Responses
219+
220+
_Possible HTTP Status Codes_:
221+
200,
222+
404,
223+
406,
224+
500
225+
226+
See [Responses][responses], [Bulk Responses][bulk-responses], and [schema][schema] for details.
227+
203228
[Top][toc]
204229

205230
## Examples
@@ -210,5 +235,8 @@ See the [Geography Examples](/geography/examples/README.md) for an example `geog
210235

211236
[Top][toc]
212237

238+
[bulk-responses]: /general-information.md#bulk-responses
213239
[modes]: /modes#list-of-supported-modes
240+
[responses]: /general-information.md#responses
241+
[schema]: /schema/
214242
[toc]: #table-of-contents

0 commit comments

Comments
 (0)