Chilkat Online Tools

PureBasic / Core Services API / ListDrgRouteDistributionStatements

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkJsonArray.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    queryParams.i = CkJsonObject::ckCreate()
    If queryParams.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateInt(queryParams,"limit",801)
    CkJsonObject::ckUpdateString(queryParams,"page","laboris proident officia tempor")
    CkJsonObject::ckUpdateString(queryParams,"sortBy","TIMECREATED")
    CkJsonObject::ckUpdateString(queryParams,"sortOrder","DESC")

    CkHttp::ckSetRequestHeader(http,"Authorization","{{signature}}")
    CkHttp::ckSetRequestHeader(http,"Date","{{date}}")

    resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://iaas.{{region}}.oraclecloud.com/20160918/drgRouteDistributions/:drgRouteDistributionId/drgRouteDistributionStatements",queryParams)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    jarrResp.i = CkJsonArray::ckCreate()
    If jarrResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonArray::ckLoadSb(jarrResp,sbResponseBody)
    CkJsonArray::setCkEmitCompact(jarrResp, 0)

    Debug "Response Body:"
    Debug CkJsonArray::ckEmit(jarrResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonArray::ckDispose(jarrResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

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

    ; [
    ;   {
    ;     "matchCriteria": {
    ;       "value": "<Error: Too many levels of nesting to fake this schema>"
    ;     },
    ;     "action": {
    ;       "value": "<Error: Too many levels of nesting to fake this schema>"
    ;     },
    ;     "priority": {
    ;       "value": "<Error: Too many levels of nesting to fake this schema>"
    ;     },
    ;     "id": {
    ;       "value": "<Error: Too many levels of nesting to fake this schema>"
    ;     }
    ;   },
    ;   {
    ;     "matchCriteria": {
    ;       "value": "<Error: Too many levels of nesting to fake this schema>"
    ;     },
    ;     "action": {
    ;       "value": "<Error: Too many levels of nesting to fake this schema>"
    ;     },
    ;     "priority": {
    ;       "value": "<Error: Too many levels of nesting to fake this schema>"
    ;     },
    ;     "id": {
    ;       "value": "<Error: Too many levels of nesting to fake this schema>"
    ;     }
    ;   }
    ; ]

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

    json.i
    Value.s
    actionValue.s
    priorityValue.s
    idValue.s

    i.i = 0
    count_i.i = CkJsonArray::ckSize(jarrResp)
    While i < count_i
        json = CkJsonArray::ckObjectAt(jarrResp,i)
        Value = CkJsonObject::ckStringOf(json,"matchCriteria.value")
        actionValue = CkJsonObject::ckStringOf(json,"action.value")
        priorityValue = CkJsonObject::ckStringOf(json,"priority.value")
        idValue = CkJsonObject::ckStringOf(json,"id.value")
        CkJsonObject::ckDispose(json)

        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(queryParams)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonArray::ckDispose(jarrResp)


    ProcedureReturn
EndProcedure

Curl Command

curl -G -d "limit=801"
	-d "page=laboris%20proident%20officia%20tempor"
	-d "sortBy=TIMECREATED"
	-d "sortOrder=DESC"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/drgRouteDistributions/:drgRouteDistributionId/drgRouteDistributionStatements

Postman Collection Item JSON

{
  "name": "ListDrgRouteDistributionStatements",
  "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}}/drgRouteDistributions/:drgRouteDistributionId/drgRouteDistributionStatements?limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "drgRouteDistributions",
        ":drgRouteDistributionId",
        "drgRouteDistributionStatements"
      ],
      "query": [
        {
          "key": "limit",
          "value": "801",
          "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
        },
        {
          "key": "page",
          "value": "laboris proident officia tempor",
          "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
        },
        {
          "key": "sortBy",
          "value": "TIMECREATED",
          "description": "The field to sort by."
        },
        {
          "key": "sortOrder",
          "value": "DESC",
          "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
        }
      ],
      "variable": [
        {
          "key": "drgRouteDistributionId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
        }
      ]
    },
    "description": "Lists the statements for the specified route distribution."
  },
  "response": [
    {
      "name": "The list is being retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/drgRouteDistributions/:drgRouteDistributionId/drgRouteDistributionStatements?limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "drgRouteDistributions",
            ":drgRouteDistributionId",
            "drgRouteDistributionStatements"
          ],
          "query": [
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ],
          "variable": [
            {
              "key": "drgRouteDistributionId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-next-page",
          "value": "officia sed",
          "description": "For list pagination. When this header appears in the response, additional pages\nof results remain. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\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 {\n  \"matchCriteria\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"action\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"priority\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"id\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n },\n {\n  \"matchCriteria\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"action\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"priority\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"id\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n }\n]"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/drgRouteDistributions/:drgRouteDistributionId/drgRouteDistributionStatements?limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "drgRouteDistributions",
            ":drgRouteDistributionId",
            "drgRouteDistributionStatements"
          ],
          "query": [
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ],
          "variable": [
            {
              "key": "drgRouteDistributionId"
            }
          ]
        }
      },
      "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}}/drgRouteDistributions/:drgRouteDistributionId/drgRouteDistributionStatements?limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "drgRouteDistributions",
            ":drgRouteDistributionId",
            "drgRouteDistributionStatements"
          ],
          "query": [
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ],
          "variable": [
            {
              "key": "drgRouteDistributionId"
            }
          ]
        }
      },
      "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}}/drgRouteDistributions/:drgRouteDistributionId/drgRouteDistributionStatements?limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "drgRouteDistributions",
            ":drgRouteDistributionId",
            "drgRouteDistributionStatements"
          ],
          "query": [
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ],
          "variable": [
            {
              "key": "drgRouteDistributionId"
            }
          ]
        }
      },
      "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}}/drgRouteDistributions/:drgRouteDistributionId/drgRouteDistributionStatements?limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "drgRouteDistributions",
            ":drgRouteDistributionId",
            "drgRouteDistributionStatements"
          ],
          "query": [
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ],
          "variable": [
            {
              "key": "drgRouteDistributionId"
            }
          ]
        }
      },
      "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}}/drgRouteDistributions/:drgRouteDistributionId/drgRouteDistributionStatements?limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "drgRouteDistributions",
            ":drgRouteDistributionId",
            "drgRouteDistributionStatements"
          ],
          "query": [
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ],
          "variable": [
            {
              "key": "drgRouteDistributionId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}