Jump to

• Request
• Response

Create Presence Reporting Area

post

ss/oc-cnpolicy-configuration/v1/policydata/common/pras

Request

Supported Media Types

• application/json

Body ()

body

Root Schema : PresenceReportingArea

Type: object

Title: PresenceReportingArea

Show Source

• ecgiList(optional): array ecgiList
• globalRanNodeIdList(optional): array globalRanNodeIdList
• name: string
• ncgiList(optional): array ncgiList
• praId: string
• presenceState(optional): string
  Allowed Values: [ "INACTIVE", "IN_AREA", "OUT_OF_AREA", "UNKNOWN" ]
• trackingAreaList(optional): array trackingAreaList

{
    "type":"object",
    "required":[
        "name",
        "praId"
    ],
    "properties":{
        "ecgiList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PresenceReportingAreaEcgiList"
            }
        },
        "globalRanNodeIdList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PresenceReportingAreaGlobalRanNodeIdList"
            }
        },
        "name":{
            "type":"string"
        },
        "ncgiList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PresenceReportingAreaNcgiList"
            }
        },
        "praId":{
            "type":"string"
        },
        "presenceState":{
            "type":"string",
            "enum":[
                "INACTIVE",
                "IN_AREA",
                "OUT_OF_AREA",
                "UNKNOWN"
            ]
        },
        "trackingAreaList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PresenceReportingAreaTrackingAreaList"
            }
        }
    },
    "title":"PresenceReportingArea"
}

Nested Schema : ecgiList

Type: array

Show Source

• Array of: object PresenceReportingAreaEcgiList
  Title: PresenceReportingAreaEcgiList

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PresenceReportingAreaEcgiList"
    }
}

Nested Schema : globalRanNodeIdList

Type: array

Show Source

• Array of: object PresenceReportingAreaGlobalRanNodeIdList
  Title: PresenceReportingAreaGlobalRanNodeIdList

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PresenceReportingAreaGlobalRanNodeIdList"
    }
}

Nested Schema : ncgiList

Type: array

Show Source

• Array of: object PresenceReportingAreaNcgiList
  Title: PresenceReportingAreaNcgiList

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PresenceReportingAreaNcgiList"
    }
}

Nested Schema : trackingAreaList

Type: array

Show Source

• Array of: object PresenceReportingAreaTrackingAreaList
  Title: PresenceReportingAreaTrackingAreaList

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PresenceReportingAreaTrackingAreaList"
    }
}

Nested Schema : PresenceReportingAreaEcgiList

Type: object

Title: PresenceReportingAreaEcgiList

Show Source

• eutraCellId(optional): string
  enter a 7 digit hexadecimal value
• plmnId: object PlmnId
  Title: PlmnId

{
    "type":"object",
    "required":[
        "plmnId"
    ],
    "properties":{
        "eutraCellId":{
            "type":"string",
            "description":"enter a 7 digit hexadecimal value"
        },
        "plmnId":{
            "$ref":"#/definitions/PlmnId"
        }
    },
    "title":"PresenceReportingAreaEcgiList"
}

Nested Schema : PlmnId

Type: object

Title: PlmnId

Show Source

• mcc: string
  enter a 3 digit number
• mnc: string
  enter a 2 or 3 digit number

{
    "type":"object",
    "required":[
        "mcc",
        "mnc"
    ],
    "properties":{
        "mcc":{
            "type":"string",
            "description":"enter a 3 digit number"
        },
        "mnc":{
            "type":"string",
            "description":"enter a 2 or 3 digit number"
        }
    },
    "title":"PlmnId"
}

Nested Schema : PresenceReportingAreaGlobalRanNodeIdList

Type: object

Title: PresenceReportingAreaGlobalRanNodeIdList

Show Source

• gNbId(optional): object GNbId
  Title: GNbId
• n3IwfId(optional): string
  enter a 1 or more digit hexadecimal value
• ngeNbId(optional): string
  Enter a value starting with 'MacroNGeNB-' or 'SMacroNGeNB-' and ending with a 5 hexadecimal value or starting with 'LMacroNGeNB-' and ending with a 6 hexadecimal value
• plmnId(optional): object PlmnId
  Title: PlmnId

{
    "type":"object",
    "properties":{
        "gNbId":{
            "$ref":"#/definitions/GNbId"
        },
        "n3IwfId":{
            "type":"string",
            "description":"enter a 1 or more digit hexadecimal value"
        },
        "ngeNbId":{
            "type":"string",
            "description":"Enter a value starting with 'MacroNGeNB-' or 'SMacroNGeNB-' and ending with a 5 hexadecimal value or starting with 'LMacroNGeNB-' and ending with a 6 hexadecimal value"
        },
        "plmnId":{
            "$ref":"#/definitions/PlmnId"
        }
    },
    "title":"PresenceReportingAreaGlobalRanNodeIdList"
}

Nested Schema : GNbId

Type: object

Title: GNbId

Show Source

• bitLength: integer(int32)
• gNbValue: string
  You must enter 6 to 8 A-F or a-f letter or number.

{
    "type":"object",
    "required":[
        "bitLength",
        "gNbValue"
    ],
    "properties":{
        "bitLength":{
            "type":"integer",
            "format":"int32"
        },
        "gNbValue":{
            "type":"string",
            "description":"You must enter 6 to 8 A-F or a-f letter or number."
        }
    },
    "title":"GNbId"
}

Nested Schema : PresenceReportingAreaNcgiList

Type: object

Title: PresenceReportingAreaNcgiList

Show Source

• nrCellId(optional): string
  enter a 9 digit hexadecimal value
• plmnId(optional): object PlmnId
  Title: PlmnId

{
    "type":"object",
    "properties":{
        "nrCellId":{
            "type":"string",
            "description":"enter a 9 digit hexadecimal value"
        },
        "plmnId":{
            "$ref":"#/definitions/PlmnId"
        }
    },
    "title":"PresenceReportingAreaNcgiList"
}

Nested Schema : PresenceReportingAreaTrackingAreaList

Type: object

Title: PresenceReportingAreaTrackingAreaList

Show Source

• plmnId(optional): object PlmnId
  Title: PlmnId
• tac(optional): string
  enter a 4 or 6 digit hexadecimal value

{
    "type":"object",
    "properties":{
        "plmnId":{
            "$ref":"#/definitions/PlmnId"
        },
        "tac":{
            "type":"string",
            "description":"enter a 4 or 6 digit hexadecimal value"
        }
    },
    "title":"PresenceReportingAreaTrackingAreaList"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : PresenceReportingArea

Type: object

Title: PresenceReportingArea

Show Source

• ecgiList(optional): array ecgiList
• globalRanNodeIdList(optional): array globalRanNodeIdList
• name: string
• ncgiList(optional): array ncgiList
• praId: string
• presenceState(optional): string
  Allowed Values: [ "INACTIVE", "IN_AREA", "OUT_OF_AREA", "UNKNOWN" ]
• trackingAreaList(optional): array trackingAreaList

{
    "type":"object",
    "required":[
        "name",
        "praId"
    ],
    "properties":{
        "ecgiList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PresenceReportingAreaEcgiList"
            }
        },
        "globalRanNodeIdList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PresenceReportingAreaGlobalRanNodeIdList"
            }
        },
        "name":{
            "type":"string"
        },
        "ncgiList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PresenceReportingAreaNcgiList"
            }
        },
        "praId":{
            "type":"string"
        },
        "presenceState":{
            "type":"string",
            "enum":[
                "INACTIVE",
                "IN_AREA",
                "OUT_OF_AREA",
                "UNKNOWN"
            ]
        },
        "trackingAreaList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PresenceReportingAreaTrackingAreaList"
            }
        }
    },
    "title":"PresenceReportingArea"
}

Nested Schema : ecgiList

Type: array

Show Source

• Array of: object PresenceReportingAreaEcgiList
  Title: PresenceReportingAreaEcgiList

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PresenceReportingAreaEcgiList"
    }
}

Nested Schema : globalRanNodeIdList

Type: array

Show Source

• Array of: object PresenceReportingAreaGlobalRanNodeIdList
  Title: PresenceReportingAreaGlobalRanNodeIdList

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PresenceReportingAreaGlobalRanNodeIdList"
    }
}

Nested Schema : ncgiList

Type: array

Show Source

• Array of: object PresenceReportingAreaNcgiList
  Title: PresenceReportingAreaNcgiList

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PresenceReportingAreaNcgiList"
    }
}

Nested Schema : trackingAreaList

Type: array

Show Source

• Array of: object PresenceReportingAreaTrackingAreaList
  Title: PresenceReportingAreaTrackingAreaList

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PresenceReportingAreaTrackingAreaList"
    }
}

Nested Schema : PresenceReportingAreaEcgiList

Type: object

Title: PresenceReportingAreaEcgiList

Show Source

• eutraCellId(optional): string
  enter a 7 digit hexadecimal value
• plmnId: object PlmnId
  Title: PlmnId

{
    "type":"object",
    "required":[
        "plmnId"
    ],
    "properties":{
        "eutraCellId":{
            "type":"string",
            "description":"enter a 7 digit hexadecimal value"
        },
        "plmnId":{
            "$ref":"#/definitions/PlmnId"
        }
    },
    "title":"PresenceReportingAreaEcgiList"
}

Nested Schema : PlmnId

Type: object

Title: PlmnId

Show Source

• mcc: string
  enter a 3 digit number
• mnc: string
  enter a 2 or 3 digit number

{
    "type":"object",
    "required":[
        "mcc",
        "mnc"
    ],
    "properties":{
        "mcc":{
            "type":"string",
            "description":"enter a 3 digit number"
        },
        "mnc":{
            "type":"string",
            "description":"enter a 2 or 3 digit number"
        }
    },
    "title":"PlmnId"
}

Nested Schema : PresenceReportingAreaGlobalRanNodeIdList

Type: object

Title: PresenceReportingAreaGlobalRanNodeIdList

Show Source

• gNbId(optional): object GNbId
  Title: GNbId
• n3IwfId(optional): string
  enter a 1 or more digit hexadecimal value
• ngeNbId(optional): string
  Enter a value starting with 'MacroNGeNB-' or 'SMacroNGeNB-' and ending with a 5 hexadecimal value or starting with 'LMacroNGeNB-' and ending with a 6 hexadecimal value
• plmnId(optional): object PlmnId
  Title: PlmnId

{
    "type":"object",
    "properties":{
        "gNbId":{
            "$ref":"#/definitions/GNbId"
        },
        "n3IwfId":{
            "type":"string",
            "description":"enter a 1 or more digit hexadecimal value"
        },
        "ngeNbId":{
            "type":"string",
            "description":"Enter a value starting with 'MacroNGeNB-' or 'SMacroNGeNB-' and ending with a 5 hexadecimal value or starting with 'LMacroNGeNB-' and ending with a 6 hexadecimal value"
        },
        "plmnId":{
            "$ref":"#/definitions/PlmnId"
        }
    },
    "title":"PresenceReportingAreaGlobalRanNodeIdList"
}

Nested Schema : GNbId

Type: object

Title: GNbId

Show Source

• bitLength: integer(int32)
• gNbValue: string
  You must enter 6 to 8 A-F or a-f letter or number.

{
    "type":"object",
    "required":[
        "bitLength",
        "gNbValue"
    ],
    "properties":{
        "bitLength":{
            "type":"integer",
            "format":"int32"
        },
        "gNbValue":{
            "type":"string",
            "description":"You must enter 6 to 8 A-F or a-f letter or number."
        }
    },
    "title":"GNbId"
}

Nested Schema : PresenceReportingAreaNcgiList

Type: object

Title: PresenceReportingAreaNcgiList

Show Source

• nrCellId(optional): string
  enter a 9 digit hexadecimal value
• plmnId(optional): object PlmnId
  Title: PlmnId

{
    "type":"object",
    "properties":{
        "nrCellId":{
            "type":"string",
            "description":"enter a 9 digit hexadecimal value"
        },
        "plmnId":{
            "$ref":"#/definitions/PlmnId"
        }
    },
    "title":"PresenceReportingAreaNcgiList"
}

Nested Schema : PresenceReportingAreaTrackingAreaList

Type: object

Title: PresenceReportingAreaTrackingAreaList

Show Source

• plmnId(optional): object PlmnId
  Title: PlmnId
• tac(optional): string
  enter a 4 or 6 digit hexadecimal value

{
    "type":"object",
    "properties":{
        "plmnId":{
            "$ref":"#/definitions/PlmnId"
        },
        "tac":{
            "type":"string",
            "description":"enter a 4 or 6 digit hexadecimal value"
        }
    },
    "title":"PresenceReportingAreaTrackingAreaList"
}

201 Response

Created

Body ()

Root Schema : PresenceReportingArea

Type: object

Title: PresenceReportingArea

Show Source

• ecgiList(optional): array ecgiList
• globalRanNodeIdList(optional): array globalRanNodeIdList
• name: string
• ncgiList(optional): array ncgiList
• praId: string
• presenceState(optional): string
  Allowed Values: [ "INACTIVE", "IN_AREA", "OUT_OF_AREA", "UNKNOWN" ]
• trackingAreaList(optional): array trackingAreaList

{
    "type":"object",
    "required":[
        "name",
        "praId"
    ],
    "properties":{
        "ecgiList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PresenceReportingAreaEcgiList"
            }
        },
        "globalRanNodeIdList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PresenceReportingAreaGlobalRanNodeIdList"
            }
        },
        "name":{
            "type":"string"
        },
        "ncgiList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PresenceReportingAreaNcgiList"
            }
        },
        "praId":{
            "type":"string"
        },
        "presenceState":{
            "type":"string",
            "enum":[
                "INACTIVE",
                "IN_AREA",
                "OUT_OF_AREA",
                "UNKNOWN"
            ]
        },
        "trackingAreaList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PresenceReportingAreaTrackingAreaList"
            }
        }
    },
    "title":"PresenceReportingArea"
}

Nested Schema : ecgiList

Type: array

Show Source

• Array of: object PresenceReportingAreaEcgiList
  Title: PresenceReportingAreaEcgiList

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PresenceReportingAreaEcgiList"
    }
}

Nested Schema : globalRanNodeIdList

Type: array

Show Source

• Array of: object PresenceReportingAreaGlobalRanNodeIdList
  Title: PresenceReportingAreaGlobalRanNodeIdList

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PresenceReportingAreaGlobalRanNodeIdList"
    }
}

Nested Schema : ncgiList

Type: array

Show Source

• Array of: object PresenceReportingAreaNcgiList
  Title: PresenceReportingAreaNcgiList

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PresenceReportingAreaNcgiList"
    }
}

Nested Schema : trackingAreaList

Type: array

Show Source

• Array of: object PresenceReportingAreaTrackingAreaList
  Title: PresenceReportingAreaTrackingAreaList

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PresenceReportingAreaTrackingAreaList"
    }
}

Nested Schema : PresenceReportingAreaEcgiList

Type: object

Title: PresenceReportingAreaEcgiList

Show Source

• eutraCellId(optional): string
  enter a 7 digit hexadecimal value
• plmnId: object PlmnId
  Title: PlmnId

{
    "type":"object",
    "required":[
        "plmnId"
    ],
    "properties":{
        "eutraCellId":{
            "type":"string",
            "description":"enter a 7 digit hexadecimal value"
        },
        "plmnId":{
            "$ref":"#/definitions/PlmnId"
        }
    },
    "title":"PresenceReportingAreaEcgiList"
}

Nested Schema : PlmnId

Type: object

Title: PlmnId

Show Source

• mcc: string
  enter a 3 digit number
• mnc: string
  enter a 2 or 3 digit number

{
    "type":"object",
    "required":[
        "mcc",
        "mnc"
    ],
    "properties":{
        "mcc":{
            "type":"string",
            "description":"enter a 3 digit number"
        },
        "mnc":{
            "type":"string",
            "description":"enter a 2 or 3 digit number"
        }
    },
    "title":"PlmnId"
}

Nested Schema : PresenceReportingAreaGlobalRanNodeIdList

Type: object

Title: PresenceReportingAreaGlobalRanNodeIdList

Show Source

• gNbId(optional): object GNbId
  Title: GNbId
• n3IwfId(optional): string
  enter a 1 or more digit hexadecimal value
• ngeNbId(optional): string
  Enter a value starting with 'MacroNGeNB-' or 'SMacroNGeNB-' and ending with a 5 hexadecimal value or starting with 'LMacroNGeNB-' and ending with a 6 hexadecimal value
• plmnId(optional): object PlmnId
  Title: PlmnId

{
    "type":"object",
    "properties":{
        "gNbId":{
            "$ref":"#/definitions/GNbId"
        },
        "n3IwfId":{
            "type":"string",
            "description":"enter a 1 or more digit hexadecimal value"
        },
        "ngeNbId":{
            "type":"string",
            "description":"Enter a value starting with 'MacroNGeNB-' or 'SMacroNGeNB-' and ending with a 5 hexadecimal value or starting with 'LMacroNGeNB-' and ending with a 6 hexadecimal value"
        },
        "plmnId":{
            "$ref":"#/definitions/PlmnId"
        }
    },
    "title":"PresenceReportingAreaGlobalRanNodeIdList"
}

Nested Schema : GNbId

Type: object

Title: GNbId

Show Source

• bitLength: integer(int32)
• gNbValue: string
  You must enter 6 to 8 A-F or a-f letter or number.

{
    "type":"object",
    "required":[
        "bitLength",
        "gNbValue"
    ],
    "properties":{
        "bitLength":{
            "type":"integer",
            "format":"int32"
        },
        "gNbValue":{
            "type":"string",
            "description":"You must enter 6 to 8 A-F or a-f letter or number."
        }
    },
    "title":"GNbId"
}

Nested Schema : PresenceReportingAreaNcgiList

Type: object

Title: PresenceReportingAreaNcgiList

Show Source

• nrCellId(optional): string
  enter a 9 digit hexadecimal value
• plmnId(optional): object PlmnId
  Title: PlmnId

{
    "type":"object",
    "properties":{
        "nrCellId":{
            "type":"string",
            "description":"enter a 9 digit hexadecimal value"
        },
        "plmnId":{
            "$ref":"#/definitions/PlmnId"
        }
    },
    "title":"PresenceReportingAreaNcgiList"
}

Nested Schema : PresenceReportingAreaTrackingAreaList

Type: object

Title: PresenceReportingAreaTrackingAreaList

Show Source

• plmnId(optional): object PlmnId
  Title: PlmnId
• tac(optional): string
  enter a 4 or 6 digit hexadecimal value

{
    "type":"object",
    "properties":{
        "plmnId":{
            "$ref":"#/definitions/PlmnId"
        },
        "tac":{
            "type":"string",
            "description":"enter a 4 or 6 digit hexadecimal value"
        }
    },
    "title":"PresenceReportingAreaTrackingAreaList"
}

400 Response

Bad request

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Not Found

405 Response

Method Not Allowed

406 Response

Not Acceptable

408 Response

Request Timeout

409 Response

Conflict

412 Response

Precondition Failed

500 Response

Internal Server Error

503 Response

Service Unavailable

504 Response

Gateway Timeout

Back to Top