Retrieve a list of portout requests

v1.0.0

Returns the portout requests according to filters

Input

{
  "type": "object",
  "properties": {
    "filter[carrier_name]": {
      "type": "string"
    },
    "filter[spid]": {
      "type": "string"
    },
    "filter[status]": {
      "type": "string",
      "enum": [
        "pending",
        "authorized",
        "ported",
        "rejected",
        "rejected-pending",
        "canceled"
      ]
    },
    "page[number]": {
      "type": "integer"
    },
    "page[size]": {
      "type": "integer"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "carrier_name": {
            "type": "string",
            "description": "Carrier the number will be ported out to"
          },
          "created_at": {
            "type": "string",
            "description": "ISO 8601 formatted date of when the portout was created"
          },
          "foc_date": {
            "type": "string",
            "description": "ISO 8601 formatted Date/Time of the FOC date"
          },
          "id": {
            "type": "string"
          },
          "phone_numbers": {
            "type": "array",
            "description": "Phone numbers associated with this portout",
            "items": {
              "type": "string",
              "description": "E164 formatted phone number"
            }
          },
          "record_type": {
            "type": "string",
            "description": "Identifies the type of the resource."
          },
          "requested_foc_date": {
            "type": "string",
            "description": "ISO 8601 formatted Date/Time of the user requested FOC date"
          },
          "spid": {
            "type": "string",
            "description": "New service provider spid"
          },
          "status": {
            "type": "string",
            "description": "Status of portout request",
            "enum": [
              "pending",
              "authorized",
              "ported",
              "rejected",
              "rejected-pending",
              "canceled"
            ]
          },
          "updated_at": {
            "type": "string",
            "description": "ISO 8601 formatted date of when the portout was last updated"
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "page_number": {
          "type": "number",
          "format": "double",
          "description": "Current Page based on pagination settings (included when defaults are used.)"
        },
        "page_size": {
          "type": "number",
          "format": "double",
          "description": "Number of results to return per page based on pagination settings (included when defaults are used.)"
        },
        "total_pages": {
          "type": "number",
          "format": "double",
          "description": "Total number of pages based on pagination settings"
        },
        "total_results": {
          "type": "number",
          "format": "double",
          "description": "Total number of results"
        }
      }
    }
  }
}