def get_status():
request_utils.get_request_id(request)
request_utils.get_source_ip(request)
result = request_handler.ping_database()
if result:
logger = logging.getLogger(__name__)
logger.debug('logType=StatusCheck|requestId="{request_id}"|statusCode={status_code}|path="{path}"|'
'sourceIp={source_ip}|url="{url}"'.format(request_id=g.request_id,
source_ip=g.source_ip,
path=request.path,
url=request.url,
status_code=200))
return jsonify(
{
'status': 'OK'
}
)
else:
logger = logging.getLogger(__name__)
logger.error('logType=StatusCheck|requestId="{request_id}"|statusCode={status_code}|path="{path}"|'
'sourceIp={source_ip}|url="{url}"'.format(request_id=g.request_id,
source_ip=g.source_ip,
path=request.path,
url=request.url,
status_code=500))
return jsonify(
{
'status': 'ERROR'
}
), 500
def get_root():
"""Endpoint returning information about available resources
---
responses:
200:
description: A list of resources available through the API
"""
request_utils.get_request_id(request)
request_utils.get_source_ip(request)
root_resource = request_handler.get_root_response()
parameters_as_string = request_utils.dict_to_piped_kv_pairs(request.args)
logger = logging.getLogger(__name__)
logger.info('logType=Request|requestId="{request_id}"|statusCode={status_code}|path="{path}"|'
'sourceIp={source_ip}|url="{url}"|{parameters}'.format(
request_id=g.request_id,
source_ip=g.source_ip,
path=request.path,
url=request.url,
parameters=parameters_as_string,
status_code=200)
)
logger.debug('requestId="{request_id}"|headers={headers}|'.format(
headers=json.dumps(dict(request.headers)),
request_id=g.request_id)
)
return jsonify(root_resource)
def route_role_type_by_code(role_code):
"""Endpoint returns a single ODS role type
---
parameters:
- name: role_code
in: path
type: string
required: true
responses:
200:
description: A single JSON object representing an ODS role type record
"""
request_utils.get_request_id(request)
request_utils.get_source_ip(request)
# Ensure the provided code is in upper case
role_code = str.upper(role_code)
# Pass the supplied code to the request handler to service the request
result = request_handler.get_role_type_by_code_response(role_code)
logger = logging.getLogger(__name__)
logger.info('logType=Request|requestId="{request_id}"|path="{path}"|'
'resourceId={resource_id}|sourceIp={source_ip}|url="{url}"'.format(
source_ip=g.source_ip,
request_id=g.request_id,
resource_id=role_code,
path=request.path,
url=request.url,
)
)
return result
def route_role_types():
"""
Endpoint returning a list of ODS role types
---
responses:
200:
description: A list of ODS role type resources
"""
request_utils.get_request_id(request)
request_utils.get_source_ip(request)
result = request_handler.get_role_types_response()
parameters_as_string = request_utils.dict_to_piped_kv_pairs(request.args)
logger = logging.getLogger(__name__)
logger.info('logType=Request|requestId="{request_id}"|'
'path="{path}"|sourceIp={source_ip}|url="{url}"|{parameters}'.format(
source_ip=g.source_ip,
request_id=g.request_id,
path=request.path,
url=request.url,
parameters=parameters_as_string,
)
)
return result
def not_found(error):
try:
g.request_id
except AttributeError:
request_utils.get_request_id(request)
try:
g.source_ip
except AttributeError:
request_utils.get_source_ip(request)
logger = logging.getLogger(__name__)
logger.info('logType=Request|requestId="{request_id}"|statusCode={status_code}|'
'errorText="{error_text}"|path="{path}"|'
'sourceIp={source_ip}|url="{url}"|'.format(
request_id=g.request_id,
source_ip=g.source_ip,
path=request.path,
url=request.url,
status_code=error.code,
error_text=error.description)
)
return jsonify(
{
'errorCode': 404,
'errorText': 'Not found'
}
), 404
def get_info():
"""Endpoint returning information about the current ODS dataset
---
responses:
200:
description: A JSON object representing the metadata about the ODS dataset currently in use by the API
"""
request_utils.get_request_id(request)
request_utils.get_source_ip(request)
logger = logging.getLogger(__name__)
logger.info('logType=Request|requestId="{request_id}"|'
'path="{path}"|sourceIp={source_ip}|url="{url}|"'.format(
request_id=g.request_id,
source_ip=g.source_ip,
path=request.path,
url=request.url,
)
)
dataset_info = request_handler.get_info_response()
return jsonify(dataset_info)
def get_organisations():
"""
Endpoint returning a list of ODS organisations
---
parameters:
- name: limit
description: Limits number of results to specified value (hard limit of 1000 records)
in: query
type: integer
required: false
- name: offset
description: Starts result set at specified point in the total results set
in: query
type: integer
required: false
- name: q
description: Filters results by names which contain the specified string
in: query
type: string
required: false
- name: postCode
description: Filters results to only those with a postcode containing the specified value
in: query
type: string
- name: active
description: true - filters results to only those with a status of 'Active'.
false - filters results to only those with a status of 'Inactive'
in: query
type: boolean
- name: roleCode
description: Filters results to only those with one of the specified role codes assigned
in: query
type: array
collectionFormat: csv
required: false
- name: primaryRoleCode
description: Filters results to only those with one of the specified role codes assigned as a Primary role.
Ignored if used alongside roleCode parameter.
in: query
type: array
collectionFormat: csv
required: false
- name: lastUpdatedSince
description: Filters results to only those with a lastChangeDate after the specified date.
in: query
type: string
format: date
required: false
- name: legallyActive
description: Filters results to only those that are still legally active.
in: query
type: boolean
required: false
- name: recordClass
description: Filters results to only those in the specified record class.
in: query
type: string
enum: ['HSCSite', 'HSCOrg']
required: false
responses:
200:
description: A filtered list of organisation resources
"""
request_utils.get_request_id(request)
request_utils.get_source_ip(request)
logger = logging.getLogger(__name__)
resp = request_handler.get_organisations_response(request)
parameters_as_string = request_utils.dict_to_piped_kv_pairs(request.args)
logger.info('logType=Request|requestId="{request_id}"|path="{path}"|sourceIp={source_ip}|'
'url="{url}"|{parameters}'.format(
source_ip=g.source_ip,
request_id=g.request_id,
path=request.path,
url=request.url,
parameters=parameters_as_string,
)
)
return resp