Dieser Endpunkt gibt Informationen zu einer spezifischen ClientId zurück. Er wird verwendet, um Details zu einem bestimmten Mandanten (Client) zu erhalten:
- Eindeutige Client-Identifikationsdaten
- Lizenzinformationen
- Firmendaten
- Geschäftsdaten
- Kasseninformationen
- weitere Parameter
Achtung: Es ist wichtig zu beachten, dass die ClientId im lokalen System vorhanden sein muss. Sollte dies nicht der Fall sein, wird der Fehler "Client does not exist. (Parameter 'clientId')" zurückgegeben. Eventuell muss hier eine weitere Analyse erfolgen, warum die ClientId nicht im lokalen System vorhanden ist. Sollte der Client noch nicht in Betrieb genommen worden sein, muss diese zuerst erfolgen.
Ergebnis
Ein erfolgreicher Aufruf des Endpunkts liefert eine HTTP-200-Antwort und ein JSON-Objekt mit den Informationen zum angefragten Client.
Beispiel:
{
"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": "Testfirma - DE",
"companyAddress": {
"street": "Teststraße",
"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": "Teststore 06 - DE",
"storeAddress": {
"street": "Teststraße",
"streetNumber": "1",
"postalCode": "10115",
"city": "Berlin",
"countryCode": "DEU"
},
"terminalNumber": "00345",
"cashRegister": {
"id": "00000001",
"brand": "Testmodel",
"modelname": "ModelA",
"serialNumber": "123",
"currencyIsoCode": "EUR",
"software": {
"brand": "TestPOS Software",
"version": "4.40.14",
"softwareCompany": "TestPOS 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
}
Verwendung
- Dieser Endpunkt wird verwendet, um Informationen über einen bestimmten Client abzurufen.
Voraussetzungen
- RetailForce Fiskal Middleware installiert,
- betreffender Client aktiviert und im lokalen System vorhanden.
Formularfelder
Folgende Informationen müssen übermittelt werden:
Bezeichnung | Beschreibung | Beispiele |
clientId | Die ID des abzurufenden Mandanten (Clients) | aa227e71-6775-45d0-ba73-85da33c34d37 |
Antwort
Mögliche Antworten:
Code | Beschreibung | Beispiele |
200 | Erfolgreiche Anfrage. Die Informationen zu der angefragten ClientId werden in einem JSON-Objekt zurückgegeben. |
JSON-FORMAT
|
422 |
Die angefragte ClientId existiert nicht im lokalen System. Fehlerbehebung: Ursachenanalyse, warum der Client im lokalen System nicht (mehr) existiert. |
"Message": "Client does not exist. (Parameter 'clientId')" |
404 |
Die angefragte ClientId existiert nicht im lokalen System. Fehlerbehebung: Ursachenanalyse, warum der Client im lokalen System nicht (mehr) existiert. |
"Massage": "Client configuration for aa227e71-6775-45d0-ba73-85da33c34d37 was not found." |
Kommentare
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.