About Data Bundles
Learn how AbiliTec API data bundles organize response data.
Response data is organized into data bundles. You can specify the data bundle you want returned in each API call. If you don’t specify the data bundle, you'll receive all data bundles for which you have permissions.
The table below describes the Response Data Bundles that are available for a document class and the endpoints that can be used to return the data bundle.
| Response Data Bundles | Document Class | Endpoints |
|---|---|---|
| AbiliTec ID Bundles | ||
| abilitec Bundle | person, household, place, entity | Match Lookup * DocID |
| abilitecHousehold Bundle | entity | Match Lookup * DocID |
| householdId Bundle | entity, person, place | Match Lookup * DocID |
| householdMembers Bundle | household | Match Lookup * DocID |
| placeId Bundle | entity | Match Lookup * DocID |
| Metadata Bundles | ||
| matchMetadata Bundle | person, household, place, entity | * Match |
| validationErrors Bundle | person, household, place, entity | * Match |
When developing your app to call the AbiliTec API, it is important to understand the following:
- Even if a document class (such as a person), is associated with a particular bundle, the particular bundle may or may not be present in a given document. For example, the person document for "John Smith" might contain a validationErrors bundle because there was a parameter in the input record that contained invalid data, but the person document associated with "Mary Robinson" might not have a validationErrors bundle because there were no parameters in the input record that contained invalid data.
- The AbiliTec API only returns true Boolean values. Missing Boolean values are implied to be false. This means that bundles containing only false values will also not be returned. Client code should always check for the existence of bundles before reading their values. You should code your applications to deal with either the presence or absence of each requested bundle on any given request.
- Access to particular bundles is based upon the permissions associated with the calling client. Bundles are the basis for usage privileges and a client program may retrieve only those bundles to which the program is permitted.
Updated almost 4 years ago