GET /api/v1/management/clients/ {clientId} – RetailForce

Ova krajnja točka vraća informacije o određenom ClientId-u. Koristi se za dohvaćanje detalja o određenom klijentu, uključujući:

Jedinstveni identifikacijski podaci klijenta
Informacije o licenci
Podaci o tvrtki
Poslovni podaci
Informacije o blagajni
Razni parametri

Pažnja: Važno je napomenuti da ClientId mora postojati u lokalnom sustavu. Ako ne postoji, pojavit će se pogreška "Client does not exist. (Parametar 'clientId')" će biti vraćena. Možda će biti potrebna daljnja analiza kako bi se utvrdilo zašto ClientId ne postoji u lokalnom sustavu. Ako klijent još nije pušten u rad, to se mora prvo učiniti.

Rezultat

Uspješni poziv na krajnju točku vraća HTTP odgovor 200 i JSON objekt koji sadrži tražene informacije o klijentu.

Primjer:

{
  "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
}

Upotreba

Ova krajnja točka služi za dohvaćanje informacija o određenom klijentu.

Zahtjevi

RetailForce Fiscal Middleware instaliran,
relevantni klijent je aktiviran i prisutan u lokalnom sustavu.

Polja obrasca

Sljedeće informacije potrebno je dostaviti:

Oznaka	Opis	Primjeri
ID klijenta	ID klijenta koji se treba dohvatiti	aa227e71-6775-45d0-ba73-85da33c34d37

Odgovor

Mogući odgovori:

Kod	Opis	Primjeri
200	Uspješan zahtjev. Informacije za traženi ClientId vraćene su u JSON objektu.	JSON FORMAT
422	Zatraženi ClientId ne postoji u lokalnom sustavu. Rješavanje problema: Analizirajte uzrok zašto klijent ne postoji (više) u lokalnom sustavu.	"Poruka": "Klijent ne postoji. (Parametar 'clientId')"
404	Zatraženi ClientId ne postoji u lokalnom sustavu. Rješavanje problema: Analizirajte uzrok zašto klijent (više) ne postoji u lokalnom sustavu.	"Poruka": "Konfiguracija klijenta za aa227e71-6775-45d0-ba73-85da33c34d37 nije pronađena."

Ovaj je članak automatski preveden.

Rezultat

Polja obrasca

Odgovor

Povezani članci