Chilkat Online Tools

DataFlex / Core Services API / GetFastConnectProviderServiceKey

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sName
    String sBandwidthShapeName
    String sPeeringLocation
    String sTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    Send ComSetRequestHeader To hoHttp "Authorization" "{{signature}}"
    Send ComSetRequestHeader To hoHttp "Date" "{{date}}"

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComQuickGetSb Of hoHttp "https://iaas.{{region}}.oraclecloud.com/20160918/fastConnectProviderServices/:providerServiceId/providerServiceKeys/:providerServiceKeyName" vSbResponseBody To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComLastStatus Of hoHttp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComLastHeader Of hoHttp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Procedure_Return
    End

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

    // {
    //   "name": "laboru",
    //   "bandwidthShapeName": "nulla fugiat",
    //   "peeringLocation": "Ut"
    // }

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

    Get ComStringOf Of hoJResp "name" To sName
    Get ComStringOf Of hoJResp "bandwidthShapeName" To sBandwidthShapeName
    Get ComStringOf Of hoJResp "peeringLocation" To sPeeringLocation


End_Procedure

Curl Command

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

Postman Collection Item JSON

{
  "name": "GetFastConnectProviderServiceKey",
  "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/providerServiceKeys/:providerServiceKeyName",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "fastConnectProviderServices",
        ":providerServiceId",
        "providerServiceKeys",
        ":providerServiceKeyName"
      ],
      "variable": [
        {
          "key": "providerServiceId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the provider service."
        },
        {
          "key": "providerServiceKeyName",
          "value": "amet ut",
          "description": "(Required) The provider service key that the provider gives you when you set up a virtual circuit connection\nfrom the provider to Oracle Cloud Infrastructure. You can set up that connection and get your\nprovider service key at the provider's website or portal. For the portal location, see the `description`\nattribute of the [FastConnectProviderService](#/en/iaas/latest/FastConnectProviderService/).\n"
        }
      ]
    },
    "description": "Gets the specified provider service key's information. Use this operation to validate a\nprovider service key. An invalid key returns a 404 error.\n"
  },
  "response": [
    {
      "name": "The provider service key name is being retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/fastConnectProviderServices/:providerServiceId/providerServiceKeys/:providerServiceKeyName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices",
            ":providerServiceId",
            "providerServiceKeys",
            ":providerServiceKeyName"
          ],
          "variable": [
            {
              "key": "providerServiceId"
            },
            {
              "key": "providerServiceKeyName"
            }
          ]
        }
      },
      "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 \"name\": \"laboru\",\n \"bandwidthShapeName\": \"nulla fugiat\",\n \"peeringLocation\": \"Ut\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/fastConnectProviderServices/:providerServiceId/providerServiceKeys/:providerServiceKeyName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices",
            ":providerServiceId",
            "providerServiceKeys",
            ":providerServiceKeyName"
          ],
          "variable": [
            {
              "key": "providerServiceId"
            },
            {
              "key": "providerServiceKeyName"
            }
          ]
        }
      },
      "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/providerServiceKeys/:providerServiceKeyName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices",
            ":providerServiceId",
            "providerServiceKeys",
            ":providerServiceKeyName"
          ],
          "variable": [
            {
              "key": "providerServiceId"
            },
            {
              "key": "providerServiceKeyName"
            }
          ]
        }
      },
      "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/providerServiceKeys/:providerServiceKeyName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices",
            ":providerServiceId",
            "providerServiceKeys",
            ":providerServiceKeyName"
          ],
          "variable": [
            {
              "key": "providerServiceId"
            },
            {
              "key": "providerServiceKeyName"
            }
          ]
        }
      },
      "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/providerServiceKeys/:providerServiceKeyName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices",
            ":providerServiceId",
            "providerServiceKeys",
            ":providerServiceKeyName"
          ],
          "variable": [
            {
              "key": "providerServiceId"
            },
            {
              "key": "providerServiceKeyName"
            }
          ]
        }
      },
      "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/providerServiceKeys/:providerServiceKeyName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices",
            ":providerServiceId",
            "providerServiceKeys",
            ":providerServiceKeyName"
          ],
          "variable": [
            {
              "key": "providerServiceId"
            },
            {
              "key": "providerServiceKeyName"
            }
          ]
        }
      },
      "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}"
    }
  ]
}