Get customer list customerlist.nv

Resource: customerlist.nv

HTTP-method: GET

This section describes how to retrieve a list of customers from Netvisor. The customer list contains basic information (NetvisorID, name, customer's code, company ID and URI for retrieving detailed customer information). Detailed customer information can then be retrieved with Get Customer Details.

Querystring parameters:

Parameter name	Occurs	Description	Example
keyword	0...1	Filters result list with given keyword. Match is searched from following fields: Name, Customer Code, Organization identifier, CoName. If the keyword parameter is given, changedsince is ignored.
changedsince	0...1	Filters result to contain only customers having change after given date, date in format YYYY-MM-DDThh:mm:ss	2012-01-01
customercodelist	0...1	Filters result with given customercodes. Customercodes should be separated with comma. The list can include maximum of 100 alfanumeric customer codes. Note! Parameter keyword can be used with customercodelist. Filters result with given customercodes AND with given keyword.

Keyword parameter is used over changedsince

Response:

Level	Element name	Type and length	Occurs	Description	Example
1	Customerlist	Aggr.	1
2	Customer	Aggr.	0...n
3	Netvisorkey	Integer	1	Customer identifier in Netvisor	123
3	Name	String	1	Name of the customer	Customer X
3	Code	String	1	Customer code	234
3	OrganisationIdentifier	String	1	Customers organization identifier if not consumer customer	12345678-9
3	CustomerGroupID	Integer	1	Customer Group ID, where the customer belongs. Can be empty.	2
3	CustomerGroupName	String	1	Customer Group Name, where the customer belongs. Can be empty	Customer group 1
3	Uri	String	1	URI that can be used to get details of current customer	/getcustomer.nv?id=123

Did you find it helpful? Yes No

Send feedback