IdentityPersonCodeMaintenance
CodeMaintenanceService
Base URL: /domains/legacy/identity/person/codemaintenance
Version: v1
Summary
Path | Operation | Description |
---|---|---|
/ | GET | shows a list of all domain names |
/countries/{country_code} | PUT | Updates an existing country name |
/delete/countries/{country_code} | DELETE | deletes a given country |
/delete/religions/{religion_code} | DELETE | deletes a religion identified by a religion code |
/delete/states/{country_code}/{state_code} | DELETE | deletes a single state identified by a state and country code |
/delete/{domain_name}/{domain_value} | DELETE | deletes a code value identified by a given domain name and value |
/documentation | GET | service definition |
/religions/{religion_code} | PUT | Updates an existing religion name |
/states/{country_code}/{state_code} | PUT | Updates an existing state name |
/{domain_name} | GET | shows a list of all maintainable codes for other general categories |
/{domain_name}/{domain_value} | PUT | Updates an existing value in the current selected list |
Paths
shows a list of all domain names
Uses default content-types: application/json
- 200 OK
-
Service request is OK and a response has been generated.
Example for application/json{
"CodeMaintenanceService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"domains": [
"Countries",
"Religions",
"States",
"BUILDING",
"LANGUAGE"
]
}
}
} - 400 Bad Request
-
There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
- 403 Forbidden
-
The user does not have access to the resource.
- 404 Not Found
-
The target resource can not be found for the provided resource identifiers.
- 405 Method Not Allowed
-
The service method is not supported by the service.
- 409 Conflict
-
A conflict has occurred. The response structure may contain information about the conflict.
- 500 Internal Server Error
-
An error occurred generating the response to the service request. This is strictly a server error and not an application error.
Updates an existing country name
country_code | string -> the code for a specific country | path | string |
Uses default content-types: application/json
- 200 OK
-
Service request is OK and a response has been generated.
- 400 Bad Request
-
There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
- 403 Forbidden
-
The user does not have access to the resource.
- 404 Not Found
-
The target resource can not be found for the provided resource identifiers.
- 405 Method Not Allowed
-
The service method is not supported by the service.
- 409 Conflict
-
A conflict has occurred. The response structure may contain information about the conflict.
- 500 Internal Server Error
-
An error occurred generating the response to the service request. This is strictly a server error and not an application error.
deletes a given country
country_code | string -> the code for a specific country | path | string |
Uses default content-types: application/json
- 200 OK
-
Service request is OK and a response has been generated.
- 400 Bad Request
-
There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
- 403 Forbidden
-
The user does not have access to the resource.
- 404 Not Found
-
The target resource can not be found for the provided resource identifiers.
- 405 Method Not Allowed
-
The service method is not supported by the service.
- 409 Conflict
-
A conflict has occurred. The response structure may contain information about the conflict.
- 500 Internal Server Error
-
An error occurred generating the response to the service request. This is strictly a server error and not an application error.
DELETE /delete/religions/{religion_code}
Tags: CodeMaintenanceServicedeletes a religion identified by a religion code
religion_code | string -> the 3 letter code for a given religion | path | string |
Uses default content-types: application/json
- 200 OK
-
Service request is OK and a response has been generated.
- 400 Bad Request
-
There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
- 403 Forbidden
-
The user does not have access to the resource.
- 404 Not Found
-
The target resource can not be found for the provided resource identifiers.
- 405 Method Not Allowed
-
The service method is not supported by the service.
- 409 Conflict
-
A conflict has occurred. The response structure may contain information about the conflict.
- 500 Internal Server Error
-
An error occurred generating the response to the service request. This is strictly a server error and not an application error.
DELETE /delete/states/{country_code}/{state_code}
Tags: CodeMaintenanceServicedeletes a single state identified by a state and country code
country_code | string -> the code for a specific country | path | string | |
state_code | string -> the code for a specific state inside the selected country | path | string |
Uses default content-types: application/json
- 200 OK
-
Service request is OK and a response has been generated.
- 400 Bad Request
-
There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
- 403 Forbidden
-
The user does not have access to the resource.
- 404 Not Found
-
The target resource can not be found for the provided resource identifiers.
- 405 Method Not Allowed
-
The service method is not supported by the service.
- 409 Conflict
-
A conflict has occurred. The response structure may contain information about the conflict.
- 500 Internal Server Error
-
An error occurred generating the response to the service request. This is strictly a server error and not an application error.
DELETE /delete/{domain_name}/{domain_value}
Tags: CodeMaintenanceServicedeletes a code value identified by a given domain name and value
domain_name | string -> the name of a domain of code values | path | string | |
domain_value | string -> the value for a given item in the domain | path | string |
Uses default content-types: application/json
- 200 OK
-
Service request is OK and a response has been generated.
- 400 Bad Request
-
There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
- 403 Forbidden
-
The user does not have access to the resource.
- 404 Not Found
-
The target resource can not be found for the provided resource identifiers.
- 405 Method Not Allowed
-
The service method is not supported by the service.
- 409 Conflict
-
A conflict has occurred. The response structure may contain information about the conflict.
- 500 Internal Server Error
-
An error occurred generating the response to the service request. This is strictly a server error and not an application error.
GET /documentation
service definition
Uses default content-types: application/json
- 200 OK
-
Success
Updates an existing religion name
religion_code | string -> the 3 letter code for a given religion | path | string |
Uses default content-types: application/json
- 200 OK
-
Service request is OK and a response has been generated.
- 400 Bad Request
-
There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
- 403 Forbidden
-
The user does not have access to the resource.
- 404 Not Found
-
The target resource can not be found for the provided resource identifiers.
- 405 Method Not Allowed
-
The service method is not supported by the service.
- 409 Conflict
-
A conflict has occurred. The response structure may contain information about the conflict.
- 500 Internal Server Error
-
An error occurred generating the response to the service request. This is strictly a server error and not an application error.
Updates an existing state name
country_code | string -> the code for a specific country | path | string | |
state_code | string -> the code for a specific state inside the selected country | path | string |
Uses default content-types: application/json
- 200 OK
-
Service request is OK and a response has been generated.
- 400 Bad Request
-
There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
- 403 Forbidden
-
The user does not have access to the resource.
- 404 Not Found
-
The target resource can not be found for the provided resource identifiers.
- 405 Method Not Allowed
-
The service method is not supported by the service.
- 409 Conflict
-
A conflict has occurred. The response structure may contain information about the conflict.
- 500 Internal Server Error
-
An error occurred generating the response to the service request. This is strictly a server error and not an application error.
GET /{domain_name}
Tags: CodeMaintenanceServiceshows a list of all maintainable codes for other general categories
domain_name | string -> the name of a domain of code values | path | string |
Uses default content-types: application/json
- 200 OK
-
Service request is OK and a response has been generated.
Example for application/json{
"CodeMaintenanceService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/Countries",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"Countries": [
{
"country": "Aaland Islands",
"country_code": "AAL",
"country_phone_prefix": "",
"iso_code": "AX",
"iso_code_3": "",
"valid_for_address": "Y",
"valid_for_birth_country": "Y",
"valid_for_citizenship": "Y",
"valid_for_home_country": "Y"
},
{
"country": "Afghanistan",
"country_code": "AFG",
"country_phone_prefix": "93",
"iso_code": "AF",
"iso_code_3": "AFG",
"valid_for_address": "Y",
"valid_for_birth_country": "Y",
"valid_for_citizenship": "Y",
"valid_for_home_country": "Y"
}
],
"List": [
{
"active_status": "A",
"desc_15": "Allen Hall",
"description": "Allen Hall",
"domain_name": "BUILDING",
"domain_value": "ALLN"
},
{
"active_status": "",
"desc_15": "Amanda Knight H",
"description": "Amanda Knight Hall",
"domain_name": "BUILDING",
"domain_value": "AKH"
},
{
"active_status": "A",
"desc_15": "Abkhazian",
"description": "Abkhazian",
"domain_name": "LANGUAGE",
"domain_value": "AB"
},
{
"active_status": "A",
"desc_15": "Afar",
"description": "Afar",
"domain_name": "LANGUAGE",
"domain_value": "AA"
}
],
"Religions": [
{
"religion": "Bahai",
"religion_code": "BAH"
},
{
"religion": "Ballai",
"religion_code": "BAL"
}
],
"States": [
{
"country_code": "AUS",
"state": "Austl. Cap. Terr.",
"state_code": "ACT"
},
{
"country_code": "AUS",
"state": "New South Wales",
"state_code": "NSW"
}
]
}
}
} - 400 Bad Request
-
There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
- 403 Forbidden
-
The user does not have access to the resource.
- 404 Not Found
-
The target resource can not be found for the provided resource identifiers.
- 405 Method Not Allowed
-
The service method is not supported by the service.
- 409 Conflict
-
A conflict has occurred. The response structure may contain information about the conflict.
- 500 Internal Server Error
-
An error occurred generating the response to the service request. This is strictly a server error and not an application error.
PUT /{domain_name}/{domain_value}
Tags: CodeMaintenanceServiceUpdates an existing value in the current selected list
domain_name | string -> the name of a domain of code values | path | string | |
domain_value | string -> the value for a given item in the domain | path | string |
Uses default content-types: application/json
- 200 OK
-
Service request is OK and a response has been generated.
- 400 Bad Request
-
There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
- 403 Forbidden
-
The user does not have access to the resource.
- 404 Not Found
-
The target resource can not be found for the provided resource identifiers.
- 405 Method Not Allowed
-
The service method is not supported by the service.
- 409 Conflict
-
A conflict has occurred. The response structure may contain information about the conflict.
- 500 Internal Server Error
-
An error occurred generating the response to the service request. This is strictly a server error and not an application error.
Schema definitions
- country_code: string
-
- country: string
-
- iso_code: string
-
- country_phone_prefix: string
-
- valid_for_citizenship: string
-
- valid_for_address: string
-
- valid_for_birth_country: string
-
- valid_for_home_country: string
-
- iso_code_3: string
-
- WebService: object
-
- name: string
-
- operations: operations
-
- docErrors: docErrors
-
- httpStatusCodes: httpStatusCodes
-
- domain_name: string
-
- domain_value: string
-
- active_status: string
-
- description: string
-
- desc_15: string
-
- name: string
-
- description: string
-
- method: string
-
- path: string
-
- path_identifiers: object[]
-
object - name: string
-
- type: string
-
- format: string
-
- query_attributes: object[]
-
object - name: string
-
- type: string
-
- format: string
-
- required: string
-
- method: string
-
- resource: string
-
- attributes: string
-
- status: integer
-
- statusMessage: string
-