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.
-- {
-- "members": [
-- "5df9d90aba2cb0c5a4f12d44",
-- "5df9d90aba2cb0c5a4f12d45",
-- "5df9d90aba2cb0c5a4f12d46"
-- ]
-- }
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, 'members[0]', '5df9d90aba2cb0c5a4f12d44'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'members[1]', '5df9d90aba2cb0c5a4f12d45'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'members[2]', '5df9d90aba2cb0c5a4f12d46'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
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://api.squadcast.com/v3/squads/:squadID', @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 "Authorization: Bearer <access_token>"
-d '{
"members":[
"5df9d90aba2cb0c5a4f12d44",
"5df9d90aba2cb0c5a4f12d45",
"5df9d90aba2cb0c5a4f12d46"
]
}'
https://api.squadcast.com/v3/squads/:squadID
Postman Collection Item JSON
{
"name": "Update Squad",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{sq_pb_auth_header}}",
"type": "string"
}
]
},
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"members\":[\n \"5df9d90aba2cb0c5a4f12d44\",\n \"5df9d90aba2cb0c5a4f12d45\",\n \"5df9d90aba2cb0c5a4f12d46\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/squads/:squadID",
"host": [
"{{baseUrl}}"
],
"path": [
"squads",
":squadID"
],
"variable": [
{
"key": "squadID",
"value": "5ed4e5977cc8a1daa90d56eb",
"type": "string"
}
]
},
"description": "This endpoint is used to update the squads details.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `squad-update` scope."
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"members\":[\n \"5df9d90aba2cb0c5a4f12d44\",\n \"5df9d90aba2cb0c5a4f12d45\",\n \"5df9d90aba2cb0c5a4f12d46\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/squads/:squadID",
"host": [
"{{baseUrl}}"
],
"path": [
"squads",
":squadID"
],
"variable": [
{
"key": "squadID",
"value": "5ed4e5977cc8a1daa90d56eb"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [
],
"body": "{\n \"data\": {\n \"id\": \"5ed4e5977cc8a1daa90d56eb\",\n \"name\": \"Devops Night Man Squad\",\n \"slug\": \"devops-night-man-squad\",\n \"members\": [\n \"5df9d90aba2cb0c5a4f12d44\",\n \"5df9d90aba2cb0c5a4f12d45\",\n \"5df9d90aba2cb0c5a4f12d46\"\n ],\n \"organization\": {\n \"id\": \"5ea962e35734157d01594951\",\n \"name\": \"Avengers\",\n \"slug\": \"avengers\"\n }\n }\n}"
},
{
"name": "400 Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"members\":[\n \"5df9d90aba2cb0c5a4f12d44\",\n \"5df9d90aba2cb0c5a4f12d45\",\n \"5df9d90aba2cb0c5a4f12d46\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/squads/:squadID",
"host": [
"{{baseUrl}}"
],
"path": [
"squads",
":squadID"
],
"variable": [
{
"key": "squadID",
"value": "5ed4e5977cc8a1daa90d56eb"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": 400,\n \"error_message\": \"<string>\"\n }\n}"
},
{
"name": "401 Unauthorized",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"members\":[\n \"5df9d90aba2cb0c5a4f12d44\",\n \"5df9d90aba2cb0c5a4f12d45\",\n \"5df9d90aba2cb0c5a4f12d46\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/squads/:squadID",
"host": [
"{{baseUrl}}"
],
"path": [
"squads",
":squadID"
],
"variable": [
{
"key": "squadID",
"value": "5ed4e5977cc8a1daa90d56eb"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": 401,\n \"error_message\": \"<string>\"\n }\n}"
},
{
"name": "403 Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"members\":[\n \"5df9d90aba2cb0c5a4f12d44\",\n \"5df9d90aba2cb0c5a4f12d45\",\n \"5df9d90aba2cb0c5a4f12d46\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/squads/:squadID",
"host": [
"{{baseUrl}}"
],
"path": [
"squads",
":squadID"
],
"variable": [
{
"key": "squadID",
"value": "5ed4e5977cc8a1daa90d56eb"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": 403,\n \"error_message\": \"<string>\"\n }\n}"
},
{
"name": "404 Not Found",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"members\":[\n \"5df9d90aba2cb0c5a4f12d44\",\n \"5df9d90aba2cb0c5a4f12d45\",\n \"5df9d90aba2cb0c5a4f12d46\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/squads/:squadID",
"host": [
"{{baseUrl}}"
],
"path": [
"squads",
":squadID"
],
"variable": [
{
"key": "squadID",
"value": "5ed4e5977cc8a1daa90d56eb"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": 404,\n \"error_message\": \"<string>\"\n }\n}"
},
{
"name": "500 Internal Server Error",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"members\":[\n \"5df9d90aba2cb0c5a4f12d44\",\n \"5df9d90aba2cb0c5a4f12d45\",\n \"5df9d90aba2cb0c5a4f12d46\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/squads/:squadID",
"host": [
"{{baseUrl}}"
],
"path": [
"squads",
":squadID"
],
"variable": [
{
"key": "squadID",
"value": "5ed4e5977cc8a1daa90d56eb"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": 500,\n \"error_message\": \"<string>\"\n }\n}"
}
]
}
