Retrieve a report
GET/porting/reports/:id
Retrieve a specific report generated.
Request
Path Parameters
Identifies a report.
Responses
200: Successful response
- application/json
- Schema
- Example (from schema)
Schema
- ExportPortingOrdersCSVReport
data
object
Uniquely identifies the report.
Possible values: [export_porting_orders_csv
]
Identifies the type of report
Possible values: [pending
, completed
]
The current status of the report generation.
params
object
oneOf
filters
object
required
The filters to apply to the export porting order CSV report.
Possible values: [draft
, in-process
, submitted
, exception
, foc-date-confirmed
, cancel-pending
, ported
, cancelled
]
The status of the porting orders to include in the report.
The customer reference of the porting orders to include in the report.
The date and time the porting order was created before.
The date and time the porting order was created after.
The filters to apply to the export porting order CSV report.
Identifies the document that was uploaded when report was generated. This field is only populated when the report is under completed status.
Identifies the type of the resource.
ISO 8601 formatted date indicating when the resource was created.
ISO 8601 formatted date indicating when the resource was updated.
{
"data": {
"id": "eef3340b-8903-4466-b445-89b697315a3a",
"report_type": "export_porting_orders_csv",
"status": "completed",
"params": {},
"document_id": "f1486bae-f067-460c-ad43-73a92848f902",
"record_type": "porting_report",
"created_at": "2021-03-19T10:07:15.527000Z",
"updated_at": "2021-03-19T10:07:15.527000Z"
}
}
404: Resource not found
500: Internal server error