Endpoint tim

Tim merepresentasikan pengelompokan yang dapat ditetapkan ke agen, yang kemudian dapat ditetapkan ke antrean. Setiap objek mewakili satu tim.

Ada tiga endpoint tim:

• /team - menarik daftar tim.

• /team/tree - menarik tim dalam struktur pohon.

• /team/{:id} - menarik satu resource tim.

Tinjau model berikut untuk menentukan kolom mana yang mungkin berisi PII.

[
  {
    "id": 0,
    "name": "string",
    "parent_id": 0,
    "position": 0,
    "deleted": true,
    "agents_count": 0,
    "assignees": {
      "id": 0,
      "name": "string", // This may be considered PII
      "last_name": "string", // This may be considered PII
      "first_name": "string", // This may be considered PII
      "agent_number": "string", // This may be considered PII
      "avatar_url": "string"
    }
  }
]

Daftar tim

Parameter	Wajib	Jenis Data	Definisi
sort_column	FALSE	String	Mengurutkan respons berdasarkan kolom apa pun dalam objek respons.
sort_direction	FALSE	ASC atau DESC	Mencatat arah pengurutan, baik menaik atau menurun
halaman	FALSE	String	Berpasangan dengan per untuk mencatat halaman rekaman. Misalnya, jika per ditetapkan menjadi 200 dan halaman adalah 2, respons akan berisi data 201-400, karena halaman 1 akan berisi 1-200.
per	FALSE	String	Dipasangkan dengan halaman untuk mencatat jumlah data yang akan disertakan dalam halaman data. Misalnya, jika per ditetapkan menjadi 200 dan halaman adalah 2, respons akan berisi data 201-400, karena halaman 1 akan berisi 1-200.
agents_count[from]	FALSE	Angka	membuat batas bawah kolom jumlah agen. Semua data yang ditampilkan akan berada setelah nilai yang dimasukkan.
agents_count[to]	FALSE	Angka	membuat batas atas kolom jumlah agen. Semua data yang ditampilkan akan berada sebelum nilai yang dimasukkan.
id[]	FALSE	Array[String]	Array[String]. ID catatan yang akan ditelusuri dan ditampilkan
name[]	FALSE	Array[String]	Menampilkan data berdasarkan nama resource.
parent_id[]	FALSE	Array[String]	Menampilkan data berdasarkan ID induk dari data yang diberikan
position[]	FALSE	Array[String]	Menampilkan rekaman berdasarkan posisi menu
with_deleted	FALSE	Boolean	Menampilkan data yang telah dihapus (True) atau tidak menyertakan data yang telah dihapus (False)

Endpoint:

Method: GET
Type: 
URL: https://{​{subdomain}​}.{​{domain}​}/manager/api/v1/teams

Contoh Permintaan/Respons lainnya:

Contoh permintaan: Daftar tim

Isi: Tidak ada

Contoh Respons: Daftar tim

[
  {
    "id": 11,
    "name": "Forest Moon of Endor Team",
    "parent_id": null,
    "position": 28,
    "agents_count": 3,
    "deleted": false,
    "assignees": [
      {
        "id": 19,
        "agent_number": "77",
        "name": "Storm Trooper 1",
        "last_name": "Storm",
        "first_name": "Trooper 1"
      },
      {
        "id": 20,
        "agent_number": "78",
        "name": "Storm Trooper 2",
        "last_name": "Storm",
        "first_name": "Trooper 2"
      },
      {
        "id": 21,
        "agent_number": "79",
        "name": "Storm Trooper 3",
        "last_name": "Storm",
        "first_name": "Trooper 3"
      }
    ]
  },
  {
    "id": 12,
    "name": "Death Star Team",
    "parent_id": null,
    "position": 28,
    "agents_count": 3,
    "deleted": false,
    "assignees": [
      {
        "id": 34,
        "agent_number": "80",
        "name": "Storm Trooper 5",
        "last_name": "Storm",
        "first_name": "Trooper 5"
      },
      {
        "id": 35,
        "agent_number": "81",
        "name": "Storm Trooper 6",
        "last_name": "Storm",
        "first_name": "Trooper 6"
      },
      {
        "id": 36,
        "agent_number": "82",
        "name": "Storm Trooper 7",
        "last_name": "Storm",
        "first_name": "Trooper 7"
      }
    ]
  }
]

Kode Status: 200

Tim tunggal

Parameter	Wajib	Jenis Data	Definisi
record_id	FALSE	String	Menampilkan data spesifik berdasarkan ID
with_deleted	FALSE	Boolean	Menampilkan data yang telah dihapus (True) atau tidak menyertakan data yang telah dihapus (False)

Endpoint:

Method: GET
Type: 
URL: https://{​{subdomain}​}.{​{domain}​}/manager/api/v1/teams/{​{team_id}​}

Contoh Permintaan/Respons lainnya:

Contoh permintaan: Satu tim

Isi: Tidak ada

Contoh respons: Satu tim

    {
        "id": 11,
        "name": "Forest Moon of Endor Team",
        "parent_id": null,
        "position": 28,
        "agents_count": 3,
        "deleted": false,
        "assignees": [
            {
                "id": 19,
                "agent_number": "77",
                "name": "Storm Trooper 1",
                "last_name": "Storm",
                "first_name": "Trooper 1"
            },
            {
                "id": 20,
                "agent_number": "78",
                "name": "Storm Trooper 2",
                "last_name": "Storm",
                "first_name": "Trooper 2"
            },
            {
                "id": 21,
                "agent_number": "79",
                "name": "Storm Trooper 3",
                "last_name": "Storm",
                "first_name": "Trooper 3"
            }
        ]
    }

Kode Status: 200

Struktur tim

Endpoint:

Method: GET
Type: 
URL: https://{​{subdomain}​}.{​{domain}​}/manager/api/v1/teams/tree

Contoh Permintaan/Respons lainnya:

Contoh permintaan: Struktur tim

Isi: Tidak ada

Contoh respons: Struktur tim

[
  {
    "id": 147,
    "name": "Storm Trooper Reigment",
    "parent_id": null,
    "position": 1,
    "agents_count": 9,
    "deleted": false,
    "children": [
      {
        "id": 34,
        "name": "Storm Trooper 1st Regiment",
        "parent_id": 147,
        "position": 1,
        "agents_count": 2,
        "deleted": false,
        "children": []
      }
    ]
  }
]

Kode Status: 200