Skip to main content

Create a porting related report

POST 

/porting/reports

Generate reports about porting operations.

Request

Body

required

    report_type stringrequired

    Possible values: [export_porting_orders_csv]

    Identifies the type of report

    params

    object

    required

    oneOf

    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.

Responses

201: Successful response

Schema

    data

    object

    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

    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.

    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.

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

500: Internal server error

Loading...