identityStateCodes
Describes the identity codes for identity-state-codes
Base URL: /domains/identity/state_codes
Version: v1
Summary
| Path | Operation | Description |
|---|---|---|
| / | GET | Identity Codes |
| POST | Identity Codes | |
| /{country_code},{state_code} | DELETE | Identity Codes |
| GET | Identity Codes | |
| PUT | Identity Codes | |
| /{country_code},{state_code}/logs | GET | Identity Codes Archive |
Paths
Retrieve a collection of state_codes
| country_code | country_codes query parameter. | query | string | |
| active_status | active query parameter. | query | string |
Uses default content-types: application/json
- 200 OK
-
A collection of state_codes
- 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Creates a state_code
New state_code values
Uses default content-types: application/json
- 201 Created
-
state_code successfully created
- 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Removes a state_code
| country_code | country_code path parameter | path | string | #/parameters/country_code |
| state_code | state_code path parameter | path | string | #/parameters/state_code |
Uses default content-types: application/json
- 204 No Content
-
state_code successfully Removed
- 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 404 Not Found
-
There is no matching state_code to remove
- default #/responses/default
-
Unexpected error
Retrieve a specific state_code
| country_code | country_code path parameter | path | string | #/parameters/country_code |
| state_code | state_code path parameter | path | string | #/parameters/state_code |
Uses default content-types: application/json
- 200 OK
-
A specific state_code
- 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 404 Not Found
-
There is no matching state_code
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Modify a state_code
Values required to modify a state_code
| country_code | country_code path parameter | path | string | #/parameters/country_code |
| state_code | state_code path parameter | path | string | #/parameters/state_code |
Uses default content-types: application/json
- 200 OK
-
state_code successfully modified
- 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 404 Not Found
-
There is no matching state_code
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Retrieve the collection of logs for a state_code
| country_code | country_code path parameter | path | string | #/parameters/country_code |
| state_code | state_code path parameter | path | string | #/parameters/state_code |
Uses default content-types: application/json
- 200 OK
-
A collection of state_code Logs
- 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 404 Not Found
-
There is no matching state_code
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Parameter definitions
| country_code | country_code | country_code path parameter | path | string | |
| state_code | state_code | state_code path parameter | path | string |
Response definitions
- 400
-
Invalid Request - unable to interpret request
- 401
-
Authentication required to access data
- 403
-
Access denied to protected data
- 409
-
Query parameters conflict or are malformed
- default
-
Unexpected error
Schema definitions
- metadata: simple_metadata
-
What function was performed on the state_code
- validation_response: object
-
- code: integer
-
- message: string
-
- validation_information: string[]
-
string - cache: object
-
If data is from live source, value will be null, otherwise it will be date-time of cache
- date_time: string (date-time)
-
A state_code
- links: object
-
Hypermedia Links that impact this state_code
- state_codes__info: object
-
Hypermedia link to retrieve this state_code
- rel: string , x ∈ { self (default) }
-
- href: string (uri) https://api.byu.edu/domains/identity/state_codes/v1/:state_code
-
- method: string , x ∈ { GET (default) }
-
- state_codes__modify: object
-
Hypermedia link to modify this state_code
- rel: string , x ∈ { state_codes__modify (default) }
-
- href: string (uri) https://api.byu.edu/domains/identity/state_codes/v1/:state_code
-
- method: string , x ∈ { PUT (default) }
-
- state_codes__remove: object
-
Hypermedia link to remove this state_code
- rel: string , x ∈ { state_codes__remove (default) }
-
- href: string (uri) https://api.byu.edu/domains/identity/state_codes/v1/:state_code
-
- method: string , x ∈ { DELETE (default) }
-
- metadata: simple_metadata
-
- state_code: state_code
-
- country_code: country_code
-
- description: description
-
- long_description: long_description
-
- active_status: active_status
-
- updated_by_id: updated_by_id
-
- date_time_updated: date_time_updated
-
Change Log for state_codes API
- log_action: log_action
-
- state_code: state_code
-
- country_code: country_code
-
- description: description
-
- long_description: long_description
-
- active_status: active_status
-
- updated_by_id: updated_by_id
-
- date_time_updated: date_time_updated
-
Change Logs for state_codes API
- links: object
-
Hypermedia Links for the collection of logs for the state_code
- state_code_logs__info: object
-
Hypermedia link to retrieve the change logs for this state_code
- rel: string , x ∈ { self (default) }
-
- href: string (uri) https://api.byu.edu/domains/identity/state_codes/v1/:country_code,:state_code/logs
-
- method: string , x ∈ { GET (default) }
-
- metadata: sub_level_metadata
-
- values: object[]
Elements required to add a new state_code
- state_code: state_code
-
- country_code: country_code
-
- description: description
-
- long_description: long_description
-
- active_status: active_status
-
A state_code collection
- links: object
-
Hypermedia Links that impact the state_codes collection
- state_codes__info: object
-
- rel: string , x ∈ { self (default) }
-
- href: string (uri) https://api.byu.edu/domains/identity/state_codes/v1
-
- method: string , x ∈ { GET (default) }
-
- state_codes__create: object
-
- rel: string , x ∈ { state_codes__create (default) }
-
- href: string (uri) https://api.byu.edu/domains/identity/state_codes/v1
-
- method: string , x ∈ { POST (default) }
-
- metadata: sub_level_metadata
-
- values: object[]
- collection_size: integer , { x ∈ ℤ | x ≥ 0 }
-
