Obtener todo (Clientes)

Obtener todo (Clientes) #

Obtiene todos los clientes de un revendedor

GET /v1.0/customers?pageIndex={pageIndex}& pageSize={pageSize}& filtro={filtro}

Parámetros Descripción
pageIndex Índice basado en 0 para permitir la consulta de páginas
Pagesize Tamaño de página que devolverá la solicitud. Máx. 1.000
filtro Parámetro de filtro opcional para buscar clientes por ' nombre' y ' referencia' Campos. A ' Contiene' La búsqueda se realiza en cualquier cadena proporcionada.
Color Wand tip
Recuerde URL Codifique el parámetro filter.

Ejemplo #

Esta solicitud obtendrá todos los inquilinos de cliente secundarios para este revendedor.

Pedir # 

GET <https://api.na.myreports.cloud/api/v1.0/customers> HTTP/1.1
Autorización: portador {TOKEN}

Respuesta # 

HTTP/1.1 200 OK
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: xx
{
	"page_size": 4,
	"page_index": 0,
	"Datos": [ {
			"id": "{CUSTOMER_TENANT_ID_1}",
			"name": "Cliente 1",
			"description": "Este es el cliente 1",
			"habilitado": verdadero,
			"parentTenantId": "{ACCOUNT_ID}",
			"Referencia": "Referencia del cliente 1",
			"dateCreated": "2019-01-01T09:00:00.000"
		}, {
			"id": "{CUSTOMER_TENANT_ID_2}",
			"name": "Cliente 2",
			"description": "Este es el cliente 2",
			"habilitado": falso,
			"parentTenantId": "{ACCOUNT_ID}",
			"referencia": "referencia del cliente 2",
			"dateCreated": "2019-01-01T09:00:00.000"
		}, {
			"id": "{CUSTOMER_TENANT_ID_3}",
			"name": "Cliente 3",
			"description": "Este es el cliente 3",
			"habilitado": falso,
			"parentTenantId": "{ACCOUNT_ID}",
			"referencia": "referencia del cliente 3",
			"dateCreated": "2019-01-01T09:00:00.000"
		}, {
			"id": "{CUSTOMER_TENANT_ID_4",
			"name": "Cliente 4",
			"description": "Este es el cliente 4",
			"habilitado": falso,
			"parentTenantId": "{ACCOUNT_ID}",
			"Referencia": "Referencia del cliente 4",
			"dateCreated": "2019-01-01T09:00:00.000"
		}
	][{
			"id": "{CUSTOMER_TENANT_ID_1}",
			"name": "Customer 1",
			"description": "This is Customer 1",
			"enabled": true,
			"parentTenantId": "{ACCOUNT_ID}",
			"reference": "customer reference 1",
			"dateCreated": "2019-01-01T09:00:00.000"
		}, {
			"id": "{CUSTOMER_TENANT_ID_2}",
			"name": "Customer 2",
			"description": "This is Customer 2",
			"enabled": false,
			"parentTenantId": "{ACCOUNT_ID}",
			"reference": "customer reference 2",
			"dateCreated": "2019-01-01T09:00:00.000"
		}, {
			"id": "{CUSTOMER_TENANT_ID_3}",
			"name": "Customer 3",
			"description": "This is Customer 3",
			"enabled": false,
			"parentTenantId": "{ACCOUNT_ID}",
			"reference": "customer reference 3",
			"dateCreated": "2019-01-01T09:00:00.000"
		}, {
			"id": "{CUSTOMER_TENANT_ID_4",
			"name": "Customer 4",
			"description": "This is Customer 4",
			"enabled": false,
			"parentTenantId": "{ACCOUNT_ID}",
			"reference": "customer reference 4",
			"dateCreated": "2019-01-01T09:00:00.000"
		}
	],
	"status": "éxito",
	"marca de tiempo": "2019-01-01T10:00:00.2890319Z"
}

Errores #

Desautorizado #

Cuando el token no se proporciona, no es válido o ha caducado 

HTTP/1.1 401 No autorizado