Mogelijke HTTP methodes: GET
URL
{apiurl}/viewdata/clients
GET
Met deze aanroep kan er snel door klanten in AuditCase worden gezocht. Er kan worden gezocht op de velden klantnummer, zoeknaam en klantnaam. De waarde bij header "startKey" is de begintekst de velden. Dus "ABC" zal "ABCD B.v." vinden maar niet "00ABCD B.v.".
Het aantal resultaten dat maximaal teruggegeven kan worden is gelimiteerd op 500.
Header |
Value |
Verplicht |
X-startKey |
"ABC" |
NEE |
Response (voorbeeld)
[
{
"$col1": "1001004",
"$col2": "HAPJES",
"$col3": "Eetcafé Hapjes",
"$col4": "Klant",
"$col5": "Barneveld",
"$col6": "Straatweg 30",
"$id": "BF1CE0157D54C29CC1257CB7004EBD12"
},
]
Er komt meer informatie terug voor intern gebruik AuditCase. Er kan uitgegaan worden van minimaal de volgende informatie:
Property name |
Value |
Type |
$id |
Unieke sleutel van het document. |
String |
$col1 |
Klantnummer |
String |
$col2 |
Zoeknaam |
String |
$col3 |
Klantnaam |
String |
$col4 |
Klantstatus |
String |
$col5 |
Plaats |
String |
$col6 |
Straat + huisnummer (vestigingsadres) | String |
Deze call ondersteund Paging.