maintenanceMetadata Bundle

The maintenanceMetadata bundle returns metadata about the maintenance that was performed for AbiliTec IDs listed in a Maintenance Document. This bundle is returned when either the “consolidations” or “relinks” maintenance type parameter is specified for calls to the Maintenance endpoint.

Document Class: Maintenance

Data ElementTypeDescriptionExample or Valid Values
documentTypestringType of document to which the maintenance applies. person
place
household
entity
changeDatestringYear, month, and day the maintenance record was created.20180225
entityTypestringThe type of entity the document represents.nameAndPostal
postal
nameAndPhone
phone
nameAndEmail
email

Samples

Sample maintenanceMetadata bundle in JSON format for a document:

{
  "maintenanceMetadata": {
    "changeDate": "20170115",
    "entityType": "nameAndAddress",
    "documentType": "person"
  }
}

NOTE: Sample bundle values are for illustration purposes only.