Chilkat Online Tools

SQL Server / Core Services API / GetAppCatalogListing

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/appCatalogListings/:listingId', @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)

    -- {
    --   "contactUrl": "officia eiusmod est irure in",
    --   "description": "Excepteur ex",
    --   "displayName": "irure consectetur Lorem Duis",
    --   "listingId": "tempor amet occaecat anim",
    --   "publisherLogoUrl": "consectetur Lorem sunt",
    --   "publisherName": "in nostrud occaecat commodo",
    --   "summary": "non in sed est ad",
    --   "timePublished": "1960-12-14T17:05:59.907Z"
    -- }

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

    DECLARE @contactUrl nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @contactUrl OUT, 'contactUrl'
    DECLARE @description nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'description'
    DECLARE @displayName nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @displayName OUT, 'displayName'
    DECLARE @listingId nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @listingId OUT, 'listingId'
    DECLARE @publisherLogoUrl nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @publisherLogoUrl OUT, 'publisherLogoUrl'
    DECLARE @publisherName nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @publisherName OUT, 'publisherName'
    DECLARE @summary nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @summary OUT, 'summary'
    DECLARE @timePublished nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @timePublished OUT, 'timePublished'

    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/appCatalogListings/:listingId

Postman Collection Item JSON

{
  "name": "GetAppCatalogListing",
  "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}}/appCatalogListings/:listingId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "appCatalogListings",
        ":listingId"
      ],
      "variable": [
        {
          "key": "listingId",
          "value": "officia sed",
          "description": "(Required) The OCID of the listing."
        }
      ]
    },
    "description": "Gets the specified listing."
  },
  "response": [
    {
      "name": "The listing was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/appCatalogListings/:listingId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "appCatalogListings",
            ":listingId"
          ],
          "variable": [
            {
              "key": "listingId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "etag",
          "value": "officia sed",
          "description": "For optimistic concurrency control. See `if-match`.\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 \"contactUrl\": \"officia eiusmod est irure in\",\n \"description\": \"Excepteur ex\",\n \"displayName\": \"irure consectetur Lorem Duis\",\n \"listingId\": \"tempor amet occaecat anim\",\n \"publisherLogoUrl\": \"consectetur Lorem sunt\",\n \"publisherName\": \"in nostrud occaecat commodo\",\n \"summary\": \"non in sed est ad\",\n \"timePublished\": \"1960-12-14T17:05:59.907Z\"\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/appCatalogListings/:listingId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "appCatalogListings",
            ":listingId"
          ],
          "variable": [
            {
              "key": "listingId"
            }
          ]
        }
      },
      "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}}/appCatalogListings/:listingId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "appCatalogListings",
            ":listingId"
          ],
          "variable": [
            {
              "key": "listingId"
            }
          ]
        }
      },
      "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}}/appCatalogListings/:listingId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "appCatalogListings",
            ":listingId"
          ],
          "variable": [
            {
              "key": "listingId"
            }
          ]
        }
      },
      "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}}/appCatalogListings/:listingId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "appCatalogListings",
            ":listingId"
          ],
          "variable": [
            {
              "key": "listingId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}