Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sStrVal
String sValue
String sTypeValue
String sLabelValue
String sValidationValue
String sPlaceholderValue
String sValidation_messageValue
String sValueValue
String sNameValue
String sDescriptionValue
String sId
String sName
String sV_type
String sWebsite
String sDisplay_name
String sPrimary_color
String sLogo
String sIcon_logo
String sText_logo
Integer i
Integer iCount_i
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Set ComBasicAuth Of hoHttp To True
Set ComLogin Of hoHttp To "{{secretId}}"
Set ComPassword Of hoHttp To "{{secretPassword}}"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://domain.com/api/institutions/:id/" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// 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
Get ComStringOf Of hoJResp "id" To sId
Get ComStringOf Of hoJResp "name" To sName
Get ComStringOf Of hoJResp "type" To sV_type
Get ComStringOf Of hoJResp "website" To sWebsite
Get ComStringOf Of hoJResp "display_name" To sDisplay_name
Get ComStringOf Of hoJResp "primary_color" To sPrimary_color
Get ComStringOf Of hoJResp "logo" To sLogo
Get ComStringOf Of hoJResp "icon_logo" To sIcon_logo
Get ComStringOf Of hoJResp "text_logo" To sText_logo
Move 0 To i
Get ComSizeOfArray Of hoJResp "country_codes" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "country_codes[i]" To sStrVal
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "form_fields" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "form_fields[i].name.value" To sValue
Get ComStringOf Of hoJResp "form_fields[i].type.value" To sTypeValue
Get ComStringOf Of hoJResp "form_fields[i].label.value" To sLabelValue
Get ComStringOf Of hoJResp "form_fields[i].validation.value" To sValidationValue
Get ComStringOf Of hoJResp "form_fields[i].placeholder.value" To sPlaceholderValue
Get ComStringOf Of hoJResp "form_fields[i].validation_message.value" To sValidation_messageValue
Get ComStringOf Of hoJResp "form_fields[i].value.value" To sValueValue
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "features" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "features[i].name.value" To sNameValue
Get ComStringOf Of hoJResp "features[i].description.value" To sDescriptionValue
Move (i + 1) To i
Loop
End_Procedure
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]"
}
]
}
