| ShortName | Name | Type | Description | Required? | Read only? | Cardinality | XML Attribute? | Implementation Notes |
|---|---|---|---|---|---|---|---|---|
| id | Unique Id | String | The system assigned unique id to identify this Object. Could be implemented as as sequence number or as a UUID. Attempts to set this value on creates should result in a ReadOnlyException being thrown An Id:
|
Required on updates | Read only | One | Yes | |
| typeKey | Type Key | String | Unique identifier for the type of this object. | Required | Read only on updates | One | Yes | |
| stateKey | State Key | String | Unique identifier for the state of this object. | Required | One | Yes | ||
| atpKey | ATP Key | String | A unique identifier for the related ATP. | Required | One | No | ||
| milestoneKey | Milestone Key | String | A unique identifier for the related Milestone. | Required | One | No | ||
| effectiveDate | Effective Date | Date | Date/time this object became effective. Must be less than or equal to the expirationDate specified. |
One | No | |||
| expirationDate | Expiration Date | Date | Date/time this relationship is no longer effective. Must be greater than or equal to the effectiveDate specified. |
One | No | |||
| meta | Create/Update meta info | MetaInfo | Create and last update info for the structure. This is optional and treated as read only since the data is set by the internals of the service during maintenance operations. Contains audit trail information about the creation and last update of this object Also contains the version ind used for optimistic locking. Attempts to set or update should result in a ReadOnlyException being thrown. |
Required on updates | Read only | One | No | |
| attributes | Dynamic Attributes | AttributeInfoList | List of dynamic attributes, each holding a key-value pair that can be configured to hold additional information for an implementing institution. Note: the key may be repeated more than once to simulate a list of values. |
Many | No |