Chilkat Online Tools

PureBasic / Core Services API / GetFastConnectProviderService

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::ckSetRequestHeader(http,"Authorization","{{signature}}")
    CkHttp::ckSetRequestHeader(http,"Date","{{date}}")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://iaas.{{region}}.oraclecloud.com/20160918/fastConnectProviderServices/:providerServiceId",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

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

    ; {
    ;   "id": "ut officia voluptate minim",
    ;   "providerName": "occaecat mag",
    ;   "providerServiceName": "magna aliqua occaecat laborum",
    ;   "type": "LAYER3",
    ;   "privatePeeringBgpManagement": "ORACLE_MANAGED",
    ;   "publicPeeringBgpManagement": "PROVIDER_MANAGED",
    ;   "customerAsnManagement": "PROVIDER_MANAGED",
    ;   "providerServiceKeyManagement": "CUSTOMER_MANAGED",
    ;   "bandwithShapeManagement": "CUSTOMER_MANAGED",
    ;   "requiredTotalCrossConnects": 31215616,
    ;   "description": "ut Duis ullamco laborum",
    ;   "supportedVirtualCircuitTypes": [
    ;     "PRIVATE",
    ;     "PUBLIC"
    ;   ]
    ; }

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

    strVal.s

    id.s = CkJsonObject::ckStringOf(jResp,"id")
    providerName.s = CkJsonObject::ckStringOf(jResp,"providerName")
    providerServiceName.s = CkJsonObject::ckStringOf(jResp,"providerServiceName")
    v_type.s = CkJsonObject::ckStringOf(jResp,"type")
    privatePeeringBgpManagement.s = CkJsonObject::ckStringOf(jResp,"privatePeeringBgpManagement")
    publicPeeringBgpManagement.s = CkJsonObject::ckStringOf(jResp,"publicPeeringBgpManagement")
    customerAsnManagement.s = CkJsonObject::ckStringOf(jResp,"customerAsnManagement")
    providerServiceKeyManagement.s = CkJsonObject::ckStringOf(jResp,"providerServiceKeyManagement")
    bandwithShapeManagement.s = CkJsonObject::ckStringOf(jResp,"bandwithShapeManagement")
    requiredTotalCrossConnects.i = CkJsonObject::ckIntOf(jResp,"requiredTotalCrossConnects")
    description.s = CkJsonObject::ckStringOf(jResp,"description")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"supportedVirtualCircuitTypes")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        strVal = CkJsonObject::ckStringOf(jResp,"supportedVirtualCircuitTypes[i]")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

curl -X GET
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/fastConnectProviderServices/:providerServiceId

Postman Collection Item JSON

{
  "name": "GetFastConnectProviderService",
  "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/:providerServiceId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "fastConnectProviderServices",
        ":providerServiceId"
      ],
      "variable": [
        {
          "key": "providerServiceId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the provider service."
        }
      ]
    },
    "description": "Gets the specified provider service.\nFor more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n"
  },
  "response": [
    {
      "name": "The provider service is being retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/fastConnectProviderServices/:providerServiceId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices",
            ":providerServiceId"
          ],
          "variable": [
            {
              "key": "providerServiceId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_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 \"id\": \"ut officia voluptate minim\",\n \"providerName\": \"occaecat mag\",\n \"providerServiceName\": \"magna aliqua occaecat laborum\",\n \"type\": \"LAYER3\",\n \"privatePeeringBgpManagement\": \"ORACLE_MANAGED\",\n \"publicPeeringBgpManagement\": \"PROVIDER_MANAGED\",\n \"customerAsnManagement\": \"PROVIDER_MANAGED\",\n \"providerServiceKeyManagement\": \"CUSTOMER_MANAGED\",\n \"bandwithShapeManagement\": \"CUSTOMER_MANAGED\",\n \"requiredTotalCrossConnects\": 31215616,\n \"description\": \"ut Duis ullamco laborum\",\n \"supportedVirtualCircuitTypes\": [\n  \"PRIVATE\",\n  \"PUBLIC\"\n ]\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/fastConnectProviderServices/:providerServiceId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices",
            ":providerServiceId"
          ],
          "variable": [
            {
              "key": "providerServiceId"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_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": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/fastConnectProviderServices/:providerServiceId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices",
            ":providerServiceId"
          ],
          "variable": [
            {
              "key": "providerServiceId"
            }
          ]
        }
      },
      "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/:providerServiceId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices",
            ":providerServiceId"
          ],
          "variable": [
            {
              "key": "providerServiceId"
            }
          ]
        }
      },
      "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/:providerServiceId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices",
            ":providerServiceId"
          ],
          "variable": [
            {
              "key": "providerServiceId"
            }
          ]
        }
      },
      "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/:providerServiceId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices",
            ":providerServiceId"
          ],
          "variable": [
            {
              "key": "providerServiceId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}