Chilkat Online Tools

SQL Server / Salesforce Platform APIs / Get Appointment Candidates

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

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

    DECLARE @json int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'startTime', 'string'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'endTime', 'string'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'workTypeGroupId', 'string'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'workType', 'Work Type'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'accountId', 'string'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'territoryIds', 'string[]'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'requiredResourceIds', 'string[]'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'schedulingPolicyId', 'string'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'allowConcurrentScheduling', 'boolean'

    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/services/data/v{{version}}/scheduling/getAppointmentCandidates', 'application/json', @json
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json


END
GO

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