Tento koncový bod vracia informácie o konkrétnom clientId. Používa sa na získanie podrobností o konkrétnom klientovi, vrátane:
- Údaje o jedinečnej identifikácii klienta
- Informácie o licencii
- Údaje o spoločnosti
- Obchodné údaje
- Informácie o pokladni
- Rôzne parametre
Upozornenie:
Je dôležité poznamenať, že clientId musí existovať v lokálnom systéme. Ak neexistuje, vráti sa chyba „Klient neexistuje. (Parameter 'clientId')“. Na zistenie dôvodu, prečo clientId nie je prítomný v lokálnom systéme, môže byť potrebná ďalšia analýza. Ak klient ešte nebol uvedený do prevádzky, je potrebné tak urobiť najskôr.
Výsledok
Úspešné volanie koncového bodu vráti odpoveď HTTP 200 a objekt JSON obsahujúci požadované informácie o kliente.
Príklad:
{
"uniqueClientId": "4ac109f5-5c7b-4173-b3b7-b403f472ac8f",
"licenseConsumerId": "f2a72f8c-104a-4fc1-add7-8f1254bce787",
"usedVersion": "1.7.1.0",
"distributerId": "20b7abfc-6abb-352e-b1fe-a14b1e507482",
"licenseKey": "xxxJhbGciOiJodHRwOi8zd3d3LmczLm7yZy8yMDAxLzA0L3htbGRzaWbtbW9zZ...",
"fiscalCountry": "[0] = Germany",
"fiscalRegion": null,
"companyNumber": "003",
"companyName": "Test Company - DE",
"companyAddress": {
"street": "Test Street",
"streetNumber": "99",
"postalCode": "10115",
"city": "Berlin",
"countryCode": "DEU"
},
"companyIdentification": [
{
"type": "[0] = VatNumber",
"identification": "TEST_000000"
}
],
"companyVatNumber": "TEST_000000",
"companyTaxNumber": null,
"fiscalYearStartMonth": 0,
"storeNumber": "00345",
"storeName": "Test Store 06 - DE",
"storeAddress": {
"street": "Test Street",
"streetNumber": "1",
"postalCode": "10115",
"city": "Berlin",
"countryCode": "DEU"
},
"terminalNumber": "00345",
"cashRegister": {
"id": "00000001",
"brand": "Test Model",
"modelname": "Model A",
"serialNumber": "123",
"currencyIsoCode": "EUR",
"software": {
"brand": "Test POS Software",
"version": "4.40.14",
"softwareCompany": "Test POS Company"
}
},
"testClient": true,
"fiscalModulImplementationConfiguration": {
"primaryTse": {
"tseDriver": "[99] = xxxxx",
"tseId": "xxxx....",
"tseGuid": null,
"useTseGuid": false,
"tseParameter": [
{
"parameterName": "apiKey",
"parameterValue": "test_xxx_test"
},
{
"parameterName": "apiSecret",
"parameterValue": "test_xyz_test"
},
{
"parameterName": "tseAdminPin",
"parameterValue": "123456"
},
{
"parameterName": "tseAdminPuk",
"parameterValue": "4099817164"
},
{
"parameterName": "tseMaxClients",
"parameterValue": ""
}
]
},
"fiscalCountry": "[0] = Germany",
"taxonomyFileStoreConfiguration": {
"localStorePath": "C:\\ProgramData\\RetailForce\\Fiscal Webservice",
"compress": true
},
"taxonomyCloudStoreConfiguration": null
},
"simpleCashPointClosing": true
}
Použitie
- Tento koncový bod sa používa na získanie informácií o konkrétnom kliente.
Požiadavky
- Nainštalovaný RetailForce Middleware,
- príslušný klient musí byť aktivovaný a prítomný v lokálnom systéme.
Pole formulára
Je potrebné uviesť nasledujúce informácie:
| Názov | Popis | Príklady |
| clientId | ID klienta, ktorého údaje sa majú načítať | aa227e71-6775-45d0-ba73-85da33c34d37 |
Odpoveď
Možné odpovede:
| Kód | Popis | Príklady |
| 200 | Žiadosť bola úspešná. Informácie o požadovanom clientId sú vrátené v objekte JSON. |
FORMÁT JSON
|
| 422 |
Požadované clientId neexistuje v lokálnom systéme. Riešenie problémov: Zistite príčinu, prečo client v lokálnom systéme (už) neexistuje. |
„Správa“: „Klient neexistuje. (Parameter 'clientId')“ |
| 404 |
Požadované clientId neexistuje v lokálnom systéme. Riešenie problémov: Zistite, prečo client v lokálnom systéme (už) neexistuje. |
"Správa": "Konfigurácia klienta pre aa227e71-6775-45d0-ba73-85da33c34d37 nebola nájdená." |
Tento článok bol preložený automaticky.
Príspevky
0 komentárov
Ak chcete napísať komentár, prihlásiť sa.