Chilkat Online Tools

delphiDll / Salesforce Platform APIs / Get Appointment Candidates

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
resp: HCkHttpResponse;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := CkHttp_Create();

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "startTime": "string",
//   "endTime": "string",
//   "workTypeGroupId": "string",
//   "workType": "Work Type",
//   "accountId": "string",
//   "territoryIds": "string[]",
//   "requiredResourceIds": "string[]",
//   "schedulingPolicyId": "string",
//   "allowConcurrentScheduling": "boolean"
// }

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'startTime','string');
CkJsonObject_UpdateString(json,'endTime','string');
CkJsonObject_UpdateString(json,'workTypeGroupId','string');
CkJsonObject_UpdateString(json,'workType','Work Type');
CkJsonObject_UpdateString(json,'accountId','string');
CkJsonObject_UpdateString(json,'territoryIds','string[]');
CkJsonObject_UpdateString(json,'requiredResourceIds','string[]');
CkJsonObject_UpdateString(json,'schedulingPolicyId','string');
CkJsonObject_UpdateString(json,'allowConcurrentScheduling','boolean');

// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');

resp := CkHttp_PostJson3(http,'https://domain.com/services/data/v{{version}}/scheduling/getAppointmentCandidates','application/json',json);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add(IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add(CkHttpResponse__bodyStr(resp));
CkHttpResponse_Dispose(resp);

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
	"startTime": "string",
	"endTime": "string",
	"workTypeGroupId": "string",
	"workType": "Work Type",
	"accountId": "string",
	"territoryIds": "string[]",
	"requiredResourceIds": "string[]",
	"schedulingPolicyId": "string",
	"allowConcurrentScheduling": "boolean",
}'
https://domain.com/services/data/v{{version}}/scheduling/getAppointmentCandidates

Postman Collection Item JSON

{
  "name": "Get Appointment Candidates",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n\t\"startTime\": \"string\",\n\t\"endTime\": \"string\",\n\t\"workTypeGroupId\": \"string\",\n\t\"workType\": \"Work Type\",\n\t\"accountId\": \"string\",\n\t\"territoryIds\": \"string[]\",\n\t\"requiredResourceIds\": \"string[]\",\n\t\"schedulingPolicyId\": \"string\",\n\t\"allowConcurrentScheduling\": \"boolean\",\n}"
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/scheduling/getAppointmentCandidates",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "scheduling",
        "getAppointmentCandidates"
      ]
    },
    "description": "Returns a list of available service resources (appointment candidates) based on work type group and service territories.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/requests_ls_getappointmentcandidates.htm"
  },
  "response": [
  ]
}