C / Support API / Create Sharing Agreement
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *Created_at;
const char *Id;
const char *Name;
const char *Partner_name;
const char *Remote_subdomain;
const char *Status;
const char *v_Type;
const char *v_Url;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
CkHttp_putBasicAuth(http,TRUE);
CkHttp_putLogin(http,"login");
CkHttp_putPassword(http,"password");
CkHttp_SetRequestHeader(http,"Accept","application/json");
resp = CkHttp_QuickRequest(http,"POST","https://example.zendesk.com/api/v2/sharing_agreements");
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "sharing_agreement": {
// "created_at": "<dateTime>",
// "id": "<integer>",
// "name": "<string>",
// "partner_name": "<string>",
// "remote_subdomain": "<string>",
// "status": "<string>",
// "type": "<string>",
// "url": "<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.
Created_at = CkJsonObject_stringOf(jResp,"sharing_agreement.created_at");
Id = CkJsonObject_stringOf(jResp,"sharing_agreement.id");
Name = CkJsonObject_stringOf(jResp,"sharing_agreement.name");
Partner_name = CkJsonObject_stringOf(jResp,"sharing_agreement.partner_name");
Remote_subdomain = CkJsonObject_stringOf(jResp,"sharing_agreement.remote_subdomain");
Status = CkJsonObject_stringOf(jResp,"sharing_agreement.status");
v_Type = CkJsonObject_stringOf(jResp,"sharing_agreement.type");
v_Url = CkJsonObject_stringOf(jResp,"sharing_agreement.url");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -u login:password -X POST
-H "Accept: application/json"
https://example.zendesk.com/api/v2/sharing_agreements
Postman Collection Item JSON
{
"name": "Create Sharing Agreement",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sharing_agreements",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sharing_agreements"
]
},
"description": "#### Allowed For\n\n* Admins\n"
},
"response": [
{
"name": "Created response",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sharing_agreements",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sharing_agreements"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"sharing_agreement\": {\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"partner_name\": \"<string>\",\n \"remote_subdomain\": \"<string>\",\n \"status\": \"<string>\",\n \"type\": \"<string>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}