Resource: customerlist.nv
HTTP-method: GET
Retrieve the Netvisor customer list. The customer list contains basic information (NetvisorID, name, customer's code, Business id for company customers, URI for retrieving detailed customer details). Detailed customer details can then be retrieved using the Get Customer Details function.
Querystring parameters:
Parameter name | Occurs | Description | Example |
keyword | 0...1 | Filters the list with the given keyword. Returns customers that have the keyword*. |
|
changedsince | 0...1 | Filters customers with changes after the given date. Date format YYYY-MM-DDThh:mm:ss | 2014-09-13 |
customercodelist | 0...1 | Comma-separated list of customer codes to filter the returned customers. The list can contain up to 100 alphanumeric customer codes. Note! The keyword parameter can be given with the customercodelist parameter. In this case, the resource returns customers with a customer code from the list AND the keyword in one of the keyword search fields. |
|
If the keyword parameter is given, changedsince is ignored.
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 |
This article has been translated using an AI-based translation tool. The contents or wording of these instructions may differ from those in other instructions or in the software.