S350-AddressMutationsFile
Documentation technique générale BeStServices (S332)
Cette page fournit des informations techniques et le manuel pour les différents services Web de cette famille.
| XSD | BeSt-xsd_v23.3.1.zip | will be phased out end November 2023 |
| XSD Change Log | BeSt_xsd_change_log.xlsx |
| XSD | BeSt-xsd_v24.3.zip | will become operational end November 2023 |
| XSD Change Log | Schema XSD 24.3 delta.pdf |
Avertissement :
| S350-AddressMutationsFile | Version |
Status |
|---|---|---|
S350-AddressMutationsFile v1.0
Fonctionnalité
A mutation is the creation of a new record, the update of an existing record, or the archiving of a record.
- Add
An add takes place when a new record is created.
Example: A new address or a new Streetname is created.
- Delete
When an Identifier is in the Delete table, it means it is no longer used by the region.
It is up to the clients’ interpretation and business logic to determine whether this should result in a physical delete or a logical delete.
Example: An address will not be used anymore.
- Update
This is when an Identifier appears in the Add and the Delete table. An update takes place when non-identifying information to a record is changed.
Example: The status of a Streetname is changed from ‘proposed’ to ‘current’
Structured file of mutations of addresses
The Insert, Update and Archive operations will be constructed on the basis of two data types:
- Table ‘Addobjectversion’ will contain all versions of records that need to be added in the clients’ copy
- Table ‘Deleteobjectversion’ will contain all records that need to be deleted.
In this way, the 3 types of mutations can be constructed:
- Add
If a record is shown in the ‘Add’ table only, the record is new and needs to be created for the first time by the client.
- Delete
If a record is shown in the ‘delete’ table only, the record can be deleted by the client. In the back-end, this can have the meaning of ‘status = archived’ or of a delete of a record (for instance, because of serious errors in the record).
- Update
If a record with the same unique ObjectIdentifier appears both in the ‘delete’ and in the ‘Add’ table, this means an update of the record. The ‘old’ version can be deleted and replaced by the updated version.