Tout obtenir (clients)

Tout obtenir (clients) #

Obtient tous les clients d'un revendeur

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

Paramètres Description
pageIndex Index basé sur 0 pour permettre l'interrogation des pages
Pagesize Taille de la page à renvoyer par la requête. Max 1 000
filtre Paramètre de filtre facultatif permettant de rechercher des clients par ' nom' et ' référence' champs. A ' Contient' La recherche est effectuée sur n'importe quelle chaîne fournie.
Color Wand tip
N'oubliez pas de URL encoder le paramètre de filtre.

Exemple #

Cette demande permet d'obtenir tous les locataires clients enfants de ce revendeur.

Demander # 

GET <https://api.na.myreports.cloud/api/v1.0/customers> HTTP/1.1
Autorisation : Porteur {TOKEN}

Réponse # 

HTTP/1.1 200 OK
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : xx
{
	« page_size » : 4,
	« page_index » : 0,
	« données » : [ {
			« id » : « {CUSTOMER_TENANT_ID_1} »,
			« name » : « Client 1 »,
			« description » : « Il s'agit du client 1 »,
			« enabled » : true,
			« parentTenantId » : « {ACCOUNT_ID} »,
			« reference » : « référence client 1 »,
			« dateCreated » : « 2019-01-01T09:00:00.000 »
		}, {
			« id » : « {CUSTOMER_TENANT_ID_2} »,
			« name » : « Client 2 »,
			« description » : « Il s'agit du client 2 »,
			« enabled » : false,
			« parentTenantId » : « {ACCOUNT_ID} »,
			« reference » : « référence client 2 »,
			« dateCreated » : « 2019-01-01T09:00:00.000 »
		}, {
			« id » : « {CUSTOMER_TENANT_ID_3} »,
			« name » : « Client 3 »,
			« description » : « Il s'agit du client 3 »,
			« enabled » : false,
			« parentTenantId » : « {ACCOUNT_ID} »,
			« reference » : « référence client 3 »,
			« dateCreated » : « 2019-01-01T09:00:00.000 »
		}, {
			« id » : « {CUSTOMER_TENANT_ID_4 »,
			« name » : « Client 4 »,
			« description » : « Il s'agit du client 4 »,
			« enabled » : false,
			« parentTenantId » : « {ACCOUNT_ID} »,
			« reference » : « référence client 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 » : « succès »,
	« timestamp » : « 2019-01-01T10:00:00.2890319Z »
}

Erreurs #

Non autorisée #

Lorsque le jeton n'est pas fourni, qu'il n'est pas valide ou qu'il a expiré 

HTTP/1.1 401 Non autorisé