delphiDll / Support API / Show a Sharing Agreement
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Created_at: PWideChar;
Id: PWideChar;
Name: PWideChar;
Partner_name: PWideChar;
Remote_subdomain: PWideChar;
Status: PWideChar;
v_Type: PWideChar;
v_Url: PWideChar;
begin
// 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');
sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://example.zendesk.com/api/v2/sharing_agreements/:sharing_agreement_id',sbResponseBody);
if (success = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttp__lastHeader(http));
Memo1.Lines.Add('Failed.');
Exit;
end;
// 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
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 GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/sharing_agreements/:sharing_agreement_id
Postman Collection Item JSON
{
"name": "Show a Sharing Agreement",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sharing_agreements/:sharing_agreement_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sharing_agreements",
":sharing_agreement_id"
],
"variable": [
{
"key": "sharing_agreement_id",
"value": "<integer>"
}
]
},
"description": "Returns a sharing agreement for your account.\n\n#### Allowed For\n\n* Agents\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sharing_agreements/:sharing_agreement_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sharing_agreements",
":sharing_agreement_id"
],
"variable": [
{
"key": "sharing_agreement_id"
}
]
}
},
"status": "OK",
"code": 200,
"_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}"
}
]
}