Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "{{secretId}}"
$oHttp.Password = "{{secretPassword}}"
$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/api/institutions/:id/",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
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
Local $strVal
Local $sValue
Local $sTypeValue
Local $sLabelValue
Local $sValidationValue
Local $sPlaceholderValue
Local $sValidation_messageValue
Local $sValueValue
Local $sNameValue
Local $sDescriptionValue
Local $sId = $oJResp.StringOf("id")
Local $sName = $oJResp.StringOf("name")
Local $sV_type = $oJResp.StringOf("type")
Local $sWebsite = $oJResp.StringOf("website")
Local $sDisplay_name = $oJResp.StringOf("display_name")
Local $sPrimary_color = $oJResp.StringOf("primary_color")
Local $sLogo = $oJResp.StringOf("logo")
Local $sIcon_logo = $oJResp.StringOf("icon_logo")
Local $sText_logo = $oJResp.StringOf("text_logo")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("country_codes")
While $i < $iCount_i
$oJResp.I = $i
$strVal = $oJResp.StringOf("country_codes[i]")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("form_fields")
While $i < $iCount_i
$oJResp.I = $i
$sValue = $oJResp.StringOf("form_fields[i].name.value")
$sTypeValue = $oJResp.StringOf("form_fields[i].type.value")
$sLabelValue = $oJResp.StringOf("form_fields[i].label.value")
$sValidationValue = $oJResp.StringOf("form_fields[i].validation.value")
$sPlaceholderValue = $oJResp.StringOf("form_fields[i].placeholder.value")
$sValidation_messageValue = $oJResp.StringOf("form_fields[i].validation_message.value")
$sValueValue = $oJResp.StringOf("form_fields[i].value.value")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("features")
While $i < $iCount_i
$oJResp.I = $i
$sNameValue = $oJResp.StringOf("features[i].name.value")
$sDescriptionValue = $oJResp.StringOf("features[i].description.value")
$i = $i + 1
Wend
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]"
}
]
}
