Chilkat Online Tools

PureBasic / DocuSign REST API / Deletes an existing user group.

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    ; The following JSON is sent in the request body.

    ; {
    ;   "groups": [
    ;     {
    ;       "groupId": "sample string 1",
    ;       "groupName": "sample string 2",
    ;       "permissionProfileId": "sample string 3",
    ;       "groupType": "sample string 4",
    ;       "users": [
    ;         {
    ;           "userName": "sample string 1",
    ;           "userId": "sample string 2",
    ;           "email": "sample string 3",
    ;           "userType": "sample string 4",
    ;           "userStatus": "sample string 5",
    ;           "uri": "sample string 6",
    ;           "loginStatus": "sample string 7",
    ;           "sendActivationEmail": "sample string 8",
    ;           "activationAccessCode": "sample string 9"
    ;         }
    ;       ]
    ;     }
    ;   ],
    ;   "resultSetSize": "sample string 1",
    ;   "totalSetSize": "sample string 2",
    ;   "startPosition": "sample string 3",
    ;   "endPosition": "sample string 4",
    ;   "nextUri": "sample string 5",
    ;   "previousUri": "sample string 6"
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"groups[0].groupId","sample string 1")
    CkJsonObject::ckUpdateString(json,"groups[0].groupName","sample string 2")
    CkJsonObject::ckUpdateString(json,"groups[0].permissionProfileId","sample string 3")
    CkJsonObject::ckUpdateString(json,"groups[0].groupType","sample string 4")
    CkJsonObject::ckUpdateString(json,"groups[0].users[0].userName","sample string 1")
    CkJsonObject::ckUpdateString(json,"groups[0].users[0].userId","sample string 2")
    CkJsonObject::ckUpdateString(json,"groups[0].users[0].email","sample string 3")
    CkJsonObject::ckUpdateString(json,"groups[0].users[0].userType","sample string 4")
    CkJsonObject::ckUpdateString(json,"groups[0].users[0].userStatus","sample string 5")
    CkJsonObject::ckUpdateString(json,"groups[0].users[0].uri","sample string 6")
    CkJsonObject::ckUpdateString(json,"groups[0].users[0].loginStatus","sample string 7")
    CkJsonObject::ckUpdateString(json,"groups[0].users[0].sendActivationEmail","sample string 8")
    CkJsonObject::ckUpdateString(json,"groups[0].users[0].activationAccessCode","sample string 9")
    CkJsonObject::ckUpdateString(json,"resultSetSize","sample string 1")
    CkJsonObject::ckUpdateString(json,"totalSetSize","sample string 2")
    CkJsonObject::ckUpdateString(json,"startPosition","sample string 3")
    CkJsonObject::ckUpdateString(json,"endPosition","sample string 4")
    CkJsonObject::ckUpdateString(json,"nextUri","sample string 5")
    CkJsonObject::ckUpdateString(json,"previousUri","sample string 6")

    ; Adds the "Authorization: Bearer {{accessToken}}" header.
    CkHttp::setCkAuthToken(http, "{{accessToken}}")
    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"DELETE","https://domain.com/v2.1/accounts/{{accountId}}/groups",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

Curl Command

curl -X DELETE
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "groups": [
    {
      "groupId": "sample string 1",
      "groupName": "sample string 2",
      "permissionProfileId": "sample string 3",
      "groupType": "sample string 4",
      "users": [
        {
          "userName": "sample string 1",
          "userId": "sample string 2",
          "email": "sample string 3",
          "userType": "sample string 4",
          "userStatus": "sample string 5",
          "uri": "sample string 6",
          "loginStatus": "sample string 7",
          "sendActivationEmail": "sample string 8",
          "activationAccessCode": "sample string 9"
        }
      ]
    }
  ],
  "resultSetSize": "sample string 1",
  "totalSetSize": "sample string 2",
  "startPosition": "sample string 3",
  "endPosition": "sample string 4",
  "nextUri": "sample string 5",
  "previousUri": "sample string 6"
}'
https://domain.com/v2.1/accounts/{{accountId}}/groups

Postman Collection Item JSON

{
  "name": "Deletes an existing user group.",
  "request": {
    "method": "DELETE",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"groups\": [\n    {\n      \"groupId\": \"sample string 1\",\n      \"groupName\": \"sample string 2\",\n      \"permissionProfileId\": \"sample string 3\",\n      \"groupType\": \"sample string 4\",\n      \"users\": [\n        {\n          \"userName\": \"sample string 1\",\n          \"userId\": \"sample string 2\",\n          \"email\": \"sample string 3\",\n          \"userType\": \"sample string 4\",\n          \"userStatus\": \"sample string 5\",\n          \"uri\": \"sample string 6\",\n          \"loginStatus\": \"sample string 7\",\n          \"sendActivationEmail\": \"sample string 8\",\n          \"activationAccessCode\": \"sample string 9\"\n        }\n      ]\n    }\n  ],\n  \"resultSetSize\": \"sample string 1\",\n  \"totalSetSize\": \"sample string 2\",\n  \"startPosition\": \"sample string 3\",\n  \"endPosition\": \"sample string 4\",\n  \"nextUri\": \"sample string 5\",\n  \"previousUri\": \"sample string 6\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/groups",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "groups"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        }
      ]
    },
    "description": "Deletes an existing user group."
  },
  "response": [
  ]
}