Merge pull request #197 from jensstalder/issue-192-project-inquiryperson

Added `<inquiryPerson>` to `<project>` and depricated `<emailRem />`
qualipool · Nov 4, 2021 · ee6fbb2 · ee6fbb2
2 parents ac3d405 + 3ec194e
commit ee6fbb2
Show file tree

Hide file tree

Showing 9 changed files with 37 additions and 15 deletions.
diff --git a/docs/FAQ.md b/docs/FAQ.md
@@ -13,9 +13,8 @@ Simply omit the `<rent>` or `<buy>` tag within `<prices>`.
 Whenever possible, try to **avoid using local files**. For all the other cases use the [file URI scheme](https://en.wikipedia.org/wiki/File_URI_scheme).
 
 <details>
-
 <summary>Show an example</summary>
-
+<p>
 As an example for a **export.zip** file containing the following files
 
 ```
@@ -67,5 +66,9 @@ Would result in using the following **export.xml**
   </properties>
 </export>
 ```
-
+</p>
 </details>
+
+## How do I specify machine parsable email addresses for inquiries?
+
+The industry tends to use industry-standard formats for inquiries that are sent to a specified email address that you define. This makes it possible for some applications to, more reliably, parse contacts. For example, standards such as "OpenImmo Feedback" require websites to include a file within the emails. Others require you to format the plain text of the email in a CSV-like format, such as RemCat. SwissRETS does not currently provide a field for this specifically. Instead, currently, the industry relies on other indicators. First, make sure you are sending the email Address within `<inquiryPerson><email>`. Portals will then do one of the following. Either they configure that the special format needs to be sent with every inquiry that is sent to the address, or the email contains special strings (such as "remcat") which allow them to "introspect" in what form the inquiry should be sent as. This does not necessarily need to be within an email since a couple of standards will instead send the inquiry via HTTP for Example. 
diff --git a/docs/docs/noNamespace/complexType/exportType.html b/docs/docs/noNamespace/complexType/exportType.html
diff --git a/docs/docs/noNamespace/complexType/exportType.projects.html b/docs/docs/noNamespace/complexType/exportType.projects.html
diff --git a/docs/docs/noNamespace/complexType/exportType.projects.project.html b/docs/docs/noNamespace/complexType/exportType.projects.project.html
diff --git a/docs/docs/noNamespace/complexType/exportType.projects.project.seller.html b/docs/docs/noNamespace/complexType/exportType.projects.project.seller.html
diff --git a/docs/docs/noNamespace/complexType/exportType.properties.property.seller.html b/docs/docs/noNamespace/complexType/exportType.properties.property.seller.html
diff --git a/docs/docs/noNamespace/complexType/organization.html b/docs/docs/noNamespace/complexType/organization.html
diff --git a/examples/full.xml b/examples/full.xml
@@ -26,7 +26,7 @@
           <legalName>Someorg Ltd</legalName>
           <brand>Someorg Ltd</brand>
           <email>info@someorg.com</email>
-          <emailRem>info-remax@someorg.com</emailRem>
+          <emailRem>DEPRICATED@FIELD.com</emailRem>
           <mobile>+4178254657</mobile>
           <phone>+4178254657</phone>
           <website title="Some LTD org" label="Some LTD org">https://someorg.com</website>
@@ -41,6 +41,16 @@
           <gender>m</gender>
           <note>Contact Mr. Smith</note>
         </contactPerson>
+        <inquiryPerson>
+          <function>Remcat</function>
+          <givenName>Backoffice</givenName>
+          <familyName>Jane</familyName>
+          <email>jane@backoffice.com</email>
+          <mobile>+4178254657</mobile>
+          <phone>+4178254657</phone>
+          <gender>f</gender>
+          <note>This email should not be shown publicly and is intended only for trusted forms submisions. This could be in a special inquiry format that can be parsed by softwares.</note>
+        </inquiryPerson>
       </seller>
       <availability start="2018-12-13T12:12:12" expiration="2019-12-13T12:12:12">active</availability>
       <constructionStatus>under-construction</constructionStatus>
@@ -419,7 +429,7 @@
           <legalName>Someorg Ltd</legalName>
           <brand>Someorg Ltd</brand>
           <email>info@someorg.com</email>
-          <emailRem>info-remax@someorg.com</emailRem>
+          <emailRem>DEPRICATED@FIELD.com</emailRem>
           <mobile>+4178254657</mobile>
           <phone>+4178254657</phone>
           <website title="Some LTD org" label="Some LTD org">https://someorg.com</website>

diff --git a/schema/schema.xsd b/schema/schema.xsd
@@ -727,7 +727,11 @@
       <xs:element type="xs:string" name="legalName" minOccurs="0" maxOccurs="1" />
       <xs:element type="xs:string" name="brand" minOccurs="0" maxOccurs="1" />
       <xs:element type="emailaddress" name="email" minOccurs="0" maxOccurs="1" />
-      <xs:element type="emailaddress" name="emailRem" minOccurs="0" maxOccurs="1" />
+      <xs:element type="emailaddress" name="emailRem" minOccurs="0" maxOccurs="1">
+        <xs:annotation>
+          <xs:documentation>This field is depricated and will be removed in a future major version!</xs:documentation>
+        </xs:annotation>
+      </xs:element>
       <xs:element type="phoneNumber" name="phone" minOccurs="0" maxOccurs="1" />
       <xs:element type="phoneNumber" name="mobile" minOccurs="0" maxOccurs="1" />
       <xs:element name="website" minOccurs="0" maxOccurs="1">
@@ -1279,7 +1283,12 @@
                           </xs:element>
                           <xs:element type="person" name="contactPerson" minOccurs="0" maxOccurs="1">
                             <xs:annotation>
-                              <xs:documentation>Contact person for questions and typically responsible for making appointments.</xs:documentation>
+                              <xs:documentation>Contact person for questions and typically responsible for making appointments. This contact is typicaly presented publicly.</xs:documentation>
+                            </xs:annotation>
+                          </xs:element>
+                          <xs:element type="person" name="inquiryPerson" minOccurs="0" maxOccurs="1">
+                            <xs:annotation>
+                              <xs:documentation>The person responsible for receiving inquiries and applications. This person should not be presented publicly and is only intended as an indirect recipient using an online form or similar.</xs:documentation>
                             </xs:annotation>
                           </xs:element>
                         </xs:all>
@@ -1953,7 +1962,7 @@
                           </xs:element>
                           <xs:element type="person" name="contactPerson" minOccurs="0" maxOccurs="1">
                             <xs:annotation>
-                              <xs:documentation>Contact person for questions and typically responsible for making appointments.</xs:documentation>
+                              <xs:documentation>Contact person for questions and typically responsible for making appointments. This contact is typicaly presented publicly.</xs:documentation>
                             </xs:annotation>
                           </xs:element>
                           <xs:element type="person" name="visitPerson" minOccurs="0" maxOccurs="1">
@@ -1963,7 +1972,7 @@
                           </xs:element>
                           <xs:element type="person" name="inquiryPerson" minOccurs="0" maxOccurs="1">
                             <xs:annotation>
-                              <xs:documentation>Person responsible for receiving inquiries and applications.</xs:documentation>
+                              <xs:documentation>The person responsible for receiving inquiries and applications. This person should not be presented publicly and is only intended as an indirect recipient using an online form or similar.</xs:documentation>
                             </xs:annotation>
                           </xs:element>
                         </xs:all>