Übersicht
Übersicht über alle Ressourcen und Elemente
| Funktion | Ressource | Request | Answer |
|---|---|---|---|
| Hitlist via What/Where-Suche | /v3/hitlistitems/whatwheresearch | SearchRequest, SearchFilter | HitListResultSet, HitListItem |
| Hitlist via Adress-Suche | /v3/hitlistitems/adresssearch | Address, SearchFilter | HitListResultSet, HitListItem |
| Adresse matchen | /v3/matches | ProductCode, SearchedAddress, SearchFilter, MatchLevel, ReasonOfInquiry | MatchItem |
| Bestellung | /v3/orders | Address, OrderReport | OrderData |
| Identifizierte Bestellung | /v3/orders/identorders | CrefoId, OrderReport | OrderData |
| Nachfolgeprodukt bestellen | /v3/orders/{id}/followup | Id, OrderReport | OrderData |
| Interessennachweis hochladen | /v3/orders/{id}/proofofinterest | Id, Fileupload | http 204 No Content |
| Mailboxverzeichnis abrufen | /v3/mailboxentries | TypeFilter, PageSize, LastId | MailboxDirectoryItemPagedResultSet, MailboxDirectoryItem |
| Auskunft aus der Mailbox abholen | /v3/mailboxentries/{id}/report | Id | Report |
| Auskunft online beziehen | /v3/reports | CrefoId, OrderReport | Report |
| Auskunftsbeilagen beziehen | /v3/reports/{id}/attachments | Id, TypeFilter, OrderId | ReportAttachmentResultSet, ReportAttachment |
| Monitoringverzeichnis abrufen | /v3/monitorings (Get) | MonitoringFilter, PageSize, LastId | MonitoringOrderDataPagedResultSet, MonitoringOrderData |
| Monitoring anmelden | /v3/monitorings (Post) | MonitoringOrder | MonitoringOrderData |
| Monitoring abmelden | /v3/monitorings/{id} | http 204 No Content | |
| Produktinfo abfragen | /v3/productinfos | CrefoId | ProductInfo |
Report besteht aus folgenden Elementen:
- OrderData
- Address
- BasicContent
- ProductContent
- ExtendedProductContent
- CustomizedKeyValue (falls vorhanden)
- MonitoringOrderData
- ReportPdf (PDF in Base64, ja nach gewähltem Format)
- ReportAttachmentAvailable
ReportAttachmentitem besteht aus folgenden Elementen:
- DocumentType
- IssuedOn
- File (PDF als Base64)