From cd7318d815de5a29b729ac2f31f98858cad7e95c Mon Sep 17 00:00:00 2001 From: Jens Stalder Date: Fri, 13 Nov 2020 13:21:11 +0100 Subject: [PATCH 1/3] auction, bidding, and documentation for pricing --- docs/Prices.md | 87 +++++++++++++++++++++++++++++++++++++++++++++++ docs/index.md | 1 + schema/schema.xsd | 15 ++++++++ 3 files changed, 103 insertions(+) create mode 100644 docs/Prices.md diff --git a/docs/Prices.md b/docs/Prices.md new file mode 100644 index 0000000..76755bf --- /dev/null +++ b/docs/Prices.md @@ -0,0 +1,87 @@ +[**◀ Home**](index.md) + +# Prices + +This provides an overview and documentation for the [prices](https://swissrets.ch/docs/noNamespace/complexType/prices.html) tag. + +## Explanation + +Prices defined in a property are essential. Because of it's inherit complexity and to make sure the values are understood correctly please refer to this guide as to what actually means what. + +## XML examples + +Property for sale with a fixed price. +* **extra** TODO: Good question? Is this similar to yearlyOperationAndMaintenanceCosts? +* **wirPercentage**: The percententage of the gross price which has to paid in WIR Franc electronic currency. + +```xml + + active + + + 850000 + 25000 + 5 + + 50123 + + +``` + +Property for sale within an auction. Bidders can consequently increase the current standing of the auction price. The last bidder usually wins. + +The element `` has the following distinctions: + +* **start:** refers to the time the property is up for auction and for sale. +* **expiration:** refers to the time when the property can not be auctioned any longer and gets disabled. +* **minimalIncrease:** refers to a amount that is required for each bid to increase. +* **value:** refers the starting price + +```xml + + active + + 745 + 50123 + + +``` + +Property for sale within a bidding war. Here anyone can bid a sum that is larger or equal to the asking price. The bidder with the largest commitment usually wins. + +The element `` has the following distinctions: + +* **start:** refers to the time that bidding can commence. +* **bindingStart** refers to the legal start where biddings become legally binding. Consider this a point of no return. +* **expiration:** refers to the time when the property gets removed from the bidding War. +* **value:** refers the minimal asking price + +```xml + + active + + 745 + 50123 + + +``` + +Property for rent. +* **gross**: The total price (net + extra) +* **net**: The cost minus extra costs (gross - extra) +* **extra**: the difference between gross and net (gross - net) + +Usually only two are required and the third can be calculated based on the other two. But the XML generator can choose to provide all three. + +```xml + + active + + + 8500 + 7500 + 1000 + + + +``` diff --git a/docs/index.md b/docs/index.md index d9c5a5f..a47a330 100644 --- a/docs/index.md +++ b/docs/index.md @@ -25,6 +25,7 @@ Schema location declaration for validation. 1. Details - [Attachments](./Attachments.md) - images, documents, links - [Availability](Availability.md) - lifecycle states + - [Prices](Prices.md) - Some clarifications for pricings (buy, rent, auction, bidding) - [Categories](Categories.md) - categorization - [Characteristics](./Characteristics.md) - facts and features - [Applicables](./Characteristics.md#type-applicable) diff --git a/schema/schema.xsd b/schema/schema.xsd index 80695a3..8601fa8 100644 --- a/schema/schema.xsd +++ b/schema/schema.xsd @@ -730,6 +730,21 @@ + + + + + + + + + Starting price for a bidding war. + + + + + + From 2bf64684f669d78ff89cde43ee25c7c086c978e0 Mon Sep 17 00:00:00 2001 From: Jens Stalder Date: Fri, 13 Nov 2020 13:41:05 +0100 Subject: [PATCH 2/3] Documentation fixes --- docs/Prices.md | 57 +++++++++++++++++++++++++------------------------- 1 file changed, 28 insertions(+), 29 deletions(-) diff --git a/docs/Prices.md b/docs/Prices.md index 76755bf..afa330f 100644 --- a/docs/Prices.md +++ b/docs/Prices.md @@ -8,41 +8,41 @@ This provides an overview and documentation for the [prices](https://swissrets.c Prices defined in a property are essential. Because of it's inherit complexity and to make sure the values are understood correctly please refer to this guide as to what actually means what. -## XML examples +## Fixed price (buy) Property for sale with a fixed price. -* **extra** TODO: Good question? Is this similar to yearlyOperationAndMaintenanceCosts? +* **extra**: TODO: Good question? Is this similar to yearlyOperationAndMaintenanceCosts? * **wirPercentage**: The percententage of the gross price which has to paid in WIR Franc electronic currency. ```xml active - - - 850000 - 25000 - 5 - - 50123 + + + 850000 + 25000 + 5 + ``` +## Auction + Property for sale within an auction. Bidders can consequently increase the current standing of the auction price. The last bidder usually wins. The element `` has the following distinctions: -* **start:** refers to the time the property is up for auction and for sale. -* **expiration:** refers to the time when the property can not be auctioned any longer and gets disabled. -* **minimalIncrease:** refers to a amount that is required for each bid to increase. -* **value:** refers the starting price +* **start:**: The time the property is up for auction and for sale. +* **expiration:**: The time when the property can not be auctioned any longer and gets disabled. +* **minimalIncrease:**: To a amount that is required for each bid to increase. +* **value:**: The starting price ```xml active - - 745 - 50123 + + 745 ``` @@ -51,17 +51,16 @@ Property for sale within a bidding war. Here anyone can bid a sum that is larger The element `` has the following distinctions: -* **start:** refers to the time that bidding can commence. -* **bindingStart** refers to the legal start where biddings become legally binding. Consider this a point of no return. -* **expiration:** refers to the time when the property gets removed from the bidding War. -* **value:** refers the minimal asking price +* **start:**: The time that bidding can commence. +* **bindingStart**: The start where offers become legally binding. +* **expiration:**: The time when the property gets removed from the bidding War. +* **value:**: The minimal asking price ```xml active - - 745 - 50123 + + 745 ``` @@ -76,12 +75,12 @@ Usually only two are required and the third can be calculated based on the other ```xml active - - - 8500 - 7500 - 1000 - + + + 8500 + 7500 + 1000 + ``` From a9de60afb39bc3ba9def6c4f4745ec9c4da495bc Mon Sep 17 00:00:00 2001 From: Jens Stalder Date: Fri, 13 Nov 2020 14:00:34 +0100 Subject: [PATCH 3/3] updated doc --- docs/Prices.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/Prices.md b/docs/Prices.md index afa330f..d75d39c 100644 --- a/docs/Prices.md +++ b/docs/Prices.md @@ -47,6 +47,8 @@ The element `` has the following distinctions: ``` +## Bidding process + Property for sale within a bidding war. Here anyone can bid a sum that is larger or equal to the asking price. The bidder with the largest commitment usually wins. The element `` has the following distinctions: @@ -60,12 +62,13 @@ The element `` has the following distinctions: active - 745 + 745 ``` -Property for rent. +## Property for rent. + * **gross**: The total price (net + extra) * **net**: The cost minus extra costs (gross - extra) * **extra**: the difference between gross and net (gross - net)