Obter tudo (clientes)

Obter tudo (clientes) #

Obtém todos os clientes para um revendedor

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

Parâmetros Descrição
índice de páginas 0 índice baseado para permitir a consulta de páginas
Pagesize Tamanho da página a ser retornado pela solicitação. Máximo de 1.000
filtro Parâmetro de filtro opcional para pesquisar clientes por ' nome' e ' referência' Campos. Um ' Contém' A pesquisa é executada em qualquer cadeia de caracteres fornecida.
Color Wand tip
Lembre-se de URL codifique o parâmetro filter.

Exemplo #

Essa solicitação obterá todos os locatários do cliente filho para esse revendedor.

Pedir # 

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: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: xx
{
	"page_size": 4,
	"page_index": 0,
	"dados": [ {
			"id": "{CUSTOMER_TENANT_ID_1}",
			"name": "Cliente 1",
			"description": "Este é o Cliente 1",
			"habilitado": verdadeiro,
			"parentTenantId": "{ACCOUNT_ID}",
			"reference": "referência do cliente 1",
			"dateCreated": "2019-01-01T09:00:00.000"
		}, {
			"id": "{CUSTOMER_TENANT_ID_2}",
			"name": "Cliente 2",
			"description": "Este é o Cliente 2",
			"ativado": falso,
			"parentTenantId": "{ACCOUNT_ID}",
			"reference": "Referência do cliente 2",
			"dateCreated": "2019-01-01T09:00:00.000"
		}, {
			"id": "{CUSTOMER_TENANT_ID_3}",
			"name": "Cliente 3",
			"description": "Este é o Cliente 3",
			"ativado": falso,
			"parentTenantId": "{ACCOUNT_ID}",
			"reference": "referência do cliente 3",
			"dateCreated": "2019-01-01T09:00:00.000"
		}, {
			"id": "{CUSTOMER_TENANT_ID_4",
			"name": "Cliente 4",
			"description": "Este é o Cliente 4",
			"ativado": falso,
			"parentTenantId": "{ACCOUNT_ID}",
			"reference": "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",
	"timestamp": "2019-01-01T10:00:00.2890319Z"
}

Erros #

Desautorizado #

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

HTTP/1.1 401 Não autorizado