Obter todos (clientes)

Obter todos (clientes) #

Obtém todos os clientes para um revendedor

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

Parâmetros Descrição
pageIndex Índice baseado em 0 para permitir a consulta de páginas
pageSize Tamanho da página a ser retornado pela solicitação. Máximo 1.000
filtrar Parâmetro de filtro opcional para pesquisar clientes por » nome' e » referência' campos. A » Contém' A pesquisa é realizada em qualquer cadeia de caracteres fornecida.
Color Wand tip
Lembre-se de URL Codifique o parâmetro Filter.

Exemplo #

Este pedido irá obter todos os inquilinos filhos do Cliente para este Revendedor.

Solicitar # 

GET <https://api.na.myreports.cloud/api/v1.0/customers> HTTP/1.1
Autorização: Portador {TOKEN}

Resposta # 

HTTP/1.1 200 OK
Tipo de conteúdo: application/json; charset=utf-8
Conteúdo-Comprimento: xx
{
	"page_size": 4,
	"page_index": 0,
	"dados": [ {
			"id": "{CUSTOMER_TENANT_ID_1}",
			"nome": "Cliente 1",
			"descrição": "Este é o Cliente 1",
			"habilitado": true,
			"parentTenantId": "{ACCOUNT_ID}",
			"referência": "referência do cliente 1",
			"dateCreated": "2019-01-01T09:00:00.000"
		}, {
			"id": "{CUSTOMER_TENANT_ID_2}",
			"nome": "Cliente 2",
			"descrição": "Este é o Cliente 2",
			"habilitado": false,
			"parentTenantId": "{ACCOUNT_ID}",
			"referência": "referência do cliente 2",
			"dateCreated": "2019-01-01T09:00:00.000"
		}, {
			"id": "{CUSTOMER_TENANT_ID_3}",
			"nome": "Cliente 3",
			"descrição": "Este é o Cliente 3",
			"habilitado": false,
			"parentTenantId": "{ACCOUNT_ID}",
			"referência": "referência do cliente 3",
			"dateCreated": "2019-01-01T09:00:00.000"
		}, {
			"id": "{CUSTOMER_TENANT_ID_4",
			"nome": "Cliente 4",
			"descrição": "Este é o Cliente 4",
			"habilitado": false,
			"parentTenantId": "{ACCOUNT_ID}",
			"referência": "referência do 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": "sucesso",
	"carimbo de data/hora": "2019-01-01T10:00:00.2890319Z"
}

Erros #

Não autorizado #

Quando o token não é fornecido, inválido ou expirado 

HTTP/1.1 401 Não autorizado