Mogelijke HTTP methodes: GET
GET
{apiurl}/clients/search-by-phonenumber/{telefoonnummer}
Voorbeeld:
ac/api/clients/search-by-phonenumber/0031612345678
Met deze methode kan er gezocht worden op klanten en contactpersonen die het gegeven telefoonnummer hebben. Deze aanroep is bedoeld voor VOIP telefonie koppelingen.
|
URL Deel |
Voorbeeld |
|
{apiurl} |
https://ac.klant.nl/ac/api |
|
{telefoonnummer} |
"0031612345678" of "0612345678" (telefoonnummer met landnummer) Landcode moet geschreven worden als 0031, waarbij de + vervangen wordt met 00 |
Response (voorbeeld)
[
{
"contactname": "Natte, Nathan (m)",
"clientkey": "19875DBC26DE3F52C12582B300331E1A",
"clientname": "Brouwerij 't IJ",
"link": "https://dev01.changetocomm.net/ac/redirect&target=client&clientkey=19875DBC26DE3F52C12582B300331E1A&key=DA3249B49AE399F6C12582C7002D6AB9&modulename=RELATIE#!/contact=31FEA97B4A553740C125838500454F3B",
"contactkey": "DA3249B49AE399F6C12582C7002D6AB9",
"clientshortname": "bierbrouwerij IJ",
"type": "contact",
"clientnumber": "00205241"
},
{
"clientkey": "19875DBC26DE3F52C12582B300331E1A",
"clientname": "Brouwerij 't IJ",
"link": "https://dev01.changetocomm.net/ac/redirect&target=client&clientkey=19875DBC26DE3F52C12582B300331E1A&key=19875DBC26DE3F52C12582B300331E1A&modulename=RELATIE",
"clientshortname": "bierbrouwerij IJ",
"type": "client",
"clientnumber": "00205241"
},
{
"contactname": "Karel - Karelsen, Karline (v)",
"clientkey": "E406966AA8332A5DC125806000588B2B",
"clientname": "Kinderopvang Knuffelbeer",
"link": "https://dev01.changetocomm.net/ac/redirect&target=client&clientkey=E406966AA8332A5DC125806000588B2B&key=1E2A649F5CBE5FCAC12580CE00595C96&modulename=RELATIE#!/contact=A482AD412776394AC1258385004543C2",
"contactkey": "1E2A649F5CBE5FCAC12580CE00595C96",
"clientshortname": "Kinderopvang Knuffelberen",
"type": "contact",
"clientnumber": "00202686"
}
]
Er zal altijd een json array terug worden gegeven. Indien er geen klanten of contactpersonen gevonden kunnen worden op het gegeven nummer zal de response: [] zijn.
|
Property name |
Value |
Type |
|
clientkey |
Unieke technische sleutel van de klant |
String |
|
clientname |
Naam van de gevonden klant |
String |
|
clientshortname |
De zoeknaam van de klant. | String |
|
type |
Hier komt uit: "client" = telefoonnummer is gevonden op een klantkaart "contact" = telefoonnummer is gevonden op een contactpersoon |
String |
|
link |
Dit is een volledige link waarbij de gevonden klant of contactpersoon in AuditCase geopend kunnen worden. | String |
|
contactkey |
(Optioneel) indien type = "contact" dan komt hier een technische sleutel van de contactpersoon uit. | String |
|
contactname |
(Optioneel) indien type = "contact" dan komt hier de naam van de contactpersoon uit. | String |