deidentifyDriverData

Overview

This method runs a de-identification job over driver data. A saved query identifies which drivers the job applies to, and the method you choose determines how their data is de-identified.

Warning: De-identification changes driver data in place. The expunge method deletes data from the de-identified fields.

De-identification methods

Method	What it does
expunge	Deletes the data from the de-identified fields. This is the default.
obfuscate	Replaces the fields with randomised data.
wildcard-substitution	Replaces the fields with a substitution character.
wildcard-substitution-with-suffix	Replaces the fields with a substitution character, preserving a 3-character suffix.

This method requires the Drivers:Deidentification permission to be associated with your role.

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'Drivers:Deidentification'.

Only roles with a stored link to this permission in [gb_role_api_permissions] can run this api.

HTTP Method

Use the HTTP Method 'POST' for consuming this web service.

URL Examples

https://api.demo.catch-e.com/fm/drivers/deidentification 
https://api.{{environment}}.catch-e.com/fm/drivers/deidentification https://api.test.catch-e.com/fm/drivers/deidentification

Input Fields (Header)

Key	Format	Notes	Mandatory
Audit-User-Id	string	(Optional) User Id to use for audit purposes. Up to 5 digits. Requires the Audit:UserIdOverride permission.	No

Input Fields (Form Data)

The request body is sent as form data (application/x-www-form-urlencoded).

Key	Format	Notes	Mandatory
driver_classification_query_id	string	The id of the saved SQL query used to identify the drivers to de-identify. The query must return a driver_id column.	Yes
deidentification_method	string	The de-identification method to apply. Allowed values: `expunge`, `obfuscate`, `wildcard-substitution`, `wildcard-substitution-with-suffix`. Default `expunge`.	Yes
wildcard_subsitution_character	string	The substitution character to use with `wildcard-substitution` or `wildcard-substitution-with-suffix`. Allowed values: `asterisk` (*), `hash`, `randomised`. Default `asterisk`.	No

Response Details

Success

204 - No Content

The driver de-identification job was run and completed successfully. No response body is returned.

Error Response Details

Validation Message	Comments
401 - Unauthorized	1. You have not authenticated before running this API or 2. The token_timeout of the current session has passed. You need to authenticate again.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized" }

Validation Message	Comments
403 - Forbidden	- You do not have permissions for this request. - Go to System Roles and enter 'web_services' - Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden" }

Validation Message	Comments
406 - Not Acceptable	The Accept header of the request does not match a response format this API supports.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Acceptable", "status": 406, "detail": "Not Acceptable" }

Validation Message	Comments
415 - Unsupported Media Type	The Content-Type of the request is not supported by this API.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unsupported Media Type", "status": 415, "detail": "Not Acceptable" }

Validation Message	Comments
422 - Unprocessable Entity	One or more input fields failed validation. The field name and message are returned in `validation_messages`.

{ "warning_messages": {}, "validation_messages": { "fieldName": { "validationExceptionCode": "A textual description of the validation exception" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

Validation Message	Comments
500 - Internal Error	An unexpected error occurred on the server.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }

Validation Message	Comments
default - Unexpected Error	Any other unexpected error.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }