StreamlineAppearance
Get CSV Export Status
Retrieves CSV Export status.
Endpoints
| Environment | API Endpoint |
|---|---|
| Sandbox | https://onprem-test.streamline.laboremus.ug/api/exports/{id}/status |
Request
Request Type : GET
Authorization
INFO
Always add your Subscription key to the request.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| v | string | yes | The version of the API |
Path Parameters Values
| Name | Type | Required | Description |
|---|---|---|---|
| id | string(uuid) | yes | The Unique ID of a CSV report |
Response
Content type
application/json
Response Body
| Name | Type | Description |
|---|---|---|
| id | string (uuid) | A Guid / uuid / A set of unique Alphanumerical characters assigned to this verification request. |
| requestUri | string or null | The URL to find the request |
| status | string(Enum : Pending, Completed, Failed) | Status of the request sent to verify |
Example Response Body
json
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"requestUri": "string",
"status": "Processing"
}{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"requestUri": "string",
"status": "Processing"
}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 |