Coordinate Port Completion

This endpoint is in Beta. Some features may change as we receive and incorporate your feedback. We will notify you of any breaking changes before deploying them.

SUPPs

This endpoint is designed to allow users to request a new completion date for their Port Order. If the approve_lsr task in the coordinating_with_losing_service_provider state has not yet been started, then the desired_completion_date will automatically be updated and accepted. However, if the Port Order does have an active port request with the Losing Service Provider, then the Flowroute porting team will need to manually update the order in order to accept the desired_completion_date.

Endpoint

PATCH /portorders/:id

Request Parameters

  • desired_completion_datetime
    string

    DateTime of when you would ideally like for the Port Order to complete.

            

Example Request

curl https://api.flowroute.com/v2/portorders/899015 \
    -u accessKey:secretKey \
    -X PATCH
    -d "desired_completion_date": "2017-02-01"

                        

Example Response

{
  "data": {
    "links": {
      "self": "https://api.flowroute.com/v2/portorders/899015"
    },
    "type": "portorder",
    "id": "899015",
    "attributes": {
      "alias": "",
      "number_cost": "7.50",
      "total_cost": "7.50",
      "created_at": "2016-10-20T10:15:24Z",
      "updated_at": "2016-10-21T13:18:20Z",
      "notifications_email": [],
      "notifications_url": [],
      "desired_completion_date": "2017-02-01T16:00:00Z",
      "lsp_requested_completion_date": "",
      "firm_order_completion_date": "",
      "end_user_information": {}, "//...JSON condensed for readability...//"
      "service_address": {}, "//...JSON condensed for readability...//"
      "wireless_fields": {
        "last_four_ssn": "",
        "pin": ""
      },
      "loa": {}, "//...JSON condensed for readability...//"
      "uploaded_files": [], "//...JSON condensed for readability...//"
      "recommendations": [],
      "progress": {}, "//...JSON condensed for readability...//"
      "relationships": {
        "numbers": {} "//...JSON condensed for readability...//"
      }}},
  "included": [
    {
      "type": "number",
      "id": "12064205780",
      "links": {},
      "attributes": {} "//...JSON condensed for readability...//"
    }]}