Chilkat Online Tools

lianja / Core Services API / ListFastConnectProviderServices

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loHttp = createobject("CkHttp")

loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("compartmentId","{{compartment_ocid}}")
loQueryParams.UpdateInt("limit",801)
loQueryParams.UpdateString("page","laboris proident officia tempor")

loHttp.SetRequestHeader("Authorization","{{signature}}")
loHttp.SetRequestHeader("Date","{{date}}")

loResp = loHttp.QuickRequestParams("GET","https://iaas.{{region}}.oraclecloud.com/20160918/fastConnectProviderServices",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loQueryParams
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)

loJarrResp = createobject("CkJsonArray")
loJarrResp.LoadSb(loSbResponseBody)
loJarrResp.EmitCompact = .F.

? "Response Body:"
? loJarrResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loQueryParams
    release loSbResponseBody
    release loJarrResp
    return
endif

release loResp

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// [
//   {
//     "id": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "providerName": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "providerServiceName": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "type": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "privatePeeringBgpManagement": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "publicPeeringBgpManagement": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "customerAsnManagement": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "providerServiceKeyManagement": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "bandwithShapeManagement": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "requiredTotalCrossConnects": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "description": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "supportedVirtualCircuitTypes": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     }
//   },
//   {
//     "id": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "providerName": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "providerServiceName": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "type": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "privatePeeringBgpManagement": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "publicPeeringBgpManagement": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "customerAsnManagement": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "providerServiceKeyManagement": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "bandwithShapeManagement": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "requiredTotalCrossConnects": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "description": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "supportedVirtualCircuitTypes": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     }
//   }
// ]

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

i = 0
lnCount_i = loJarrResp.Size
do while i < lnCount_i
    loJson = loJarrResp.ObjectAt(i)
    lcValue = loJson.StringOf("id.value")
    lcProviderNameValue = loJson.StringOf("providerName.value")
    lcProviderServiceNameValue = loJson.StringOf("providerServiceName.value")
    lcTypeValue = loJson.StringOf("type.value")
    lcPrivatePeeringBgpManagementValue = loJson.StringOf("privatePeeringBgpManagement.value")
    lcPublicPeeringBgpManagementValue = loJson.StringOf("publicPeeringBgpManagement.value")
    lcCustomerAsnManagementValue = loJson.StringOf("customerAsnManagement.value")
    lcProviderServiceKeyManagementValue = loJson.StringOf("providerServiceKeyManagement.value")
    lcBandwithShapeManagementValue = loJson.StringOf("bandwithShapeManagement.value")
    lcRequiredTotalCrossConnectsValue = loJson.StringOf("requiredTotalCrossConnects.value")
    lcDescriptionValue = loJson.StringOf("description.value")
    lcSupportedVirtualCircuitTypesValue = loJson.StringOf("supportedVirtualCircuitTypes.value")
    release loJson
    i = i + 1
enddo


release loHttp
release loQueryParams
release loSbResponseBody
release loJarrResp

Curl Command

curl -G -d "compartmentId=%7B%7Bcompartment_ocid%7D%7D"
	-d "limit=801"
	-d "page=laboris%20proident%20officia%20tempor"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/fastConnectProviderServices

Postman Collection Item JSON

{
  "name": "ListFastConnectProviderServices",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Date",
        "value": "{{date}}",
        "description": "(Required) Current Date",
        "type": "text"
      },
      {
        "key": "Authorization",
        "value": "{{signature}}",
        "description": "(Required) Signature Authentication on Authorization header",
        "type": "text"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/fastConnectProviderServices?compartmentId={{compartment_ocid}}&limit=801&page=laboris proident officia tempor",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "fastConnectProviderServices"
      ],
      "query": [
        {
          "key": "compartmentId",
          "value": "{{compartment_ocid}}",
          "description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
        },
        {
          "key": "limit",
          "value": "801",
          "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
        },
        {
          "key": "page",
          "value": "laboris proident officia tempor",
          "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
        }
      ]
    },
    "description": "Lists the service offerings from supported providers. You need this\ninformation so you can specify your desired provider and service\noffering when you create a virtual circuit.\n\nFor the compartment ID, provide the [OCID](/Content/General/Concepts/identifiers.htm) of your tenancy (the root compartment).\n\nFor more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n"
  },
  "response": [
    {
      "name": "The list is being retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/fastConnectProviderServices?compartmentId=amet ut&limit=801&page=laboris proident officia tempor",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-next-page",
          "value": "officia sed",
          "description": "For list pagination. When this header appears in the response, additional pages\nof results remain. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
        },
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "[\n {\n  \"id\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"providerName\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"providerServiceName\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"type\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"privatePeeringBgpManagement\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"publicPeeringBgpManagement\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"customerAsnManagement\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"providerServiceKeyManagement\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"bandwithShapeManagement\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"requiredTotalCrossConnects\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"description\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"supportedVirtualCircuitTypes\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n },\n {\n  \"id\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"providerName\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"providerServiceName\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"type\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"privatePeeringBgpManagement\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"publicPeeringBgpManagement\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"customerAsnManagement\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"providerServiceKeyManagement\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"bandwithShapeManagement\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"requiredTotalCrossConnects\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"description\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"supportedVirtualCircuitTypes\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n }\n]"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/fastConnectProviderServices?compartmentId=amet ut&limit=801&page=laboris proident officia tempor",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Not Found",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/fastConnectProviderServices?compartmentId=amet ut&limit=801&page=laboris proident officia tempor",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Internal Server Error",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/fastConnectProviderServices?compartmentId=amet ut&limit=801&page=laboris proident officia tempor",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            }
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "An error has occurred.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/fastConnectProviderServices?compartmentId=amet ut&limit=801&page=laboris proident officia tempor",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            }
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    }
  ]
}