Chilkat Online Tools

Swift / Support API / Create Membership

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

    http.BasicAuth = true
    http.Login = "login"
    http.Password = "password"

    http.SetRequestHeader("Accept", value: "application/json")

    var resp: CkoHttpResponse? = http.QuickRequest("POST", url: "https://example.zendesk.com/api/v2/group_memberships")
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "group_membership": {
    //     "user_id": "<integer>",
    //     "group_id": "<integer>",
    //     "created_at": "<dateTime>",
    //     "default": "<boolean>",
    //     "id": "<integer>",
    //     "updated_at": "<dateTime>",
    //     "url": "<string>"
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var User_id: String? = jResp.StringOf("group_membership.user_id")
    var Group_id: String? = jResp.StringOf("group_membership.group_id")
    var Created_at: String? = jResp.StringOf("group_membership.created_at")
    var Default: String? = jResp.StringOf("group_membership.default")
    var Id: String? = jResp.StringOf("group_membership.id")
    var Updated_at: String? = jResp.StringOf("group_membership.updated_at")
    var v_Url: String? = jResp.StringOf("group_membership.url")

}

Curl Command

curl  -u login:password -X POST
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/group_memberships

Postman Collection Item JSON

{
  "name": "Create Membership",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/group_memberships",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "group_memberships"
      ],
      "variable": [
        {
          "key": "user_id",
          "value": "<integer>",
          "description": "(Required) The id of the user"
        },
        {
          "key": "group_id",
          "value": "<integer>",
          "description": "(Required) The ID of the group"
        }
      ]
    },
    "description": "Assigns an agent to a given group.\n\n#### Allowed For\n\n* Admins\n* Agents assigned to a custom role with permissions to manage group memberships (Enterprise only)\n"
  },
  "response": [
    {
      "name": "Created response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/group_memberships",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "group_memberships"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"group_membership\": {\n    \"user_id\": \"<integer>\",\n    \"group_id\": \"<integer>\",\n    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"id\": \"<integer>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}