Consulta de la lista de miembros del equipo de etiquetado
Función
Esta API se utiliza para consultar la lista de miembros del equipo de etiquetado.
URI
GET /v2/{project_id}/workforces/{workforce_id}/workers
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
ID del proyecto. Para obtener más información sobre cómo obtener el ID de proyecto, consulte Obtención de un ID de proyecto. |
|
workforce_id |
Sí |
String |
ID de un equipo de etiquetado. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
limit |
No |
Integer |
Número máximo de registros devueltos en cada página. El valor varía de 1 a 100. El valor predeterminado es 10. |
|
offset |
No |
Integer |
Página de inicio de la lista de paginación. El valor predeterminado es 0. |
|
order |
No |
String |
Secuencia de clasificación. Opciones:
|
|
sort_by |
No |
String |
Modo de clasificación de la consulta. Opciones:
|
Parámetros de solicitud
Ninguno
Parámetros de respuesta
Código de estado: 200
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
total_number |
Integer |
Número total de miembros del equipo de etiquetado. |
|
workers |
Array of Worker objects |
Lista de miembros de equipo de etiquetado consultada por página. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
create_time |
Long |
Tiempo de creación. |
|
description |
String |
Descripción del miembro del equipo de etiquetado. El valor contiene de 0 a 256 caracteres y no admite los siguientes caracteres especiales: ^!<>=&"' |
|
|
String |
Dirección de correo electrónico de un miembro del equipo de etiquetado. |
|
role |
Integer |
Rol. Opciones:
|
|
status |
Integer |
Estado actual de inicio de sesión de un miembro del equipo de etiquetado. Opciones:
|
|
update_time |
Long |
Tiempo de actualización. |
|
worker_id |
String |
ID de un miembro del equipo de etiquetado. |
|
workforce_id |
String |
ID de un equipo de etiquetado. |
Solicitudes de ejemplo
Consulta de la lista de miembros del equipo de etiquetado
GET https://{endpoint}/v2/{project_id}/workforces/{workforce_id}/workers
Ejemplo de respuestas
Código de estado: 200
OK
{
"total_number" : 3,
"workers" : [ {
"email" : "xxx@xxx.com",
"worker_id" : "b1e4054407ecb36a7bcde70f52ba37f2",
"workforce_id" : "gyb7IaAvkLc5IhEY2dv",
"status" : 0,
"role" : 2,
"description" : "",
"create_time" : 1606356324223,
"update_time" : 1606356324223
}, {
"email" : "xxx@xxx.com",
"worker_id" : "8c15ad080d3eabad14037b4eb00d6a6f",
"workforce_id" : "gyb7IaAvkLc5IhEY2dv",
"status" : 0,
"role" : 0,
"description" : "",
"create_time" : 1591783804629,
"update_time" : 1591783804629
}, {
"email" : "xxx@xxx.com",
"worker_id" : "2880f38d660dd68ca6ab578b5a1d9558",
"workforce_id" : "gyb7IaAvkLc5IhEY2dv",
"status" : 0,
"role" : 0,
"description" : "",
"create_time" : 1575104629439,
"update_time" : 1575104629439
} ]
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
200 |
OK |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
Códigos de error
Consulte Códigos de error.