Maintenance Document

Maintenance Document

A maintenance document helps refresh links between releases by allowing client links to get updated via relinks or consolidations. All responses return collections of results. These collections contain the document type, change date, and entity type as well as an array of maintenance objects (relinks or consolidations).

  • Relinks will contain the relink bundle, which will contain an AbiliTecĀ® link and a document ID.
  • Consolidations will contain the consolidation bundle, which will contain active and retired versions of the AbiliTec link and document ID.

Each maintenance record will be a single document object.

Sample

Consumer Consolidation Maintenance Document

{
  "maintenance": {
    "maintenanceMetadata": {
      "changeDate": "20180125",
      "entityType": "nameAndEmail",
      "documentType": "person"
    },
    "consolidation": {
      "activeId": "000000US00L1B0noikGKtihuo7EqGheBndFBF9",
      "retiredId": "000000US00kwqJUnO94yRKQDAte8DKydqSOql4",
      "activeLink": "0000US0103KVJPKN",
      "retiredLink": "0000US0101PP5VTL"
    }
  }
}

Relink Maintenance Document

{
  "maintenance": {
    "maintenanceMetadata": {
      "changeDate": "20180125",
      "entityType": "nameAndEmail",
      "documentType": "person"
    },
    "relink": {
      "retiredId": "000000US00XTyTV38YrtdWYNH5At5L3-K7buf3",
      "retiredLink": "0000US020105ZRLQ"
    }
  }
}

NOTE: Sample documents include sample ids and content, and may not include all possible data attributes. This is for illustration purposes only.