Chilkat Online Tools

C / Core Services API / GetDhcpOptions

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *value;
    const char *id;
    const char *compartmentId;
    const char *lifecycleState;
    const char *timeCreated;
    const char *vcnId;
    const char *displayName;
    int i;
    int count_i;

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

    http = CkHttp_Create();

    CkHttp_SetRequestHeader(http,"Authorization","{{signature}}");
    CkHttp_SetRequestHeader(http,"Date","{{date}}");

    sbResponseBody = CkStringBuilder_Create();
    success = CkHttp_QuickGetSb(http,"https://iaas.{{region}}.oraclecloud.com/20160918/dhcps/:dhcpId",sbResponseBody);
    if (success == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttp_getLastStatus(http);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttp_lastHeader(http));
        printf("Failed.\n");
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

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

    // {
    //   "id": "tempor dolor",
    //   "compartmentId": "eu id Duis Excepteur",
    //   "options": [
    //     {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     }
    //   ],
    //   "lifecycleState": "TERMINATING",
    //   "timeCreated": "1956-02-12T08:38:20.357Z",
    //   "vcnId": "aute",
    //   "definedTags": {},
    //   "displayName": "dolor incididunt deserunt",
    //   "freeformTags": {}
    // }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    id = CkJsonObject_stringOf(jResp,"id");
    compartmentId = CkJsonObject_stringOf(jResp,"compartmentId");
    lifecycleState = CkJsonObject_stringOf(jResp,"lifecycleState");
    timeCreated = CkJsonObject_stringOf(jResp,"timeCreated");
    vcnId = CkJsonObject_stringOf(jResp,"vcnId");
    displayName = CkJsonObject_stringOf(jResp,"displayName");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"options");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        value = CkJsonObject_stringOf(jResp,"options[i].value");
        i = i + 1;
    }



    CkHttp_Dispose(http);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

Curl Command

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

Postman Collection Item JSON

{
  "name": "GetDhcpOptions",
  "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}}/dhcps/:dhcpId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "dhcps",
        ":dhcpId"
      ],
      "variable": [
        {
          "key": "dhcpId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) for the set of DHCP options."
        }
      ]
    },
    "description": "Gets the specified set of DHCP options."
  },
  "response": [
    {
      "name": "The set of DHCP options was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/dhcps/:dhcpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "dhcps",
            ":dhcpId"
          ],
          "variable": [
            {
              "key": "dhcpId"
            }
          ]
        }
      },
      "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 \"id\": \"tempor dolor\",\n \"compartmentId\": \"eu id Duis Excepteur\",\n \"options\": [\n  {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n ],\n \"lifecycleState\": \"TERMINATING\",\n \"timeCreated\": \"1956-02-12T08:38:20.357Z\",\n \"vcnId\": \"aute\",\n \"definedTags\": {},\n \"displayName\": \"dolor incididunt deserunt\",\n \"freeformTags\": {}\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/dhcps/:dhcpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "dhcps",
            ":dhcpId"
          ],
          "variable": [
            {
              "key": "dhcpId"
            }
          ]
        }
      },
      "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}}/dhcps/:dhcpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "dhcps",
            ":dhcpId"
          ],
          "variable": [
            {
              "key": "dhcpId"
            }
          ]
        }
      },
      "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}}/dhcps/:dhcpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "dhcps",
            ":dhcpId"
          ],
          "variable": [
            {
              "key": "dhcpId"
            }
          ]
        }
      },
      "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}}/dhcps/:dhcpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "dhcps",
            ":dhcpId"
          ],
          "variable": [
            {
              "key": "dhcpId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}