3 API3.6
3.6
Vyhľadanie v katalógu: GET /catalogue/{code}
Vyhľadanie jedného kódu v katalógu.
- V sandboxe
Jednoducho povedané
Toto volanie zrozumiteľne vysvetlí jeden chybový kód: čo je zle, čo robiť a kto má konať.
GET /catalogue/{code} vráti verejnú časť jednej položky katalógu. Každé zistenie v protokole a každá chyba v 422 obsahuje jeden z týchto kódov. Volanie vyžaduje kľúč s oprávnením read. Kódom môže byť aj niektorý z jeho aliasov.
| Pole | Význam |
|---|---|
id | Kód. |
meaning | Čo je zle. |
fix | Čo s tým robiť. |
owner | Kto má konať: us alebo niektorá z ďalších strán na stránke chyby a katalóg. |
severity | error, business, warning alebo info. |
routes | Kanály, na ktoré sa kód vzťahuje. ALL znamená každý kanál. |
partner_message | Veta, ktorú by sme poslali klientovi. Pri niektorých kódoch je vo viacerých jazykoch. |
curl "https://api-sandbox-eu.eurinvoice.com/catalogue/EI-SCHEMA" \
-H "Authorization: Bearer <your-api-key>"import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder(URI.create("https://api-sandbox-eu.eurinvoice.com/catalogue/EI-SCHEMA"))
.header("Authorization", "Bearer <your-api-key>")
.GET()
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}const response = await fetch('https://api-sandbox-eu.eurinvoice.com/catalogue/EI-SCHEMA', {
headers: {
Authorization: 'Bearer <your-api-key>',
},
});
console.log(response.status);
console.log(await response.text());{
"severity": "error",
"owner": "us",
"routes": [
"ALL"
],
"partner_message": "We could not read this invoice from your export. We are correcting our mapping; if a field is missing in the ERP we will tell you which one.",
"fix": "Read the JSON path in the error and correct the client mapping.",
"meaning": "The invoice JSON does not match the canonical model: a missing or unknown field, a wrong type or code, or a route rule on structure.",
"id": "EI-SCHEMA"
}Pre kód, ktorý nie je v katalógu, je odpoveď 404.
curl "https://api-sandbox-eu.eurinvoice.com/catalogue/NO-SUCH-CODE" \
-H "Authorization: Bearer <your-api-key>"import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder(URI.create("https://api-sandbox-eu.eurinvoice.com/catalogue/NO-SUCH-CODE"))
.header("Authorization", "Bearer <your-api-key>")
.GET()
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}const response = await fetch('https://api-sandbox-eu.eurinvoice.com/catalogue/NO-SUCH-CODE', {
headers: {
Authorization: 'Bearer <your-api-key>',
},
});
console.log(response.status);
console.log(await response.text());{
"detail": "NO-SUCH-CODE",
"type": "https://eurinvoice.com/problems/not-found",
"title": "No such catalogue entry",
"status": 404
}Odpovede
| Stav | Význam |
|---|---|
200 | Položka. |
401 | Chýba kľúč alebo je neznámy. |
403 | Kľúču chýba oprávnenie read. |
404 | Taká položka katalógu neexistuje. |
429 | Príliš veľa požiadaviek pre kľúč. Počkajte Retry-After sekúnd. |