Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcStrVal
LOCAL lcValue
LOCAL lcTypeValue
LOCAL lcLabelValue
LOCAL lcValidationValue
LOCAL lcPlaceholderValue
LOCAL lcValidation_messageValue
LOCAL lcValueValue
LOCAL lcNameValue
LOCAL lcDescriptionValue
LOCAL lcId
LOCAL lcName
LOCAL lcV_type
LOCAL lcWebsite
LOCAL lcDisplay_name
LOCAL lcPrimary_color
LOCAL lcLogo
LOCAL lcIcon_logo
LOCAL lcText_logo
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "{{secretId}}"
loHttp.Password = "{{secretPassword}}"
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://domain.com/api/institutions/:id/",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "id": "<string>",
* "name": "<string>",
* "type": "nulla Excepteur nisi",
* "website": "<string>",
* "display_name": "<string>",
* "country_codes": [
* "<string>",
* "<string>"
* ],
* "primary_color": "<string>",
* "logo": "<string>",
* "icon_logo": "<string>",
* "text_logo": "<string>",
* "form_fields": [
* {
* "name": {
* "value": "<Error: Too many levels of nesting to fake this schema>"
* },
* "type": {
* "value": "<Error: Too many levels of nesting to fake this schema>"
* },
* "label": {
* "value": "<Error: Too many levels of nesting to fake this schema>"
* },
* "validation": {
* "value": "<Error: Too many levels of nesting to fake this schema>"
* },
* "placeholder": {
* "value": "<Error: Too many levels of nesting to fake this schema>"
* },
* "validation_message": {
* "value": "<Error: Too many levels of nesting to fake this schema>"
* },
* "value": {
* "value": "<Error: Too many levels of nesting to fake this schema>"
* }
* },
* {
* "name": {
* "value": "<Error: Too many levels of nesting to fake this schema>"
* },
* "type": {
* "value": "<Error: Too many levels of nesting to fake this schema>"
* },
* "label": {
* "value": "<Error: Too many levels of nesting to fake this schema>"
* },
* "validation": {
* "value": "<Error: Too many levels of nesting to fake this schema>"
* },
* "placeholder": {
* "value": "<Error: Too many levels of nesting to fake this schema>"
* },
* "validation_message": {
* "value": "<Error: Too many levels of nesting to fake this schema>"
* },
* "value": {
* "value": "<Error: Too many levels of nesting to fake this schema>"
* }
* }
* ],
* "features": [
* {
* "name": {
* "value": "<Error: Too many levels of nesting to fake this schema>"
* },
* "description": {
* "value": "<Error: Too many levels of nesting to fake this schema>"
* }
* },
* {
* "name": {
* "value": "<Error: Too many levels of nesting to fake this schema>"
* },
* "description": {
* "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
lcId = loJResp.StringOf("id")
lcName = loJResp.StringOf("name")
lcV_type = loJResp.StringOf("type")
lcWebsite = loJResp.StringOf("website")
lcDisplay_name = loJResp.StringOf("display_name")
lcPrimary_color = loJResp.StringOf("primary_color")
lcLogo = loJResp.StringOf("logo")
lcIcon_logo = loJResp.StringOf("icon_logo")
lcText_logo = loJResp.StringOf("text_logo")
i = 0
lnCount_i = loJResp.SizeOfArray("country_codes")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("country_codes[i]")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("form_fields")
DO WHILE i < lnCount_i
loJResp.I = i
lcValue = loJResp.StringOf("form_fields[i].name.value")
lcTypeValue = loJResp.StringOf("form_fields[i].type.value")
lcLabelValue = loJResp.StringOf("form_fields[i].label.value")
lcValidationValue = loJResp.StringOf("form_fields[i].validation.value")
lcPlaceholderValue = loJResp.StringOf("form_fields[i].placeholder.value")
lcValidation_messageValue = loJResp.StringOf("form_fields[i].validation_message.value")
lcValueValue = loJResp.StringOf("form_fields[i].value.value")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("features")
DO WHILE i < lnCount_i
loJResp.I = i
lcNameValue = loJResp.StringOf("features[i].name.value")
lcDescriptionValue = loJResp.StringOf("features[i].description.value")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -X GET
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/institutions/:id/
Postman Collection Item JSON
{
"name": "Detail",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/institutions/:id/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"institutions",
":id",
""
],
"variable": [
{
"key": "id",
"value": "consequa",
"description": "(Required) The `institution.id` you want to get detailed information about."
}
]
},
"description": "Get the details of a specific institution."
},
"response": [
{
"name": "Ok",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/institutions/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"institutions",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"id\": \"<string>\",\n\t\"name\": \"<string>\",\n\t\"type\": \"nulla Excepteur nisi\",\n\t\"website\": \"<string>\",\n\t\"display_name\": \"<string>\",\n\t\"country_codes\": [\n\t\t\"<string>\",\n\t\t\"<string>\"\n\t],\n\t\"primary_color\": \"<string>\",\n\t\"logo\": \"<string>\",\n\t\"icon_logo\": \"<string>\",\n\t\"text_logo\": \"<string>\",\n\t\"form_fields\": [\n\t\t{\n\t\t\t\"name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"type\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"label\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"validation\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"placeholder\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"validation_message\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"value\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"type\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"label\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"validation\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"placeholder\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"validation_message\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"value\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t}\n\t],\n\t\"features\": [\n\t\t{\n\t\t\t\"name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"description\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"description\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t}\n\t]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/institutions/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"institutions",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
},
{
"name": "Too Many Sessions",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/institutions/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"institutions",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
}
]
}
