Archives an existing person from the given date. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the person.
Description
Archives an existing person from the given date. Either reference or externalIdentifier must have a value. Please note that if both identifiers are given, both must match; otherwise, an error message will be generated. It is recommended that the user utilizes only one identifier, with a preference for the reference. By using this operation the selected person will not be available anymore as an option to choose from lists.
A person is a standalone entity and pertains to an enhancement of organisation. This could be a contact person within an organisation. Several users utilize this to enter their own employees into the system.
Use Case
The Bloxs user terminates the cooperation with a person. Therefore the person should not be shown in lists anymore.
| Field | Description |
|---|---|
| reference | The relationship number within Bloxs. This is unique (per client specific environment) for all relationships (EstateAgents, Organisations, Owners, Persons, Suppliers). The relationship number is generated by the Bloxs system . |
| externalIdentifier | The unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system. |
| archiveDate | The date after which the person is archived. |
Please enter a valid token
The date on which it is archived.
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
The external API identifier of the model.
The person was archived
The archiving has validation issues
The requested person was not found.