Delete source system apartment using id

Updated on 28 Oct 2024
1 Minute to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Delete

/externalSourceSystemApartment/{id}/

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

integerRequired

Id 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?

What's Next

Delete source system apartment using source system information