Delete source system apartment using source system information
  • 28 Oct 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Delete source system apartment using source system information

  • Dark
    Light
  • PDF

Article summary

The Delete /externalSourceSystemApartment operation is designed to permanently remove a source system apartment using its associated information. This process involves eliminating all references to the apartment, but once deleted, it cannot be restored. If the operation fails unexpectedly, some objects linked to the apartment may be remapped to a default apartment, even if the original apartment still exists. In such cases, these remapped objects will not revert to their previous state. The operation requires an Authorization Token for security and includes mandatory path parameters: sourceSystemId and sourceSystemKey. Possible responses include a 204 status for successful deletion, a 401 status for missing or invalid authentication credentials, and a 403 status indicating that the request is valid but cannot be executed, often due to dependencies on other objects. Detailed error descriptions are provided in the response for troubleshooting.

Delete
/externalSourceSystemApartment/{sourceSystemId}/{sourceSystemKey}/

Operation is used to delete source system apartment using source system information.

Operation attempts to remove all references to the apartment and then proceed to delete it permanently. Deleted apartment cannot be restored.

Be aware, that in case of operation failing unexpectedly, some of the objects that were previously related to the apartment to be deleted may have already been re-mapped to default apartment despite of the original apartment still existing in the system as a result of failed operation. When operation fails, re-mapped objects will not be rolled back to their previous state.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
sourceSystemId
integerRequired

Source system id of source system apartment to delete

sourceSystemKey
integerRequired

Source system key of source system apartment to delete

Responses
204

Object deleted

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object
details
string

Detailed description of error

403

Request is valid, but for some reason cannot be executed.

For example deletion is forbidden if object has at least one dependent object.

{
  "details": "Child record(s) exist, deletion declined."
}
object

There was an error that forbids request execution

details
string

Detailed description of error


Was this article helpful?