Jump to

• Request
• Response
• Examples

Update a Converged Charging Session

post

{apiRoot}/nchf-convergedcharging/v2/chargingdata/{ChargingDataRef}/update

Reserves additional units for an existing converged charging session.

You may need to reserve additional units for an existing Nchf converged charging session when:

• The granted service unit for one rating group is spent. For example, when a subscriber uses the last of their 2 GB of data per month during an online web session.
• The validity period expires for the granted service. For example, a telephone call starts at 11:45am using a grant of free minutes that expires at noon. In this case, an update request would be required just before noon.
• Service events occur that might affect the rating of the current service. For example, when the QoS increases or decreases during a session.

Request

Path Parameters

• ChargingDataRef(required): string
  A unique identifier for a charging data resource in a Public Land Mobile Network (PLMN).

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Details about a converged charging session.

Show Source

• invocationSequenceNumber(required): integer (int32)
  Minimum Value: 0

  The sequence number for the charging service invocation by the NF consumer.
• invocationTimeStamp(required): string (date-time)
  The timestamp for when the request was sent.
• locationReportingChargingInformation: object LocationReportingChargingInformation
  The 5G N2 connection-specific information.
• mnSConsumerIdentifier: string
  The ID of the Management Server (MnS) consumer.
• multipleUnitUsage: array multipleUnitUsage
  Minimum Number of Items: 0

  The parameters for the quota management request or usage report.
• n2ConnectionChargingInformation: object N2ConnectionChargingInformation
  Information about a 5G N2 charging connection.
• nEFChargingInformation: object NEFChargingInformation
  Exposure Function Northbound API-specific information.
• nfConsumerIdentification(required): object NFIdentification
  A grouped field that contains a set of information identifying the NF consumer of the charging service.
• notifyUri: string
  The recipient of notifications sent by the CHF, such as http://test-notification-url. For session-based charging, this parameter is required for create requests and optional for update requests.
• nSMChargingInformation: object NSMChargingInformation
  The Network Slice Management (NSM)-specific information.
• nSPAChargingInformation: object NSPAChargingInformation
  The network slice information, which is reported to the CHF.
• oneTimeEvent: boolean
  Whether this uses event-based charging for a one-time event (true) or to expect an update and ending request (false).
• oneTimeEventType: string
  Allowed Values: [ "IEC", "PEC" ]

  The type of one-time event, such as immediate (IEC) or post-event charging (PEC).
• pDUSessionChargingInformation: object PDUSessionChargingInformation
  The 5G data connectivity-specific information.
• registrationChargingInformation: object RegistrationChargingInformation
  The 5G registration-specific information.
• retransmissionIndicator: boolean
  Whether this is a retransmitted request message (true) or not (false).
• roamingQBCInformation: object RoamingQBCInformation
  The 5G data connectivity-specific information for roaming QBC.
• serviceSpecificationInfo: string
  The technical specification for the service, such as TS 32.255, and release version, such as Release 16, that applies to the request.
• sMSChargingInformation: object SMSChargingInformation
  SMS-specific information.
• subscriberIdentifier: string
  Pattern: ^(imsi-[0-9]{5,15}|nai-.+|.+)$

  The unique identifier for the subscriber that uses the requested service. The ID is either a SUPI or an IMSI.
• supportedFeatures: string
  Pattern: ^[A-Fa-f0-9]*$

  The list of supported features.
• tenantIdentifier: string
  The ID of the tenant.
• triggers: array triggers
  Minimum Number of Items: 0

  The triggers for usage reporting associated to the rating group, which is supplied from the CHF.

  The presence of the triggers attribute without any triggerType is used by CHF to disable all of the triggers to the associated rating group.

{
    "description":"Details about a converged charging session.",
    "type":"object",
    "properties":{
        "subscriberIdentifier":{
            "description":"The unique identifier for the subscriber that uses the requested service. The ID is either a SUPI or an IMSI.",
            "type":"string",
            "pattern":"^(imsi-[0-9]{5,15}|nai-.+|.+)$"
        },
        "tenantIdentifier":{
            "description":"The ID of the tenant.",
            "type":"string"
        },
        "mnSConsumerIdentifier":{
            "description":"The ID of the Management Server (MnS) consumer.",
            "type":"string"
        },
        "nfConsumerIdentification":{
            "$ref":"#/components/schemas/NFIdentification"
        },
        "invocationTimeStamp":{
            "description":"The timestamp for when the request was sent.",
            "format":"date-time",
            "type":"string"
        },
        "invocationSequenceNumber":{
            "description":"The sequence number for the charging service invocation by the NF consumer.",
            "format":"int32",
            "type":"integer",
            "minimum":0
        },
        "retransmissionIndicator":{
            "description":"Whether this is a retransmitted request message (<b>true</b>) or not (<b>false</b>).",
            "type":"boolean"
        },
        "oneTimeEvent":{
            "description":"Whether this uses event-based charging for a one-time event (<b>true</b>) or to expect an update and ending request (<b>false</b>).",
            "type":"boolean"
        },
        "oneTimeEventType":{
            "description":"The type of one-time event, such as immediate (<b>IEC</b>) or post-event charging (<b>PEC</b>).",
            "type":"string",
            "enum":[
                "IEC",
                "PEC"
            ]
        },
        "notifyUri":{
            "description":"The recipient of notifications sent by the CHF, such as http://test-notification-url. For session-based charging, this parameter is required for create requests and optional for update requests.",
            "type":"string"
        },
        "supportedFeatures":{
            "description":"The features supported by the NF consumer.",
            "$ref":"#/components/schemas/SupportedFeatures"
        },
        "serviceSpecificationInfo":{
            "description":"The technical specification for the service, such as TS 32.255, and release version, such as Release 16, that applies to the request.",
            "type":"string"
        },
        "multipleUnitUsage":{
            "description":"The parameters for the quota management request or usage report.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MultipleUnitUsage"
            },
            "minItems":0
        },
        "triggers":{
            "description":"The triggers for usage reporting associated to the rating group, which is supplied from the CHF. <p>The presence of the triggers attribute without any triggerType is used by CHF to disable all of the triggers to the associated rating group.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Trigger"
            },
            "minItems":0
        },
        "pDUSessionChargingInformation":{
            "$ref":"#/components/schemas/PDUSessionChargingInformation"
        },
        "roamingQBCInformation":{
            "$ref":"#/components/schemas/RoamingQBCInformation"
        },
        "sMSChargingInformation":{
            "$ref":"#/components/schemas/SMSChargingInformation"
        },
        "nEFChargingInformation":{
            "$ref":"#/components/schemas/NEFChargingInformation"
        },
        "registrationChargingInformation":{
            "$ref":"#/components/schemas/RegistrationChargingInformation"
        },
        "n2ConnectionChargingInformation":{
            "$ref":"#/components/schemas/N2ConnectionChargingInformation"
        },
        "locationReportingChargingInformation":{
            "$ref":"#/components/schemas/LocationReportingChargingInformation"
        },
        "nSPAChargingInformation":{
            "$ref":"#/components/schemas/NSPAChargingInformation"
        },
        "nSMChargingInformation":{
            "$ref":"#/components/schemas/NSMChargingInformation"
        }
    },
    "required":[
        "nfConsumerIdentification",
        "invocationTimeStamp",
        "invocationSequenceNumber"
    ]
}

Nested Schema : LocationReportingChargingInformation

Type: object

The 5G N2 connection-specific information.

Show Source

• locationReportingMessageType(required): integer
• presenceReportingAreaInformation: object presenceReportingAreaInformation
  Minimum Number of Properties: 0

  Additional Properties Allowed: PresenceInfo
• rATType:
• uetimeZone: string
• userInformation: object UserInformation
• userLocationinfo: object UserLocation

{
    "type":"object",
    "description":"The 5G N2 connection-specific information.",
    "properties":{
        "locationReportingMessageType":{
            "$ref":"#/components/schemas/LocationReportingMessageType"
        },
        "userInformation":{
            "$ref":"#/components/schemas/UserInformation"
        },
        "userLocationinfo":{
            "$ref":"#/components/schemas/UserLocation"
        },
        "uetimeZone":{
            "$ref":"#/components/schemas/TimeZone"
        },
        "rATType":{
            "$ref":"#/components/schemas/RatType"
        },
        "presenceReportingAreaInformation":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/PresenceInfo"
            },
            "minProperties":0
        }
    },
    "required":[
        "locationReportingMessageType"
    ]
}

Nested Schema : multipleUnitUsage

Type: array

Minimum Number of Items: 0

The parameters for the quota management request or usage report.

Show Source

• Array of: object MultipleUnitUsage

{
    "description":"The parameters for the quota management request or usage report.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MultipleUnitUsage"
    },
    "minItems":0
}

Nested Schema : N2ConnectionChargingInformation

Type: object

Information about a 5G N2 charging connection.

Show Source

• allowedNSSAI: array allowedNSSAI
  Minimum Number of Items: 0
• amfUeNgapId: integer
  The UE association over the N2 interface within the AMF.
• forbiddenAreaList: array forbiddenAreaList
  Minimum Number of Items: 0
• n2ConnectionMessageType(required): integer
• ranNodeId: object GlobalRanNodeId
• ranUeNgapId: integer
  The RAN UE NGAP ID over the N2 interface.
• rATType:
• restrictedCnList: array restrictedCnList
  Minimum Number of Items: 0
• restrictedRatList: array restrictedRatList
  Minimum Number of Items: 0
• rrcEstCause: string
  Pattern: ^[0-9a-fA-F]+$
• serviceAreaRestriction: array serviceAreaRestriction
  Minimum Number of Items: 0
• uetimeZone: string
• userInformation: object UserInformation
• userLocationinfo: object UserLocation

{
    "description":"Information about a 5G N2 charging connection.",
    "type":"object",
    "properties":{
        "n2ConnectionMessageType":{
            "$ref":"#/components/schemas/N2ConnectionMessageType"
        },
        "userInformation":{
            "$ref":"#/components/schemas/UserInformation"
        },
        "userLocationinfo":{
            "$ref":"#/components/schemas/UserLocation"
        },
        "uetimeZone":{
            "$ref":"#/components/schemas/TimeZone"
        },
        "rATType":{
            "$ref":"#/components/schemas/RatType"
        },
        "amfUeNgapId":{
            "description":"The UE association over the N2 interface within the AMF.",
            "type":"integer"
        },
        "ranUeNgapId":{
            "description":"The RAN UE NGAP ID over the N2 interface.",
            "type":"integer"
        },
        "ranNodeId":{
            "$ref":"#/components/schemas/GlobalRanNodeId"
        },
        "restrictedRatList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RatType"
            },
            "minItems":0
        },
        "forbiddenAreaList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Area"
            },
            "minItems":0
        },
        "serviceAreaRestriction":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceAreaRestriction"
            },
            "minItems":0
        },
        "restrictedCnList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CoreNetworkType"
            },
            "minItems":0
        },
        "allowedNSSAI":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Snssai"
            },
            "minItems":0
        },
        "rrcEstCause":{
            "type":"string",
            "pattern":"^[0-9a-fA-F]+$"
        }
    },
    "required":[
        "n2ConnectionMessageType"
    ]
}

Nested Schema : NEFChargingInformation

Type: object

Exposure Function Northbound API-specific information.

Show Source

• aPIContent: string
• aPIDirection: string
  Allowed Values: [ "INVOCATION", "NOTIFICATION" ]
• aPIName(required): string
• aPIReference: string
• aPIResultCode: integer (int32)
  Minimum Value: 0
• aPITargetNetworkFunction: object NFIdentification
  A grouped field that contains a set of information identifying the NF consumer of the charging service.
• groupIdentifier: string
  Pattern: ^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0-9][A-Fa-f0-9]){1,10}$

{
    "type":"object",
    "description":"Exposure Function Northbound API-specific information.",
    "properties":{
        "groupIdentifier":{
            "$ref":"#/components/schemas/GroupId"
        },
        "aPIDirection":{
            "$ref":"#/components/schemas/APIDirection"
        },
        "aPITargetNetworkFunction":{
            "$ref":"#/components/schemas/NFIdentification"
        },
        "aPIResultCode":{
            "format":"int32",
            "type":"integer",
            "minimum":0
        },
        "aPIName":{
            "type":"string"
        },
        "aPIReference":{
            "type":"string"
        },
        "aPIContent":{
            "type":"string"
        }
    },
    "required":[
        "aPIName"
    ]
}

Nested Schema : NFIdentification

Type: object

A grouped field that contains a set of information identifying the NF consumer of the charging service.

Show Source

• nFFqdn: string
• nFIPv4Address: string
  Pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$

  Example: 198.51.100.1
• nFIPv6Address: string Ipv6Addr
• nFName: string (uuid)
• nFPLMNID: object PlmnId
• nodeFunctionality(required): string
  Allowed Values: [ "AMF", "SMF", "SMSF", "SGW", "I_SMF", "ePDG", "CEF" ]

{
    "description":"A grouped field that contains a set of information identifying the NF consumer of the charging service.",
    "type":"object",
    "properties":{
        "nFName":{
            "$ref":"#/components/schemas/NfInstanceId"
        },
        "nFIPv4Address":{
            "$ref":"#/components/schemas/Ipv4Addr"
        },
        "nFIPv6Address":{
            "$ref":"#/components/schemas/Ipv6Addr"
        },
        "nFPLMNID":{
            "$ref":"#/components/schemas/PlmnId"
        },
        "nodeFunctionality":{
            "$ref":"#/components/schemas/NodeFunctionality"
        },
        "nFFqdn":{
            "type":"string"
        }
    },
    "required":[
        "nodeFunctionality"
    ]
}

Nested Schema : NSMChargingInformation

Type: object

The Network Slice Management (NSM)-specific information.

Show Source

• idNetworkSliceInstance: string
• listOfserviceProfileChargingInformation: array listOfserviceProfileChargingInformation
  Minimum Number of Items: 0
• managementOperation(required): string
  Allowed Values: [ "CreateMOI", "ModifyMOIAttributes", "DeleteMOI" ]
• managementOperationStatus: string
  Allowed Values: [ "OPERATION_SUCCEEDED", "OPERATION_FAILED" ]

{
    "type":"object",
    "description":"The Network Slice Management (NSM)-specific information.",
    "properties":{
        "managementOperation":{
            "$ref":"#/components/schemas/ManagementOperation"
        },
        "idNetworkSliceInstance":{
            "type":"string"
        },
        "listOfserviceProfileChargingInformation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceProfileChargingInformation"
            },
            "minItems":0
        },
        "managementOperationStatus":{
            "$ref":"#/components/schemas/ManagementOperationStatus"
        }
    },
    "required":[
        "managementOperation"
    ]
}

Nested Schema : NSPAChargingInformation

Type: object

The network slice information, which is reported to the CHF.

Show Source

• singleNSSAI: object Snssai
  The S-NSSAIs of the NF.

{
    "type":"object",
    "description":"The network slice information, which is reported to the CHF.",
    "properties":{
        "singleNSSAI":{
            "$ref":"#/components/schemas/Snssai"
        }
    },
    "required":[
        "sNSSAI"
    ]
}

Nested Schema : PDUSessionChargingInformation

Type: object

The 5G data connectivity-specific information.

Show Source

• chargingId: integer (int32)
  Minimum Value: 0
• homeProvidedChargingId: integer (int32)
  Minimum Value: 0
• mAPDUNon3GPPUserLocationInfo: object UserLocation
• pduSessionInformation: object PDUSessionInformation
• presenceReportingAreaInformation: object presenceReportingAreaInformation
  Minimum Number of Properties: 0

  Additional Properties Allowed: PresenceInfo
• rANSecondaryRATUsageReport: object RANSecondaryRATUsageReport
• uetimeZone: string
• unitCountInactivityTimer: integer
• userInformation: object UserInformation
• userLocationinfo: object UserLocation

{
    "description":"The 5G data connectivity-specific information.",
    "type":"object",
    "properties":{
        "chargingId":{
            "$ref":"#/components/schemas/ChargingId"
        },
        "homeProvidedChargingId":{
            "$ref":"#/components/schemas/ChargingId"
        },
        "userInformation":{
            "$ref":"#/components/schemas/UserInformation"
        },
        "userLocationinfo":{
            "$ref":"#/components/schemas/UserLocation"
        },
        "mAPDUNon3GPPUserLocationInfo":{
            "$ref":"#/components/schemas/UserLocation"
        },
        "presenceReportingAreaInformation":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/PresenceInfo"
            },
            "minProperties":0
        },
        "uetimeZone":{
            "$ref":"#/components/schemas/TimeZone"
        },
        "pduSessionInformation":{
            "$ref":"#/components/schemas/PDUSessionInformation"
        },
        "unitCountInactivityTimer":{
            "$ref":"#/components/schemas/DurationSec"
        },
        "rANSecondaryRATUsageReport":{
            "$ref":"#/components/schemas/RANSecondaryRATUsageReport"
        }
    }
}

Nested Schema : RegistrationChargingInformation

Type: object

The 5G registration-specific information.

Show Source

• 5GMMCapability: string (byte)
• allowedNSSAI: array allowedNSSAI
  Minimum Number of Items: 0
• mICOModeIndication: string
  Allowed Values: [ "MICO_MODE", "NO_MICO_MODE" ]
• rATType:
• registrationMessagetype(required): string
  Allowed Values: [ "INITIAL", "MOBILITY", "PERIODIC", "EMERGENCY", "DEREGISTRATION" ]
• rejectedNSSAI: array rejectedNSSAI
  Minimum Number of Items: 0
• requestedNSSAI: array requestedNSSAI
  Minimum Number of Items: 0
• serviceAreaRestriction: array serviceAreaRestriction
  Minimum Number of Items: 0
• smsIndication: string
  Allowed Values: [ "SMS_SUPPORTED", "SMS_NOT_SUPPORTED" ]
• taiList: array taiList
  Minimum Number of Items: 0
• uetimeZone: string
• userInformation: object UserInformation
• userLocationinfo: object UserLocation

{
    "type":"object",
    "description":"The 5G registration-specific information.",
    "properties":{
        "registrationMessagetype":{
            "$ref":"#/components/schemas/RegistrationMessageType"
        },
        "userInformation":{
            "$ref":"#/components/schemas/UserInformation"
        },
        "userLocationinfo":{
            "$ref":"#/components/schemas/UserLocation"
        },
        "uetimeZone":{
            "$ref":"#/components/schemas/TimeZone"
        },
        "rATType":{
            "$ref":"#/components/schemas/RatType"
        },
        "5GMMCapability":{
            "$ref":"#/components/schemas/Bytes"
        },
        "mICOModeIndication":{
            "$ref":"#/components/schemas/MICOModeIndication"
        },
        "smsIndication":{
            "$ref":"#/components/schemas/SmsIndication"
        },
        "taiList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Tai"
            },
            "minItems":0
        },
        "serviceAreaRestriction":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceAreaRestriction"
            },
            "minItems":0
        },
        "requestedNSSAI":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Snssai"
            },
            "minItems":0
        },
        "allowedNSSAI":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Snssai"
            },
            "minItems":0
        },
        "rejectedNSSAI":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Snssai"
            },
            "minItems":0
        }
    },
    "required":[
        "registrationMessagetype"
    ]
}

Nested Schema : RoamingQBCInformation

Type: object

The 5G data connectivity-specific information for roaming QBC.

Show Source

• multipleQFIcontainer: array multipleQFIcontainer
  Minimum Number of Items: 0
• roamingChargingProfile: object RoamingChargingProfile
• uPFID: string (uuid)

{
    "type":"object",
    "description":"The 5G data connectivity-specific information for roaming QBC.",
    "properties":{
        "multipleQFIcontainer":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MultipleQFIcontainer"
            },
            "minItems":0
        },
        "uPFID":{
            "$ref":"#/components/schemas/NfInstanceId"
        },
        "roamingChargingProfile":{
            "$ref":"#/components/schemas/RoamingChargingProfile"
        }
    }
}

Nested Schema : SMSChargingInformation

Type: object

SMS-specific information.

Show Source

• deliveryReportRequested: string
  Allowed Values: [ "YES", "NO" ]
• messageClass: object MessageClass
• messageReference: string
• messageSize: integer (int32)
  Minimum Value: 0
• numberofMessagesSent: integer (int32)
  Minimum Value: 0
• originatorInfo: object OriginatorInfo
• rATType:
• recipientInfo: array recipientInfo
  Minimum Number of Items: 0
• sMDataCodingScheme: integer
• sMDischargeTime: string (date-time)
• sMMessageType: string
  Allowed Values: [ "SUBMISSION", "DELIVERY_REPORT", "SM_SERVICE_REQUEST" ]
• sMPriority: string
  Allowed Values: [ "LOW", "NORMAL", "HIGH" ]
• sMReplyPathRequested: string
  Allowed Values: [ "NO_REPLY_PATH_SET", "REPLY_PATH_SET" ]
• sMSCAddress: string
• sMSequenceNumber: integer (int32)
  Minimum Value: 0
• sMServiceType: string
  Allowed Values: [ "VAS4SMS_SHORT_MESSAGE_CONTENT_PROCESSING", "VAS4SMS_SHORT_MESSAGE_FORWARDING", "VAS4SMS_SHORT_MESSAGE_FORWARDING_MULTIPLE_SUBSCRIPTIONS", "VAS4SMS_SHORT_MESSAGE_FILTERING", "VAS4SMS_SHORT_MESSAGE_RECEIPT", "VAS4SMS_SHORT_MESSAGE_NETWORK_STORAGE", "VAS4SMS_SHORT_MESSAGE_TO_MULTIPLE_DESTINATIONS", "VAS4SMS_SHORT_MESSAGE_VIRTUAL_PRIVATE_NETWORK(VPN)", "VAS4SMS_SHORT_MESSAGE_AUTO_REPLY", "VAS4SMS_SHORT_MESSAGE_PERSONAL_SIGNATURE", "VAS4SMS_SHORT_MESSAGE_DEFERRED_DELIVERY" ]
• sMSresult: integer (int32)
  Minimum Value: 0
• sMStatus: string
• sMUserDataHeader: string
• submissionTime: string (date-time)
• uetimeZone: string
• userEquipmentInfo: string
  Pattern: ^(imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$
• userLocationinfo: object UserLocation

{
    "type":"object",
    "description":"SMS-specific information.",
    "properties":{
        "originatorInfo":{
            "$ref":"#/components/schemas/OriginatorInfo"
        },
        "recipientInfo":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RecipientInfo"
            },
            "minItems":0
        },
        "userEquipmentInfo":{
            "$ref":"#/components/schemas/Pei"
        },
        "userLocationinfo":{
            "$ref":"#/components/schemas/UserLocation"
        },
        "uetimeZone":{
            "$ref":"#/components/schemas/TimeZone"
        },
        "rATType":{
            "$ref":"#/components/schemas/RatType"
        },
        "sMSCAddress":{
            "type":"string"
        },
        "sMDataCodingScheme":{
            "type":"integer"
        },
        "sMMessageType":{
            "$ref":"#/components/schemas/SMMessageType"
        },
        "sMReplyPathRequested":{
            "$ref":"#/components/schemas/ReplyPathRequested"
        },
        "sMUserDataHeader":{
            "type":"string"
        },
        "sMStatus":{
            "type":"string"
        },
        "sMDischargeTime":{
            "format":"date-time",
            "type":"string"
        },
        "numberofMessagesSent":{
            "format":"int32",
            "type":"integer",
            "minimum":0
        },
        "sMServiceType":{
            "$ref":"#/components/schemas/SMServiceType"
        },
        "sMSequenceNumber":{
            "format":"int32",
            "type":"integer",
            "minimum":0
        },
        "sMSresult":{
            "format":"int32",
            "type":"integer",
            "minimum":0
        },
        "submissionTime":{
            "format":"date-time",
            "type":"string"
        },
        "sMPriority":{
            "$ref":"#/components/schemas/SMPriority"
        },
        "messageReference":{
            "type":"string"
        },
        "messageSize":{
            "format":"int32",
            "type":"integer",
            "minimum":0
        },
        "messageClass":{
            "$ref":"#/components/schemas/MessageClass"
        },
        "deliveryReportRequested":{
            "$ref":"#/components/schemas/DeliveryReportRequested"
        }
    }
}

Nested Schema : triggers

Type: array

Minimum Number of Items: 0

The triggers for usage reporting associated to the rating group, which is supplied from the CHF.

The presence of the triggers attribute without any triggerType is used by CHF to disable all of the triggers to the associated rating group.

Show Source

• Array of: object Trigger

{
    "description":"The triggers for usage reporting associated to the rating group, which is supplied from the CHF. <p>The presence of the triggers attribute without any triggerType is used by CHF to disable all of the triggers to the associated rating group.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Trigger"
    },
    "minItems":0
}

Nested Schema : presenceReportingAreaInformation

Type: object

Minimum Number of Properties: 0

Additional Properties Allowed

Show Source

• object PresenceInfo

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/PresenceInfo"
    },
    "minProperties":0
}

Nested Schema : UserInformation

Type: object

Show Source

• roamerInOut: string
  Allowed Values: [ "IN_BOUND", "OUT_BOUND" ]
• servedGPSI: string
  Pattern: ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$
• servedPEI: string
  Pattern: ^(imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$
• unauthenticatedFlag: boolean

{
    "type":"object",
    "properties":{
        "servedGPSI":{
            "$ref":"#/components/schemas/Gpsi"
        },
        "servedPEI":{
            "$ref":"#/components/schemas/Pei"
        },
        "unauthenticatedFlag":{
            "type":"boolean"
        },
        "roamerInOut":{
            "$ref":"#/components/schemas/RoamerInOut"
        }
    }
}

Nested Schema : UserLocation

Type: object

Show Source

• eutraLocation: object EutraLocation
• n3gaLocation: object N3gaLocation
• nrLocation: object NrLocation

{
    "type":"object",
    "properties":{
        "eutraLocation":{
            "$ref":"#/components/schemas/EutraLocation"
        },
        "nrLocation":{
            "$ref":"#/components/schemas/NrLocation"
        },
        "n3gaLocation":{
            "$ref":"#/components/schemas/N3gaLocation"
        }
    }
}

Nested Schema : PresenceInfo

Type: object

Show Source

• ecgiList: array ecgiList
  Minimum Number of Items: 1
• globalRanNodeIdList: array globalRanNodeIdList
  Minimum Number of Items: 1
• ncgiList: array ncgiList
  Minimum Number of Items: 1
• praId: string
• presenceState:
• trackingAreaList: array trackingAreaList
  Minimum Number of Items: 1

{
    "type":"object",
    "properties":{
        "praId":{
            "type":"string"
        },
        "presenceState":{
            "$ref":"#/components/schemas/PresenceState"
        },
        "trackingAreaList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Tai"
            },
            "minItems":1
        },
        "ecgiList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Ecgi"
            },
            "minItems":1
        },
        "ncgiList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Ncgi"
            },
            "minItems":1
        },
        "globalRanNodeIdList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/GlobalRanNodeId"
            },
            "minItems":1
        }
    }
}

Nested Schema : ecgiList

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object Ecgi

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Ecgi"
    },
    "minItems":1
}

Nested Schema : globalRanNodeIdList

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object GlobalRanNodeId

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/GlobalRanNodeId"
    },
    "minItems":1
}

Nested Schema : ncgiList

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object Ncgi

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Ncgi"
    },
    "minItems":1
}

Nested Schema : trackingAreaList

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object Tai

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Tai"
    },
    "minItems":1
}

Nested Schema : Ecgi

Type: object

Show Source

• eutraCellId(required): string
  Pattern: ^[A-Fa-f0-9]{7}$
• plmnId(required): object PlmnId

{
    "type":"object",
    "properties":{
        "plmnId":{
            "$ref":"#/components/schemas/PlmnId"
        },
        "eutraCellId":{
            "$ref":"#/components/schemas/EutraCellId"
        }
    },
    "required":[
        "plmnId",
        "eutraCellId"
    ]
}

Nested Schema : PlmnId

Type: object

Show Source

• mcc(required): string
  Pattern: ^\d{3}$
• mnc(required): string
  Pattern: ^\d{2,3}$

{
    "type":"object",
    "properties":{
        "mcc":{
            "$ref":"#/components/schemas/Mcc"
        },
        "mnc":{
            "$ref":"#/components/schemas/Mnc"
        }
    },
    "required":[
        "mcc",
        "mnc"
    ]
}

Nested Schema : GlobalRanNodeId

Type: object

Show Source

• gNbId: object GNbId
• n3IwfId: string
  Pattern: ^[A-Fa-f0-9]+$
• ngeNbId: string
  Pattern: ^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]{6}|SMacroNGeNB-[A-Fa-f0-9]{5})$
• plmnId(required): object PlmnId

{
    "type":"object",
    "properties":{
        "plmnId":{
            "$ref":"#/components/schemas/PlmnId"
        },
        "n3IwfId":{
            "$ref":"#/components/schemas/N3IwfId"
        },
        "gNbId":{
            "$ref":"#/components/schemas/GNbId"
        },
        "ngeNbId":{
            "$ref":"#/components/schemas/NgeNbId"
        }
    },
    "oneOf":[
        {
            "required":[
                "n3IwfId"
            ]
        },
        {
            "required":[
                "gNbId"
            ]
        },
        {
            "required":[
                "ngeNbId"
            ]
        }
    ],
    "required":[
        "plmnId"
    ]
}

Match One Schema

Show Source

{
    "type":"object",
    "properties":{
        "plmnId":{
            "$ref":"#/components/schemas/PlmnId"
        },
        "n3IwfId":{
            "$ref":"#/components/schemas/N3IwfId"
        },
        "gNbId":{
            "$ref":"#/components/schemas/GNbId"
        },
        "ngeNbId":{
            "$ref":"#/components/schemas/NgeNbId"
        }
    },
    "oneOf":[
        {
            "required":[
                "n3IwfId"
            ]
        },
        {
            "required":[
                "gNbId"
            ]
        },
        {
            "required":[
                "ngeNbId"
            ]
        }
    ],
    "required":[
        "plmnId"
    ]
}

Nested Schema : GNbId

Type: object

Show Source

• bitLength(required): integer
  Minimum Value: 22

  Maximum Value: 32
• gNBValue(required): string
  Pattern: ^[A-Fa-f0-9]{6,8}$

{
    "type":"object",
    "properties":{
        "bitLength":{
            "type":"integer",
            "minimum":22,
            "maximum":32
        },
        "gNBValue":{
            "type":"string",
            "pattern":"^[A-Fa-f0-9]{6,8}$"
        }
    },
    "required":[
        "bitLength",
        "gNBValue"
    ]
}

Nested Schema : Ncgi

Type: object

Show Source

• nrCellId(required): string
  Pattern: ^[A-Fa-f0-9]{9}$
• plmnId(required): object PlmnId

{
    "type":"object",
    "properties":{
        "plmnId":{
            "$ref":"#/components/schemas/PlmnId"
        },
        "nrCellId":{
            "$ref":"#/components/schemas/NrCellId"
        }
    },
    "required":[
        "plmnId",
        "nrCellId"
    ]
}

Nested Schema : Tai

Type: object

Show Source

• plmnId(required): object PlmnId
• tac(required): string
  Pattern: (^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)

{
    "type":"object",
    "properties":{
        "plmnId":{
            "$ref":"#/components/schemas/PlmnId"
        },
        "tac":{
            "$ref":"#/components/schemas/Tac"
        }
    },
    "required":[
        "plmnId",
        "tac"
    ]
}

Nested Schema : EutraLocation

Type: object

Show Source

• ageOfLocationInformation: integer
  Minimum Value: 0

  Maximum Value: 32767
• ecgi(required): object Ecgi
• geodeticInformation: string
  Pattern: ^[0-9A-F]{20}$
• geographicalInformation: string
  Pattern: ^[0-9A-F]{16}$
• globalNgenbId: object GlobalRanNodeId
• tai(required): object Tai
• ueLocationTimestamp: string (date-time)

{
    "type":"object",
    "properties":{
        "tai":{
            "$ref":"#/components/schemas/Tai"
        },
        "ecgi":{
            "$ref":"#/components/schemas/Ecgi"
        },
        "ageOfLocationInformation":{
            "type":"integer",
            "minimum":0,
            "maximum":32767
        },
        "ueLocationTimestamp":{
            "format":"date-time",
            "type":"string"
        },
        "geographicalInformation":{
            "type":"string",
            "pattern":"^[0-9A-F]{16}$"
        },
        "geodeticInformation":{
            "type":"string",
            "pattern":"^[0-9A-F]{20}$"
        },
        "globalNgenbId":{
            "$ref":"#/components/schemas/GlobalRanNodeId"
        }
    },
    "required":[
        "tai",
        "ecgi"
    ]
}

Nested Schema : N3gaLocation

Type: object

Show Source

• n3gppTai: object Tai
• n3IwfId: string
  Pattern: ^[A-Fa-f0-9]+$
• portNumber: integer
  Minimum Value: 0
• ueIpv4Addr: string
  Pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$

  Example: 198.51.100.1
• ueIpv6Addr: string Ipv6Addr

{
    "type":"object",
    "properties":{
        "n3gppTai":{
            "$ref":"#/components/schemas/Tai"
        },
        "n3IwfId":{
            "type":"string",
            "pattern":"^[A-Fa-f0-9]+$"
        },
        "ueIpv4Addr":{
            "$ref":"#/components/schemas/Ipv4Addr"
        },
        "ueIpv6Addr":{
            "$ref":"#/components/schemas/Ipv6Addr"
        },
        "portNumber":{
            "$ref":"#/components/schemas/Uinteger"
        }
    }
}

Nested Schema : NrLocation

Type: object

Show Source

• ageOfLocationInformation: integer
  Minimum Value: 0

  Maximum Value: 32767
• geodeticInformation: string
  Pattern: ^[0-9A-F]{20}$
• geographicalInformation: string
  Pattern: ^[0-9A-F]{16}$
• globalGnbId: object GlobalRanNodeId
• ncgi(required): object Ncgi
• tai(required): object Tai
• ueLocationTimestamp: string (date-time)

{
    "type":"object",
    "properties":{
        "tai":{
            "$ref":"#/components/schemas/Tai"
        },
        "ncgi":{
            "$ref":"#/components/schemas/Ncgi"
        },
        "ageOfLocationInformation":{
            "type":"integer",
            "minimum":0,
            "maximum":32767
        },
        "ueLocationTimestamp":{
            "format":"date-time",
            "type":"string"
        },
        "geographicalInformation":{
            "type":"string",
            "pattern":"^[0-9A-F]{16}$"
        },
        "geodeticInformation":{
            "type":"string",
            "pattern":"^[0-9A-F]{20}$"
        },
        "globalGnbId":{
            "$ref":"#/components/schemas/GlobalRanNodeId"
        }
    },
    "required":[
        "tai",
        "ncgi"
    ]
}

Nested Schema : Ipv6Addr

Match All

Show Source

• Pattern: ^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$
• Pattern: ^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$

{
    "type":"string",
    "allOf":[
        {
            "pattern":"^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$"
        },
        {
            "pattern":"^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$"
        }
    ],
    "example":"2001:db8:85a3::8a2e:370:7334"
}

Example:

2001:db8:85a3::8a2e:370:7334

Nested Schema : MultipleUnitUsage

Type: object

Show Source

• ratingGroup(required): integer (int32)
  Minimum Value: 0

  The ID of the rating group.
• requestedUnit: object RequestedUnit
• uPFID: string (uuid)
• usedUnitContainer: array usedUnitContainer
  Minimum Number of Items: 0

{
    "type":"object",
    "properties":{
        "ratingGroup":{
            "$ref":"#/components/schemas/RatingGroup"
        },
        "requestedUnit":{
            "$ref":"#/components/schemas/RequestedUnit"
        },
        "usedUnitContainer":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UsedUnitContainer"
            },
            "minItems":0
        },
        "uPFID":{
            "$ref":"#/components/schemas/NfInstanceId"
        }
    },
    "required":[
        "ratingGroup"
    ]
}

Nested Schema : RequestedUnit

Type: object

Show Source

• downlinkVolume: integer (int64)
  Minimum Value: 0
• serviceSpecificUnits: integer (int64)
  Minimum Value: 0
• time: integer (int32)
  Minimum Value: 0
• totalVolume: integer (int64)
  Minimum Value: 0
• uplinkVolume: integer (int64)
  Minimum Value: 0

{
    "type":"object",
    "properties":{
        "time":{
            "format":"int32",
            "type":"integer",
            "minimum":0
        },
        "totalVolume":{
            "$ref":"#/components/schemas/Uint64"
        },
        "uplinkVolume":{
            "$ref":"#/components/schemas/Uint64"
        },
        "downlinkVolume":{
            "$ref":"#/components/schemas/Uint64"
        },
        "serviceSpecificUnits":{
            "$ref":"#/components/schemas/Uint64"
        }
    }
}

Nested Schema : usedUnitContainer

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object UsedUnitContainer

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UsedUnitContainer"
    },
    "minItems":0
}

Nested Schema : UsedUnitContainer

Type: object

Show Source

• downlinkVolume: integer (int64)
  Minimum Value: 0
• eventTimeStamps: array eventTimeStamps
  Minimum Number of Items: 0
• localSequenceNumber(required): integer
• nSPAContainerInformation: object NSPAContainerInformation
• pDUContainerInformation: object PDUContainerInformation
• quotaManagementIndicator: string
  Allowed Values: [ "ONLINE_CHARGING", "OFFLINE_CHARGING", "QUOTA_MANAGEMENT_SUSPENDED" ]

  Indicates the charging type for the usage request: (ONLINE_CHARGING) for online charging, (OFFLINE_CHARGING) for offline-only charging, or (QUOTA_MANAGEMENT_SUSPENDED) for suspended charging.
• serviceId: integer (int32)
  Minimum Value: 0

  The ID of the service.
• serviceSpecificUnits: integer (int64)
  Minimum Value: 0
• time: integer (int32)
  Minimum Value: 0
• totalVolume: integer (int64)
  Minimum Value: 0
• triggers: array triggers
  Minimum Number of Items: 0
• triggerTimestamp: string (date-time)
• uplinkVolume: integer (int64)
  Minimum Value: 0

{
    "type":"object",
    "properties":{
        "serviceId":{
            "$ref":"#/components/schemas/ServiceId"
        },
        "quotaManagementIndicator":{
            "$ref":"#/components/schemas/QuotaManagementIndicator"
        },
        "triggers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Trigger"
            },
            "minItems":0
        },
        "triggerTimestamp":{
            "format":"date-time",
            "type":"string"
        },
        "time":{
            "format":"int32",
            "type":"integer",
            "minimum":0
        },
        "totalVolume":{
            "$ref":"#/components/schemas/Uint64"
        },
        "uplinkVolume":{
            "$ref":"#/components/schemas/Uint64"
        },
        "downlinkVolume":{
            "$ref":"#/components/schemas/Uint64"
        },
        "serviceSpecificUnits":{
            "$ref":"#/components/schemas/Uint64"
        },
        "eventTimeStamps":{
            "type":"array",
            "items":{
                "format":"date-time",
                "type":"string"
            },
            "minItems":0
        },
        "localSequenceNumber":{
            "type":"integer"
        },
        "pDUContainerInformation":{
            "$ref":"#/components/schemas/PDUContainerInformation"
        },
        "nSPAContainerInformation":{
            "$ref":"#/components/schemas/NSPAContainerInformation"
        }
    },
    "required":[
        "localSequenceNumber"
    ]
}

Nested Schema : eventTimeStamps

Type: array

Minimum Number of Items: 0

Show Source

• Array of: string(date-time)

{
    "type":"array",
    "items":{
        "format":"date-time",
        "type":"string"
    },
    "minItems":0
}

Nested Schema : NSPAContainerInformation

Type: object

Show Source

• latency: integer
• loadLevel: object NsiLoadLevelInfo
  Represents the network slice and optionally the associated network slice instance and the load level information.
• maximumPacketLossRate: string
• serviceExperienceStatisticsData: object ServiceExperienceInfo
  Represents service experience information.
• theNumberOfPDUSessions: integer
• theNumberOfRegisteredSubscribers: integer
• throughput: object Throughput

{
    "type":"object",
    "properties":{
        "latency":{
            "type":"integer"
        },
        "throughput":{
            "$ref":"#/components/schemas/Throughput"
        },
        "maximumPacketLossRate":{
            "type":"string"
        },
        "serviceExperienceStatisticsData":{
            "$ref":"#/components/schemas/ServiceExperienceInfo"
        },
        "theNumberOfPDUSessions":{
            "type":"integer"
        },
        "theNumberOfRegisteredSubscribers":{
            "type":"integer"
        },
        "loadLevel":{
            "$ref":"#/components/schemas/NsiLoadLevelInfo"
        }
    }
}

Nested Schema : PDUContainerInformation

Type: object

Show Source

• 3gppPSDataOffStatus: string
  Allowed Values: [ "ACTIVE", "INACTIVE" ]
• afChargingIdentifier: integer (int32)
  Minimum Value: 0
• applicationserviceProviderIdentity: string
• chargingRuleBaseName: string
• mAPDUSteeringFunctionality:
  Possible values are:

  • MPTCP: Indicates that PCF authorizes the MPTCP functionality to support traffic steering, switching and splitting.
  • ATSSS_LL: Indicates that PCF authorizes the ATSSS-LL functionality to support traffic steering, switching and splitting.
• mAPDUSteeringMode: object SteeringMode
  Contains the steering mode value and parameters determined by the PCF.
• presenceReportingAreaInformation: object presenceReportingAreaInformation
  Minimum Number of Properties: 0

  Additional Properties Allowed: PresenceInfo
• qoSCharacteristics: object QosCharacteristics
  Contains QoS characteristics for a non-standardized or a non-configured 5QI.
• qoSInformation: object QosData
• rATType:
• servingNodeID: array servingNodeID
  Minimum Number of Items: 0
• sponsorIdentity: string
• timeofFirstUsage: string (date-time)
• timeofLastUsage: string (date-time)
• uetimeZone: string
• userLocationInformation: object UserLocation

{
    "type":"object",
    "properties":{
        "timeofFirstUsage":{
            "format":"date-time",
            "type":"string"
        },
        "timeofLastUsage":{
            "format":"date-time",
            "type":"string"
        },
        "qoSInformation":{
            "$ref":"#/components/schemas/QosData"
        },
        "qoSCharacteristics":{
            "$ref":"#/components/schemas/QosCharacteristics"
        },
        "afChargingIdentifier":{
            "$ref":"#/components/schemas/ChargingId"
        },
        "userLocationInformation":{
            "$ref":"#/components/schemas/UserLocation"
        },
        "uetimeZone":{
            "$ref":"#/components/schemas/TimeZone"
        },
        "rATType":{
            "$ref":"#/components/schemas/RatType"
        },
        "servingNodeID":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServingNetworkFunctionID"
            },
            "minItems":0
        },
        "presenceReportingAreaInformation":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/PresenceInfo"
            },
            "minProperties":0
        },
        "3gppPSDataOffStatus":{
            "$ref":"#/components/schemas/3GPPPSDataOffStatus"
        },
        "sponsorIdentity":{
            "type":"string"
        },
        "applicationserviceProviderIdentity":{
            "type":"string"
        },
        "chargingRuleBaseName":{
            "type":"string"
        },
        "mAPDUSteeringFunctionality":{
            "$ref":"#/components/schemas/SteeringFunctionality"
        },
        "mAPDUSteeringMode":{
            "$ref":"#/components/schemas/SteeringMode"
        }
    }
}

Nested Schema : triggers

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object Trigger

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Trigger"
    },
    "minItems":0
}

Nested Schema : NsiLoadLevelInfo

Type: object

Represents the network slice and optionally the associated network slice instance and the load level information.

Show Source

• confidence: integer
  Minimum Value: 0
• exceedLoadLevelThrInd: boolean
• loadLevelInformation(required): integer
  Load-level information of the network slice and the optionally associated network slice instance.
• networkArea: object NetworkAreaInfo
  Describes a network area in which the NF service consumer requests the number of UEs.
• numOfExceedLoadLevelThr: integer
  Minimum Value: 0
• numOfPduSess: object NumberAverage
  Represents average and variance information.
• numOfUes: object NumberAverage
  Represents average and variance information.
• resUsage: object ResourceUsage
  The current usage of the virtual resources assigned to the NF instances belonging to a particular network slice instance.
• snssai(required): object Snssai
  The S-NSSAIs of the NF.
• timePeriod: object TimeWindow
  Represents a time window identified by a start time and a stop time.

{
    "description":"Represents the network slice and optionally the associated network slice instance and the load level information.",
    "type":"object",
    "properties":{
        "loadLevelInformation":{
            "$ref":"#/components/schemas/LoadLevelInformation"
        },
        "snssai":{
            "$ref":"#/components/schemas/Snssai"
        },
        "resUsage":{
            "$ref":"#/components/schemas/ResourceUsage"
        },
        "numOfExceedLoadLevelThr":{
            "$ref":"#/components/schemas/Uinteger"
        },
        "exceedLoadLevelThrInd":{
            "type":"boolean"
        },
        "networkArea":{
            "$ref":"#/components/schemas/NetworkAreaInfo"
        },
        "timePeriod":{
            "$ref":"#/components/schemas/TimeWindow"
        },
        "numOfUes":{
            "$ref":"#/components/schemas/NumberAverage"
        },
        "numOfPduSess":{
            "$ref":"#/components/schemas/NumberAverage"
        },
        "confidence":{
            "$ref":"#/components/schemas/Uinteger"
        }
    },
    "required":[
        "loadLevelInformation",
        "snssai"
    ]
}

Nested Schema : ServiceExperienceInfo

Type: object

Represents service experience information.

Show Source

• appId: string
• confidence: integer
  Minimum Value: 0
• dnn: string
• networkArea: object NetworkAreaInfo
  Describes a network area in which the NF service consumer requests the number of UEs.
• ratType:
• snssai: object Snssai
  The S-NSSAIs of the NF.
• srvExpcType:
  This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.

  Possible values are:

  • VOICE: Indicates that the service experience analytics is for voice service.
  • VIDEO: Indicates that the service experience analytics is for video service.

• supis: array supis
  Minimum Number of Items: 1
• svcExprcVariance: number (float)

{
    "description":"Represents service experience information.",
    "type":"object",
    "properties":{
        "svcExprcVariance":{
            "$ref":"#/components/schemas/Float"
        },
        "supis":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Supi"
            },
            "minItems":1
        },
        "snssai":{
            "$ref":"#/components/schemas/Snssai"
        },
        "appId":{
            "$ref":"#/components/schemas/ApplicationId"
        },
        "srvExpcType":{
            "$ref":"#/components/schemas/ServiceExperienceType"
        },
        "confidence":{
            "$ref":"#/components/schemas/Uinteger"
        },
        "dnn":{
            "$ref":"#/components/schemas/Dnn"
        },
        "networkArea":{
            "$ref":"#/components/schemas/NetworkAreaInfo"
        },
        "ratType":{
            "$ref":"#/components/schemas/RatType"
        }
    },
    "required":[
        "svcExprc"
    ]
}

Nested Schema : Throughput

Type: object

Show Source

• guaranteedThpt: number (float)
• maximumThpt: number (float)

{
    "type":"object",
    "properties":{
        "guaranteedThpt":{
            "$ref":"#/components/schemas/Float"
        },
        "maximumThpt":{
            "$ref":"#/components/schemas/Float"
        }
    }
}

Nested Schema : NetworkAreaInfo

Type: object

Describes a network area in which the NF service consumer requests the number of UEs.

Show Source

• ecgis: array ecgis
  Minimum Number of Items: 1

  Contains a list of E-UTRA cell identities.
• gRanNodeIds: array gRanNodeIds
  Minimum Number of Items: 1

  Contains a list of NG RAN nodes.
• ncgis: array ncgis
  Minimum Number of Items: 1

  Contains a list of NR cell identities.
• tais: array tais
  Minimum Number of Items: 1

  Contains a list of tracking area identities.

{
    "description":"Describes a network area in which the NF service consumer requests the number of UEs.",
    "type":"object",
    "properties":{
        "ecgis":{
            "description":"Contains a list of E-UTRA cell identities.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Ecgi"
            },
            "minItems":1
        },
        "ncgis":{
            "description":"Contains a list of NR cell identities.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Ncgi"
            },
            "minItems":1
        },
        "gRanNodeIds":{
            "description":"Contains a list of NG RAN nodes.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/GlobalRanNodeId"
            },
            "minItems":1
        },
        "tais":{
            "description":"Contains a list of tracking area identities.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Tai"
            },
            "minItems":1
        }
    }
}

Nested Schema : NumberAverage

Type: object

Represents average and variance information.

Show Source

• number(required): integer
  The average number.
• variance(required): number (float)

{
    "description":"Represents average and variance information.",
    "type":"object",
    "properties":{
        "number":{
            "description":"The average number.",
            "type":"integer"
        },
        "variance":{
            "$ref":"#/components/schemas/Float"
        }
    },
    "required":[
        "number",
        "variance"
    ]
}

Nested Schema : ResourceUsage

Type: object

The current usage of the virtual resources assigned to the NF instances belonging to a particular network slice instance.

Show Source

• cpuUsage: integer
  Minimum Value: 0
• memoryUsage: integer
  Minimum Value: 0
• storageUsage: integer
  Minimum Value: 0

{
    "description":"The current usage of the virtual resources assigned to the NF instances belonging to a particular network slice instance.",
    "type":"object",
    "properties":{
        "cpuUsage":{
            "$ref":"#/components/schemas/Uinteger"
        },
        "memoryUsage":{
            "$ref":"#/components/schemas/Uinteger"
        },
        "storageUsage":{
            "$ref":"#/components/schemas/Uinteger"
        }
    }
}

Nested Schema : Snssai

Type: object

The S-NSSAIs of the NF.

Show Source

• sd: string
  Pattern: ^[A-Fa-f0-9]{6}$

  The S-NSSAI Slice Differentiator (SD) ID of the network slices that are allowed to access the HTTP Gateway server.
• sst(required): integer
  Minimum Value: 0

  Maximum Value: 255

  The S-NSSAI Slice/Service Type (SST) ID of the network slices that are allowed to access the HTTP Gateway server.

{
    "description":"The S-NSSAIs of the NF.",
    "type":"object",
    "properties":{
        "sst":{
            "description":"The S-NSSAI Slice/Service Type (SST) ID of the network slices that are allowed to access the HTTP Gateway server.",
            "type":"integer",
            "minimum":0,
            "maximum":255
        },
        "sd":{
            "description":"The S-NSSAI Slice Differentiator (SD) ID of the network slices that are allowed to access the HTTP Gateway server.",
            "type":"string",
            "pattern":"^[A-Fa-f0-9]{6}$"
        }
    },
    "required":[
        "sst"
    ]
}

Nested Schema : TimeWindow

Type: object

Represents a time window identified by a start time and a stop time.

Show Source

• startTime(required): string (date-time)
  The starting time.
• stopTime(required): string (date-time)
  The stopping time.

{
    "description":"Represents a time window identified by a start time and a stop time.",
    "type":"object",
    "properties":{
        "startTime":{
            "description":"The starting time.",
            "format":"date-time",
            "type":"string"
        },
        "stopTime":{
            "description":"The stopping time.",
            "format":"date-time",
            "type":"string"
        }
    },
    "required":[
        "startTime",
        "stopTime"
    ]
}

Nested Schema : ecgis

Type: array

Minimum Number of Items: 1

Contains a list of E-UTRA cell identities.

Show Source

• Array of: object Ecgi

{
    "description":"Contains a list of E-UTRA cell identities.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Ecgi"
    },
    "minItems":1
}

Nested Schema : gRanNodeIds

Type: array

Minimum Number of Items: 1

Contains a list of NG RAN nodes.

Show Source

• Array of: object GlobalRanNodeId

{
    "description":"Contains a list of NG RAN nodes.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/GlobalRanNodeId"
    },
    "minItems":1
}

Nested Schema : ncgis

Type: array

Minimum Number of Items: 1

Contains a list of NR cell identities.

Show Source

• Array of: object Ncgi

{
    "description":"Contains a list of NR cell identities.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Ncgi"
    },
    "minItems":1
}

Nested Schema : tais

Type: array

Minimum Number of Items: 1

Contains a list of tracking area identities.

Show Source

• Array of: object Tai

{
    "description":"Contains a list of tracking area identities.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Tai"
    },
    "minItems":1
}

Nested Schema : supis

Type: array

Minimum Number of Items: 1

Show Source

• Array of: string
  Pattern: ^(imsi-[0-9]{5,15}|nai-.+|.+)$

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Supi"
    },
    "minItems":1
}

Nested Schema : SteeringMode

Type: object

Contains the steering mode value and parameters determined by the PCF.

Show Source

• 3gLoad: integer
  Minimum Value: 0
• active: string
  Allowed Values: [ "3GPP_ACCESS", "NON_3GPP_ACCESS" ]
• prioAcc: string
  Allowed Values: [ "3GPP_ACCESS", "NON_3GPP_ACCESS" ]
• standby: string
  Allowed Values: [ "3GPP_ACCESS", "NON_3GPP_ACCESS" ]
• steerModeInd:
  Contains an autonomous load-balance indicator or UE-assistance indicator.
• steerModeValue(required):
• thresValue: object ThresholdValue
  Indicates the threshold values for round-trip time (RTT) and packet loss rate.

{
    "description":"Contains the steering mode value and parameters determined by the PCF.",
    "type":"object",
    "properties":{
        "steerModeValue":{
            "$ref":"#/components/schemas/SteerModeValue"
        },
        "active":{
            "$ref":"#/components/schemas/AccessType"
        },
        "standby":{
            "$ref":"#/components/schemas/AccessTypeRm"
        },
        "3gLoad":{
            "$ref":"#/components/schemas/Uinteger"
        },
        "prioAcc":{
            "$ref":"#/components/schemas/AccessType"
        },
        "thresValue":{
            "$ref":"#/components/schemas/ThresholdValue"
        },
        "steerModeInd":{
            "$ref":"#/components/schemas/SteerModeIndicator"
        }
    },
    "required":[
        "steerModeValue"
    ]
}

Nested Schema : presenceReportingAreaInformation

Type: object

Minimum Number of Properties: 0

Additional Properties Allowed

Show Source

• object PresenceInfo

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/PresenceInfo"
    },
    "minProperties":0
}

Nested Schema : QosCharacteristics

Type: object

Contains QoS characteristics for a non-standardized or a non-configured 5QI.

Show Source

• 5qi(required): integer
  Minimum Value: 0

  Maximum Value: 255
• averagingWindow: integer
  Minimum Value: 1

  Maximum Value: 4095

  Default Value: 2000

  The averaging window.
• maxDataBurstVol: integer
  Minimum Value: 1

  Maximum Value: 4095

  The maximum data burst volume.
• packetDelayBudget(required): integer
  Minimum Value: 1

  The packet delay budget.
• packetErrorRate(required): string
  Pattern: ^([0-9]E-[0-9])$

  The packet error rate.
• priorityLevel(required): integer
  Minimum Value: 1

  Maximum Value: 127

  An unsigned integer indicating the 5QI priority level, from range 1 through 127. Values are ordered in decreasing order of priority, with 1 as the highest priority.
• resourceType(required):
  Whether a QoS Flow is non-GBR, delay critical GBR, or non-delay critical GBR.

{
    "description":"Contains QoS characteristics for a non-standardized or a non-configured 5QI.",
    "type":"object",
    "properties":{
        "5qi":{
            "$ref":"#/components/schemas/5Qi"
        },
        "resourceType":{
            "$ref":"#/components/schemas/QosResourceType"
        },
        "priorityLevel":{
            "$ref":"#/components/schemas/5QiPriorityLevel"
        },
        "packetDelayBudget":{
            "$ref":"#/components/schemas/PacketDelBudget"
        },
        "packetErrorRate":{
            "$ref":"#/components/schemas/PacketErrRate"
        },
        "averagingWindow":{
            "$ref":"#/components/schemas/AverWindow"
        },
        "maxDataBurstVol":{
            "$ref":"#/components/schemas/MaxDataBurstVol"
        }
    },
    "required":[
        "5qi",
        "resourceType",
        "priorityLevel",
        "packetDelayBudget",
        "packetErrorRate"
    ]
}

Nested Schema : QosData

Type: object

Show Source

• 5qi: integer
  Minimum Value: 0

  Maximum Value: 255
• arp: object Arp
• averWindow: integer
  Minimum Value: 1

  Maximum Value: 4095

  Default Value: 2000

  The averaging window. This field can have a nullable value.
• defQosFlowIndication: boolean
  Indicates that the dynamic PCC rule shall always have its binding with the QoS Flow associated with the default QoS rule
• gbrDl: string
  Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
• gbrUl: string
  Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
• maxbrDl: string
  Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
• maxbrUl: string
  Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
• maxDataBurstVol: integer
  Minimum Value: 1

  Maximum Value: 4095

  The maximum data burst volume. This field can have a nullable value.
• maxPacketLossRateDl: integer
  Minimum Value: 0

  Maximum Value: 1000

  The packet loss rate. This field can have a nullable value.
• maxPacketLossRateUl: integer
  Minimum Value: 0

  Maximum Value: 1000

  The packet loss rate. This field can have a nullable value.
• priorityLevel: integer
  Minimum Value: 1

  Maximum Value: 127
• qnc: boolean
  Indicates whether notifications are requested from 3GPP NG-RAN when the GFBR can no longer (or again) be guaranteed for a QoS Flow during the lifetime of the QoS Flow.
• qosId(required): string
  Univocally identifies the QoS control policy data within a PDU session.
• reflectiveQos: boolean
  Indicates whether the QoS information is reflective for the corresponding service data flow.
• sharingKeyDl: string
  Indicates, by containing the same value, what PCC rules may share resource in downlink direction.
• sharingKeyUl: string
  Indicates, by containing the same value, what PCC rules may share resource in uplink direction.

{
    "type":"object",
    "properties":{
        "qosId":{
            "type":"string",
            "description":"Univocally identifies the QoS control policy data within a PDU session."
        },
        "5qi":{
            "$ref":"#/components/schemas/5Qi"
        },
        "maxbrUl":{
            "$ref":"#/components/schemas/BitRateRm"
        },
        "maxbrDl":{
            "$ref":"#/components/schemas/BitRateRm"
        },
        "gbrUl":{
            "$ref":"#/components/schemas/BitRateRm"
        },
        "gbrDl":{
            "$ref":"#/components/schemas/BitRateRm"
        },
        "arp":{
            "$ref":"#/components/schemas/Arp"
        },
        "qnc":{
            "type":"boolean",
            "description":"Indicates whether notifications are requested from 3GPP NG-RAN when the GFBR can no longer (or again) be guaranteed for a QoS Flow during the lifetime of the QoS Flow."
        },
        "priorityLevel":{
            "$ref":"#/components/schemas/5QiPriorityLevelRm"
        },
        "averWindow":{
            "$ref":"#/components/schemas/AverWindowRm"
        },
        "maxDataBurstVol":{
            "$ref":"#/components/schemas/MaxDataBurstVolRm"
        },
        "reflectiveQos":{
            "type":"boolean",
            "description":"Indicates whether the QoS information is reflective for the corresponding service data flow."
        },
        "sharingKeyDl":{
            "type":"string",
            "description":"Indicates, by containing the same value, what PCC rules may share resource in downlink direction."
        },
        "sharingKeyUl":{
            "type":"string",
            "description":"Indicates, by containing the same value, what PCC rules may share resource in uplink direction."
        },
        "maxPacketLossRateDl":{
            "$ref":"#/components/schemas/PacketLossRateRm"
        },
        "maxPacketLossRateUl":{
            "$ref":"#/components/schemas/PacketLossRateRm"
        },
        "defQosFlowIndication":{
            "type":"boolean",
            "description":"Indicates that the dynamic PCC rule shall always have its binding with the QoS Flow associated with the default QoS rule"
        }
    },
    "required":[
        "qosId"
    ],
    "nullable":true
}

Nested Schema : servingNodeID

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object ServingNetworkFunctionID

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServingNetworkFunctionID"
    },
    "minItems":0
}

Nested Schema : ThresholdValue

Type: object

Indicates the threshold values for round-trip time (RTT) and packet loss rate.

Show Source

• plrThres: integer
  Minimum Value: 0

  Maximum Value: 1000

  The packet loss rate. This field can have a nullable value.
• rttThres: integer
  Minimum Value: 0

{
    "description":"Indicates the threshold values for round-trip time (RTT) and packet loss rate.",
    "type":"object",
    "properties":{
        "rttThres":{
            "$ref":"#/components/schemas/UintegerRm"
        },
        "plrThres":{
            "$ref":"#/components/schemas/PacketLossRateRm"
        }
    },
    "nullable":true
}

Nested Schema : Arp

Type: object

Show Source

• preemptCap(required):
  Whether a bearer with a lower priority level should be dropped to free up the required resources.
• preemptVuln(required):
  Whether a service data flow can lose the resources assigned to it in order to admit a service data flow that has a higher priority level.
• priorityLevel(required): integer
  Minimum Value: 1

  Maximum Value: 15

  nullable true shall not be used for this attribute

{
    "type":"object",
    "properties":{
        "priorityLevel":{
            "$ref":"#/components/schemas/ArpPriorityLevel"
        },
        "preemptCap":{
            "$ref":"#/components/schemas/PreemptionCapability"
        },
        "preemptVuln":{
            "$ref":"#/components/schemas/PreemptionVulnerability"
        }
    },
    "required":[
        "priorityLevel",
        "preemptCap",
        "preemptVuln"
    ]
}

Nested Schema : ServingNetworkFunctionID

Type: object

Show Source

• aMFId: string
  Pattern: ^[A-Fa-f0-9]{6}$
• servingNetworkFunctionInformation(required): object NFIdentification
  A grouped field that contains a set of information identifying the NF consumer of the charging service.

{
    "type":"object",
    "properties":{
        "servingNetworkFunctionInformation":{
            "$ref":"#/components/schemas/NFIdentification"
        },
        "aMFId":{
            "$ref":"#/components/schemas/AmfId"
        }
    },
    "required":[
        "servingNetworkFunctionInformation"
    ]
}

Nested Schema : Trigger

Type: object

Show Source

• maxNumberOfccc: integer (int32)
  Minimum Value: 0
• timeLimit: integer
• triggerCategory(required): string
  Allowed Values: [ "IMMEDIATE_REPORT", "DEFERRED_REPORT" ]
• triggerType(required): string
  Allowed Values: [ "QUOTA_THRESHOLD", "QHT", "FINAL", "QUOTA_EXHAUSTED", "VALIDITY_TIME", "OTHER_QUOTA_TYPE", "FORCED_REAUTHORISATION", "UNUSED_QUOTA_TIMER", "UNIT_COUNT_INACTIVITY_TIMER", "ABNORMAL_RELEASE", "QOS_CHANGE", "VOLUME_LIMIT", "TIME_LIMIT", "EVENT_LIMIT", "PLMN_CHANGE", "USER_LOCATION_CHANGE", "RAT_CHANGE", "SESSION_AMBR_CHANGE", "UE_TIMEZONE_CHANGE", "TARIFF_TIME_CHANGE", "MAX_NUMBER_OF_CHANGES_IN_CHARGING_CONDITIONS", "MANAGEMENT_INTERVENTION", "CHANGE_OF_UE_PRESENCE_IN_PRESENCE_REPORTING_AREA", "CHANGE_OF_3GPP_PS_DATA_OFF_STATUS", "SERVING_NODE_CHANGE", "REMOVAL_OF_UPF", "ADDITION_OF_UPF", "INSERTION_OF_ISMF", "REMOVAL_OF_ISMF", "CHANGE_OF_ISMF", "START_OF_SERVICE_DATA_FLOW", "ECGI_CHANGE", "TAI_CHANGE", "HANDOVER_CANCEL", "HANDOVER_START", "HANDOVER_COMPLETE", "GFBR_GUARANTEED_STATUS_CHANGE", "ADDITION_OF_ACCESS", "REMOVAL_OF_ACCESS", "START_OF_SDF_ADDITIONAL_ACCESS" ]
• volumeLimit: integer (int32)
  Minimum Value: 0
• volumeLimit64: integer (int64)
  Minimum Value: 0

{
    "type":"object",
    "properties":{
        "triggerType":{
            "$ref":"#/components/schemas/TriggerType"
        },
        "triggerCategory":{
            "$ref":"#/components/schemas/TriggerCategory"
        },
        "timeLimit":{
            "$ref":"#/components/schemas/DurationSec"
        },
        "volumeLimit":{
            "format":"int32",
            "type":"integer",
            "minimum":0
        },
        "volumeLimit64":{
            "$ref":"#/components/schemas/Uint64"
        },
        "maxNumberOfccc":{
            "format":"int32",
            "type":"integer",
            "minimum":0
        }
    },
    "required":[
        "triggerType",
        "triggerCategory"
    ]
}

Nested Schema : allowedNSSAI

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object Snssai
  The S-NSSAIs of the NF.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Snssai"
    },
    "minItems":0
}

Nested Schema : forbiddenAreaList

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object Area

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Area"
    },
    "minItems":0
}

Nested Schema : restrictedCnList

Type: array

Minimum Number of Items: 0

Show Source

• Array of:

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CoreNetworkType"
    },
    "minItems":0
}

Nested Schema : restrictedRatList

Type: array

Minimum Number of Items: 0

Show Source

• Array of:

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RatType"
    },
    "minItems":0
}

Nested Schema : serviceAreaRestriction

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object ServiceAreaRestriction

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServiceAreaRestriction"
    },
    "minItems":0
}

Nested Schema : Area

Type: object

Show Source

• areaCode: string
• tacs: array tacs
  Minimum Number of Items: 1

{
    "type":"object",
    "oneOf":[
        {
            "required":[
                "tacs"
            ]
        },
        {
            "required":[
                "areaCode"
            ]
        }
    ],
    "properties":{
        "tacs":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Tac"
            },
            "minItems":1
        },
        "areaCode":{
            "$ref":"#/components/schemas/AreaCode"
        }
    }
}

Match One Schema

Show Source

{
    "type":"object",
    "oneOf":[
        {
            "required":[
                "tacs"
            ]
        },
        {
            "required":[
                "areaCode"
            ]
        }
    ],
    "properties":{
        "tacs":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Tac"
            },
            "minItems":1
        },
        "areaCode":{
            "$ref":"#/components/schemas/AreaCode"
        }
    }
}

Nested Schema : tacs

Type: array

Minimum Number of Items: 1

Show Source

• Array of: string
  Pattern: (^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Tac"
    },
    "minItems":1
}

Nested Schema : ServiceAreaRestriction

Type: object

Show Source

• areas: array areas
• maxNumOfTAs: integer
  Minimum Value: 0
• maxNumOfTAsForNotAllowedAreas: integer
  Minimum Value: 0
• restrictionType:

{
    "type":"object",
    "properties":{
        "restrictionType":{
            "$ref":"#/components/schemas/RestrictionType"
        },
        "areas":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Area"
            }
        },
        "maxNumOfTAs":{
            "$ref":"#/components/schemas/Uinteger"
        },
        "maxNumOfTAsForNotAllowedAreas":{
            "$ref":"#/components/schemas/Uinteger"
        }
    },
    "allOf":[
        {
            "oneOf":[
                {
                    "not":{
                        "required":[
                            "restrictionType"
                        ]
                    }
                },
                {
                    "required":[
                        "areas"
                    ]
                }
            ]
        },
        {
            "anyOf":[
                {
                    "not":{
                        "required":[
                            "restrictionType"
                        ],
                        "properties":{
                            "restrictionType":{
                                "type":"string",
                                "enum":[
                                    "NOT_ALLOWED_AREAS"
                                ]
                            }
                        }
                    }
                },
                {
                    "not":{
                        "required":[
                            "maxNumOfTAs"
                        ]
                    }
                }
            ]
        },
        {
            "anyOf":[
                {
                    "not":{
                        "required":[
                            "restrictionType"
                        ],
                        "properties":{
                            "restrictionType":{
                                "type":"string",
                                "enum":[
                                    "ALLOWED_AREAS"
                                ]
                            }
                        }
                    }
                },
                {
                    "not":{
                        "required":[
                            "maxNumOfTAsForNotAllowedAreas"
                        ]
                    }
                }
            ]
        }
    ]
}

Match All

Show Source

• ServiceAreaRestriction-allOf[0]

{
    "type":"object",
    "properties":{
        "restrictionType":{
            "$ref":"#/components/schemas/RestrictionType"
        },
        "areas":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Area"
            }
        },
        "maxNumOfTAs":{
            "$ref":"#/components/schemas/Uinteger"
        },
        "maxNumOfTAsForNotAllowedAreas":{
            "$ref":"#/components/schemas/Uinteger"
        }
    },
    "allOf":[
        {
            "oneOf":[
                {
                    "not":{
                        "required":[
                            "restrictionType"
                        ]
                    }
                },
                {
                    "required":[
                        "areas"
                    ]
                }
            ]
        },
        {
            "anyOf":[
                {
                    "not":{
                        "required":[
                            "restrictionType"
                        ],
                        "properties":{
                            "restrictionType":{
                                "type":"string",
                                "enum":[
                                    "NOT_ALLOWED_AREAS"
                                ]
                            }
                        }
                    }
                },
                {
                    "not":{
                        "required":[
                            "maxNumOfTAs"
                        ]
                    }
                }
            ]
        },
        {
            "anyOf":[
                {
                    "not":{
                        "required":[
                            "restrictionType"
                        ],
                        "properties":{
                            "restrictionType":{
                                "type":"string",
                                "enum":[
                                    "ALLOWED_AREAS"
                                ]
                            }
                        }
                    }
                },
                {
                    "not":{
                        "required":[
                            "maxNumOfTAsForNotAllowedAreas"
                        ]
                    }
                }
            ]
        }
    ]
}

Nested Schema : areas

Type: array

Show Source

• Array of: object Area

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Area"
    }
}

Nested Schema : ServiceAreaRestriction-allOf[0]

Match One Schema

Show Source

{
    "oneOf":[
        {
            "not":{
                "required":[
                    "restrictionType"
                ]
            }
        },
        {
            "required":[
                "areas"
            ]
        }
    ]
}

Nested Schema : listOfserviceProfileChargingInformation

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object ServiceProfileChargingInformation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServiceProfileChargingInformation"
    },
    "minItems":0
}

Nested Schema : ServiceProfileChargingInformation

Type: object

Show Source

• addServiceProfileInfo: string
• availability: number
• coverageArea: string
• dLThptPerSlice: object Throughput
• dLThptPerUE: object Throughput
• jitter: integer
• kPIMonitoringList: string
• latency: integer
• maxNumberofPDUsessions: integer
• maxNumberofUEs: integer
• reliability: string
• serviceProfileIdentifier: string
• sNSSAIList: array sNSSAIList
  Minimum Number of Items: 0
• supportedAccessTechnology: integer
• uLThptPerSlice: object Throughput
• uLThptPerUE: object Throughput

{
    "type":"object",
    "properties":{
        "serviceProfileIdentifier":{
            "type":"string"
        },
        "sNSSAIList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Snssai"
            },
            "minItems":0
        },
        "latency":{
            "type":"integer"
        },
        "availability":{
            "type":"number"
        },
        "jitter":{
            "type":"integer"
        },
        "reliability":{
            "type":"string"
        },
        "maxNumberofUEs":{
            "type":"integer"
        },
        "coverageArea":{
            "type":"string"
        },
        "dLThptPerSlice":{
            "$ref":"#/components/schemas/Throughput"
        },
        "dLThptPerUE":{
            "$ref":"#/components/schemas/Throughput"
        },
        "uLThptPerSlice":{
            "$ref":"#/components/schemas/Throughput"
        },
        "uLThptPerUE":{
            "$ref":"#/components/schemas/Throughput"
        },
        "maxNumberofPDUsessions":{
            "type":"integer"
        },
        "kPIMonitoringList":{
            "type":"string"
        },
        "supportedAccessTechnology":{
            "type":"integer"
        },
        "addServiceProfileInfo":{
            "type":"string"
        }
    }
}

Nested Schema : sNSSAIList

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object Snssai
  The S-NSSAIs of the NF.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Snssai"
    },
    "minItems":0
}

Nested Schema : PDUSessionInformation

Type: object

Show Source

• 3gppPSDataOffStatus: string
  Allowed Values: [ "ACTIVE", "INACTIVE" ]
• authorizedQoSInformation: object AuthorizedDefaultQos
• authorizedSessionAMBR: object Ambr
• chargingCharacteristics: string
  Pattern: ^[0-9a-fA-F]{1,4}$
• chargingCharacteristicsSelectionMode: string
  Allowed Values: [ "HOME_DEFAULT", "ROAMING_DEFAULT", "VISITING_DEFAULT" ]
• diagnostics: integer
• dnnId(required): string
• dnnSelectionMode: string
  Allowed Values: [ "VERIFIED", "UE_DNN_NOT_VERIFIED", "NW_DNN_NOT_VERIFIED" ]
• hPlmnId: object PlmnId
• mAPDUNon3GPPRATType:
• mAPDUSessionInformation: object MAPDUSessionInformation
• networkSlicingInfo: object NetworkSlicingInfo
• pduAddress: object PDUAddress
• pduSessionID(required): integer
  Minimum Value: 0

  Maximum Value: 255
• pduType:
• ratType:
• servingCNPlmnId: object PlmnId
• servingNetworkFunctionID: object ServingNetworkFunctionID
• sessionStopIndicator: boolean
• sscMode:
• startTime: string (date-time)
• stopTime: string (date-time)
• subscribedQoSInformation: object SubscribedDefaultQos
• subscribedSessionAMBR: object Ambr

{
    "type":"object",
    "properties":{
        "networkSlicingInfo":{
            "$ref":"#/components/schemas/NetworkSlicingInfo"
        },
        "pduSessionID":{
            "$ref":"#/components/schemas/PduSessionId"
        },
        "pduType":{
            "$ref":"#/components/schemas/PduSessionType"
        },
        "sscMode":{
            "$ref":"#/components/schemas/SscMode"
        },
        "hPlmnId":{
            "$ref":"#/components/schemas/PlmnId"
        },
        "servingNetworkFunctionID":{
            "$ref":"#/components/schemas/ServingNetworkFunctionID"
        },
        "ratType":{
            "$ref":"#/components/schemas/RatType"
        },
        "mAPDUNon3GPPRATType":{
            "$ref":"#/components/schemas/RatType"
        },
        "dnnId":{
            "$ref":"#/components/schemas/Dnn"
        },
        "dnnSelectionMode":{
            "$ref":"#/components/schemas/dnnSelectionMode"
        },
        "chargingCharacteristics":{
            "type":"string",
            "pattern":"^[0-9a-fA-F]{1,4}$"
        },
        "chargingCharacteristicsSelectionMode":{
            "$ref":"#/components/schemas/ChargingCharacteristicsSelectionMode"
        },
        "startTime":{
            "format":"date-time",
            "type":"string"
        },
        "stopTime":{
            "format":"date-time",
            "type":"string"
        },
        "3gppPSDataOffStatus":{
            "$ref":"#/components/schemas/3GPPPSDataOffStatus"
        },
        "sessionStopIndicator":{
            "type":"boolean"
        },
        "pduAddress":{
            "$ref":"#/components/schemas/PDUAddress"
        },
        "diagnostics":{
            "$ref":"#/components/schemas/Diagnostics"
        },
        "authorizedQoSInformation":{
            "$ref":"#/components/schemas/AuthorizedDefaultQos"
        },
        "subscribedQoSInformation":{
            "$ref":"#/components/schemas/SubscribedDefaultQos"
        },
        "authorizedSessionAMBR":{
            "$ref":"#/components/schemas/Ambr"
        },
        "subscribedSessionAMBR":{
            "$ref":"#/components/schemas/Ambr"
        },
        "servingCNPlmnId":{
            "$ref":"#/components/schemas/PlmnId"
        },
        "mAPDUSessionInformation":{
            "$ref":"#/components/schemas/MAPDUSessionInformation"
        }
    },
    "required":[
        "pduSessionID",
        "dnnId"
    ]
}

Nested Schema : presenceReportingAreaInformation

Type: object

Minimum Number of Properties: 0

Additional Properties Allowed

Show Source

• object PresenceInfo

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/PresenceInfo"
    },
    "minProperties":0
}

Nested Schema : RANSecondaryRATUsageReport

Type: object

Show Source

• qosFlowsUsageReports: array qosFlowsUsageReports
• rANSecondaryRATType:

{
    "type":"object",
    "properties":{
        "rANSecondaryRATType":{
            "$ref":"#/components/schemas/RatType"
        },
        "qosFlowsUsageReports":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/QosFlowsUsageReport"
            }
        }
    }
}

Nested Schema : AuthorizedDefaultQos

Type: object

Show Source

• 5qi: integer
  Minimum Value: 0

  Maximum Value: 255
• arp: object Arp
• averWindow: integer
  Minimum Value: 1

  Maximum Value: 4095

  Default Value: 2000

  The averaging window. This field can have a nullable value.
• gbrDl: string
  Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
• gbrUl: string
  Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
• maxbrDl: string
  Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
• maxbrUl: string
  Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
• maxDataBurstVol: integer
  Minimum Value: 1

  Maximum Value: 4095

  The maximum data burst volume. This field can have a nullable value.
• priorityLevel: integer
  Minimum Value: 1

  Maximum Value: 127
• qnc: boolean
  Indicates whether notifications are requested from 3GPP NG-RAN when the GFBR can no longer (or again) be guaranteed for a QoS Flow during the lifetime of the QoS Flow.

{
    "type":"object",
    "properties":{
        "5qi":{
            "$ref":"#/components/schemas/5Qi"
        },
        "arp":{
            "$ref":"#/components/schemas/Arp"
        },
        "priorityLevel":{
            "$ref":"#/components/schemas/5QiPriorityLevelRm"
        },
        "averWindow":{
            "$ref":"#/components/schemas/AverWindowRm"
        },
        "maxDataBurstVol":{
            "$ref":"#/components/schemas/MaxDataBurstVolRm"
        },
        "maxbrUl":{
            "$ref":"#/components/schemas/BitRateRm"
        },
        "maxbrDl":{
            "$ref":"#/components/schemas/BitRateRm"
        },
        "gbrUl":{
            "$ref":"#/components/schemas/BitRateRm"
        },
        "gbrDl":{
            "$ref":"#/components/schemas/BitRateRm"
        },
        "qnc":{
            "type":"boolean",
            "description":"Indicates whether notifications are requested from 3GPP NG-RAN when the GFBR can no longer (or again) be guaranteed for a QoS Flow during the lifetime of the QoS Flow."
        }
    }
}

Nested Schema : Ambr

Type: object

Show Source

• downlink(required): string
  Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
• uplink(required): string
  Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$

{
    "type":"object",
    "properties":{
        "uplink":{
            "$ref":"#/components/schemas/BitRate"
        },
        "downlink":{
            "$ref":"#/components/schemas/BitRate"
        }
    },
    "required":[
        "uplink",
        "downlink"
    ]
}

Nested Schema : MAPDUSessionInformation

Type: object

Show Source

• aTSSSCapability:
• mAPDUSessionIndicator:

{
    "type":"object",
    "properties":{
        "mAPDUSessionIndicator":{
            "$ref":"#/components/schemas/MaPduIndication"
        },
        "aTSSSCapability":{
            "$ref":"#/components/schemas/AtsssCapability"
        }
    }
}

Nested Schema : NetworkSlicingInfo

Type: object

Show Source

• sNSSAI(required): object Snssai
  The S-NSSAIs of the NF.

{
    "type":"object",
    "properties":{
        "sNSSAI":{
            "$ref":"#/components/schemas/Snssai"
        }
    },
    "required":[
        "sNSSAI"
    ]
}

Nested Schema : PDUAddress

Type: object

Show Source

• iPv4dynamicAddressFlag: boolean
• iPv6dynamicPrefixFlag: boolean
• pduAddressprefixlength: integer
• pduIPv4Address: string
  Pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$

  Example: 198.51.100.1
• pduIPv6AddresswithPrefix: string Ipv6Addr

{
    "type":"object",
    "properties":{
        "pduIPv4Address":{
            "$ref":"#/components/schemas/Ipv4Addr"
        },
        "pduIPv6AddresswithPrefix":{
            "$ref":"#/components/schemas/Ipv6Addr"
        },
        "pduAddressprefixlength":{
            "type":"integer"
        },
        "iPv4dynamicAddressFlag":{
            "type":"boolean"
        },
        "iPv6dynamicPrefixFlag":{
            "type":"boolean"
        }
    }
}

Nested Schema : SubscribedDefaultQos

Type: object

Show Source

• 5qi(required): integer
  Minimum Value: 0

  Maximum Value: 255
• arp(required): object Arp
• priorityLevel: integer
  Minimum Value: 1

  Maximum Value: 127

  An unsigned integer indicating the 5QI priority level, from range 1 through 127. Values are ordered in decreasing order of priority, with 1 as the highest priority.

{
    "type":"object",
    "required":[
        "5qi",
        "arp"
    ],
    "properties":{
        "5qi":{
            "$ref":"#/components/schemas/5Qi"
        },
        "arp":{
            "$ref":"#/components/schemas/Arp"
        },
        "priorityLevel":{
            "$ref":"#/components/schemas/5QiPriorityLevel"
        }
    }
}

Nested Schema : qosFlowsUsageReports

Type: array

Show Source

• Array of: object QosFlowsUsageReport

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/QosFlowsUsageReport"
    }
}

Nested Schema : QosFlowsUsageReport

Type: object

Show Source

• downlinkVolume: integer (int64)
  Minimum Value: 0
• endTimestamp: string (date-time)
• qFI: integer
  Minimum Value: 0

  Maximum Value: 63
• startTimestamp: string (date-time)
• uplinkVolume: integer (int64)
  Minimum Value: 0

{
    "type":"object",
    "properties":{
        "qFI":{
            "$ref":"#/components/schemas/Qfi"
        },
        "startTimestamp":{
            "format":"date-time",
            "type":"string"
        },
        "endTimestamp":{
            "$ref":"#/components/schemas/DateTime"
        },
        "uplinkVolume":{
            "$ref":"#/components/schemas/Uint64"
        },
        "downlinkVolume":{
            "$ref":"#/components/schemas/Uint64"
        }
    }
}

Nested Schema : allowedNSSAI

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object Snssai
  The S-NSSAIs of the NF.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Snssai"
    },
    "minItems":0
}

Nested Schema : rejectedNSSAI

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object Snssai
  The S-NSSAIs of the NF.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Snssai"
    },
    "minItems":0
}

Nested Schema : requestedNSSAI

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object Snssai
  The S-NSSAIs of the NF.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Snssai"
    },
    "minItems":0
}

Nested Schema : serviceAreaRestriction

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object ServiceAreaRestriction

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServiceAreaRestriction"
    },
    "minItems":0
}

Nested Schema : taiList

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object Tai

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Tai"
    },
    "minItems":0
}

Nested Schema : multipleQFIcontainer

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object MultipleQFIcontainer

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MultipleQFIcontainer"
    },
    "minItems":0
}

Nested Schema : RoamingChargingProfile

Type: object

Show Source

• partialRecordMethod: string
  Allowed Values: [ "DEFAULT", "INDIVIDUAL" ]
• triggers: array triggers
  Minimum Number of Items: 0

{
    "type":"object",
    "properties":{
        "triggers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Trigger"
            },
            "minItems":0
        },
        "partialRecordMethod":{
            "$ref":"#/components/schemas/PartialRecordMethod"
        }
    }
}

Nested Schema : MultipleQFIcontainer

Type: object

Show Source

• downlinkVolume: integer (int64)
  Minimum Value: 0
• localSequenceNumber(required): integer
• qFIContainerInformation: object QFIContainerInformation
• time: integer (int32)
  Minimum Value: 0
• totalVolume: integer (int64)
  Minimum Value: 0
• triggers: array triggers
  Minimum Number of Items: 0
• triggerTimestamp: string (date-time)
• uplinkVolume: integer (int64)
  Minimum Value: 0

{
    "type":"object",
    "properties":{
        "triggers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Trigger"
            },
            "minItems":0
        },
        "triggerTimestamp":{
            "format":"date-time",
            "type":"string"
        },
        "time":{
            "format":"int32",
            "type":"integer",
            "minimum":0
        },
        "totalVolume":{
            "$ref":"#/components/schemas/Uint64"
        },
        "uplinkVolume":{
            "$ref":"#/components/schemas/Uint64"
        },
        "downlinkVolume":{
            "$ref":"#/components/schemas/Uint64"
        },
        "localSequenceNumber":{
            "type":"integer"
        },
        "qFIContainerInformation":{
            "$ref":"#/components/schemas/QFIContainerInformation"
        }
    },
    "required":[
        "localSequenceNumber"
    ]
}

Nested Schema : QFIContainerInformation

Type: object

Show Source

• 3gppChargingId: integer (int32)
  Minimum Value: 0
• 3gppPSDataOffStatus: string
  Allowed Values: [ "ACTIVE", "INACTIVE" ]
• diagnostics: integer
• enhancedDiagnostics: array enhancedDiagnostics
• presenceReportingAreaInformation: object presenceReportingAreaInformation
  Minimum Number of Properties: 0

  Additional Properties Allowed: PresenceInfo
• qFI: integer
  Minimum Value: 0

  Maximum Value: 63
• qoSCharacteristics: object QosCharacteristics
  Contains QoS characteristics for a non-standardized or a non-configured 5QI.
• qoSInformation: object QosData
• rATType:
• reportTime(required): string (date-time)
• servingNetworkFunctionID: array servingNetworkFunctionID
  Minimum Number of Items: 0
• timeofFirstUsage: string (date-time)
• timeofLastUsage: string (date-time)
• uetimeZone: string
• userLocationInformation: object UserLocation

{
    "type":"object",
    "properties":{
        "qFI":{
            "$ref":"#/components/schemas/Qfi"
        },
        "reportTime":{
            "format":"date-time",
            "type":"string"
        },
        "timeofFirstUsage":{
            "format":"date-time",
            "type":"string"
        },
        "timeofLastUsage":{
            "format":"date-time",
            "type":"string"
        },
        "qoSInformation":{
            "$ref":"#/components/schemas/QosData"
        },
        "qoSCharacteristics":{
            "$ref":"#/components/schemas/QosCharacteristics"
        },
        "userLocationInformation":{
            "$ref":"#/components/schemas/UserLocation"
        },
        "uetimeZone":{
            "$ref":"#/components/schemas/TimeZone"
        },
        "presenceReportingAreaInformation":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/PresenceInfo"
            },
            "minProperties":0
        },
        "rATType":{
            "$ref":"#/components/schemas/RatType"
        },
        "servingNetworkFunctionID":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServingNetworkFunctionID"
            },
            "minItems":0
        },
        "3gppPSDataOffStatus":{
            "$ref":"#/components/schemas/3GPPPSDataOffStatus"
        },
        "3gppChargingId":{
            "$ref":"#/components/schemas/ChargingId"
        },
        "diagnostics":{
            "$ref":"#/components/schemas/Diagnostics"
        },
        "enhancedDiagnostics":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "reportTime"
    ]
}

Nested Schema : triggers

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object Trigger

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Trigger"
    },
    "minItems":0
}

Nested Schema : enhancedDiagnostics

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : presenceReportingAreaInformation

Type: object

Minimum Number of Properties: 0

Additional Properties Allowed

Show Source

• object PresenceInfo

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/PresenceInfo"
    },
    "minProperties":0
}

Nested Schema : servingNetworkFunctionID

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object ServingNetworkFunctionID

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServingNetworkFunctionID"
    },
    "minItems":0
}

Nested Schema : triggers

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object Trigger

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Trigger"
    },
    "minItems":0
}

Nested Schema : MessageClass

Type: object

Show Source

• classIdentifier: string
  Allowed Values: [ "PERSONAL", "ADVERTISEMENT", "INFORMATIONAL", "AUTO" ]
• tokenText: string

{
    "type":"object",
    "properties":{
        "classIdentifier":{
            "$ref":"#/components/schemas/ClassIdentifier"
        },
        "tokenText":{
            "type":"string"
        }
    }
}

Nested Schema : OriginatorInfo

Type: object

Show Source

• originatorGPSI: string
  Pattern: ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$
• originatorOtherAddress: object SMAddressInfo
• originatorReceivedAddress: object SMAddressInfo
• originatorSCCPAddress: string
• originatorSUPI: string
  Pattern: ^(imsi-[0-9]{5,15}|nai-.+|.+)$
• sMOriginatorInterface: object SMInterface
• sMOriginatorProtocolId: string

{
    "type":"object",
    "properties":{
        "originatorSUPI":{
            "type":"string",
            "pattern":"^(imsi-[0-9]{5,15}|nai-.+|.+)$"
        },
        "originatorGPSI":{
            "$ref":"#/components/schemas/Gpsi"
        },
        "originatorOtherAddress":{
            "$ref":"#/components/schemas/SMAddressInfo"
        },
        "originatorReceivedAddress":{
            "$ref":"#/components/schemas/SMAddressInfo"
        },
        "originatorSCCPAddress":{
            "type":"string"
        },
        "sMOriginatorInterface":{
            "$ref":"#/components/schemas/SMInterface"
        },
        "sMOriginatorProtocolId":{
            "type":"string"
        }
    }
}

Nested Schema : recipientInfo

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object RecipientInfo

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RecipientInfo"
    },
    "minItems":0
}

Nested Schema : SMAddressInfo

Type: object

Show Source

• sMaddressData: string
• sMaddressDomain: object SMAddressDomain
• sMaddressType: string
  Allowed Values: [ "EMAIL_ADDRESS", "MSISDN", "IPV4_ADDRESS", "IPV6_ADDRESS", "NUMERIC_SHORTCODE", "ALPHANUMERIC_SHORTCODE", "OTHER", "IMSI" ]

{
    "type":"object",
    "properties":{
        "sMaddressType":{
            "$ref":"#/components/schemas/SMAddressType"
        },
        "sMaddressData":{
            "type":"string"
        },
        "sMaddressDomain":{
            "$ref":"#/components/schemas/SMAddressDomain"
        }
    }
}

Nested Schema : SMInterface

Type: object

Show Source

• interfaceId: string
• interfacePort: string
• interfaceText: string
• interfaceType: string
  Allowed Values: [ "UNKNOWN", "MOBILE_ORIGINATING", "MOBILE_TERMINATING", "APPLICATION_ORIGINATING", "APPLICATION_TERMINATING" ]

{
    "type":"object",
    "properties":{
        "interfaceId":{
            "type":"string"
        },
        "interfaceText":{
            "type":"string"
        },
        "interfacePort":{
            "type":"string"
        },
        "interfaceType":{
            "$ref":"#/components/schemas/InterfaceType"
        }
    }
}

Nested Schema : SMAddressDomain

Type: object

Show Source

• 3GPPIMSIMCCMNC: string
• domainName: string

{
    "type":"object",
    "properties":{
        "domainName":{
            "type":"string"
        },
        "3GPPIMSIMCCMNC":{
            "type":"string"
        }
    }
}

Nested Schema : RecipientInfo

Type: object

Show Source

• recipientGPSI: string
  Pattern: ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$
• recipientOtherAddress: object SMAddressInfo
• recipientReceivedAddress: object SMAddressInfo
• recipientSCCPAddress: string
• recipientSUPI: string
  Pattern: ^(imsi-[0-9]{5,15}|nai-.+|.+)$
• sMDestinationInterface: object SMInterface
• sMrecipientProtocolId: string

{
    "type":"object",
    "properties":{
        "recipientSUPI":{
            "type":"string",
            "pattern":"^(imsi-[0-9]{5,15}|nai-.+|.+)$"
        },
        "recipientGPSI":{
            "$ref":"#/components/schemas/Gpsi"
        },
        "recipientOtherAddress":{
            "$ref":"#/components/schemas/SMAddressInfo"
        },
        "recipientReceivedAddress":{
            "$ref":"#/components/schemas/SMAddressInfo"
        },
        "recipientSCCPAddress":{
            "type":"string"
        },
        "sMDestinationInterface":{
            "$ref":"#/components/schemas/SMInterface"
        },
        "sMrecipientProtocolId":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/problem+json

200 Response

The converged charging session was updated successfully.

Body ()

Root Schema : ChargingDataResponse

Type: object

Details about the charging data service that was created.

Show Source

• invocationResult: object InvocationResult
  The result.
• invocationSequenceNumber(required): integer (int32)
  Minimum Value: 0

  The sequence number of the charging service invocation by the NF consumer.
• invocationTimeStamp(required): string (date-time)
  The timestamp of the charging service response from the CHF.
• multipleUnitInformation: array multipleUnitInformation
  Minimum Number of Items: 0

  The parameters for quota management or usage reporting. It may have multiple occurrences.
• pDUSessionChargingInformation: object PDUSessionChargingInformation
  The 5G data connectivity-specific information.
• roamingQBCInformation: object RoamingQBCInformation
  The 5G data connectivity-specific information for roaming QBC.
• sessionFailover: string
  Allowed Values: [ "FAILOVER_NOT_SUPPORTED", "FAILOVER_SUPPORTED" ]

  Whether an alternative CHF is supported for ongoing charging service failover handling by the NF consumer.
• supportedFeatures: string
  Pattern: ^[A-Fa-f0-9]*$

  The list of supported features.
• triggers: array triggers
  Minimum Number of Items: 0

  The triggers for usage reporting associated to the rating group, which is supplied from the CHF.

  The presence of the triggers attribute without a triggerType is used by CHF to disable all triggers to the associated rating group.

{
    "description":"Details about the charging data service that was created.",
    "type":"object",
    "properties":{
        "invocationTimeStamp":{
            "description":"The timestamp of the charging service response from the CHF.",
            "format":"date-time",
            "type":"string"
        },
        "invocationSequenceNumber":{
            "description":"The sequence number of the charging service invocation by the NF consumer.",
            "format":"int32",
            "type":"integer",
            "minimum":0
        },
        "invocationResult":{
            "description":"The result of charging service invocation by the NF consumer.",
            "$ref":"#/components/schemas/InvocationResult"
        },
        "sessionFailover":{
            "description":"Whether an alternative CHF is supported for ongoing charging service failover handling by NF consumer.",
            "$ref":"#/components/schemas/SessionFailover"
        },
        "supportedFeatures":{
            "description":"This list of supported features.",
            "$ref":"#/components/schemas/SupportedFeatures"
        },
        "multipleUnitInformation":{
            "description":"The parameters for quota management or usage reporting. It may have multiple occurrences.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MultipleUnitInformation"
            },
            "minItems":0
        },
        "triggers":{
            "description":"The triggers for usage reporting associated to the rating group, which is supplied from the CHF. <p>The presence of the triggers attribute without a <b>triggerType</b> is used by CHF to disable all triggers to the associated rating group.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Trigger"
            },
            "minItems":0
        },
        "pDUSessionChargingInformation":{
            "$ref":"#/components/schemas/PDUSessionChargingInformation"
        },
        "roamingQBCInformation":{
            "$ref":"#/components/schemas/RoamingQBCInformation"
        }
    },
    "required":[
        "invocationTimeStamp",
        "invocationSequenceNumber"
    ]
}

Nested Schema : InvocationResult

Type: object

The result.

Show Source

• error: object ProblemDetails
  Information about an error.
• failureHandling: string
  Allowed Values: [ "TERMINATE", "CONTINUE", "RETRY_AND_TERMINATE" ]

  Failure handling.

{
    "type":"object",
    "description":"The result.",
    "properties":{
        "error":{
            "$ref":"#/components/schemas/ProblemDetails"
        },
        "failureHandling":{
            "$ref":"#/components/schemas/FailureHandling"
        }
    }
}

Nested Schema : multipleUnitInformation

Type: array

Minimum Number of Items: 0

The parameters for quota management or usage reporting. It may have multiple occurrences.

Show Source

• Array of: object MultipleUnitInformation

{
    "description":"The parameters for quota management or usage reporting. It may have multiple occurrences.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MultipleUnitInformation"
    },
    "minItems":0
}

Nested Schema : PDUSessionChargingInformation

Type: object

The 5G data connectivity-specific information.

Show Source

• chargingId: integer (int32)
  Minimum Value: 0
• homeProvidedChargingId: integer (int32)
  Minimum Value: 0
• mAPDUNon3GPPUserLocationInfo: object UserLocation
• pduSessionInformation: object PDUSessionInformation
• presenceReportingAreaInformation: object presenceReportingAreaInformation
  Minimum Number of Properties: 0

  Additional Properties Allowed: PresenceInfo
• rANSecondaryRATUsageReport: object RANSecondaryRATUsageReport
• uetimeZone: string
• unitCountInactivityTimer: integer
• userInformation: object UserInformation
• userLocationinfo: object UserLocation

{
    "description":"The 5G data connectivity-specific information.",
    "type":"object",
    "properties":{
        "chargingId":{
            "$ref":"#/components/schemas/ChargingId"
        },
        "homeProvidedChargingId":{
            "$ref":"#/components/schemas/ChargingId"
        },
        "userInformation":{
            "$ref":"#/components/schemas/UserInformation"
        },
        "userLocationinfo":{
            "$ref":"#/components/schemas/UserLocation"
        },
        "mAPDUNon3GPPUserLocationInfo":{
            "$ref":"#/components/schemas/UserLocation"
        },
        "presenceReportingAreaInformation":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/PresenceInfo"
            },
            "minProperties":0
        },
        "uetimeZone":{
            "$ref":"#/components/schemas/TimeZone"
        },
        "pduSessionInformation":{
            "$ref":"#/components/schemas/PDUSessionInformation"
        },
        "unitCountInactivityTimer":{
            "$ref":"#/components/schemas/DurationSec"
        },
        "rANSecondaryRATUsageReport":{
            "$ref":"#/components/schemas/RANSecondaryRATUsageReport"
        }
    }
}

Nested Schema : RoamingQBCInformation

Type: object

The 5G data connectivity-specific information for roaming QBC.

Show Source

• multipleQFIcontainer: array multipleQFIcontainer
  Minimum Number of Items: 0
• roamingChargingProfile: object RoamingChargingProfile
• uPFID: string (uuid)

{
    "type":"object",
    "description":"The 5G data connectivity-specific information for roaming QBC.",
    "properties":{
        "multipleQFIcontainer":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MultipleQFIcontainer"
            },
            "minItems":0
        },
        "uPFID":{
            "$ref":"#/components/schemas/NfInstanceId"
        },
        "roamingChargingProfile":{
            "$ref":"#/components/schemas/RoamingChargingProfile"
        }
    }
}

Nested Schema : triggers

Type: array

Minimum Number of Items: 0

The triggers for usage reporting associated to the rating group, which is supplied from the CHF.

The presence of the triggers attribute without a triggerType is used by CHF to disable all triggers to the associated rating group.

Show Source

• Array of: object Trigger

{
    "description":"The triggers for usage reporting associated to the rating group, which is supplied from the CHF. <p>The presence of the triggers attribute without a <b>triggerType</b> is used by CHF to disable all triggers to the associated rating group.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Trigger"
    },
    "minItems":0
}

Nested Schema : ProblemDetails

Type: object

Information about an error.

Show Source

• cause: string
  The reason for the failure.
• detail: string
  Details about the error.
• instance: string
  The instance.
• invalidParams: array invalidParams
  Minimum Number of Items: 1

  A list of invalid parameters.
• status: integer
  The status code.
• supportedFeatures: string
  Pattern: ^[A-Fa-f0-9]*$

  The list of supported features.
• title: string
  The problem's title.
• type: string
  The type of problem.

{
    "description":"Information about an error.",
    "type":"object",
    "properties":{
        "type":{
            "description":"The type of problem.",
            "type":"string"
        },
        "title":{
            "description":"The problem's title.",
            "type":"string"
        },
        "status":{
            "description":"The status code.",
            "type":"integer"
        },
        "detail":{
            "description":"Details about the error.",
            "type":"string"
        },
        "instance":{
            "type":"string",
            "description":"The instance."
        },
        "cause":{
            "description":"The reason for the failure.",
            "type":"string"
        },
        "invalidParams":{
            "type":"array",
            "description":"A list of invalid parameters.",
            "items":{
                "$ref":"#/components/schemas/InvalidParam"
            },
            "minItems":1
        },
        "supportedFeatures":{
            "$ref":"#/components/schemas/SupportedFeatures"
        }
    }
}

Nested Schema : invalidParams

Type: array

Minimum Number of Items: 1

A list of invalid parameters.

Show Source

• Array of: object InvalidParam
  An invalid parameter.

{
    "type":"array",
    "description":"A list of invalid parameters.",
    "items":{
        "$ref":"#/components/schemas/InvalidParam"
    },
    "minItems":1
}

Nested Schema : InvalidParam

Type: object

An invalid parameter.

Show Source

• param(required): string
  The name of the parameter.
• reason: string
  The reason why the parameter didn't pass validation.

{
    "type":"object",
    "description":"An invalid parameter.",
    "properties":{
        "param":{
            "type":"string",
            "description":"The name of the parameter."
        },
        "reason":{
            "type":"string",
            "description":"The reason why the parameter didn't pass validation."
        }
    },
    "required":[
        "param"
    ]
}

Nested Schema : MultipleUnitInformation

Type: object

Show Source

• finalUnitIndication: object FinalUnitIndication
• grantedUnit: object GrantedUnit
• quotaHoldingTime: integer
• ratingGroup(required): integer (int32)
  Minimum Value: 0

  The ID of the rating group.
• resultCode: string
  Allowed Values: [ "SUCCESS", "END_USER_SERVICE_DENIED", "QUOTA_MANAGEMENT_NOT_APPLICABLE", "QUOTA_LIMIT_REACHED", "END_USER_SERVICE_REJECTED", "USER_UNKNOWN", "RATING_FAILED", "QUOTA_MANAGEMENT" ]
• timeQuotaThreshold: integer
• triggers: array triggers
  Minimum Number of Items: 0
• unitQuotaThreshold: integer
• uPFID: string (uuid)
• validityTime: integer
• volumeQuotaThreshold: integer (int64)
  Minimum Value: 0

{
    "type":"object",
    "properties":{
        "resultCode":{
            "$ref":"#/components/schemas/ResultCode"
        },
        "ratingGroup":{
            "$ref":"#/components/schemas/RatingGroup"
        },
        "grantedUnit":{
            "$ref":"#/components/schemas/GrantedUnit"
        },
        "triggers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Trigger"
            },
            "minItems":0
        },
        "validityTime":{
            "$ref":"#/components/schemas/DurationSec"
        },
        "quotaHoldingTime":{
            "$ref":"#/components/schemas/DurationSec"
        },
        "finalUnitIndication":{
            "$ref":"#/components/schemas/FinalUnitIndication"
        },
        "timeQuotaThreshold":{
            "type":"integer"
        },
        "volumeQuotaThreshold":{
            "$ref":"#/components/schemas/Uint64"
        },
        "unitQuotaThreshold":{
            "type":"integer"
        },
        "uPFID":{
            "$ref":"#/components/schemas/NfInstanceId"
        }
    },
    "required":[
        "ratingGroup"
    ]
}

Nested Schema : FinalUnitIndication

Type: object

Show Source

• filterId: string
• finalUnitAction(required): string
  Allowed Values: [ "TERMINATE", "REDIRECT", "RESTRICT_ACCESS" ]
• redirectServer: object RedirectServer
• restrictionFilterRule: string

{
    "type":"object",
    "properties":{
        "finalUnitAction":{
            "$ref":"#/components/schemas/FinalUnitAction"
        },
        "restrictionFilterRule":{
            "$ref":"#/components/schemas/IPFilterRule"
        },
        "filterId":{
            "type":"string"
        },
        "redirectServer":{
            "$ref":"#/components/schemas/RedirectServer"
        }
    },
    "required":[
        "finalUnitAction"
    ]
}

Nested Schema : GrantedUnit

Type: object

Show Source

• downlinkVolume: integer (int64)
  Minimum Value: 0
• serviceSpecificUnits: integer (int64)
  Minimum Value: 0
• tariffTimeChange: string (date-time)
• time: integer (int32)
  Minimum Value: 0
• totalVolume: integer (int64)
  Minimum Value: 0
• uplinkVolume: integer (int64)
  Minimum Value: 0

{
    "type":"object",
    "properties":{
        "tariffTimeChange":{
            "format":"date-time",
            "type":"string"
        },
        "time":{
            "format":"int32",
            "type":"integer",
            "minimum":0
        },
        "totalVolume":{
            "$ref":"#/components/schemas/Uint64"
        },
        "uplinkVolume":{
            "$ref":"#/components/schemas/Uint64"
        },
        "downlinkVolume":{
            "$ref":"#/components/schemas/Uint64"
        },
        "serviceSpecificUnits":{
            "$ref":"#/components/schemas/Uint64"
        }
    }
}

Nested Schema : triggers

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object Trigger

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Trigger"
    },
    "minItems":0
}

Nested Schema : RedirectServer

Type: object

Show Source

• redirectAddressType(required): string
  Allowed Values: [ "IPV4", "IPV6", "URL" ]
• redirectServerAddress(required): string

{
    "type":"object",
    "properties":{
        "redirectAddressType":{
            "$ref":"#/components/schemas/RedirectAddressType"
        },
        "redirectServerAddress":{
            "type":"string"
        }
    },
    "required":[
        "redirectAddressType",
        "redirectServerAddress"
    ]
}

Nested Schema : Trigger

Type: object

Show Source

• maxNumberOfccc: integer (int32)
  Minimum Value: 0
• timeLimit: integer
• triggerCategory(required): string
  Allowed Values: [ "IMMEDIATE_REPORT", "DEFERRED_REPORT" ]
• triggerType(required): string
  Allowed Values: [ "QUOTA_THRESHOLD", "QHT", "FINAL", "QUOTA_EXHAUSTED", "VALIDITY_TIME", "OTHER_QUOTA_TYPE", "FORCED_REAUTHORISATION", "UNUSED_QUOTA_TIMER", "UNIT_COUNT_INACTIVITY_TIMER", "ABNORMAL_RELEASE", "QOS_CHANGE", "VOLUME_LIMIT", "TIME_LIMIT", "EVENT_LIMIT", "PLMN_CHANGE", "USER_LOCATION_CHANGE", "RAT_CHANGE", "SESSION_AMBR_CHANGE", "UE_TIMEZONE_CHANGE", "TARIFF_TIME_CHANGE", "MAX_NUMBER_OF_CHANGES_IN_CHARGING_CONDITIONS", "MANAGEMENT_INTERVENTION", "CHANGE_OF_UE_PRESENCE_IN_PRESENCE_REPORTING_AREA", "CHANGE_OF_3GPP_PS_DATA_OFF_STATUS", "SERVING_NODE_CHANGE", "REMOVAL_OF_UPF", "ADDITION_OF_UPF", "INSERTION_OF_ISMF", "REMOVAL_OF_ISMF", "CHANGE_OF_ISMF", "START_OF_SERVICE_DATA_FLOW", "ECGI_CHANGE", "TAI_CHANGE", "HANDOVER_CANCEL", "HANDOVER_START", "HANDOVER_COMPLETE", "GFBR_GUARANTEED_STATUS_CHANGE", "ADDITION_OF_ACCESS", "REMOVAL_OF_ACCESS", "START_OF_SDF_ADDITIONAL_ACCESS" ]
• volumeLimit: integer (int32)
  Minimum Value: 0
• volumeLimit64: integer (int64)
  Minimum Value: 0

{
    "type":"object",
    "properties":{
        "triggerType":{
            "$ref":"#/components/schemas/TriggerType"
        },
        "triggerCategory":{
            "$ref":"#/components/schemas/TriggerCategory"
        },
        "timeLimit":{
            "$ref":"#/components/schemas/DurationSec"
        },
        "volumeLimit":{
            "format":"int32",
            "type":"integer",
            "minimum":0
        },
        "volumeLimit64":{
            "$ref":"#/components/schemas/Uint64"
        },
        "maxNumberOfccc":{
            "format":"int32",
            "type":"integer",
            "minimum":0
        }
    },
    "required":[
        "triggerType",
        "triggerCategory"
    ]
}

Nested Schema : UserLocation

Type: object

Show Source

• eutraLocation: object EutraLocation
• n3gaLocation: object N3gaLocation
• nrLocation: object NrLocation

{
    "type":"object",
    "properties":{
        "eutraLocation":{
            "$ref":"#/components/schemas/EutraLocation"
        },
        "nrLocation":{
            "$ref":"#/components/schemas/NrLocation"
        },
        "n3gaLocation":{
            "$ref":"#/components/schemas/N3gaLocation"
        }
    }
}

Nested Schema : PDUSessionInformation

Type: object

Show Source

• 3gppPSDataOffStatus: string
  Allowed Values: [ "ACTIVE", "INACTIVE" ]
• authorizedQoSInformation: object AuthorizedDefaultQos
• authorizedSessionAMBR: object Ambr
• chargingCharacteristics: string
  Pattern: ^[0-9a-fA-F]{1,4}$
• chargingCharacteristicsSelectionMode: string
  Allowed Values: [ "HOME_DEFAULT", "ROAMING_DEFAULT", "VISITING_DEFAULT" ]
• diagnostics: integer
• dnnId(required): string
• dnnSelectionMode: string
  Allowed Values: [ "VERIFIED", "UE_DNN_NOT_VERIFIED", "NW_DNN_NOT_VERIFIED" ]
• hPlmnId: object PlmnId
• mAPDUNon3GPPRATType:
• mAPDUSessionInformation: object MAPDUSessionInformation
• networkSlicingInfo: object NetworkSlicingInfo
• pduAddress: object PDUAddress
• pduSessionID(required): integer
  Minimum Value: 0

  Maximum Value: 255
• pduType:
• ratType:
• servingCNPlmnId: object PlmnId
• servingNetworkFunctionID: object ServingNetworkFunctionID
• sessionStopIndicator: boolean
• sscMode:
• startTime: string (date-time)
• stopTime: string (date-time)
• subscribedQoSInformation: object SubscribedDefaultQos
• subscribedSessionAMBR: object Ambr

{
    "type":"object",
    "properties":{
        "networkSlicingInfo":{
            "$ref":"#/components/schemas/NetworkSlicingInfo"
        },
        "pduSessionID":{
            "$ref":"#/components/schemas/PduSessionId"
        },
        "pduType":{
            "$ref":"#/components/schemas/PduSessionType"
        },
        "sscMode":{
            "$ref":"#/components/schemas/SscMode"
        },
        "hPlmnId":{
            "$ref":"#/components/schemas/PlmnId"
        },
        "servingNetworkFunctionID":{
            "$ref":"#/components/schemas/ServingNetworkFunctionID"
        },
        "ratType":{
            "$ref":"#/components/schemas/RatType"
        },
        "mAPDUNon3GPPRATType":{
            "$ref":"#/components/schemas/RatType"
        },
        "dnnId":{
            "$ref":"#/components/schemas/Dnn"
        },
        "dnnSelectionMode":{
            "$ref":"#/components/schemas/dnnSelectionMode"
        },
        "chargingCharacteristics":{
            "type":"string",
            "pattern":"^[0-9a-fA-F]{1,4}$"
        },
        "chargingCharacteristicsSelectionMode":{
            "$ref":"#/components/schemas/ChargingCharacteristicsSelectionMode"
        },
        "startTime":{
            "format":"date-time",
            "type":"string"
        },
        "stopTime":{
            "format":"date-time",
            "type":"string"
        },
        "3gppPSDataOffStatus":{
            "$ref":"#/components/schemas/3GPPPSDataOffStatus"
        },
        "sessionStopIndicator":{
            "type":"boolean"
        },
        "pduAddress":{
            "$ref":"#/components/schemas/PDUAddress"
        },
        "diagnostics":{
            "$ref":"#/components/schemas/Diagnostics"
        },
        "authorizedQoSInformation":{
            "$ref":"#/components/schemas/AuthorizedDefaultQos"
        },
        "subscribedQoSInformation":{
            "$ref":"#/components/schemas/SubscribedDefaultQos"
        },
        "authorizedSessionAMBR":{
            "$ref":"#/components/schemas/Ambr"
        },
        "subscribedSessionAMBR":{
            "$ref":"#/components/schemas/Ambr"
        },
        "servingCNPlmnId":{
            "$ref":"#/components/schemas/PlmnId"
        },
        "mAPDUSessionInformation":{
            "$ref":"#/components/schemas/MAPDUSessionInformation"
        }
    },
    "required":[
        "pduSessionID",
        "dnnId"
    ]
}

Nested Schema : presenceReportingAreaInformation

Type: object

Minimum Number of Properties: 0

Additional Properties Allowed

Show Source

• object PresenceInfo

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/PresenceInfo"
    },
    "minProperties":0
}

Nested Schema : RANSecondaryRATUsageReport

Type: object

Show Source

• qosFlowsUsageReports: array qosFlowsUsageReports
• rANSecondaryRATType:

{
    "type":"object",
    "properties":{
        "rANSecondaryRATType":{
            "$ref":"#/components/schemas/RatType"
        },
        "qosFlowsUsageReports":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/QosFlowsUsageReport"
            }
        }
    }
}

Nested Schema : UserInformation

Type: object

Show Source

• roamerInOut: string
  Allowed Values: [ "IN_BOUND", "OUT_BOUND" ]
• servedGPSI: string
  Pattern: ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$
• servedPEI: string
  Pattern: ^(imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$
• unauthenticatedFlag: boolean

{
    "type":"object",
    "properties":{
        "servedGPSI":{
            "$ref":"#/components/schemas/Gpsi"
        },
        "servedPEI":{
            "$ref":"#/components/schemas/Pei"
        },
        "unauthenticatedFlag":{
            "type":"boolean"
        },
        "roamerInOut":{
            "$ref":"#/components/schemas/RoamerInOut"
        }
    }
}

Nested Schema : EutraLocation

Type: object

Show Source

• ageOfLocationInformation: integer
  Minimum Value: 0

  Maximum Value: 32767
• ecgi(required): object Ecgi
• geodeticInformation: string
  Pattern: ^[0-9A-F]{20}$
• geographicalInformation: string
  Pattern: ^[0-9A-F]{16}$
• globalNgenbId: object GlobalRanNodeId
• tai(required): object Tai
• ueLocationTimestamp: string (date-time)

{
    "type":"object",
    "properties":{
        "tai":{
            "$ref":"#/components/schemas/Tai"
        },
        "ecgi":{
            "$ref":"#/components/schemas/Ecgi"
        },
        "ageOfLocationInformation":{
            "type":"integer",
            "minimum":0,
            "maximum":32767
        },
        "ueLocationTimestamp":{
            "format":"date-time",
            "type":"string"
        },
        "geographicalInformation":{
            "type":"string",
            "pattern":"^[0-9A-F]{16}$"
        },
        "geodeticInformation":{
            "type":"string",
            "pattern":"^[0-9A-F]{20}$"
        },
        "globalNgenbId":{
            "$ref":"#/components/schemas/GlobalRanNodeId"
        }
    },
    "required":[
        "tai",
        "ecgi"
    ]
}

Nested Schema : N3gaLocation

Type: object

Show Source

• n3gppTai: object Tai
• n3IwfId: string
  Pattern: ^[A-Fa-f0-9]+$
• portNumber: integer
  Minimum Value: 0
• ueIpv4Addr: string
  Pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$

  Example: 198.51.100.1
• ueIpv6Addr: string Ipv6Addr

{
    "type":"object",
    "properties":{
        "n3gppTai":{
            "$ref":"#/components/schemas/Tai"
        },
        "n3IwfId":{
            "type":"string",
            "pattern":"^[A-Fa-f0-9]+$"
        },
        "ueIpv4Addr":{
            "$ref":"#/components/schemas/Ipv4Addr"
        },
        "ueIpv6Addr":{
            "$ref":"#/components/schemas/Ipv6Addr"
        },
        "portNumber":{
            "$ref":"#/components/schemas/Uinteger"
        }
    }
}

Nested Schema : NrLocation

Type: object

Show Source

• ageOfLocationInformation: integer
  Minimum Value: 0

  Maximum Value: 32767
• geodeticInformation: string
  Pattern: ^[0-9A-F]{20}$
• geographicalInformation: string
  Pattern: ^[0-9A-F]{16}$
• globalGnbId: object GlobalRanNodeId
• ncgi(required): object Ncgi
• tai(required): object Tai
• ueLocationTimestamp: string (date-time)

{
    "type":"object",
    "properties":{
        "tai":{
            "$ref":"#/components/schemas/Tai"
        },
        "ncgi":{
            "$ref":"#/components/schemas/Ncgi"
        },
        "ageOfLocationInformation":{
            "type":"integer",
            "minimum":0,
            "maximum":32767
        },
        "ueLocationTimestamp":{
            "format":"date-time",
            "type":"string"
        },
        "geographicalInformation":{
            "type":"string",
            "pattern":"^[0-9A-F]{16}$"
        },
        "geodeticInformation":{
            "type":"string",
            "pattern":"^[0-9A-F]{20}$"
        },
        "globalGnbId":{
            "$ref":"#/components/schemas/GlobalRanNodeId"
        }
    },
    "required":[
        "tai",
        "ncgi"
    ]
}

Nested Schema : Ecgi

Type: object

Show Source

• eutraCellId(required): string
  Pattern: ^[A-Fa-f0-9]{7}$
• plmnId(required): object PlmnId

{
    "type":"object",
    "properties":{
        "plmnId":{
            "$ref":"#/components/schemas/PlmnId"
        },
        "eutraCellId":{
            "$ref":"#/components/schemas/EutraCellId"
        }
    },
    "required":[
        "plmnId",
        "eutraCellId"
    ]
}

Nested Schema : GlobalRanNodeId

Type: object

Show Source

• gNbId: object GNbId
• n3IwfId: string
  Pattern: ^[A-Fa-f0-9]+$
• ngeNbId: string
  Pattern: ^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]{6}|SMacroNGeNB-[A-Fa-f0-9]{5})$
• plmnId(required): object PlmnId

{
    "type":"object",
    "properties":{
        "plmnId":{
            "$ref":"#/components/schemas/PlmnId"
        },
        "n3IwfId":{
            "$ref":"#/components/schemas/N3IwfId"
        },
        "gNbId":{
            "$ref":"#/components/schemas/GNbId"
        },
        "ngeNbId":{
            "$ref":"#/components/schemas/NgeNbId"
        }
    },
    "oneOf":[
        {
            "required":[
                "n3IwfId"
            ]
        },
        {
            "required":[
                "gNbId"
            ]
        },
        {
            "required":[
                "ngeNbId"
            ]
        }
    ],
    "required":[
        "plmnId"
    ]
}

Match One Schema

Show Source

{
    "type":"object",
    "properties":{
        "plmnId":{
            "$ref":"#/components/schemas/PlmnId"
        },
        "n3IwfId":{
            "$ref":"#/components/schemas/N3IwfId"
        },
        "gNbId":{
            "$ref":"#/components/schemas/GNbId"
        },
        "ngeNbId":{
            "$ref":"#/components/schemas/NgeNbId"
        }
    },
    "oneOf":[
        {
            "required":[
                "n3IwfId"
            ]
        },
        {
            "required":[
                "gNbId"
            ]
        },
        {
            "required":[
                "ngeNbId"
            ]
        }
    ],
    "required":[
        "plmnId"
    ]
}

Nested Schema : Tai

Type: object

Show Source

• plmnId(required): object PlmnId
• tac(required): string
  Pattern: (^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)

{
    "type":"object",
    "properties":{
        "plmnId":{
            "$ref":"#/components/schemas/PlmnId"
        },
        "tac":{
            "$ref":"#/components/schemas/Tac"
        }
    },
    "required":[
        "plmnId",
        "tac"
    ]
}

Nested Schema : PlmnId

Type: object

Show Source

• mcc(required): string
  Pattern: ^\d{3}$
• mnc(required): string
  Pattern: ^\d{2,3}$

{
    "type":"object",
    "properties":{
        "mcc":{
            "$ref":"#/components/schemas/Mcc"
        },
        "mnc":{
            "$ref":"#/components/schemas/Mnc"
        }
    },
    "required":[
        "mcc",
        "mnc"
    ]
}

Nested Schema : GNbId

Type: object

Show Source

• bitLength(required): integer
  Minimum Value: 22

  Maximum Value: 32
• gNBValue(required): string
  Pattern: ^[A-Fa-f0-9]{6,8}$

{
    "type":"object",
    "properties":{
        "bitLength":{
            "type":"integer",
            "minimum":22,
            "maximum":32
        },
        "gNBValue":{
            "type":"string",
            "pattern":"^[A-Fa-f0-9]{6,8}$"
        }
    },
    "required":[
        "bitLength",
        "gNBValue"
    ]
}

Nested Schema : Ipv6Addr

Match All

Show Source

• Pattern: ^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$
• Pattern: ^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$

{
    "type":"string",
    "allOf":[
        {
            "pattern":"^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$"
        },
        {
            "pattern":"^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$"
        }
    ],
    "example":"2001:db8:85a3::8a2e:370:7334"
}

Example:

2001:db8:85a3::8a2e:370:7334

Nested Schema : Ncgi

Type: object

Show Source

• nrCellId(required): string
  Pattern: ^[A-Fa-f0-9]{9}$
• plmnId(required): object PlmnId

{
    "type":"object",
    "properties":{
        "plmnId":{
            "$ref":"#/components/schemas/PlmnId"
        },
        "nrCellId":{
            "$ref":"#/components/schemas/NrCellId"
        }
    },
    "required":[
        "plmnId",
        "nrCellId"
    ]
}

Nested Schema : AuthorizedDefaultQos

Type: object

Show Source

• 5qi: integer
  Minimum Value: 0

  Maximum Value: 255
• arp: object Arp
• averWindow: integer
  Minimum Value: 1

  Maximum Value: 4095

  Default Value: 2000

  The averaging window. This field can have a nullable value.
• gbrDl: string
  Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
• gbrUl: string
  Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
• maxbrDl: string
  Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
• maxbrUl: string
  Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
• maxDataBurstVol: integer
  Minimum Value: 1

  Maximum Value: 4095

  The maximum data burst volume. This field can have a nullable value.
• priorityLevel: integer
  Minimum Value: 1

  Maximum Value: 127
• qnc: boolean
  Indicates whether notifications are requested from 3GPP NG-RAN when the GFBR can no longer (or again) be guaranteed for a QoS Flow during the lifetime of the QoS Flow.

{
    "type":"object",
    "properties":{
        "5qi":{
            "$ref":"#/components/schemas/5Qi"
        },
        "arp":{
            "$ref":"#/components/schemas/Arp"
        },
        "priorityLevel":{
            "$ref":"#/components/schemas/5QiPriorityLevelRm"
        },
        "averWindow":{
            "$ref":"#/components/schemas/AverWindowRm"
        },
        "maxDataBurstVol":{
            "$ref":"#/components/schemas/MaxDataBurstVolRm"
        },
        "maxbrUl":{
            "$ref":"#/components/schemas/BitRateRm"
        },
        "maxbrDl":{
            "$ref":"#/components/schemas/BitRateRm"
        },
        "gbrUl":{
            "$ref":"#/components/schemas/BitRateRm"
        },
        "gbrDl":{
            "$ref":"#/components/schemas/BitRateRm"
        },
        "qnc":{
            "type":"boolean",
            "description":"Indicates whether notifications are requested from 3GPP NG-RAN when the GFBR can no longer (or again) be guaranteed for a QoS Flow during the lifetime of the QoS Flow."
        }
    }
}

Nested Schema : Ambr

Type: object

Show Source

• downlink(required): string
  Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
• uplink(required): string
  Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$

{
    "type":"object",
    "properties":{
        "uplink":{
            "$ref":"#/components/schemas/BitRate"
        },
        "downlink":{
            "$ref":"#/components/schemas/BitRate"
        }
    },
    "required":[
        "uplink",
        "downlink"
    ]
}

Nested Schema : MAPDUSessionInformation

Type: object

Show Source

• aTSSSCapability:
• mAPDUSessionIndicator:

{
    "type":"object",
    "properties":{
        "mAPDUSessionIndicator":{
            "$ref":"#/components/schemas/MaPduIndication"
        },
        "aTSSSCapability":{
            "$ref":"#/components/schemas/AtsssCapability"
        }
    }
}

Nested Schema : NetworkSlicingInfo

Type: object

Show Source

• sNSSAI(required): object Snssai
  The S-NSSAIs of the NF.

{
    "type":"object",
    "properties":{
        "sNSSAI":{
            "$ref":"#/components/schemas/Snssai"
        }
    },
    "required":[
        "sNSSAI"
    ]
}

Nested Schema : PDUAddress

Type: object

Show Source

• iPv4dynamicAddressFlag: boolean
• iPv6dynamicPrefixFlag: boolean
• pduAddressprefixlength: integer
• pduIPv4Address: string
  Pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$

  Example: 198.51.100.1
• pduIPv6AddresswithPrefix: string Ipv6Addr

{
    "type":"object",
    "properties":{
        "pduIPv4Address":{
            "$ref":"#/components/schemas/Ipv4Addr"
        },
        "pduIPv6AddresswithPrefix":{
            "$ref":"#/components/schemas/Ipv6Addr"
        },
        "pduAddressprefixlength":{
            "type":"integer"
        },
        "iPv4dynamicAddressFlag":{
            "type":"boolean"
        },
        "iPv6dynamicPrefixFlag":{
            "type":"boolean"
        }
    }
}

Nested Schema : ServingNetworkFunctionID

Type: object

Show Source

• aMFId: string
  Pattern: ^[A-Fa-f0-9]{6}$
• servingNetworkFunctionInformation(required): object NFIdentification
  A grouped field that contains a set of information identifying the NF consumer of the charging service.

{
    "type":"object",
    "properties":{
        "servingNetworkFunctionInformation":{
            "$ref":"#/components/schemas/NFIdentification"
        },
        "aMFId":{
            "$ref":"#/components/schemas/AmfId"
        }
    },
    "required":[
        "servingNetworkFunctionInformation"
    ]
}

Nested Schema : SubscribedDefaultQos

Type: object

Show Source

• 5qi(required): integer
  Minimum Value: 0

  Maximum Value: 255
• arp(required): object Arp
• priorityLevel: integer
  Minimum Value: 1

  Maximum Value: 127

  An unsigned integer indicating the 5QI priority level, from range 1 through 127. Values are ordered in decreasing order of priority, with 1 as the highest priority.

{
    "type":"object",
    "required":[
        "5qi",
        "arp"
    ],
    "properties":{
        "5qi":{
            "$ref":"#/components/schemas/5Qi"
        },
        "arp":{
            "$ref":"#/components/schemas/Arp"
        },
        "priorityLevel":{
            "$ref":"#/components/schemas/5QiPriorityLevel"
        }
    }
}

Nested Schema : Arp

Type: object

Show Source

• preemptCap(required):
  Whether a bearer with a lower priority level should be dropped to free up the required resources.
• preemptVuln(required):
  Whether a service data flow can lose the resources assigned to it in order to admit a service data flow that has a higher priority level.
• priorityLevel(required): integer
  Minimum Value: 1

  Maximum Value: 15

  nullable true shall not be used for this attribute

{
    "type":"object",
    "properties":{
        "priorityLevel":{
            "$ref":"#/components/schemas/ArpPriorityLevel"
        },
        "preemptCap":{
            "$ref":"#/components/schemas/PreemptionCapability"
        },
        "preemptVuln":{
            "$ref":"#/components/schemas/PreemptionVulnerability"
        }
    },
    "required":[
        "priorityLevel",
        "preemptCap",
        "preemptVuln"
    ]
}

Nested Schema : Snssai

Type: object

The S-NSSAIs of the NF.

Show Source

• sd: string
  Pattern: ^[A-Fa-f0-9]{6}$

  The S-NSSAI Slice Differentiator (SD) ID of the network slices that are allowed to access the HTTP Gateway server.
• sst(required): integer
  Minimum Value: 0

  Maximum Value: 255

  The S-NSSAI Slice/Service Type (SST) ID of the network slices that are allowed to access the HTTP Gateway server.

{
    "description":"The S-NSSAIs of the NF.",
    "type":"object",
    "properties":{
        "sst":{
            "description":"The S-NSSAI Slice/Service Type (SST) ID of the network slices that are allowed to access the HTTP Gateway server.",
            "type":"integer",
            "minimum":0,
            "maximum":255
        },
        "sd":{
            "description":"The S-NSSAI Slice Differentiator (SD) ID of the network slices that are allowed to access the HTTP Gateway server.",
            "type":"string",
            "pattern":"^[A-Fa-f0-9]{6}$"
        }
    },
    "required":[
        "sst"
    ]
}

Nested Schema : NFIdentification

Type: object

A grouped field that contains a set of information identifying the NF consumer of the charging service.

Show Source

• nFFqdn: string
• nFIPv4Address: string
  Pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$

  Example: 198.51.100.1
• nFIPv6Address: string Ipv6Addr
• nFName: string (uuid)
• nFPLMNID: object PlmnId
• nodeFunctionality(required): string
  Allowed Values: [ "AMF", "SMF", "SMSF", "SGW", "I_SMF", "ePDG", "CEF" ]

{
    "description":"A grouped field that contains a set of information identifying the NF consumer of the charging service.",
    "type":"object",
    "properties":{
        "nFName":{
            "$ref":"#/components/schemas/NfInstanceId"
        },
        "nFIPv4Address":{
            "$ref":"#/components/schemas/Ipv4Addr"
        },
        "nFIPv6Address":{
            "$ref":"#/components/schemas/Ipv6Addr"
        },
        "nFPLMNID":{
            "$ref":"#/components/schemas/PlmnId"
        },
        "nodeFunctionality":{
            "$ref":"#/components/schemas/NodeFunctionality"
        },
        "nFFqdn":{
            "type":"string"
        }
    },
    "required":[
        "nodeFunctionality"
    ]
}

Nested Schema : PresenceInfo

Type: object

Show Source

• ecgiList: array ecgiList
  Minimum Number of Items: 1
• globalRanNodeIdList: array globalRanNodeIdList
  Minimum Number of Items: 1
• ncgiList: array ncgiList
  Minimum Number of Items: 1
• praId: string
• presenceState:
• trackingAreaList: array trackingAreaList
  Minimum Number of Items: 1

{
    "type":"object",
    "properties":{
        "praId":{
            "type":"string"
        },
        "presenceState":{
            "$ref":"#/components/schemas/PresenceState"
        },
        "trackingAreaList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Tai"
            },
            "minItems":1
        },
        "ecgiList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Ecgi"
            },
            "minItems":1
        },
        "ncgiList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Ncgi"
            },
            "minItems":1
        },
        "globalRanNodeIdList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/GlobalRanNodeId"
            },
            "minItems":1
        }
    }
}

Nested Schema : ecgiList

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object Ecgi

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Ecgi"
    },
    "minItems":1
}

Nested Schema : globalRanNodeIdList

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object GlobalRanNodeId

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/GlobalRanNodeId"
    },
    "minItems":1
}

Nested Schema : ncgiList

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object Ncgi

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Ncgi"
    },
    "minItems":1
}

Nested Schema : trackingAreaList

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object Tai

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Tai"
    },
    "minItems":1
}

Nested Schema : qosFlowsUsageReports

Type: array

Show Source

• Array of: object QosFlowsUsageReport

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/QosFlowsUsageReport"
    }
}

Nested Schema : QosFlowsUsageReport

Type: object

Show Source

• downlinkVolume: integer (int64)
  Minimum Value: 0
• endTimestamp: string (date-time)
• qFI: integer
  Minimum Value: 0

  Maximum Value: 63
• startTimestamp: string (date-time)
• uplinkVolume: integer (int64)
  Minimum Value: 0

{
    "type":"object",
    "properties":{
        "qFI":{
            "$ref":"#/components/schemas/Qfi"
        },
        "startTimestamp":{
            "format":"date-time",
            "type":"string"
        },
        "endTimestamp":{
            "$ref":"#/components/schemas/DateTime"
        },
        "uplinkVolume":{
            "$ref":"#/components/schemas/Uint64"
        },
        "downlinkVolume":{
            "$ref":"#/components/schemas/Uint64"
        }
    }
}

Nested Schema : multipleQFIcontainer

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object MultipleQFIcontainer

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MultipleQFIcontainer"
    },
    "minItems":0
}

Nested Schema : RoamingChargingProfile

Type: object

Show Source

• partialRecordMethod: string
  Allowed Values: [ "DEFAULT", "INDIVIDUAL" ]
• triggers: array triggers
  Minimum Number of Items: 0

{
    "type":"object",
    "properties":{
        "triggers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Trigger"
            },
            "minItems":0
        },
        "partialRecordMethod":{
            "$ref":"#/components/schemas/PartialRecordMethod"
        }
    }
}

Nested Schema : MultipleQFIcontainer

Type: object

Show Source

• downlinkVolume: integer (int64)
  Minimum Value: 0
• localSequenceNumber(required): integer
• qFIContainerInformation: object QFIContainerInformation
• time: integer (int32)
  Minimum Value: 0
• totalVolume: integer (int64)
  Minimum Value: 0
• triggers: array triggers
  Minimum Number of Items: 0
• triggerTimestamp: string (date-time)
• uplinkVolume: integer (int64)
  Minimum Value: 0

{
    "type":"object",
    "properties":{
        "triggers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Trigger"
            },
            "minItems":0
        },
        "triggerTimestamp":{
            "format":"date-time",
            "type":"string"
        },
        "time":{
            "format":"int32",
            "type":"integer",
            "minimum":0
        },
        "totalVolume":{
            "$ref":"#/components/schemas/Uint64"
        },
        "uplinkVolume":{
            "$ref":"#/components/schemas/Uint64"
        },
        "downlinkVolume":{
            "$ref":"#/components/schemas/Uint64"
        },
        "localSequenceNumber":{
            "type":"integer"
        },
        "qFIContainerInformation":{
            "$ref":"#/components/schemas/QFIContainerInformation"
        }
    },
    "required":[
        "localSequenceNumber"
    ]
}

Nested Schema : QFIContainerInformation

Type: object

Show Source

• 3gppChargingId: integer (int32)
  Minimum Value: 0
• 3gppPSDataOffStatus: string
  Allowed Values: [ "ACTIVE", "INACTIVE" ]
• diagnostics: integer
• enhancedDiagnostics: array enhancedDiagnostics
• presenceReportingAreaInformation: object presenceReportingAreaInformation
  Minimum Number of Properties: 0

  Additional Properties Allowed: PresenceInfo
• qFI: integer
  Minimum Value: 0

  Maximum Value: 63
• qoSCharacteristics: object QosCharacteristics
  Contains QoS characteristics for a non-standardized or a non-configured 5QI.
• qoSInformation: object QosData
• rATType:
• reportTime(required): string (date-time)
• servingNetworkFunctionID: array servingNetworkFunctionID
  Minimum Number of Items: 0
• timeofFirstUsage: string (date-time)
• timeofLastUsage: string (date-time)
• uetimeZone: string
• userLocationInformation: object UserLocation

{
    "type":"object",
    "properties":{
        "qFI":{
            "$ref":"#/components/schemas/Qfi"
        },
        "reportTime":{
            "format":"date-time",
            "type":"string"
        },
        "timeofFirstUsage":{
            "format":"date-time",
            "type":"string"
        },
        "timeofLastUsage":{
            "format":"date-time",
            "type":"string"
        },
        "qoSInformation":{
            "$ref":"#/components/schemas/QosData"
        },
        "qoSCharacteristics":{
            "$ref":"#/components/schemas/QosCharacteristics"
        },
        "userLocationInformation":{
            "$ref":"#/components/schemas/UserLocation"
        },
        "uetimeZone":{
            "$ref":"#/components/schemas/TimeZone"
        },
        "presenceReportingAreaInformation":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/PresenceInfo"
            },
            "minProperties":0
        },
        "rATType":{
            "$ref":"#/components/schemas/RatType"
        },
        "servingNetworkFunctionID":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServingNetworkFunctionID"
            },
            "minItems":0
        },
        "3gppPSDataOffStatus":{
            "$ref":"#/components/schemas/3GPPPSDataOffStatus"
        },
        "3gppChargingId":{
            "$ref":"#/components/schemas/ChargingId"
        },
        "diagnostics":{
            "$ref":"#/components/schemas/Diagnostics"
        },
        "enhancedDiagnostics":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "reportTime"
    ]
}

Nested Schema : triggers

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object Trigger

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Trigger"
    },
    "minItems":0
}

Nested Schema : enhancedDiagnostics

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : presenceReportingAreaInformation

Type: object

Minimum Number of Properties: 0

Additional Properties Allowed

Show Source

• object PresenceInfo

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/PresenceInfo"
    },
    "minProperties":0
}

Nested Schema : QosCharacteristics

Type: object

Contains QoS characteristics for a non-standardized or a non-configured 5QI.

Show Source

• 5qi(required): integer
  Minimum Value: 0

  Maximum Value: 255
• averagingWindow: integer
  Minimum Value: 1

  Maximum Value: 4095

  Default Value: 2000

  The averaging window.
• maxDataBurstVol: integer
  Minimum Value: 1

  Maximum Value: 4095

  The maximum data burst volume.
• packetDelayBudget(required): integer
  Minimum Value: 1

  The packet delay budget.
• packetErrorRate(required): string
  Pattern: ^([0-9]E-[0-9])$

  The packet error rate.
• priorityLevel(required): integer
  Minimum Value: 1

  Maximum Value: 127

  An unsigned integer indicating the 5QI priority level, from range 1 through 127. Values are ordered in decreasing order of priority, with 1 as the highest priority.
• resourceType(required):
  Whether a QoS Flow is non-GBR, delay critical GBR, or non-delay critical GBR.

{
    "description":"Contains QoS characteristics for a non-standardized or a non-configured 5QI.",
    "type":"object",
    "properties":{
        "5qi":{
            "$ref":"#/components/schemas/5Qi"
        },
        "resourceType":{
            "$ref":"#/components/schemas/QosResourceType"
        },
        "priorityLevel":{
            "$ref":"#/components/schemas/5QiPriorityLevel"
        },
        "packetDelayBudget":{
            "$ref":"#/components/schemas/PacketDelBudget"
        },
        "packetErrorRate":{
            "$ref":"#/components/schemas/PacketErrRate"
        },
        "averagingWindow":{
            "$ref":"#/components/schemas/AverWindow"
        },
        "maxDataBurstVol":{
            "$ref":"#/components/schemas/MaxDataBurstVol"
        }
    },
    "required":[
        "5qi",
        "resourceType",
        "priorityLevel",
        "packetDelayBudget",
        "packetErrorRate"
    ]
}

Nested Schema : QosData

Type: object

Show Source

• 5qi: integer
  Minimum Value: 0

  Maximum Value: 255
• arp: object Arp
• averWindow: integer
  Minimum Value: 1

  Maximum Value: 4095

  Default Value: 2000

  The averaging window. This field can have a nullable value.
• defQosFlowIndication: boolean
  Indicates that the dynamic PCC rule shall always have its binding with the QoS Flow associated with the default QoS rule
• gbrDl: string
  Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
• gbrUl: string
  Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
• maxbrDl: string
  Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
• maxbrUl: string
  Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
• maxDataBurstVol: integer
  Minimum Value: 1

  Maximum Value: 4095

  The maximum data burst volume. This field can have a nullable value.
• maxPacketLossRateDl: integer
  Minimum Value: 0

  Maximum Value: 1000

  The packet loss rate. This field can have a nullable value.
• maxPacketLossRateUl: integer
  Minimum Value: 0

  Maximum Value: 1000

  The packet loss rate. This field can have a nullable value.
• priorityLevel: integer
  Minimum Value: 1

  Maximum Value: 127
• qnc: boolean
  Indicates whether notifications are requested from 3GPP NG-RAN when the GFBR can no longer (or again) be guaranteed for a QoS Flow during the lifetime of the QoS Flow.
• qosId(required): string
  Univocally identifies the QoS control policy data within a PDU session.
• reflectiveQos: boolean
  Indicates whether the QoS information is reflective for the corresponding service data flow.
• sharingKeyDl: string
  Indicates, by containing the same value, what PCC rules may share resource in downlink direction.
• sharingKeyUl: string
  Indicates, by containing the same value, what PCC rules may share resource in uplink direction.

{
    "type":"object",
    "properties":{
        "qosId":{
            "type":"string",
            "description":"Univocally identifies the QoS control policy data within a PDU session."
        },
        "5qi":{
            "$ref":"#/components/schemas/5Qi"
        },
        "maxbrUl":{
            "$ref":"#/components/schemas/BitRateRm"
        },
        "maxbrDl":{
            "$ref":"#/components/schemas/BitRateRm"
        },
        "gbrUl":{
            "$ref":"#/components/schemas/BitRateRm"
        },
        "gbrDl":{
            "$ref":"#/components/schemas/BitRateRm"
        },
        "arp":{
            "$ref":"#/components/schemas/Arp"
        },
        "qnc":{
            "type":"boolean",
            "description":"Indicates whether notifications are requested from 3GPP NG-RAN when the GFBR can no longer (or again) be guaranteed for a QoS Flow during the lifetime of the QoS Flow."
        },
        "priorityLevel":{
            "$ref":"#/components/schemas/5QiPriorityLevelRm"
        },
        "averWindow":{
            "$ref":"#/components/schemas/AverWindowRm"
        },
        "maxDataBurstVol":{
            "$ref":"#/components/schemas/MaxDataBurstVolRm"
        },
        "reflectiveQos":{
            "type":"boolean",
            "description":"Indicates whether the QoS information is reflective for the corresponding service data flow."
        },
        "sharingKeyDl":{
            "type":"string",
            "description":"Indicates, by containing the same value, what PCC rules may share resource in downlink direction."
        },
        "sharingKeyUl":{
            "type":"string",
            "description":"Indicates, by containing the same value, what PCC rules may share resource in uplink direction."
        },
        "maxPacketLossRateDl":{
            "$ref":"#/components/schemas/PacketLossRateRm"
        },
        "maxPacketLossRateUl":{
            "$ref":"#/components/schemas/PacketLossRateRm"
        },
        "defQosFlowIndication":{
            "type":"boolean",
            "description":"Indicates that the dynamic PCC rule shall always have its binding with the QoS Flow associated with the default QoS rule"
        }
    },
    "required":[
        "qosId"
    ],
    "nullable":true
}

Nested Schema : servingNetworkFunctionID

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object ServingNetworkFunctionID

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServingNetworkFunctionID"
    },
    "minItems":0
}

Nested Schema : triggers

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object Trigger

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Trigger"
    },
    "minItems":0
}

400 Response

The request isn't valid.

Body ()

Root Schema : ProblemDetails

Type: object

Information about an error.

Show Source

• cause: string
  The reason for the failure.
• detail: string
  Details about the error.
• instance: string
  The instance.
• invalidParams: array invalidParams
  Minimum Number of Items: 1

  A list of invalid parameters.
• status: integer
  The status code.
• supportedFeatures: string
  Pattern: ^[A-Fa-f0-9]*$

  The list of supported features.
• title: string
  The problem's title.
• type: string
  The type of problem.

{
    "description":"Information about an error.",
    "type":"object",
    "properties":{
        "type":{
            "description":"The type of problem.",
            "type":"string"
        },
        "title":{
            "description":"The problem's title.",
            "type":"string"
        },
        "status":{
            "description":"The status code.",
            "type":"integer"
        },
        "detail":{
            "description":"Details about the error.",
            "type":"string"
        },
        "instance":{
            "type":"string",
            "description":"The instance."
        },
        "cause":{
            "description":"The reason for the failure.",
            "type":"string"
        },
        "invalidParams":{
            "type":"array",
            "description":"A list of invalid parameters.",
            "items":{
                "$ref":"#/components/schemas/InvalidParam"
            },
            "minItems":1
        },
        "supportedFeatures":{
            "$ref":"#/components/schemas/SupportedFeatures"
        }
    }
}

Nested Schema : invalidParams

Type: array

Minimum Number of Items: 1

A list of invalid parameters.

Show Source

• Array of: object InvalidParam
  An invalid parameter.

{
    "type":"array",
    "description":"A list of invalid parameters.",
    "items":{
        "$ref":"#/components/schemas/InvalidParam"
    },
    "minItems":1
}

Nested Schema : InvalidParam

Type: object

An invalid parameter.

Show Source

• param(required): string
  The name of the parameter.
• reason: string
  The reason why the parameter didn't pass validation.

{
    "type":"object",
    "description":"An invalid parameter.",
    "properties":{
        "param":{
            "type":"string",
            "description":"The name of the parameter."
        },
        "reason":{
            "type":"string",
            "description":"The reason why the parameter didn't pass validation."
        }
    },
    "required":[
        "param"
    ]
}

401 Response

Unauthorized request.

Body ()

Root Schema : ProblemDetails

Type: object

Information about an error.

Show Source

• cause: string
  The reason for the failure.
• detail: string
  Details about the error.
• instance: string
  The instance.
• invalidParams: array invalidParams
  Minimum Number of Items: 1

  A list of invalid parameters.
• status: integer
  The status code.
• supportedFeatures: string
  Pattern: ^[A-Fa-f0-9]*$

  The list of supported features.
• title: string
  The problem's title.
• type: string
  The type of problem.

{
    "description":"Information about an error.",
    "type":"object",
    "properties":{
        "type":{
            "description":"The type of problem.",
            "type":"string"
        },
        "title":{
            "description":"The problem's title.",
            "type":"string"
        },
        "status":{
            "description":"The status code.",
            "type":"integer"
        },
        "detail":{
            "description":"Details about the error.",
            "type":"string"
        },
        "instance":{
            "type":"string",
            "description":"The instance."
        },
        "cause":{
            "description":"The reason for the failure.",
            "type":"string"
        },
        "invalidParams":{
            "type":"array",
            "description":"A list of invalid parameters.",
            "items":{
                "$ref":"#/components/schemas/InvalidParam"
            },
            "minItems":1
        },
        "supportedFeatures":{
            "$ref":"#/components/schemas/SupportedFeatures"
        }
    }
}

Nested Schema : invalidParams

Type: array

Minimum Number of Items: 1

A list of invalid parameters.

Show Source

• Array of: object InvalidParam
  An invalid parameter.

{
    "type":"array",
    "description":"A list of invalid parameters.",
    "items":{
        "$ref":"#/components/schemas/InvalidParam"
    },
    "minItems":1
}

Nested Schema : InvalidParam

Type: object

An invalid parameter.

Show Source

• param(required): string
  The name of the parameter.
• reason: string
  The reason why the parameter didn't pass validation.

{
    "type":"object",
    "description":"An invalid parameter.",
    "properties":{
        "param":{
            "type":"string",
            "description":"The name of the parameter."
        },
        "reason":{
            "type":"string",
            "description":"The reason why the parameter didn't pass validation."
        }
    },
    "required":[
        "param"
    ]
}

403 Response

The request wasn't authorized.

Body ()

Root Schema : ProblemDetails

Type: object

Information about an error.

Show Source

• cause: string
  The reason for the failure.
• detail: string
  Details about the error.
• instance: string
  The instance.
• invalidParams: array invalidParams
  Minimum Number of Items: 1

  A list of invalid parameters.
• status: integer
  The status code.
• supportedFeatures: string
  Pattern: ^[A-Fa-f0-9]*$

  The list of supported features.
• title: string
  The problem's title.
• type: string
  The type of problem.

{
    "description":"Information about an error.",
    "type":"object",
    "properties":{
        "type":{
            "description":"The type of problem.",
            "type":"string"
        },
        "title":{
            "description":"The problem's title.",
            "type":"string"
        },
        "status":{
            "description":"The status code.",
            "type":"integer"
        },
        "detail":{
            "description":"Details about the error.",
            "type":"string"
        },
        "instance":{
            "type":"string",
            "description":"The instance."
        },
        "cause":{
            "description":"The reason for the failure.",
            "type":"string"
        },
        "invalidParams":{
            "type":"array",
            "description":"A list of invalid parameters.",
            "items":{
                "$ref":"#/components/schemas/InvalidParam"
            },
            "minItems":1
        },
        "supportedFeatures":{
            "$ref":"#/components/schemas/SupportedFeatures"
        }
    }
}

Nested Schema : invalidParams

Type: array

Minimum Number of Items: 1

A list of invalid parameters.

Show Source

• Array of: object InvalidParam
  An invalid parameter.

{
    "type":"array",
    "description":"A list of invalid parameters.",
    "items":{
        "$ref":"#/components/schemas/InvalidParam"
    },
    "minItems":1
}

Nested Schema : InvalidParam

Type: object

An invalid parameter.

Show Source

• param(required): string
  The name of the parameter.
• reason: string
  The reason why the parameter didn't pass validation.

{
    "type":"object",
    "description":"An invalid parameter.",
    "properties":{
        "param":{
            "type":"string",
            "description":"The name of the parameter."
        },
        "reason":{
            "type":"string",
            "description":"The reason why the parameter didn't pass validation."
        }
    },
    "required":[
        "param"
    ]
}

404 Response

The requested resource couldn't be found.

Body ()

Root Schema : ProblemDetails

Type: object

Information about an error.

Show Source

• cause: string
  The reason for the failure.
• detail: string
  Details about the error.
• instance: string
  The instance.
• invalidParams: array invalidParams
  Minimum Number of Items: 1

  A list of invalid parameters.
• status: integer
  The status code.
• supportedFeatures: string
  Pattern: ^[A-Fa-f0-9]*$

  The list of supported features.
• title: string
  The problem's title.
• type: string
  The type of problem.

{
    "description":"Information about an error.",
    "type":"object",
    "properties":{
        "type":{
            "description":"The type of problem.",
            "type":"string"
        },
        "title":{
            "description":"The problem's title.",
            "type":"string"
        },
        "status":{
            "description":"The status code.",
            "type":"integer"
        },
        "detail":{
            "description":"Details about the error.",
            "type":"string"
        },
        "instance":{
            "type":"string",
            "description":"The instance."
        },
        "cause":{
            "description":"The reason for the failure.",
            "type":"string"
        },
        "invalidParams":{
            "type":"array",
            "description":"A list of invalid parameters.",
            "items":{
                "$ref":"#/components/schemas/InvalidParam"
            },
            "minItems":1
        },
        "supportedFeatures":{
            "$ref":"#/components/schemas/SupportedFeatures"
        }
    }
}

Nested Schema : invalidParams

Type: array

Minimum Number of Items: 1

A list of invalid parameters.

Show Source

• Array of: object InvalidParam
  An invalid parameter.

{
    "type":"array",
    "description":"A list of invalid parameters.",
    "items":{
        "$ref":"#/components/schemas/InvalidParam"
    },
    "minItems":1
}

Nested Schema : InvalidParam

Type: object

An invalid parameter.

Show Source

• param(required): string
  The name of the parameter.
• reason: string
  The reason why the parameter didn't pass validation.

{
    "type":"object",
    "description":"An invalid parameter.",
    "properties":{
        "param":{
            "type":"string",
            "description":"The name of the parameter."
        },
        "reason":{
            "type":"string",
            "description":"The reason why the parameter didn't pass validation."
        }
    },
    "required":[
        "param"
    ]
}

410 Response

The requested resource is no longer available.

Body ()

Root Schema : ProblemDetails

Type: object

Information about an error.

Show Source

• cause: string
  The reason for the failure.
• detail: string
  Details about the error.
• instance: string
  The instance.
• invalidParams: array invalidParams
  Minimum Number of Items: 1

  A list of invalid parameters.
• status: integer
  The status code.
• supportedFeatures: string
  Pattern: ^[A-Fa-f0-9]*$

  The list of supported features.
• title: string
  The problem's title.
• type: string
  The type of problem.

{
    "description":"Information about an error.",
    "type":"object",
    "properties":{
        "type":{
            "description":"The type of problem.",
            "type":"string"
        },
        "title":{
            "description":"The problem's title.",
            "type":"string"
        },
        "status":{
            "description":"The status code.",
            "type":"integer"
        },
        "detail":{
            "description":"Details about the error.",
            "type":"string"
        },
        "instance":{
            "type":"string",
            "description":"The instance."
        },
        "cause":{
            "description":"The reason for the failure.",
            "type":"string"
        },
        "invalidParams":{
            "type":"array",
            "description":"A list of invalid parameters.",
            "items":{
                "$ref":"#/components/schemas/InvalidParam"
            },
            "minItems":1
        },
        "supportedFeatures":{
            "$ref":"#/components/schemas/SupportedFeatures"
        }
    }
}

Nested Schema : invalidParams

Type: array

Minimum Number of Items: 1

A list of invalid parameters.

Show Source

• Array of: object InvalidParam
  An invalid parameter.

{
    "type":"array",
    "description":"A list of invalid parameters.",
    "items":{
        "$ref":"#/components/schemas/InvalidParam"
    },
    "minItems":1
}

Nested Schema : InvalidParam

Type: object

An invalid parameter.

Show Source

• param(required): string
  The name of the parameter.
• reason: string
  The reason why the parameter didn't pass validation.

{
    "type":"object",
    "description":"An invalid parameter.",
    "properties":{
        "param":{
            "type":"string",
            "description":"The name of the parameter."
        },
        "reason":{
            "type":"string",
            "description":"The reason why the parameter didn't pass validation."
        }
    },
    "required":[
        "param"
    ]
}

411 Response

The request didn't include the required length.

Body ()

Root Schema : ProblemDetails

Type: object

Information about an error.

Show Source

• cause: string
  The reason for the failure.
• detail: string
  Details about the error.
• instance: string
  The instance.
• invalidParams: array invalidParams
  Minimum Number of Items: 1

  A list of invalid parameters.
• status: integer
  The status code.
• supportedFeatures: string
  Pattern: ^[A-Fa-f0-9]*$

  The list of supported features.
• title: string
  The problem's title.
• type: string
  The type of problem.

{
    "description":"Information about an error.",
    "type":"object",
    "properties":{
        "type":{
            "description":"The type of problem.",
            "type":"string"
        },
        "title":{
            "description":"The problem's title.",
            "type":"string"
        },
        "status":{
            "description":"The status code.",
            "type":"integer"
        },
        "detail":{
            "description":"Details about the error.",
            "type":"string"
        },
        "instance":{
            "type":"string",
            "description":"The instance."
        },
        "cause":{
            "description":"The reason for the failure.",
            "type":"string"
        },
        "invalidParams":{
            "type":"array",
            "description":"A list of invalid parameters.",
            "items":{
                "$ref":"#/components/schemas/InvalidParam"
            },
            "minItems":1
        },
        "supportedFeatures":{
            "$ref":"#/components/schemas/SupportedFeatures"
        }
    }
}

Nested Schema : invalidParams

Type: array

Minimum Number of Items: 1

A list of invalid parameters.

Show Source

• Array of: object InvalidParam
  An invalid parameter.

{
    "type":"array",
    "description":"A list of invalid parameters.",
    "items":{
        "$ref":"#/components/schemas/InvalidParam"
    },
    "minItems":1
}

Nested Schema : InvalidParam

Type: object

An invalid parameter.

Show Source

• param(required): string
  The name of the parameter.
• reason: string
  The reason why the parameter didn't pass validation.

{
    "type":"object",
    "description":"An invalid parameter.",
    "properties":{
        "param":{
            "type":"string",
            "description":"The name of the parameter."
        },
        "reason":{
            "type":"string",
            "description":"The reason why the parameter didn't pass validation."
        }
    },
    "required":[
        "param"
    ]
}

413 Response

The request payload is too large.

Body ()

Root Schema : ProblemDetails

Type: object

Information about an error.

Show Source

• cause: string
  The reason for the failure.
• detail: string
  Details about the error.
• instance: string
  The instance.
• invalidParams: array invalidParams
  Minimum Number of Items: 1

  A list of invalid parameters.
• status: integer
  The status code.
• supportedFeatures: string
  Pattern: ^[A-Fa-f0-9]*$

  The list of supported features.
• title: string
  The problem's title.
• type: string
  The type of problem.

{
    "description":"Information about an error.",
    "type":"object",
    "properties":{
        "type":{
            "description":"The type of problem.",
            "type":"string"
        },
        "title":{
            "description":"The problem's title.",
            "type":"string"
        },
        "status":{
            "description":"The status code.",
            "type":"integer"
        },
        "detail":{
            "description":"Details about the error.",
            "type":"string"
        },
        "instance":{
            "type":"string",
            "description":"The instance."
        },
        "cause":{
            "description":"The reason for the failure.",
            "type":"string"
        },
        "invalidParams":{
            "type":"array",
            "description":"A list of invalid parameters.",
            "items":{
                "$ref":"#/components/schemas/InvalidParam"
            },
            "minItems":1
        },
        "supportedFeatures":{
            "$ref":"#/components/schemas/SupportedFeatures"
        }
    }
}

Nested Schema : invalidParams

Type: array

Minimum Number of Items: 1

A list of invalid parameters.

Show Source

• Array of: object InvalidParam
  An invalid parameter.

{
    "type":"array",
    "description":"A list of invalid parameters.",
    "items":{
        "$ref":"#/components/schemas/InvalidParam"
    },
    "minItems":1
}

Nested Schema : InvalidParam

Type: object

An invalid parameter.

Show Source

• param(required): string
  The name of the parameter.
• reason: string
  The reason why the parameter didn't pass validation.

{
    "type":"object",
    "description":"An invalid parameter.",
    "properties":{
        "param":{
            "type":"string",
            "description":"The name of the parameter."
        },
        "reason":{
            "type":"string",
            "description":"The reason why the parameter didn't pass validation."
        }
    },
    "required":[
        "param"
    ]
}

500 Response

The system encountered an internal error.

Body ()

Root Schema : ProblemDetails

Type: object

Information about an error.

Show Source

• cause: string
  The reason for the failure.
• detail: string
  Details about the error.
• instance: string
  The instance.
• invalidParams: array invalidParams
  Minimum Number of Items: 1

  A list of invalid parameters.
• status: integer
  The status code.
• supportedFeatures: string
  Pattern: ^[A-Fa-f0-9]*$

  The list of supported features.
• title: string
  The problem's title.
• type: string
  The type of problem.

{
    "description":"Information about an error.",
    "type":"object",
    "properties":{
        "type":{
            "description":"The type of problem.",
            "type":"string"
        },
        "title":{
            "description":"The problem's title.",
            "type":"string"
        },
        "status":{
            "description":"The status code.",
            "type":"integer"
        },
        "detail":{
            "description":"Details about the error.",
            "type":"string"
        },
        "instance":{
            "type":"string",
            "description":"The instance."
        },
        "cause":{
            "description":"The reason for the failure.",
            "type":"string"
        },
        "invalidParams":{
            "type":"array",
            "description":"A list of invalid parameters.",
            "items":{
                "$ref":"#/components/schemas/InvalidParam"
            },
            "minItems":1
        },
        "supportedFeatures":{
            "$ref":"#/components/schemas/SupportedFeatures"
        }
    }
}

Nested Schema : invalidParams

Type: array

Minimum Number of Items: 1

A list of invalid parameters.

Show Source

• Array of: object InvalidParam
  An invalid parameter.

{
    "type":"array",
    "description":"A list of invalid parameters.",
    "items":{
        "$ref":"#/components/schemas/InvalidParam"
    },
    "minItems":1
}

Nested Schema : InvalidParam

Type: object

An invalid parameter.

Show Source

• param(required): string
  The name of the parameter.
• reason: string
  The reason why the parameter didn't pass validation.

{
    "type":"object",
    "description":"An invalid parameter.",
    "properties":{
        "param":{
            "type":"string",
            "description":"The name of the parameter."
        },
        "reason":{
            "type":"string",
            "description":"The reason why the parameter didn't pass validation."
        }
    },
    "required":[
        "param"
    ]
}

503 Response

The server cannot handle the request due to overload or maintenance.

Body ()

Root Schema : ProblemDetails

Type: object

Information about an error.

Show Source

• cause: string
  The reason for the failure.
• detail: string
  Details about the error.
• instance: string
  The instance.
• invalidParams: array invalidParams
  Minimum Number of Items: 1

  A list of invalid parameters.
• status: integer
  The status code.
• supportedFeatures: string
  Pattern: ^[A-Fa-f0-9]*$

  The list of supported features.
• title: string
  The problem's title.
• type: string
  The type of problem.

{
    "description":"Information about an error.",
    "type":"object",
    "properties":{
        "type":{
            "description":"The type of problem.",
            "type":"string"
        },
        "title":{
            "description":"The problem's title.",
            "type":"string"
        },
        "status":{
            "description":"The status code.",
            "type":"integer"
        },
        "detail":{
            "description":"Details about the error.",
            "type":"string"
        },
        "instance":{
            "type":"string",
            "description":"The instance."
        },
        "cause":{
            "description":"The reason for the failure.",
            "type":"string"
        },
        "invalidParams":{
            "type":"array",
            "description":"A list of invalid parameters.",
            "items":{
                "$ref":"#/components/schemas/InvalidParam"
            },
            "minItems":1
        },
        "supportedFeatures":{
            "$ref":"#/components/schemas/SupportedFeatures"
        }
    }
}

Nested Schema : invalidParams

Type: array

Minimum Number of Items: 1

A list of invalid parameters.

Show Source

• Array of: object InvalidParam
  An invalid parameter.

{
    "type":"array",
    "description":"A list of invalid parameters.",
    "items":{
        "$ref":"#/components/schemas/InvalidParam"
    },
    "minItems":1
}

Nested Schema : InvalidParam

Type: object

An invalid parameter.

Show Source

• param(required): string
  The name of the parameter.
• reason: string
  The reason why the parameter didn't pass validation.

{
    "type":"object",
    "description":"An invalid parameter.",
    "properties":{
        "param":{
            "type":"string",
            "description":"The name of the parameter."
        },
        "reason":{
            "type":"string",
            "description":"The reason why the parameter didn't pass validation."
        }
    },
    "required":[
        "param"
    ]
}

Default Response

Generic Error

Back to Top

Examples

The following example shows how to update an Nchf converged charging session by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".

The -d option specifies the file to attach as the request body.

curl -X POST "apiroot/nchf-convergedcharging/v2/chargingdata/7e5f7eb2-6f5a-8d7d-63df-5202fadbc512/update" -H "accept: */*" -H "Content-Type: application/json" -d @file.json

where:

• apiRoot is for accessing the HTTP Gateway server at either http://hostname:httpPort or https://hostname:httpsPort.

• file.json is the JSON file that specifies the converged charging session to update.

Example of Request Body

The following is an example of the contents of file.json sent as the request body:

{
   "invocationSequenceNumber": 9,
   "invocationTimeStamp": "2019-09-24T07:30:33.882Z",
   "multipleUnitUsage": [
      {
         "ratingGroup": 10,
         "requestedUnit": {
            "time": 600
         },
         "usedUnitContainer": [{
            "serviceId": 123,
            "localSequenceNumber": 0,
            "quotaManagementIndicator": "ONLINE_CHARGING",
            "time": 600
         }],
         "uPFID": "123e4567-e89b-12d3-a456-426655440000"
      }   
   ],
   "nfConsumerIdentification": {
      "nodeFunctionality": "SMF"
   },
   "notifyUri": "http://test-notification-url",
   "pDUSessionChargingInformation": {
      "chargingId": 1000,
      "pduSessionInformation": {
         "pduSessionID": 1,
         "dnnId": "1"
      }
   },
   "roamingQBCInformation": {},
   "subscriberIdentifier": "imsi-6500000427",
   "triggers": [
      {
         "triggerCategory": "IMMEDIATE_REPORT",
         "triggerType": "QUOTA_THRESHOLD"
      }
   ]
}

Example of Response Body

If successful, the response code 200 is returned along with a header and a response payload. The following shows sample header contents:

connection: keep-alive
content-length: 154
content-type: application/json
date: Tue, 12 Jul 2022 08:21:13 +0530

The following shows sample response body contents:

{
   "invocationTimeStamp": "2019-09-24T13:00:33.882+05:30",
   "invocationSequenceNumber": 9,
   "multipleUnitInformation": [
      {
         "resultCode": "SUCCESS",
         "ratingGroup": 10,
         "grantedUnit": {
            "time" : 600
         }
      }
   ]
}

If the request fails, the response includes the appropriate HTTP code. For a 4xx/5xx code, the message body also contains a ProblemDetails structure with the cause attribute set to the appropriate application error.

Back to Top