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
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.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.
-- {
-- "alias": "{{$randomUserName}}'s Device",
-- "location": {
-- "longitude": "{{longitude}}",
-- "latitude": "{{latitude}}"
-- }
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'alias', '{{$randomUserName}}''s Device'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'location.longitude', '{{longitude}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'location.latitude', '{{latitude}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'If-Match', '*'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept-API-Version', 'resource=1.0'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, '{{cookieName}}', '{{demoSSOToken}}'
DECLARE @sbRequestBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/users/:user/devices/profile/:deviceProfileId?_prettyPrint=true#1.0_update', @sbRequestBody, 'utf-8', 'application/json', 0, 0
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
EXEC @hr = sp_OADestroy @sbRequestBody
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
EXEC @hr = sp_OADestroy @sbRequestBody
END
GO
Curl Command
curl -X PUT
-H "Accept-API-Version: resource=1.0"
-H "If-Match: *"
-H "Content-Type: application/json"
-H "{{cookieName}}: {{demoSSOToken}}"
-d '{
"alias": "{{$randomUserName}}\'s Device",
"location": {
"longitude": {{$randomLongitude}},
"latitude": {{$randomLatitude}}
}
}'
https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/users/:user/devices/profile/:deviceProfileId?_prettyPrint=true#1.0_update
Postman Collection Item JSON
{
"name": "Step 2: Update Users' Device Profile",
"request": {
"method": "PUT",
"header": [
{
"description": "(Required) ",
"key": "Accept-API-Version",
"value": "resource=1.0"
},
{
"description": "(Required) ",
"key": "If-Match",
"value": "*"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "{{cookieName}}",
"type": "text",
"value": "{{demoSSOToken}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"alias\": \"{{$randomUserName}}'s Device\",\n \"location\": {\n \"longitude\": {{$randomLongitude}},\n \"latitude\": {{$randomLatitude}}\n }\n}"
},
"url": {
"raw": "{{amUrl}}/json{{realm}}/users/:user/devices/profile/:deviceProfileId?_prettyPrint=true#1.0_update",
"host": [
"{{amUrl}}"
],
"path": [
"json{{realm}}",
"users",
":user",
"devices",
"profile",
":deviceProfileId"
],
"query": [
{
"key": "_fields",
"value": "",
"description": "Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.",
"disabled": true
},
{
"key": "_prettyPrint",
"value": "true",
"description": "Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable."
}
],
"hash": "1.0_update",
"variable": [
{
"key": "user",
"value": "{{demoUserId}}"
},
{
"key": "deviceProfileId",
"value": "{{deviceProfileId}}"
}
]
},
"description": "Update an existing user device alias"
},
"response": [
{
"name": "Unexpected server error happened during the process",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "(Required) ",
"key": "Accept-API-Version",
"value": "resource=1.0"
},
{
"description": "(Required) ",
"key": "If-Match",
"value": "*"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identifier\": \"<string>\",\n \"alias\": \"<string>\",\n \"lastSelectedDate\": \"<string>\",\n \"metadata\": \"<string>\",\n \"location\": {\n \"longitude\": 5910496.137554675,\n \"latitude\": -41063633.84429224\n }\n}"
},
"url": {
"raw": "{{amUrl}}/json{{realm}}/users/:user/devices/profile/{{identifier}}#1.0_update?&_prettyPrint=true",
"host": [
"{{amUrl}}"
],
"path": [
"json{{realm}}",
"users",
":user",
"devices",
"profile",
"{{identifier}}"
],
"hash": "1.0_update?&_prettyPrint=true",
"variable": [
{
"key": "user"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"code\": 93541721,\n \"message\": \"minim\",\n \"reason\": \"sint Excepteur\",\n \"detail\": \"veniam id qui\"\n}"
},
{
"name": "Success",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "(Required) ",
"key": "Accept-API-Version",
"value": "resource=1.0"
},
{
"description": "(Required) ",
"key": "If-Match",
"value": "*"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identifier\": \"<string>\",\n \"alias\": \"<string>\",\n \"lastSelectedDate\": \"<string>\",\n \"metadata\": \"<string>\",\n \"location\": {\n \"longitude\": 5910496.137554675,\n \"latitude\": -41063633.84429224\n }\n}"
},
"url": {
"raw": "{{amUrl}}/json{{realm}}/users/:user/devices/profile/{{identifier}}#1.0_update?&_prettyPrint=true",
"host": [
"{{amUrl}}"
],
"path": [
"json{{realm}}",
"users",
":user",
"devices",
"profile",
"{{identifier}}"
],
"hash": "1.0_update?&_prettyPrint=true",
"variable": [
{
"key": "user"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "*/*"
}
],
"cookie": [
],
"body": ""
}
]
}
