Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Revision DescriptionTime

Swagger

Ready

Adding new methods - Insert, Update and Delete ENB.  Add new errors.

Added Additional Cell Information for both eNB and gNB (in the Insert eNB Request, Update eNB)

Changing the response of Get NodeB - adding more information to the Cell Object

July 2020ReadyTBD  
Changing the end point of Update GNB. Adding more information to the Cell Object like Update eNBJuly 2020ReadyTBD 
Supporting E2M Set Parameter (New method) with Enable RIC parameterMay 2020  Ready

Get All NodeB States Request changed its End-Point URL

Adding Connection Status in RAN object in Get All NodeB States Response

TBD  
RAN Definition in the RAN List table turn to be Array of bytes (We don't decode the ASN.1)June 2020  Ready
AD SDL Notification DescriptionJune 2020NA

...

Resource

Resource for this interface - /v#/nodeb/enb 

Description

For Updating nodeb from eNB type to Redis, the client should send PUT request

HTTP Method

PUT

Supported Representation Formats

Request: Request Format ie application/json, none, etc

Response: Response Format ie application/json, none, etc

Successful HTTP Response Code

200 OK


PUT http://<serverBaseURL>/v#/nodeb/enb/<ranName>

accept: application/json

{

    "enb": {

        "enbType": 1,

        "guGroupIds": [

            "ghi"

        ],

        "servedCells": [

            {

                "broadcastPlmns": [

                    "jkl"

                ],

                "cellId": "mnop",

                "choiceEutraMode": {

                    "fdd": {

                        "dlearFcn": 1,

                        "ulearFcn": 1

                    },

                    "tdd": {

                        "additionalSpecialSubframeExtensionInfo": {

                            "additionalSpecialSubframePatternsExtension": 1,

                            "cyclicPrefixDl": 1,

                            "cyclicPrefixUl": 1

                        },

                        "additionalSpecialSubframeInfo": {

                            "additionalSpecialSubframePatterns": 1,

                            "cyclicPrefixDl": 1,

                            "cyclicPrefixUl": 1

                        },

                        "earFcn": 4,

                        "specialSubframeInfo": {

                            "specialSubframePatterns": 1,

                            "cyclicPrefixDl": 1,

                            "cyclicPrefixUl": 1

                        }

                    }

                },

                "eutraMode": 1,

                "csgId": "string",

                "mbmsServiceAreaIdentities": [

                    "sds"

                ],

                "mbsfnSubframeInfos": [

                    {

                        "radioframeAllocationOffset": 3,

                        "subframeAllocation": "jhg"

                    }

                ],

                "multibandInfos": [

                    4

                ],

                "neighbourInfos": [

                    {

                        "earFcn": 4,

                        "ecgi": "klj",

                        "pci": 5,

                        "tac": "wew"

                    }

                ],

                "pci": 2,

                "prachConfiguration": {

                    "highSpeedFlag": true,

                    "prachConfigurationIndex": 5,

                    "prachFrequencyOffset": 6,

                    "rootSequenceIndex": 7,

                    "zeroCorrelationZoneConfiguration": 6

                },

                "tac": "asd",

                "additionalCellInformation": {

                    "cellLatitude": 1,

                    "cellLongitude": 1,

                    "antennaHeight": 1,

                    "antennaAzimuthDirection": 2,

                    "antennaTiltAngle": 3,

                    "antennaMaxTransmit": 4,

                    "antennaMaxGain": 5,

                    "sectorId": 6

                }

            },

            {

                "broadcastPlmns": [

                    "jkl"

                ],

                "cellId": "qrst",

                "choiceEutraMode": {

                    "fdd": {

                        "dlearFcn": 4,

                        "ulearFcn": 2

                    },

                    "tdd": {

                        "additionalSpecialSubframeExtensionInfo": {

                            "additionalSpecialSubframePatternsExtension": 1,

                            "cyclicPrefixDl": 1,

                            "cyclicPrefixUl": 1

                        },

                        "additionalSpecialSubframeInfo": {

                            "additionalSpecialSubframePatterns": 1,

                            "cyclicPrefixDl": 1,

                            "cyclicPrefixUl": 1

                        },

                        "earFcn": 4,

                        "specialSubframeInfo": {

                            "specialSubframePatterns": 1,

                            "cyclicPrefixDl": 1,

                            "cyclicPrefixUl": 1

                        }

                    }

                },

                "eutraMode": 1,

                "csgId": "string",

                "mbmsServiceAreaIdentities": [

                    "sds"

                ],

                "mbsfnSubframeInfos": [

                    {

                        "radioframeAllocationOffset": 5,

                        "subframeAllocation": "jhg"

                    }

                ],

                "multibandInfos": [

                    4

                ],

                "neighbourInfos": [

                    {

                        "earFcn": 2,

                        "ecgi": "klj",

                        "pci": 4,

                        "tac": "wew"

                    }

                ],

                "pci": 3,

                "prachConfiguration": {

                    "highSpeedFlag": true,

                    "prachConfigurationIndex": 4,

                    "prachFrequencyOffset": 3,

                    "rootSequenceIndex": 3,

                    "zeroCorrelationZoneConfiguration": 2

                },

                "tac": "asd",

                "additionalCellInformation": {

                    "cellLatitude": 3,

                    "cellLongitude": 3,

                    "antennaHeight": 3,

                    "antennaAzimuthDirection": 3,

                    "antennaTiltAngle": 4,

                    "antennaMaxTransmit": 4,

                    "antennaMaxGain": 5,

                    "sectorId": 5

                }

            }

        ]

    }

}

Request Data Details

#

Parameter

Location

Data Type

Required?

Value Rules

1acceptHeaderString

YES

Refer to Standard API Request Headers
2

content-type

Header

String

YES

Refer to Standard API Request Headers

3enbBodyObjectYESPlease refer to ENB Object

...