Chilkat Online Tools

SQL Server / Core Services API / GetFastConnectProviderService

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Authorization', '{{signature}}'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Date', '{{date}}'

    DECLARE @sbResponseBody int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://iaas.{{region}}.oraclecloud.com/20160918/fastConnectProviderServices/:providerServiceId', @sbResponseBody
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @sbResponseBody
        RETURN
      END

    DECLARE @jResp int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT

    EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
    EXEC sp_OASetProperty @jResp, 'EmitCompact', 0


    PRINT 'Response Body:'
    EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    DECLARE @respStatusCode int
    EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT

    PRINT 'Response Status Code = ' + @respStatusCode
    IF @respStatusCode >= 400
      BEGIN

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @sbResponseBody
        EXEC @hr = sp_OADestroy @jResp
        RETURN
      END

    -- 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

    DECLARE @strVal nvarchar(4000)

    DECLARE @id nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
    DECLARE @providerName nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @providerName OUT, 'providerName'
    DECLARE @providerServiceName nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @providerServiceName OUT, 'providerServiceName'
    DECLARE @v_type nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'type'
    DECLARE @privatePeeringBgpManagement nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @privatePeeringBgpManagement OUT, 'privatePeeringBgpManagement'
    DECLARE @publicPeeringBgpManagement nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @publicPeeringBgpManagement OUT, 'publicPeeringBgpManagement'
    DECLARE @customerAsnManagement nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @customerAsnManagement OUT, 'customerAsnManagement'
    DECLARE @providerServiceKeyManagement nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @providerServiceKeyManagement OUT, 'providerServiceKeyManagement'
    DECLARE @bandwithShapeManagement nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @bandwithShapeManagement OUT, 'bandwithShapeManagement'
    DECLARE @requiredTotalCrossConnects int
    EXEC sp_OAMethod @jResp, 'IntOf', @requiredTotalCrossConnects OUT, 'requiredTotalCrossConnects'
    DECLARE @description nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'description'
    DECLARE @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'supportedVirtualCircuitTypes'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jResp, 'I', @i
        EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'supportedVirtualCircuitTypes[i]'
        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @sbResponseBody
    EXEC @hr = sp_OADestroy @jResp


END
GO

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}"
    }
  ]
}