B.2 Data types applicable to multiple resource representations
24.5453GPPLocation Management - Service Enabler Architecture Layer for Verticals (SEAL)Protocol specificationRelease 17TS
This clause defines structured data types, simple data types, and enumerations that are applicable to several APIs defined for CoAP resource representations in the present specification.
B.2.1 Referenced structured data types
Table B.2.1-1 lists structured data types referenced by multiple CoAP resource representations and defined in other specifications.
Table B.2.1-1: Referenced Structured Data Types
|
Data type |
Reference |
Description |
|
ValTargetUe |
3GPP TS 24.546 [29] |
Information identifying a VAL user ID or VAL UE ID. |
|
GeographicalCoordinates |
3GPP TS 24.546 [29] |
Defines geographical coordinates. |
|
GeographicArea |
3GPP TS 24.546 [29] |
Defines a geographical area. |
B.2.2 Referenced simple data types
Table B.2.2-1 lists simple datatypes referenced by multiple CoAP resource representations and defined in other specifications.
Table B.2.2-1: Referenced Simple Data Types
|
Type name |
Reference |
Description |
|
Uinteger |
3GPP TS 24.546 [29] |
Unsigned integer, i.e. only value 0 and values above 0 are permissible. |
|
CellId |
3GPP TS 24.546 [29] |
String representing a unique identifier of a cell. |
|
TaId |
3GPP TS 24.546 [29] |
String representing a unique identifier of a tracking area. |
|
PlmnId |
3GPP TS 24.546 [29] |
String representing a unique identifier of a PLMN. |
|
MbmsSaId |
3GPP TS 24.546 [29] |
String representing a unique identifier of a MBMS serving area. |
|
MbsfnAreaId |
3GPP TS 24.546 [29] |
String representing a unique identifier of a MSFN area. |
B.2.3 Common structured data types
B.2.3.1 Type: BaseTrigger
Table B.2.3.1-1: Definition of type CellChange
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
triggerId |
TriggerId |
M |
1 |
The unique identity of the trigger criterion. |
B.2.3.2 Type: LocationReportConfiguration
Table B.2.3.2-1: Definition of type LocationReportConfiguration
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
valTgtUes |
array(ValTargetUe) |
M |
1..N |
VAL users to whom the configuration information is applied |
|
|
locationType |
Accuracy |
M |
1 |
The type of location information is requested. |
|
|
triggeringCriteria |
TriggeringCriteriaType |
O |
0..1 |
The triggering criteria associated with this configuration. |
|
|
minimumIntervalLength |
Uinteger |
O |
0..1 |
The minimum time between consecutive reports. |
B.2.3.3 Type: TriggeringCriteriaType
Table B.2.3.3-1: Definition of type TriggeringCriteriaType
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
cellChange |
CellChange |
O |
0..1 |
The triggers for cell change. |
|
|
trackingAreaChange |
TrackingAreaChange |
O |
0..1 |
The triggers for tracking area change. |
|
|
plmnChange |
PlmnChange |
O |
0..1 |
The triggers for PLMN change. |
|
|
mbmsSaChange |
MbmsSaChange |
O |
0..1 |
The triggers for MBMS serving area change. |
|
|
mbsfnAreaChange |
MbsfnAreaChange |
O |
0..1 |
The triggers for MBSFN area change. |
|
|
periodicReport |
PeriodicReport |
O |
0..1 |
The triggers for periodic reporting. |
|
|
travelledDistance |
TravelledDistance |
O |
0..1 |
The triggers for the distance that is travelled. |
|
|
verticalAppEvent |
VerticalAppEvent |
O |
0..1 |
The triggers for events generated by vertical application. |
|
|
geographicalAreaChange |
GeographicalAreaChange |
O |
0..1 |
The triggers for geographical area change. |
B.2.3.4 Type: CellChange
Table B.2.3.4-1: Definition of type CellChange
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
anyCellChange |
BaseTrigger |
O |
0..1 |
The trigger of any cell change. |
|
|
enterSpecificCells |
SpecificCells |
O |
0..1 |
The trigger of entering one or more cells. |
|
|
exitSpecificCells |
SpecificCells |
O |
0..1 |
The trigger of existing one or more cells. |
B.2.3.5 Type: SpecificCells
Table B.2.3.5-1: Definition of type SpecificCells
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
triggerId |
TriggerId |
M |
1 |
The unique identity of the trigger criterion. |
|
|
cells |
array(CellId) |
M |
1 |
The specific cell list. |
B.2.3.6 Type: TrackingAreaChange
Table B.2.3.6-1: Definition of type TrackingAreaChange
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
anyTrackingAreaChange |
BaseTrigger |
O |
0..1 |
The trigger of any tracking area change. |
|
|
enterSpecificTrackingAreas |
SpecificTrackingAreas |
O |
0..1 |
The trigger of entering one or more tracking areas. |
|
|
exitSpecificTrackingAreas |
SpecificTrackingAreas |
O |
0..1 |
The trigger of existing one or more tracking areas. |
B.2.3.7 Type: SpecificTrackingAreas
Table B.2.3.7-1: Definition of type SpecificTrackingAreas
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
triggerId |
TriggerId |
M |
1 |
The unique identity of the trigger criterion. |
|
|
trackingAreas |
array(TaId) |
M |
1 |
The specific tracking area list. |
B.2.3.8 Type: PlmnChange
Table B.2.3.8-1: Definition of type PlmnChange
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
anyPlmnChange |
AnyPlmnChange |
O |
0..1 |
The trigger of any PLMN change. |
|
|
enterSpecificPlmns |
SpecificPlmns |
O |
0..1 |
The trigger of entering one or more PLMNs. |
|
|
exitSpecificPlmns |
SpecificPlmns |
O |
0..1 |
The trigger of existing one or more PLMNs. |
B.2.3.9 Type: SpecificPlmns
Table B.2.3.9-1: Definition of type SpecificPlmns
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
triggerId |
TriggerId |
M |
1 |
The unique identity of the trigger criterion. |
|
|
plmns |
array(PlmnId) |
M |
1 |
The specific PLMN list. |
B.2.3.10 Type: MbmsSaChange
Table B.3.1.10-1: Definition of type MbmsSaChange
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
anyMbmsSaChange |
anyMbmsSaChange |
O |
0..1 |
The trigger of any MBMS serving area change. |
|
|
enterSpecificMbmsSas |
SpecificMbmsSas |
O |
0..1 |
The trigger of entering one or more MBMS serving areas. |
|
|
exitSpecificMbmsSas |
SpecificMbmsSas |
O |
0..1 |
The trigger of existing one or more MBMS serving areas. |
B.2.3.11 Type: SpecificMbmsSas
Table B.2.3.11-1: Definition of type SpecificMbmsSas
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
triggerId |
TriggerId |
M |
1 |
The unique identity of the trigger criterion. |
|
|
mbmsSas |
array(MbmsSaId) |
M |
1 |
The specific MBMS serving area list. |
B.2.3.12 Type: MbsfnAreaChange
Table B.2.3.12-1: Definition of type MbsfnAreaChange
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
any MbsfnAreaChange |
Any MbsfnAreaChange |
O |
0..1 |
The trigger of any MBSFN area change. |
|
|
enterSpecificMbsfnAreas |
SpecificMbsfnAreas |
O |
0..1 |
The trigger of entering one or more MBSFN areas. |
|
|
exitSpecificMbsfnAreas |
SpecificMbsfnAreas |
O |
0..1 |
The trigger of existing one or more MBSFN areas. |
B.2.3.13 Type: SpecificMbsfnAreas
Table B.2.3.13-1: Definition of type SpecificMbsfnAreas
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
triggerId |
TriggerId |
M |
1 |
The unique identity of the trigger criterion. |
|
|
mbsfnAreas |
array(MbsfnAreaId) |
M |
1 |
The specific MBSFN area list. |
B.2.3.14 Type: PeriodicReport
Table B.2.3.14-1: Definition of type PeriodicReport
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
triggerId |
TriggerId |
M |
1 |
The unique identity of the trigger criterion. |
|
|
interval |
Uinteger |
M |
1 |
The time interval for location reporting. |
B.2.3.15 Type: TravelledDistance
Table B.2.3.15-1: Definition of type TravelledDistance
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
triggerId |
TriggerId |
M |
1 |
The unique identity of the trigger criterion. |
|
|
distance |
Uinteger |
M |
1 |
The distance interval for location reporting. |
B.2.3.16 Type: VerticalAppEvent
Table B.2.3.16-1: Definition of type VerticalAppEvent
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
initialLogOn |
BaseTrigger |
O |
0..1 |
The event of initial log-on. |
|
|
locConfigReceived |
BaseTrigger |
O |
0..1 |
The event of location configuration being received. |
|
|
anyOtherEvent |
BaseTrigger |
O |
0..1 |
Any other event. |
B.2.3.17 Type: GeographicalAreaChange
Table B.2.3.17-1: Definition of type GeographicalAreaChange
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
anyAreaChange |
BaseTigger |
O |
0..1 |
The trigger of any geographical area change. |
|
|
enterSpecificAreas |
SpecificGeoAreas |
O |
0..1 |
The trigger of entering one or more geographical areas. |
|
|
exitSpecificAreas |
SpecificGeoAreas |
O |
0..1 |
The trigger of existing one or more geographical areas. |
B.2.3.18 Type: SpecificGeoAreas
Table B.2.3.18-1: Definition of type SpecificGeoAreas
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
triggerId |
TriggerId |
M |
1 |
The unique identity of the trigger criterion. |
|
|
geographicalAreas |
array(GeographicArea) |
M |
1 |
The specific geographical area list. |
B.2.3.19 Type: LocationReport
Table B.2.3.20-1: Definition of type LocationReport
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
valTgtUe |
ValTgtUe |
O |
0..N |
VAL user who reports the location information. |
|
|
tiggerIds |
array(TriggerId) |
O |
0..N |
The triggers that have been met for this location report. |
|
|
locInfo |
LocationInfo |
M |
1 |
The location information in this report. |
B.2.3.20 Type: LocationInfo
Table B.2.3.21-1: Definition of type LocationInfo
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
cellId |
CellId |
O |
0..1 |
Current cell. |
|
|
neighbouringCellIds |
array(CellId) |
O |
0..N |
The neighbouring cells of current cell. |
|
|
mbmsSaId |
MbmsSaId |
O |
0..1 |
Current MBMS serving area. |
|
|
mbsfnAreaId |
MbsfnAreaId |
O |
0..1 |
Current MBSFN area. |
|
|
currentCoordinate |
GeographicalCoordinates |
O |
0..1 |
Current geographical coordinate. |
B.2.4 Common simple data types
Table B.2.4-1: Simple data types applicable to multiple CoAP resource representations
|
Type name |
Description |
|
TriggerId |
String representing a unique identifier of a trigger criterion. |
B.2.5 Common enumerations
B.2.5.1 Enumeration: Accuracy
Table B.2.5.1-1: Accuracy
|
Enumeration value |
Description |
Applicability |
|
CURRENT_SERVING_NCGI |
Current cell. |
|
|
NEIGHBOURING_NCGI |
The neighbouring cells of current cell. |
|
|
MBMS_SA |
Current MBMS serving area. |
|
|
MBSFN_AREA |
Current MBSFN area. |
|
|
CURRENT_GEOGRAPHICAL_COORDINATE |
Current geographical coordinate. |