Appearance
Create Person Csv Export
Accepts requests for generating Person CSV file.
Endpoints
| Environment | API Endpoint |
|---|---|
| Sandbox | https://onprem-test.streamline.laboremus.ug/routing/v1/csv/persons |
Request
Request Type : POST
Authorization
All requests must be authenticated using OAuth 2.0 Client Credentials. Follow the steps in the Authentication section to obtain an access token.
Content type
application/json
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
| type | string | yes | Type of CSV to be generated |
| dateRange.from | tate | yes | Start date to filter from |
| dateRange.to | date | yes | End date to filter to |
Example Request Body
json
{
"type":"IDV",
"dateRange": {
"from": "2024-01-01",
"to": "2024-09-25"
}
}{
"type":"IDV",
"dateRange": {
"from": "2024-01-01",
"to": "2024-09-25"
}
}Response
Content type
application/json
Response Body
| Name | Type | Description |
|---|---|---|
| requestId | string (uuid) | A Guid / uuid / A set of unique Alphanumerical characters assigned to this verification request. |
| status | boolean | Status of the request sent to verify |
| message | string or null | The message describing the status of the request |
Example Response Body
json
{
"requestId": "ff7f8d9b-1a07-4881-9d65-afc2fcb7694e",
"status": true,
"message": "The csv export message has been queued successfully"
}{
"requestId": "ff7f8d9b-1a07-4881-9d65-afc2fcb7694e",
"status": true,
"message": "The csv export message has been queued successfully"
}Error Response
400 Bad Request
application/json
| Name | Type | Description |
|---|---|---|
| type | string or null | Type of error response |
| title | string or null | The title of the error response |
| status | integer(int32) | The status of the error response |
| traceId | string or null | The traceId of the error request producing the error |
| errors | object | Object defining the errors |
errors
| Name | Type | Description |
|---|---|---|
| property | Array of strings | The definition of the errors |
401 Unauthorized
application/json
| Name | Type | Description |
|---|---|---|
| error | object(Error) | Type of error response |
Error
| Name | Type | Description |
|---|---|---|
| code | string or null | The Error code |
| message | string or null | The Error message |
403 Forbidden
application/json
| Name | Type | Description |
|---|---|---|
| error | object(Error) | Type of error response |
Error
| Name | Type | Description |
|---|---|---|
| code | string or null | The Error code |
| message | string or null | The Error message |
404 Not Found
application/json
| Name | Type | Description |
|---|---|---|
| error | object(Error) | Type of error response |
Error
| Name | Type | Description |
|---|---|---|
| code | string or null | The Error code |
| message | string or null | The Error message |
500 Server Error
application/json
| Name | Type | Description |
|---|---|---|
| error | object(Error) | Type of error response |
Error
| Name | Type | Description |
|---|---|---|
| code | string or null | The Error code |
| message | string or null | The Error message |