Chilkat Online Tools

Foxpro / Salesforce Platform APIs / Get Appointment Candidates

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* 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"
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("startTime","string")
loJson.UpdateString("endTime","string")
loJson.UpdateString("workTypeGroupId","string")
loJson.UpdateString("workType","Work Type")
loJson.UpdateString("accountId","string")
loJson.UpdateString("territoryIds","string[]")
loJson.UpdateString("requiredResourceIds","string[]")
loJson.UpdateString("schedulingPolicyId","string")
loJson.UpdateString("allowConcurrentScheduling","boolean")

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")

loResp = loHttp.PostJson3("https://domain.com/services/data/v{{version}}/scheduling/getAppointmentCandidates","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loJson

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": [
  ]
}