Chilkat Online Tools

Go / Salesforce Platform APIs / Get Appointment Candidates

Back to Collection Items

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

    http := chilkat.NewHttp()
    var success bool

    // 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 := chilkat.NewJsonObject()
    json.UpdateString("startTime","string")
    json.UpdateString("endTime","string")
    json.UpdateString("workTypeGroupId","string")
    json.UpdateString("workType","Work Type")
    json.UpdateString("accountId","string")
    json.UpdateString("territoryIds","string[]")
    json.UpdateString("requiredResourceIds","string[]")
    json.UpdateString("schedulingPolicyId","string")
    json.UpdateString("allowConcurrentScheduling","boolean")

    // Adds the "Authorization: Bearer <access_token>" header.
    http.SetAuthToken("<access_token>")
    http.SetRequestHeader("Content-Type","application/json")

    resp := http.PostJson3("https://domain.com/services/data/v{{version}}/scheduling/getAppointmentCandidates","application/json",json)
    if http.LastMethodSuccess() == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        json.DisposeJsonObject()
        return
    }

    fmt.Println(resp.StatusCode())
    fmt.Println(resp.BodyStr())
    resp.DisposeHttpResponse()

    http.DisposeHttp()
    json.DisposeJsonObject()

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