Release 2.73 - Precise documentation for list of all applications (#197)

* Extend description of the fields at Antrag, which are not returned in the list of all applications
* More precise description of the endpoints with Antraege
* More precise description of filled fields in the list of all applications

---------

Co-authored-by: Stefan Koch <[email protected]>

README.md

@@ -51,7 +51,8 @@ To start tests begin with [Get a list of applications](#get-a-list-of-applicatio
 
 ## Segments of Antragsnummer
 
-Europace is a multi-lender plattform. For this case antragsnummer is segmented by / for different solutions and applications
+Europace is a multi-lender plattform.
+For this case antragsnummer is segmented by / for different solutions and applications.
 
 Example: `ABC12F/2/1`
 
@@ -89,7 +90,7 @@ Furthermore maybe: \
 
 ## Get all the data you need for approval
 
-### Get a list of applications
+### Get a list of all applications
 
 As loan provider, you'll get a list of all your applications, sorted by lastChanged, paged and filterable.
 
@@ -160,6 +161,16 @@ You can filter the results by using the following parameters:
 - aenderungSeit (lastChangeUntil for getting all changes after the last call)
 - and many more - see documentation
 
+Please note that in the list of all applications only the following fields are filled in (if data is available):
+
+- `antragsNummer`
+- `antragsReferenz`
+- `datenKontext`
+- `entscheidungsreifeVomVertriebSignalisiert`
+- `letzteAenderung`
+- `letztesEreignis`
+- `zeitpunktDerAnnahme`
+
 #### Get all applications changed since
 
 Example request:

docs/index.html

@@ -463,9 +463,9 @@ <h1>Anträge API</h1>
 <ul class="sectlevel2">
 <li><a href="#_antraege_resource">Antraege</a>
 <ul class="sectlevel3">
-<li><a href="#_getantraegelist">get all applications</a></li>
-<li><a href="#_getantraegebyvorgangnummer">get applications of a case</a></li>
-<li><a href="#_getantrag">get approvals of an application</a></li>
+<li><a href="#_getantraegelist">get list of all applications</a></li>
+<li><a href="#_getantraegebyvorgangnummer">get list of all applications of a case</a></li>
+<li><a href="#_getantrag">get list of approvals of an application</a></li>
 <li><a href="#_getantrag_1">get application</a></li>
 <li><a href="#_updateantrag">patch application</a></li>
 <li><a href="#_getangebot">get offer</a></li>
@@ -602,7 +602,7 @@ <h2 id="_overview">Overview</h2>
 <div class="sect2">
 <h3 id="_version_information">Version information</h3>
 <div class="paragraph">
-<p><em>Version</em> : 2.72</p>
+<p><em>Version</em> : 2.73</p>
 </div>
 </div>
 <div class="sect2">
@@ -700,7 +700,7 @@ <h3 id="_antraege_resource">Antraege</h3>
 <p>All about mortage-applications and -approvals.</p>
 </div>
 <div class="sect3">
-<h4 id="_getantraegelist">get all applications</h4>
+<h4 id="_getantraegelist">get list of all applications</h4>
 <div class="literalblock">
 <div class="content">
 <pre>GET /v2/antraege</pre>
@@ -1090,7 +1090,7 @@ <h5 id="_security">Security</h5>
 </div>
 </div>
 <div class="sect3">
-<h4 id="_getantraegebyvorgangnummer">get applications of a case</h4>
+<h4 id="_getantraegebyvorgangnummer">get list of all applications of a case</h4>
 <div class="literalblock">
 <div class="content">
 <pre>GET /v2/antraege/{vorgang}</pre>
@@ -1099,7 +1099,7 @@ <h4 id="_getantraegebyvorgangnummer">get applications of a case</h4>
 <div class="sect4">
 <h5 id="_description_2">Description</h5>
 <div class="paragraph">
-<p>As advisor, you&#8217;ll get all applications of your case.</p>
+<p>As advisor, you&#8217;ll get a list of all applications of your case.</p>
 </div>
 </div>
 <div class="sect4">
@@ -1322,7 +1322,7 @@ <h5 id="_security_2">Security</h5>
 </div>
 </div>
 <div class="sect3">
-<h4 id="_getantrag">get approvals of an application</h4>
+<h4 id="_getantrag">get list of approvals of an application</h4>
 <div class="literalblock">
 <div class="content">
 <pre>GET /v2/antraege/{vorgang}/{antrag}</pre>
@@ -4324,7 +4324,7 @@ <h3 id="_antrag">Antrag</h3>
 <em>optional</em></p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>The offer on which the application is based on.</p>
+<p>The offer on which the application is based on. Not returned in the list of all applications.</p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p><a href="#_angebotzumantrag">AngebotZumAntrag</a></p>
@@ -4336,7 +4336,7 @@ <h3 id="_antrag">Antrag</h3>
 <em>optional</em></p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>clerk</p>
+<p>clerk. Not returned in the list of all applications.</p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p><a href="#_partner">Partner</a></p>
@@ -4372,7 +4372,7 @@ <h3 id="_antrag">Antrag</h3>
 <em>optional</em></p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>information about advisor type</p>
+<p>information about advisor type. Not returned in the list of all applications.</p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p><a href="#_beratung">Beratung</a></p>
@@ -4396,7 +4396,7 @@ <h3 id="_antrag">Antrag</h3>
 <em>optional</em></p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>all generated documents, shared proofs and documents uploaded by loan provider</p>
+<p>all generated documents, shared proofs and documents uploaded by loan provider. Not returned in the list of all applications.</p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p>&lt; <a href="#_dokument">Dokument</a> &gt; array</p>
@@ -4420,7 +4420,7 @@ <h3 id="_antrag">Antrag</h3>
 <em>optional</em></p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>loan officer</p>
+<p>loan officer. Not returned in the list of all applications.</p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p><a href="#_partner">Partner</a></p>
@@ -4455,7 +4455,9 @@ <h3 id="_antrag">Antrag</h3>
 <p><strong>produktAnbieter</strong><br>
 <em>optional</em></p>
 </div></div></td>
-<td class="tableblock halign-left valign-middle"><div class="content"></div></td>
+<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
+<p>Not returned in the list of all applications.</p>
+</div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p><a href="#_produktanbieter">ProduktAnbieter</a></p>
 </div></div></td>
@@ -4465,7 +4467,9 @@ <h3 id="_antrag">Antrag</h3>
 <p><strong>prolongation</strong><br>
 <em>optional</em></p>
 </div></div></td>
-<td class="tableblock halign-left valign-middle"><div class="content"></div></td>
+<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
+<p>Not returned in the list of all applications.</p>
+</div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p>boolean</p>
 </div></div></td>
@@ -4476,7 +4480,7 @@ <h3 id="_antrag">Antrag</h3>
 <em>optional</em></p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>state of application</p>
+<p>state of application. Not returned in the list of all applications.</p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p><a href="#_antragsstatus">AntragsStatus</a></p>
@@ -4488,7 +4492,7 @@ <h3 id="_antrag">Antrag</h3>
 <em>optional</em></p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>advisor</p>
+<p>advisor. Not returned in the list of all applications.</p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p><a href="#_partner">Partner</a></p>
@@ -4500,7 +4504,7 @@ <h3 id="_antrag">Antrag</h3>
 <em>optional</em></p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>distribution channels of advisor and/or clerk at creation date of application</p>
+<p>distribution channels of advisor and/or clerk at creation date of application. Not returned in the list of all applications.</p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p><a href="#_vertriebsstruktur">VertriebsStruktur</a></p>
@@ -4512,7 +4516,7 @@ <h3 id="_antrag">Antrag</h3>
 <em>optional</em></p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>estimated approval date</p>
+<p>estimated approval date. Not returned in the list of all applications.</p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p>string (date)</p>
@@ -4524,7 +4528,7 @@ <h3 id="_antrag">Antrag</h3>
 <em>optional</em></p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>advisors reference for case</p>
+<p>advisors reference for case. Not returned in the list of all applications.</p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p>string</p>
@@ -4536,7 +4540,7 @@ <h3 id="_antrag">Antrag</h3>
 <em>optional</em></p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>additional loan providers references. Will be visible to the advisor.</p>
+<p>additional loan providers references. Will be visible to the advisor. Not returned in the list of all applications.</p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p>&lt; string, string &gt; map</p>
@@ -4560,7 +4564,7 @@ <h3 id="_antrag">Antrag</h3>
 <em>optional</em></p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>data of applicants, property and project, wich is the source for application</p>
+<p>data of applicants, property and project, wich is the source for application. Not returned in the list of all applications.</p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p><a href="#_zugrundeliegendedatenzumantrag">ZugrundeliegendeDatenZumAntrag</a></p>
@@ -14087,7 +14091,7 @@ <h3 id="_zahlungsplan">zahlungsplan</h3>
 <div id="footer">
 <div id="footer-text">
 Version unspecified<br>
-Last updated 2024-05-22 09:24:43 +0200
+Last updated 2024-06-12 11:06:57 +0200
 </div>
 </div>
 </body>

swagger.json

@@ -2,7 +2,7 @@
   "swagger": "2.0",
   "info": {
     "description": "As a loan provider get all the data of your applications for highly effective validations and approvals.",
-    "version": "2.72",
+    "version": "2.73",
     "title": "Anträge API",
     "contact": {
       "name": "Europace AG",
@@ -23,7 +23,7 @@
     "/v2/antraege": {
       "get": {
         "tags": ["Antraege"],
-        "summary": "get all applications",
+        "summary": "get list of all applications",
         "description": "As loan provider, you'll get a list of all your applications, sorted by lastChanged, paged and filterable.",
         "operationId": "getAntraegeList",
         "produces": ["application/json;charset=UTF-8"],
@@ -153,8 +153,8 @@
     "/v2/antraege/{vorgang}": {
       "get": {
         "tags": ["Antraege"],
-        "summary": "get applications of a case",
-        "description": "As advisor, you'll get all applications of your case. ",
+        "summary": "get list of all applications of a case",
+        "description": "As advisor, you'll get a list of all applications of your case. ",
         "operationId": "getAntraegeByVorgangNummer",
         "produces": ["application/json;charset=UTF-8"],
         "parameters": [
@@ -210,7 +210,7 @@
     "/v2/antraege/{vorgang}/{antrag}": {
       "get": {
         "tags": ["Antraege"],
-        "summary": "get approvals of an application",
+        "summary": "get list of approvals of an application",
         "description": "As loan Provider, you'll get a list of approvals with data for validation and decision.",
         "operationId": "getAntrag",
         "produces": ["application/json;charset=UTF-8"],
@@ -1098,11 +1098,11 @@
       "properties": {
         "_links": { "$ref": "#/definitions/Links" },
         "angebot": {
-          "description": "The offer on which the application is based on.",
+          "description": "The offer on which the application is based on. Not returned in the list of all applications.",
           "$ref": "#/definitions/AngebotZumAntrag"
         },
         "ansprechpartner": {
-          "description": "clerk",
+          "description": "clerk. Not returned in the list of all applications.",
           "$ref": "#/definitions/Partner"
         },
         "antragsNummer": { "type": "string", "description": "application-id" },
@@ -1111,7 +1111,7 @@
           "description": "loan providers reference for application"
         },
         "beratung": {
-          "description": "information about advisor type",
+          "description": "information about advisor type. Not returned in the list of all applications.",
           "$ref": "#/definitions/Beratung"
         },
         "datenKontext": {
@@ -1121,7 +1121,7 @@
         },
         "dokumente": {
           "type": "array",
-          "description": "all generated documents, shared proofs and documents uploaded by loan provider",
+          "description": "all generated documents, shared proofs and documents uploaded by loan provider. Not returned in the list of all applications.",
           "uniqueItems": true,
           "items": { "$ref": "#/definitions/Dokument" }
         },
@@ -1130,7 +1130,7 @@
           "description": "advisor-mark of final state for approving"
         },
         "kreditSachbearbeiter": {
-          "description": "loan officer",
+          "description": "loan officer. Not returned in the list of all applications.",
           "$ref": "#/definitions/Partner"
         },
         "letzteAenderung": {
@@ -1143,32 +1143,38 @@
           "format": "date-time",
           "description": "last event date. For example for messages from the advisors."
         },
-        "produktAnbieter": { "$ref": "#/definitions/ProduktAnbieter" },
-        "prolongation": { "type": "boolean" },
+        "produktAnbieter": {
+          "description": "Not returned in the list of all applications.",
+          "$ref": "#/definitions/ProduktAnbieter"
+        },
+        "prolongation": {
+          "type": "boolean",
+          "description": "Not returned in the list of all applications."
+        },
         "status": {
-          "description": "state of application",
+          "description": "state of application. Not returned in the list of all applications.",
           "$ref": "#/definitions/AntragsStatus"
         },
         "vermittler": {
-          "description": "advisor",
+          "description": "advisor. Not returned in the list of all applications.",
           "$ref": "#/definitions/Partner"
         },
         "vertriebsStrukturZumZeitpunktDerAnnahme": {
-          "description": "distribution channels of advisor and/or clerk at creation date of application",
+          "description": "distribution channels of advisor and/or clerk at creation date of application. Not returned in the list of all applications.",
           "$ref": "#/definitions/VertriebsStruktur"
         },
         "voraussichtlicheBearbeitung": {
           "type": "string",
           "format": "date",
-          "description": "estimated approval date"
+          "description": "estimated approval date. Not returned in the list of all applications."
         },
         "vorgangsReferenz": {
           "type": "string",
-          "description": "advisors reference for case"
+          "description": "advisors reference for case. Not returned in the list of all applications."
         },
         "weitereAntragsReferenzen": {
           "type": "object",
-          "description": "additional loan providers references. Will be visible to the advisor.",
+          "description": "additional loan providers references. Will be visible to the advisor. Not returned in the list of all applications.",
           "additionalProperties": { "type": "string" }
         },
         "zeitpunktDerAnnahme": {
@@ -1177,7 +1183,7 @@
           "description": "creation date of application"
         },
         "zugrundeliegendeDaten": {
-          "description": "data of applicants, property and project, wich is the source for application",
+          "description": "data of applicants, property and project, wich is the source for application. Not returned in the list of all applications.",
           "$ref": "#/definitions/ZugrundeliegendeDatenZumAntrag"
         }
       },