TS 102 657 v1.18.1 (2017-04-11) agreed at LI#44 (Sophia-Antipolis, 2017-01-30)

RDMessage {itu-t(0) identified-organization(4) etsi(0) securityDomain(2) retainedData(3) rdHeader(0) version17(17)}

RDMessage {itu-t(0) identified-organization(4) etsi(0) securityDomain(2) retainedData(3) rdHeader(0) version18(18)}

DEFINITIONS IMPLICIT TAGS ::=

retainedDataDomainId OBJECT IDENTIFIER ::= {itu-t(0) identified-organization(4) etsi(0) securityDomain(2) retainedData(3)}

-- rdHeader

rdHeaderId OBJECT IDENTIFIER ::= {retainedDataDomainId rdHeader(0) version17(17)}

rdHeaderId OBJECT IDENTIFIER ::= {retainedDataDomainId rdHeader(0) version18(18)}

-- ======================================

-- Top level definitions for RDHI wrapper

	cSPID			[2] CSPID,

	timeStamp		[3] GeneralizedTime,

	thirdPartyCSPID	[4] CSPID OPTIONAL,

	...

	... ,

	requestType		[5] RequestType OPTIONAL

}

CSPID ::= UTF8String

	-- Unique identifier for the CSP that issued the request

RequestType ::= UTF8String

-- Description or reference of the type of Retained Data request

RequestID ::= SEQUENCE

{

	countryCode					[1] CountryCode,

		-- Maximum number of records to be returned.

		-- On a national basis maximum numbers could be considered

		-- In case of maxHit a responseFailed message is sent and no data is sent

		-- This parameter shall not be used simultaneously with the numberOfRecordsLimit parameter.

		-- (see clause 6.3.3.2)

	nationalRequestParameters	[5] NationalRequestParameters OPTIONAL,

		-- To be defined on a national basis

	maxRecordsPerBatch			[6] INTEGER OPTIONAL,

		-- Indicates that multi-part delivery shall be used and each ResponseMessage shall not

		-- contain more records than specified. (see clause 6.3.3.3)

	requestedData				[7] SEQUENCE OF UTF8String OPTIONAL

	requestedData				[7] SEQUENCE OF UTF8String OPTIONAL,

		-- only to use in case of selective requests, it contains

		-- the path to the selected parameter in XPATH notation

	numberOfRecordsLimit		[8] INTEGER OPTIONAL

		-- Indicates the upper limit on the number of records to be provided by the CSP.

		-- This parameter shall not be used simultaneously with the maxHits parameter.

		-- (see clause 6.3.3.4)

}

DeliveryPointHIB ::= UTF8String

		-- to be defined on a national basis

		-- only to be used in case the present document cannot fulfil the national requirements

	...,

	responseNumber				[4] INTEGER OPTIONAL

	responseNumber				[4] INTEGER OPTIONAL,

		-- number to identify partial results within parallel multi-part delivery

	numberOfRecordsFound			[5] INTEGER OPTIONAL

		-- Indicates the total number of records found by the CSP when the value set in the 

		-- numberOfRecordsLimit has been reached or exceeded.

		-- (see clause 6.3.3.4)

}

ResponseStatus	::= CHOICE

	tAI						[11] OCTET STRING (SIZE (6)) OPTIONAL,

		-- Only applicable to the CS traffic cases, such as SMS over SGs, according to

		-- 3GPP TS 23.272 [35]

	eCGI					[12] OCTET STRING (SIZE (8)) OPTIONAL

	eCGI				[12] OCTET STRING (SIZE (8)) OPTIONAL,

		-- Only applicable to the CS traffic cases, such as SMS over SGs, according to

		-- 3GPP TS 23.272 [35]

	maritimeTransport		[13] MaritimeTransport OPTIONAL,

		-- Information about the mobile cells embarked on ships using

		-- satellite transponder backhaul

	airTransport			[14] AirTransport OPTIONAL

		-- Information about the mobile cells embarked on aircraft using

		-- satellite transponder backhaul

}

GSMLocation ::= CHOICE

HorizontalExtent ::= INTEGER

	-- metres

MaritimeTransport ::= SEQUENCE

{

	shipName			[1] UTF8String OPTIONAL,

		-- Registered ship name

	imoNumber			[2] IA5String (SIZE(10)) OPTIONAL,

		-- International Maritime Organization (IMO) ship number:

		-- IMO prefix with 7-digit number, e.g. IMO7812345

	...

}

AirTransport ::= SEQUENCE

{

	iATAAirlineCode			[1] IA5String (SIZE(2)) OPTIONAL,

		-- Two-character designation code assigned to the airline

		-- by the International Air Transport Association (IATA)

	iCAOOperatorCode		[2] IA5String (SIZE(3)) OPTIONAL,

		-- Three-letter designation code assigned to the aircraft operator agency

		-- by the International Civil Aviation Organization (ICAO).

		-- The iCAOOperatorCode should be used only when the aircraft operator does not have

		-- an assigned IATA airline code.

	aircraftRegistration	[3] UTF8String OPTIONAL,

		-- Aircraft identification as in the aircraft's certificate of registration

		-- e.g. G-IABC, N99999, F-OAAA

	flightNumber			[4] IA5String OPTIONAL,

		-- Flight number assigned by the airline operating the aircraft

	...

}

-- ===================

-- General definitions

-- ===================

	userAgent							[14] UTF8String OPTIONAL,

		-- e.g. SIP User-Agent field (see RFC 3261 [26])

	octetsUploaded						[15] INTEGER OPTIONAL,

	octetsDownloaded					[16] INTEGER OPTIONAL

	octetsDownloaded					[16] INTEGER OPTIONAL,

	accessNetworkInformation				[17] SEQUENCE OF AccessNetworkInfo OPTIONAL

}

MultimediaCallID	::=	UTF8String

	...

}

AccessNetworkInfo ::= CHOICE

{

	paniHeaderInfo		[1] PaniHeaderInfo,

	...

}

PaniHeaderInfo	::= SEQUENCE

{

	accessType 		[1] OCTET STRING OPTIONAL,

    -- ASCII string '3GPP-E-UTRAN-TDD', ' IEEE-802.11'... : see ETSI TS 124 229 [xx] clause 7.2A.4 

    accessClass  		[2] OCTET STRING OPTIONAL,

    -- ASCII string '3GPP-UTRAN', '3GPP-E-UTRAN',... : see ETSI TS 124 229 [xx] clause 7.2A.4

    networkProvided	[3] NULL OPTIONAL,

    -- present if provided by the network

    paniLocation		[4] Location OPTIONAL,

	-- Cell-ID and location information if available

	paniTime			[5] GeneralizedTime OPTIONAL,

	-- indicates the time when the location was reported at the start of the session, 

	-- or during or at the end of the session if the location is retained for the event

    ...

}

-- ==============================

-- Definitions of Billing Data

-- ==============================

	deliveryAddress			[16] AddressInformation OPTIONAL,

	resellerAddress			[17] AddressInformation OPTIONAL,

	otherAddresses			[18] SEQUENCE OF OtherAddress OPTIONAL,

	allocatedDevices		[19] SEQUENCE OF NADevice OPTIONAL

	allocatedDevices		[19] SEQUENCE OF NADevice OPTIONAL,

		-- If present, contains device details for all elements from allocatedDeviceIDs

	mSISDNs				[20] SEQUENCE OF PartyNumber OPTIONAL

}

NationalNASubscription ::= SEQUENCE

RDMessage {itu-t(0) identified-organization(4) etsi(0) securityDomain(2) retainedData(3) rdHeader(0) version17(17)}

RDMessage {itu-t(0) identified-organization(4) etsi(0) securityDomain(2) retainedData(3) rdHeader(0) version18(18)}

DEFINITIONS IMPLICIT TAGS ::=

retainedDataDomainId OBJECT IDENTIFIER ::= {itu-t(0) identified-organization(4) etsi(0) securityDomain(2) retainedData(3)}

-- rdHeader

rdHeaderId OBJECT IDENTIFIER ::= {retainedDataDomainId rdHeader(0) version17(17)}

rdHeaderId OBJECT IDENTIFIER ::= {retainedDataDomainId rdHeader(0) version18(18)}

-- ======================================

-- Top level definitions for RDHI wrapper

	cSPID			[2] CSPID,

	timeStamp		[3] GeneralizedTime,

	thirdPartyCSPID	[4] CSPID OPTIONAL,

	...

	... ,

	requestType		[5] RequestType OPTIONAL

}

CSPID ::= UTF8String

	-- Unique identifier for the CSP that issued the request

RequestType ::= UTF8String

-- Description or reference of the type of Retained Data request

RequestID ::= SEQUENCE

{

	countryCode					[1] CountryCode,

		-- Maximum number of records to be returned.

		-- On a national basis maximum numbers could be considered

		-- In case of maxHit a responseFailed message is sent and no data is sent

		-- This parameter shall not be used simultaneously with the numberOfRecordsLimit parameter.

		-- (see clause 6.3.3.2)

	nationalRequestParameters	[5] NationalRequestParameters OPTIONAL,

		-- To be defined on a national basis

	maxRecordsPerBatch			[6] INTEGER OPTIONAL,

		-- Indicates that multi-part delivery shall be used and each ResponseMessage shall not

		-- contain more records than specified. (see clause 6.3.3.3)

	requestedData				[7] SEQUENCE OF UTF8String OPTIONAL

	requestedData				[7] SEQUENCE OF UTF8String OPTIONAL,

		-- only to use in case of selective requests, it contains

		-- the path to the selected parameter in XPATH notation

	numberOfRecordsLimit		[8] INTEGER OPTIONAL

		-- Indicates the upper limit on the number of records to be provided by the CSP.

		-- This parameter shall not be used simultaneously with the maxHits parameter.

		-- (see clause 6.3.3.4)

}

DeliveryPointHIB ::= UTF8String

		-- to be defined on a national basis

		-- only to be used in case the present document cannot fulfil the national requirements

	...,

	responseNumber				[4] INTEGER OPTIONAL

	responseNumber				[4] INTEGER OPTIONAL,

		-- number to identify partial results within parallel multi-part delivery

	numberOfRecordsFound			[5] INTEGER OPTIONAL

		-- Indicates the total number of records found by the CSP when the value set in the 

		-- numberOfRecordsLimit has been reached or exceeded.

		-- (see clause 6.3.3.4)

}

ResponseStatus	::= CHOICE

	tAI						[11] OCTET STRING (SIZE (6)) OPTIONAL,

		-- Only applicable to the CS traffic cases, such as SMS over SGs, according to

		-- 3GPP TS 23.272 [35]

	eCGI					[12] OCTET STRING (SIZE (8)) OPTIONAL

	eCGI				[12] OCTET STRING (SIZE (8)) OPTIONAL,

		-- Only applicable to the CS traffic cases, such as SMS over SGs, according to

		-- 3GPP TS 23.272 [35]

	maritimeTransport		[13] MaritimeTransport OPTIONAL,

		-- Information about the mobile cells embarked on ships using

		-- satellite transponder backhaul

	airTransport			[14] AirTransport OPTIONAL

		-- Information about the mobile cells embarked on aircraft using

		-- satellite transponder backhaul

}

GSMLocation ::= CHOICE

HorizontalExtent ::= INTEGER

	-- metres

MaritimeTransport ::= SEQUENCE

{

	shipName			[1] UTF8String OPTIONAL,

		-- Registered ship name

	imoNumber			[2] IA5String (SIZE(10)) OPTIONAL,

		-- International Maritime Organization (IMO) ship number:

		-- IMO prefix with 7-digit number, e.g. IMO7812345

	...

}

AirTransport ::= SEQUENCE

{

	iATAAirlineCode			[1] IA5String (SIZE(2)) OPTIONAL,

		-- Two-character designation code assigned to the airline

		-- by the International Air Transport Association (IATA)

	iCAOOperatorCode		[2] IA5String (SIZE(3)) OPTIONAL,

		-- Three-letter designation code assigned to the aircraft operator agency

		-- by the International Civil Aviation Organization (ICAO).

		-- The iCAOOperatorCode should be used only when the aircraft operator does not have

		-- an assigned IATA airline code.

	aircraftRegistration	[3] UTF8String OPTIONAL,

		-- Aircraft identification as in the aircraft's certificate of registration

		-- e.g. G-IABC, N99999, F-OAAA

	flightNumber			[4] IA5String OPTIONAL,

		-- Flight number assigned by the airline operating the aircraft

	...

}

-- ===================

-- General definitions

-- ===================

	userAgent							[14] UTF8String OPTIONAL,

		-- e.g. SIP User-Agent field (see RFC 3261 [26])

	octetsUploaded						[15] INTEGER OPTIONAL,

	octetsDownloaded					[16] INTEGER OPTIONAL

	octetsDownloaded					[16] INTEGER OPTIONAL,

	accessNetworkInformation				[17] SEQUENCE OF AccessNetworkInfo OPTIONAL

}

MultimediaCallID	::=	UTF8String

	...

}

AccessNetworkInfo ::= CHOICE

{

	paniHeaderInfo		[1] PaniHeaderInfo,

	...

}

PaniHeaderInfo	::= SEQUENCE

{

	accessType 		[1] OCTET STRING OPTIONAL,

    -- ASCII string '3GPP-E-UTRAN-TDD', ' IEEE-802.11'... : see ETSI TS 124 229 [xx] clause 7.2A.4 

    accessClass  		[2] OCTET STRING OPTIONAL,

    -- ASCII string '3GPP-UTRAN', '3GPP-E-UTRAN',... : see ETSI TS 124 229 [xx] clause 7.2A.4

    networkProvided	[3] NULL OPTIONAL,

    -- present if provided by the network

    paniLocation		[4] Location OPTIONAL,

	-- Cell-ID and location information if available

	paniTime			[5] GeneralizedTime OPTIONAL,

	-- indicates the time when the location was reported at the start of the session, 

	-- or during or at the end of the session if the location is retained for the event

    ...

}

-- ==============================

-- Definitions of Billing Data

-- ==============================

	deliveryAddress			[16] AddressInformation OPTIONAL,

	resellerAddress			[17] AddressInformation OPTIONAL,

	otherAddresses			[18] SEQUENCE OF OtherAddress OPTIONAL,

	allocatedDevices		[19] SEQUENCE OF NADevice OPTIONAL

	allocatedDevices		[19] SEQUENCE OF NADevice OPTIONAL,

		-- If present, contains device details for all elements from allocatedDeviceIDs

	mSISDNs				[20] SEQUENCE OF PartyNumber OPTIONAL

}

NationalNASubscription ::= SEQUENCE