This entity contains the payload of the message and the metadata related to this payload as showed in the attached partial model.
As depicted, the CoreEntityPayload is extended by the EncryptedEntityPayload and the XmlEntityPayload.
The definition of the CoreEntityPayload is the following.
| Element | Required | Description and value |
|---|---|---|
| InformationSecurityLevel | Yes | Level of security associated with the payload. This enumeration presents the possible values for information security classification. The enumeration is based in the security rules for protecting EU classified information. Allowed values:
|
| InformationSensitivity | Yes | Level of sensitivity related to the payload. This enumeration presents the possible values for information sensitivity degree. The Traffic Light Protocol (TLP) of US-CERT is applied ("http://www.us-cert.gov/tlp"). One of this values:
|
| IsPersonalData | No | Boolean. Indicate if the payload contains personal data. In case of sending personal data (that IsPersonalData is true), the attribute Purpose (next attribute) should have a meaningful value (a value different of "NonSpecified"). |
| Purpose | Yes | The purpose of the message. It can be used to handle access rights on the provider side. Allowed values:
In case of personal data (IsPersonalData is true) the Purpose field should have a value different from "NonSpecified", and should indicate what should be used for. |
| RetentionPeriod | No | Date and Time until when the payload can be kept. Datetime format: YYYY-MM-DDThh:mm:ss Example: 2025-05-30T09:00:00 This information can be used for the legal constraints associated with the management of personal data. |
| EnsureEncryption | No | Boolean value as true, false, and also “1” (for true) and “0” (for false). An indication the payload is encrypted. Actually fixed to true. |
The following table presents the list of supported entity types used as payload.
Payload entities
Type of service for Producer/Consumer | Shared data entity |
AgentService | Agent |
AircraftService | Aircraft |
AnomalyService | Anomaly |
CargoDocumentService | CargoDocument |
CargoService | Cargo |
CertificateDocumentService | CertificateDocument |
| CrisisIncidentService | CrisisIncident |
| DocumentService | Document |
EventDocumentService | EventDocument |
| IncidentService | Incident |
| IrregularMigrationIncidentService | IrregularMigrationIncident |
| LandVehicleService | LandVehicle |
| LawInfringementIncidentService | LawInfringementIncident |
| LocationService | Location, PortLocation, PortFacilityLocation, NamedLocation |
| LocationDocumentService | LocationDocument |
| MaritimeSafetyIncidentService | MaritimeSafetyIncident |
| MeteoOceanographicConditionService | MeteoOceanographicCondition |
| MovementService | Movement |
| OperationalAssetService | OperationalAsset |
| OrganizationService | Organization, PortOrganization, OrganizationalUnit, OrganizationalCollaboration, FormalOrganization |
| OrganizationDocumentService | OrganizationDocument |
| PersonService | Person |
| PersonDocumentService | PersonDocument |
| RiskDocumentService | RiskDocument |
| RiskService | Risk |
| VesselDocumentService | VesselDocument |
| VesselService | Vessel |