| Name | EntityCitizenship | |
|---|---|---|
| Usage | IdentityService | |
| addCitizenshipToEntity updateCitizenship inactivateCitizenship | ||
| Entity | Type | Complex |
| ShortName | Name | Type | Description | Required? | Read only? | Cardinality | XML Attribute? | Implementation Notes |
|---|---|---|---|---|---|---|---|---|
| id | Id | String | The unique identifier for an object. This can be null. | One | No | |||
| entityId | Entity Id | String | Gets this id of the parent identity object. | One | No | |||
| status | Status | CodedAttribute | Gets this {@link EntityCitizenshipContract}'s citizenship status object. | One | No | |||
| countryCode | Country Code | String | Gets this {@link EntityCitizenshipContract}'s country code. | One | No | |||
| startDate | Start Date | DateTime | Gets this {@link EntityCitizenshipContract}'s start date. | One | No | |||
| endDate | End Date | DateTime | Gets this {@link EntityCitizenshipContract}'s end date. | One | No | |||
| versionNumber | Version Number | Long | Returns the version number for this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. This version number is generally used for the purposes of optimistic locking. |
One | No | |||
| objectId | Object Id | String | Return the globally unique object id of this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. |
One | No | |||
| active | Active | boolean | The active indicator for an object. | One | No |