Back to Collection Items
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node21-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node21-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node21-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node21-linux32');
} else {
var chilkat = require('@chilkat/ck-node21-linux64');
}
} else if (os.platform() == 'darwin') {
if (os.arch() == 'arm64') {
var chilkat = require('@chilkat/ck-node21-mac-m1');
} else {
var chilkat = require('@chilkat/ck-node21-macosx');
}
}
function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
var success;
http.BasicAuth = true;
http.Login = "{{secretId}}";
http.Password = "{{secretPassword}}";
var sbResponseBody = new chilkat.StringBuilder();
success = http.QuickGetSb("https://domain.com/api/institutions/:id/",sbResponseBody);
if (success == false) {
console.log(http.LastErrorText);
return;
}
var jResp = new chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
console.log("Response Body:");
console.log(jResp.Emit());
var respStatusCode = http.LastStatus;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
console.log("Response Header:");
console.log(http.LastHeader);
console.log("Failed.");
return;
}
// 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
var strVal;
var Value;
var typeValue;
var labelValue;
var validationValue;
var placeholderValue;
var validation_messageValue;
var valueValue;
var nameValue;
var descriptionValue;
var id = jResp.StringOf("id");
var name = jResp.StringOf("name");
var v_type = jResp.StringOf("type");
var website = jResp.StringOf("website");
var display_name = jResp.StringOf("display_name");
var primary_color = jResp.StringOf("primary_color");
var logo = jResp.StringOf("logo");
var icon_logo = jResp.StringOf("icon_logo");
var text_logo = jResp.StringOf("text_logo");
var i = 0;
var count_i = jResp.SizeOfArray("country_codes");
while (i < count_i) {
jResp.I = i;
strVal = jResp.StringOf("country_codes[i]");
i = i+1;
}
i = 0;
count_i = jResp.SizeOfArray("form_fields");
while (i < count_i) {
jResp.I = i;
Value = jResp.StringOf("form_fields[i].name.value");
typeValue = jResp.StringOf("form_fields[i].type.value");
labelValue = jResp.StringOf("form_fields[i].label.value");
validationValue = jResp.StringOf("form_fields[i].validation.value");
placeholderValue = jResp.StringOf("form_fields[i].placeholder.value");
validation_messageValue = jResp.StringOf("form_fields[i].validation_message.value");
valueValue = jResp.StringOf("form_fields[i].value.value");
i = i+1;
}
i = 0;
count_i = jResp.SizeOfArray("features");
while (i < count_i) {
jResp.I = i;
nameValue = jResp.StringOf("features[i].name.value");
descriptionValue = jResp.StringOf("features[i].description.value");
i = i+1;
}
}
chilkatExample();
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]"
}
]
}
