Ten punkt końcowy zwraca informacje dotyczące konkretnego identyfikatora clientId. Służy on do pobrania szczegółowych danych o danym kliencie, w tym:
- Unikalne dane identyfikacyjne klienta
- Informacje dotyczące licencji
- Dane firmy
- Dane biznesowe
- Informacje dotyczące kasy fiskalnej
- Różne parametry
Wynik
Pomyślne wywołanie punktu końcowego zwraca odpowiedź HTTP 200 oraz obiekt JSON zawierający żądane informacje o kliencie.
Przykład:
{
"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
}
Zastosowanie
- Ten punkt końcowy służy do pobierania informacji o konkretnym kliencie.
Wymagania
- Zainstalowane oprogramowanie RetailForce Middleware,
- aktywacja odpowiedniego klienta oraz jego obecność w systemie lokalnym.
Pola formularza
Należy podać następujące informacje:
| Etykieta | Opis | Przykłady |
| clientId | ID klienta, którego dane mają zostać pobrane | aa227e71-6775-45d0-ba73-85da33c34d37 |
Odpowiedź
Możliwe odpowiedzi:
| Kod | Opis | Przykłady |
| 200 | Żądanie zakończone powodzeniem. Informacje dotyczące żądanego identyfikatora clientId są zwracane w obiekcie JSON. |
FORMAT JSON
|
| 422 |
Żądany identyfikator clientId nie istnieje w systemie lokalnym. Rozwiązywanie problemów: Proszę przeanalizować przyczynę, dla której client nie istnieje (już) w systemie lokalnym. |
„Komunikat”: „Klient nie istnieje. (Parametr „clientId”)” |
| 404 |
Żądany identyfikator clientId nie istnieje w systemie lokalnym. Rozwiązywanie problemów: Proszę przeanalizować przyczynę, dla której client nie istnieje (już) w systemie lokalnym. |
„Komunikat”: „Nie znaleziono konfiguracji klienta dla aa227e71-6775-45d0-ba73-85da33c34d37.” |
Ten artykuł został przetłumaczony automatycznie.
Komentarze
Komentarze: 0
Zaloguj się, aby dodać komentarz.