Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW queryParams;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *title;
const wchar_t *description;
const wchar_t *Id;
const wchar_t *Name;
const wchar_t *v_Type;
const wchar_t *Is_default;
const wchar_t *Default_payment_accountId;
const wchar_t *Default_payment_accountName;
const wchar_t *Default_payment_accountType;
const wchar_t *Iban;
const wchar_t *Sia;
const wchar_t *Cuc;
const wchar_t *v_Virtual;
const wchar_t *Bank_iban;
const wchar_t *Bank_name;
const wchar_t *Bank_beneficiary;
const wchar_t *Ei_payment_method;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
queryParams = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(queryParams,L"fields",L"<string>");
CkJsonObjectW_UpdateString(queryParams,L"fieldset",L"basic");
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://api-v2.fattureincloud.it/c/:company_id/settings/payment_methods/:payment_method_id",queryParams);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "id": "<integer>",
// "name": "<string>",
// "type": "standard",
// "is_default": "<boolean>",
// "default_payment_account": {
// "id": "<integer>",
// "name": "<string>",
// "type": "standard",
// "iban": "<string>",
// "sia": "<string>",
// "cuc": "<string>",
// "virtual": "<boolean>"
// },
// "details": [
// {
// "title": "<string>",
// "description": "<string>"
// },
// {
// "title": "<string>",
// "description": "<string>"
// }
// ],
// "bank_iban": "<string>",
// "bank_name": "<string>",
// "bank_beneficiary": "<string>",
// "ei_payment_method": "<string>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
Id = CkJsonObjectW_stringOf(jResp,L"data.id");
Name = CkJsonObjectW_stringOf(jResp,L"data.name");
v_Type = CkJsonObjectW_stringOf(jResp,L"data.type");
Is_default = CkJsonObjectW_stringOf(jResp,L"data.is_default");
Default_payment_accountId = CkJsonObjectW_stringOf(jResp,L"data.default_payment_account.id");
Default_payment_accountName = CkJsonObjectW_stringOf(jResp,L"data.default_payment_account.name");
Default_payment_accountType = CkJsonObjectW_stringOf(jResp,L"data.default_payment_account.type");
Iban = CkJsonObjectW_stringOf(jResp,L"data.default_payment_account.iban");
Sia = CkJsonObjectW_stringOf(jResp,L"data.default_payment_account.sia");
Cuc = CkJsonObjectW_stringOf(jResp,L"data.default_payment_account.cuc");
v_Virtual = CkJsonObjectW_stringOf(jResp,L"data.default_payment_account.virtual");
Bank_iban = CkJsonObjectW_stringOf(jResp,L"data.bank_iban");
Bank_name = CkJsonObjectW_stringOf(jResp,L"data.bank_name");
Bank_beneficiary = CkJsonObjectW_stringOf(jResp,L"data.bank_beneficiary");
Ei_payment_method = CkJsonObjectW_stringOf(jResp,L"data.ei_payment_method");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"data.details");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
title = CkJsonObjectW_stringOf(jResp,L"data.details[i].title");
description = CkJsonObjectW_stringOf(jResp,L"data.details[i].description");
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -G -d "fields=%3Cstring%3E"
-d "fieldset=basic"
-H "Authorization: Bearer <access_token>"
-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/settings/payment_methods/:payment_method_id
Postman Collection Item JSON
{
"name": "Get Payment Method",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "scope",
"value": "entity.clients:r entity.clients:a entity.suppliers:r entity.suppliers:a products:r products:a issued_documents.invoices:r issued_documents.credit_notes:r issued_documents.receipts:r issued_documents.orders:r issued_documents.quotes:r issued_documents.proformas:r issued_documents.delivery_notes:r issued_documents.work_reports:r issued_documents.supplier_orders:r issued_documents.self_invoices:r issued_documents.invoices:a issued_documents.credit_notes:a issued_documents.receipts:a issued_documents.orders:a issued_documents.quotes:a issued_documents.proformas:a issued_documents.delivery_notes:a issued_documents.work_reports:a issued_documents.supplier_orders:a issued_documents.self_invoices:a received_documents:r received_documents:a stock:r stock:a receipts:r receipts:a taxes:r taxes:a archive:r archive:a cashbook:r cashbook:a settings:r settings:a situation:r",
"type": "string"
},
{
"key": "redirect_uri",
"value": "https://api-v2.fattureincloud.it/oauth/token",
"type": "string"
},
{
"key": "accessTokenUrl",
"value": "https://api-v2.fattureincloud.it/oauth/token",
"type": "string"
},
{
"key": "authUrl",
"value": "https://api-v2.fattureincloud.it/oauth/authorize",
"type": "string"
},
{
"key": "grant_type",
"value": "authorization_code",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/settings/payment_methods/:payment_method_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"settings",
"payment_methods",
":payment_method_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
},
{
"key": "payment_method_id",
"value": "<integer>"
}
]
},
"description": "Gets the specified payment method."
},
"response": [
{
"name": "Example response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/settings/payment_methods/:payment_method_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"settings",
"payment_methods",
":payment_method_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id"
},
{
"key": "payment_method_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"standard\",\n \"is_default\": \"<boolean>\",\n \"default_payment_account\": {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"standard\",\n \"iban\": \"<string>\",\n \"sia\": \"<string>\",\n \"cuc\": \"<string>\",\n \"virtual\": \"<boolean>\"\n },\n \"details\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n },\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"bank_iban\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"bank_beneficiary\": \"<string>\",\n \"ei_payment_method\": \"<string>\"\n }\n}"
}
]
}
