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

Този ендпойнт връща информация за конкретен clientId. Използва се за извличане на подробности за конкретен клиент, включително:

Данни за уникалната идентификация на клиента
Информация за лиценза
Данни за компанията
Бизнес данни
Информация за касовия апарат
Различни параметри

Внимание: Важно е да се отбележи, че clientId трябва да съществува в локалната система. Ако не съществува, ще бъде върната грешка „Клиентът не съществува. (Параметър 'clientId')“. Може да се наложи допълнителен анализ, за да се установи защо clientId не присъства в локалната система. Ако клиентът все още не е пуснат в експлоатация, това трябва да се направи първо.

Резултат

Успешното извикване на крайната точка връща HTTP отговор 200 и JSON обект, съдържащ поисканата информация за клиента.

Пример:

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

Употреба

Този ендпойнт се използва за извличане на информация за конкретен client.

Изисквания

Инсталирован RetailForce Fiscal Middleware,
съответният client да е активиран и да присъства в локалната система.

Полета във формуляра

Трябва да бъде предоставена следната информация:

Етикет	Описание	Примери
clientId	ID-то на клиента, който трябва да бъде извлечен	aa227e71-6775-45d0-ba73-85da33c34d37

Отговор

Възможни отговори:

Код	Описание	Примери
200	Успешно заявка. Информацията за поискания clientId се връща в JSON обект.	ФОРМАТ JSON
422	Заявеният clientId не съществува в локалната система. Отстраняване на проблема: Анализирайте причината, поради която клиентът не съществува (вече) в локалната система.	"Съобщение": "Клиентът не съществува. (Параметър 'clientId')"
404	Заявеният clientId не съществува в локалната система. Отстраняване на проблема: Анализирайте причината, поради която клиентът вече не съществува в локалната система.	"Съобщение": "Конфигурацията на клиента за aa227e71-6775-45d0-ba73-85da33c34d37 не беше намерена."

Тази статия е преведена автоматично.

Резултат

Полета във формуляра

Отговор

Подобни статии