List porting related reports

GET 
/porting/reports

List the reports generated about porting operations.

Request

Query Parameters

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load

page[size] integer

Possible values: >= 1 and <= 250

Default value: 20

The size of the page

filter[report_type] string

Possible values: [export_porting_orders_csv]

Filter reports of a specific type

filter[status] string

Possible values: [pending, completed]

Filter reports of a specific status

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

id uuid

Uniquely identifies the report.

report_type string

Possible values: [export_porting_orders_csv]

Identifies the type of report

status string

Possible values: [pending, completed]

The current status of the report generation.

params

object

oneOf

• ExportPortingOrdersCSVReport

filters

object

required

The filters to apply to the export porting order CSV report.

status__in string[]

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.

customer_reference__in string[]

The customer reference of the porting orders to include in the report.

created_at__lt date-time

The date and time the porting order was created before.

created_at__gt date-time

The date and time the porting order was created after.

The filters to apply to the export porting order CSV report.

document_id uuid

Identifies the document that was uploaded when report was generated. This field is only populated when the report is under completed status.

record_type string

Identifies the type of the resource.

created_at date-time

ISO 8601 formatted date indicating when the resource was created.

updated_at date-time

ISO 8601 formatted date indicating when the resource was updated.

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "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"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

422: Unprocessable entity. Check message field in response for details.

500: Internal server error

Loading...