Skip to content

Command 17 — Get a client's datarework

GET /client/{clientID}. Same information, JSON instead of XML, with a handful of renamed fields and a few that moved elsewhere. Two behaviours change: the id must be the client’s current id, and the call no longer activates the client app.

V2 checks an app permission on every call — V1 checked none — and a call whose permission is missing answers 400 with errorCode 15, the same status as an invalid payload (see 4.4). Grant these to the API user before porting the command; the names are the ones of the permission tree in flowww.

CallPermission
GET /client/{clientID}Clients → Clients - Edit
GET /referer/{refererID}Clients - Contact Origin Catalog → Edit
GET /system/countriesGeneral → Settings - Load
API V1
curl --location 'https://euapi.flowww.net/v1/fwa_external_get.asp?cmd=17&doctor=USER_LOGIN&pass=USER_PASS&country=ES&key=SYSTEM_KEY&ClientID=1&ClientFWA=0'
API V2
curl --location 'https://api.flowww.net/v2/client/1?clinicID=1' \
--header 'Authorization: Bearer <api_key>'
V1 elementV2 fieldNotes
Result—Replaced by the HTTP status. A missing — or merged — client is 404, not Result=0.
ClientID, ClientNumber, ClientClinicID, ClientRefererID, ClientName, ClientSurname1/2, ClientSex, ClientIDClass, ClientPhone1/2, ClientEmail, ClientAddress, ClientPostCode, ClientNotes, ClientSMSDisabled, ClientAppToken, ClientAppDisabled, ClientCustom1…10same namesStraight across.
ClientDNIClientNIFRenamed — note V1 was already inconsistent (it took ClientNIF on write and returned ClientDNI on read).
ClientBirthDayClientBirthDateRenamed.
ClientCityNameClientCityRenamed.
ClientProvinceISO3166_2 + ClientProvinceNameClientProvinceID + ClientProvinceNumeric id instead of the ISO code.
ClientCountryISO3166_1_alfa2 + ClientCountryNameClientCountryID + ClientCountrySame change.
ClientRefererDesc—Only the id comes back. Resolve the description with GET /referer/{refererID}.
ClientClinicName, ClientDatesame namesEmpty when the clinic uses the extended marketing record of the client.
ClientLoginClientFWALoginApp login of the client.
ClientWarnings* (5 fields)—Client alerts are their own resource now: GET /client/{clientID}/alert?clinicID=….
ClientLastSessionDate—Not in the detail payload. It is returned by the search endpoints (command 24) together with ClientLastPurchaseDate.
—ClientLifeCycleStageName, ClientConsent* (6), ClientEnableRGPD, ClientEnableGeneralConditions, ClientVIP, ClientCardNumber, ClientHistory, ClientVouchers, ClientDeferred, ClientRep*New in V2, free of charge.
TopicAPI V1API V2
Merged clientsAn old id was translated to the surviving client, and its data returned.404. The absorbed record no longer exists. Search the client again and store the new id — see 4.7.
ClientFWA=1Was an action: it activated the client app (and created the token) if it was not active yet.Gone from the GET, which only reads. To activate the app on an existing client, send ClientFWA: 1 in command 18; it generates ClientAppToken if the client had none, and this call reads it back.
Other failuresResult=0 with a code.Any failure reading the client answers 404. Permissions and an invalid clinic answer 400, with the reason in errorCode.
AnswerMeaningWhat to do
404The client does not exist, or was merged into another one.Search it again (GET /client?clientData=).
400 (errorCode 15)The API user lacks Clients → Clients → See a client’s record.Grant the permission.