Chilkat Online Tools

Swift / Support API / Incremental User Export, Cursor Based

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"

    let queryParams = CkoJsonObject()
    queryParams.UpdateString("start_time", value: "<integer>")
    queryParams.UpdateString("cursor", value: "<string>")
    queryParams.UpdateString("per_page", value: "<integer>")

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

    var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://example.zendesk.com/api/v2/incremental/users/cursor", json: queryParams)
    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)

    // {
    //   "after_cursor": "<string>",
    //   "after_url": "<string>",
    //   "before_cursor": "<string>",
    //   "before_url": "<string>",
    //   "end_of_stream": "<boolean>",
    //   "users": [
    //     {
    //       "name": "<string>",
    //       "active": "<boolean>",
    //       "alias": "<string>",
    //       "chat_only": "<boolean>",
    //       "created_at": "<string>",
    //       "custom_role_id": "<integer>",
    //       "default_group_id": "<integer>",
    //       "details": "<string>",
    //       "email": "<string>",
    //       "external_id": "<string>",
    //       "iana_time_zone": "<string>",
    //       "id": "<integer>",
    //       "last_login_at": "<string>",
    //       "locale": "<string>",
    //       "locale_id": "<integer>",
    //       "moderator": "<boolean>",
    //       "notes": "<string>",
    //       "only_private_comments": "<boolean>",
    //       "organization_id": "<integer>",
    //       "phone": "<string>",
    //       "photo": {
    //         "proidentbc0": -29354278.707036167,
    //         "fugiat_e_b": -98816029.91228342
    //       },
    //       "remote_photo_url": "<string>",
    //       "report_csv": "<boolean>",
    //       "restricted_agent": "<boolean>",
    //       "role": "<string>",
    //       "role_type": "<integer>",
    //       "shared": "<boolean>",
    //       "shared_agent": "<boolean>",
    //       "shared_phone_number": "<boolean>",
    //       "signature": "<string>",
    //       "suspended": "<boolean>",
    //       "tags": "<array>",
    //       "ticket_restriction": "<string>",
    //       "time_zone": "<string>",
    //       "two_factor_auth_enabled": "<boolean>",
    //       "updated_at": "<string>",
    //       "url": "<string>",
    //       "user_fields": {
    //         "culpa14b": true
    //       },
    //       "verified": "<boolean>"
    //     },
    //     {
    //       "name": "<string>",
    //       "active": "<boolean>",
    //       "alias": "<string>",
    //       "chat_only": "<boolean>",
    //       "created_at": "<string>",
    //       "custom_role_id": "<integer>",
    //       "default_group_id": "<integer>",
    //       "details": "<string>",
    //       "email": "<string>",
    //       "external_id": "<string>",
    //       "iana_time_zone": "<string>",
    //       "id": "<integer>",
    //       "last_login_at": "<string>",
    //       "locale": "<string>",
    //       "locale_id": "<integer>",
    //       "moderator": "<boolean>",
    //       "notes": "<string>",
    //       "only_private_comments": "<boolean>",
    //       "organization_id": "<integer>",
    //       "phone": "<string>",
    //       "photo": {
    //         "in223": -78887847,
    //         "quis20_": 61629027.23513341
    //       },
    //       "remote_photo_url": "<string>",
    //       "report_csv": "<boolean>",
    //       "restricted_agent": "<boolean>",
    //       "role": "<string>",
    //       "role_type": "<integer>",
    //       "shared": "<boolean>",
    //       "shared_agent": "<boolean>",
    //       "shared_phone_number": "<boolean>",
    //       "signature": "<string>",
    //       "suspended": "<boolean>",
    //       "tags": "<array>",
    //       "ticket_restriction": "<string>",
    //       "time_zone": "<string>",
    //       "two_factor_auth_enabled": "<boolean>",
    //       "updated_at": "<string>",
    //       "url": "<string>",
    //       "user_fields": {
    //         "aliquipe8": false
    //       },
    //       "verified": "<boolean>"
    //     }
    //   ]
    // }

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

    var name: String?
    var active: String?
    var alias: String?
    var chat_only: String?
    var created_at: String?
    var custom_role_id: String?
    var default_group_id: String?
    var details: String?
    var email: String?
    var external_id: String?
    var iana_time_zone: String?
    var id: String?
    var last_login_at: String?
    var locale: String?
    var locale_id: String?
    var moderator: String?
    var notes: String?
    var only_private_comments: String?
    var organization_id: String?
    var phone: String?
    var Proidentbc0: String?
    var Fugiat_e_b: String?
    var remote_photo_url: String?
    var report_csv: String?
    var restricted_agent: String?
    var role: String?
    var role_type: String?
    var v_shared: String?
    var shared_agent: String?
    var shared_phone_number: String?
    var signature: String?
    var suspended: String?
    var tags: String?
    var ticket_restriction: String?
    var time_zone: String?
    var two_factor_auth_enabled: String?
    var updated_at: String?
    var url: String?
    var Culpa14b: Bool
    var verified: String?
    var In223: Int
    var Quis20_: String?
    var Aliquipe8: Bool

    var after_cursor: String? = jResp.StringOf("after_cursor")
    var after_url: String? = jResp.StringOf("after_url")
    var before_cursor: String? = jResp.StringOf("before_cursor")
    var before_url: String? = jResp.StringOf("before_url")
    var end_of_stream: String? = jResp.StringOf("end_of_stream")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("users").intValue
    while i < count_i {
        jResp.I = i
        name = jResp.StringOf("users[i].name")
        active = jResp.StringOf("users[i].active")
        alias = jResp.StringOf("users[i].alias")
        chat_only = jResp.StringOf("users[i].chat_only")
        created_at = jResp.StringOf("users[i].created_at")
        custom_role_id = jResp.StringOf("users[i].custom_role_id")
        default_group_id = jResp.StringOf("users[i].default_group_id")
        details = jResp.StringOf("users[i].details")
        email = jResp.StringOf("users[i].email")
        external_id = jResp.StringOf("users[i].external_id")
        iana_time_zone = jResp.StringOf("users[i].iana_time_zone")
        id = jResp.StringOf("users[i].id")
        last_login_at = jResp.StringOf("users[i].last_login_at")
        locale = jResp.StringOf("users[i].locale")
        locale_id = jResp.StringOf("users[i].locale_id")
        moderator = jResp.StringOf("users[i].moderator")
        notes = jResp.StringOf("users[i].notes")
        only_private_comments = jResp.StringOf("users[i].only_private_comments")
        organization_id = jResp.StringOf("users[i].organization_id")
        phone = jResp.StringOf("users[i].phone")
        Proidentbc0 = jResp.StringOf("users[i].photo.proidentbc0")
        Fugiat_e_b = jResp.StringOf("users[i].photo.fugiat_e_b")
        remote_photo_url = jResp.StringOf("users[i].remote_photo_url")
        report_csv = jResp.StringOf("users[i].report_csv")
        restricted_agent = jResp.StringOf("users[i].restricted_agent")
        role = jResp.StringOf("users[i].role")
        role_type = jResp.StringOf("users[i].role_type")
        v_shared = jResp.StringOf("users[i].shared")
        shared_agent = jResp.StringOf("users[i].shared_agent")
        shared_phone_number = jResp.StringOf("users[i].shared_phone_number")
        signature = jResp.StringOf("users[i].signature")
        suspended = jResp.StringOf("users[i].suspended")
        tags = jResp.StringOf("users[i].tags")
        ticket_restriction = jResp.StringOf("users[i].ticket_restriction")
        time_zone = jResp.StringOf("users[i].time_zone")
        two_factor_auth_enabled = jResp.StringOf("users[i].two_factor_auth_enabled")
        updated_at = jResp.StringOf("users[i].updated_at")
        url = jResp.StringOf("users[i].url")
        Culpa14b = jResp.BoolOf("users[i].user_fields.culpa14b")
        verified = jResp.StringOf("users[i].verified")
        In223 = jResp.IntOf("users[i].photo.in223").intValue
        Quis20_ = jResp.StringOf("users[i].photo.quis20_")
        Aliquipe8 = jResp.BoolOf("users[i].user_fields.aliquipe8")
        i = i + 1
    }


}

Curl Command

curl  -u login:password -G -d "start_time=%3Cinteger%3E"
	-d "cursor=%3Cstring%3E"
	-d "per_page=%3Cinteger%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/incremental/users/cursor

Postman Collection Item JSON

{
  "name": "Incremental User Export, Cursor Based",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/incremental/users/cursor?start_time=<integer>&cursor=<string>&per_page=<integer>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "incremental",
        "users",
        "cursor"
      ],
      "query": [
        {
          "key": "start_time",
          "value": "<integer>",
          "description": "(Required) The time to start the incremental export from"
        },
        {
          "key": "cursor",
          "value": "<string>",
          "description": "The cursor pointer to work with for all subsequent exports after the initial request"
        },
        {
          "key": "per_page",
          "value": "<integer>",
          "description": "The number of records to return per page"
        }
      ]
    },
    "description": "#### Allowed For\n\n * Admins\n\n#### Sideloading\n\nSee [Users sideloads](/documentation/ticketing/using-the-zendesk-api/side_loading/#supported-endpoints).\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/incremental/users/cursor?start_time=<integer>&cursor=<string>&per_page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "incremental",
            "users",
            "cursor"
          ],
          "query": [
            {
              "key": "start_time",
              "value": "<integer>",
              "description": "(Required) The time to start the incremental export from"
            },
            {
              "key": "cursor",
              "value": "<string>",
              "description": "The cursor pointer to work with for all subsequent exports after the initial request"
            },
            {
              "key": "per_page",
              "value": "<integer>",
              "description": "The number of records to return per page"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"after_cursor\": \"<string>\",\n  \"after_url\": \"<string>\",\n  \"before_cursor\": \"<string>\",\n  \"before_url\": \"<string>\",\n  \"end_of_stream\": \"<boolean>\",\n  \"users\": [\n    {\n      \"name\": \"<string>\",\n      \"active\": \"<boolean>\",\n      \"alias\": \"<string>\",\n      \"chat_only\": \"<boolean>\",\n      \"created_at\": \"<string>\",\n      \"custom_role_id\": \"<integer>\",\n      \"default_group_id\": \"<integer>\",\n      \"details\": \"<string>\",\n      \"email\": \"<string>\",\n      \"external_id\": \"<string>\",\n      \"iana_time_zone\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"last_login_at\": \"<string>\",\n      \"locale\": \"<string>\",\n      \"locale_id\": \"<integer>\",\n      \"moderator\": \"<boolean>\",\n      \"notes\": \"<string>\",\n      \"only_private_comments\": \"<boolean>\",\n      \"organization_id\": \"<integer>\",\n      \"phone\": \"<string>\",\n      \"photo\": {\n        \"proidentbc0\": -29354278.707036167,\n        \"fugiat_e_b\": -98816029.91228342\n      },\n      \"remote_photo_url\": \"<string>\",\n      \"report_csv\": \"<boolean>\",\n      \"restricted_agent\": \"<boolean>\",\n      \"role\": \"<string>\",\n      \"role_type\": \"<integer>\",\n      \"shared\": \"<boolean>\",\n      \"shared_agent\": \"<boolean>\",\n      \"shared_phone_number\": \"<boolean>\",\n      \"signature\": \"<string>\",\n      \"suspended\": \"<boolean>\",\n      \"tags\": \"<array>\",\n      \"ticket_restriction\": \"<string>\",\n      \"time_zone\": \"<string>\",\n      \"two_factor_auth_enabled\": \"<boolean>\",\n      \"updated_at\": \"<string>\",\n      \"url\": \"<string>\",\n      \"user_fields\": {\n        \"culpa14b\": true\n      },\n      \"verified\": \"<boolean>\"\n    },\n    {\n      \"name\": \"<string>\",\n      \"active\": \"<boolean>\",\n      \"alias\": \"<string>\",\n      \"chat_only\": \"<boolean>\",\n      \"created_at\": \"<string>\",\n      \"custom_role_id\": \"<integer>\",\n      \"default_group_id\": \"<integer>\",\n      \"details\": \"<string>\",\n      \"email\": \"<string>\",\n      \"external_id\": \"<string>\",\n      \"iana_time_zone\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"last_login_at\": \"<string>\",\n      \"locale\": \"<string>\",\n      \"locale_id\": \"<integer>\",\n      \"moderator\": \"<boolean>\",\n      \"notes\": \"<string>\",\n      \"only_private_comments\": \"<boolean>\",\n      \"organization_id\": \"<integer>\",\n      \"phone\": \"<string>\",\n      \"photo\": {\n        \"in223\": -78887847,\n        \"quis20_\": 61629027.23513341\n      },\n      \"remote_photo_url\": \"<string>\",\n      \"report_csv\": \"<boolean>\",\n      \"restricted_agent\": \"<boolean>\",\n      \"role\": \"<string>\",\n      \"role_type\": \"<integer>\",\n      \"shared\": \"<boolean>\",\n      \"shared_agent\": \"<boolean>\",\n      \"shared_phone_number\": \"<boolean>\",\n      \"signature\": \"<string>\",\n      \"suspended\": \"<boolean>\",\n      \"tags\": \"<array>\",\n      \"ticket_restriction\": \"<string>\",\n      \"time_zone\": \"<string>\",\n      \"two_factor_auth_enabled\": \"<boolean>\",\n      \"updated_at\": \"<string>\",\n      \"url\": \"<string>\",\n      \"user_fields\": {\n        \"aliquipe8\": false\n      },\n      \"verified\": \"<boolean>\"\n    }\n  ]\n}"
    }
  ]
}