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
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'API-Key', '{{API_KEY}}'
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://api.shipengine.com/v1/carriers/se-963358/options', @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
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.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)
-- {
-- "options": [
-- {
-- "name": "bill_to_account",
-- "default_value": "",
-- "description": ""
-- },
-- {
-- "name": "bill_to_country_code",
-- "default_value": "",
-- "description": ""
-- },
-- {
-- "name": "bill_to_party",
-- "default_value": "",
-- "description": ""
-- },
-- {
-- "name": "bill_to_postal_code",
-- "default_value": "",
-- "description": ""
-- },
-- {
-- "name": "contains_alcohol",
-- "default_value": "false",
-- "description": ""
-- },
-- {
-- "name": "delivered_duty_paid",
-- "default_value": "false",
-- "description": ""
-- },
-- {
-- "name": "dry_ice",
-- "default_value": "false",
-- "description": ""
-- },
-- {
-- "name": "dry_ice_weight",
-- "default_value": "0",
-- "description": ""
-- },
-- {
-- "name": "freight_class",
-- "default_value": "",
-- "description": ""
-- },
-- {
-- "name": "non_machinable",
-- "default_value": "false",
-- "description": ""
-- },
-- {
-- "name": "saturday_delivery",
-- "default_value": "false",
-- "description": ""
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @name nvarchar(4000)
DECLARE @default_value nvarchar(4000)
DECLARE @description nvarchar(4000)
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'options'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'options[i].name'
EXEC sp_OAMethod @jResp, 'StringOf', @default_value OUT, 'options[i].default_value'
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'options[i].description'
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 "API-Key: {{API_KEY}}"
https://api.shipengine.com/v1/carriers/se-963358/options
Postman Collection Item JSON
{
"name": "List a carrier's options",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let response = pm.response.json();",
"",
"if (response.options.length > 0) {",
" const template = `",
" <link rel=\"stylesheet\" href=\"https://cdnjs.cloudflare.com/ajax/libs/meyer-reset/2.0/reset.min.css\">",
" <link rel=\"stylesheet\" href=\"https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css\">",
" ",
" <h1>Carrier Options</h1>",
" <table class=\"table\" style=\"max-width: 600px\">",
" <thead class=\"thead-dark\">",
" <tr>",
" <th>Option</th>",
" <th>Default Value</th>",
" </tr>",
" </thead>",
" <tbody>",
" {{#each options}}",
" <tr>",
" <td>",
" <samp>{{name}}</samp>",
" </td>",
" <td>{{default_value}}</td>",
" </tr>",
" {{/each}}",
" </tbody>",
" </table>",
" `;",
" ",
" pm.visualizer.set(template, response);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.shipengine.com/v1/carriers/{{ups}}/options",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"carriers",
"{{ups}}",
"options"
]
},
"description": "Many carriers support \"advanced options\", such as the ability to ship alcohol, bill to the receiving party, request money on delivery, or many others. This request shows you how to list the options that are supported by a carrier."
},
"response": [
{
"name": "List a carrier's options",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.shipengine.com/v1/carriers/{{ups}}/options",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"carriers",
"{{ups}}",
"options"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Tue, 17 Sep 2019 14:56:45 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "1174"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "54453653-caa0-4bb3-bcca-c86dd8a44317"
}
],
"cookie": [
],
"body": "{\n \"options\": [\n {\n \"name\": \"bill_to_account\",\n \"default_value\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"bill_to_country_code\",\n \"default_value\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"bill_to_party\",\n \"default_value\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"bill_to_postal_code\",\n \"default_value\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"contains_alcohol\",\n \"default_value\": \"false\",\n \"description\": \"\"\n },\n {\n \"name\": \"delivered_duty_paid\",\n \"default_value\": \"false\",\n \"description\": \"\"\n },\n {\n \"name\": \"dry_ice\",\n \"default_value\": \"false\",\n \"description\": \"\"\n },\n {\n \"name\": \"dry_ice_weight\",\n \"default_value\": \"0\",\n \"description\": \"\"\n },\n {\n \"name\": \"freight_class\",\n \"default_value\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"non_machinable\",\n \"default_value\": \"false\",\n \"description\": \"\"\n },\n {\n \"name\": \"saturday_delivery\",\n \"default_value\": \"false\",\n \"description\": \"\"\n }\n ]\n}"
}
]
}
