Overview
Overview of all resources and elements
| Function | Resource | Request | Answer |
|---|---|---|---|
| Hitlist via What/Where search | /v3/hitlistitems/whatwheresearch | SearchRequest, SearchFilter | HitListResultSet, HitListItem |
| Hitlist via address search | /v3/hitlistitems/adresssearch | Address, SearchFilter | HitListResultSet, HitListItem |
| Address match | /v3/matches | ProductCode, SearchedAddress, SearchFilter, MatchLevel, ReasonOfInquiry | MatchItem |
| Order | /v3/orders | Address, OrderReport | OrderData |
| Identified order | /v3/orders/identorders | CrefoId, OrderReport | OrderData |
| Order follow-up product | /v3/orders/{id}/followup | Id, OrderReport | OrderData |
| Upload proof of interest | /v3/orders/{id}/proofofinterest | Id, DocPI | http 204 No Content |
| Retrieve mailbox directory | /v3/mailboxentries | TypeFilter, PageSize, LastId | MailboxDirectoryItemPagedResultSet, MailboxDirectoryItem |
| Retrieve information from mailbox | /v3/mailboxentries/{id}/report | Id | Report |
| Obtain information online | /v3/reports | CrefoId, OrderReport | Report |
| Obtain information attachments | /v3/reports/{id}/attachments | Id, TypeFilter, OrderId | ReportAttachmentResultSet, ReportAttachment |
| Retrieve monitoring directory | /v3/monitorings (Get) | MonitoringFilter, PageSize, LastId | MonitoringOrderDataPagedResultSet, MonitoringOrderData |
| Register monitoring | /v3/monitorings (Post) | MonitoringOrder | MonitoringOrderData |
| Monitoring cancellation | /v3/monitorings/{id} | http 204 No Content | |
| Query product information | /v3/productinfos | CrefoId | ProductInfo |
Report consists the following elements:
- OrderData
- Address
- BasicContent
- ProductContent
- ExtendedProductContent
- CustomizedKeyValue (if available)
- MonitoringOrderData
- ReportPdf (PDF in Base64, depending on the selected format)
- ReportAttachmentAvailable
ReportAttachmentitem consists the following elements:
- DocumentType
- IssuedOn
- File (PDF als Base64)