diff --git a/marked/Rel-18/25_series/25106/30a26f2d17ca95672702bf50fb4f0242_img.jpg b/marked/Rel-18/25_series/25106/30a26f2d17ca95672702bf50fb4f0242_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e6ff709151e7cfedc7d5362760d96df3f3c9b22f --- /dev/null +++ b/marked/Rel-18/25_series/25106/30a26f2d17ca95672702bf50fb4f0242_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:24d036488b888b43439969ac8e9c6fd0e164036d8d45be6a94920d752049463b +size 5148 diff --git a/marked/Rel-18/25_series/25106/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/25_series/25106/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fa046f17e44d05d0f3ff36db6a0628df7c5f4705 --- /dev/null +++ b/marked/Rel-18/25_series/25106/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2edb076fc92420df2cde182ac8fe64b5456fdb45f4bd30a3fe834b2e88e45830 +size 9482 diff --git a/marked/Rel-18/25_series/25106/a2f89834a149b852721f8887349fd6fa_img.jpg b/marked/Rel-18/25_series/25106/a2f89834a149b852721f8887349fd6fa_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f70dbf9076f1afea49f7935179f6e42ad4ea4b63 --- /dev/null +++ b/marked/Rel-18/25_series/25106/a2f89834a149b852721f8887349fd6fa_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0f40519e80ee247aef7a61c527eaa5416bd10ed6f889cb36a2f5b3bfc29d5036 +size 80732 diff --git a/marked/Rel-18/25_series/25153/031e354d9de9563c9f650e3e4fcba16d_img.jpg b/marked/Rel-18/25_series/25153/031e354d9de9563c9f650e3e4fcba16d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7344ed0bae7e229315e7efcdf482d046b88d758b --- /dev/null +++ b/marked/Rel-18/25_series/25153/031e354d9de9563c9f650e3e4fcba16d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cba5d9b0e702304fdce19d7b951d2015fd92f48c28e3e7810977cd3d030fc5cb +size 29988 diff --git a/marked/Rel-18/25_series/25153/036ceaf207a7b289ca76e160892eb724_img.jpg b/marked/Rel-18/25_series/25153/036ceaf207a7b289ca76e160892eb724_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2199624ada1593802c616826a4964370530ce26d --- /dev/null +++ b/marked/Rel-18/25_series/25153/036ceaf207a7b289ca76e160892eb724_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:74766422bf19712726c20b14355868cdba5e7ea9200395a54f5a3a3ef07c7994 +size 38547 diff --git a/marked/Rel-18/25_series/25153/080a7af02bc47cf21ebfae4e0be39745_img.jpg b/marked/Rel-18/25_series/25153/080a7af02bc47cf21ebfae4e0be39745_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..efd1c391ac538d91bd31a3ca41c64df300fefea4 --- /dev/null +++ b/marked/Rel-18/25_series/25153/080a7af02bc47cf21ebfae4e0be39745_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:242a5b609736bbaadecc4b93210f80b58e12b104fbac9d3f035bd1c5ae1604cf +size 17691 diff --git a/marked/Rel-18/25_series/25153/0892c0cb3b8502a44c4fe4e786be912a_img.jpg b/marked/Rel-18/25_series/25153/0892c0cb3b8502a44c4fe4e786be912a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e84279db64ebf7e45996b22bea53172489878977 --- /dev/null +++ b/marked/Rel-18/25_series/25153/0892c0cb3b8502a44c4fe4e786be912a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ce038e2b5804ef9c4473764c5c53916f96c1b67017acb4f039626b31eb497435 +size 32184 diff --git a/marked/Rel-18/25_series/25153/08e8bbb2a063a3935a0c649b39ade125_img.jpg b/marked/Rel-18/25_series/25153/08e8bbb2a063a3935a0c649b39ade125_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..26a4005815a39c7b8af03223e759d3b9ed4c73bd --- /dev/null +++ b/marked/Rel-18/25_series/25153/08e8bbb2a063a3935a0c649b39ade125_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:af1e7f91d029504857255058425e7b40a96df03377d58c8b8e5decf12a43f3a9 +size 22529 diff --git a/marked/Rel-18/25_series/25153/1bc74e8f6d9201dc09d80d17653a55db_img.jpg b/marked/Rel-18/25_series/25153/1bc74e8f6d9201dc09d80d17653a55db_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d6b1a22aa201e1f6e58a940e9f7974057f4cf63d --- /dev/null +++ b/marked/Rel-18/25_series/25153/1bc74e8f6d9201dc09d80d17653a55db_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:44986f0e29cc622c75bcb4f9e411af6a5d4e1d12b8fbb14c04d3a0c795120f4b +size 20139 diff --git a/marked/Rel-18/25_series/25153/1e8c50ad4fca7f315a407347dd5091cc_img.jpg b/marked/Rel-18/25_series/25153/1e8c50ad4fca7f315a407347dd5091cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bdca4f366d6ea17dc514810420fae1fee97283ed --- /dev/null +++ b/marked/Rel-18/25_series/25153/1e8c50ad4fca7f315a407347dd5091cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:439a968dc8523a13266e40211c417cb420641d710686415fda2aef7373d73357 +size 19286 diff --git a/marked/Rel-18/25_series/25153/30a26f2d17ca95672702bf50fb4f0242_img.jpg b/marked/Rel-18/25_series/25153/30a26f2d17ca95672702bf50fb4f0242_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c41fe7a46262d69158021d8211976adacaf91185 --- /dev/null +++ b/marked/Rel-18/25_series/25153/30a26f2d17ca95672702bf50fb4f0242_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c1354d74b38916480ccce27cb7d2de7aa459c08b26bd42a226509fb702e697cc +size 5218 diff --git a/marked/Rel-18/25_series/25153/30a91d1c3ead5af4823f4f3330e4ac1e_img.jpg b/marked/Rel-18/25_series/25153/30a91d1c3ead5af4823f4f3330e4ac1e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d4d47814624d70f3b586a3b185d7c52c46c23fe5 --- /dev/null +++ b/marked/Rel-18/25_series/25153/30a91d1c3ead5af4823f4f3330e4ac1e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0595d351c0915e2c48ac9730f87d9d4ffd90475888a2e8d5cbec2f82859ba61b +size 16450 diff --git a/marked/Rel-18/25_series/25153/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/25_series/25153/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9350aa6b76d40ec33bd014b7b7c1e5d300f1ae96 --- /dev/null +++ b/marked/Rel-18/25_series/25153/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:070e353684c451244b3bab5ebe5ab6181e1bbe0bbfe6d72d64c1c05df71b98b7 +size 7471 diff --git a/marked/Rel-18/25_series/25153/a3083eec2a883ee8327b3c24174df6a9_img.jpg b/marked/Rel-18/25_series/25153/a3083eec2a883ee8327b3c24174df6a9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9f8ed96829ef140275d542e4dfdf6303f3719ee7 --- /dev/null +++ b/marked/Rel-18/25_series/25153/a3083eec2a883ee8327b3c24174df6a9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:38508aa21da42815671400a17e5e12b8af6864733ca28d260043730840e15b9c +size 29682 diff --git a/marked/Rel-18/25_series/25153/bd4c85f71b8f5e06d935a6240b6dab56_img.jpg b/marked/Rel-18/25_series/25153/bd4c85f71b8f5e06d935a6240b6dab56_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..07f2d4e9d714893a765cc6eda3072964f1b1cf79 --- /dev/null +++ b/marked/Rel-18/25_series/25153/bd4c85f71b8f5e06d935a6240b6dab56_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7fe96ffd113db2c9420d851c1c0905446e4d37d77820623c58a9174fed03631e +size 18750 diff --git a/marked/Rel-18/25_series/25153/c1278da91cbcabe32628e589ebc47418_img.jpg b/marked/Rel-18/25_series/25153/c1278da91cbcabe32628e589ebc47418_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5d21cdcc95813e77624ac2a3f0447891b2d723e2 --- /dev/null +++ b/marked/Rel-18/25_series/25153/c1278da91cbcabe32628e589ebc47418_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1af7fd2fd1b6649174f9f8f4bea0132df6ce0df1279df47ddff388408ef73b05 +size 20653 diff --git a/marked/Rel-18/25_series/25153/cdd9c57c9c578160002ead5cdaef414d_img.jpg b/marked/Rel-18/25_series/25153/cdd9c57c9c578160002ead5cdaef414d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0f150b6599d35297477e8a178670cd64b7ef38c4 --- /dev/null +++ b/marked/Rel-18/25_series/25153/cdd9c57c9c578160002ead5cdaef414d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:07486f1920fb7ffec08b8ae442e350b186d2aef3998a66924644001d9c5b068a +size 27007 diff --git a/marked/Rel-18/25_series/25153/d99a54a2d327cbeae6f5a3abd0c978ad_img.jpg b/marked/Rel-18/25_series/25153/d99a54a2d327cbeae6f5a3abd0c978ad_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1422abc4a097650d9646a12d07b00ea6b55d636f --- /dev/null +++ b/marked/Rel-18/25_series/25153/d99a54a2d327cbeae6f5a3abd0c978ad_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aeb736b8cf5c596b1df005ef235be00a2ffb24fa0a9473b6e82876aad6c901da +size 15570 diff --git a/marked/Rel-18/25_series/25215/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/25_series/25215/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..afdb82952f7cbabcd9af54194921405894eca285 --- /dev/null +++ b/marked/Rel-18/25_series/25215/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9b6894d381f7c927e149fe2aaf4be1270fc4163f7d8ee828e00b8ace0c63c071 +size 7750 diff --git a/marked/Rel-18/25_series/25215/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg b/marked/Rel-18/25_series/25215/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f7c7305d3ac68a7a7af12901ba5449da399a6241 --- /dev/null +++ b/marked/Rel-18/25_series/25215/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4f5f43133fe3168e7f59e85036f4413d35e09f99d96f3c9b3352383e37e836cf +size 46672 diff --git a/marked/Rel-18/25_series/25367/1439cb942d9e363bbb3161b5540dd8c6_img.jpg b/marked/Rel-18/25_series/25367/1439cb942d9e363bbb3161b5540dd8c6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..17e5b4b6120183cd8e8d2f1ef933c235767f90f6 --- /dev/null +++ b/marked/Rel-18/25_series/25367/1439cb942d9e363bbb3161b5540dd8c6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:21c3516baf64a50045e71a716416b1c2c749399e506610f4378ad39e404fb33f +size 77944 diff --git a/marked/Rel-18/25_series/25367/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/25_series/25367/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5ac40cbf33edcbd49f51627b2cb727bd385e9776 --- /dev/null +++ b/marked/Rel-18/25_series/25367/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:18ebfab88a9a63ecac95673e5da6b633fecaa0446274b19da935776741a1043a +size 8036 diff --git a/marked/Rel-18/25_series/25367/d26959f4514c26ca19c3d6f00da85956_img.jpg b/marked/Rel-18/25_series/25367/d26959f4514c26ca19c3d6f00da85956_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..513a278655a0c067de38a9de8c13cc0a84d0645a --- /dev/null +++ b/marked/Rel-18/25_series/25367/d26959f4514c26ca19c3d6f00da85956_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f86715baaf2ed07a85fe20624b5c4407ba2f4f3a0d7cf0831ab5e4e78dd46be5 +size 53150 diff --git a/marked/Rel-18/25_series/25410/49a49278cad196bdfe0db6b4dd1be7fd_img.jpg b/marked/Rel-18/25_series/25410/49a49278cad196bdfe0db6b4dd1be7fd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6c9723ace058a5b10ceaf845d4297de890899272 --- /dev/null +++ b/marked/Rel-18/25_series/25410/49a49278cad196bdfe0db6b4dd1be7fd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:57adf8dbb2b5cde70b89bada0a08eed564c8f3f85605bb4d7f836d48e16e0e64 +size 100735 diff --git a/marked/Rel-18/25_series/25410/4cde160bcc69b7b6c81b648dd0e4252e_img.jpg b/marked/Rel-18/25_series/25410/4cde160bcc69b7b6c81b648dd0e4252e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c1c56657a1b75e05f579a9858d0d23d0bcd8a158 --- /dev/null +++ b/marked/Rel-18/25_series/25410/4cde160bcc69b7b6c81b648dd0e4252e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a69786f002e85052dea1d7d94ebf0b7e62b01ca3db225d5a8838e575b392e168 +size 126957 diff --git a/marked/Rel-18/25_series/25410/5a9282ac54ca7bc50f1d2ab6cfb376ba_img.jpg b/marked/Rel-18/25_series/25410/5a9282ac54ca7bc50f1d2ab6cfb376ba_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..927b8a836e225f9558197d6cc77442b693b450bd --- /dev/null +++ b/marked/Rel-18/25_series/25410/5a9282ac54ca7bc50f1d2ab6cfb376ba_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2f9050e54938da2302076b3aea7a9183f5d2f8e5a2a469d9f3621a82ed0b0ead +size 55880 diff --git a/marked/Rel-18/25_series/25410/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/25_series/25410/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dc350895f79a0bd13ecbae7c8f46e154d52a9b22 --- /dev/null +++ b/marked/Rel-18/25_series/25410/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c0f5a67dc4e349199cd63fdd70d17eb7000dd871a29096d451436035dd0fc6d6 +size 9553 diff --git a/marked/Rel-18/25_series/25410/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/25_series/25410/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cf7fb29a2201d28919e2df63eb9f586ed6e3c0b6 --- /dev/null +++ b/marked/Rel-18/25_series/25410/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:880541df7cbf6529bfe62771b2a7ce40bc0d2d4def89c6913dc33f5b351b249f +size 7137 diff --git a/marked/Rel-18/25_series/25410/90ddb84c323b956e2d50a54d3f870566_img.jpg b/marked/Rel-18/25_series/25410/90ddb84c323b956e2d50a54d3f870566_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..82df4188a10b1d6dc1ff4fc08f0620fc26c88857 --- /dev/null +++ b/marked/Rel-18/25_series/25410/90ddb84c323b956e2d50a54d3f870566_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e5d4dd6cf210907c5aedb8f1ce427c38710157f79b02c7d1201924b0471ad72a +size 48367 diff --git a/marked/Rel-18/25_series/25410/a0739aaf13fa5a632d4faa830f6b2708_img.jpg b/marked/Rel-18/25_series/25410/a0739aaf13fa5a632d4faa830f6b2708_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5872912d6819142b27c312fd37edca360daf3d2e --- /dev/null +++ b/marked/Rel-18/25_series/25410/a0739aaf13fa5a632d4faa830f6b2708_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5470ee3010bbfe94399b36dd20407afed46d7d18d2518e539a5b8a7320539925 +size 124747 diff --git a/marked/Rel-18/25_series/25410/a26e142d3df5bef41a84a9dd099d7825_img.jpg b/marked/Rel-18/25_series/25410/a26e142d3df5bef41a84a9dd099d7825_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b2dc6e3de529f0853bdd680a88bbe81319067416 --- /dev/null +++ b/marked/Rel-18/25_series/25410/a26e142d3df5bef41a84a9dd099d7825_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7fd5e42ebbc50cc7de1919bf269eed72faf1a5a2d9d432557b3ab928371699d9 +size 55549 diff --git a/marked/Rel-18/25_series/25410/b28af4985cdef1e519e3aaf26561dcb3_img.jpg b/marked/Rel-18/25_series/25410/b28af4985cdef1e519e3aaf26561dcb3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..321afa718f082adf9ea09bcb0b696f8226cebcfe --- /dev/null +++ b/marked/Rel-18/25_series/25410/b28af4985cdef1e519e3aaf26561dcb3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d4d9ea3ecf29e5f8d23b33881bc1b60b1a6cea08f85441b752d0dd147d7906ed +size 58822 diff --git a/marked/Rel-18/25_series/25419/10781f43062bf3e9601a1e086710556c_img.jpg b/marked/Rel-18/25_series/25419/10781f43062bf3e9601a1e086710556c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..38a01d0933380d84e1bd5b6bb5f6622d4e325693 --- /dev/null +++ b/marked/Rel-18/25_series/25419/10781f43062bf3e9601a1e086710556c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:680aae2be030f0bae9f19f7df929b41a9404890bd57e168d50315cce56e847e9 +size 9955 diff --git a/marked/Rel-18/25_series/25419/124c6108c63173818afb8ed49521e22d_img.jpg b/marked/Rel-18/25_series/25419/124c6108c63173818afb8ed49521e22d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9785585cece0953c4342f3a25220d5f0e00b84d7 --- /dev/null +++ b/marked/Rel-18/25_series/25419/124c6108c63173818afb8ed49521e22d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9ca4532e3c48c2e2892ef6f9906e59622a375e4e11f81d69035a3bf979cead2e +size 9453 diff --git a/marked/Rel-18/25_series/25419/16152cf1d84aea10848758f51a91ff6a_img.jpg b/marked/Rel-18/25_series/25419/16152cf1d84aea10848758f51a91ff6a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..805ae89409efce2340b6b425a901800f696729a5 --- /dev/null +++ b/marked/Rel-18/25_series/25419/16152cf1d84aea10848758f51a91ff6a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ba5c4637a2c92c3d41470971fa68a280406a593afa7180910a43d331f0c9241d +size 18771 diff --git a/marked/Rel-18/25_series/25419/29f586959675cafdf81cf934954908eb_img.jpg b/marked/Rel-18/25_series/25419/29f586959675cafdf81cf934954908eb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e4b3e52f18b87372bed2b70234e1ea7169edc769 --- /dev/null +++ b/marked/Rel-18/25_series/25419/29f586959675cafdf81cf934954908eb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a19b6cf1647cf89a94206703e4593d7dda6bc9b610d31a8902dba6285ff0fe67 +size 14803 diff --git a/marked/Rel-18/25_series/25419/4aa740e8119817a3f9b9f72d06eaa53d_img.jpg b/marked/Rel-18/25_series/25419/4aa740e8119817a3f9b9f72d06eaa53d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..461dd7afef0bed21867b1f1bdd9d899182feb7ca --- /dev/null +++ b/marked/Rel-18/25_series/25419/4aa740e8119817a3f9b9f72d06eaa53d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fc6815d03867e350eda970c9090a634ecc3c3f03ab3e31afc76cb191e649ff07 +size 14798 diff --git a/marked/Rel-18/25_series/25419/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/25_series/25419/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dc350895f79a0bd13ecbae7c8f46e154d52a9b22 --- /dev/null +++ b/marked/Rel-18/25_series/25419/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c0f5a67dc4e349199cd63fdd70d17eb7000dd871a29096d451436035dd0fc6d6 +size 9553 diff --git a/marked/Rel-18/25_series/25419/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/25_series/25419/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..94e875029cc4f7f66b42fcf477e061e8c8cd52ff --- /dev/null +++ b/marked/Rel-18/25_series/25419/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:83edb64c7d9679a29444a4bc2b67b1e9970f13083ed317f318ae460b50191e9d +size 5460 diff --git a/marked/Rel-18/25_series/25419/66c2bf11a8f117cddf67eff92d4c736c_img.jpg b/marked/Rel-18/25_series/25419/66c2bf11a8f117cddf67eff92d4c736c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..652305e86a601ed56e0ff7b20eeb23211a44bfe5 --- /dev/null +++ b/marked/Rel-18/25_series/25419/66c2bf11a8f117cddf67eff92d4c736c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cdc63f7c493052c0255f71a19e273a32bf8a2657723a28533a4a4a5e5e38463c +size 15400 diff --git a/marked/Rel-18/25_series/25419/6b9ee906d502aece4a2becf5895db07a_img.jpg b/marked/Rel-18/25_series/25419/6b9ee906d502aece4a2becf5895db07a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..090adfdf3021ff60e423bb28b0477d9775ded432 --- /dev/null +++ b/marked/Rel-18/25_series/25419/6b9ee906d502aece4a2becf5895db07a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:408fdde85d26cab0086acfab8067f616e3d1459b7a8eb2c2ebd596557ef4e1d9 +size 21926 diff --git a/marked/Rel-18/25_series/25419/76d19e4271bf243b20d55a98efd51483_img.jpg b/marked/Rel-18/25_series/25419/76d19e4271bf243b20d55a98efd51483_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8a3aecbba7a10ececee683165507dce296c67385 --- /dev/null +++ b/marked/Rel-18/25_series/25419/76d19e4271bf243b20d55a98efd51483_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:01cd3964282ac1c5152e86f7e776fa949b45b552117482035b5ccd57719a2e41 +size 74046 diff --git a/marked/Rel-18/25_series/25419/78ffccd66df9bafd96e3e081110d09dd_img.jpg b/marked/Rel-18/25_series/25419/78ffccd66df9bafd96e3e081110d09dd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9780f6ba2e9bba8197845d53e8ef523a744ecc8d --- /dev/null +++ b/marked/Rel-18/25_series/25419/78ffccd66df9bafd96e3e081110d09dd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1cb952b3b2ae934d89d0c46898ae56621097dfcf6cc3266876974aa49b52ce79 +size 15460 diff --git a/marked/Rel-18/25_series/25419/9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg b/marked/Rel-18/25_series/25419/9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..39957d8f4934437322a81ddded5709e3dd662c4d --- /dev/null +++ b/marked/Rel-18/25_series/25419/9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3a93844f8a650d8d92ebb1a497b80ea338b699ffe0fab591bce273982d7296ba +size 14467 diff --git a/marked/Rel-18/25_series/25419/9cb54072e43a6b6717eb16036a7640a2_img.jpg b/marked/Rel-18/25_series/25419/9cb54072e43a6b6717eb16036a7640a2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..049bef6faad9ba768fe888396f7234f5ce0c3fe0 --- /dev/null +++ b/marked/Rel-18/25_series/25419/9cb54072e43a6b6717eb16036a7640a2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d761ad96ab47f91521058d06d2221087d5354ebb2124ad2e135d3bd6d33ba447 +size 73419 diff --git a/marked/Rel-18/25_series/25419/a9159a006d67a834a7b1a771c18191cc_img.jpg b/marked/Rel-18/25_series/25419/a9159a006d67a834a7b1a771c18191cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c30e2c8009426125e226b11db12e93472def32f7 --- /dev/null +++ b/marked/Rel-18/25_series/25419/a9159a006d67a834a7b1a771c18191cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8e6431895ef962bd372b89fce504becffc82cac3c09fdfd1dac66f2bde8b132c +size 73858 diff --git a/marked/Rel-18/25_series/25419/b0988cfd9f60f2cd1916e3c2f9cae3da_img.jpg b/marked/Rel-18/25_series/25419/b0988cfd9f60f2cd1916e3c2f9cae3da_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..be4c0eb089560f881471c1c72ef149d8f9ce4e86 --- /dev/null +++ b/marked/Rel-18/25_series/25419/b0988cfd9f60f2cd1916e3c2f9cae3da_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:456f967328ec42dea00077c0a85781dd6ce5d99e89dc87200f893b2bbce20c67 +size 73332 diff --git a/marked/Rel-18/25_series/25419/bd671b21db63e6fdb2196e9b18502aac_img.jpg b/marked/Rel-18/25_series/25419/bd671b21db63e6fdb2196e9b18502aac_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6eb30b8e2182fdad0187ce8f87844b499df5c650 --- /dev/null +++ b/marked/Rel-18/25_series/25419/bd671b21db63e6fdb2196e9b18502aac_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:506f386adf19cc7032145520867eea8eeb6fd93ee6064d7c477b8f9374b80340 +size 11438 diff --git a/marked/Rel-18/25_series/25419/bfca6639dd4b8480f2d96d2b61c806d9_img.jpg b/marked/Rel-18/25_series/25419/bfca6639dd4b8480f2d96d2b61c806d9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..668e10c8913c82e32c0f52e17ee2168a196b8a17 --- /dev/null +++ b/marked/Rel-18/25_series/25419/bfca6639dd4b8480f2d96d2b61c806d9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2bc2e0a2c3591efc1a0e46e4a2099debadf34bb3e27ba8bc1e1c3a7fe83ae054 +size 87383 diff --git a/marked/Rel-18/25_series/25419/c649cad02e45d7d9a16f3f5bdb332219_img.jpg b/marked/Rel-18/25_series/25419/c649cad02e45d7d9a16f3f5bdb332219_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..54410c504c996d65a83ea961d2b5a409e6c60a1f --- /dev/null +++ b/marked/Rel-18/25_series/25419/c649cad02e45d7d9a16f3f5bdb332219_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a0c5e0f657bd449477500edc1bc8c88f5c9df2bc1e7255156d14c40fa79d629f +size 74376 diff --git a/marked/Rel-18/25_series/25419/cf4ac1058c52bc3ca37737740afb7f2c_img.jpg b/marked/Rel-18/25_series/25419/cf4ac1058c52bc3ca37737740afb7f2c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..209c7d47adf497d657efc17280a118d8bf8afc01 --- /dev/null +++ b/marked/Rel-18/25_series/25419/cf4ac1058c52bc3ca37737740afb7f2c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a12f8e4a2eac1b1a0ed2b8379d73b239fffa869cf331a1457abb6295360df004 +size 11366 diff --git a/marked/Rel-18/25_series/25419/d26959f4514c26ca19c3d6f00da85956_img.jpg b/marked/Rel-18/25_series/25419/d26959f4514c26ca19c3d6f00da85956_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d8c3de895f1cdfcd080ab7bdcc36674068342a1c --- /dev/null +++ b/marked/Rel-18/25_series/25419/d26959f4514c26ca19c3d6f00da85956_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7916254fb671d46fed56d21d29f06802c517b7962c21e660ad20df1e76e25427 +size 14944 diff --git a/marked/Rel-18/25_series/25419/e9d825d87c5f85c8dba0664eace96ef4_img.jpg b/marked/Rel-18/25_series/25419/e9d825d87c5f85c8dba0664eace96ef4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3e590be53f87eab424bd11e021998187bcd8d217 --- /dev/null +++ b/marked/Rel-18/25_series/25419/e9d825d87c5f85c8dba0664eace96ef4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b5b77a4699543ff0fa3e39211840c250f8a6521f6172c7e2639485d357d75190 +size 12351 diff --git a/marked/Rel-18/25_series/25419/f57a881fcbcaf494a7dedc4f61224991_img.jpg b/marked/Rel-18/25_series/25419/f57a881fcbcaf494a7dedc4f61224991_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..234ac7c612b0b6959255b7ab03f09bce211b8df6 --- /dev/null +++ b/marked/Rel-18/25_series/25419/f57a881fcbcaf494a7dedc4f61224991_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2f34b9e0dcb106142f97b94ec908a691dfe87daf39102515f0a96ac6df90b76b +size 19209 diff --git a/marked/Rel-18/25_series/25421/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/25_series/25421/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4e027e0f84975dcb4761cb5b6c3143df967b5869 --- /dev/null +++ b/marked/Rel-18/25_series/25421/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5543341caa32b4c0dac9cfe4f1a490e54386d139dbb7c82c200f2bef7f7e299f +size 9865 diff --git a/marked/Rel-18/25_series/25421/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/25_series/25421/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c3ffba24d84fc213e7e60176b1c9e5add6b6e488 --- /dev/null +++ b/marked/Rel-18/25_series/25421/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1f0ac36a8cbcc6bd0c224e94c9af5fa1664809cc36f97a8cd519ef8c1f460518 +size 6327 diff --git a/marked/Rel-18/25_series/25426/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/25_series/25426/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4e027e0f84975dcb4761cb5b6c3143df967b5869 --- /dev/null +++ b/marked/Rel-18/25_series/25426/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5543341caa32b4c0dac9cfe4f1a490e54386d139dbb7c82c200f2bef7f7e299f +size 9865 diff --git a/marked/Rel-18/25_series/25426/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/25_series/25426/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5dd5822d2635ce987dc5ea6653f8e1e4bcbb479b --- /dev/null +++ b/marked/Rel-18/25_series/25426/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:25e1ec04c6289ec979704072284cb742d8ea793c824afc4d304b626093a71c13 +size 6368 diff --git a/marked/Rel-18/25_series/25426/731f533b0599c8e42a063f06e4332045_img.jpg b/marked/Rel-18/25_series/25426/731f533b0599c8e42a063f06e4332045_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9acd63c4c72c64c2b2b4cf5a6c2bc50e4b8aadf1 --- /dev/null +++ b/marked/Rel-18/25_series/25426/731f533b0599c8e42a063f06e4332045_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9644517ad2064a1fa270234ba821369da1a177591965feefb84ab713784f902a +size 62770 diff --git a/marked/Rel-18/25_series/25426/7e670a2b556b53ea9002dfff3a420e08_img.jpg b/marked/Rel-18/25_series/25426/7e670a2b556b53ea9002dfff3a420e08_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..57c1d307a7c5c96aff5f492c32cd3eab638c07d3 --- /dev/null +++ b/marked/Rel-18/25_series/25426/7e670a2b556b53ea9002dfff3a420e08_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fdc83a904bb56cdb9b6895cbc9cbd24af07374f32bb6a5f397cf02addf69460c +size 68763 diff --git a/marked/Rel-18/25_series/25426/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg b/marked/Rel-18/25_series/25426/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7dd289da1e1074571e23bbaaec2ce7a21e7a2188 --- /dev/null +++ b/marked/Rel-18/25_series/25426/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:55f46582c9da4f0e12f4de5620757e62f869a12f9f3841bf9eb2dac17fc9c60d +size 27803 diff --git a/marked/Rel-18/25_series/25442/47e8c2042061e08a14e012472e9fdbaa_img.jpg b/marked/Rel-18/25_series/25442/47e8c2042061e08a14e012472e9fdbaa_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..403c4fa679f91afb4913f59d092d80797b1d1296 --- /dev/null +++ b/marked/Rel-18/25_series/25442/47e8c2042061e08a14e012472e9fdbaa_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9581d276fe578cb9bdd84e227aa4765349f7c3229585bfa8a857ec5f70a34cc8 +size 82726 diff --git a/marked/Rel-18/25_series/25442/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/25_series/25442/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2f3d3dcf850c18e15841afb2eacaa3ac179a905f --- /dev/null +++ b/marked/Rel-18/25_series/25442/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e3682ec5eda7280c6dfd88735940eac7bcda48b88e9f6ff73d755df49f33abd4 +size 6262 diff --git a/marked/Rel-18/25_series/25444/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/25_series/25444/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4e027e0f84975dcb4761cb5b6c3143df967b5869 --- /dev/null +++ b/marked/Rel-18/25_series/25444/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5543341caa32b4c0dac9cfe4f1a490e54386d139dbb7c82c200f2bef7f7e299f +size 9865 diff --git a/marked/Rel-18/25_series/25444/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/25_series/25444/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6b3383eeb58b56b207c0091f9baf0bb24c2b992f --- /dev/null +++ b/marked/Rel-18/25_series/25444/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4e6bbde0457f46821b95aceb43f14ba073dd553da90aeff329f2804e8bae8e6c +size 6199 diff --git a/marked/Rel-18/25_series/25444/7affafe7362a2d2d072e9d4bf515f0bb_img.jpg b/marked/Rel-18/25_series/25444/7affafe7362a2d2d072e9d4bf515f0bb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ba66fb2c50e02e8e56d2f791cf47a6735170400e --- /dev/null +++ b/marked/Rel-18/25_series/25444/7affafe7362a2d2d072e9d4bf515f0bb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e1abb7de128b7e0e284dbed8a7b372667f31fa7ccf942d84a936b60c202514b5 +size 74463 diff --git a/marked/Rel-18/29_series/29109/raw.md b/marked/Rel-18/29_series/29109/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..2c1d209c57da7b632e9ffc18c6b2bbbf607615f3 --- /dev/null +++ b/marked/Rel-18/29_series/29109/raw.md @@ -0,0 +1,3505 @@ +# 3GPP TS 29.109 V18.1.0 (2025-06) + +Technical Specification + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Generic Authentication Architecture (GAA); Zh and Zn Interfaces based on the Diameter protocol; Stage 3 (Release 18)** + +![5G ADVANCED logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G ADVANCED logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'P' has a red signal wave icon at its base. + +3GPP logo + +A GLOBAL INITIATIVE + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | | +|----------|-------------------------------------------------------------------------|----| +| 1 | Scope..... | 5 | +| 2 | References..... | 9 | +| 3 | Definitions, symbols and abbreviations ..... | 11 | +| 3.1 | Definitions ..... | 11 | +| 3.2 | Symbols..... | 11 | +| 3.3 | Abbreviations ..... | 12 | +| 4 | GBA Bootstrapping Zh interface and Zh' interface ..... | 13 | +| 4.1 | Generic bootstrapping network architecture ..... | 13 | +| 4.2 | Protocol Zh between BSF and HSS ..... | 13 | +| 4.3 | Protocol Zh' between BSF and HLR..... | 18 | +| 4.3.1 | Public to Private Identity Resolution over Zh between BSF and HLR ..... | 19 | +| 5 | GAA Application Zn and Zpn interfaces..... | 21 | +| 5.1 | Applications' network architecture ..... | 21 | +| 5.2 | Protocol Zn between NAF and BSF based on Diameter..... | 22 | +| 5.3 | Protocol Zn between NAF and BSF based on Web Services ..... | 25 | +| 5.4 | Protocol Zpn between NAF and BSF based on Diameter..... | 28 | +| 5.5 | Protocol Zpn between NAF and BSF based on Web Services ..... | 32 | +| 6 | Diameter application for Zh, Zn and Zpn interfaces..... | 35 | +| 6.0 | Introduction ..... | 35 | +| 6.1 | Command-Code values ..... | 35 | +| 6.2 | Result-Code AVP values..... | 35 | +| 6.2.1 | Success ..... | 35 | +| 6.2.2 | Permanent failures ..... | 35 | +| 6.2.2.1 | DIAMETER_ERROR_IDENTITY_UNKNOWN (5401) ..... | 35 | +| 6.2.2.2 | DIAMETER_ERROR_NOT_AUTHORIZED (5402)..... | 36 | +| 6.2.2.3 | DIAMETER_ERROR_TRANSACTION_IDENTIFIER_INVALID (5403) ..... | 36 | +| 6.2.2.4 | Void ..... | 36 | +| 6.2.2.5 | Void ..... | 36 | +| 6.2.2.6 | Void ..... | 36 | +| 6.2.2.7 | Void ..... | 36 | +| 6.3 | AVPs ..... | 37 | +| 6.3.1 | Common AVPs..... | 38 | +| 6.3.1.1 | GBA-UserSecSettings AVP ..... | 38 | +| 6.3.1.2 | Transaction-Identifier AVP ..... | 38 | +| 6.3.1.3 | NAF-Id..... | 38 | +| 6.3.1.4 | GAA-Service-Identifier AVP ..... | 38 | +| 6.3.1.5 | Key-ExpiryTime AVP..... | 38 | +| 6.3.1.6 | ME-Key-Material AVP..... | 38 | +| 6.3.1.7 | UICC-Key-Material AVP ..... | 38 | +| 6.3.1.8 | GBA_U-Awareness-Indicator ..... | 38 | +| 6.3.1.9 | BootstrapInfoCreationTime AVP ..... | 39 | +| 6.3.1.10 | GUSS-Timestamp AVP..... | 39 | +| 6.3.1.11 | GBA-Type ..... | 39 | +| 6.3.1.12 | UE-Id ..... | 39 | +| 6.3.1.13 | UE-Id-Type ..... | 39 | +| 6.3.1.14 | UICC-App-Label ..... | 39 | +| 6.3.1.15 | UICC-ME..... | 39 | +| 6.3.1.16 | Requested-Key-Lifetime..... | 39 | +| 6.3.1.17 | Private-Identity-Request ..... | 40 | +| 6.3.1.18 | GBA-Push-Info ..... | 40 | +| 6.3.1.19 | NAF-SA-Identifier ..... | 40 | +| 6.3.1.20 | Security-Feature-Request..... | 40 | +| 6.3.1.21 | Security-Feature-Response ..... | 40 | +| 6.3.1.22 | SHA-256-Indication..... | 40 | + +| | | | +|-------------------------------|-----------------------------------------------------------------|-----------| +| 6.4 | User identity to HSS resolution..... | 40 | +| 7 | Use of namespaces..... | 42 | +| 7.1 | AVP codes..... | 42 | +| 7.2 | Experimental-Result-Code AVP values..... | 42 | +| 7.3 | Command Code values..... | 42 | +| Annex A (normative): | GBA-UserSecSettings XML definition..... | 43 | +| Annex B (normative): | GAA Service Type Codes ..... | 48 | +| Annex C (normative): | GAA Authorization flag codes ..... | 48 | +| Annex D (normative): | Web Services Definition for Zn interface..... | 49 | +| Annex E (informative): | Liberty authentication context definitions for GBA ..... | 50 | +| E.1 | Introduction..... | 50 | +| E.2 | GBA Authentication context statement data model..... | 50 | +| E.3 | GBA authentication context statement schema ..... | 51 | +| E.4 | GBA authentication context classes..... | 52 | +| E.4.1 | GBAOneFactorUnregistered..... | 52 | +| E.4.1.1 | Associated 3GPP URI ..... | 52 | +| E.4.1.2 | Class schema ..... | 53 | +| E.4.2 | GBATwoFactorUnregistered ..... | 53 | +| E.4.2.1 | Associated 3GPP URI ..... | 53 | +| E.4.2.2 | Class schema ..... | 53 | +| E.4.3 | GBAOneFactorContract..... | 54 | +| E.4.3.1 | Associated 3GPP URI ..... | 54 | +| E.4.3.2 | Class schema ..... | 54 | +| E.4.4 | GBATwoFactorContract..... | 55 | +| E.4.4.1 | Associated 3GPP URI ..... | 55 | +| E.4.4.2 | Class schema ..... | 55 | +| Annex F (informative): | SAML authentication context definitions for GBA ..... | 56 | +| F.1 | Introduction..... | 56 | +| F.2 | GBA authentication context declaration data model ..... | 56 | +| F.3 | GBA authentication context declaration types..... | 57 | +| F.4 | GBA authentication context declaration classes..... | 58 | +| F.4.1 | GBAOneFactorUnregistered..... | 58 | +| F.4.1.1 | Associated 3GPP URI ..... | 58 | +| F.4.1.2 | Class schema ..... | 58 | +| F.4.2 | GBATwoFactorUnregistered ..... | 61 | +| F.4.2.1 | Associated 3GPP URI ..... | 61 | +| F.4.2.2 | Class schema ..... | 61 | +| F.4.3 | GBAOneFactorContract..... | 63 | +| F.4.3.1 | Associated 3GPP URI ..... | 63 | +| F.4.3.2 | Class schema ..... | 63 | +| F.4.4 | GBATwoFactorContract..... | 65 | +| F.4.4.1 | Associated 3GPP URI ..... | 65 | +| F.4.4.2 | Class schema ..... | 65 | +| Annex G (normative): | Web Services Definition for Zpn interface ..... | 68 | +| Annex H (informative): | Change history..... | 69 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present stage 3 specification defines the Diameter based implementation for bootstrapping Zh interface (BSF-HSS) and Dz interface (BSF-SLF) for HSS resolution for the BSF, the MAP based implementation for bootstrapping Zh' interface (BSF-HLR) and GAA Application Zn interface (BSF-NAF) in Generic Authentication Architecture (GAA). This specification also defines the Web Services based implementation for GAA Application Zn reference point (BSF-NAF). The definition contains procedures, message contents and coding. The procedures for bootstrapping and usage of bootstrapped security association are defined in 3GPP TS 33.220 [5]. + +The present document also specifies the Diameter and Web Services based implementation for the GAA Application Push Function Zpn reference point (BSF-NAF). The procedures for bootstrapping are defined in 3GPP TS 33.223 [23]. + +This specification is a part of the Generic Authentication Architecture (GAA) specification series. + +The diameter based implementation for the Zh interface is based on re-usage of Cx interface Multimedia-Auth-Request/Answer messages originally between CSCF and HSS. These messages are defined in 3GPP TS 29.229 [3]. The 3GPP IMS mobility management uses the same definitions between CSCF and HSS. The present document defines how the defined messages are used with the bootstrapping and GAA application procedures (e.g. subscriber certificates) and the application logic that is needed in GAA network elements (BSF, HSS, and NAF). + +Figure 1.1 depicts the relationships of these specifications to the other specifications for the Diameter based implementations. + +![Diagram showing relationships between 3GPP and IETF specifications for Diameter-based implementations. It is organized into layers: Stage 2 (GAA System Description TR 33.919, GAA GBA TS 33.220, GBA Push Function TS 33.223) and Stage 3 (GAA Zh, Zn and Zpn TS 29.109) on the left; IMS TS 23.228 and IMS MM TS 29.228 on the right; IMS Cx Diameter message definitions TS 29.229 in the middle; and Diameter Base Protocol RFC 3588, SCTP, and IP at the bottom. Brackets on the left group these into 3GPP, IETF with 3GPP, and IETF categories. Zh, Zn, Zpn, and Cx interfaces are indicated at the bottom of the Stage 3 and IMS layers.](f6d72d7c790e7f585532140f3971639a_img.jpg) + +The diagram illustrates the relationship between various specifications for Diameter-based implementations, categorized into 3GPP and IETF standards. + +- 3GPP** specifications include: + - GAA System Description TR 33.919 + - GAA GBA TS 33.220 + - GBA Push Function TS 33.223 + - GAA Zh, Zn and Zpn TS 29.109 +- Stage 2** (IMS TS 23.228) +- Stage 3** (IMS MM TS 29.228) +- IETF with 3GPP** specifications include: + - IMS Cx Diameter message definitions TS 29.229 +- IETF** specifications include: + - Diameter Base Protocol RFC 3588 + - SCTP + - IP + +Interfaces are indicated at the bottom of the diagram: Zh, Zn, Zpn (under Stage 3) and Cx (under IMS MM). + +Diagram showing relationships between 3GPP and IETF specifications for Diameter-based implementations. It is organized into layers: Stage 2 (GAA System Description TR 33.919, GAA GBA TS 33.220, GBA Push Function TS 33.223) and Stage 3 (GAA Zh, Zn and Zpn TS 29.109) on the left; IMS TS 23.228 and IMS MM TS 29.228 on the right; IMS Cx Diameter message definitions TS 29.229 in the middle; and Diameter Base Protocol RFC 3588, SCTP, and IP at the bottom. Brackets on the left group these into 3GPP, IETF with 3GPP, and IETF categories. Zh, Zn, Zpn, and Cx interfaces are indicated at the bottom of the Stage 3 and IMS layers. + +Figure 1.1: Relationships to other specifications + +Figure 1.2 provides an informal overall quick introduction to the whole signalling procedures in GAA system. The important identifiers are marked bold and optional data items are italicised. The Ub and Ua interfaces, not defined in this TS, are simplified. + +NOTE: The Zh' interface (BSF-HLR) is not represented in this figure. + +![Figure 1.2: The whole signalling procedure in GAA system. The diagram shows the interaction between a UE, BSF, SLF, HSS, and NAF across GAA Security and Application domains.](997233d405f0d4b89ddeb7683e047f66_img.jpg) + +The diagram illustrates the signalling procedure in the GAA system, divided into two domains: GAA Security Domain (top, green background) and GAA Application Domain (bottom, blue background). + +**Entities:** + +- UE (User Equipment):** Located in the GAA Application Domain. +- BSF (Bootstrap Server):** Located in the GAA Security Domain. +- SLF (Subscription Locator Function):** Located in the GAA Security Domain, connected to BSF via Dz and IMPI interfaces. +- HSS (Home Subscriber Server):** Located in the GAA Security Domain. +- NAF (Network Application Function):** Located in the GAA Application Domain, containing sub-components: Auth.Proxy and Appl.Spec. Servers. + +**Signalling Procedure:** + +- (1) UE sends **IMPI** to BSF via the **Ub** interface. +- (2) BSF sends **IMPI** to SLF. +- (3) BSF sends a request to HSS containing *AV, IMPI* and **GUSS(USS\*(UID\*))**. +- (4) HSS responds with **B-TID** and **Key-Lifetime** to BSF via the **Zh** interface. +- (5) BSF sends **B-TID** and **UID** to UE via the **Ua** interface. +- (6) UE sends **B-TID**, **GSID\***, and **NAF-Id** to NAF. +- (7) BSF sends a message to NAF containing **USS\*(UID\*)**, **Ks\_(ext)\_NAF**, **Key-Expirytime**, **BootstrapInfoCreationTime**, **Ks\_int\_NAF**, and **IMPI** via the **Zn** interface. +- (8) NAF sends a response to UE. +- (9) if needed: Sh, GUP, etc. (indicated by a dashed arrow from NAF to HSS). + +**Legend:** + +- Bold**=Important Identity. +- Italic*=optional items. +- Ub and Ua interfaces are simplified. + +Figure 1.2: The whole signalling procedure in GAA system. The diagram shows the interaction between a UE, BSF, SLF, HSS, and NAF across GAA Security and Application domains. + +**Bold**=Important Identity. *Italic*=optional items. Ub and Ua interfaces are simplified. + +**Figure 1.2: The whole signalling procedure in GAA system** + +Figure 1.3 provides an informal overall quick introduction to the whole signalling procedures in GAA Push Function. The important identifiers are marked bold and optional data items are italicised. The Ua and Upa interfaces, not defined in this TS, are simplified. + +![Signalling procedure in GAA Bootstrapping Push Function diagram showing interactions between UE, SLF, BSF, HSS, and NAF across GAA Security and Application domains.](d0abac95583b52a3b35f74a215567334_img.jpg) + +The diagram illustrates the signalling procedure for GAA Bootstrapping Push Function across two domains: GAA Security Domain (top, green background) and GAA Application Domain (bottom, light blue background). + +**Entities:** + +- UE** (User Equipment) +- SLF** (SLF - Service Location Function) +- BSF** (BSF - Bootstrapping Server Function) +- HSS** (HSS - Home Subscriber Server) +- NAF** (NAF - Network Authentication Function) +- Appl.Spec. Servers** (Application Specific Servers) + +**Interfaces and Messages:** + +- UE to BSF:** Message (1) containing **UE-Id (Type)**, **P-TID**, **GSID\***, **NAF-Id**, and **Zpn**. +- BSF to SLF:** Message (2) containing **IMPI/IMPU** and **Dz**. +- BSF to HSS:** Message (3) containing **Zh**. +- HSS to BSF:** Message (4) containing **AV, IMPI** and **GUSS(USS\*(UID\*))**. +- NAF to BSF:** Message (5) containing **GPI** and **Upa**. +- BSF to NAF:** A large message block containing: + - GPI** + - USS\*(UID\*)** + - Ks\_(ext)\_NAF** + - Key-Expirytime** + - BootstrapInfoCreationTime** + - Ks\_int\_NAF** + - IMPI** + +**Legend:** + +- Bold**=Important Identity. +- Italic*=optional items. +- Ub and Ua interfaces are simplified. + +Signalling procedure in GAA Bootstrapping Push Function diagram showing interactions between UE, SLF, BSF, HSS, and NAF across GAA Security and Application domains. + +Figure 1.3: Signalling procedure in GAA Bootstrapping Push Function + +# 2 References + +The following documents contain provisions that, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] Void. +- [2] 3GPP TS 29.228: "IP Multimedia (IM) Subsystem Cx and Dx Interfaces; Signalling flows and message contents". +- [3] 3GPP TS 29.229: "Cx and Dx interfaces based on the Diameter protocol". +- [4] 3GPP TR 33.919 "Generic Authentication Architecture (GAA); System Description". +- [5] 3GPP TS 33.220 "Generic Authentication Architecture (GAA); Generic Bootstrapping Architecture". +- [6] 3GPP TS 33.221 "Generic Authentication Architecture (GAA); Support for Subscriber Certificates". +- [7] 3GPP TS 24.109: "Bootstrapping interface (Ub) and Network application function interface (Ua);Protocol details". +- [8] 3GPP TS 29.230: "Diameter applications; 3GPP specific codes and identifiers" +- [9] IETF RFC 3589: "Diameter Command Codes for Third Generation Partnership Project (3GPP)". +- [10] 3GPP TS 23.008: "Organisation of subscriber data" +- [11] 3GPP TS 33.222: "Generic Authentication Architecture (GAA); Access to network application functions using secure hypertext transfer protocol (HTTPS)". +- [12] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2" +- [13] W3C: "Web Services Activity", . +- [14] W3C: "Web Services Description Language (WSDL) Version 2.0 Part 0: Primer", . +- [15] 3GPP TR 33.980: "Liberty Alliance and 3GPP Security Interworking; Interworking of Liberty Alliance ID-FF, ID-WSF and Generic Authentication Architecture". +- [16] Liberty Alliance Project: "Liberty ID-FF Authentication Context Specification". +- [17] 3GPP TS 33.110: "Key establishment between a Universal Integrated Circuit Card (UICC) and a terminal" +- [18] 3GPP TS 33.259: "Key establishment between a UICC Hosting Device and a Remote Device" +- [19] 3GPP TS 29.002: "Mobile Application Part (MAP) Specification" +- [20] 3GPP TS 33.102: "3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; 3G Security; Security architecture". +- [21] 3GPP TS 23.003: "Numbering, addressing and identification". +- [22] OASIS Standard: "Authentication Context for the OASIS Security Assertion Markup Language (SAML) V2.0 OASIS Standard, 15 March 2005, saml-authn-context-2.0-os". + +- [23] 3GPP TS 33.223 "Generic Authentication Architecture (GAA); Generic Bootstrapping Architecture (GBA) Push Function". +- [24] 3GPP TS 33.402: "3GPP System Architecture Evolution (SAE); Security aspects of non-3GPP accesses". +- [25] Void +- [26] 3GPP TS 26.237: "IP Multimedia Subsystem (IMS) based Packet Switched Streaming (PSS) Multimedia Broadcast/Multicast Services (MBMS); User Service; Protocols". +- [27] Void +- [28] Void +- [29] 3GPP TR 33.924: "Identity Management and 3GPP Security Interworking; Identity Management and Generic Authentication Architecture (GAA) Interworking". +- [30] 3GPP TS 33.224: "Generic Authentication Architecture (GAA); Generic Push Layer". +- [31] 3GPP TS 33.203: "Access security for IP-based services". +- [32] 3GPP TS 29.329: " Sh Interface based on the Diameter protocol; Protocol details". +- [33] IETF RFC 6733: "Diameter Base Protocol". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TS 23.008 [10], 3GPP TR 33.919 [4], 3GPP TS 33.220 [5] apply with following additions. + +**Bootstrapping information** (Bootstrapped data) in a BSF consists of a bootstrapping transaction identifier (B-TID), a key material (Ks), the key lifetime (expiry time), the bootstrapinfo creation time, the IMPI and the GUSS (if received from HSS) with BSF control information. Each bootstrapping procedure creates a bootstrapped data entity with B-TID as retrieval key.. + +**GAA application** is an application that uses the security association created by GBA Bootstrapping procedure. + +**GAA service** is an operator specific end user service that uses the security association created by GAA Bootstrapping procedure. GAA services are identified by **GAA Service Identifiers**. A GAA service is implemented using some standardised or proprietary GAA application defined by GAA application type. + +**NAF specific Bootstrapping information** transferred from a BSF to a NAF contains NAF and its service specific parts from bootstrapped data and needed key information derived from the bootstrapped data. + +**Service/Application.** The term service is used here in its common meaning. A service is something that a MNO offers to subscribers. GAA Services are identified by GAA Service Identifier (GSID). In stage 2 documents ([4], [5], [6] and [11]) the term application is used in the same meaning i.e. MNOs offer applications to subscribers. There is a reason to avoid the usage of the term application here. The application is an already reserved term in Diameter. In Diameter applications are identified by Application Identifiers. + +## 3.2 Symbols + +For the purposes of the present document, the terms and definitions given in 3GPP TS 23.008 [10]. + +## 3.3 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|------------|------------------------------------------------------------------------------------------------------------------------------------| +| AK | Anonymity Key | +| AKA | Authentication and Key Agreement | +| AUTN | Authentication token | +| AV | Authentication Vector. 3GPP AV=[RAND,AUTN,XRES,CK,IK]. | +| AVP | Attribute-Value-Pair in Diameter messages. | +| BIA | BootstrappingInfo-Answer message | +| BIR | BootstrappingInfo-Request message | +| BS | BootStrapping Procedure | +| BSF | Bootstrapping server functionality
BSF is hosted in a network element under the control of an MNO. | +| B-TID | Bootstrapping Transaction Identifier | +| CA | Certificate Authority | +| CK | Confidential Key | +| FQDN | Full Qualified Domain Name in URI (e.g. http://FQDN:80 ) | +| GAA | Generic Authentication Architecture | +| GBA | Generic Bootstrapping Architecture | +| GPI | GBA Push Information | +| GSID | GAA Service Identifier | +| GUSS | GBA User Security Settings | +| HSS | Home Subscriber System | +| IK | Integrity Key | +| IMPI | IP Multimedia Private Identity | +| IMPU | IP Multimedia Public Identity | +| Ks | Key Material | +| Ks_ext_NAF | MEbased key for a specific NAF | +| Ks_int_NAF | UICC based key for a specific NAF | +| ME | Mobile Equipment | +| MNO | Mobile network operator | +| NAF | Operator-controlled network application function functionality.
NAF is hosted in a network element under the control of an MNO. | +| P-TID | Push Temporary Identifier | +| RAND | Random challenge in authentication | +| REQ | In Diameter header indicates that the message is a Request. | +| SCTP | Stream Control Transmission Protocol | +| SLF | Subscription Location Function | +| SSC | Subscriber Certificate Procedure | +| Ua | UE-NAF interface for GAA applications | +| Ub | UE-BSF interface for bootstrapping | +| UE | User Equipment | +| USS | User Security Settings (a part of GUSS) | +| XRES | Expected response in authentication | +| Zh | BSF-HSS interface for bootstrapping procedure | +| Zh' | BSF-HLR interface for bootstrapping procedure | +| Zn | BSF-NAF interface for GAA applications | +| Zpn | BSF-NAF interface for GBA push. | + +# 4 GBA Bootstrapping Zh interface and Zh' interface + +## 4.1 Generic bootstrapping network architecture + +The network architecture of the Diameter based implementation for Bootstrapping procedure is presented in Figure 4.1-1. The interface Ub (bootstrapping) is defined in 3GPP TS 24.109 [7] and the interface Zh in this specification. + +![Figure 4.1-1: Network architecture of bootstrapping procedure. A diagram showing three yellow rectangular blocks: UE, BSF, and HSS. UE is connected to BSF via an interface labeled Ub. BSF is connected to HSS via an interface labeled Zh.](ddc7460821484f1ae2835c67955c554c_img.jpg) + +``` + +graph LR + UE[UE] -- Ub --> BSF[BSF] + BSF -- Zh --> HSS[HSS] + +``` + +Figure 4.1-1: Network architecture of bootstrapping procedure. A diagram showing three yellow rectangular blocks: UE, BSF, and HSS. UE is connected to BSF via an interface labeled Ub. BSF is connected to HSS via an interface labeled Zh. + +Figure 4.1-1: Network architecture of bootstrapping procedure + +The generic bootstrapping network architecture for Bootstrapping Push procedures is presented in Figure 4.1-2. The interface Zpn is also defined in this specification. + +![Figure 4.1-2: Network architecture of bootstrapping push procedure. A diagram showing four yellow rectangular blocks: UE, NAF, BSF, and HSS. UE is connected to NAF via an interface labeled Upa. NAF is connected to BSF via an interface labeled Zpn. BSF is connected to HSS via an interface labeled Zh.](e9d825d87c5f85c8dba0664eace96ef4_img.jpg) + +``` + +graph LR + UE[UE] -- Upa --> NAF[NAF] + NAF -- Zpn --> BSF[BSF] + BSF -- Zh --> HSS[HSS] + +``` + +Figure 4.1-2: Network architecture of bootstrapping push procedure. A diagram showing four yellow rectangular blocks: UE, NAF, BSF, and HSS. UE is connected to NAF via an interface labeled Upa. NAF is connected to BSF via an interface labeled Zpn. BSF is connected to HSS via an interface labeled Zh. + +Figure 4.1-2: Network architecture of bootstrapping push procedure + +The protocol stack of the Zh interface in Bootstrapping procedure is presented in Figure 4.2. The Diameter Base protocol is defined in IETF RFC 6733 [33] and the Diameter application in 3GPP TS 29.229 [3]. The requirements for Zh interface are defined in 3GPP TS 33.220 [5] and 3GPP TS 33.223 [23]. + +![Figure 4.2: Protocol stack of Zh interface. A diagram showing two protocol stacks for BSF and HSS. Both stacks have five layers. From top to bottom: Zh application logic (yellow), Diameter application (light blue), Diameter Base Protocol (light blue), SCTP (white), and IP (white). The bottom IP layers of both stacks are connected by a line labeled Zh.](5dfc130b129ace4df375839020a5700d_img.jpg) + +| BSF | HSS | +|-----------------------------|-----------------------------| +| Zh application logic in BSF | Zh application logic in HSS | +| Diameter application | Diameter application | +| Diameter Base Protocol | Diameter Base Protocol | +| SCTP | SCTP | +| IP | IP | + +Figure 4.2: Protocol stack of Zh interface. A diagram showing two protocol stacks for BSF and HSS. Both stacks have five layers. From top to bottom: Zh application logic (yellow), Diameter application (light blue), Diameter Base Protocol (light blue), SCTP (white), and IP (white). The bottom IP layers of both stacks are connected by a line labeled Zh. + +Figure 4.2: Protocol stack of Zh interface + +The MAP based Bootstrapping Zh' interface is defined in the section 4.3. + +## 4.2 Protocol Zh between BSF and HSS + +The requirements for Zh interface are defined in 3GPP TS 33.220 [5] and 3GPP TS 33.223 [23]. + +The Bootstrapping Zh interface performs the retrieval of an authentication vector and possibly GBA User Security Settings from the HSS. + +The overall Bootstrapping procedure is depicted in Figure 4.3. The basic procedure is: + +A) A UE starts the bootstrapping procedure by protocol Ub with a BSF giving the IMPI of the user (see 3GPP TS 24.109 [7]). + +B) The BSF starts protocol Zh with user's HSS + +- The BSF requests user's authentication vector and GBA User Security Settings (GUSS) corresponding to the IMPI. If the authentication scheme is to use SIP Digest credentials, the BSF shall indicate this in the request. +- The HSS supplies to the BSF the requested authentication vector and GUSS (if applicable, cf. 3GPP TS 33.220 [5]). The HSS supplies the requested authentication vector relating to SIP Digest only if explicitly indicated in the request. + +NOTE 1: If there is more than one HSS deployed within the network, the BSF may have to contact the SLF using the Dz interface prior to sending the request for information to the HSS (see section 6.4). + +C) The BSF continues the protocol Ub with the UE (see 3GPP TS 24.109 [7]). + +![Sequence diagram of the GBA bootstrapping procedure showing interactions between UE, BSF, and HSS.](f6e8acf9f931452d01688d311b5c0364_img.jpg) + +``` + +sequenceDiagram + participant UE + participant BSF + participant HSS + + Note left of UE: If non-IMS subscriber, generates IMPI from IMSI + UE->>BSF: Bootstrapping-Request (IMPI) + BSF->>HSS: 1. Multimedia-Auth-Request ( IMPI ) + Note right of HSS: 2. HSS derives Authentication data and fetches GUSS for IMPI. + HSS->>BSF: 3. Multimedia-Auth-Answer (Authentication data, GAA-UserSecSettings) + Note right of BSF: 4. BSF stores bootstrapping information tuple for IMPI. + BSF->>UE: Bootstrapping-Answer (realm,nonce,algorithm) + Note right of UE: The rest of the Bootstrapping procedure + +``` + +The diagram illustrates the GBA bootstrapping procedure. It begins with the UE sending a 'Bootstrapping-Request (IMPI)' to the BSF over the Ub interface. The BSF then sends a 'Multimedia-Auth-Request ( IMPI )' to the HSS over the Zh interface. The HSS derives authentication data and fetches GUSS for the IMPI, returning a 'Multimedia-Auth-Answer (Authentication data, GAA-UserSecSettings)' to the BSF. The BSF stores the bootstrapping information tuple for the IMPI and sends a 'Bootstrapping-Answer (realm,nonce,algorithm)' back to the UE. A note indicates that if the UE is a non-IMS subscriber, it generates the IMPI from the IMSI. A final note indicates that the rest of the bootstrapping procedure follows. + +Sequence diagram of the GBA bootstrapping procedure showing interactions between UE, BSF, and HSS. + +Figure 4.3: The GBA bootstrapping procedure + +The overall Bootstrapping Push procedure is depicted in Figure 4.4. The Push procedure shall not apply with an authentication scheme using SIP Digest credentials. The Push procedure is: + +A) A NAF sends a bootstrapping push request to the BSF via Zpn interface including the IMPI or IMPU of the user (see section 5). + +B) The BSF starts protocol Zh with user's HSS + +- The BSF requests user's authentication vector and GBA User Security Settings (GUSS) corresponding to the IMPI or IMPU. +- The HSS supplies to the BSF the requested authentication vector and GUSS (if any). + +NOTE 2: If there is more than one HSS deployed within the network, the BSF may have to contact the SLF using the Dz interface prior to sending the request for information to the HSS (see section 6.4). + +- C) The BSF continues the protocol Zpn with the NAF (see section 5). +- D) The NAF starts protocol Upa with the UE, as specified in 3GPP TS 24.109 [7]. + +![Sequence diagram of the GBA bootstrapping Push procedure. The diagram shows four entities: UE, NAF, BSF, and HSS. The NAF sends a 'Generate GPI Request' to the BSF. The BSF sends a 'Multimedia-Auth-Request (IMPI or IMPU)' to the HSS. The HSS generates AV and fetches GUSS for IMPI. The BSF generates GPI. The BSF sends a 'GPI-Response (GPI)' to the NAF. The NAF sends a 'GPI Push' to the UE. The interfaces are labeled: Upa between UE and NAF, Zpn between NAF and BSF, Zh between BSF and HSS.](9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg) + +``` + +sequenceDiagram + participant UE + participant NAF + participant BSF + participant HSS + Note right of NAF: Generate GPI Request + NAF->>BSF: GPI-Request (IMPI or IMPU, NAF-Id) + BSF->>HSS: 1. Multimedia-Auth-Request (IMPI or IMPU) + Note right of HSS: 2. HSS generates AV and fetches GUSS for IMPI. + HSS->>BSF: 3. Multimedia-Auth-Answer (RAND,AUTN,XRES,CK,IK, GAA-UserSecSettings) + Note right of BSF: 4. BSF generates GPI + BSF->>NAF: GPI-Response (GPI) + Note right of NAF: GPI Push + NAF->>UE: GPI Push + +``` + +Sequence diagram of the GBA bootstrapping Push procedure. The diagram shows four entities: UE, NAF, BSF, and HSS. The NAF sends a 'Generate GPI Request' to the BSF. The BSF sends a 'Multimedia-Auth-Request (IMPI or IMPU)' to the HSS. The HSS generates AV and fetches GUSS for IMPI. The BSF generates GPI. The BSF sends a 'GPI-Response (GPI)' to the NAF. The NAF sends a 'GPI Push' to the UE. The interfaces are labeled: Upa between UE and NAF, Zpn between NAF and BSF, Zh between BSF and HSS. + +Figure 4.4: The GBA bootstrapping Push procedure + +The steps of the bootstrapping procedure over Zh reference point in Figure 4.3 and Figure 4.4 are: + +### Step 1 + +The BSF shall send the following Bootstrapping-Request to the HSS in the format of Multimedia-Auth-Request (MAR) message. The content of the message is given below in the same format as in 3GPP TS 29.229 [3]. The curly brackets indicate mandatory AVPs. The square brackets indicate optional AVPs. The "address of" refers to the Fully Qualified Host Name (FQDN). + +``` + + ::= + < Session-Id > + { Vendor-Specific-Application-Id } + { Auth-Session-State } ; NO_STATE_MAINTAINED + { Origin-Host } ; Address of BSF + { Origin-Realm } ; Realm of BSF + { Destination-Realm } ; Realm of HSS + [ Destination-Host ] ; Address of the HSS + [ User-Name ] ; IMPI from UE + [ Public-Identity ] ; IMPU from UE + [ SIP-Auth-Data-Item ] ; Authentication Scheme, + Synchronization Failure + +``` + +``` + +[ GUSS-Timestamp ] ; Timestamp of GUSS in BSF +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +The content of mandatory Vendor-Specific-Application-ID according IETF RFC 6733 [33] is: + +``` + + ::= + 1* [Vendor-Id] ; 3GPP is 10415 + 0*1 {Auth-Application-Id} ; 16777221 + 0*1 {Acct-Application-Id} ; Omitted + +``` + +When determining the value of Destination-Host AVP the BSF can use redirector function (SLF) to resolve the address of the HSS if needed (see 3GPP TS 29.229 [3]). The BSF shall set the Auth-Session-State AVP to NO\_STATE\_MAINTAINED to inform that the HSS does not need to maintain any status information for this session according 3GPP TS 29.229 [3]. + +The User-name is the IMS Private User Identity (IMPI) as defined in 3GPP TS 29.228 [2]. In bootstrapping push procedures, either the Public-Identity AVP or the User-Name AVP shall be present in the request, depending on the user identity provided by the NAF. For all other bootstrapping procedures, only the User-Name AVP shall be present. If the identity received from the NAF is an MSISDN, the BSF shall include this MSISDN in the form of a tel URI in the Public-Identity AVP (see 3GPP TS 29.229 [2]). + +If the BSF supports the GUSS timestamp mechanism and has local copy of the GUSS, which has a timestamp, the BSF may include the GUSS-Timestamp AVP. In this case the GUSS-Timestamp AVP shall contain the timestamp from subscriber's GUSS. Otherwise the GUSS-Timestamp AVP shall not be present. + +The SIP-Auth-Data-Item AVP, when present, shall indicate the authentication scheme chosen, i.e SIP Digest when applicable. By default, when the SIP-Auth-Data-Item AVP is not present, the authentication scheme is Digest-AKA-v1-MD5. The SIP-Auth-Data-Item AVP should not be present to indicate the authentication scheme is Digest-AKA-v1-MD5. + +NOTE 3: A pre-Rel-11 HSS only received SIP-Auth-Data-Item AVP in Zh MAR in case of synchronization failure for IMS-AKA. Apart from that, when SIP-Auth-Data-Item AVP was not present, it implied that the authentication scheme was Digest-AKA-v1-MD5. Therefore, if SIP-Auth-Data-Item AVP is not present, it means that the authentication scheme is Digest-AKA-v1-MD5, like before Rel-11. Moreover, in order to avoid interoperability problems between a pre-Rel-11 HSS and a Rel-11 (or later) BSF, the BSF should not include the SIP-Auth-Data-Item AVP to indicate the authentication scheme is Digest-AKA-v1-MD5. + +If the Authentication Request is triggered by a synchronization failure (see 3GPP TS 24.109 [7]), the BSF shall include the SIP-Auth-Data-Item AVP within the MAR message according to 3GPP TS 29.228 [2]. + +### Step 2 + +When the HSS receives the MAR message, the HSS shall derive the user Authentication Vector (AV) information according the IMPI and, if present, the authentication scheme and populates it into SIP-Auth-Data-Item AVP as defined for IMS-AKA or SIP Digest authentication schemes in 3GPP TS 29.229 [3]. Only one AV shall be provided. + +If the Public User Identity is received, the HSS shall resolve to the corresponding IMPI/IMSI associated to such IMPU/MSISDN before deriving the AV information. If Public to Private identity resolution is not possible i.e. due to the IMPU is shared with multiple IMPIs, the HSS shall set the Experimental-Result-Code to DIAMETER\_ERROR\_OPERATION\_NOT\_ALLOWED (see 3GPP TS 29.329 [32]). + +If the request indicates that there is a synchronization failure, the HSS shall process AUTS as described in 3GPP TS 33.203 [31] and return the requested authentication information. The Result-Code shall be set to DIAMETER\_SUCCESS. + +If GUSS exists for the IMPI, the HSS shall do one of the following: + +- 1) If the HSS supports the GUSS timestamp mechanism and received the GUSS-Timestamp AVP in MAR message then it shall compare the timestamp of the GUSS in the HSS with the received timestamp. + - If timestamps are equal, then it shall populate the GBA-UserSecSettings AVP with static string "GUSS TIMESTAMP EQUAL". + +- If the GUSS-Timestamp AVP was not received, or timestamps are not equal, then it shall populate the GBA-UserSecSettings AVP with the GUSS. +- If the HSS does not support GUSS timestamp mechanism, it shall populate the GBA-UserSecSettings AVP with the GUSS. + +The MAR/MAA sequence in the Zh interface must not change possible status information of the possible simultaneously ongoing IMS MM application sessions in the HSS. + +If the User-Name (IMPI) or Public-Identity (IMPU) from the BSF is totally unknown to the HSS, the error situation 5401 is raised. + +Exceptions to the cases specified here shall be treated by HSS as error situations. The Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY and no authentication or GUSS information shall be returned. + +### Step 3 + +The HSS shall send the following Bootstrapping-Answer message in the format of Multimedia-Auth-Answer (MAA) message back to the BSF. + +``` +< Multimedia-Auth-Answer> ::= < Diameter Header: 303, PXY, 16777221 > + < Session-Id > + { Vendor-Specific-Application-Id } + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } ; NO_STATE_MAINTAINED + { Origin-Host } ; Address of HSS + { Origin-Realm } ; Realm of HSS + [ User-Name ] ; IMPI + [ Public-Identity ] ; IMPU + [ SIP-Auth-Data-Item ] + [ GBA-UserSecSettings ] ; GUSS + [ SHA-256-Indication ] ; UICC supports SHA-256 + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +The HSS shall set the mandatory Auth-Session-State AVP to NO\_STATE\_MAINTAINED because the HSS does not maintain any state information about this session and the BSF does not need to send any session termination request 3GPP TS 29.229 [3]. + +If the Public-Identity was present in the request, both Public-Identity and User-Name AVPs shall be present in the response. Otherwise, the User-name AVP (IMPI) may be sent back for checking. + +The required authentication vector data is sent in the SIP-Auth-Data-Items AVP as defined for IMS-AKA or SIP Digest authentication schemes according to 3GPP TS 29.228 [2]. The security settings of user's all GAA applications are sent in GBA-UserSecSettings AVP. + +If the 2G GBA option (see 3GPP TS 33.220, Annex I [5]) is applied for the user the SIP-Auth-Data-Item AVP shall be filled as follows: The SIP-Authentication-Scheme AVP is set to "Digest-AKAv1-MD5-2G-GBA" to indicate a 2G GBA vector for GBA. The SIP-Authenticate AVP contains only RAND. The SIP-Authorization AVP contains RES. The Confidentiality-Key AVP contains Kc. The Integrity-Key AVP shall not be present. If a 2G Authentication Vector is requested for the user but the 2G GBA option is not supported by the HSS, the HSS shall set the Experimental-Result-Code to DIAMETER\_AUTHENTICATION\_SCHEME\_NOT\_SUPPORTED (see 3GPP TS 29.228 [2]). + +The SHA-256-Indication AVP shall be present in the response if the UICC supports SHA-256 (see 3GPP TS 33.220 [5]). + +### Step 4 + +When the BSF receives the MAA message, the BSF shall check the value of the SIP-Authentication-Scheme AVP. If the BSF does not support the authentication-scheme the BSF shall stop processing the message and should indicate an error via the O&M subsystem. + +The BSF generates the needed key material (Ks) as described in 3GPP TS 33.220 [5] and stores temporarily the tuple for further use in GAA applications. The rest of the bootstrapping procedure in Ub + +interface will later add also the Bootstrapping Transaction Identifier (B-TID) to that tuple as key and the key lifetime (expiry time). + +If the BSF sent the GUSS-Timestamp AVP in step 1, and if the GBA-UserSecSettings AVP contains a static string "GUSS TIMESTAMP EQUAL", then the local copy of the GUSS in the BSF shall be preserved. If the GBA-UserSecSettings AVP was not present in the MAA message, the local copy of the GUSS shall be deleted. If the GBA-UserSecSettings AVP contains a new GUSS, the local copy of the GUSS shall be deleted, and the new GUSS shall be stored in the BSF. + +In GBA Bootstrapping Push procedures, the BSF generates the requested NAF-key(s) according to provided NAF\_Id and the GBA Push Information (GPI). The BSF completes the rest of the bootstrapping push procedure sending its response to the NAF over Zpn interface, and deleting the Ks used as defined in section 5. + +## 4.3 Protocol Zh' between BSF and HLR + +The requirements for Zh' reference point are the same with the one for the Zh reference point defined in 3GPP TS 33.220 [5], except that the GBA User Security Settings (GUSS) are not supported. + +The Bootstrapping Zh' interface performs the retrieval of an authentication vector. The basic procedure is: + +- A) A UE starts the bootstrapping procedure by protocol Ub with a BSF giving the IMPI of the user (see 3GPP TS 24.109 [7]). In bootstrapping push procedures a NAF initiates a GBA Push Information Request by protocol Zpn with the BSF giving the user identity (see section 5). The BSF derives the IMSI from the IMPI. In bootstrapping push procedures when only the Public Identity of the user is made available to the BSF, the BSF shall perform public to private identity resolution as defined in section 4.3.1. +- B) The BSF starts protocol Zh' with user's HLR + - The BSF requests user's authentication vector corresponding to the IMSI. + - The HLR supplies to the BSF the requested authentication vector. +- C) The BSF continues the protocol Ub with the UE (see 3GPP TS 24.109 [7]). + +The BSF shall use the following Bootstrapping-Request to the HLR in the format of a MAP\_SEND\_AUTHENTICATION\_INFO. The content of the request, result and error messages is given below in the same format as in 3GPP TS 29.002 [19]. The parameter usage is as follows: + +### IMSI + +See 3GPP TS 29.002 [19] section 7.6.2 for the use of this parameter. + +#### Number of requested vectors + +The BSF shall only request one authentication vector at a time. + +### Requesting node type + +BSF + +### Re-synchronisation Info + +For definition and use of this parameter see 3GPP TS 33.102 [20]. + +### Segmentation prohibited indicator + +This parameter is not applicable and should not be sent by the BSF. + +### Immediate response preferred indicator + +This parameter indicates that one of the requested authentication vectors is requested for immediate use in the BSF. + +### Requesting PLMN ID + +The PLMN-ID of the requesting node. See 3GPP TS 23.003 [21]. + +### AuthenticationSetList + +One authentication vector is transferred from the HLR to the BSF, if the outcome of the service was successful. + +### User error + +One of the following error causes defined in 3GPP TS 29.002 [19] shall be sent by the user in case of unsuccessful outcome of the service, depending on the respective failure reason: + +- unknown subscriber; +- unexpected data value; +- system failure; +- data missing. + +### Provider error + +See 3GPP TS 29.002 [19] for the use of this parameter. + +When the BSF receives the response of the MAP\_SEND\_AUTHENTICATION\_INFO service, then it shall generate the needed key material (Ks) from confidential key (CK) and integrity key (IK) as described in 3GPP TS 33.220 [5], respectively from Kc as described in 3GPP TS 33.220 [5] and stores temporarily the tuple for further use in GAA/GBA applications. The rest of the bootstrapping procedure in Ub interface will later add also the Bootstrapping Transaction Identifier (B-TID) to that tuple as key and the key lifetime (expiry time). + +### 4.3.1 Public to Private Identity Resolution over Zh between BSF and HLR + +When the UE identity used by the NAF in a GPI Request towards the BSF is an MSISDN, the BSF shall resolve the corresponding private user identity (IMSI) for the user. + +When Zh interface between BSF and HLR is used, the BSF shall resolve the private user identity with the HLR in the format of a MAP\_SEND\_IMSI or a MAP\_SEND\_ROUTING\_INFO\_FOR\_SM. + +The content of the request, result and error messages is given below in the same format as in 3GPP TS 29.002 [19]. The parameter usage when the MAP\_SEND\_IMSI operation is used is as follows: + +#### MSISDN + +See 3GPP TS 29.002 [19] section 7.6.2 for the use of this parameter. + +#### IMSI + +See 3GPP TS 29.002 [19] section 7.6.2 for the use of this parameter. The presence of this parameter is mandatory in a successful case. + +#### User error + +Only one of the following values is applicable: + +- Unknown subscriber; +- Unexpected data value; +- Data missing. + +The parameter usage when the MAP\_SEND\_ROUTING\_INFO\_FOR\_SM operation is used is as follows: + +#### MSISDN + +See 3GPP TS 29.002 [19] section 7.6.2 for the use of this parameter. + +#### SM-RP-PRI + +BSF shall set this parameter to indicate that delivery of the short message shall NOT be attempted when a service centre address is already contained in the Message Waiting Data file. + +#### Service Centre Address + +BSF shall include the BSF address within this parameter. + +#### SM-RP-MTI + +#### SM-RP-SMEA + +#### GPRS Support Indicator + +BSF shall not use these parameters in the public to private identity resolution request. + +#### SM-Delivery Not Intended + +BSF shall set this parameter to indicate that delivery of a short message is not intended and that only IMSI is requested. + +#### IMSI + +See 3GPP TS 29.002 [19] section 7.6.2 for the use of this parameter. The presence of this parameter is mandatory in a successful case. + +#### Network Node Number + +#### LMSI + +#### GPRS Node Indicator + +#### Additional Number + +BSF ignores these parameters if present in the public to private identity resolution response. + +#### User error + +One of the following error causes defined in 3GPP TS 29.002 [19] shall be sent by the user in case of unsuccessful outcome of the service, depending on the respective failure reason: + +- Unknown subscriber; +- Call Barred; +- Teleservice Not Provisioned; +- Absent Subscriber\_SM; +- Facility Not Supported; +- System failure; +- Unexpected Data Value; +- Data missing. + +#### Provider error + +See 3GPP TS 29.002 [19] for the use of this parameter. + +When the HLR is able to resolve the private identity of the user, the BSF continues with the bootstrapping procedures over Zh and requests a user's authentication vector corresponding to the IMSI as defined above. Otherwise the BSF provides the corresponding error to the NAF over Zpn as defined in section 5. + +# 5 GAA Application Zn and Zpn interfaces + +## 5.1 Applications' network architecture + +The network architecture of the GAA applications procedure using Zn is presented in Figure 5.1-1. The 3GPP GAA applications are listed in annex B. Different GAA applications may implement the Ua interface in different way. The Zn interface is defined in this specification. + +![Figure 5.1-1: Network architecture of GAA application using Zn](4cc7cdce3d498d8b0ba033a9be24ade5_img.jpg) + +``` +graph LR; UE[UE] -- Ua --> NAF[NAF]; NAF -- Zn --> BSF[BSF]; +``` + +The diagram shows a linear network architecture for GAA applications using the Zn interface. It consists of three main components connected in a sequence: a User Equipment (UE) block, a Network Application Function (NAF) block, and a Bootstrap Server (BSF) block. The UE is connected to the NAF via the Ua interface, and the NAF is connected to the BSF via the Zn interface. + +Figure 5.1-1: Network architecture of GAA application using Zn + +**Figure 5.1-1: Network architecture of GAA application using Zn** + +The network architecture of GBA push procedure using Zpn is presented in Figure 5.1-2. The Zpn interface is also defined in this specification. + +![Figure 5.1-2: Network architecture of GBA push procedure using Zpn](608f1b5ef8f3dc0723f2b4ea1fb72be2_img.jpg) + +``` +graph LR; UE[UE] -- Upa --> NAF[NAF]; NAF -- Zpn --> BSF[BSF]; +``` + +The diagram shows a linear network architecture for the GBA push procedure using the Zpn interface. It consists of three main components connected in a sequence: a User Equipment (UE) block, a Network Application Function (NAF) block, and a Bootstrap Server (BSF) block. The UE is connected to the NAF via the Upa interface, and the NAF is connected to the BSF via the Zpn interface. + +Figure 5.1-2: Network architecture of GBA push procedure using Zpn + +**Figure 5.1-2: Network architecture of GBA push procedure using Zpn** + +Two options are specified for the protocol stack to be used on the Zn and Zpn interface: + +The protocol stack of the DIAMETER based Zn interface, + +the protocol stack of the Web Services based Zn interface. + +The BSF shall support both options whereas the NAF shall support one or both of these options. + +The protocol stack of the Diameter based implementation of the Zn interface for GAA applications and Zpn interface for GBA push procedure is presented in Figure 5.2-1. The Zn interface is specified in clause 5.2. The Zpn interface is specified in clause 5.4. The Diameter base protocol is defined in IETF RFC 6733 [33] and the Diameter application in 3GPP TS 29.229 [3]. The requirements for Zn interface are defined in 3GPP TS 33.220 [5]. The requirements for Zpn interface are defined in 3GPP TS 33.223 [23]. + +![Figure 5.2-1: Protocol stack of Diameter based Zn and Zpn interfaces. The diagram shows two protocol stacks for NAF and BSF. Both stacks have five layers: Zn/Zpn application logic (yellow), Diameter application (light blue), Diameter Base (light blue), SCT (white), and IP (white). The IP layers of both stacks are connected by a horizontal line labeled 'Zn/Zpn'.](e180f2b5fcbe8001554a7c0677cd3f82_img.jpg) + +| NAF | | BSF | +|---------------------------------|--------|---------------------------------| +| Zn/Zpn application logic in NAF | | Zn/Zpn application logic in BSF | +| Diameter application | | Diameter application | +| Diameter Base | | Diameter Base | +| SCT | | SCT | +| IP | Zn/Zpn | IP | + +Figure 5.2-1: Protocol stack of Diameter based Zn and Zpn interfaces. The diagram shows two protocol stacks for NAF and BSF. Both stacks have five layers: Zn/Zpn application logic (yellow), Diameter application (light blue), Diameter Base (light blue), SCT (white), and IP (white). The IP layers of both stacks are connected by a horizontal line labeled 'Zn/Zpn'. + +Figure 5.2-1: Protocol stack of Diameter based Zn and Zpn interfaces + +The protocol stack of the Web Services based Zn interface for GAA applications and Zpn interface for GBA push procedure is presented in Figure 5.2-2. The Zn interface is specified in clause 5.3. The Zpn interface is specified in clause 5.5. + +![Figure 5.2-2: Protocol stack of Web Services based Zn interface. The diagram shows two protocol stacks for NAF and BSF. Both stacks have five layers: Zn/Zpn application logic (yellow), SOAP (light blue), HTTP (light blue), TCP (white), and IP (white). The IP layers of both stacks are connected by a horizontal line labeled 'Zn/Zpn'.](5793a44ffdadd039928e2f9fe6daae06_img.jpg) + +| NAF | | BSF | +|---------------------------------|--------|---------------------------------| +| Zn/Zpn application logic in NAF | | Zn/Zpn application logic in BSF | +| SOAP | | SOAP | +| HTTP | | HTTP | +| TCP | | TCP | +| IP | Zn/Zpn | IP | + +Figure 5.2-2: Protocol stack of Web Services based Zn interface. The diagram shows two protocol stacks for NAF and BSF. Both stacks have five layers: Zn/Zpn application logic (yellow), SOAP (light blue), HTTP (light blue), TCP (white), and IP (white). The IP layers of both stacks are connected by a horizontal line labeled 'Zn/Zpn'. + +Figure 5.2-2: Protocol stack of Web Services based Zn interface + +## 5.2 Protocol Zn between NAF and BSF based on Diameter + +The requirements for Zn interface are defined in 3GPP TS 33.220 [5]. + +The protocol Zn retrieves the key material and possibly user security settings data by NAF from BSF. After UE is authenticated with the BSF, every time the UE wants to interact with an NAF the following steps are executed as depicted in Figure 5.3. The basic procedure is: + +A) The UE starts protocol Ua (see 3GPP TS 33.220 [5]) + +- In general, the UE and the NAF will not yet share the key(s) required to protect protocol Ua. If they already do, there is no need for the NAF to invoke protocol Zn. +- It is assumed that UE supplies sufficient information to NAF, i.e. the Bootstrapping Transaction Identifier (B-TID), to allow the NAF to retrieve specific key material (e.g. Ks\_NAF in the case of GBA\_ME, and Ks\_ext\_NAF or Ks\_int\_NAF or both in the case of GBA\_U) from BSF. +- The UE derives the keys required to protect protocol Ua from the key material. + +B) The NAF starts protocol Zn with BSF + +- The NAF requests NAF specific key material corresponding to the information supplied by the UE to the NAF (i.e. the bootstrapping transaction identifier) in the start of protocol Ua. +- The BSF generates and supplies to the NAF the requested NAF specific key material, the expiry time, the bootstrapinfo creation time, and the appropriate User Security Settings defined for received application identifiers. + +C) The NAF continues protocol Ua with the UE (see 3GPP TS 33.221 [6]) + +Once the run of protocol Ua is completed the purpose of bootstrapping is fulfilled as it enabled UE and NAF to run protocol Ua in a secure way. + +The common GAA application procedure is presented in Figure 5.3. + +![Sequence diagram of the Diameter based GAA application procedure showing interactions between UE, NAF, and BSF.](6f31cdb576d2f15c35c3f266e5f59211_img.jpg) + +The diagram illustrates the Diameter based GAA application procedure involving three main entities: UE (User Equipment), NAF (Network Application Function), and BSF (Bootstrap Server). The initial state shows the UE knowing ****, the NAF having a security association created by bootstrapping, and the BSF having a tuple ****. The BSF's GUSS is defined as GBA User Security Settings, and GSID is the GAA Service Identifier. The procedure consists of the following steps: + +- The UE starts the GAA application procedure by sending a B-TID to the NAF. +- The NAF sends a **1. Bootstrapping-Info-Request ( B-TID, GSID\*, NAF-Id)** to the BSF. +- The BSF checks the B-TID and derives **ME-Key and UICC-Key**. +- The BSF sends a **3. Bootstrapping-Info-Answer ( IMPI, Key-ExpiryTime, Ks\_(ext)\_NAF, Ks\_int\_NAF, BootstrapInfoCreationTime, UserSecSetting\* )** back to the NAF. +- Finally, the UE and NAF mutually authenticate each other using ME-Ks. + +Sequence diagram of the Diameter based GAA application procedure showing interactions between UE, NAF, and BSF. + +Figure 5.3: The Diameter based GAA application procedure + +The steps of the GAA application procedure in Figure 5.3 are: + +Step 1 + +The NAF shall send a Bootstrapping-Info-Request message (BIR) to the BSF. The content of the message is given here in the same format as in 3GPP TS 29.229 [3]. The curly brackets indicate mandatory AVPs. The square brackets indicate optional AVP. The address refers to the Fully Qualified Host Name (FQDN). + +``` + +< Bootstrapping-Info-Request> ::= < Diameter Header: 310, REQ, PXY, 16777220 > + < Session-Id > + { Vendor-Specific-Application-Id } + [ Auth-Session-State ] ; NO_STATE_MAINTAINED + { Origin-Host } ; Address of NAF + { Origin-Realm } ; Realm of NAF + { Destination-Realm } ; Realm of BSF + [ Destination-Host ] ; Address of the BSF + * [ GAA-Service-Identifier ] ; Service identifiers + { Transaction-Identifier } ; B-TID + { NAF-Id } ; NAF_ID + [ GBA_U-Awareness-Indicator ] ; GBA_U awareness of the NAF + * [ AVP ] + * [ Proxy-Info ] + * [ Route-Record ] + +``` + +The content of Vendor-Specific-Application-ID according IETF RFC 6733 [33] is: + +``` + + ::= + 1* [Vendor-Id] ; 3GPP is 10415 + 0*1 {Auth-Application-Id} ; 16777220 + 0*1 {Acct-Application-Id} ; Omitted + +``` + +The NAF should set the Auth-Session-State AVP to NO\_STATE\_MAINTAINED to inform that the BSF does not need to maintain any session state information for this session according 3GPP TS 29.229 [3]. + +The Destination-Realm AVP is set to subscriber's BSF. The address of the BSF is extracted from the B-TID. + +NOTE: In the case where the subscriber has contacted a NAF that is in a visited network, the NAF contacts the subscriber's home BSF through a Diameter based Proxy (Zn-Proxy) that is located in the same network as the NAF. The local BSF and the Zn-Proxy may be co-located. See 3GPP TS 33.220 [6]. + +The NAF indicates the GAA services for which the information is retrieved by GAA-Service-Identifier AVPs. The Bootstrapping Transaction Identifier defines the earlier bootstrapping procedure execution. + +### Step 2 + +In the successful case the BSF has a tuple identified by Bootstrapping Transaction Identifier (B-TID). When the BSF receives the request it checks the existence and validity of the tuple for given B-TID. If checking fails the BSF sends an Answer message with Experimental-Result set to indicate the error type 5403. If the tuple for B-TID exists, but is expired, error type 5403 is also sent to indicate needs for renewal of the bootstrapping procedure. In successful case the Result-Code is set to 2xxx as defined in IETF RFC 6733 [33]. + +The BSF derives the key material for the ME (i.e., Ks\_NAF in the case of GBA\_ME, and Ks\_ext\_NAF in the case of GBA\_U) and possibly the key material for the UICC (i.e., Ks\_int\_NAF in the case of GBA\_U) according to the B-TID and packs them into ME-Key-Material AVP and possible UICC-Key-Material AVP. The ME-Key-Material contains Ks\_(ext)\_NAF and the UICC-key-Material contains the Ks\_int\_NAF key. The BSF select correct user's Security Settings according the request's GAA-Service-Identifier AVP to GBA-UserSecSettings AVP. If NAF grouping is used by the operator and there are one or more USSs corresponding to the requested GSID, then also the nafGroup attribute of USS is checked. If the NAF has sent a GAA-Service-Identifier that does not have corresponding user's security settings, and the BSF is locally configured to reject those requests from the NAF, then the error 5402 is raised. If the NAF has sent a GAA-Service-Identifier that have corresponding user's security settings, but the BSF is locally configured to reject those from that NAF, then the error 5402 is raised too. + +The NAF may be addressed from the UE with different FQDNs. The BSF shall check if this NAF-Id is allowed to be used for the NAF. If the NAF identified by its Origin-Host AVP is configured in the BSF not to be authorized to use the given NAF-Id, the BSF may raise the error situation 5402. The BSF may also be configured so that a certain NAF is not authorized to use a certain GAA-Service-Identifier. This situation may be also indicated by error code 5402. + +Exceptions to the cases specified here shall be treated by BSF as error situations. The Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY. + +### Step 3 + +After that the BSF shall send a Bootstrapping-Info-Answer message (BIA) back to the NAF. + +``` +< Boostrapping-Info-Answer> ::= < Diameter Header: 310, PXY, 16777220 > + < Session-Id > + { Vendor-Specific-Application-Id } + [ Result-Code ] + [ Experimental-Result ] + [ Auth-Session-State ] ; NO_STATE_MAINTAINED + { Origin-Host } ; Address of BSF + { Origin-Realm } ; Realm of BSF + [ User-Name ] ; IMPI + [ ME-Key-Material ] ; Required + [ UICC-Key-Material ] ; Conditional + [ Key-ExpiryTime ] ; Time of expiry + [ BootstrapInfoCreationTime ] ; Bootstrapinfo creation time + [ GBA-UserSecSettings ] ; Selected USSS + [ GBA-Type ] ; GBA type used in bootstrapping + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +The BSF shall set the Auth-Session-State AVP to NO\_STATE\_MAINTAINED because the BSF does not maintain any session state information about this session and the NAF does not need to send any session termination request 3GPP TS 29.229 [3]. + +The BSF may or may not send the User-name AVP (IMPI) according its configuration. + +The mandatory common key material with the ME (Ks\_NAF or Ks\_ext\_NAF) is sent in the ME-Key-Material AVP. The common key material with the UICC (Ks\_int\_NAF) is optionally sent in the UICC-Key-Material AVP only if the "uiccType" tag in bsfInfo from the HSS is set to "GBA\_U". + +The Key-ExpiryTime AVP contains the expiry time of the Bootstrapping information in the BSF according its configuration. The expiry time is represented according the Diameter Time data format in seconds that have passed since 0h on January 1, 1900 UTC . If a special key lifetime value is given in the "lifeTime" tag inside the bsfInfo from the HSS in bootstrapping procedure, it is used instead of the BSF default configuration value when the expiry time is calculated. + +The BootstrapInfoCreationTime AVP contains the bootstrapinfo creation time, i.e., creation time of the Bootstrapping information in the BSF. The bootstrapinfo creation time is represented in seconds that have passed since January 1, 1900 00:00:00.000 UTC. + +The BSF selects the appropriate User Security Settings (if any) to the GBA-UserSecSettings AVP from stored GAA-UserSecSettings in Bootstrapping information according the GBA-Service-Identifier AVPs in the request message. + +The BSF shall indicate the type of used authentication in the bootstrapping procedure to the NAF in GBA-Type, if other than 3G GBA type has been performed. + +When the NAF receives the BIA message, the NAF shall check the value of the GBA-Type AVP if it is included in the message. If the NAF does not support the GBA-Type the NAF shall stop processing the message and should indicate an error via the O&M subsystem. The further procedure in the NAF when the BIA is received is described in 3GPP TS 33.220 [5], 3GPP TS 33.222 [11] and optionally in GAA service type specific TSs. + +## 5.3 Protocol Zn between NAF and BSF based on Web Services + +The procedures in the NAF and in the BSF related Web Services [13] based Zn interface are the same as specified in clause 5.2, but instead of Diameter messages a Web Services procedures shall be used to communicate over Zn interface. Annex D specifies the GBA Service for Web Services, i.e., it contains the Web Services Definition Language (WSDL) [14] specification for GBA Service. Below are the attributes that are defined for GBA Service request, response, and fault cases. + +![Sequence diagram of the Web Services based GAA application procedure. The diagram shows three main entities: UE, NAF, and BSF. The UE starts the GAA application procedure by sending a B-TID to the NAF. The NAF then sends a 'requestBootstrappingInfoRequest' message to the BSF. The BSF checks the B-TID and derives ME-Key and UICC-Key. The BSF then sends a 'requestBootstrappingInfoResponse' message back to the NAF. Finally, the UE and NAF mutually authenticate each other using ME-Ks. The diagram also includes state boxes: 'UE knows: ', '{ a security association created by bootstrapping }', and 'BSF has tuple: '.](90ddb84c323b956e2d50a54d3f870566_img.jpg) + +``` + +sequenceDiagram + participant UE + participant NAF + participant BSF + + Note left of UE: UE knows: + Note right of BSF: BSF has tuple: + Note center: { a security association created by bootstrapping } + + UE->>NAF: UE start the GAA application procedure by sending a B-TID. + NAF->>BSF: 1. requestBootstrappingInfoRequest ( b-tid, nafid, gsid*, gbaUAware, extension ) + BSF->>NAF: 2. BSF checks the B-TID and derives ME-Key and UICC-Key + BSF->>NAF: 3. requestBootstrappingInfoResponse ( impi, meKeyMaterial, uiccKeyMaterial, keyExpiryTime, bootstrappingInfoCreationTime, gbaType, ussList, extension ) + Note left of UE: UE and NAF mutually authenticate each others using ME-Ks + +``` + +Sequence diagram of the Web Services based GAA application procedure. The diagram shows three main entities: UE, NAF, and BSF. The UE starts the GAA application procedure by sending a B-TID to the NAF. The NAF then sends a 'requestBootstrappingInfoRequest' message to the BSF. The BSF checks the B-TID and derives ME-Key and UICC-Key. The BSF then sends a 'requestBootstrappingInfoResponse' message back to the NAF. Finally, the UE and NAF mutually authenticate each other using ME-Ks. The diagram also includes state boxes: 'UE knows: ', '{ a security association created by bootstrapping }', and 'BSF has tuple: '. + +**Figure 5.4: The Web Services based GAA application procedure** + +The possible attribute value definitions and restrictions for the request, response, and fault messages are the same as in clause 6 unless explicitly specified in this clause. The steps of the GAA application procedure in Figure 5.4 are: + +### Step 1 + +The NAF shall send a "requestBootstrappingInfoRequest" message to the BSF. The WSDL schema of this message is included in Annex D. + +Following elements are included into this message: + +#### - "btid" + +This is B-TID and defines the earlier bootstrapping procedure execution. Description in subclause 6.3.1.2 applies. + +#### - "nafid" + +This is the NAF-Id. Description in subclause 6.3.1.3 applies. + +#### - "gsid" + +This element contains the GAA Services Identifiers. Description in subclause 6.3.1.4 applies while the GAA Service Type Codes for 3GPP standardized services are defined in Annex B. + +#### - "gbaUAware" + +This element is optionally included. It indicates whether NAF is GBA\_U aware, and is capable of using and handling the "uiccKeyMaterial". The default value for "gbaUAware" is false. Description and values defined for the corresponding Diameter AVP in subclause 6.3.1.8 apply. + +The NAF may use one or more "extension" elements to include additional data to the request, but the BSF may ignore the additional data. + +This SOAP message shall be sent to BSF, then the URI of the message shall contain the BSF address extracted from "btid". In the case where the subscriber has contacted a NAF that is in a visited network, the + +NAF contacts the subscriber's home BSF through a GBA-Proxy that is located in the same network as the NAF. The local BSF and the GBA-Proxy may be co-located. See 3GPP TS 33.220 [6]. + +### Step 2 + +The procedures for step 2 are the same as in step 2 in clause 5.2. + +If any of the error situations described in step 2 in clause 5.2 arises, the BSF shall respond with a "requestBootstrappingInfoFault" message, as defined in Annex D. The "errorCode" element shall contain the corresponding Diameter error code (see clause 6.2.2). If the "errorText" is included, it shall contain a human-readable description of the error. + +### Step 3 + +After that, "requestBootstrappingInfoResponse" message is sent back to the NAF. The WSDL schema of this message is included in Annex D. + +Following elements are included into this message: + +#### - "impi" + +This element is optionally included according to BSF configuration. Description for User-Name AVP from 3GPP TS 29.229 [3] applies. + +#### - "meKeyMaterial" + +It includes the mandatory common key material with the ME (Ks\_NAF or Ks\_ext\_NAF). Description in subclause 6.3.1.6 applies. + +#### - "uiccKeyMaterial" + +This element is the common key material with the UICC (Ks\_int\_NAF). It is optionally sent only if the "uiccType" tag in "bsfInfo" (received by BSF from the HSS over Zh) is set to "GBA\_U". Description in subclause 6.3.1.7 applies. + +#### - "keyExpiryTime" + +It contains the expiry time of the Bootstrapping information in the BSF according its configuration. If a special key lifetime value is given in the "lifeTime" tag inside the "bsfInfo" (received by BSF from the HSS over Zh) in bootstrapping procedure, it shall be used instead of the BSF default configuration value when the expiry time is calculated. Description in subclause 6.3.1.5 applies. + +#### - "bootstrappingInfoCreationTime" + +This element contains the bootstrapinfo creation time, i.e., creation time of the Bootstrapping information in the BSF. Description in subclause 6.3.1.9 applies. + +#### - "gbaType" + +This element indicates the type of used authentication in the bootstrapping procedure to the NAF in "gbaType" element. It shall be included if other than 3G GBA type has been performed. Description and values defined for the corresponding Diameter AVP in subclause 6.3.1.11 apply. + +#### - "ussList" + +This element is optionally included. The BSF shall select the appropriate User Security Settings (if any) into the "ussList" element from stored GAA-UserSecSettings in Bootstrapping information according "gsid" elements in the request message. The "ussList" element contains a standalone XML document whose root element shall be "ussList" element as specified in Annex A and which contains the User Security Settings selected by the BSF. Description in subclause 6.3.1.1 applies. + +The BSF may use one or more "extension" elements to include additional data to the request, but the NAF may ignore the additional data. + +When the NAF receives the "requestBootstrappingInfoResponse" message, the NAF shall check the value of the "gbaType" element if it is included in the message. If the NAF does not support the GBA type the NAF + +shall stop processing the message and should indicate an error via the O&M subsystem. The further procedure in the NAF when the requestBootstrappingInfoResponse message is received is described in 3GPP TS 33.220 [5], 3GPP TS 33.222 [11] and optionally in GAA service type specific TSs. + +## 5.4 Protocol Zpn between NAF and BSF based on Diameter + +The requirements for Zpn interface are defined in 3GPP TS 33.223 [23]. + +The protocol Zpn retrieves the GPI, key material and possibly user security settings data by NAF from BSF. When the NAF wants to send data to the UE, but the NAF has no valid NAF-key available, the following steps are executed as depicted in Figure 5.4. The basic procedure is: + +In general, the UE and the NAF will not yet share the key(s) required to protect protocol Ua. If they already do, there is no need for the NAF to invoke protocol Zpn. + +It is assumed that the NAF has sufficient information available, i.e. user identity and the address of BSF. + +A) The NAF starts protocol Zpn with BSF + +- The NAF requests GBA-Push-Info (GPI), NAF specific key material corresponding to the user identity. +- The BSF fetches AVs from the HSS, generates and supplies to the NAF the requested GPI, NAF specific key material, the expiry time, the bootstrapinfo creation time, and the appropriate User Security Settings defined for received application identifiers. + +B) The NAF sends GPI over protocol Upa to the UE (see 3GPP TS 33.223 [23]) + +Once the run of protocol Upa is completed the purpose of bootstrapping is fulfilled and it will enable the UE and NAF to run protocol Ua in a secure way. + +The GBA push procedure over Zpn is presented in Figure 5.4. + +![Sequence diagram of the Diameter based GBA push procedure over Zpn. Lifelines: UE, NAF, BSF, HSS. The procedure involves a GBA-Push-Info-Request from NAF to BSF, an AV request from BSF to HSS, an AV response from HSS to BSF, a GBA-Push-Info-Answer from BSF to NAF, and a final GPI push from NAF to UE.](28d75f39a24203712ee907b32cf0bbe5_img.jpg) + +``` + +sequenceDiagram + participant UE + participant NAF + participant BSF + participant HSS + + Note right of BSF: 2. BSF processing, generation of NAF keys and GPI + + NAF->>BSF: 1. GBA-Push-Info-Request (user identity, NAF-Id, GSID*, ...) + BSF->>HSS: AV request (user identity, ...) + HSS-->>BSF: AV response (AV, USS, ...) + BSF->>NAF: 3. GBA-Push-Info-Answer (IMPI, GPI, Ks_(ext)_NAF, Ks_int_NAF, USS, ...) + NAF->>UE: GPI push (cf. TS 33.223) + +``` + +Sequence diagram of the Diameter based GBA push procedure over Zpn. Lifelines: UE, NAF, BSF, HSS. The procedure involves a GBA-Push-Info-Request from NAF to BSF, an AV request from BSF to HSS, an AV response from HSS to BSF, a GBA-Push-Info-Answer from BSF to NAF, and a final GPI push from NAF to UE. + +Figure 5.4-1: The Diameter based GBA push procedure over Zpn + +The steps of the GBA push procedure in Figure 5.4-1 are: + +- Step 1 + +The NAF shall send a GBA-Push-Info-Request message to the BSF. The content of the message is given here in the same format as in 3GPP TS 29.229 [3]. The curly brackets indicate mandatory AVPs. The square brackets indicate optional AVP. The address refers to the Fully Qualified Domain Name (FQDN). + +``` + +< GBA-Push-Info-Request > ::= < Diameter Header: xxx, REQ, PXY, xxxxxxxx > + < Session-Id > + { Vendor-Specific-Application-Id } + { Origin-Host } ; Address of NAF + { Origin-Realm } ; Realm of NAF + { Destination-Realm } ; Realm of BSF + [ Destination-Host ] ; Address of the BSF + { UE-Id } ; User identity + { UE-Id-Type } ; Public or private identity + { UICC-App-Label } ; UICC application label + * [ GAA-Service-Identifier ] ; Service identifiers + { NAF-SA-Identifier } ; P-TID + { NAF-Id } ; NAF_ID + { UICC-ME } ; Use of GBA_ME or GBA_U + { Requested-Key-Lifetime } ; Requested NAF-Key lifetime + { Private-Identity-Request } ; Request private identity + [ GBA_U-Awareness-Indicator ] ; GBA_U awareness of the NAF + [ Security-Feature-Request ] ; Sec. feature request + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +The content of Vendor-Specific-Application-ID according IETF RFC 6733 [33] is: + +``` + + ::= + 1* [Vendor-Id] ; 3GPP is 10415 + 0*1 {Auth-Application-Id} ; xxxxxxxx + 0*1 {Acct-Application-Id} ; Omitted + +``` + +The Destination-Realm AVP and Destination-Host AVP are set to subscriber's BSF. + +NOTE: In the case the NAF is in a visited network, the NAF contacts the subscriber's home BSF through a Diameter based Proxy (Zn-Proxy) that is located in the same network as the NAF. In this case the Destination-Host shall not be included. The local BSF and the Zn-Proxy may be co-located. See 3GPP TS 33.220 [6]. + +The NAF indicates the GAA services for which the information is retrieved by GAA-Service-Identifier AVPs. + +With UE-Id and UE-Id-Type AVPs the NAF indicates the user identity and its type, i.e. private or public. The NAF uses UICC-ME and UICC-App-Label AVPs to identify which UICC application is to be used and if GBA-ME or GBA\_U should be used. Private-Identity-Request indicates if the NAF requests the BSF to send the private user identity. Requested-Key-Lifetime AVP indicates the requested key lifetime for the NAF keys. NAF-SA-Identifier (P-TID) is sent to the BSF so that BSF can include it to the encrypted GPI. See 3GPP TS 33.223 [23]. + +The NAF may request information on the availability of security features using the Security-Features-Request AVP. The AVP may contain a semicolon-separated list of security features that are available ordered by preference. + +### - Step 2 + +When the BSF receives the GPI request it checks that the requested key lifetime in the GPI request is less than the allowed max value in the system. If checking fails the BSF sends an Answer message with Experimental-Result set to indicate the error type 5402. In successful case the Result-Code is set to 2xxx as defined in IETF RFC 6733 [33]. + +The BSF includes the received user identity (public or private) to the Zh protocol request. + +If GBA\_U was requested by the NAF, the BSF queries its database to find out if the private user identity is registered and if a valid Ks already exists. If a valid Ks exists, the BSF shall invalidate this Ks + +The BSF derives the key material for the ME (i.e., Ks\_NAF in the case of GBA\_ME, and Ks\_ext\_NAF in the case of GBA\_U) and possibly the key material for the UICC (i.e., Ks\_int\_NAF in the case of GBA\_U) according to the NAF-ID and packs them into ME-Key-Material AVP and possible UICC-Key-Material AVP. The ME-Key-Material contains Ks\_(ext)\_NAF and the UICC-key-Material contains the Ks\_int\_NAF key. The BSF select correct user's Security Settings according the request's GAA-Service-Identifier AVP to GBA-UserSecSettings AVP. If NAF grouping is used by the operator and there are one or more USSs corresponding to the requested GSID, then also the nafGroup attribute of USS is checked. If the NAF has sent a GAA-Service-Identifier that does not have corresponding user's security settings, and the BSF is locally configured to reject those requests from the NAF, then the error 5402 is raised. If the NAF has sent a GAA-Service-Identifier that have corresponding user's security settings, but the BSF is locally configured to reject those from that NAF, then the error 5402 is raised too. + +The BSF generates the GPI according to TS 33.223 [23]. + +The BSF shall check if this NAF-Id is allowed to be used for the NAF. If the NAF identified by its Origin-Host AVP is configured in the BSF not to be authorized to use the given NAF-Id, the BSF may raise the error situation 5402. The BSF may also be configured so that a certain NAF is not authorized to use a certain GAA-Service-Identifier. This situation may be also indicated by error code 5402. + +### - Step 3 + +After that the BSF shall send a GBA-Push-Info-Answer message back to the NAF. The BSF deletes the used Ks according to 3GPP TS 33.223 [23]. + +``` + +< GBA-Push-Info-Answer> ::= < Diameter Header: xxx, PXY, xxxxxxxxx > + < Session-Id > + { Vendor-Specific-Application-Id } + [ Result-Code ] + [ Experimental-Result ] + { Origin-Host } ; Address of BSF + { Origin-Realm } ; Realm of BSF + [ User-Name ] ; IMPI + [ ME-Key-Material ] ; Required + [ UICC-Key-Material ] ; Conditional + [ Key-ExpiryTime ] ; Time of expiry + [ BootstrapInfoCreationTime ] ; Bootstrapinfo creation time + [ GBA-UserSecSettings ] ; Selected USSs + [ GBA-Type ] ; GBA type used in bootstrapping + [ GBA-Push-Info ] ; GBA Push Info + [ Security-Feature-Response ] ; Sec. feature response + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +The BSF may or may not send the User-name AVP (IMPI) It is only returned if requested and public user identity was used in the GBA-Push-Info-Request message according its configuration. + +The mandatory common key material with the ME ( $Ks\_NAF$ or $Ks\_ext\_NAF$ ) is sent in the ME-Key-Material AVP. The common key material with the UICC ( $Ks\_int\_NAF$ ) is optionally sent in the UICC-Key-Material AVP only if the "uiccType" tag in bsfInfo from the HSS is set to "GBA\_U". + +The Key-ExpiryTime AVP contains the expiry time of the Bootstrapping information in the BSF according its configuration. The expiry time is represented according the Diameter Time data format in seconds that have passed since 0h on January 1, 1900 UTC . If a special key lifetime value is given in the "lifeTime" tag inside the bsfInfo from the HSS in bootstrapping procedure, it is used instead of the BSF default configuration value when the expiry time is calculated. + +The BootstrapInfoCreationTime AVP contains the bootstrapinfo creation time, i.e., creation time of the Bootstrapping information in the BSF. The bootstrapinfo creation time is represented in seconds that have passed since January 1, 1900 00:00:00.000 UTC. + +The BSF selects the appropriate User Security Settings (if any) to the GBA-UserSecSettings AVP from stored GAA-UserSecSettings in Bootstrapping information according the GBA-Service-Identifier AVPs in the request message. + +The BSF shall indicate the type of used authentication in the bootstrapping procedure to the NAF in GBA-Type, if other than 3G GBA type has been performed. + +The GBA-Push-Info AVP includes the GPI. The contents of GPI are defined in 3GPP TS 33.223 [23]. + +If the BSF supports the usage of securityFeature and the NAF has requested the securityFeatures from the BSF in the request, the BSF shall extract securityFeatures element from the bsfInfo element in subscriber's GUSS and add those security features to the Security-Features-Response AVP in the response which are common in the received securityFeatures request from the NAF and in the extracted information from the bsfInfo element. The common security features are added to the Security-Features-Response AVP in the order as they appear in the bsfInfo element. If securityFeatures element is not defined in the GUSS,or there is no common securityFeature, the BSF shall include an empty string to the Security-Features-Response AVP in the response. + +When the NAF receives the GBA-Push-Info-Answer message, the NAF shall check the value of the GBA-Type AVP if it is included in the message. If the NAF does not support the GBA-Type the NAF shall stop processing the message and should indicate an error via the O&M subsystem. The further procedure in the NAF when the GBA-Push-Info-Answer message is received is described in 3GPP TS 33.223 [23], 3GPP TS 24.109 [7]. + +## 5.5 Protocol Zpn between NAF and BSF based on Web Services + +The procedures in the NAF and in the BSF related Web Services [13] based Zpn interface are the same as specified in clause 5.4, but instead of Diameter messages a Web Services procedures shall be used to communicate over Zpn interface. AnnexG specifies the GBA Service for Web Services, i.e., it contains the Web Services Definition Language (WSDL) [14] specification for GBA Service. Below are the attributes that are defined for GBA Service request, response, and fault cases. + +![Sequence diagram of the Web Services based GAA application procedure. The diagram shows interactions between UE, NAF, BSF, and HSS. The NAF sends a requestGbaPushInfoRequest to the BSF. The BSF performs processing and sends an AV request to the HSS, which returns an AV response. The BSF then sends a requestGbaPushInfoResponse to the NAF. Finally, the NAF sends a GPI push to the UE.](933ecd14c858bf3fc919222d8e357bc8_img.jpg) + +``` + +sequenceDiagram + participant UE + participant NAF + participant BSF + participant HSS + Note right of BSF: 2. BSF processing, generation of NAF keys and GPI + + NAF->>BSF: 1. requestGbaPushInfoRequest (user identity, NAF-Id, GSID*, ...) + BSF->>HSS: AV request (user identity, ...) + HSS-->>BSF: AV response (AV, USS, ...) + BSF->>NAF: 3. requestGbaPushInfoResponse (IMPI, GPI, Ks_(ext)_NAF, Ks_int_NAF, USS, ...) + NAF->>UE: GPI push (cf. TS 33.223) + +``` + +Sequence diagram of the Web Services based GAA application procedure. The diagram shows interactions between UE, NAF, BSF, and HSS. The NAF sends a requestGbaPushInfoRequest to the BSF. The BSF performs processing and sends an AV request to the HSS, which returns an AV response. The BSF then sends a requestGbaPushInfoResponse to the NAF. Finally, the NAF sends a GPI push to the UE. + +**Figure 5.5: The Web Services based GAA application procedure** + +The possible attribute value definitions and restrictions for the request, response, and fault messages are the same as in clause 6 unless explicitly specified in this clause. The steps of the GAA application procedure in Figure 5.4 are: + +### Step 1 + +The NAF shall send a "requestGbaPushInfoRequest message" to the BSF. The WSDL schema of this message is included in Annex G. + +Following elements are included into this message: + +#### - "ptid" + +This is P-TID and it is given to the BSF so that it can be included in the encrypted "gbaPushInfo" element in the response. Description in subclause 6.3.1.19 applies. + +#### - "nafid" + +This is the NAF-Id. Description in subclause 6.3.1.3 applies. + +#### - "gsid" + +This element contains the GAA Services Identifiers. Description in subclause 6.3.1.4 applies while the GAA Service Type Codes for 3GPP standardized services are defined in Annex B. + +#### - "gbaUAAware" + +This element is optionally included. It indicates whether NAF is GBA\_U aware, and is capable of using and handling the "uiccKeyMaterial". The default value for "gbaUAAware" is false. Description and values defined for the corresponding Diameter AVP in subclause 6.3.1.8 apply. + +#### - "userId" + +This element indicates the user identity. Description in subclause 6.3.1.12 applies. + +#### - "userIdType" + +This element indicates the user identity type, i.e. private or public. Description and values defined for the corresponding Diameter AVP in subclause 6.3.1.13 apply. + +#### - "uiccAppLabel" + +This element includes the UICC application identity to be used. Description in subclause 6.3.1.14 applies. + +#### - "uiccOrMe" + +This element indicates the BSF whether GBA\_ME or GBA\_U is to be used for GBA push. Description and values defined for the corresponding Diameter AVP in subclause 6.3.1.15 apply. + +#### - "requestedLifeTime" + +This element indicates the requested key lifetime for the NAF keys. Description in subclause 6.3.1.16 applies. + +#### - "privateIdRequest" + +- If this element is present it indicates that the NAF requests the BSF to send the private user identity of the user. Description and values defined for the corresponding Diameter AVP in subclause 6.3.1.17 apply. "securityFeaturesRequest" + +If this element is present it indicates that the NAF requests information on the availability of security features. The element may contain a semicolon-separated list of security features that are available ordered by preference. Description in subclause 6.3.1.20 applies while the values are defined in Annex A. + +The NAF may use one or more "extension" elements to include additional data to the request, but the BSF may ignore the additional data. + +This SOAP message shall be sent to BSF, then the URI of the message shall contain the BSF address. + +In the case the NAF is in a visited network, the NAF contacts the subscriber's home BSF through a GBA-Proxy that is located in the same network as the NAF. The local BSF and the GBA-Proxy may be co-located. See 3GPP TS 33.220 [6]. + +### Step 2 + +The procedures for step 2 are the same as in step 2 in clause 5.4. + +If any of the error situations described in step 2 in clause 5.4 arises, the BSF shall respond with a requestGbaPushInfoFault message, as defined in Annex G. The "errorCode" element shall contain the corresponding Diameter error code (see clause 6.2.2). If the "errorText" is included, it shall contain a human-readable description of the error. + +### Step 3 + +After that, the "requestGbaPushInfoResponse" message is sent back to the NAF. The WSDL schema of this message is included in Annex G. + +Following elements are included into this message: + +#### - "impi" + +This element is optionally included according to BSF configuration. It is only returned if requested and public user identity was used in "requestGbaPushInfoRequest" message. Description for User-Name AVP from 3GPP TS 29.229 [3] applies. + +#### - "meKeyMaterial" + +It includes the mandatory common key material with the ME (Ks\_NAF or Ks\_ext\_NAF). Description in subclause 6.3.1.6 applies. + +#### - "uiccKeyMaterial" + +This element is the common key material with the UICC (Ks\_int\_NAF). It is optionally sent only if the "uiccType" tag in "bsfInfo" (received by BSF from the HSS over Zh) is set to "GBA\_U". Description in subclause 6.3.1.7 applies. + +#### - "keyExpiryTime" + +It contains the expiry time of the Bootstrapping information in the BSF according its configuration. If a special key lifetime value is given in the "lifeTime" tag inside the "bsfInfo" (received by BSF from the HSS over Zh) in bootstrapping procedure, it shall be used instead of the BSF default configuration value when the expiry time is calculated. Description in subclause 6.3.1.5 applies. + +#### - "bootstrappingInfoCreationTime" + +This element contains the bootstrapinfo creation time, i.e., creation time of the Bootstrapping information in the BSF. Description in subclause 6.3.1.9 applies. + +#### - "gbaType" + +This element indicates the type of used authentication in the bootstrapping procedure to the NAF in "gbaType" element. It shall be included if other than 3G GBA type has been performed. Description and values defined for the corresponding Diameter AVP in subclause 6.3.1.11 apply. + +#### - "ussList" + +This element is optionally included. The BSF shall select the appropriate User Security Settings (if any) into the "ussList" element from stored GAA-UserSecSettings in Bootstrapping information according "gsid" elements in the request message. The "ussList" element contains a standalone XML document whose root element shall be "ussList" element as specified in Annex A and which contains the User Security Settings selected by the BSF. Description in subclause 6.3.1.1 applies. + +#### - "gbaPushInfo" + +This element includes the GPI. Description in subclause 6.3.1.18 applies. + +#### - "securityFeaturesResponse" + +If the BSF supports the usage of securityFeature and the NAF has requested the securityFeatures from the BSF in the request, the BSF shall extract securityFeatures element from the "bsfInfo" element in subscriber's GUSS and add those security features to the securityFeaturesResponse element in the response which are common in the received "securityFeaturesRequest" from the NAF and the extracted information from the "bsfInfo" element. The common security features are added to the "SecurityFeaturesResponse" element in the order as they appear in the "bsfInfo" element. If "securityFeatures" element is not defined in the GUSS or there is no common "securityFeature", the BSF shall add empty string to the "securityFeaturesResponse" element in the response. Description in subclause 6.3.1.21 applies while the values are defined in Annex A. + +The BSF may use one or more "extension" elements to include additional data to the request, but the NAF may ignore the additional data. + +When the NAF receives the "requestGbaPushInfoResponse" message, the NAF shall check the value of the "gbaType" element if it is included in the message. If the NAF does not support the GBA type the NAF shall stop processing the message and should indicate an error via the O&M subsystem. The further procedure in the NAF when the "requestGbaPushInfoResponse" message is received is described in 3GPP TS 33.220 [5], 3GPP TS 33.222 [11] and optionally in GAA service type specific TSs. + +# --- 6 Diameter application for Zh, Zn and Zpn interfaces + +## 6.0 Introduction + +The Zh, Zn and Zpn interface protocols are defined as IETF vendor specific Diameter applications, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the Zh interface application is 16777221 (allocated by IANA). + +The Diameter application identifiers assigned to the Zn and Zpn interface application are 16777220 and 16777268 respectively (allocated by IANA). + +## 6.1 Command-Code values + +The Zn and Zpn interfaces assign new Command-Codes 310 and 312. + +The messages in Zh interface use the same Command-Code value 303 as Multimedia-Auth-Request/Answer messages defined in 3GPP TS 29.229 [3] for Cx interface. + +As the Diameter commands used over Zh, Zn and Zpn have been defined based on the former specification of the Diameter base protocol, the Vendor-Specific-Application-Id AVP is still listed as a required AVP (an AVP indicated as {AVP}) in the command code format specifications defined in this specification to avoid backward compatibility issues, even if the use of this AVP has been deprecated in the new specification of the Diameter base protocol (IETF RFC 6733 [33]). + +## 6.2 Result-Code AVP values + +This section defines new result code values that must be supported by all Diameter implementations that conform to this specification. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and Result-Code AVP shall be absent. + +### 6.2.1 Success + +Errors that fall within the Success category are used to inform a peer that a request has been successfully completed. + +The success category result codes defined in 3GPP TS 29.229 [3] for Cx interface are useless and therefore not required in Zh, Zn and Zpn interfaces. + +### 6.2.2 Permanent failures + +Errors that fall within the Permanent Failures category are used to inform the peer that the request failed, and should not be attempted again. + +The Permanent failure category result codes defined in 3GPP TS 29.229 [3] for Cx interface are useless and therefore not required in Zh, Zn and Zpn interfaces. + +#### 6.2.2.1 DIAMETER\_ERROR\_IDENTITY\_UNKNOWN (5401) + +A message was received by the HSS for an IMPI or IMPU that is unknown. + +#### 6.2.2.2 DIAMETER\_ERROR\_NOT\_AUTHORIZED (5402) + +A message was received by the BSF which the BSF can not authorize. In this case the NAF should indicate to the UE that the service is not allowed. In case of GBA push, the NAF should not contact the UE. + +#### 6.2.2.3 DIAMETER\_ERROR\_TRANSACTION\_IDENTIFIER\_INVALID (5403) + +A message was received by the BSF for an invalid (e.g. unknown or expired) Bootstrapping Transaction Identifier (B-TID). In this case the NAF should request the UE to bootstrap again. + +6.2.2.4 Void + +6.2.2.5 Void + +6.2.2.6 Void + +6.2.2.7 Void + +## 6.3 AVPs + +The AVPs defined in 3GPP TS 29.229 [3] for 3GPP IMS Cx interface Multimedia-Auth-Request/Answer messages are used as they are. + +The following table describes the additional new Diameter AVPs defined for the Zh, Zn and Zpn interface protocol, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. The Vendor-Id header of all AVPs defined in this specification shall be set to 3GPP (10415). + +**Table 6.1: New Diameter Multimedia Application AVPs** + +| Attribute Name | AVP Code | Section defined | Value Type | AVP Flag rules | | | | | +|---------------------------|----------|-----------------|-------------|----------------|-----|------------|----------|-----------| +| | | | | Must | May | Should not | Must not | May Encr. | +| GBA-UserSecSettings | 400 | 6.3.1.1 | OctedString | M, V | | | | No | +| Transaction-Identifier | 401 | 6.3.1.2 | OctetString | M, V | | | | No | +| NAF-Id | 402 | 6.3.1.3 | OctetString | M, V | | | | No | +| GAA-Service-Identifier | 403 | 6.3.1.4 | OctedString | M, V | | | | No | +| Key-ExpiryTime | 404 | 6.3.1.5 | Time | M, V | | | | No | +| ME-Key-Material | 405 | 6.3.1.6 | OctedString | M, V | | | | No | +| UICC-Key-Material | 406 | 6.3.1.7 | OctedString | M, V | | | | No | +| GBA_U-Awareness-Indicator | 407 | 6.3.1.8 | Enumerated | M, V | | | | No | +| BootstrapInfoCreationTime | 408 | 6.3.1.9 | Time | M, V | | | | No | +| GUSS-Timestamp | 409 | 6.3.1.10 | Time | V | | | M | No | +| GBA-Type | 410 | 6.3.1.11 | Enumerated | M, V | | | | No | +| UE-Id | 411 | 6.3.1.12 | OctetString | M, V | | | | No | +| UE-Id-Type | 412 | 6.3.1.13 | Enumerated | M, V | | | | No | +| UICC-App-Label | 413 | 6.3.1.14 | OctetString | M, V | | | | No | +| UICC-ME | 414 | 6.3.1.15 | Enumerated | M, V | | | | No | +| Requested-Key-Lifetime | 415 | 6.3.1.16 | Time | M, V | | | | No | +| Private-Identity-Request | 416 | 6.3.1.17 | Enumerated | M, V | | | | No | +| GBA-Push-Info | 417 | 6.3.1.18 | OctedString | M, V | | | | No | +| NAF-SA-Identifier | 418 | 6.3.1.19 | OctedString | M, V | | | | No | +| Security-Feature-Request | 419 | 6.3.1.20 | OctetString | M, V | | | | No | +| Security-Feature-Response | 420 | 6.3.1.21 | OctetString | M, V | | | | No | +| SHA-256-Indication | 421 | 6.3.1.22 | Enumerated | M, V | | | | No | + +NOTE 1: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. + +### 6.3.1 Common AVPs + +#### 6.3.1.1 GBA-UserSecSettings AVP + +The GBA-UserSecSettings AVP (AVP code 400) is of type OctetString. If transmitted on the Zh interface it contains GBA user security settings (GUSS). If transmitted on the Zn interface it contains the relevant USSs only. The content of GBA-UserSecSettings AVP is a XML document whose root element shall be the "guss" element for Zh interface and the "ussList" element for the Zn interface. The XML schema is defined in annex A. + +#### 6.3.1.2 Transaction-Identifier AVP + +The Transaction-Identifier AVP (AVP code 401) is of type OctetString. This AVP contains the Bootstrapping Transaction Identifier (B-TID). + +#### 6.3.1.3 NAF-Id + +The NAF-Id AVP (AVP code 402) is of type OctetString. This AVP contains the full qualified domain name (FQDN) of the NAF that the UE uses concatenated with the Ua security protocol identifier as specified in 3GPP TS 33.220 [5]. The FQDN of the NAF that is part of the NAF\_Id may be a different domain name that with which the BSF knows the NAF. + +#### 6.3.1.4 GAA-Service-Identifier AVP + +The GAA-Service-identifier AVP (AVP code 403) is of type OctetString. This AVP informs a BSF about the support of a GAA-service by the NAF. According this AVP the BSF can select the right service's user security settings. + +For 3GPP standardized services (e.g., PKI portal), the GAA-Service-Identifier (GSID) shall be in the range 0 to 999999, and the currently standardized values for GSID shall be the GAA Service Type Code of the particular service. The GAA Service Type Codes for 3GPP standardized services are defined in Annex B. + +NOTE: In the future, standardized GSID values that are different than the GAA Service Type Code may be standardised (e.g. to differentiate between the services "MBMS streaming" and "MBMS download") and then several different GSID can exist within one GAA Service Type Code. + +Examples: The GSID is "1" for all PKI-portals, and "4" for all MBMS services. + +#### 6.3.1.5 Key-ExpiryTime AVP + +The Key-ExpiryTime AVP (AVP code 404) is of type Time. This AVP informs the NAF about the expiry time of the key. + +#### 6.3.1.6 ME-Key-Material AVP + +The required ME-Key-Material AVP (AVP code 405) is of type OctetString. The NAF is sharing this key material (Ks\_NAF in the case of GBA\_ME or Ks\_ext\_NAF in the case of GBA\_U) with the Mobile Equipment (ME). + +#### 6.3.1.7 UICC-Key-Material AVP + +The conditional UICC-Key-Material AVP (AVP code 406) is of type OctetString. The NAF may share this key material (Ks\_int\_NAF in the case of GBA\_U) with a security element (e.g. USIM, ISIM, etc..) in the UICC. Only some GAA applications use this conditional AVP. + +#### 6.3.1.8 GBA\_U-Awareness-Indicator + +The conditional GBA\_U-Awareness-Indicator AVP (AVP code 407) is of type Enumerated. The following values are defined. + +NO (0) The sending node is not GBA\_U aware + +YES(1) The sending node is GBA\_U aware + +The default value is 0 i.e. absence of this AVP indicates that the sending node is not GBA\_U aware. + +#### 6.3.1.9 BootstrapInfoCreationTime AVP + +The BootstrapInfoCreationTime AVP (AVP code 408) is of type Time. This AVP informs the NAF about the bootstrapinfo creation time of the key. + +#### 6.3.1.10 GUSS-Timestamp AVP + +The GUSS-Timestamp AVP (AVP code 409) is of type Time. If transmitted this AVP informs the HSS about the timestamp of the GUSS stored in the BSF. + +#### 6.3.1.11 GBA-Type + +The GBA-Type AVP (AVP code 410) is of type Enumerated. The AVP informs the NAF about the authentication type that was used during bootstrapping procedure. + +The following values are defined: + +- 3G GBA (0) The 3G GBA has been performed as defined in TS 33.220 [5]. +- 2G GBA (1) The 2G GBA has been performed as defined in TS 33.220 [5] , Annex I. +- GBA Digest (2) The GBA Digest has been performed as defined in TS 33.220 [5], Annex M. + +The default value is 0 i.e. the absence of this AVP indicates 3G GBA. The value 2 is not applicable for Zpn. + +#### 6.3.1.12 UE-Id + +The UE-Id AVP (AVP code 411) is of type OctedString. The AVP informs the BSF the identity of the user. + +#### 6.3.1.13 UE-Id-Type + +The UE-Id-Type AVP (AVP code 412) is of type Enumerated. The AVP informs the BSF the type of the identity of the user. + +The following values are defined: + +- (0) Private user identity. +- (1) Public user identity. + +#### 6.3.1.14 UICC-App-Label + +The UICC-App-Label AVP (AVP code 413) is of type OctedString. The AVP informs the BSF the UICC application to be used for GBA push. + +#### 6.3.1.15 UICC-ME + +The UICC-ME AVP (AVP code 414) is of type Enumerated. The AVP informs the BSF the whether GBA\_ME or GBA\_U is to be used for GBA push. + +The following values are defined: + +- GBA\_ME (0) GBA\_ME shall be run. +- GBA\_U (1) GBA\_U shall be run. + +#### 6.3.1.16 Requested-Key-Lifetime + +The Requested-Key-Lifetime AVP (AVP code 415) is of type Time. The AVP informs the BSF about the requested lifetime for the NAF keys. + +#### 6.3.1.17 Private-Identity-Request + +The Private-Identity-Request AVP (AVP code 416) is of type Enumerated. The AVP informs the BSF if the NAF requests the private identity of the user. + +The following values are defined: + +- Private identity requested (0) +- Private identity not requested (1) + +#### 6.3.1.18 GBA-Push-Info + +The GBA-Push-Info AVP (AVP code 417) is of type OctetString. The AVP includes the GBA-Push-Info as defined in 3GPP TS 33.223 [23]. + +#### 6.3.1.19 NAF-SA-Identifier + +The NAF-SA-Identifier AVP (AVP code 418) is of type OctetString. The AVP contains the NAF-SA-Identifier (P-TID). See 3GPP TS 33.223 [23]. + +#### 6.3.1.20 Security-Feature-Request + +The Security-Feature-Request AVP (AVP code 419) is of type OctetString. The AVP contains one or several of the security features requested by the NAF. The values are defined in Annex A. + +#### 6.3.1.21 Security-Feature-Response + +The Security-Feature-Response AVP (AVP code 420) is of type OctetString. The AVP contains one or several of the security features identified by the HSS. This information is conveyed to the BSF using the "securityFeatures" element in the "bsfElement" of GUSS (cf. Annex A), and the securityFeatures received in the request. The values are defined in Annex A. + +#### 6.3.1.22 SHA-256-Indication + +The conditional SHA-256-Indication AVP (AVP code 421) is of type Enumerated. The following values are defined. + +UICC\_NOT\_SUPPORT\_SHA256 (0) UICC does not support SHA-256 + +UICC\_SUPPORT\_SHA256 (1) UICC supports SHA-256 + +The default value is 0 i.e. absence of this AVP indicates that the UICC does not support SHA-256. + +## 6.4 User identity to HSS resolution + +The User identity to HSS resolution mechanism enables the BSF to find the identity of the HSS that holds the subscriber data for a given subscriber when multiple and separately addressable HSSs have been deployed by the network operator. The resolution mechanism is not required in networks that utilise a single HSS or when a BSF is configured to use pre-defined HSS. + +The resolution mechanism is equivalent to the mechanism defined for the Cx/Dx interface described in 3GPP TS 23.228 [12] and shall use a Subscription Locator Function (SLF) or a Diameter Proxy Agent. + +The BSF accesses the SLF via the Dz interface. The Dz interface shall be always used in conjunction with the Zh interface. The Dz interface is based on Diameter base protocol as specified in IETF RFC 6733 [33]. The SLF functionality shall use the routing mechanism provided by an enhanced Diameter redirect agent, which is able to extract the Subscriber identity from the received requests. + +The SLF or the Diameter Proxy Agent shall be able to determine the HSS identity. + +To get the HSS identity the BSF shall send the Zh request normally destined to the HSS to a pre-configured Diameter identity. + +- If this Zh request is received by an SLF (acting as a Diameter redirect agent), the SLF shall determine the HSS identity and shall send to the BSF a notification of redirection towards the HSS identity, in response to the Zh request. Multiple HSS identities may be included in the response, as specified in IETF RFC 6733 [33]. In such a case, the BSF shall send the Zh Request to the first HSS identity in the ordered list received in the Zh Response from the SLF. If the BSF does not receive a successful response to the Zh Request, the BSF shall send a Zh Request to the next HSS identity in the ordered list. This procedure shall be repeated until a successful response from an HSS is received. +- If this Zh request is received by the Diameter Proxy Agent, the Diameter Proxy Agent shall determine the HSS identity and shall forward the Zh request directly to the HSS. The BSF shall determine the HSS identity from the response to the Zh request received from the HSS. + +After the user identity to HSS resolution, the BSF may store the HSS identity and, if stored, shall use it in further Zh requests associated to the same Subscriber. + +In networks where the use of the user identity to HSS resolution mechanism is required and the BSF is not configured to use predefined HSS, each BSF shall be configured with the address/name of the SLF or the Diameter Proxy Agent implementing this resolution mechanism. + +# --- 7 Use of namespaces + +This clause contains the namespaces that have either been created in this 3GPP specification, or in 3GPP specification 3GPP TS 29.229 [3] or the values assigned to existing namespaces managed by IANA. + +## 7.1 AVP codes + +This specification reserves the 3GPP vendor specific values 10415:400-499 and assigns values 10415:400-418 for the GAA from the 3GPP AVP Code namespace for 3GPP Diameter applications ([8]). The 3GPP vendor specific AVP code space is managed by 3GPP CT4. See section 6 for the assignment of the namespace in this specification. + +Besides the Diameter base protocol AVPs specified in IETF RFC 6733 [33], this specification reuses the following AVPs from 3GPP TS 29.229 [3]: + +Authentication-Session-State, User-Name, Public-User-Identity and SIP-Auth-Data-Item. + +## 7.2 Experimental-Result-Code AVP values + +This specification reserves Experimental-Result-Code AVP values 10415:2401-2409 and 10415:5401-5409. See section 6.2. + +## 7.3 Command Code values + +Only Command-Codes 310 and 303 from 3GPP TS 29.229 [3] is used in this specification. + +This specification reuses only the Command-Code value, not the content of the original specification. The AVPs, that are defined required in TS 29.229 [3], but are not needed in Zh, Zn or Zpn interfaces, are removed and are therefore not required in Zh, Zn or Zpn interface messages. All new AVPs for GAA are defined optional although they may be mandatory in GAA viewpoint. + +This specification does not assign new command codes to the 3GPP TS 29.229 [3]. + +# Annex A (normative): GBA-UserSecSettings XML definition + +This annex contains the XML schema definition for an XML document carrying the GBA User Security Settings inside GBA-UserSecSettings AVP in Zh,Zn and Zpn interface. + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +NOTE 1: The elements within the complex types ExtensionType allow for compatible standard extensions in future releases. The elements within the other complex types allow for compatible private extensions. + +The values are: + +- The value of the attribute "id" in the element "guss" is the same as user's IM Private Identity (IMPI) used in User-Name AVP. + +- The value of the element "timestamp" in the element "guss" is the same type as GUSS-Timestamp used in GUSS-Timestamp AVP and indicates the timestamp of the GUSS. Timestamp value shall be expressed in UTC form, indicated by a time zone designator "Z" immediately following the time portion of the value. +- The value of the attribute "id" in the element "uss" is the same as service identifier (GSID) used in GAA-Service-Identifier AVP. + +NOTE 2: In the case with currently standardized 3GPP applications (c. f. Annex B), the service identifier (GSID) is the same as the GAA Service Type Code i.e. the "id" and the "type" attribute would have the same value. For example, in the interoperator GAA where the requesting BM-SC (i.e. NAF) is different operator network than the answering BSF, the BM-SC (NAF) can request particular user's MBMS USS by using "4" for the GSID in the "id" attribute in the USS. If the BSF operator wishes to have different MBMS USSs for different BM-SCs (NAFs), it can use the nafGroup attribute to separate NAFs to specific groups, and each group would get a particular USSs: would be given to NAFs in group A, and would be given to NAFs in group B when they request it. NAF groups are operator specific, i.e., operator decides which USS is given to which NAF." + +- The value of the element "uiccType" in the element "bsfInfo" is: +GBA to indicate the basic case, or +GBA\_U to indicate that generation of Ks\_int\_NAF is also required in the BSF. +The default value is GBA. +- The value of the element "lifeTime" in the element "bsfInfo" indicates a user specific key lifetime (duration in seconds). If the lifeTime element is missing the default value in the BSF is used. +- The value of the optional element "securityFeatures" in the element "bsfInfo" indicates a user specific security feature list that the UE supports. If the securityFeature element is missing then the security features are not defined. If there is a list of several values, they are separated by ";". Defined values are: +- "GPL\_U": The UICC supports Generic Push Layer on the UICC as specified in 3GPP TS 33.224 [30]. +- The value of attribute "type" in the element "uss" is GAA service type code defined in annex B. +- The value of attribute "nafGroup" in the element "uss" is an operator internal group designator for a NAF group the USS is valid for. If this attribute is missing then only the attribute "id" is used for selection of this element. +- Values of the element "uid" are user's public authentication identities from the HSS. +- Values of element "flag" are user's authorization flag codes from the HSS for GAA service type indicated in the type attribute in the parent uss element. If an authorization flag exist the NAF have permission to give the corresponding service, otherwise not +- The value of the element "keyChoice" in the "Extension" element inside the "uss" element is "ME-based-key", i.e., Ks\_NAF or Ks\_ext\_NAF shall be used, or "UICC-based-key", i.e., Ks\_int\_NAF shall be used or "ME-UICC-based-keys", i.e., Ks\_ext\_NAF or Ks\_int\_NAF can be used. The value of this element indicates to the NAF, which key shall be used. If the keyChoice element is missing, then as a default the "ME-based-key" shall be used by the NAF unless a prior agreement exists that mandates to use "UICC-based-key" or "ME-UICC-based-keys". + +In the following illustrative examples the values are *italised and underlined*. The content of one User Security Setting tag is boxed. + +``` + + + 86400 + + + + + tel:358504836551 + lauri.laitinen@example.com + ... + + + +``` + +``` + + + + 1 + ... + + + ME-based-key + + + ... + + + +``` + +The above GAA User Security Settings example for user "358500004836551@ims.mnc050.mcc358.3gppnetwork.org" defines that for PKI-Portal (GAA service type code is 1) services are allowed for user identities "tel:358504836551" and "lauri.laitinen@example.com" and authentication is allowed (flag 1 exists) but non-repudiation is not allowed (flag 2 is missing) to NAFs that provide the GAA service identified by "1" GAA Service Identifier. This particular USS for PKI-Portal is intended to be used only with a NAF group that is labeled as "A" (NAF groupings and NAFs that belong to these groups are specified by the MNO). Additionally, the key choice for the PKI-Portal should use only ME based key (as key keyChoice is set to "ME-based-key"). The BSF shall not generate UICC-Ks, because uiccType is missing. A special key lifetime defines that the duration after which the key expires is 86400 seconds. + +``` + + + + + + tel:358504836551 + lauri.laitinen@example.com + + + 1 + + + ME-based-key + + + +]]> + +``` + +The above is an example how the value of "GAA-UserSecSettings" in Diameter based Zn reference point and "ussList" in Web Services based Zn reference point is populated. + +NOTE 3: The BSF has removed the "nafGroup" attribute from "uss" element. Also, the XML document has been surrounded by "" tags, so that the XML parser handling the outer message (i.e., in Web Services case) will not parse the ussList. The ussList will be parsed by the application itself handling the incoming message. + +Below is an example illustrating the usage of the flag for service authorization. The content of one User Security Setting tag is boxed. + +``` + + + + 86400 + + + + + tel:358501234567 + pekka.mustermann@example.com + ... + + + + + +``` + +``` + + 1 + ... + + + ME-based-key + ... + + + ... + + +``` + +The above GAA User Security Settings example for user "358501234567@ims.mnc050.mcc358.3gppnetwork.org" defines that for ANDSF (GAA service type code is 8) services are allowed for user identities "tel:358501234567" and "pekka.mustermann@example.com" and authentication is allowed (flag 1 exists) i.e. the user is authorized to use the ANDSF service according to the policy stored in the ANDSF server. If the flag contains a 0 or is missing, the stated user identities would not be authorized to use the GAA service identified by "8" GAA Service Identifier. Additionally, the key choice for the ANDSF should use only ME based key (as key keyChoice is set to "ME-based-key"). + +Analogously, the authorization flag is used for OpenID GBA Interworking (GAA Service Type Code 11) the authentication is allowed (flag 1 exists) i.e. the user is authorized to use the OpenID-GBA Interworking service. If the flag contains a 0 or is missing, the stated user identities would not be authorized to use the GAA service identified by "11" GAA Service Identifier. Additionally, the key choice for the OpenID/GBA Interworking should use only ME based key if the keyChoice extension is set to "ME-based-key". + +# --- Annex B (normative): GAA Service Type Codes + +The GAA Service Type Code values are used in GAA to indicate interpretation, coding and usage of GAA service type specific data. + +For examples each GAA service type may have their own set of authorization flags. Meaning and coding of these flags are defined in Annex C. There may also be proprietary GAA service types with their own definitions in the future. + +Code values 0 – 999999 are reserved for standardized GAA service types. + +The following values are defined for standardized GAA service types with 3GPP specification: + +- 0 Unspecific service +- 1 PKI-Portal +- 2 Authentication Proxy +- 3 Presence +- 4 MBMS +- 5 Liberty Alliance Project (see [15]) +- 6 UICC - Terminal Key Establishment (see [17]) +- 7 Terminal – Remote Device Key Establishment (see [18]) +- 8 ANDSF (see [24]) +- 9 GBA Push (see [25]) +- 10 IMS based PSS MBMS (see [26]) +- 11 OpenID GBA Interworking (see [29]) +- 12 Generic Push Layer (see [30]) + +Default value is 0. An unspecific service may or may not have user security settings containing or not a list of public identities. An unspecific service cannot have specified authorization flags or other service type specific data. + +# --- Annex C (normative): GAA Authorization flag codes + +For GAA services which have a defined set of special authorization flag codes the following rule holds: The service specified by the GAA authorization flag codes is allowed for a user only if user's user security setting contains that flag. + +The following standardised GAA service types that are listed in previous annex B have the following special authorization flag codes: + +## **PKI-Portal (1)** + +- 1 Authentication allowed +- 2 Non-repudiation allowed + +## **ANDSF (8)** + +- 0 Not authorized +- 1 Authorized according to policy stored in ANDSF server + +## **OpenID Interworking (13)** + +- 0 Not authorized +- 1 Authorized + +# Annex D (normative): Web Services Definition for Zn interface + +This annex contains the Web Services Definition Language (WSDL) [14] for Zn interface: + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +# Annex E (informative): Liberty authentication context definitions for GBA + +## E.1 Introduction + +This clause describes the GBA Authentication Context definition that the Liberty Identity Provider uses to describe GBA parameters to Liberty Service Provider. The Liberty 3GPP Security Interworking is further discussed in 3GPP TR 33.980 [15]. + +## E.2 GBA Authentication context statement data model + +A particular Liberty authentication context statement will capture the characteristics of the process, procedures, and mechanisms by which the authentication authority verified the subject before issuing an identity, protects the secrets on which subsequent authentications are based, and the mechanisms used for this authentication. These characteristics are categorized in the Liberty ID-FF Authentication Context Specification [16] as follows: + +- Identification - Characteristics that describe the processes and mechanism the authentication authority uses to initially create an association between a subject and the identity (or name) by which the subject will be known. +- Technical Protection - Characteristics that describe how the "secret" (the knowledge or possession of which allows the subject to authenticate to the authentication authority) is kept secure. +- Operational Protection - Characteristics that describe procedural security controls employed by the authentication authority (for example, security audits, records archival). +- Authentication Method - Characteristics that define the mechanisms by which the subject of the issued assertion authenticates to the authentication authority (for example, a password versus a smartcard). + +- Governing Agreements - Characteristics that describe the legal framework (e.g. liability constraints and contractual obligations) underlying the authentication event and/or its associated technical authentication infrastructure. + +Compared to Liberty Authentication Context [16], the GBA Authentication Context statement data model adds a description to to which GBA mechanism was used during bootstrapping with the BSF, and how the corresponding shared secret was used with the Identity Provider (IdP) that functions as a NAF. + +The authentication contexts classes specific to mobile terminals specified by Liberty Alliance are called + +- MobileOneFactorUnregistered, +- MobileTwoFactorUnregistered, +- MobileOneFactorContract, and +- MobileTwoFactorContract classes. + +The GBA authentication context uses some of the elements in these classes and introduces a new element called "GBAMechanism", which can be used to describe GBA specific parameters of the authentication. The elements used in the GBA Authentication Context schemas are: + +- GBAMechanismType: describes the GBA bootstrapping mechanism (identifies the method used over Ub reference point); +- AuthenticatorTransportProtocolType: describes the authentication mechanism that was used authenticate the UE towards the Liberty Identity Provider (identifies the method used over Ua reference point); +- KeyActivationType: describes the mechanism to achieve two factor authentication (valid in \*TwoFactor\* authentication schemas). + +## E.3 GBA authentication context statement schema + +This section lists the complete GBA Authentication Context XML schema. It is based on Liberty Authentication Context XML Schema to which the addition is the additional description of how GBA procedures have been conducted, i.e., GBAMechanism element. + +``` + + + + + + + + + + This authentication context has been defined for the + 3GPP and 3GPP2 Generic Bootstrapping Architecture. It + defines new GBAMechanismType and its values, but reuses + the Liberty authentication context schema for other + values. The GBA authentication context is based on the + MobileOneFactor* and MobileTwoFactor* authentication + contexts with the exception that only shared secret + based authentication methods (i.e., symmetric) are used, + and private key (i.e., asymmetric) methods are not + used when authenticating the UE due to the nature of GBA. + + + + + + + + Legacy GBA where existing old authentication + frameworks are used for bootstrapping such +``` + +``` + 2G GBA in 3GPP, and CDMA 1x and CDMA 1xEvDo + in 3GPP2. + + + + + + + + GBA using AKA as specified in 3GPP and 3GPP2. + The shared secret is derived in the mobile and + used in the mobile. + + + + + + + + GBA_U using AKA as specified in 3GPP and 3GPP2. + The shared secret is derived in the UICC and used + in the mobile. + + + + + + + + GBA_U using AKA as specified in 3GPP and 3GPP2. + The shared secret is derived in the UICC and used + in the UICC. + + + + + + + + GBA mechanism used in the bootstrapping procedure. + + + +``` + +``` + + + + + + + + + + + + +``` + +## E.4 GBA authentication context classes + +### E.4.1 GBAOneFactorUnregistered + +This class reflects that there were no mobile customer registration procedures and an authentication of the UE is done without requiring explicit end-user interaction. + +#### E.4.1.1 Associated 3GPP URI + + + +#### E.4.1.2 Class schema + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +### E.4.2 GBATwoFactorUnregistered + +This class reflects that there were no mobile customer registration procedures and a two-factor based authentication of the UE is done requiring an explicit end-user interaction during authentication procedure (e.g., a PIN needs to be typed). + +#### E.4.2.1 Associated 3GPP URI + + + +#### E.4.2.2 Class schema + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +### E.4.3 GBAOneFactorContract + +This class reflects that mobile customer registration procedures have taken place and an authentication of the UE is done without requiring explicit end-user interaction. + +#### E.4.3.1 Associated 3GPP URI + + + +#### E.4.3.2 Class schema + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +### E.4.4 GBATwoFactorContract + +This class reflects that mobile customer registration procedures have taken place and a two-factor based authentication of the UE is done requiring an explicit end-user interaction during authentication procedure (e.g., a PIN needs to be typed). + +#### E.4.4.1 Associated 3GPP URI + + + +#### E.4.4.2 Class schema + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + +``` + +# --- Annex F (informative): SAML authentication context definitions for GBA + +## F.1 Introduction + +This clause describes the GBA Authentication Context definition that an Identity Provider (IdP) uses to describe GBA parameters to a Service Provider (SP). SAML authentication contexts are further discussed in the SAML Authentication Context specification [19]. + +## --- F.2 GBA authentication context declaration data model + +Similarly to Liberty (cf. Annex E), a SAML authentication context declaration captures characteristics of the processes, procedures, and mechanisms by which the authentication authority verified the subject before issuing an identity, protects the secrets on which subsequent authentications are based, and the mechanisms used for this authentication (identification, technical protection, operational protection, authentication method and governing agreements) OASIS Standard [22]. + +Compared to the SAML authentication context declaration data model OASIS Standard [22], the GBA authentication context declaration data model extends the SAML model by adding a description of which GBA mechanism was used during bootstrapping with the BSF, and at the same time restricts the SAML model in a number of respects specific to GBA (only shared secret as authenticator type, only HTTP or SSL as authenticator transport protocol, secret key activation by PIN, only mobile device or smartcard as key storage medium). + +The authentication contexts classes specific to mobile terminals specified by SAML are: + +- MobileOneFactorUnregistered, +- MobileTwoFactorUnregistered, +- MobileOneFactorContract, and +- MobileTwoFactorContract. + +The GBA authentication context classes introduced herein correspond to the above ones and are: + +- GBAOneFactorUnregistered, +- GBATwoFactorUnregistered, +- GBAOneFactorContract, and +- GBATwoFactorContract. + +The GBA authentication context classes are derived from the corresponding SAML authentication context classes by means of the following patterns: + +- The GBA mechanism (corresponding to ME-based GBA, UICC-based GBA, 2G GBA, etc.) is added to the authentication method type for all the four classes. +- A set of GBA-specific restrictions (only shared secret as authenticator type, only HTTP or SSL as authenticator transport protocol, only mobile device or smartcard as key storage medium) is applied to all the four classes. + +- For the "OneFactor" classes (GBAOneFactorUnregistered and GBAOneFactorContract), there is no more difference (compared to the corresponding SAML class) in addition to the two changes described above. +- For the "TwoFactor" classes (GBATwoFactorUnregistered and GBATwoFactorContract), the key activation by means of PIN is mandatory in secret key protection. + +Given the above patterns, the rest of this annex is expected to be understood without further detailed explanations. + +## F.3 GBA authentication context declaration types + +This section lists the type definitions common to all the four GBA authentication context declaration classes. It adds the GBA mechanism elements (and the necessary type definitions) to the SAML types. + +``` + + + + + These types are intended to be used in the definition of + the authentication context classes in 3GPP and 3GPP2 Generic + Bootstrapping Architecture (GBA). The new authentication + context classes are defined separately. + + + + + + + + + GBA mechanism used in the bootstrapping procedure. + + + + + + + Legacy GBA where existing old authentication + frameworks are used for bootstrapping such + 2G GBA in 3GPP, and CDMA 1x and CDMA 1xEvDo + in 3GPP2. + + + + + + + GBA using AKA as specified in 3GPP and 3GPP2. + The shared secret is derived in the mobile and + used in the mobile. + + + + + + + GBA_U using AKA as specified in 3GPP and 3GPP2. + The shared secret is derived in the UICC and used + in the mobile. + + + + + + + GBA_U using AKA as specified in 3GPP and 3GPP2. + The shared secret is derived in the UICC and used + in the UICC. + + + + + +``` + +``` + + + + + + + + + + + +``` + +## F.4 GBA authentication context declaration classes + +### F.4.1 GBAOneFactorUnregistered + +This class reflects that there were no mobile customer registration procedures and an authentication of the UE is done without requiring explicit end-user interaction. + +#### F.4.1.1 Associated 3GPP URI + +urn:3gpp:gba:ac:saml:2007-08:classes:GBAOneFactorUnregistered + +#### F.4.1.2 Class schema + +``` + + + + + + + The GBA authentication context class comparable to + the SAML MobileOneFactorUnregistered class. + Id: 3gpp-gba-saml-authn-context-gbaonefactor-unreg-1.0.xsd + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +### F.4.2 GBATwoFactorUnregistered + +This class reflects that there were no mobile customer registration procedures and a two-factor based authentication of the UE is done requiring an explicit end-user interaction during authentication procedure (e.g., a PIN needs to be typed). + +#### F.4.2.1 Associated 3GPP URI + +urn:3gpp:gba:ac:saml:2007-08:classes:GBATwoFactorUnregistered + +#### F.4.2.2 Class schema + +``` + + + + + + + The GBA authentication context class comparable to + the SAML MobileTwoFactorUnregistered class. + Id: 3gpp-gba-saml-authn-context-gbatwofactor-unreg-1.0.xsd + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +### F.4.3 GBAOneFactorContract + +This class reflects that mobile customer registration procedures have taken place and an authentication of the UE is done without requiring explicit end-user interaction. + +#### F.4.3.1 Associated 3GPP URI + +urn:3gpp:gba:ac:saml:2007-08:classes:GBAOneFactorContract + +#### F.4.3.2 Class schema + +``` + + + + + + + The GBA authentication context class comparable to + the SAML MobileOneFactorContract class. + Id: 3gpp-gba-saml-authn-context-gbaonefactor-reg-1.0.xsd + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + +``` + +### F.4.4 GBATwoFactorContract + +This class reflects that mobile customer registration procedures have taken place and a two-factor based authentication of the UE is done requiring an explicit end-user interaction during authentication procedure (e.g., a PIN needs to be typed). + +#### F.4.4.1 Associated 3GPP URI + +urn:3gpp:gba:ac:saml:2007-08:classes:GBATwoFactorContract + +#### F.4.4.2 Class schema + +``` + + + + + + The GBA authentication context class comparable to + the SAML MobileTwoFactorContract class. + Id: 3gpp-gba-saml-authn-context-mobiletwofactor-reg-1.0.xsd + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +# Annex G (normative): Web Services Definition for Zpn interface + +This annex contains the Web Services Definition Language (WSDL) [14] for Zpn interface: + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + +``` \ No newline at end of file diff --git a/marked/Rel-18/29_series/29153/raw.md b/marked/Rel-18/29_series/29153/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..8194e5c27880cc197fac857fff8ccbcc22df7f96 --- /dev/null +++ b/marked/Rel-18/29_series/29153/raw.md @@ -0,0 +1,667 @@ + + +# 3GPP TS 29.153 V18.0.0 (2024-03) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Service capability exposure functionality over Ns reference point (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +## --- **Keywords** + +Network,AVP,RCAF,SCEF + +## **3GPP** + +## --- **Postal address** + +## --- **3GPP support office address** + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## --- **Internet** + + + +## --- **Copyright Notification** + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|--------------------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Architectural Overview..... | 6 | +| 4.0 Overview ..... | 6 | +| 4.1 Reference Model ..... | 6 | +| 4.2 Functional elements..... | 7 | +| 4.2.1 RCAF..... | 7 | +| 4.2.2 SCEF..... | 7 | +| 4.3 Procedures over the Ns reference point..... | 7 | +| 4.3.1 Network status reporting procedures..... | 7 | +| 4.3.1.1 General..... | 7 | +| 4.3.1.2 Request of one-time or continuous reporting of network status ..... | 7 | +| 4.3.1.3 Continuous reporting of network status ..... | 8 | +| 4.3.1.4 Cancellation of continuous reporting of network status ..... | 8 | +| 4.3.2 RCAF selection ..... | 9 | +| 5 Ns protocol..... | 9 | +| 5.1 Protocol support ..... | 9 | +| 5.2 Initialization, maintenance and termination of connection and session..... | 9 | +| 5.3 Ns specific AVPs ..... | 9 | +| 5.3.1 General ..... | 9 | +| 5.3.2 Network-Congestion-Area-Report AVP ..... | 10 | +| 5.3.3 Ns-Request-Type AVP..... | 10 | +| 5.4 Ns re-used AVPs..... | 10 | +| 5.4.1 General ..... | 10 | +| 5.4.2 Use of the Supported-Features AVP on the Ns reference point..... | 11 | +| 5.5 Ns specific Experimental-Result-Code AVP values..... | 12 | +| 5.5.1 General ..... | 12 | +| 5.5.2 Success ..... | 12 | +| 5.5.3 Permanent Failures ..... | 12 | +| 5.5.4 Transient Failures ..... | 12 | +| 5.6 Ns messages ..... | 12 | +| 5.6.1 Command-Code Values..... | 12 | +| 5.6.2 Network-Status-Request (NSR) command..... | 13 | +| 5.6.3 Network-Status-Answer (NSA) command..... | 13 | +| 5.6.4 Network-Status-Continuous-Report-Request (NCR) command ..... | 14 | +| 5.6.5 Network-Status-Continuous-Report-Answer (NCA) command ..... | 14 | +| Annex A (informative): Call Flows over Ns..... | 14 | +| A.1 Request of one time or continuous reporting of network status ..... | 14 | +| A.2 Continuous reporting of network status ..... | 15 | +| A.3 Cancellation of continuous reporting of network status ..... | 15 | +| Annex B (informative): Change history..... | 17 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +This document defines the protocol for Ns reference point between the Service Capability Exposure Function (SCEF) and RAN Congestion Awareness Function (RCAF). + +The Ns reference point and related stage 2 procedures are defined in 3GPP TS 23.682 [2]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications ". +- [3] IETF RFC 3588: "Diameter Base Protocol". +- [4] 3GPP TS 29.217: "Congestion reporting over Np reference point". +- [5] IETF RFC 7683: "Diameter Overload Indication Conveyance". +- [6] 3GPP TS 29.229: "Cx and Dx interfaces based on Diameter protocol; Protocol details". +- [7] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications Diameter Base Protocol". +- [8] 3GPP TS 29.154: "Service Capability Exposure Functionality over Nt reference point". +- [9] 3GPP TS 29.274: "3GPP Evolved Packet System. Evolved GPRS Tunnelling Protocol for EPS (GTPv2)". +- [10] IETF RFC 5719: "Updated IANA Considerations for Diameter Command Code Allocations". +- [11] IETF RFC 2234: "Augmented BNF for syntax specifications". +- [12] 3GPP TS 29.213: "Policy and charging control signalling flows and Quality of Service (QoS) parameter mapping". +- [13] IETF RFC 7944: "Diameter Routing Message Priority". +- [14] IETF RFC 8583: "Diameter Load Information Conveyance". +- [15] IETF RFC 6733: "Diameter Base Protocol". + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|------|------------------------------------------| +| AS | Application Server | +| DRMP | Diameter Routing Message Priority | +| NCA | Network Status Continuous Report Answer | +| NCR | Network Status Continuous Report Request | +| NSA | Network Status Answer | +| NSR | Network Status Request | +| RCAF | RAN Congestion Awareness Function | +| SCEF | Service Capability Exposure Function | +| SCS | Service Capability Server | + +# 4 Architectural Overview + +## 4.0 Overview + +The Ns reference point is located between the RCAF and SCEF. The Ns reference point is used for network status reporting. + +The stage 2 level requirements for the Ns reference point are defined in 3GPP TS 23.682 [2]. + +Refer to Annex G of 3GPP TS 29.213 [12] for Diameter overload control procedures over the Ns reference point. + +Refer to Annex J of 3GPP TS 29.213 [12] for Diameter message priority mechanism procedures over the Ns interface. + +Refer to Annex K of 3GPP TS 29.213 [12] for Diameter load control procedures over the Ns reference point. + +## 4.1 Reference Model + +The Ns reference point is defined between the RCAF and the SCEF to transfer the network status. The relationship between the two functional entities is depicted in figure 4.1.1. The complete 3GPP architecture for service capability exposure is defined in 3GPP TS 23.682 [2]. + +![Diagram of the Ns reference model showing RCAF and SCEF connected by the Ns reference point.](1d7c39fcec994ceb71107ec910b176b6_img.jpg) + +``` +graph LR; RCAF[RCAF] --- Ns((Ns)); Ns --- SCEF[SCEF]; +``` + +The diagram illustrates the Ns reference model. It consists of two light green rectangular boxes, labeled 'RCAF' on the left and 'SCEF' on the right. A horizontal line connects the two boxes. In the center of this line, there is a small vertical tick mark, and above this tick mark is the label 'Ns', representing the reference point between the two functional entities. + +Diagram of the Ns reference model showing RCAF and SCEF connected by the Ns reference point. + +Figure 4.1.1: Ns reference model + +## 4.2 Functional elements + +### 4.2.1 RCAF + +The RCAF is a functional element which reports network status to the SCEF to enable the SCEF to take the RAN user plane congestion status into account. The network status includes the following information; + +- Congestion level or an indication of the "no congestion" state; +- ECGI, or eNB-ID, or SAI for which the congestion level is being provided. + +### 4.2.2 SCEF + +The SCEF is a functional element which provides a means to securely expose the services and capabilities provided by 3GPP network interfaces. + +Based on the geographical area provided by the SCS/AS and the configuration data, the SCEF determines from which RCAF(s) to request congestion reporting. + +NOTE: The procedures in 3GPP TS 23.682 [2], subclause 5.8, describe the interaction between the SCEF and SCS/AS and the information elements exchanged in the relevant steps of each procedure. When the SCEF receives the network status information from one or more RCAF(s) in both the one-time or continuous reporting cases, it determines the Network Status Indication (NSI) of the geographical area based on the Congestion-Level-Value AVP in the Network-Congestion-Area-Report AVP it receives from the RCAF(s). The NSI value (e.g. High, Medium, Low, No-Congestion) is determined per Service Provider policies. + +## 4.3 Procedures over the Ns reference point + +### 4.3.1 Network status reporting procedures + +#### 4.3.1.1 General + +This clause contains the detailed procedures for: + +- Requesting one-time or continuous network status report ; +- Continuous reporting of network status; +- Cancellation of continuous reporting of network status. + +#### 4.3.1.2 Request of one-time or continuous reporting of network status + +This procedure shall be used by the SCEF to request one-time or continuous network status report. + +This procedure is mapped to Network-Status-Request /Answer commands specified in subclause 5.6. + +After the SCEF authorized a SCS/AS request for notification about the network status, the SCEF shall assign an SCEF Reference ID and identify the RCAF(s) responsible for requesting of the network status report. The identity of the RCAF is found by the SCEF based on the RCAF selection procedure defined in subclause 4.3.2. If multiple RCAF(s) have been found, the procedure shall be invoked multiple times, for each RCAF responsible for the network status report. + +The SCEF shall send a Network-Status-Request (NSR) command to the targeted RCAF. The NSR shall include the Ns-Request-Type AVP with the value 0 (initial request), the SCEF reference ID within SCEF-Reference-ID AVP and the location area in the Network-Area-Info-List AVP, the location area is either a 3GPP location area (e.g. list of TA/RAs, list of cell(s), list of eNBs etc) according to operator configuration or a 3GPP location area (e.g. list of TA/RAs, list of cell(s), list of eNBs etc) as provided by the SCS/AS. + +The SCEF may also include duration in the Monitoring-Duration AVP and the threshold value(s) in Congestion-Level-Range AVP if the SCS/AS requested reporting for specific threshold(s). The duration indicates the time for which a + +continuous reporting is requested. + +The SCEF, based on operator policies, may choose a different threshold value than the one received from the SCS/AS. The SCEF shall not include the Congestion-Level-Range AVP in the request to the RCAF if no threshold was requested by the SCS/AS. + +NOTE: The SCS/AS can be notified when the SCEF changes the threshold provided by the SCS/AS. + +If the continuous reporting is requested, the SCEF shall include the SCEF Id in the SCEF-ID AVP in the NSR command. + +Upon reception of a Network-Status-Request (NSR) command including the Ns-Request-Type AVP with the value 0 (initial request), the RCAF shall send the Network-Status-Answer (NSA) command to the SCEF including the SCEF-Reference-ID AVP and one or more congestion status(es) within Network-Congestion-Area-Report AVP(s). If the Monitoring-Duration AVP is present in the NSR, the RCAF shall store the SCEF Id and the SCEF instruction, and then start to monitor the location area for a change in the congestion status. + +When receiving NSA from the RCAF, the SCEF shall store the report if the SCS/AS request identified via the SCEF reference ID is valid and active. + +#### 4.3.1.3 Continuous reporting of network status + +This procedure shall be used by the RCAF to continuously notify the SCEF of the congestion status list for the location area requested by the SCEF when at least one of the following conditions applies: + +- a threshold is not provided by the SCEF and the congestion level(s) is changed; +- one or more thresholds are provided by the SCEF and the congestion level(s) is changed which corresponds to the threshold(s) provided. + +This procedure is mapped to Network-Status-Continuous-Report-Request/Answer commands specified in subclause 5.6. + +If one or more thresholds was provided to the RCAF by the SCEF, and when the RCAF detects a change in the congestion level(s) and this congestion level(s) corresponds to congestion threshold(s) for the location area (e.g. set of cells or eNodeBs) requested by the SCEF, the RCAF shall send Network-Status-Continuous-Report-Request (NCR) command to report this to the SCEF. + +The NCR command shall include SCEF reference ID within the SCEF-Reference-ID AVP and congestion status within one or more Network-Congestion-Area-Report AVP(s). + +If no threshold was provided to the RCAF by the SCEF, see subclause 4.3.1.2, and when the RCAF detects a change in the congestion level(s) for the location area (e.g. set of cells or eNodeBs) requested by the SCEF, the RCAF shall report the change of congestion level value(s) to the SCEF by sending a NCR command including SCEF reference ID within SCEF-Reference-ID AVP and one or more congestion level value(s) within Network-Congestion-Area-Report AVP(s). + +The RCAF shall include one Network-Congestion-Area-Report AVP per congestion level value reported. + +Within the Network-Congestion-Area-Report AVP the congestion level value shall be included in the Congestion-Level-Value AVP and the affected location area in the Network-Area-Info-List AVP. + +The RCAF shall send an NCR command to the destination SCEF by including the SCEF id within the Destination-Host AVP. + +The SCEF shall acknowledge the NCR command by sending Network-Status-Continuous-Report-Answer (NCA) command. + +#### 4.3.1.4 Cancellation of continuous reporting of network status + +This procedure shall be used by the SCEF to request the cancellation of the continuous network status report. + +This procedure is mapped to Network-Status-Request (NSR)/Network-Status-Answer (NSA) commands specified in subclause 5.6. + +When the SCEF detects that the duration for ongoing continuous reporting of network status is over or is requested to terminate ongoing continuous reporting of network status by the SCS/AS, the SCEF shall identify the RCAF(s) involved in the continuous reporting represented by the SCEF reference ID and send a Network-Status-Request (NSR) + +command to the identified RCAF(s) including the SCEF reference ID in SCEF-Reference-ID AVP and the Ns-Request-Type AVP with the value 1 (cancellation request). + +Upon reception of a NSR command including the Ns-Request-Type AVP with the value 1 (cancellation request), the RCAF shall remove the related SCEF instructions associated with the SCEF reference ID such that the RCAF will no longer notify the SCEF of the change of the network status and send a Network-Status-Answer (NSA) command including the corresponding SCEF reference ID in the SCEF-Reference-ID AVP to acknowledge the cancellation. + +### 4.3.2 RCAF selection + +To discover the RCAF(s) responsible for reporting of network status, the SCEF may use the following information: + +- Geographical area provided by SCS/AS; +- Pre-configured RCAF address for the geographical area the RCAF is responsible for; + +# --- 5 Ns protocol + +## 5.1 Protocol support + +The Ns application is defined as a vendor specific Diameter application, where the vendor is 3GPP and the Application-ID for the Ns Application in the present release is 16777347. The vendor identifier assigned by IANA to 3GPP () is 10415. + +NOTE: A route entry can have a different destination based on the application identification AVP of the message. Therefore, Diameter agents (relay, proxy, redirection, translation agents) must be configured appropriately to identify the 3GPP Ns application within the Auth-Application-Id AVP in order to create suitable routing tables. + +With regard to the Diameter protocol defined over the Ns interface, the RCAF acts as a Diameter server, in the sense that it is the network element that handles network status reporting requests for a particular location. The SCEF acts as the Diameter client, in the sense that is the network element requesting reporting of network status. + +## 5.2 Initialization, maintenance and termination of connection and session + +The initialization and maintenance of the connection between each SCEF and RCAF pair is defined by the underlying protocol. Establishment and maintenance of connections between Diameter nodes is described in IETF RFC 6733 [15]. + +After establishing the transport connection, the SCEF and the RCAF shall advertise the support of the Ns specific Application by including the value of the application identifier in the Auth-Application-Id AVP and the value of the 3GPP (10415) in the Vendor-Id AVP of the Vendor-Specific-Application-Id AVP contained in the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. The Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands are specified in the Diameter Base Protocol (IETF RFC 6733 [15]). + +The Ns Diameter session shall consist of a single request and answer pair. The Ns Diameter session is terminated after each request and answer pair interaction. In order to indicate that the session state is not to be maintained, the Diameter client and server shall include the Auth-Session-State AVP with the value set to NO\_STATE\_MAINTAINED (1), in the request and in the answer messages (see IETF RFC 6733 [15]). + +## 5.3 Ns specific AVPs + +### 5.3.1 General + +Table 5.3.1.1 describes the Diameter AVPs defined for the Ns reference point, their AVP Code values, types, possible flag values, whether or not the AVP may be encrypted and which supported features the AVP is applicable to. The Vendor-Id header of all AVPs defined in the present document shall be set to 3GPP (10415). + +Table 5.3.1.1: Ns specific Diameter AVPs + +| Attribute Name | AVP Code | Clause defined | Value Type (NOTE 2) | AVP Flag rules (NOTE 1) | | | | May Encr. | Applicability (NOTE 3) | +|--------------------------------|----------|----------------|---------------------|-------------------------|-----|------------|----------|-----------|------------------------| +| | | | | Must | May | Should not | Must not | | | +| Network-Congestion-Area-Report | 4101 | 5.3.2 | Grouped | M,V | P | | | Y | | +| Ns-Request-Type | 4102 | 5.3.3 | Unsigned32 | M,V | P | | | Y | | + +NOTE 1: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [15]. + +NOTE 2: The value types are defined in IETF RFC 6733 [15]. + +NOTE 3: AVPs marked with a supported feature are applicable as described in subclause 5.4.1. + +### 5.3.2 Network-Congestion-Area-Report AVP + +The Network-Congestion-Area-Report AVP (AVP code 4101) is of type Grouped, and includes the Network-Area-Info-List AVP and the Congestion-Level-Value-AVP. + +AVP Format: + +``` +Network-Congestion-Area-Report ::= < AVP Header: 4101 > + { Network-Area-Info-List } + [ Congestion-Level-Value ] + *[ AVP ] +``` + +### 5.3.3 Ns-Request-Type AVP + +The Ns-Request-Type AVP (AVP code 4102) is of type Unsigned32, and contains the reason for sending a request message. + +The following values are defined: + +0 (initial request) + +An initial request is used to initiate a one time or continuous reporting and contains information that is relevant to initiation. + +1 (cancellation request) + +A cancellation request is used to cancel an ongoing continuous reporting. + +## 5.4 Ns re-used AVPs + +### 5.4.1 General + +Table 5.4.1.1 lists the Diameter AVPs re-used by the Ns reference point from other existing Diameter Applications, reference to their respective specifications, short description of their usage within the Ns reference point and which supported features the AVP is applicable to. AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol, do not need to be supported. Unless otherwise stated, re-used AVPs shall maintain their 'M', 'P' and 'V' flag settings. + +**Table 5.4.1.1: Ns re-used Diameter AVPs** + +| Attribute Name | Reference | Description | Applicability (NOTE ) | +|--------------------------------------------------------------------------------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| Congestion-Level-Range | 3GPP TS 29.217 [4] | It indicates the list of congestion level(s). | | +| Congestion-Level-Value | 3GPP TS 29.217 [4] | Indicates the congestion level of a location. | | +| DRMP | IETF RFC 7944 [13] | Allows Diameter endpoints to indicate the relative priority of Diameter transactions. | | +| Load | IETF RFC 8583 [14] | The AVP used to convey load information between Diameter nodes.
This AVP and all AVPs within this grouped AVP shall have the 'M' bit cleared. | | +| Monitoring-Duration | 3GPP TS 29.336 [7] | It shall contain the number of seconds for which network status reporting shall be performed. | | +| Network-Area-Info-List | 3GPP TS 29.154 [8] | It contains the network area information which is coded as specified in 3GPP TS 29.274 [9] in Presence Reporting Area Action IE, starting from octet 9. | | +| OC-OLR | IETF RFC 7683 [5] | Contains the necessary information to convey an overload report. | | +| OC-Supported-Features | IETF RFC 7683 [5] | Defines the support for the Diameter overload indication conveyance by the sending node. | | +| SCEF-ID | 3GPP TS 29.336 [7] | It shall contain the identity of the SCEF which has requested the network status reporting. | | +| SCEF-Reference-ID | 3GPP TS 29.336 [7] | It contains the identifier provided by the SCEF. | | +| Supported-Features | 3GPP TS 29.229 [6] | If present, this AVP informs the destination host about the features that the origin host requires to successfully complete this command exchange. | | +| NOTE: AVPs marked with a supported feature are applicable as described in subclause 5.4.2. | | | | + +### 5.4.2 Use of the Supported-Features AVP on the Ns reference point + +When new functionality is introduced on the Ns reference point, it should be defined as optional. If backwards incompatible changes cannot be avoided, the new functionality shall be introduced as a new feature and support advertised with the Supported-Features AVP. Unless otherwise stated, the use of the Supported-Features AVP on the Ns reference point shall be compliant to the usage of the Supported-Features AVP on the Cx reference point and consistent with the procedures for the dynamic discovery of supported features as defined in subclause 7.2 of 3GPP TS 29.229 [6]. + +When extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in 3GPP TS 29.229 [6], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the all reference points as specified in this specification, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +The Supported-Features AVP shall be included in every NSR and NSA command if supported by the RCAF and SCEF respectively. + +The Table 5.4.2.1 defines the features applicable to the Ns reference point for the feature list with a Feature-List-ID of 1. + +Table 5.4.2.1: Features of Feature-List-ID 1 used in Ns + +| Feature bit | Feature | M/O | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-----|-------------| +| Feature bit: The order number of the bit within the Feature-List AVP where the least significant bit is assigned number "0".
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "EPS".
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release.
Description: A clear textual description of the feature. | | | | + +NOTE: This table is a placeholder for when any supported features are added to Ns. There are no supported features in this release. + +## 5.5 Ns specific Experimental-Result-Code AVP values + +### 5.5.1 General + +This clause defines result code values that shall be supported by Diameter implementations that conform to this specification. + +### 5.5.2 Success + +Result Codes that fall into the Success category are used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in Diameter BASE Protocol IETF RFC 6733 [15] are applied. + +### 5.5.3 Permanent Failures + +Errors that fall into the Permanent Failures category shall be used to inform the peer that the request has failed. The Result-Code AVP values defined in Diameter Base Protocol IETF RFC 6733 [15] are applied. + +### 5.5.4 Transient Failures + +Errors that fall within the Transient failures category are used to inform a peer that the request could not be satisfied at the time it was received, but may be able to satisfy the request in the future. + +The Result-Code AVP values defined in Diameter Base Protocol IETF RFC 6733 [15] are applicable. + +## 5.6 Ns messages + +### 5.6.1 Command-Code Values + +This clause defines the Command-Code values for the Ns interface application as allocated by IANA from the vendor-specific namespace defined in IETF RFC 5719 [10]. Every command is defined by means of the ABNF syntax in IETF RFC 2234 [11], and according to the rules in IETF RFC 6733 [15]. + +NOTE: As the commands in the present specification have originally been defined based on the former specification of the Diameter Base Protocol (IETF RFC 3588 [3]), the Vendor-Specific-Application-Id AVP is still assumed as a required AVP (an AVP indicated as {AVP}) in the command code format to avoid backward compatibility issues, even if the use of this AVP has been deprecated in the new specification of the Diameter Base Protocol (IETF RFC 6733 [15]). + +The following Command Codes are defined in this specification: + +**Table 5.6.1: Command-Code values for Ns** + +| Command-Name | Abbreviation | Code | Section | +|------------------------------------------|--------------|---------|---------| +| Network-Status-Request | NSR | 8388724 | 5.6.2 | +| Network-Status-Answer | NSA | 8388724 | 5.6.3 | +| Network-Status-Continuous-Report-Request | NCR | 8388725 | 5.6.4 | +| Network- Status-Continuous-Report-Answer | NCA | 8388725 | 5.6.5 | + +### 5.6.2 Network-Status-Request (NSR) command + +The NSR command, indicated by the Command-Code field set to 8388724 and the 'R' bit set in the Command Flags field, is sent by the SCEF to the RCAF as part of the one time or continuous network status reporting procedure and as part of the cancellation of continuous reporting of network status procedure. + +Message Format: + +``` + ::= + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + [ Origin-State-Id ] + [ OC-Supported-Features ] + { Ns-Request-Type } + [ SCEF-ID ] + [ SCEF-Reference-ID ] + [ Network-Area-Info-List ] + [ Congestion-Level-Range ] + [ Monitoring-Duration ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ Supported-Features ] + *[ AVP ] +``` + +### 5.6.3 Network-Status-Answer (NSA) command + +The NSA command, indicated by the Command-Code field set to 8388724 and the 'R' bit cleared in the Command Flags field, is sent by the RCAF to the SCEF as part of the one time or continuous network status reporting request procedure and as part of the cancellation of continuous reporting of network status procedure. + +Message Format: + +``` + ::= < Diameter Header: 8388724, PXY > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + [ OC-Supported-Features ] + [ OC-OLR ] + [ SCEF-Reference-ID ] + [ Origin-State-Id ] + *[ Network-Congestion-Area-Report ] + *[ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + *[ Proxy-Info ] + *[ Supported-Features ] + *[ Load ] + *[ AVP ] +``` + +### 5.6.4 Network-Status-Continuous-Report-Request (NCR) command + +The NCR command, indicated by the Command-Code field set to 8388725 and the 'R' bit set in the Command Flags field, is sent by the RCAF to the SCEF as part of the continuous network status reporting procedure. + +Message Format: + +``` + ::= + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + [ Origin-State-Id ] + [ OC-Supported-Features ] + [ SCEF-Reference-ID ] + *[ Network-Congestion-Area-Report ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ Supported-Features ] + *[ AVP ] +``` + +### 5.6.5 Network-Status-Continuous-Report-Answer (NCA) command + +The NCA command, indicated by the Command-Code field set to 8388725 and the 'R' bit cleared in the Command Flags field, is sent by the SCEF to the RCAF as part of the continuous network status reporting procedure. + +Message Format: + +``` + ::= < Diameter Header: 8388725, PXY > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + *[ Proxy-Info ] + *[ Supported-Features ] + *[ AVP ] +``` + +# --- Annex A (informative): Call Flows over Ns + +## A.1 Request of one time or continuous reporting of network status + +This signalling flow is used by SCEF to request one time or continuous reporting of network status. + +![Sequence diagram for Figure A.1.1: Request of one time or continuous reporting of network status. The diagram shows two lifelines: RCAF and SCEF. Step 1: SCEF sends a '1. Diameter NSR' message to RCAF. Step 2: RCAF sends a '2. Diameter NSA' message to SCEF.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` +sequenceDiagram + participant SCEF + participant RCAF + Note right of SCEF: 1. Diameter NSR + SCEF->>RCAF: 1. Diameter NSR + Note left of RCAF: 2. Diameter NSA + RCAF->>SCEF: 2. Diameter NSA +``` + +Sequence diagram for Figure A.1.1: Request of one time or continuous reporting of network status. The diagram shows two lifelines: RCAF and SCEF. Step 1: SCEF sends a '1. Diameter NSR' message to RCAF. Step 2: RCAF sends a '2. Diameter NSA' message to SCEF. + +**Figure A.1.1: Request of one time or continuous reporting of network status** + +1. After the SCEF authorized a SCS/AS request for notification about the network status, the SCEF sends a Diameter NSR command to the selected RCAF(s) including the parameters as defined in subclause 4.3.1.2. +2. The RCAF sends a NSA command to the SCEF including the parameters as defined in subclause 4.3.1.2. + +## A.2 Continuous reporting of network status + +This signalling flow is used by RCAF to continuously notify the SCEF of the network status. + +![Sequence diagram for Figure A.2.1: Continuous reporting of network status. The diagram shows two lifelines: RCAF and SCEF. Step 1: RCAF sends a '1. Diameter NCR' message to SCEF. Step 2: SCEF sends a '2. Diameter NCA' message to RCAF.](c67d21fb3d9042e88cdc669f071b4e7c_img.jpg) + +``` +sequenceDiagram + participant RCAF + participant SCEF + Note left of RCAF: 1. Diameter NCR + RCAF->>SCEF: 1. Diameter NCR + Note right of SCEF: 2. Diameter NCA + SCEF->>RCAF: 2. Diameter NCA +``` + +Sequence diagram for Figure A.2.1: Continuous reporting of network status. The diagram shows two lifelines: RCAF and SCEF. Step 1: RCAF sends a '1. Diameter NCR' message to SCEF. Step 2: SCEF sends a '2. Diameter NCA' message to RCAF. + +**Figure A.2.1: Continuous reporting of network status** + +1. When the congestion level(s) is changed or the congestion level(s) is changed which corresponds to a threshold(s) provided, the RCAF sends a Diameter NCR command including the parameters as defined in subclause 4.3.1.3. +2. The SCEF acknowledges the NCR command by sending a NCA command to the RCAF. + +## A.3 Cancellation of continuous reporting of network status + +This signalling flow is used by SCEF to request the cancellation of continuous reporting of network status. + +![Sequence diagram showing the cancellation of continuous reporting of network status between RCAF and SCEF.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` +sequenceDiagram + participant SCEF + participant RCAF + Note right of SCEF: 1. Diameter NSR + SCEF->>RCAF: Diameter NSR + Note left of RCAF: 2. Diameter NSA + RCAF->>SCEF: Diameter NSA +``` + +The diagram illustrates a sequence of two messages between the SCEF and the RCAF. The SCEF is on the right and the RCAF is on the left. The first message, labeled '1. Diameter NSR', is sent from the SCEF to the RCAF. The second message, labeled '2. Diameter NSA', is sent from the RCAF to the SCEF. + +Sequence diagram showing the cancellation of continuous reporting of network status between RCAF and SCEF. + +**Figure A.3.1: Cancellation of continuous reporting of network status** + +1. When the SCEF detects that the duration for ongoing continuous reporting of network status is over or is requested to terminate ongoing continuous reporting of network status by the SCS/AS, the SCEF sends a Diameter NSR command to the identified RCAF(s) including the parameters as defined in subclause 4.3.1.4. +2. The RCAF removes the continuous reporting of network status related instructions meaning that the RCAF will no longer notify the SCEF of the change of the network status, and sends a NSA command to the SCEF. + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|-----------|-----------|------|-----|-----|-----------------------------------------------------------------------------------------------------------------------|-------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | | Subject/Comment | Old | New | +| 2015-08 | | | | | | Editor's Initial Draft | | 0.0.0 | +| 2015-08-25 | CT3#82 | C3-153466 | | | | Initial version includes agreed documents: C3-153407, C3-153431, C3-153433 | 0.0.0 | 0.1.0 | +| 2015-10-21 | CT3#82bis | | | | | Initial version includes agreed documents: C3-154183, C3-154298, C3-154332, C3-154333, C3-154318, C3-154334, C-154347 | 0.1.0 | 0.2.0 | +| 2015-11-24 | CT3#83 | C3-155416 | | | | Initial version includes agreed documents: C3-155240, C3-155241, C3-155331, C3-155347, C3-155364 | 0.2.0 | 1.0.0 | +| 2015-11-30 | CT#70 | CP-150822 | | | | TS 29.153 sent to plenary CT#70 for information and approval | 1.0.0 | 1.0.1 | +| 2015-12 | CT#70 | CP-150822 | | | | TS 29.153 upgraded to 13.0.0 after approval | 1.0.1 | 13.0.0 | +| Change history | | | | | | | | | +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | | New | +| 2016-03 | CT#71 | CP-160095 | 0001 | 1 | F | Add the missing abbreviations | | 13.1.0 | +| 2016-03 | CT#71 | CP-160095 | 0002 | - | F | Removal of the Editor's Note | | 13.1.0 | +| 2016-03 | CT#71 | CP-160095 | 0003 | - | F | Add command codes and AVP numbers for Ns protocol | | 13.1.0 | +| 2016-03 | CT#71 | CP-160095 | 0004 | 2 | F | Signalling flows over Ns reference point | | 13.1.0 | +| 2016-03 | CT#71 | CP-160093 | 0005 | - | B | Diameter Message Priority over Ns interface | | 13.1.0 | +| 2016-06 | CT#72 | CP-160251 | 0006 | - | F | Multiple instances of Network-Congestion-Area-Report AVP | | 13.2.0 | +| 2016-06 | CT#72 | CP-160251 | 0007 | 3 | F | Correction of network status reporting procedures | | 13.2.0 | +| 2016-09 | CT#73 | CP-160444 | 0008 | - | F | Correction of the NCR command | | 13.3.0 | +| 2016-09 | CT#73 | CP-160444 | 0009 | 1 | F | Correction to the continuous congestion reporting | | 13.3.0 | +| 2016-12 | CT#74 | CP-160614 | 0011 | - | F | Change IETF drmp draft version to official RFC 7944 | | 13.4.0 | +| 2016-12 | CT#74 | CP-160615 | 0010 | 1 | B | Diameter Load Control Mechanism | | 14.0.0 | +| 2016-12 | CT#74 | CP-160616 | 0012 | 1 | F | Diameter base protocol specification update | | 14.0.0 | +| 2017-03 | CT#75 | CP-170076 | 0013 | - | F | Update instance number for the Failed-AVP in answer commands | | 14.1.0 | +| 2017-06 | CT#76 | CP-171119 | 0014 | 1 | F | Reference update for draft-ietf-dime-load | | 14.2.0 | +| 2017-06 | CT#76 | CP-171136 | 0019 | 1 | F | Vendor-Specific-Application-Id AVP handling | | 14.2.0 | +| 2018-06 | SA#80 | - | - | - | | Update to Rel-15 version (MCC) | | 15.0.0 | +| 2019-09 | CT#85 | CP-192154 | 0021 | 1 | A | draft-ietf-dime-load published as RFC 8583 | | 15.1.0 | +| 2020-07 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | | 16.0.0 | +| 2022-03 | SA#95e | - | - | - | | Update to Rel-17 version (MCC) | | 17.0.0 | +| 2024-03 | SA#103 | - | - | - | | Update to Rel-18 version (MCC) | | 18.0.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29154/raw.md b/marked/Rel-18/29_series/29154/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..f1bd9817d88191eb29579ac2d911136a19ed6021 --- /dev/null +++ b/marked/Rel-18/29_series/29154/raw.md @@ -0,0 +1,998 @@ + + +# 3GPP TS 29.154 V18.0.0 (2024-03) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Service capability exposure functionality over Nt reference point; (Release 18)** --- + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a stylized font with a red signal wave icon below the 'G', and the text 'A GLOBAL INITIATIVE' in smaller letters below the logo. + +3GPP logo + +## --- **Keywords** + +--- + +Network,PCRF,SCEF,AVP + +## **3GPP** + +## --- **Postal address** + +## --- **3GPP support office address** + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## --- **Internet** + +--- + + + +## --- **Copyright Notification** + +--- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +## Contents + +| | | +|--------------------------------------------------------------------------------|-----------| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Nt application..... | 7 | +| 4.1 Overview ..... | 7 | +| 4.2 Nt Reference Model ..... | 8 | +| 4.3 Functional elements..... | 8 | +| 4.3.1 PCRF ..... | 8 | +| 4.3.2 SCEF..... | 8 | +| 4.4 Procedures over the Nt reference point..... | 8 | +| 4.4.1 Negotiation for future background data transfer ..... | 8 | +| 4.5 PCRF selection..... | 9 | +| 5 Nt protocol ..... | 9 | +| 5.1 Protocol support ..... | 9 | +| 5.2 Initialization, maintenance and termination of connection and session..... | 10 | +| 5.3 Nt specific AVPs..... | 10 | +| 5.3.1 General ..... | 10 | +| 5.3.2 Network-Area-Info-List AVP ..... | 10 | +| 5.3.3 Reference-Id AVP ..... | 10 | +| 5.3.4 Transfer-Request-Type AVP..... | 11 | +| 5.3.5 Time-Window AVP..... | 11 | +| 5.3.6 Transfer-End-Time AVP..... | 11 | +| 5.3.7 Transfer-Start-Time AVP..... | 11 | +| 5.3.8 Transfer-Policy AVP..... | 11 | +| 5.3.9 Transfer-Policy-Id AVP ..... | 11 | +| 5.3.10 Number-Of-UEs AVP ..... | 11 | +| 5.4 Nt re-used AVPs..... | 11 | +| 5.4.1 General ..... | 11 | +| 5.4.2 Use of the Supported-Features AVP for the Nt application ..... | 12 | +| 5.5 Nt specific Experimental-Result-Code AVP values ..... | 13 | +| 5.5.1 General ..... | 13 | +| 5.5.2 Success ..... | 13 | +| 5.5.3 Permanent Failures ..... | 13 | +| 5.5.4 Transient Failures ..... | 13 | +| 5.6 Nt messages..... | 14 | +| 5.6.1 Command-Code Values..... | 14 | +| 5.6.2 Background-Data-Transfer-Request (BTR) command ..... | 14 | +| 5.6.3 Background-Data-Transfer-Answer (BTA) command..... | 14 | +| Annex A (normative): Nta application ..... | 15 | +| A.1 Overview..... | 15 | +| A.2 Reference Model..... | 15 | +| A.3 Functional elements ..... | 16 | +| A.3.1 PCRF ..... | 16 | +| A.3.2 SCEF ..... | 16 | +| A.4 Procedures over the Nta application ..... | 16 | +| A.4.1 Event Monitoring Configuration..... | 16 | +| A.4.2 Event Monitoring Reporting ..... | 17 | + +| | | | +|-------------------------------|----------------------------------------------------------------------------|-----------| +| A.5 | PCRF selection..... | 17 | +| A.6 | Nta protocol..... | 17 | +| A.6.1 | Protocol support ..... | 17 | +| A.6.2 | Initialization, maintenance and termination of connection and session..... | 17 | +| A.6.3 | Nta specific AVPs ..... | 18 | +| A.6.3.1 | General ..... | 18 | +| A.6.3.2 | Access-Network-Reports AVP..... | 18 | +| A.6.3.3 | Event-Configuration ..... | 18 | +| A.6.3.4 | Event-Configuration-State AVP..... | 18 | +| A.6.3.5 | Event-Configuration-Status AVP..... | 19 | +| A.6.3.6 | Event-Reporting-Results AVP ..... | 19 | +| A.6.3.7 | Event-Reports AVP ..... | 19 | +| A.6.3.8 | Extended-SCEF-Reference-ID ..... | 19 | +| A.6.4 | Nta re-used AVPs..... | 19 | +| A.6.4.1 | General ..... | 19 | +| A.6.4.2 | Use of the Supported-Features AVP for the Nt application ..... | 21 | +| A.6.5 | Nta specific Experimental-Result-Code AVP values..... | 21 | +| A.6.6 | Nta messages ..... | 21 | +| A.6.6.1 | Command-Code Values..... | 21 | +| A.6.6.2 | Event-Configuration-Request (ECR) command..... | 22 | +| A.6.6.3 | Event-Configuration-Answer (ECA) command..... | 22 | +| A.6.6.4 | Event-Reporting-Request (ERR) command ..... | 22 | +| A.6.6.5 | Event-Reporting-Answer (ERA) command ..... | 23 | +| Annex B (informative): | Change history..... | 24 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +This document defines the protocol for Nt reference point. The Nt reference point includes Nt application and Nta application. + +The functional requirements and the stage 2 specifications of the Nt application are contained in 3GPP TS 23.203 [2]. The Nt application of Nt reference point lies between Service Capability Exposure Function (SCEF) and Policy and Charging Rules Function (PCRF), it supports the negotiation of background data transfer policy and is documented in the main body of this document. + +The functional requirements and the stage 2 specifications of the Nta application are contained in clause 5.6.4.1a of 3GPP TS 23.682 [x5]. The Nta application of Nt reference point lies between SCEF and PCRF, it supports the event monitoring configuration for a group of UEs and the corresponding event reporting. The Nta application is documented in Annex A. + +NOTE: Nta is a stage 3 name of Diameter Application due to extensibility rule mentioned in IETF RFC 6733 [15]. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.203: "Policy and charging control architecture". +- [3] IETF RFC 3588: "Diameter Base Protocol". +- [4] IETF RFC 4006: "Diameter Credit Control Application". +- [5] 3GPP TS 29.214: "Policy and Charging Control over Rx reference point". +- [6] 3GPP TS 29.274: "3GPP Evolved Packet System. Evolved GPRS Tunnelling Protocol for EPS (GTPv2)". +- [7] IETF RFC 5719: "Updated IANA Considerations for Diameter Command Code Allocations ". +- [8] IETF RFC 2234: "Augmented BNF for syntax specifications ". +- [9] 3GPP TS 29.213: "Policy and charging control signalling flows and Quality of Service (QoS) parameter mapping". +- [10] IETF RFC 7683: "Diameter Overload Indication Conveyance". +- [11] 3GPP TS 29.229: "Cx and Dx interfaces based on Diameter protocol; Protocol details". +- [12] IETF RFC 7944: "Diameter Routing Message Priority". +- [13] 3GPP TS 29.215: "Policy and Charging Control (PCC) over S9 reference point; Stage 3". +- [14] IETF RFC 8583: "Diameter Load Information Conveyance". + +- [15] IETF RFC 6733: "Diameter Base Protocol". +- [16] 3GPP TS 29.329: "Sh Interface based on the Diameter protocol". +- [17] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications". +- [18] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". +- [19] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [20] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|---------------------------------------------| +| ASP | Application Service Provider | +| BBERF | Bearer Binding and Event Reporting Function | +| BTA | Background Data Transfer Answer | +| BTR | Background Data Transfer Request | +| ECA | Event Configuration Answer | +| ECR | Event Configuration Request | +| ERA | Event Reporting Answer | +| ERR | Event Reporting Request | +| DRA | Diameter Routing Agent | +| DRMP | Diameter Routing Message Priority | +| PCEF | Policy and Charging Enforcement Function | +| PCRF | Policy and Charging Rules Function | +| SCEF | Service Capability Exposure Function | +| SPR | Subscription Profile Repository | + +# --- 4 Nt application + +## 4.1 Overview + +The Nt application of Nt reference point is located between the PCRF and the SCEF. It is used for reporting the transfer policies from the PCRF to the SCEF. + +The stage 2 requirements for Nt application are defined in TS 23.203 [2]. + +Refer to Annex G of 3GPP TS 29.213 [9] for Diameter overload control procedures for the Nt application. + +Refer to Annex J of 3GPP TS 29.213 [9] for Diameter message priority mechanism procedures for the Nt application. + +Refer to Annex K of 3GPP TS 29.213 [9] for Diameter load control procedures for the Nt application. + +## 4.2 Nt Reference Model + +The Nt application of Nt reference point resides between the SCEF and PCRF. The relationship between the two functional entities is depicted in figure 4.2-1. The overall PCC architecture is depicted in clause 3a of 3GPP TS 29.213 [9]. + +![Figure 4.2-1: Reference model for Nt application of Nt interface. The diagram shows two green rectangular boxes, 'PCRF' on the left and 'SCEF' on the right, connected by a horizontal line. Above the line, the text 'Nt application' is written, with a small vertical tick mark on the line below it.](5860ad6bd2a2dd8d1ab12864b8f90f37_img.jpg) + +``` +graph LR; PCRF[PCRF] --- Nt_application[Nt application] --- SCEF[SCEF]; +``` + +Figure 4.2-1: Reference model for Nt application of Nt interface. The diagram shows two green rectangular boxes, 'PCRF' on the left and 'SCEF' on the right, connected by a horizontal line. Above the line, the text 'Nt application' is written, with a small vertical tick mark on the line below it. + +**Figure 4.2-1: Reference model for Nt application of Nt interface** + +NOTE: For roaming case, the SCEF is always in the H-PLMN and always contact the H-PCRF. + +## 4.3 Functional elements + +### 4.3.1 PCRF + +The PCRF is a functional element that encompasses policy control decision and flow based charging control functionalities. + +The PCRF uses the information received from SCEF and other available information to determine one or more transfer policies for background data to the application service provider. The PCRF provides the selected transfer policies with a reference ID to the SPR for storage. + +### 4.3.2 SCEF + +The SCEF is a functional element which provides a means to securely expose the services and capabilities provided by 3GPP network interfaces. + +The SCEF is triggered by an SCS/AS which requests for the negotiation with the PCRF for providing necessary policy to transfer background data. + +## 4.4 Procedures over the Nt reference point + +### 4.4.1 Negotiation for future background data transfer + +Based on the SCS/AS request, the SCEF shall send the Background-Data-Transfer-Request (BTR) command to the PCRF including the Transfer-Request-Type AVP with the value TRANSFER\_POLICY\_REQUEST(0), it shall also include the ASP identifier within the Application-Service-Provider-Identity AVP, volume of data per UE within the CC-Output-Octets AVP for downlink volume and/or the CC-Input-Octets AVP for uplink volume, or the CC-Total-Octets AVP for total volume regardless direction, expected number of UEs within the Number-Of-UEs AVP and desired time window within the Time-Window AVP. + +The Time-Window AVP shall include desired start time within the Transfer-Start-Time AVP and desired end time within the Transfer-End-Time AVP. + +The SCEF may also provide network area information within Network-Area-Info-List AVP. + +Once the PCRF receives the BTR command, the PCRF shall retrieve all existing transfer policies stored for any ASP from the SPR. + +When all existing transfer policies are retrieved, the PCRF shall determine one or more transfer policies based on the information received from the SCEF and other available information (e.g. network policy, congestion level (if + +available), load status estimation for the required time window and network area, existing transfer policies) and respond with a Background-Data-Transfer-Answer (BTA) command including the possible transfer policies within Transfer-Policy AVP(s) and a reference ID within Reference-Id AVP. + +The Transfer-Policy AVP(s) shall include the Transfer-Policy-Id AVP, the Time-Window AVP, the Rating-Group AVP, and may also include an Max-Requested-Bandwidth-DL AVP and/or an Max-Requested-Bandwidth-UL AVP. + +If more than one transfer policies are included in the BTA command, the PCRF shall also include the PCRF Id within the PCRF-Address AVP in the BTA command. + +NOTE 1: If only one Transfer-Policy AVP is included in the BTA command, the PCRF sends a request to the SPR to store the reference ID together with the transfer policy and corresponding network area information (if available). + +If there is more than one Transfer-Policy AVP included in the BTA command, the PCRF waits for the transfer policy selected by the SCS/AS before communicating with the SPR. + +If there is more than one transfer policy provided from the PCRF to the SCEF in the BTA command, when the SCEF receives the selected transfer policy from the SCS/AS, the SCEF shall send Background-Data-Transfer-Request (BTR) command to the PCRF including the Transfer-Request-Type AVP set to the value + +TRANSFER\_POLICY\_NOTIFICATION (1). The SCEF shall also include the reference ID in the Reference-Id AVP, the identity of the selected transfer policy within the Transfer-Policy-Id AVP and the destination PCRF Id within the Destination-Host AVP. + +NOTE 2: When receiving the BTA command from the PCRF, if there is only one transfer policy included, the SCEF forwards the transfer policy to SCS/AS. + +If there is more than one transfer policy included, the SCEF forwards these transfer policies to the SCS/AS and waits for the answer including the identity of the transfer policy selected by the SCS/AS. + +The PCRF shall acknowledge the BTR command by sending Background-Data-Transfer-Answer (BTA) command. + +NOTE 3: The PCRF sends a request to the SPR to store the reference ID together with the transfer policy and corresponding network area information (if available). + +## 4.5 PCRF selection + +The SCEF or DRA (if deployed) may select a PCRF in the HPLMN based on operator policy (e.g. pre-configured PCRF identities or routing strategy, etc). + +# --- 5 Nt protocol + +## 5.1 Protocol support + +The Diameter Base Protocol as specified in IETF RFC 6733 [15] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures specified in IETF RFC 6733 [15] (including error handling and unrecognised information handling) shall be used unmodified. + +The Nt application is defined as vendor specific Diameter application, where the vendor is 3GPP and the Application-ID for the Nt application in the present release is 16777348. The vendor identifier assigned by IANA to 3GPP () is 10415. + +With regard to the Diameter protocol defined for the Nt application, the PCRF acts as a Diameter server, in the sense that it is the network element that handles background data transfer request. The SCEF acts as the Diameter client, in the sense that it is the network element requesting background data transfer. + +## 5.2 Initialization, maintenance and termination of connection and session + +The initialization and maintenance of the connection between each SCEF and PCRF pair is defined by the underlying protocol. Establishment and maintenance of connections between Diameter nodes is described in IETF RFC 6733 [15]. After establishing the transport connection, the SCEF and the PCRF shall advertise the support of the Nt specific Application by including the value of the application identifier in the Auth-Application-Id AVP and the value of the 3GPP (10415) in the Vendor-Id AVP of the Vendor-Specific-Application-Id AVP contained in the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. The Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands are specified in the Diameter Base Protocol (IETF RFC 6733 [15]). + +An Nt Diameter session shall consist of a single request and answer pair. The Nt Diameter session is terminated after each request and answer pair interaction. In order to indicate that the session state is not to be maintained, the Diameter client and server shall include the Auth-Session-State AVP with the value set to NO\_STATE\_MAINTAINED (1), in the request and in the answer messages (see IETF RFC 6733 [15]). + +## 5.3 Nt specific AVPs + +### 5.3.1 General + +Table 5.3.1.1 describes the Diameter AVPs defined for the Nt application, their AVP Code values, types, possible flag values, whether or not the AVP may be encrypted and which supported features the AVP is applicable to. The Vendor-Id header of all AVPs defined in the present document shall be set to 3GPP (10415). + +**Table 5.3.1.1: Nt specific Diameter AVPs** + +| Attribute Name | AVP Code | Clause defined | Value Type (Note 2) | AVP Flag rules (Note 1) | | | | Applicability | +|------------------------|----------|----------------|---------------------|-------------------------|-----|------------|----------|---------------| +| | | | | Must | May | Should not | Must not | | +| Network-Area-Info-List | 4201 | 5.3.2 | OctetString | M,V | P | | | | +| Number-Of-UEs | 4209 | 5.3.10 | Unsigned32 | M,V | P | | | | +| Reference-Id | 4202 | 5.3.3 | OctetString | M,V | P | | | | +| Transfer-Request-Type | 4203 | 5.3.4 | Unsigned32 | M,V | P | | | | +| Time-Window | 4204 | 5.3.5 | Grouped | M,V | P | | | | +| Transfer-End-Time | 4205 | 5.3.6 | Time | M,V | P | | | | +| Transfer-Policy | 4207 | 5.3.8 | Grouped | M,V | P | | | | +| Transfer-Policy-Id | 4208 | 5.3.9 | Unsigned32 | M,V | P | | | | +| Transfer-Start-Time | 4206 | 5.3.7 | Time | M,V | P | | | | + +NOTE 1: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [15]. + +NOTE 2: The value types are defined in IETF RFC 6733 [15]. + +### 5.3.2 Network-Area-Info-List AVP + +The Network-Area-Info-List AVP (AVP code 4201) is of type OctetString, it contains the network area information which is coded as specified in 3GPP TS 29.274 [6] in Presence Reporting Area Action IE, starting from octet 9. + +### 5.3.3 Reference-Id AVP + +The Reference-Id AVP (AVP code 4202) is of type OctetString. It is used by the PCRF to correlate an SCS/AS request with the transfer policy retrieved from the SPR. It is assigned by the PCRF and shall be globally unique per PLMN. + +NOTE: To guarantee the uniqueness of the Reference Id, the Reference Id can follow the definition of Session Id in IETF RFC 6733 [15]. + +### 5.3.4 Transfer-Request-Type AVP + +The Transfer-Request-Type AVP (AVP code 4203) is of type Unsigned32, it contains the reason for sending the BT-Request message. + +The following values are defined: + +0 (TRANSFER\_POLICY\_REQUEST) + +The BT-Request message is sent to initiate a transfer policy request procedure. + +1 (TRANSFER\_POLICY\_NOTIFICATION) + +The BT-Request message is sent to initiate a transfer policy notification procedure. + +### 5.3.5 Time-Window AVP + +The Time-Window AVP (AVP code 4204) is of type Grouped. It contains a Transfer-Start-Time and a Transfer-End-Time. It describes the time interval during which the SCS/AS may realize the background data transfer. + +``` +Time-window ::= < AVP Header: 4204 > + { Transfer-Start-Time } + { Transfer-End-Time } + *[ AVP ] +``` + +### 5.3.6 Transfer-End-Time AVP + +The Transfer-End-Time AVP (AVP code 4205) is of type Time. It indicates the NTP time at which the SCS/AS shall stop the background data transfer. + +### 5.3.7 Transfer-Start-Time AVP + +The Transfer-Start-Time AVP (AVP code 4206) is of type Time. It indicates the NTP time when the SCS/AS may start the background data transfer. + +### 5.3.8 Transfer-Policy AVP + +The Transfer-Policy AVP (AVP code 4207) is of type Grouped. It indicates the transfer policy determined by the PCRF. + +``` +Transfer-Policy ::= < AVP Header: 4207 > + { Transfer-Policy-Id } + [ Time-Window ] + [ Rating-Group ] + [ Max-Requested-Bandwidth-DL ] + [ Max-Requested-Bandwidth-UL ] + *[ AVP ] +``` + +### 5.3.9 Transfer-Policy-Id AVP + +The Transfer-Policy-Id AVP (AVP code 4208) is of type Unsigned32. It indicates the identity of the transfer policy. It is assigned by the PCRF and is unique per Reference-Id. + +### 5.3.10 Number-Of-UEs AVP + +The Number-Of-UEs AVP (AVP code 4209) is of type Unsigned32. It indicates the expected number of UEs. + +## 5.4 Nt re-used AVPs + +### 5.4.1 General + +Table 5.4.1 lists the Diameter AVPs re-used by the Nt application from other existing Diameter Applications, reference to their respective specifications, short description of their usage within the Nt application. Other AVPs from existing + +Diameter Applications, except for the AVPs from Diameter base protocol, do not need to be supported. The AVPs from Diameter base protocol are not included in table 5.4.1, but they are re-used for the Nt application. Unless otherwise stated, re-used AVPs shall maintain their 'M', 'P' and 'V' flag settings. + +**Table 5.4.1: Nt re-used Diameter AVPs** + +| Attribute Name | Reference | Description | Applicability (NOTE) | +|---------------------------------------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| Application-Service-Provider-Identity | 3GPP TS 29.214 [5] | The identity of the application service provider that is delivering a service to an end user. | | +| CC-Output-Octets | IETF RFC 4006 [4] | It contains the number of requested, octets that may be sent to involved users. | | +| CC-Input-Octets | IETF RFC 4006 [4] | It contains the number of requested octets that may be received from the involved users. | | +| CC-Total-Octets | IETF RFC 4006 [4] | It contains the total number of requested octets regardless of the direction (sent or received). | | +| DRMP | IETF RFC 7944 [12] | Allows Diameter endpoints to indicate the relative priority of Diameter transactions. | | +| Load | IETF RFC 8583 [14] | The AVP used to convey load information between Diameter nodes. This AVP and all AVPs within this grouped AVP shall have the 'M' bit cleared. | | +| Max-Requested-Bandwidth-DL | 3GPP TS 29.214 [5] | Defines the maximum aggregated authorized bandwidth for downlink by the PCRF. | | +| Max-Requested-Bandwidth-UL | 3GPP TS 29.214 [5] | Defines the maximum aggregated authorized bandwidth for uplink by the PCRF. | | +| OC-OLR | IETF RFC 7683 [10] | Contains the necessary information to convey an overload report. | | +| OC-Supported-Features | IETF RFC 7683 [10] | Defines the support for the Diameter overload indication conveyance by the sending node. | | +| PCRF-Address | 3GPP TS 29.215 [13] | The identity, which indicates the destination PCRF. | | +| Rating-Group | IETF RFC 4006 [4] | The charging key for the aggregated traffic of all involved UEs used for rating purpose. | | +| Supported-Features | 3GPP TS 29.229 [11] | If present, this AVP informs the destination host about the features that the origin host requires to successfully complete this command exchange. | | + +NOTE: AVPs marked with a supported feature are applicable as described in clause 5.4.2. + +### 5.4.2 Use of the Supported-Features AVP for the Nt application + +When new functionality is introduced for the Nt application, it should be defined as optional. If backwards incompatible changes cannot be avoided, the new functionality shall be introduced as a new feature and support advertised with the Supported-Features AVP. Unless otherwise stated, the use of the Supported-Features AVP for the Nt application shall be compliant to the usage of the Supported-Features AVP on the Cx reference point and consistent with the procedures for the dynamic discovery of supported features as defined in clause 7.2 of 3GPP TS 29.229 [11]. + +The base functionality for the Nt application is the 3GPP Rel-13 standard and a feature is an extension to that functionality. If the origin host does not support any features beyond the base functionality, the Supported-Features AVP may be absent from the Nt commands. + +As defined in clause 7.1.1 of 3GPP TS 29.229 [11], when extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in 3GPP TS 29.229 [11], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the all reference points as specified in this specification, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +The Supported-Features AVP shall be included in every BTR and BTA commands if supported by the SCEF and PCRF respectively. + +The table 5.4.2.1 defines the features applicable to the Nt application for the feature list with a Feature-List-ID of 1. + +**Table 5.4.2.1: Features of Feature-List-ID 1 used in Nt** + +| Feature bit | Feature | M/O | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-----|-------------| +| Feature bit: The order number of the bit within the Feature-List AVP where the least significant bit is assigned number "0".
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "EPS".
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release.
Description: A clear textual description of the feature. | | | | + +NOTE: This table is a placeholder for when any supported features are added to Nt. There are no supported features in this release. + +## 5.5 Nt specific Experimental-Result-Code AVP values + +### 5.5.1 General + +This clause defines result code values that shall be supported by Diameter implementations that conform to this specification. + +### 5.5.2 Success + +Result Codes that fall into the Success category are used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in Diameter base protocol IETF RFC 6733 [15] are applied. + +### 5.5.3 Permanent Failures + +Errors that fall into the Permanent Failures category shall be used to inform the peer that the request has failed, and should not be attempted again. + +The Result-Code AVP values defined in Diameter base protocol IETF RFC 6733 [15] are applied. + +### 5.5.4 Transient Failures + +Errors that fall within the Transient Failures category are used to inform a peer that the request could not be satisfied at the time it was received, but may be able to satisfy the request in the future. + +The Result-Code AVP values defined in Diameter base protocol IETF RFC 6733 [15] are applied. + +## 5.6 Nt messages + +### 5.6.1 Command-Code Values + +This clause defines the Command-Code values for the Nt application as allocated by IANA from the vendor-specific namespace defined in IETF RFC 5719 [7]. Every command is defined by means of the ABNF syntax in IETF RFC 2234 [8], and according to the rules in IETF RFC 6733 [15]. + +NOTE: As the commands in the present specification have originally been defined based on the former specification of the Diameter Base Protocol (IETF RFC 3588 [3]), the Vendor-Specific-Application-Id AVP is still assumed as a required AVP (an AVP indicated as {AVP}) in the command code format to avoid backward compatibility issues, even if the use of this AVP has been deprecated in the new specification of the Diameter Base Protocol (IETF RFC 6733 [15]). + +The Nt application identifier shall be included in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP contained in the BT-Request/Answer commands. + +The following Command Codes are defined in this specification: + +**Table 5.6.1: Command-Code values for Nt** + +| Command-Name | Abbreviation | Code | Section | +|----------------------------------|--------------|---------|---------| +| Background-Data-Transfer-Request | BTR | 8388723 | 5.6.2 | +| Background-Data-Transfer-Answer | BTA | 8388723 | 5.6.3 | + +### 5.6.2 Background-Data-Transfer-Request (BTR) command + +The BTR command, indicated by the Command-Code field set to 8388723 and the 'R' bit set in the Command Flags field, is sent by the SCEF to the PCRF as part of Negotiation for future background data transfer procedure. + +Message Format: + +``` + ::= + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Transfer-Request-Type } + [ Destination-Host ] + [ OC-Supported-Features ] + [ Application-Service-Provider-Identity ] + [ CC-Output-Octets ] + [ CC-Input-Octets ] + [ CC-Total-Octets ] + [ Number-Of-UEs ] + [ Time-Window ] + [ Network-Area-Info-List ] + [ Reference-Id ] + [ Transfer-Policy-Id ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ Supported-Features ] + *[ AVP ] +``` + +### 5.6.3 Background-Data-Transfer-Answer (BTA) command + +The BTA command, indicated by the Command-Code field set to 8388723 and the 'R' bit cleared in the Command Flags field, is sent by the PCRF to the SCEF as part of Negotiation for future background data transfer procedure. + +Message Format: + +``` + ::= + < Session-Id > + [ DRMP ] +``` + +``` + + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + * [ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + [ Reference-Id ] + [ OC-Supported-Features ] + [ OC-OLR ] + * [ Transfer-Policy ] + [ PCRF-Address ] + * [ Proxy-Info ] + * [ Route-Record ] + * [ Supported-Features ] + * [ Load ] + * [ AVP ] + +``` + +# --- Annex A (normative): Nta application + +## A.1 Overview + +The Nta application of Nt reference point is located between the PCRF and the SCEF. It is used for configuring event monitoring for a group of UEs and reporting the event. + +The stage 2 requirements for Nta application are defined in TS 23.682 [x5]. + +Refer to Annex G of 3GPP TS 29.213 [9] for Diameter overload control procedures for the Nta application. + +Refer to Annex J of 3GPP TS 29.213 [9] for Diameter message priority mechanism procedures for the Nta application. + +Refer to Annex K of 3GPP TS 29.213 [9] for Diameter load control procedures for the Nta application. + +## --- A.2 Reference Model + +The Nta application of Nt reference point resides between the SCEF and PCRF. The relationship between the two functional entities is depicted in figure A.2-1. The overall PCC architecture is depicted in clause 3a of 3GPP TS 29.213 [9]. + +![Diagram showing the reference model for the Nta application of the Nt interface. A green box labeled 'PCRF' is connected by a horizontal line to another green box labeled 'SCEF'. Above the connection line, the text 'Nta application' is displayed, with a small vertical tick mark on the line below it.](e4c6fa93821e3546ee9fcae897ae2771_img.jpg) + +``` + +graph LR + PCRF[PCRF] ---|Nta application| SCEF[SCEF] + +``` + +Diagram showing the reference model for the Nta application of the Nt interface. A green box labeled 'PCRF' is connected by a horizontal line to another green box labeled 'SCEF'. Above the connection line, the text 'Nta application' is displayed, with a small vertical tick mark on the line below it. + +**Figure A.2-1: Reference model for Nta application of Nt interface** + +NOTE: For roaming case, the SCEF is always in the H-PLMN and always contact the H-PCRF. + +## A.3 Functional elements + +### A.3.1 PCRF + +The PCRF is a functional element that encompasses policy control decision and flow based charging control functionalities. + +The PCRF receives event monitoring configuration (e.g. location request) from the SCEF and applies corresponding procedure over IP-CAN session. The PCRF reports the subscribed event to the SCEF after receiving report of the IP-CAN session. + +### A.3.2 SCEF + +The SCEF is a functional element which provides a means to securely expose the services and capabilities provided by 3GPP network interfaces. + +The SCEF receives event monitoring configuration from an SCS/AS which requests for the information (e.g. location) for a group of UEs, and reports such information to the SCS/AS. + +## A.4 Procedures over the Nta application + +### A.4.1 Event Monitoring Configuration + +Based on the SCS/AS request to retrieve the location information for a group of UEs, the SCEF shall send an Event-Configuration-Request (ECR) command to the PCRF including the Event-Configuration AVP and the External-Group-Identifier AVP. The Event-Configuration AVP shall include Monitoring-Type AVP with the value LOCATION\_REPORTING (2), SCEF-ID AVP, Extended-SCEF-Reference-ID AVP and MONTE-Location-Type AVP within Location-Information-Configuration AVP. The SCEF may also send the Group-Reporting-Guard-Timer AVP to indicate how often the event monitoring report shall be sent. + +Once the PCRF receives the ECR command, the PCRF shall retrieve UE identities (MSISDN and optionally UE external identifier) for all UEs in the group associated with the External-Group-Identifier AVP from the SPR and respond with an Event-Configuration-Answer (ECA) command including the Event-Configuration-Status AVP. If the PCRF has at least one active IP-CAN session for received UE identities and for such IP-CAN session the PCEF/BBERF supports the NetLoc feature as defined in clause 5.4.1 of 3GPP TS 29.212 [aa], the Event-Configuration-State AVP within the Event-Configuration-Status AVP shall indicate this is not a final report with bit 0 not set. For those UEs having active IP-CAN sessions but without the support of the NetLoc feature in the PCEF/BBERF, the PCRF shall also send Event-Reports AVP with NetLoc-Access-Support AVP set to the value NETLOC\_ACCESS\_NOT\_SUPPORTED (0). + +NOTE 1: The details associated with the Sp reference point are not specified in this Release. The SPR's relation to existing subscriber databases is not specified in this Release. + +For location reporting, the PCRF shall trigger an IP-CAN session modification procedure including the Access Network information report request as defined in 3GPP TS 29.212 [aa] for each UE having active IP-CAN session(s). + +If a UE has multiple IP-CAN sessions established in the PCRF, only one IP-CAN session shall be selected to trigger a PCRF initiated IP-CAN session modification. + +NOTE 2: If a UE has multiple IP-CAN sessions over both 3GPP and non-3GPP access, the PCRF can prioritize multi access IP-CAN session(s) or 3GPP access IP-CAN session(s) in the selection among multiple IP-CAN sessions. Then how the PCRF selects the final IP-CAN session is implementation specific and not standardized in this specification. + +After receiving the ECA command, if the result indicates that it is a final report, the SCEF does not need to wait for further reporting from such PCRF. + +### A.4.2 Event Monitoring Reporting + +For location reporting, the PCRF may wait and aggregate (according to Group-Reporting-Guard-Timer AVP received in the ECR command) the access network information reported from the PCEF/BBERF for UE(s) that were requested previously, the PCRF shall send an Event-Reporting-Request (ERR) command to the SCEF including Event-Reports AVP. The Event-Reports AVP shall include Extended-SCEF-Reference-ID AVP and the following information for each UE: MSISDN AVP or External-Identifier AVP (if available and local policy allows it) and Access-Network-Reports AVP (if available). The PCRF may send the User-Location-Info-Time AVP within the Access-Network-Reports AVP to indicate that it is the last known location for a UE. If the PCRF receives NetLoc-Access-Support AVP with the value NETLOC\_ACCESS\_NOT\_SUPPORTED (0) from the PCEF/BBERF, it shall relay such AVP to the SCEF within the Access-Network-Reports AVP. The PCRF shall also indicate whether it is a final reporting for the group within the Event-Reporting-Results AVP within the Event-Reports AVP. + +After receiving the ERR command, the SCEF shall respond with an Event-Reporting-Answer (ERA) command. If the SCEF receives the Event-Reports AVP from the PCRF with an Extended-SCEF-Reference-ID not known by the SCEF, it shall reply with DIAMETER\_ERROR\_SCEF\_REFERENCE\_ID\_UNKNOWN (5515). + +## --- A.5 PCRF selection + +For location reporting, the SCEF shall select all PCRFs and send ECR command to each PCRF in the same PLMN. + +## --- A.6 Nta protocol + +### A.6.1 Protocol support + +The Diameter Base Protocol as specified in IETF RFC 6733 [15] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures specified in IETF RFC 6733 [15] (including error handling and unrecognised information handling) shall be used unmodified. + +The Nta application is defined as vendor specific Diameter application, where the vendor is 3GPP and the Application-ID for the Nta application in the present release is 16777358. The vendor identifier assigned by IANA to 3GPP () is 10415. + +With regard to the Diameter protocol defined for the Nta application, the PCRF acts as a Diameter server, in the sense that it is the network element that handles event monitoring request. The SCEF acts as the Diameter client, in the sense that it is the network element requesting event monitoring report. + +### A.6.2 Initialization, maintenance and termination of connection and session + +The initialization and maintenance of the connection between each SCEF and PCRF pair is defined by the underlying protocol. Establishment and maintenance of connections between Diameter nodes is described in IETF RFC 6733 [15]. After establishing the transport connection, the SCEF and the PCRF shall advertise the support of the Nta specific Application by including the value of the application identifier in the Auth-Application-Id AVP and the value of the 3GPP (10415) in the Vendor-Id AVP of the Vendor-Specific-Application-Id AVP contained in the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. The Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands are specified in the Diameter Base Protocol (IETF RFC 6733 [15]). + +An Nta Diameter session shall consist of a single request and answer pair. The Nta Diameter session is terminated after each request and answer pair interaction. In order to indicate that the session state is not to be maintained, the Diameter client and server shall include the Auth-Session-State AVP with the value set to NO\_STATE\_MAINTAINED (1), in the request and in the answer messages (see IETF RFC 6733 [15]). + +### A.6.3 Nta specific AVPs + +#### A.6.3.1 General + +Table A.6.3.1-1 describes the Diameter AVPs defined for the Nta application, their AVP Code values, types, possible flag values, whether or not the AVP may be encrypted and which supported features the AVP is applicable to. The Vendor-Id header of all AVPs defined in the present document shall be set to 3GPP (10415). + +**Table A.6.3.1-1: Nta specific Diameter AVPs** + +| Attribute Name | AVP Code | Clause defined | Value Type (Note 2) | AVP Flag rules (Note 1) | | | | Applicability | +|----------------------------|----------|----------------|---------------------|-------------------------|-----|------------|----------|---------------| +| | | | | Must | May | Should not | Must not | | +| Access-Network-Reports | 4210 | A.6.3.2 | Grouped | M,V | P | | | | +| Event-Configuration | 4211 | A.6.3.3 | Grouped | M,V | P | | | | +| Event-Configuration-State | 4212 | A.6.3.4 | Unsigned32 | M,V | P | | | | +| Event-Configuration-Status | 4213 | A.6.3.5 | Grouped | M,V | P | | | | +| Event-Reporting-Results | 4214 | A.6.3.6 | Unsigned32 | M,V | P | | | | +| Event-Reports | 4215 | A.6.3.7 | Grouped | M,V | P | | | | +| Extended-SCEF-Reference-ID | 4216 | A.6.3.8 | Unsigned64 | M,V | P | | | | + +NOTE 1: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [15]. + +NOTE 2: The value types are defined in IETF RFC 6733 [15]. + +#### A.6.3.2 Access-Network-Reports AVP + +The Access-Network-Reports AVP (AVP code 4210) is of type Grouped. It indicates the access network information for a UE. + +``` +Access-Network-Reports ::= < AVP Header: 4210 > + [ MSISDN ] + [ External-Identifier ] + [ 3GPP-User-Location-Info ] + [ User-Location-Info-Time ] + [ 3GPP-SGSN-MCC-MNC ] + [ 3GPP-MS-TimeZone ] + [ UE-Local-IP-Address ] + [ TCP-Source-Port ] + [ UDP-Source-Port ] + [ NetLoc-Access-Support ] + * [ AVP ] +``` + +#### A.6.3.3 Event-Configuration + +The Event-Configuration AVP (AVP code 4211) is of type Grouped, and it contains the details of the monitoring event configuration from the SCEF. + +``` +Event-Configuration ::= < AVP Header: 4211 > + { Extended-SCEF-Reference-ID } + { SCEF-ID } + { Monitoring-Type } + [ Location-Information-Configuration ] + * [ AVP ] +``` + +#### A.6.3.4 Event-Configuration-State AVP + +The Event-Configuration-State AVP (AVP code 4212) is of type Unsigned32, it shall contain a bit mask. The bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x0001 should be used. The meaning of the bits shall be as defined below: + +Table A.6.3.4-1: Event-Configuration-State + +| Bit | Name | Description | +|-----|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Final report | This bit, when set, indicates that this is the final report for the UE group; when not set, indicates that there are more reports pending for the UE group. | + +#### A.6.3.5 Event-Configuration-Status AVP + +The Event-Configuration-Status AVP (AVP code 4213) is of type Grouped. It indicates the status for the monitoring event configuration. + +``` +Event-Configuration-Status ::= < AVP Header: 4213 > + { Event-Configuration-State } + { Extended-SCEF-Reference-ID } + *[ AVP ] +``` + +#### A.6.3.6 Event-Reporting-Results AVP + +The Event-Reporting-Results AVP (AVP code 4214) is of type Unsigned32, it shall contain a bit mask. The bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x0001 should be used. The meaning of the bits shall be as defined below: + +Table A.6.3.6-1: Event-Reporting-Results + +| Bit | Name | Description | +|-----|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Final report | This bit, when set, indicates that this is the final report for the UE group; when not set, indicates that there are more reports pending for the UE group. | + +#### A.6.3.7 Event-Reports AVP + +The Event-Reports AVP (AVP code 4215) is of type Grouped. It indicates the event reports for a UE group. + +``` +Event-Reports ::= < AVP Header: 4215 > + { Event-Reporting-Results } + { Extended-SCEF-Reference-ID } + *[ Access-Network-Reports ] + *[ AVP ] +``` + +#### A.6.3.8 Extended-SCEF-Reference-ID + +The Extended-SCEF-Reference-ID AVP (AVP code 4216) is of type Unsigned64 and it shall contain the identifier provided by the SCEF. + +### A.6.4 Nta re-used AVPs + +#### A.6.4.1 General + +Table A.6.4.1-1 lists the Diameter AVPs re-used by the Nta application from other existing Diameter Applications, reference to their respective specifications, short description of their usage within the Nta application. Other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol, do not need to be supported. The AVPs from Diameter base protocol are not included in table A.6.4.1-1, but they are re-used for the Nta application. Unless otherwise stated, re-used AVPs shall maintain their 'M', 'P' and 'V' flag settings. + +Table A.6.4.1-1: Nta re-used Diameter AVPs + +| Attribute Name | Reference | Description | Applicability (NOTE) | +|------------------------------------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| 3GPP-MS-TimeZone | 3GPP TS 29.061 [18] | Indicate the offset between universal time and local time in steps of 15 minutes of where the MS currently resides. | | +| 3GPP-SGSN-MCC-MNC | 3GPP TS 29.061 [18] | For GPRS the MCC and the MNC of the SGSN.
For 3GPP/non-3GPP accesses the MCC and the MNC provided by the serving gateway (SGW, or AGW or TWAG). | | +| 3GPP-User-Location-Info | 3GPP TS 29.061 [18] | Indicates details of where the UE is currently located (e.g. SAI, CGI or eNodeB ID) | | +| DRMP | IETF RFC 7944 [12] | Allows Diameter endpoints to indicate the relative priority of Diameter transactions. | | +| External-Identifier | 3GPP TS 29.336 [17] | External Identifier of the UE | | +| Group-Reporting-Guard-Timer | 3GPP TS 29.336 [17] | It is used by the PCRF to aggregate the reports. | | +| Load | IETF RFC 8583 [14] | The AVP used to convey load information between Diameter nodes. This AVP and all AVPs within this grouped AVP shall have the 'M' bit cleared. | | +| Location-Information-Configuration | 3GPP TS 29.336 [17] | Only MONTE-Location-Type AVP is applicable for the Nta application. | | +| Monitoring-Type | 3GPP TS 29.336 [17] | Only LOCATION_REPORTING (2) is applicable for the Nta application. | | +| MONTE-Location-Type | 3GPP TS 29.336 [17] | Indicates the current location or the last known location. | | +| MSISDN | 3GPP TS 29.329 [16] | MSISDN of the UE | | +| NetLoc-Access-Support | 3GPP TS 29.212 [19] | Indicates the level of support for NetLoc procedures provided by the current access network. | | +| OC-OLR | IETF RFC 7683 [10] | Contains the necessary information to convey an overload report. | | +| OC-Supported-Features | IETF RFC 7683 [10] | Defines the support for the Diameter overload indication conveyance by the sending node. | | +| SCEF-ID | 3GPP TS 29.336 [17] | The diameter identifier provided by the SCEF which has originated the request towards the PCRF. | | +| Supported-Features | 3GPP TS 29.229 [11] | If present, this AVP informs the destination host about the features that the origin host requires to successfully complete this command exchange. | | +| TCP-Source-Port | 3GPP TS 29.212 [19] | TCP source port number | | +| UDP-Source-Port | 3GPP TS 29.212 [19] | UDP source port number | | +| UE-Local-IP-Address | 3GPP TS 29.212 [19] | Contains the UE local IP address. | | +| User-Location-Info-Time | 3GPP TS 29.212 [19] | The time at which the UE was last known to be in the location. | | + +NOTE: AVPs marked with a supported feature are applicable as described in clause A.6.4.2. + +#### A.6.4.2 Use of the Supported-Features AVP for the Nt application + +When new functionality is introduced for the Nt application, it should be defined as optional. If backwards incompatible changes cannot be avoided, the new functionality shall be introduced as a new feature and support advertised with the Supported-Features AVP. Unless otherwise stated, the use of the Supported-Features AVP for the Nt application shall be compliant to the usage of the Supported-Features AVP on the Cx reference point and consistent with the procedures for the dynamic discovery of supported features as defined in clause 7.2 of 3GPP TS 29.229 [11]. + +The base functionality for the Nta application is the 3GPP Rel-15 standard and a feature is an extension to that functionality. If the origin host does not support any features beyond the base functionality, the Supported-Features AVP may be absent from the Nta commands. + +As defined in clause 7.1.1 of 3GPP TS 29.229 [11], when extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in 3GPP TS 29.229 [11], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the all reference points as specified in this specification, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +The Supported-Features AVP shall be included in every ECR and ECA commands if supported by the SCEF and PCRF respectively. + +The table A.6.4.2-1 defines the features applicable to the Nta application for the feature list with a Feature-List-ID of 1. + +**Table A.6.4.2-1: Features of Feature-List-ID 1 used in Nta** + +| Feature bit | Feature | M/O | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-----|-------------| +| Feature bit: The order number of the bit within the Feature-List AVP where the least significant bit is assigned number "0".
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "EPS".
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release.
Description: A clear textual description of the feature. | | | | + +NOTE: This table is a placeholder for when any supported features are added to Nta. There are no supported features in this release. + +### A.6.5 Nta specific Experimental-Result-Code AVP values + +Clause 5.5 is applicable for Nta specific Experimental-Result-Code AVP values. + +### A.6.6 Nta messages + +#### A.6.6.1 Command-Code Values + +This clause defines the Command-Code values for the Nta application as allocated by IANA from the vendor-specific namespace defined in IETF RFC 5719 [7]. Every command is defined by means of the ABNF syntax in IETF RFC 2234 [8], and according to the rules in IETF RFC 6733 [15]. + +The Vendor-Specific-Application-Id AVP shall not be included in any command sent by Diameter nodes supporting applications defined in this specification. If the Vendor-Specific-Application-Id AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node. + +NOTE: The Vendor-Specific-Application-Id is included as an optional AVP in all Command Code Format specifications defined in this specification in order to overcome potential interoperability issues with intermediate Diameter agents non-compliant with the IETF RFC 6733 [15]. + +The following Command Codes are defined in this specification: + +Table A.6.6-1: Command-Code values for Nta + +| Command-Name | Abbreviation | Code | Section | +|-----------------------------|--------------|---------|---------| +| Event-Configuration-Request | ECR | 8388735 | A.6.6.2 | +| Event-Configuration-Answer | ECA | 8388735 | A.6.6.3 | +| Event-Reporting-Request | ERR | 8388736 | A.6.6.4 | +| Event-Reporting-Answer | ERA | 8388736 | A.6.6.5 | + +#### A.6.6.2 Event-Configuration-Request (ECR) command + +The ECR command, indicated by the Command-Code field set to 8388735 and the 'R' bit set in the Command Flags field, is sent by the SCEF to the PCRF as part of event monitoring configuration procedure. + +Message Format: + +``` + ::= + < Session-Id > + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + [ OC-Supported-Features ] + { External-Group-Identifier } + [ Event-Configuration ] + [ Group-Reporting-Guard-Timer ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ Supported-Features ] + *[ AVP ] +``` + +#### A.6.6.3 Event-Configuration-Answer (ECA) command + +The ECA command, indicated by the Command-Code field set to 8388735 and the 'R' bit cleared in the Command Flags field, is sent by the PCRF to the SCEF as part of event monitoring configuration procedure. + +Message Format: + +``` + ::= + < Session-Id > + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + *[ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + [ OC-Supported-Features ] + [ OC-OLR ] + [ Event-Reports ] + [ Event-Configuration-Status ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ Supported-Features ] + *[ Load ] + *[ AVP ] +``` + +#### A.6.6.4 Event-Reporting-Request (ERR) command + +The ERR command, indicated by the Command-Code field set to 8388736 and the 'R' bit set in the Command Flags field, is sent by the PCRF to the SCEF as part of event monitoring report procedure. + +Message Format: + +``` + ::= +``` + +``` +< Session-Id > +[ DRMP ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +{ Destination-Realm } +{ Destination-Host } +[ OC-Supported-Features ] +[ Event-Reports ] +*[ Proxy-Info ] +*[ Route-Record ] +*[ AVP ] +``` + +#### A.6.6.5 Event-Reporting-Answer (ERA) command + +The ERA command, indicated by the Command-Code field set to 8388736 and the 'R' bit cleared in the Command Flags field, is sent by the SCEF to the PCRF as part of event monitoring report procedure + +Message Format: + +``` + ::= + < Session-Id > + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm} + [ Result-Code ] + [ Experimental-Result ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + *[ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ Load ] + *[ AVP ] +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|-----------|-----------|------|-----|------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2015-08 | | | | | Editor's Initial Draft | | 0.0.0 | +| 2015-08 | CT3#82 | C3-153468 | | | Initial version includes agreed documents: C3-153405, C3-153406, C3-153408, | 0.0.0 | 0.1.0 | +| 2015-10 | CT3#82bis | | | | Initial version includes agreed documents: C3-154100, C3-154293, C3-154180, C3-154317, C3-154295, C3-154330 | 0.1.0 | 0.2.0 | +| 2015-11 | CT3#83 | C3-155418 | | | Initial version includes agreed documents: C3-155110, C3-155150, C3-155277, C3-155279, C3-155281, C3-155282, C3-155332, C3-155356. | 0.2.0 | 1.0.0 | +| 2015-11 | CT#70 | CP-150823 | | | TS presented to plenary for information and approval | 1.0.0 | 1.0.1 | +| 2015-12 | CT#70 | CP-150823 | | | TS 29.154 upgraded tp 13.0.0 after approval | 1.0.1 | 13.0.0 | +| Change history | | | | | | | | +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +| 2016-03 | CT#71 | CP-160095 | 0001 | 1 | F | Add command codes and AVP numbers for Nt protocol | 13.1.0 | +| 2016-03 | CT#71 | CP-160095 | 0002 | 2 | F | Missed Transfer-Request-Type AVP in the BTR/BTA commands | 13.1.0 | +| 2016-03 | CT#71 | CP-160095 | 0003 | 2 | F | Some corrections for Nt protocol | 13.1.0 | +| 2016-03 | CT#71 | CP-160093 | 0004 | 2 | B | Diameter Message Priority over Nt interface | 13.1.0 | +| 2016-06 | CT#72 | CP-160251 | 0005 | 2 | F | Some corrections to 29.154 | 13.2.0 | +| 2016-06 | CT#72 | CP-160251 | 0006 | - | F | Correction of future background data transfer procedure | 13.2.0 | +| 2016-06 | CT#72 | CP-160251 | 0007 | - | F | Define Diameter application identifier for Nt reference point | 13.2.0 | +| 2016-09 | CT#73 | CP-160444 | 0008 | 2 | F | Correction of the inconsistent terminology | 13.3.0 | +| 2016-09 | CT#73 | CP-160444 | 0009 | 2 | F | Correction to PCRF addressing of transfer policy negotiation | 13.3.0 | +| 2016-12 | CT#74 | CP-160614 | 0011 | - | F | Change IETF drmp draft version to official RFC 7944 | 13.4.0 | +| 2016-12 | CT#74 | CP-160615 | 0010 | 1 | B | Diameter Load Control Mechanism | 14.0.0 | +| 2016-12 | CT#74 | CP-160616 | 0012 | 1 | F | Diameter base protocol specification update | 14.0.0 | +| 2017-03 | CT#75 | CP-170076 | 0013 | - | F | Update instance number for the Failed-AVP in answer commands | 14.1.0 | +| 2017-06 | CT#76 | CP-171119 | 0019 | 1 | F | Reference update for draft-ietf-dime-load | 14.2.0 | +| 2017-06 | CT#76 | CP-171136 | 0020 | 1 | F | Vendor-Specific-Application-Id AVP handling | 14.2.0 | +| 2017-06 | CT#76 | CP-171136 | 0016 | 2 | F | Correction for Nt interface | 15.0.0 | +| 2018-06 | CT#80 | CP-181023 | 0022 | 1 | B | Support for group based event configuration and reporting | 15.1.0 | +| 2018-09 | CT#81 | CP-182026 | 0023 | - | F | Missing re-used AVP for Nta | 15.2.0 | +| 2018-09 | CT#81 | CP-182026 | 0024 | 1 | F | IANA codes for Nta application | 15.2.0 | +| 2019-09 | CT#85 | CP-192154 | 0026 | 1 | A | draft-ietf-dime-load published as RFC 8583 | 15.3.0 | +| 2020-07 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | +| 2022-03 | SA#95e | - | - | - | | Update to Rel-17 version (MCC) | 17.0.0 | +| 2024-03 | SA#103 | - | - | - | | Update to Rel-18 version (MCC) | 18.0.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29165/raw.md b/marked/Rel-18/29_series/29165/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..04fd61d54fef5211e243de414cbd3f76947d7906 --- /dev/null +++ b/marked/Rel-18/29_series/29165/raw.md @@ -0,0 +1,6153 @@ + + +# 3GPP TS 29.165 V18.2.0 (2023-09) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Inter-IMS Network to Network Interface (NNI) (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' in black with a green wave-like graphic above it, and the word 'ADVANCED' in smaller black letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'G' has a red signal icon below it. Below the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps, sans-serif font. + +3GPP logo + +## Keywords + +IMS, LTE, Interconnection, II-NNI, IBCF, TrGW + +## **3GPP** + +Postal address + +3GPP support office address +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + + +## **Copyright Notification** + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +## Contents + +| | | +|---------------------------------------------------------------------------------------------------|----| +| Foreword..... | 8 | +| 1 Scope..... | 9 | +| 2 References..... | 9 | +| 3 Definitions, symbols and abbreviations..... | 17 | +| 3.1 Definitions..... | 17 | +| 3.2 Symbols..... | 18 | +| 3.3 Abbreviations..... | 18 | +| 4 Overview..... | 20 | +| 5 Reference model for interconnection between IM CN subsystems..... | 22 | +| 5.1 General..... | 22 | +| 5.2 Functionalities performed by entities at the edge of the network..... | 23 | +| 5.2.1 Interconnection Border Control Function (IBCF)..... | 23 | +| 5.2.2 Transition Gateway (TrGW)..... | 24 | +| 5.3 Identifying II-NNI traversal scenario..... | 24 | +| 5.3.1 General..... | 24 | +| 5.3.2 Mapping of the "iotl" SIP URI parameter to II-NNI traversal scenario..... | 24 | +| 6 Control plane interconnection..... | 25 | +| 6.1 Definition of Inter-IMS Network to Network Interconnection..... | 25 | +| 6.1.1 SIP methods and header fields..... | 25 | +| 6.1.1.1 General..... | 25 | +| 6.1.1.2 SIP methods..... | 25 | +| 6.1.1.3 SIP header fields..... | 26 | +| 6.1.1.3.0 General..... | 26 | +| 6.1.1.3.1 Trust and no trust relationship..... | 26 | +| 6.1.1.3.2 Derivation of applicable SIP header fields from 3GPP TS 24.229 [5]..... | 28 | +| 6.1.1.3.3 Applicability of SIP header fields on a roaming II-NNI..... | 28 | +| 6.1.1.3.4 Applicability of SIP header fields on a non-roaming II-NNI..... | 29 | +| 6.1.1.4 Notations of the codes..... | 29 | +| 6.1.1.5 Modes of signalling..... | 30 | +| 6.1.2 SDP protocol..... | 30 | +| 6.1.2.1 General..... | 30 | +| 6.1.3 Major capabilities..... | 30 | +| 6.1.4 SIP message bodies..... | 36 | +| 6.2 Control Plane Transport..... | 40 | +| 6.2.1 General..... | 40 | +| 6.3 SIP timers..... | 40 | +| 7 User plane Interconnection..... | 42 | +| 7.1 Media and Codec..... | 42 | +| 7.2 User Plane Transport..... | 42 | +| 8 Numbering, Naming and Addressing..... | 43 | +| 8.1 Numbering, Naming and Addressing for SIP message..... | 43 | +| 8.2 Numbering, Naming and Addressing for SDP..... | 44 | +| 9 IP Version..... | 44 | +| 10 Security..... | 44 | +| 11 Charging..... | 44 | +| 11.1 General..... | 44 | +| 11.2 Inter-operator accounting..... | 45 | +| 11.3 Transfer of IP multimedia service tariff information..... | 45 | +| 12 Supplementary services associated with the IMS multimedia telephony communication service..... | 46 | +| 12.1 General..... | 46 | + +| | | | +|---------|----------------------------------------------------------------------------------------------------------|----| +| 12.2 | Malicious Communication IDentification (MCID)..... | 46 | +| 12.3 | Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR)..... | 47 | +| 12.4 | Terminating Identification Presentation (TIP) and Terminating Identification Restriction (TIR)..... | 47 | +| 12.5 | Anonymous Communication Rejection (ACR)..... | 47 | +| 12.6 | Communication DIVersion (CDIV)..... | 48 | +| 12.7 | Communication Waiting (CW)..... | 48 | +| 12.8 | Communication HOLD (HOLD)..... | 48 | +| 12.9 | Message Waiting Indication (MWI)..... | 48 | +| 12.10 | Communication Barring (CB)..... | 49 | +| 12.10.1 | Incoming Communication Barring (ICB)..... | 49 | +| 12.10.2 | Outgoing Communication Barring (OCB)..... | 49 | +| 12.11 | Completion of Communications to Busy Subscriber (CCBS)..... | 49 | +| 12.12 | Completion of Communications by No Reply (CCNR)..... | 50 | +| 12.13 | Explicit Communication Transfer (ECT)..... | 50 | +| 12.13.1 | Consultative and blind transfer..... | 50 | +| 12.13.2 | Assured transfer..... | 51 | +| 12.14 | Customized Alerting Tone (CAT)..... | 51 | +| 12.15 | Customized Ringing Signal (CRS)..... | 51 | +| 12.16 | Closed User Group (CUG)..... | 52 | +| 12.17 | Personal Network Management (PNM)..... | 52 | +| 12.18 | Three-Party (3PTY)..... | 52 | +| 12.19 | Conference (CONF)..... | 53 | +| 12.20 | Flexible Alerting (FA)..... | 53 | +| 12.21 | Announcements..... | 54 | +| 12.21.1 | General..... | 54 | +| 12.21.2 | Providing announcements during the establishment of a communication session..... | 54 | +| 12.21.3 | Providing announcements during an established communication session..... | 54 | +| 12.21.4 | Providing announcements when communication request is rejected..... | 54 | +| 12.22 | Advice Of Charge (AOC)..... | 55 | +| 12.23 | Completion of Communications on Not Logged-in (CCNL)..... | 55 | +| 12.24 | Unstructured Supplementary Service Data (USSD)..... | 56 | +| 12.25 | Enhanced Calling Name (eCNAM)..... | 56 | +| 12.26 | Multi-Device and Multi-Identity (MuD and MiD)..... | 56 | +| 12.26.1 | Multi-Device (MuD)..... | 56 | +| 12.26.2 | Multi-Identity (MiD)..... | 56 | +| 13 | Interoperability of IMS Centralized Services (ICS) over II-NNI..... | 57 | +| 13.1 | General..... | 57 | +| 13.2 | IMS Centralized Services (ICS)..... | 57 | +| 14 | Interoperability of IMS Service Continuity over II-NNI..... | 58 | +| 14.1 | General..... | 58 | +| 14.2 | PS to CS Single Radio Voice Call Continuity (SRVCC) and Single Radio Video Call Continuity (vSRVCC)..... | 58 | +| 14.2.1 | Basic PS to CS SRVCC..... | 58 | +| 14.2.2 | PS to CS SRVCC for calls in alerting phase..... | 58 | +| 14.2.3 | Using the ATCF based architecture..... | 59 | +| 14.2.4 | PS to CS SRVCC for originating calls in pre-alerting phase..... | 59 | +| 14.2.5 | PS to CS SRVCC with the MSC server assisted mid-call feature..... | 59 | +| 14.2.6 | PS to CS SRVCC for terminating calls in pre-alerting phase..... | 59 | +| 14.3 | Inter UE Transfer (IUT)..... | 59 | +| 14.4 | MSC server assisted mid-call feature..... | 60 | +| 14.5 | CS to PS Single Radio Voice Call Continuity (SRVCC)..... | 61 | +| 14.5.1 | Basic CS to PS SRVCC..... | 61 | +| 14.5.2 | CS to PS SRVCC for calls in alerting phase..... | 61 | +| 14.5.3 | CS to PS SRVCC with the assisted mid-call feature..... | 61 | +| 14.6 | PS to CS dual radio voice call continuity (DRVCC)..... | 61 | +| 14.6.1 | Basic PS to CS DRVCC..... | 61 | +| 14.6.2 | PS to CS DRVCC with the assisted mid-call feature..... | 62 | +| 14.6.3 | PS to CS DRVCC for calls in alerting phase..... | 62 | +| 14.6.4 | PS to CS DRVCC for originating calls in pre-alerting phase..... | 62 | +| 14.7 | CS to PS Dual Radio Voice Call Continuity (DRVCC)..... | 62 | + +| | | | +|--------|--------------------------------------------------------------------------------|----| +| 14.7.1 | Basic CS to PS DRVCC..... | 62 | +| 14.7.2 | CS to PS DRVCC with the assisted mid-call feature..... | 63 | +| 14.7.3 | CS to PS DRVCC for calls in alerting phase..... | 63 | +| 14.7.4 | CS to PS DRVCC for originating calls in pre-alerting phase..... | 63 | +| 14.8 | PS to PS access transfer..... | 63 | +| 15 | Presence service..... | 64 | +| 15.0 | General..... | 64 | +| 15.1 | Subscription of presence information..... | 64 | +| 15.2 | Watcher subscribing to Presence List..... | 64 | +| 15.3 | Subscription to Watcher Information..... | 65 | +| 15.4 | Subscription to state changes in XML documents..... | 65 | +| 15.5 | Presence enhancements specified in Open Mobile Alliance (OMA) Release 1.1..... | 65 | +| 15.5.1 | General..... | 65 | +| 15.5.2 | OMA subscription of presence information..... | 65 | +| 15.5.3 | OMA watcher subscribing to Presence List..... | 65 | +| 15.5.4 | OMA subscription to Watcher Information..... | 66 | +| 15.6 | Presence enhancements specified in Open Mobile Alliance (OMA) Release 2.0..... | 66 | +| 15.6.1 | General..... | 66 | +| 15.6.2 | OMA subscription of presence information..... | 66 | +| 15.6.3 | OMA watcher subscribing to Presence List..... | 66 | +| 15.6.4 | OMA subscription to Watcher Information..... | 67 | +| 15.6.5 | Subscription to state changes in XML documents..... | 67 | +| 15.6.6 | Void..... | 67 | +| 15.6.7 | Void..... | 67 | +| 16 | Messaging service..... | 67 | +| 16.1 | General..... | 67 | +| 16.2 | Page-mode messaging..... | 68 | +| 16.4 | Session-mode messaging..... | 68 | +| 16.5 | Session-mode messaging conferences..... | 68 | +| 17 | Optimal Media Routeing..... | 69 | +| 17.1 | General..... | 69 | +| 17.2 | OMR related SDP attributes..... | 69 | +| 17.3 | IP realm names..... | 69 | +| 18 | Inter-UE transfer (IUT)..... | 69 | +| 18.1 | General..... | 69 | +| 18.2 | IUT without establishment of a collaborative session..... | 69 | +| 18.3 | IUT using a collaborative session..... | 70 | +| 18.3.1 | Collaborative session of participants of the same subscription..... | 70 | +| 18.3.2 | Establishment of a collaborative session during session setup..... | 70 | +| 18.3.3 | Assignment and transfer of control of a collaborative session..... | 71 | +| 18.3.4 | Collaborative session of participants of different subscriptions..... | 71 | +| 18.4 | Session replication / media replication..... | 71 | +| 18.4.1 | Pull mode..... | 71 | +| 18.4.2 | Push mode..... | 71 | +| 19 | Roaming Architecture for Voice over IMS with Local Breakout..... | 72 | +| 20 | Delivery of Media Resource Broker address information..... | 72 | +| 21 | Overload control..... | 72 | +| 21.1 | General..... | 72 | +| 21.2 | Feedback based mechanism..... | 73 | +| 21.3 | The load filter mechanism..... | 73 | +| 22 | Delivery of original destination identity..... | 73 | +| 23 | Telepresence using IMS..... | 73 | +| 24 | Barring of premium rate numbers..... | 74 | +| 25 | P-CSCF restoration..... | 74 | +| 25.1 | General..... | 74 | + +| | | | +|----------|-------------------------------------------------------------------------------------------|----| +| 25.2 | PCRF or PCF based P-CSCF restoration..... | 74 | +| 25.3 | HSS or UDM/HSS based P-CSCF restoration..... | 74 | +| 26 | Resource sharing..... | 74 | +| 27 | Service access number translation..... | 75 | +| 28 | Mission critical services..... | 75 | +| 28.1 | General..... | 75 | +| 28.2 | Interoperability of mission critical services for communication over II-NNI..... | 76 | +| 28.2.1 | Mission Critical services session establishment..... | 76 | +| 28.2.2 | MBMS transmission usage and location procedures..... | 77 | +| 28.2.3 | Affiliation procedure..... | 78 | +| 28.2.3.1 | General..... | 78 | +| 28.2.3.2 | Mandatory mode..... | 78 | +| 28.2.3.3 | Negotiated mode..... | 79 | +| 28.2.4 | Conference event package subscription..... | 79 | +| 28.2.5 | Mission critical services settings..... | 79 | +| 28.2.6 | Registration procedures..... | 80 | +| 28.2.7 | Group regrouping..... | 80 | +| 28.2.8 | Signalling plane messages for mission critical data..... | 81 | +| 28.2.9 | Functional alias management procedure..... | 81 | +| 29 | Calling number verification using signature verification and attestation information..... | 81 | +| 30 | IMS emergency service..... | 82 | +| 30.1 | IMS emergency registration..... | 82 | +| 30.2 | IMS emergency session..... | 82 | +| 30.3 | Next-Generation Pan-European eCall emergency service..... | 82 | +| 31 | Restricted Local Operator Services (RLOS)..... | 83 | +| 32 | 3GPP PS data off extension..... | 83 | +| 33 | MTSI Data channel..... | 83 | +| 34 | Support for signed attestation for emergency and priority IMS sessions..... | 83 | +| 34.1 | General..... | 83 | +| 34.2 | Calling number verification using signature verification and attestation information..... | 84 | +| 34.3 | Priority verification using assertion of priority information..... | 84 | + +| | | +|----------------------------------------------------------------------------------------------------|------------| +| Annex A (informative): Summary of SIP header fields..... | 84 | +| Annex B (informative): Dynamic view of SIP header fields within SIP messages..... | 89 | +| B.1 Scope..... | 89 | +| B.2 Methodology..... | 89 | +| B.3 ACK method..... | 91 | +| B.4 BYE method..... | 92 | +| B.5 CANCEL method..... | 95 | +| B.6 INFO method..... | 96 | +| B.7 INVITE method..... | 100 | +| B.8 MESSAGE method..... | 106 | +| B.9 NOTIFY method..... | 110 | +| B.10 OPTIONS method..... | 112 | +| B.11 PRACK method..... | 116 | +| B.12 PUBLISH method..... | 119 | +| B.13 REFER method..... | 123 | +| B.14 REGISTER method..... | 126 | +| B.15 SUBSCRIBE method..... | 129 | +| B.16 UPDATE method..... | 133 | +| Annex C (informative): The list of option items for II-NNI..... | 137 | +| C.1 Scope..... | 137 | +| C.2 Format of option item table..... | 137 | +| C.3 Option item table..... | 137 | +| C.3.0 Supported II-NNI traversal scenarios..... | 137 | +| C.3.1 Option item table common to roaming, non-roaming II-NNI and loopback traversal scenario..... | 138 | +| C.3.2 Option item table specific to roaming II-NNI..... | 147 | +| C.3.3 Option item table specific to non-roaming II-NNI and loopback traversal scenario..... | 151 | +| Annex D (informative): Change history..... | 155 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The objective of this document is to address the Inter-IMS Network to Network Interface (II-NNI) consisting of Ici and Izi reference points between IMS networks in order to support end-to-end service interoperability. + +The present document addresses the issues related to control plane signalling (3GPP usage of SIP and SDP protocols, required SIP header fields) as well as other interconnecting aspects like security, numbering/naming/addressing and user plane issues as transport protocol, media and codecs actually covered in a widespread set of 3GPP specifications. A profiling of the Inter-IMS Network to Network Interface (II-NNI) is also provided. + +Charging aspects are addressed as far as SIP signalling is concerned. + +IMS emergency session establishment between IMS networks is addressed as far as SIP signalling is concerned. + +SIP signalling traversing the NNI between a CSCF and MRB, e.g. for media control or Voice Interworking with Enterprise IP-PBX, and SIP signalling traversing the NNI on the Mr interface between the CSCF and the MRFC, or on the Mr' interface between the AS and MRFC, or on the Rc interface between AS and MRB is not considered in the present release of this specification. + +SIP signalling traversing the NNI between an application server and the remaining IMS functional entities (e.g. for MCPTT interface SIP-2 in figure 7.3.1-2 in 3GPP TS 23.280 [200]) is not considered in the present release of this specification. + +SIP signalling traversing the NNI between an ISC gateway and an AS in an enterprise network, e.g. for media control and voice interworking with enterprise IP-PBX, on the ISC interface between the ISC gateway and the enterprise network is not considered in the present release of this specification. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same Release as the present document. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] IETF RFC 791: "Internet Protocol". +- [3] 3GPP TS 23.002: "Network architecture". +- [4] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [5] 3GPP TS 24.229: "Internet Protocol (IP) multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [6] 3GPP TR 24.930: "Signalling flows for the session setup in the IP Multimedia core network Subsystem (IMS) based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [7] IETF RFC 2460: "Internet Protocol, Version 6 (IPv6) Specification". +- [8] 3GPP TS 29.162: "Interworking between the IM CN subsystem and IP networks". +- [9] 3GPP TS 22.228: "Service requirements for the IP multimedia core network subsystem". +- [10] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security". + +- [11] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia Telephony; Media handling and interaction". +- [12] ETSI TS 181 005 V1.1.1: "Telecommunications and Internet converged Services and Protocols for Advanced Networking (TISPAN); Services and Capabilities Requirements". +- [13] IETF RFC 3261: "SIP: Session Initiation Protocol". +- [14] IETF RFC 3966: "The tel URI for Telephone Numbers". +- [15] IETF RFC 3860: "Common Profile for Instant Messaging (CPIM)". +- [16] IETF RFC 3859: "Common Profile for Presence (CPP)". +- [17] IETF RFC 4975: "The Message Session Relay Protocol (MSRP)". +- [18] IETF RFC 3262: "Reliability of provisional responses in Session Initiation Protocol (SIP)". +- [19] IETF RFC 3428: "Session Initiation Protocol (SIP) Extension for Instant Messaging". +- [20] IETF RFC 6665: "SIP-Specific Event Notification". + +NOTE: In earlier releases of this document the predecessor IETF RFC 3265 is used. + +- [21] IETF RFC 3903: "An Event State Publication Extension to the Session Initiation Protocol (SIP)". +- [22] IETF RFC 3515: "The Session Initiation Protocol (SIP) REFER method". +- [23] IETF RFC 3311: "The Session Initiation Protocol (SIP) UPDATE method". +- [24] IETF RFC 7315: "Private Header (P-Header) Extensions to the Session Initiation Protocol (SIP) for the 3GPP". +- [24A] IETF RFC 7976: "Updates to Private Header (P-Header) Extension Usage in Session Initiation Protocol (SIP) Requests and Responses". +- [24B] IETF RFC 7913: "P-Access-Network-Info ABNF Update". +- [25] IETF RFC 7044: "An Extension to the Session Initiation Protocol (SIP) for Request History Information". +- [26] IETF RFC 6050: "A Session Initiation Protocol (SIP) Extension for the Identification of Services". +- [27] IETF RFC 4168: "The Stream Control Transmission Protocol (SCTP) as a Transport for the Session Initiation Protocol (SIP)". +- [28] Void. +- [29] 3GPP TS 32.260: "Telecommunication management; Charging management; IP Multimedia Subsystem (IMS) charging". +- [30] 3GPP TS 22.173: "IP Multimedia Core Network Subsystem (IMS); Multimedia Telephony Service and supplementary services; Stage 1". +- [31] 3GPP TS 24.173: "IMS multimedia telephony communication service and supplementary services; Stage 3". +- [32] 3GPP TS 24.607: "Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR) using IP Multimedia (IM); Core Network (CN) subsystem". +- [33] 3GPP TS 24.616: "Malicious Communication Identification (MCID) using IP Multimedia (IM) Core Network (CN) subsystem". +- [34] IETF RFC 3323: "A Privacy Mechanism for the Session Initiation Protocol (SIP)". +- [35] 3GPP TS 23.003: "Numbering, addressing and identification". + +- [36] 3GPP TS 24.610: "Communication HOLD (HOLD) using IP Multimedia (IM) Core Network (CN) subsystem". +- [37] 3GPP TS 24.615: "Communication Waiting (CW) using IP Multimedia (IM) Core Network (CN) subsystem". +- [38] 3GPP TS 24.628: "Common Basic Communication procedures using IP Multimedia (IM) Core Network (CN) subsystem". +- [39] IETF RFC 6086: "Session Initiation Protocol (SIP) INFO Method and Package Framework". +- [40] IETF RFC 3312: "Integration of resource management and Session Initiation Protocol (SIP)". +- [41] IETF RFC 4032: "Update to the Session Initiation Protocol (SIP) Preconditions Framework". +- [42] IETF RFC 3313: "Private Session Initiation Protocol (SIP) Extensions for Media Authorization". +- [43] IETF RFC 3327: "Session Initiation Protocol Extension Header Field for Registering Non-Adjacent Contacts". +- [44] IETF RFC 3325: "Private Extensions to the Session Initiation Protocol (SIP) for Network Asserted Identity within Trusted Networks". +- [45] IETF RFC 3608: "Session Initiation Protocol (SIP) Extension Header Field for Service Route Discovery During Registration". +- [46] IETF RFC 3486: "Compressing the Session Initiation Protocol (SIP)". +- [47] IETF RFC 3329: "Security Mechanism Agreement for the Session Initiation Protocol (SIP)". +- [48] IETF RFC 3326: "The Reason Header Field for the Session Initiation Protocol (SIP)". +- [49] IETF RFC 6432: "Carrying Q.850 Codes in Reason Header Fields in SIP (Session Initiation Protocol) Responses". +- [50] IETF RFC 3581: "An Extension to the Session Initiation Protocol (SIP) for Symmetric Response Routing". +- [51] IETF RFC 3841: "Caller Preferences for the Session Initiation Protocol (SIP)". +- [52] IETF RFC 4028: "Session Timers in the Session Initiation Protocol (SIP)". +- [53] IETF RFC 3892: "The Session Initiation Protocol (SIP) Referred-By Mechanism". +- [54] IETF RFC 3891: "The Session Initiation Protocol (SIP) 'Replaces' Header". +- [55] IETF RFC 3911: "The Session Initiation Protocol (SIP) 'Join' Header". +- [56] IETF RFC 3840: "Indicating User Agent Capabilities in the Session Initiation Protocol (SIP)". +- [57] IETF RFC 5079: "Rejecting Anonymous Requests in the Session Initiation Protocol (SIP)". +- [58] IETF RFC 4458: "Session Initiation Protocol (SIP) URIs for Applications such as Voicemail and Interactive Voice Response (IVR)". +- [59] IETF RFC 4320: "Actions Addressing Identified Issues with the Session Initiation Protocol's (SIP) Non-INVITE Transaction". +- [60] IETF RFC 4457: "The Session Initiation Protocol (SIP) P-User-Database Private-Header (P-header)". +- [61] IETF RFC 5031: "A Uniform Resource Name (URN) for Emergency and Other Well-Known Services". +- [62] IETF RFC 5627: "Obtaining and Using Globally Routable User Agent (UA) URIs (GRUU) in the Session Initiation Protocol (SIP)". + +- [63] Void. +- [64] IETF RFC 5002: "The Session Initiation Protocol (SIP) P-Profile-Key Private Header (P-Header)". +- [65] IETF RFC 5626: "Managing Client-Initiated Connections in the Session Initiation Protocol (SIP)". +- [66] IETF RFC 5768: "Indicating Support for Interactive Connectivity Establishment (ICE) in the Session Initiation Protocol (SIP)". +- [67] IETF RFC 5365: "Multiple-Recipient MESSAGE Requests in the Session Initiation Protocol (SIP)". +- [68] IETF RFC 6442: "Location Conveyance for the Session Initiation Protocol". +- [69] IETF RFC 5368: "Referring to Multiple Resources in the Session Initiation Protocol (SIP)". +- [70] IETF RFC 5366: "Conference Establishment Using Request-Contained Lists in the Session Initiation Protocol (SIP)". +- [71] IETF RFC 5367: "Subscriptions to Request-Contained Resource Lists in the Session Initiation Protocol (SIP)". +- [72] IETF RFC 4967: "Dial String Parameter for the Session Initiation Protocol Uniform Resource Identifier". +- [73] IETF RFC 4964: "The P-Answer-State Header Extension to the Session Initiation Protocol for the Open Mobile Alliance Push to Talk over Cellular". +- [74] IETF RFC 5009: "Private Header (P-Header) Extension to the Session Initiation Protocol (SIP) for Authorization of Early Media". +- [75] IETF RFC 4694: "Number Portability Parameters for the 'tel' URI". +- [76] Void. +- [77] IETF RFC 4411: "Extending the Session Initiation Protocol (SIP) Reason Header for Preemption Events". +- [78] IETF RFC 4412: "Communications Resource Priority for the Session Initiation Protocol (SIP)". +- [79] IETF RFC 5393: "Addressing an Amplification Vulnerability in Session Initiation Protocol (SIP) Forking Proxies". +- [80] IETF RFC 5049: "Applying Signaling Compression (SigComp) to the Session Initiation Protocol (SIP)". +- [81] IETF RFC 5688: "A Session Initiation Protocol (SIP) Media Feature Tag for MIME Application Sub-Types". +- [82] IETF RFC 5360: "A Framework for Consent-Based Communications in the Session Initiation Protocol (SIP)". +- [83] IETF RFC 7433: "A Mechanism for Transporting User-to-User Call Control Information in SIP". +- [83A] IETF RFC 7434: "Interworking ISDN Call Control User Information with SIP". +- [84] IETF RFC 7316: "The Session Initiation Protocol (SIP) P-Private-Network-Indication Private Header (P-Header)". +- [85] IETF RFC 5502: "The SIP P-Served-User Private-Header (P-Header) for the 3GPP IP Multimedia (IM) Core Network (CN) Subsystem". +- [86] Void. +- [87] IETF RFC 8497: "Marking SIP Messages to Be Logged". +- [88] IETF RFC 6228: "Response Code for Indication of Terminated Dialog". + +- [89] IETF RFC 5621: "Message Body Handling in the Session Initiation Protocol (SIP)". +- [90] IETF RFC 6223: "Indication of support for keep-alive". +- [91] IETF RFC 5552: "SIP Interface to VoiceXML Media Services". +- [92] IETF RFC 3862: "Common Presence and Instant Messaging (CPIM): Message Format". +- [93] IETF RFC 5438: "Instant Message Disposition Notification". +- [94] IETF RFC 5373: "Requesting Answering Modes for the Session Initiation Protocol (SIP)". +- [95] Void. +- [96] IETF RFC 3959: "The Early Session Disposition Type for the Session Initiation Protocol (SIP)". +- [97] Void. +- [98] 3GPP TS 24.183: "Customized Ringing Signal (CRS) using IP Multimedia (IM) Core Network (CN) subsystem". +- [99] 3GPP TS 24.259: "Personal Network Management (PNM) using IP Multimedia (IM) Core Network (CN) subsystem". +- [100] 3GPP TS 24.238: "Session Initiation Protocol (SIP) based user configuration". +- [101] 3GPP TS 24.239: "Flexible Alerting (FA) using IP Multimedia (IM) Core Network (CN) subsystem". +- [102] Void. +- [103] 3GPP TS 24.654: "Closed User Group (CUG) using IP Multimedia (IM) Core Network (CN) subsystem". +- [104] Void. +- [105] 3GPP TS 24.605: "Conference (CONF) using IP Multimedia (IM) Core Network (CN) subsystem". +- [106] 3GPP TS 24.147: "Conferencing using the IP Multimedia (IM) Core Network (CN) subsystem". +- [107] Void. +- [108] Void. +- [109] 3GPP TS 24.642: "Completion of Communications to Busy Subscriber (CCBS) Completion of Communications by No Reply (CCNR) using IP Multimedia (IM) Core Network (CN) subsystem". +- [110] Void. +- [111] Void. +- [112] 3GPP TS 24.606: "Message Waiting Indication (MWI) using IP Multimedia (IM) Core Network (CN) subsystem". +- [113] 3GPP TS 24.608: "Terminating Identification Presentation (TIP) and Terminating Identification Restriction (TIR) using IP Multimedia (IM); Core Network (CN) subsystem". +- [114] 3GPP TS 24.611: "Communication Barring (CB) using IP Multimedia (IM); Core Network (CN) subsystem". +- [115] Void. +- [116] 3GPP TS 24.629: "Explicit Communication Transfer (ECT) using IP Multimedia (IM) Core Network (CN) subsystem". + +- [117] 3GPP TS 24.604: "Communication DIVersion (CDIV) using IP Multimedia (IM) Core Network (CN) subsystem". +- [118] Void. +- [119] Void. +- [120] 3GPP TS 23.292: "IP Multimedia Subsystem (IMS) Centralized Services; Stage 2". +- [121] 3GPP TS 24.292: "IP Multimedia Core Network subsystem Centralized Services (ICS); Stage 3". +- [122] 3GPP TS 24.647: "Advice Of Charge (AOC) using IP Multimedia (IM) Core Network (CN) subsystem". +- [123] Void. +- [124] IETF RFC 7989: "End-to-End Session Identification in IP-Based Multimedia Communication Networks". +- [125] IETF RFC 6026: "Correct Transaction Handling for 2xx Responses to Session Initiation Protocol (SIP) INVITE Requests". +- [126] IETF RFC 5658: "Addressing Record-Route issues in the Session Initiation Protocol (SIP)". +- [127] IETF RFC 5954: "Essential correction for IPv6 ABNF and URI comparison in RFC3261". +- [128] Void. +- [129] 3GPP TS 24.182: "IP Multimedia Subsystem (IMS) Customized Alerting Tones (CAT)". +- [130] 3GPP TS 29.292: "Interworking between the IP Multimedia (IM) Core Network (CN) subsystem and MSC Server for IMS Centralized Services (ICS)". +- [131] 3GPP TS 24.237: "IP Multimedia (IM) Core Network (CN) subsystem; IP Multimedia Subsystem (IMS) Service Continuity". +- [132] 3GPP TS 24.141: "Presence service using the IP Multimedia (IM) Core Network (CN) subsystem". +- [133] IETF RFC 6794: "A Framework for Session Initiation Protocol (SIP) Session Policies". +- [134] IETF RFC 5875: "An Extensible Markup Language (XML) Configuration Access Protocol (XCAP) Diff Event Package". +- [135] IETF RFC 4488: "Suppression of Session Initiation Protocol (SIP) REFER Method Implicit Subscription". +- [136] IETF RFC 7462: "URNs for the Alert-Info Header Field of the Session Initiation Protocol (SIP)". +- [137] Void. +- [138] OMA-TS-Presence\_SIMPLE-V2\_0-20120710-A: "Presence SIMPLE Specification". +- [139] 3GPP TS 24.247: "Messaging service using the IP Multimedia (IM) Core Network (CN) subsystem". +- [140] IETF RFC 4538: "Request Authorization through Dialog Identification in the Session Initiation Protocol (SIP)". +- [141] IETF RFC 5318: "The Session Initiation Protocol (SIP) P-Refused-URI-List Private-Header (P-Header)". +- [142] OMA-TS-Presence\_SIMPLE-V1\_1\_1-20100225-A: "Presence SIMPLE Specification". +- [143] IETF RFC 6809: "Mechanism to Indicate Support of Features and Capabilities in the Session Initiation Protocol (SIP)". + +- [144] IETF RFC 5839: "An Extension to Session Initiation Protocol (SIP) Events for Conditional Event Notification". +- [145] Void. +- [146] IETF RFC 3264: "An Offer/Answer Model with the Session Description Protocol (SDP)". +- [147] IETF RFC 4566: "SDP: Session Description Protocol". +- [148] 3GPP TS 29.079: "Optimal Media Routeing within the IP Multimedia Subsystem; Stage 3". +- [149] 3GPP TS 24.337: "IP Multimedia Subsystem (IMS) inter-UE transfer". +- [150] IETF RFC 3960: "Early Media and Ringing Tone Generation in the Session Initiation Protocol (SIP)". +- [151] IETF RFC 3550: "RTP: A Transport Protocol for Real-Time Applications". +- [152] IETF RFC 768: "User Datagram Protocol". +- [153] IETF RFC 3551: "RTP Profile for Audio and Video Conferences with Minimal Control". +- [154] IETF RFC 3556: "Session Description Protocol (SDP) Bandwidth Modifiers for RTP Control Protocol (RTCP) Bandwidth". +- [155] IETF RFC 4585: "Extended RTP Profile for Real-time Transport Control Protocol (RTCP)-Based Feedback (RTP/AVPF)". +- [156] IETF RFC 793: "Transmission Control Protocol". +- [157] IETF RFC 4733: "RTP Payload for DTMF Digits, Telephony Tones, and Telephony Signals". +- [158] IETF RFC 4916: "Connected Identity in the Session Initiation Protocol (SIP)". +- [159] 3GPP TS 23.237: "IP Multimedia Subsystem (IMS) Service Continuity". +- [160] IETF RFC 6140: "Registration for Multiple Phone Numbers in the Session Initiation Protocol (SIP)". +- [161] IETF RFC 6230: "Media Control Channel Framework". +- [162] IETF RFC 4145: "TCP-Based Media Transport in the Session Description Protocol (SDP)". +- [163] 3GPP TS 24.390: "Unstructured Supplementary Service Data (USSD)". +- [164] IETF RFC 6357: "Design Considerations for Session Initiation Protocol (SIP) Overload Control". +- [165] IETF RFC 7339: "Session Initiation Protocol (SIP) Overload Control". +- [166] IETF RFC 7415: "Session Initiation Protocol (SIP) Rate Control". +- [167] IETF RFC 7200: "A Session Initiation Protocol (SIP) Load-Control Event Package". +- [168] 3GPP TS 29.163: "Interworking between the IP Multimedia (IM) Core Network (CN) subsystem and Circuit Switched (CS) networks". +- [169] IETF RFC 2046: "Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types". +- [170] IETF RFC 2387: "The MIME Multipart/Related Content-type". +- [171] IETF RFC 3420: "Internet Media Type message/sipfrag". +- [172] IETF RFC 3842: "A Message Summary and Message Waiting Indication Event Package for the Session Initiation Protocol (SIP)". +- [173] IETF RFC 3858: "An Extensible Markup Language (XML) Based Format for Watcher Information". + +- [174] IETF RFC 3863: "Presence Information Data Format (PIDF)". +- [175] IETF RFC 3994: "Indication of Message Composition for Instant Messaging". +- [176] IETF RFC 4661: "An Extensible Markup Language (XML) Based Format for Event Notification Filtering". +- [177] IETF RFC 4662: "A Session Initiation Protocol (SIP) Event Notification Extension for Resource Lists". +- [178] IETF RFC 4826: "Extensible Markup Language (XML) Formats for Representing Resource Lists". +- [179] IETF RFC 5262: "Presence Information Data Format (PIDF) Extension for Partial Presence". +- [180] IETF RFC 5874: "An Extensible Markup Language (XML) Document Format for Indicating a Change in XML Configuration Access Protocol (XCAP) Resources". +- [181] Void. +- [182] OMA-SUP-XSD\_prs\_suppnotFilter-V1\_0-20120710-A: "Presence - Event notification suppression filter". +- [183] 3GPP TS 32.240: "Telecommunication management; Charging management; Charging architecture and principles". +- [184] IETF RFC 7090: "Public Safety Answering Point (PSAP) Callback". +- [185] IETF RFC 8055: "Session Initiation Protocol (SIP) Via Header Field Parameter to Indicate Received Realm". +- [186] 3GPP TS 29.658: "SIP Transfer of IP Multimedia Service Tariff Information". +- [187] 3GPP TS 22.153: "Multimedia priority service". +- [188] IETF RFC 7549: "3GPP SIP URI Inter Operator Traffic Leg parameter". +- [189] 3GPP TS 24.103: "Telepresence using the IP Multimedia (IM) Core Network (CN) Subsystem (IMS); Stage 3". +- [190] IETF RFC 8841: "Session Description Protocol (SDP) Offer/Answer Procedures for Stream Control Transmission Protocol (SCTP) over Datagram Transport Layer Security (DTLS) Transport". +- [191] 3GPP TS 24.315: "IP Multimedia Subsystem (IMS) Operator Determined Barring (ODB)". +- [192] 3GPP TR 29.949: "Study on Technical aspects on Roaming End-to-end scenarios with VoLTE IMS and other networks". +- [193] IETF RFC 8119: "SIP "cause" URI Parameter for Service Number Translation". +- [194] IETF RFC 7647: "Clarifications for the Use of REFER with RFC6665". +- [195] IETF RFC 7614: "Explicit Subscriptions for the REFER Method". +- [196] IETF RFC 7621: "A Clarification on the Use of Globally Routable User Agent URIs (GRUUs) in the Session Initiation Protocol SIP Event Notification Framework". +- [197] IETF RFC 2646: "The Text/Plain Format Parameter". +- [198] IETF RFC 1866: "Hypertext Markup Language - 2.0". +- [199] 3GPP TS 22.179: "Mission Critical Push To Talk (MCPTT); Stage 1". +- [200] 3GPP TS 23.280: "Common functional architecture to support mission critical services; Stage 2". +- [201] 3GPP TS 24.379: "Mission Critical Push To Talk (MCPTT) call control Protocol specification". + +- [202] 3GPP TS 24.380: "Mission Critical Push To Talk (MCPTT) floor control Protocol specification". +- [203] IETF RFC 8498: "A P-Served-User Header Field Parameter for an Originating Call Diversion (CDIV) Session Case in the Session Initiation Protocol (SIP)". +- [204] IETF RFC 4575: "A Session Initiation Protocol (SIP) Event Package for Conference State". +- [205] IETF RFC 4354: "A Session Initiation Protocol (SIP) Event Package and Data Format for Various Settings in Support for the Push-to-Talk over Cellular (PoC) Service". +- [206] IETF RFC 8224: "Authenticated Identity Management in the Session Initiation Protocol (SIP)". +- [207] IETF RFC 8197: "A SIP Response Code for Unwanted Calls". +- [208] IETF RFC 6910: "Completion of Calls for the Session Initiation Protocol (SIP)". +- [209] 3GPP TS 22.280: "Mission Critical Services Common Requirements". +- [210] 3GPP TS 24.281: "Mission Critical Video (MCVideo) signalling control; Protocol specification". +- [211] 3GPP TS 24.282: "Mission Critical Data (MCData) signalling control; Protocol specification". +- [212] 3GPP TS 24.581: "Mission Critical Video (MCVideo) media plane control; Protocol specification". +- [213] 3GPP TS 24.582: "Mission Critical Data (MCData) media plane control; Protocol specification". +- [214] IETF RFC 8606: "ISDN User Part (ISUP) Cause Location Parameter for the SIP Reason Header Field". +- [215] 3GPP TS 23.167: "IP Multimedia Subsystem (IMS) emergency sessions". +- [216] IETF RFC 8262: "Content-ID Header Field in the Session Initiation Protocol (SIP)". +- [217] 3GPP TS 24.196: "Technical Specification Group Core Network and Terminals; Enhanced Calling Name". +- [218] 3GPP TS 24.174: "Support of Multi-Device and Multi-Identity in IMS; Stage 3". +- [219] 3GPP TS 23.218: "IP Multimedia (IM) Session Handling; IM call model". +- [220] IETF RFC 9410: "Handling of Identity Header Errors for Secure Telephone Identity Revisited (STIR)". +- [221] IETF RFC 9366: "Multiple SIP Reason Header Field Values". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**example:** text used to clarify abstract rules by applying them literally. + +**IM CN subsystem:** (IP Multimedia CN subsystem) comprises of all CN elements for the provision of IP multimedia applications over IP multimedia sessions, as specified in 3GPP TS 22.228 [9]. + +**IP multimedia session:** as specified in 3GPP TS 22.228 [9] an IP multimedia session is a set of multimedia senders and receivers and the data streams flowing from senders to receivers. IP multimedia sessions are supported by the IP multimedia CN Subsystem and are enabled by IP connectivity bearers (e.g. GPRS as a bearer). A user can invoke concurrent IP multimedia sessions. + +**non-roaming II-NNI:** the II-NNI between IMS home networks, or, if the Roaming Architecture for Voice over IMS with Local Breakout is used, alternatively the II-NNI between the caller's visited network and the callee's home network. + +**roaming II-NNI:** the II-NNI between a visited IMS network and the IMS home network; for the Roaming Architecture for Voice over IMS with Local Breakout, the loopback traversal scenario is excluded. + +**loopback traversal scenario:** for the Roaming Architecture for Voice over IMS with Local Breakout, the scenario where the II-NNI between the caller's home network and the caller's visited network is being traversed by an initial INVITE request from the caller's home network to the caller's visited network or any subsequent SIP message within the same dialogue on the same call leg. + +**home-to-visited request on roaming II-NNI:** SIP request being sent from the callee's home network to the callee's visited network. + +**home routeing:** the scenario when the caller's home network routes a dialog creating SIP request directly to the callee's home network without using the loopback traversal scenario. + +**visited-to-home request on roaming II-NNI:** SIP request being sent from the caller's visited network to the caller's home network. + +**home-to-visited response on roaming II-NNI:** SIP response being sent from the caller's home network to the caller's visited network. + +**visited-to-home response on roaming II-NNI:** SIP response being sent from the callee's visited network to the callee's home network. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.292 [120] apply: + +### **MSC Server enhanced for ICS** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.237 [159] apply: + +### **MSC server enhanced for SRVCC** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 24.237 [131] apply: + +### **MSC server enhanced for dual radio** + +For the purposes of the present document, the following term and definition given in 3GPP TS 23.218 [219] apply: + +### **Standalone transaction** + +## **3.2 Symbols** + +For the purposes of the present document, the following symbols apply: + +| | | +|-----|----------------------------------------------------------------------------------------------------------------------------------------------| +| I2 | Reference point between the MSC Server enhanced for ICS and the home IMS | +| Ici | Reference Point between an IBCF and another IBCF belonging to a different IM CN subsystem network | +| Ix | Reference Point between an IBCF and TrGW | +| Izi | Reference Point between a TrGW and another TrGW or media handling node belonging to a different IM CN subsystem network | +| Mi | Reference Point between a BGCF and CSCF | +| Mm | Reference Point between a CSCF/BGCF/IMS ALG and an IP multimedia network | +| Mw | Reference Point between a CSCF and another CSCF | +| Mx | Reference Point between a CSCF/BGCF/MSC Server enhanced for ICS/ MSC Server enhanced for SRVCC / MSC server enhanced for dual radio and IBCF | + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|---------|-------------------------------------------------| +| 18x | A SIP status-code in the range 180 through 189 | +| 2xx | A SIP status-code in the range 200 through 299 | +| 3PTY | Three-Party | +| 3xx | A SIP status-code in the range 300 through 399 | +| 4xx | A SIP status-code in the range 400 through 499 | +| 5GS | 5G System | +| 5xx | A SIP status-code in the range 500 through 599 | +| 6xx | A SIP status-code in the range 600 through 699 | +| ACR | Anonymous Communication Rejection | +| AOC | Advice Of Charge | +| AS | Application Server | +| ATCF | Access Transfer Control Function | +| B2BUA | Back 2 Back User Agent | +| BGCF | Breakout Gateway Control Function | +| CAT | Customized Alerting Tone | +| CB | Communication Barring | +| CCBS | Completion of Communications to Busy Subscriber | +| CCNL | Completion of Communications on Not Logged-in | +| CCNR | Communication Completion on No Reply | +| CDIV | Communication Diversion | +| CONF | Conference | +| CRS | Customized Ringing Signal | +| CSCF | Call Session Control Function | +| CW | Communication Waiting | +| DRVCC | Dual Radio Voice Call Continuity | +| eCNAM | Enhanced Calling Name | +| E-CSCF | Emergency CSCF | +| ECT | Explicit Communication Transfer | +| FA | Flexible Alerting | +| GRUU | Globally Routable User agent URI | +| HOLD | Communication HOLD | +| IBCF | Interconnection Border Control Function | +| ICB | Incoming Communication Barring | +| ICID | IMS Charging Identifier | +| ICS | IMS Centralized Services | +| I-CSCF | Interrogating CSCF | +| II-NNI | Inter-IMS Network to Network Interface | +| IM | Instant Messaging | +| IMS-ALG | IMS Application Level Gateway | +| IOI | Inter Operator Identifier | +| IUT | Inter UE Transfer | +| MBMS | Multimedia Broadcast Multicast Service | +| MCData | Mission Critical Data | +| MCID | Malicious Communication IDentification | +| MCPTT | Mission Critical Push-To-Talk | +| MCVideo | Mission Critical Video | +| MiD | Multi-iDentity | +| MMTEL | Multimedia Telephony | +| MPS | Multimedia Priority Service | +| MRB | Media Resource Broker | +| MRFC | Media Resource Function Controller | +| MRFP | Multimedia Resource Function Processor | +| MSD | Minimum Set of Data | +| MSRP | Message Session Relay Protocol | +| MTSI | Multimedia Telephony Service for IMS | + +| | | +|-----------|----------------------------------------------------------------------| +| MuD | Multi-Device | +| MWI | Message Waiting Indication | +| NA(P)T-PT | Network Address (Port-Multiplexing) Translation-Protocol Translation | +| NNI | Network to Network Interface | +| OCB | Outgoing Communication Barring | +| OIP | Originating Identification Presentation | +| OIR | Originating Identification Restriction | +| OMA | Open Mobile Alliance | +| OMR | Optimal Media Routeing | +| P-CSCF | Proxy CSCF | +| PCF | Policy Control Function | +| PCRF | Policy and Charging Rules Function | +| PNM | Personal Network Management | +| PRES | Presence | +| PSAP | Public Safety Answering Point | +| PSI | Public Service Identity | +| RLOS | Restricted Local Operator Services | +| RTT | Round-trip Time | +| S-CSCF | Serving CSCF | +| SRVCC | Single Radio Voice Call Continuity | +| STN | Session Transfer Number | +| TIP | Terminating Identification Presentation | +| TIR | Terminating Identification Restriction | +| TRF | Transit and Roaming Function | +| TrGW | Transition Gateway | +| UDM | Unified Data Management | +| vSRVCC | Single Radio Video Call Continuity | + +# 4 Overview + +Interconnection between two different IM CN subsystems shall be guaranteed in order to support end-to-end service interoperability. For this purpose, Inter-IMS Network to Network Interface (II-NNI) between two IM CN subsystem networks is adopted, according to the assumptions coming from 3GPP TS 23.002 [3] and 3GPP TS 23.228 [4]. + +NOTE: The end-to-end service interoperability within one IM CN subsystem over the Mi, Mm, Mw and I2 reference points not passing over the Mx reference point as defined in 3GPP TS 23.228 [4] is outside the scope of this document. + +Aiming to support the delivery of IMS services between two separated IM CN subsystems, protocol interconnection has to occur: + +- at a control plane level, in order that IMS procedures can be supported. In this case the adopted reference point is the Ici; and +- at a user plane level, where media streams are exchanged over the Izi reference point. + +IP multimedia sessions are managed by SIP. The transport mechanism for both SIP session signalling and media transport is IPv4 (IETF RFC 791 [2]) or IPv6 (IETF RFC 2460 [7]). The 3GPP profile of SIP defining the usage of SIP within the IM CN subsystem is specified in 3GPP TS 24.229 [5]. Example call flows are provided in 3GPP TR 24.930 [6]. + +The general interconnection model is shown in figure 4.1. + +![Diagram showing the interconnection model for IM CN subsystems. Two gray ovals, each labeled 'IM CN Subsystem', are connected by a horizontal line. A vertical line segment crosses this horizontal line, and a rectangular box labeled 'II-NNI' is centered on this vertical segment.](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +``` +graph LR; A((IM CN Subsystem)) --- II_NNI[II-NNI]; II_NNI --- B((IM CN Subsystem)); +``` + +Diagram showing the interconnection model for IM CN subsystems. Two gray ovals, each labeled 'IM CN Subsystem', are connected by a horizontal line. A vertical line segment crosses this horizontal line, and a rectangular box labeled 'II-NNI' is centered on this vertical segment. + +**Figure 4.1: Interconnection Model for IM CN subsystems** + +The II-NNI traversal scenarios in this document are covered in figure 4.2, figure 4.3 and figure 4.4. + +NOTE 1: Any II-NNI can contain intermediate transit network(s). The intermediate transit network can either be an IMS transit network with or without a transit function as specified in 3GPP TS 24.229 [5] or a non-IMS transit network using standards outside the scope of 3GPP. + +NOTE 2: IMS home network A and IMS home network B represent the IMS home network on originating side and terminating side respectively. + +NOTE 3: IMS visited network X and IMS visited network Y represent the IMS visited network on originating side and terminating side respectively. + +**Figure 4.2: II-NNI traversal scenarios when P-CSCF is located in visited network and when home routing is used** + +- NOTE 1: Any II-NNI can contain intermediate transit network(s). The intermediate transit network can either be an IMS transit network with or without a transit function as specified in 3GPP TS 24.229 [5] or a non-IMS transit network using standards outside the scope of 3GPP. +- NOTE 2: IMS home network A and IMS home network B represent the IMS home network on originating side and terminating side respectively. +- NOTE 3: IMS visited network X and IMS visited network Y represent the IMS visited network on originating side and terminating side respectively. + +**Figure 4.3: II-NNI traversal scenarios when P-CSCF is located in visited network and when the roaming architecture for voice over IMS with local breakout is used** + +- NOTE 1: Originating IMS network O represents the IMS network to which the originating UE is attached to, and terminating IMS network T represents the IMS network which accomodates a PSAP. +- NOTE 2: Originating IMS network O can be a visited IMS network or a home IMS network. +- NOTE 3: The E-CSCF is located in the originating IMS network O. +- NOTE 4: Any II-NNI between originating IMS network O and terminating IMS network T does not use any specific capabilities for roaming II-NNI, and is treated as non-roaming II-NNI. + +**Figure 4.4: IMS emergency session traversal scenario on non-roaming II-NNI** + +The possible functional entities involved in the signalling plane interconnection (IBCF, I-CSCF, P-CSCF, ATCF, S-CSCF, E-CSCF, BGCF, MSC Server enhanced for ICS, MSC server enhanced for SRVCC, MSC server enhanced for dual radio and TRF) and in the user plane interconnection (TrGW) are specified in 3GPP TS 24.229 [5], in 3GPP TS 24.292 [121], 3GPP TS 29.292 [130], 3GPP TS 29.162 [8] and in 3GPP TS 24.237 [131]. + +IP Version interworking is described within 3GPP TS 29.162 [8]. + +Examples of usage of the Inter-IMS Network to Network Interface (II-NNI) for roaming scenarios are described in 3GPP TR 29.949 [192]. + +# 5 Reference model for interconnection between IM CN subsystems + +## 5.1 General + +Figure 5.1.1 illustrates the architecture diagram given in 3GPP TS 23.228 [4] showing the Inter-IMS Network to Network Interface (II-NNI) between two IM CN subsystem networks. + +![Figure 5.1.1: Inter-IMS Network to Network Interface between two IM CN subsystem networks. The diagram shows two separate IM CN subsystem networks connected via an Inter-IMS Network to Network Interface (II-NNI). On the left, a dashed box contains an ATC (Access Terminal Controller) and an MSC Server (which can be a stand-alone entity or combined with another functional entity). The ATC is connected to a central IBCF (Interconnection Border Control Function) via an Mx reference point. The IBCF is connected to the II-NNI via an Ici reference point. The II-NNI is represented by a red arc. On the right, another IBCF is connected to the II-NNI via an Ici reference point. This IBCF is connected to a central TrGW (Traffic Gateway) via an Ix reference point. The TrGW is connected to various external entities via Mx reference points. A NOTE below the diagram states: 'The TRF can reside as a stand-alone entity or can be combined with another functional entity.'](ab846b81e78dbc8da2a6f9511e2f248a_img.jpg) + +Figure 5.1.1: Inter-IMS Network to Network Interface between two IM CN subsystem networks. The diagram shows two separate IM CN subsystem networks connected via an Inter-IMS Network to Network Interface (II-NNI). On the left, a dashed box contains an ATC (Access Terminal Controller) and an MSC Server (which can be a stand-alone entity or combined with another functional entity). The ATC is connected to a central IBCF (Interconnection Border Control Function) via an Mx reference point. The IBCF is connected to the II-NNI via an Ici reference point. The II-NNI is represented by a red arc. On the right, another IBCF is connected to the II-NNI via an Ici reference point. This IBCF is connected to a central TrGW (Traffic Gateway) via an Ix reference point. The TrGW is connected to various external entities via Mx reference points. A NOTE below the diagram states: 'The TRF can reside as a stand-alone entity or can be combined with another functional entity.' + +NOTE: The TRF can reside as a stand-alone entity or can be combined with another functional entity. + +**Figure 5.1.1: Inter-IMS Network to Network Interface between two IM CN subsystem networks** + +The protocols over the two reference points Ici and Izi make up the Inter-IMS Network to Network Interface. + +The Ici reference point allows IBCFs to communicate with each other in order to provide the communication and forwarding of SIP signalling messaging between IM CN subsystem networks. The Izi reference point allows TrGWs to forward media streams between IM CN subsystem networks. + +IMS roaming performed by using II-NNI is considered, when the IBCFs are inserted at the network borders. The applicability of roaming scenario by using II-NNI is based on agreement between the operators. + +Whenever the Inter-IMS Network to Network Interface is used to interconnect two IM CN subsystem networks belonging to different security domains, security procedures apply as described in 3GPP TS 33.210 [10]. + +When an IMS transit network is providing application services and interconnecting two IM CN subsystem networks, as described in 3GPP TS 23.228 [4], interfaces on both sides of the IMS transit network are within the scope of this document. + +When two IM CN subsystem networks are interconnected for IMS emergency session establishment as described in 3GPP TS 23.167 [215], the interface between these IM CN subsystem networks is within the scope of this document. + +NOTE: Implementations of functional entities at the IMS network edge might include functions that are not described in this Release of the specification, for example fault management that sends SIP OPTIONS requests between the two IBCFs over the Ici. IBCF originated SIP OPTIONS standalone transactions and any other features not described in the main body of this specification are out of scope. + +## 5.2 Functionalities performed by entities at the edge of the network + +### 5.2.1 Interconnection Border Control Function (IBCF) + +An IBCF provides application specific functions at the SIP/SDP protocol layer in order to perform interconnection between IM CN subsystem networks by using Iei reference point. According to 3GPP TS 23.228 [4], IBCF can act both as an entry point and as an exit point for the IM CN subsystem network. + +The functionalities of IBCF are indicated in the 3GPP TS 23.228 [4] and specified in 3GPP TS 24.229 [5]. They include: + +- network topology hiding; +- application level gateway (for instance enabling communication between IPv6 and IPv4 SIP applications, or between a SIP application in a private IP address space and a SIP application outside this address space); +- controlling transport plane functions; +- controlling media plane adaptations; +- screening of SIP signalling information; +- selecting the appropriate signalling interconnect; +- generation of charging data records; +- privacy protection; +- additional routing functionality; and +- inclusion of a transit IOI in requests when acting as an entry point for a transit network and in responses when acting as an exit point for a transit network. + +Based on local configuration, the IBCF performs transit routing functions as specified in 3GPP TS 24.229 [5] clause I.2. + +The IBCF acts as a B2BUA when it performs IMS-ALG functionality. + +### 5.2.2 Transition Gateway (TrGW) + +According to 3GPP TS 23.002 [3], the TrGW is located at the network borders within the media path and is controlled by an IBCF. Forwarding of media streams between IM CN subsystem networks is applied over Izi reference point. + +The TrGW provides functions like network address/port translation and IPv4/IPv6 protocol translation. NAT-PT binds addresses in IPv6 network with addresses in IPv4 network and vice versa to provide transparent routing between the two IP domains without requiring any changes to end points. NA(P)T-PT provides additional translation of transport identifier (TCP and UDP port numbers). The approach is similar to that one described also in 3GPP TS 29.162 [8]. + +Further details are described in 3GPP TS 23.228 [4]. + +## 5.3 Identifying II-NNI traversal scenario + +### 5.3.1 General + +The procedures for identifying the II-NNI traversal scenario using the "iotl" SIP URI parameter defined in IETF RFC 7549 [188] is specified in 3GPP TS 24.229 [5]. + +This specification uses the following II-NNI traversal scenarios when describing requirements at II-NNI: + +- the non-roaming II-NNI traversal scenario; +- the roaming II-NNI traversal scenario; and + +- the loopback II-NNI traversal scenario. + +When a requirement at II-NNI is dependent on direction the roaming II-NNI traversal scenario is further divided into: + +- the home-to-visited II-NNI traversal scenario; and +- the visited-to-home II-NNI traversal scenario. + +See figure 4.2 and figure 4.3 for information on how the II-NNI traversal scenarios above are applied between networks. + +### 5.3.2 Mapping of the "iotl" SIP URI parameter to II-NNI traversal scenario + +Table 5.3.2.1 describes how the "iotl" SIP URI parameter shall be used to identify the II-NNI traversal scenario. The table 5.3.2.1 contains the following items: + +- the first column, named "II-NNI traversal scenario", shows the II-NNI traversal scenarios within the scope of this specification; and +- the second column, named "Value of the "iotl" parameter", shows the value of the "iotl" SIP URI parameter as specified in IETF RFC 7549 [188]. + +**Table 5.3.2.1: Mapping of the "iotl" SIP URI parameter to II-NNI traversal scenario** + +| II-NNI traversal scenario | Value of the "iotl" parameter | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------| +| Non-roaming II-NNI traversal scenario
(NOTE 1) | "homeA-homeB" or "visitedA-homeB" | +| Loopback traversal scenario | "homeA-visitedA" | +| Roaming II-NNI traversal scenario | "visitedA-homeA" or "homeB-visitedB"
(NOTE 2) | +| Home-to-visited traversal scenario | "homeB-visitedB" | +| Visited-to-home traversal scenario | "visitedA-homeA" | +| NOTE 1: This is the default II-NNI traversal scenario, if the "iotl" SIP URI parameter is not present in the Request-URI or in any of the Route header fields in the SIP request and if an implementation dependent method of identifying the II-NNI traversal scenario is not used. | | +| NOTE 2: When the requirement at II-NNI is independent on direction any of the "visitedA-homeA" or "homeB-visitedB" can be used to identify the roaming II-NNI traversal scenario. | | + +# 6 Control plane interconnection + +## 6.1 Definition of Inter-IMS Network to Network Interconnection + +### 6.1.1 SIP methods and header fields + +#### 6.1.1.1 General + +The functional entity closest to the border of an II-NNI (see reference model in clause 5) shall provide the capabilities specified for that network element in clause A.2 of 3GPP TS 24.229 [5] with modifications as described in the following clauses. + +#### 6.1.1.2 SIP methods + +3GPP TS 24.229 [5] defines the methods allowing an IBCF to interconnect to an IBCF placed in another IM CN subsystem. + +The following SIP methods are supported on the II-NNI as defined in table 6.1. + +The following table is based on table A.5 and table A.163 of 3GPP TS 24.229 [5] and endorsed for this document: + +**Table 6.1: Supported SIP methods** + +| Item | Method | Ref. | II-NNI | | +|-------|---------------------------------------------------------------------------------|--------------------|---------|-----------| +| | | | Sending | Receiving | +| 1 | ACK request | IETF RFC 3261 [13] | m | m | +| 2 | BYE request | IETF RFC 3261 [13] | m | m | +| 3 | BYE response | IETF RFC 3261 [13] | m | m | +| 4 | CANCEL request | IETF RFC 3261 [13] | m | m | +| 5 | CANCEL response | IETF RFC 3261 [13] | m | m | +| 5A | INFO request | IETF RFC 6086 [39] | o | o | +| 5B | INFO response | IETF RFC 6086 [39] | o | o | +| 8 | INVITE request | IETF RFC 3261 [13] | m | m | +| 9 | INVITE response | IETF RFC 3261 [13] | m | m | +| 9A | MESSAGE request | IETF RFC 3428 [19] | o | o | +| 9B | MESSAGE response | IETF RFC 3428 [19] | o | o | +| 10 | NOTIFY request | IETF RFC 6665 [20] | c1 | c1 | +| 11 | NOTIFY response | IETF RFC 6665 [20] | c1 | c1 | +| 12 | OPTIONS request | IETF RFC 3261 [13] | m | m | +| 13 | OPTIONS response | IETF RFC 3261 [13] | m | m | +| 14 | PRACK request | IETF RFC 3262 [18] | m | m | +| 15 | PRACK response | IETF RFC 3262 [18] | m | m | +| 15A | PUBLISH request | IETF RFC 3903 [21] | c1 | c1 | +| 15B | PUBLISH response | IETF RFC 3903 [21] | c1 | c1 | +| 16 | REFER request | IETF RFC 3515 [22] | o | o | +| 17 | REFER response | IETF RFC 3515 [22] | o | o | +| 18 | REGISTER request | IETF RFC 3261 [13] | c2 | c2 | +| 19 | REGISTER response | IETF RFC 3261 [13] | c2 | c2 | +| 20 | SUBSCRIBE request | IETF RFC 6665 [20] | c1 | c1 | +| 21 | SUBSCRIBE response | IETF RFC 6665 [20] | c1 | c1 | +| 22 | UPDATE request | IETF RFC 3311 [23] | m | m | +| 23 | UPDATE response | IETF RFC 3311 [23] | m | m | +| c1: | In case of roaming II-NNI, the support of the method is m, else o. | | | | +| c2: | In case of roaming II-NNI, the support of the method is m, else n/a. | | | | +| NOTE: | In the above table, m, o and c and n/a have the meanings indicated in table 6.3 | | | | + +#### 6.1.1.3 SIP header fields + +##### 6.1.1.3.0 General + +The IBCF shall provide the capabilities to manage and modify SIP header fields according to clause 5.10 and annex A of 3GPP TS 24.229 [5] with modifications as described in the following clauses. + +##### 6.1.1.3.1 Trust and no trust relationship + +The IBCF acting as exit point applies the procedures described in clause 5.10.2 of 3GPP TS 24.229 [5] before forwarding the SIP signalling to the IBCF acting as entry point. The IBCF acting as entry point applies the procedures described in clause 5.10.3 of 3GPP TS 24.229 [5]. + +Additionally, in case there is no trust relationship between the two IM CN subsystems connected by II-NNI, the IBCF applies the procedures described in clause 4.4 of 3GPP TS 24.229 [5], before forwarding the SIP signalling. + +These procedures may be utilized on a per header field basis to realize overall trust as well as per service level screening of header fields. Trust relationships and trust domains may be defined by inter-operator agreements for individual services and/or individual SIP header fields. + +The management of the SIP header fields (if present) over II-NNI in case of a presence or not of a trust relationship between the two interconnected IM CN subsystems is wrapped up in the following table. + +**Table 6.2: Management of SIP header fields and parameters over II-NNI in presence or not of a trust relationship** + +| Item | Header field or parameter | Reference | Trust relationship | Not trust relationship | +|------|----------------------------------------|-----------------------------------|---------------------------------------------------------|--------------------------------------------------------------------------------------| +| 1 | P-Asserted-Identity | IETF RFC 3325 [44] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 2 | P-Access-Network-Info | IETF RFC 7315 [24] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 3 | Resource-Priority | IETF RFC 4412 [78] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 4 | History-Info | IETF RFC 7044 [25] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in clause 7 of IETF RFC 7044 [25] and in 3GPP TS 24.229 [5], clause 4.4 | +| 5 | P-Asserted-Service | IETF RFC 6050 [26] | As specified in 3GPP TS 24.229 [5], clause 4.4 (NOTE 3) | As specified in 3GPP TS 24.229 [5], clause 4.4 (NOTE 3) | +| 6 | P-Charging-Vector | IETF RFC 7315 [24] | As specified in 3GPP TS 24.229 [5], clause 5.10 | As specified in 3GPP TS 24.229 [5], clause 5.10 | +| 7 | P-Charging-Function-Addresses (NOTE 4) | IETF RFC 7315 [24] | As specified in 3GPP TS 24.229 [5], clause 5.10 | As specified in 3GPP TS 24.229 [5], clause 5.10 | +| 8 | P-Profile-Key (NOTE 2) | IETF RFC 5002 [64] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 9 | P-Private-Network-Indication | IETF RFC 7316 [84] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 10 | P-Served-User (NOTE 1, NOTE 2) | IETF RFC 5502 [85] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 11 | Reason (in a response) | IETF RFC 6432 [49] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 12 | P-Early-Media | IETF RFC 5009 [74] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 13 | Feature-Caps | IETF RFC 6809 [143] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 14 | Priority (NOTE 6) | IETF RFC 7090 [184] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 15 | "iotl" SIP URI parameter (NOTE 7) | IETF RFC 7549 [188] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 16 | "cpc" tel URI parameter (NOTE 5) | 3GPP TS 24.229 [5] clause 7.2A.12 | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 17 | "oli" tel URI parameter (NOTE 5) | 3GPP TS 24.229 [5] clause 7.2A.12 | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 18 | Restoration-Info (NOTE 2) | 3GPP TS 24.229 [5] clause 7.2.11 | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 19 | Relayed-Charge (NOTE 4) | 3GPP TS 24.229 [5] clause 7.2.12 | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 20 | Service-Interact-Info | 3GPP TS 24.229 [5] clause 7.2.14 | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 21 | Cellular-Network-Info | 3GPP TS 24.229 [5] clause 7.2.15 | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|-------------------------------------|------------------------------------------------------|------------------------------------------------------| +| 22 | Response-Source | 3GPP TS 24.229 [5]
clause 7.2.17 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | +| 23 | Attestation-Info
(NOTE 8) | 3GPP TS 24.229 [5]
clause 7.2.18 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | +| 24 | Origination-Id
(NOTE 8) | 3GPP TS 24.229 [5]
clause 7.2.19 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | +| 25 | Additional-Identity | 3GPP TS 24.229 [5]
clause 7.2.20 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | +| 26 | Priority-Verstat
(NOTE 8) | 3GPP TS 24.229 [5]
clause 7.2.21 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | +| NOTE 1: For a roaming II-NNI, a trust relationship with respect to this header field is required. | | | | | +| NOTE 2: This header field is only applicable on a roaming II-NNI. | | | | | +| NOTE 3: In addition, value-dependent operator policies may be applied. | | | | | +| NOTE 4: This header field is not applicable at II-NNI. | | | | | +| NOTE 5: The tel URI parameters "cpc" and "oli" can be included in the URI in the P-Asserted-Identity header field. | | | | | +| NOTE 6: Only the "psap-callback" value is part of the trust domain. | | | | | +| NOTE 7: The "iotl" SIP URI parameter can be transported in the Request-URI, Route header field, Path header field, Service-Route header field, "+g.3gpp.trf" header field parameter, "+g.3gpp.atcf-mgmt-uri" header field parameter and in the "ATU-STI" parameter in the "application/vnd.3gpp.srvcc-info+xml" MIME body. | | | | | +| NOTE 8: This header field is only applicable on non-roaming II-NNI. | | | | | + +##### 6.1.1.3.2 Derivation of applicable SIP header fields from 3GPP TS 24.229 [5] + +For any method in table 6.1, the SIP header fields applicable on the II-NNI are detailed in the corresponding method tables for the UA role and proxy role sending behaviour in annex A of 3GPP TS 24.229 [5]. Unless other information is specified in the normative part of the present specification, the applicability of header fields at the II-NNI can be derived for each method from the corresponding tables in annex A of 3GPP TS 24.229 [5] as follows: + +- All header fields not present in the corresponding tables in annex A of 3GPP TS 24.229 [5] or marked as "n/a" in both the "RFC status" and "profile status" columns for the UA role and proxy role sending behaviour of that tables are not applicable at the II-NNI. + +NOTE 1: Operators could choose to apply header fields for other SIP extensions on an II-NNI based on bilateral agreements, but this is outside the scope of the present specification. + +- All header fields which are marked as "o" in at least one of the "RFC status" or the "profile status" profile columns for the sending behaviour in the corresponding UA role and proxy role tables in annex A of 3GPP TS 24.229 [5] and as "n/a" or "o" in the other such columns are applicable at II-NNI based on bilateral agreement between operators. +- All header fields which are marked as "m" in at least one of the "RFC status" or the "profile status" columns for the sending behaviour in the corresponding UA role or proxy role table in annex A of 3GPP TS 24.229 [5] and as "n/a", "o", or "m" in the other such columns are applicable at the II-NNI. +- If conditions are specified, they are also applicable at the II-NNI and the above rules are applicable to the "n/a", "o" and "m" values within the conditions. + +NOTE 2: In the above rules, the RFC profile columns are taken into account in order to enable interworking with non-3GPP networks. + +An informative summary of SIP header fields to be used over the II-NNI is proposed in annex A. + +##### 6.1.1.3.3 Applicability of SIP header fields on a roaming II-NNI + +The following SIP header fields are applicable on a roaming II-NNI but not on a non-roaming II-NNI: + +- Authentication-Info +- Authorization + +- P-Associated-URI +- P-Called-Party-ID +- P-Preferred-Service +- P-Profile-Key +- P-Served-User +- P-Visited-Network-ID +- Path +- Priority-Share +- Proxy-Authenticate +- Proxy-Authorization +- Resource-Share +- Restoration-Info +- Service-Route +- WWW-Authenticate + +##### 6.1.1.3.4 Applicability of SIP header fields on a non-roaming II-NNI + +The following SIP header fields are only applicable on a non-roaming II-NNI: + +- P-Refused-URI-List; +- Identity; +- Attestation-Info; +- Origination-Id; and +- Priority-Verstat. + +#### 6.1.1.4 Notations of the codes + +In the table 6.1 the status codes "m", "o", "c" and "n/a" have the following meanings: + +**Table 6.3: Key to notation codes for SIP messages** + +| Notation code | Notation name | Sending side | Receiving side | +|----------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| m | mandatory | The message shall be supported at II-NNI.
Supporting sending a SIP message at the II-NNI means that this message shall be sent over the II-NNI if received from the serving network. It does not imply that network elements inside the serving network or user equipment connected to this network shall support this message. | Supporting receiving a SIP message at the II-NNI means that this message shall be forwarded to the serving network unless the operator's policy is applied as defined in clause 5.10.1 of 3GPP TS 24.229 [5]. It does not imply that network elements inside the serving network or user equipment connected to this network are supporting this message. | +| o | optional | The message may or may not be supported at II-NNI. The support of the message is provided based on bilateral agreement between the operators. | Same as for sending side. | +| n/a | not applicable | It is impossible to use/support the message. | It is impossible to use/support the message. This message will be discarded by the IBCF. | +| c
| conditional | The requirement on the message ("m", "o" or "n/a") depends on the support of other optional or conditional items.
is the identifier of the conditional expression. | Same as for sending side. | + +#### 6.1.1.5 Modes of signalling + +Overlap signalling may be used if agreement exists between operators to use overlap and which method to be used, otherwise enbloc shall be used at the II-NNI. + +### 6.1.2 SDP protocol + +#### 6.1.2.1 General + +The functional entity closest to the border of an II-NNI (see reference model in clause 5) shall provide the capabilities specified for that network element in clause A.3 of 3GPP TS 24.229 [5]. + +The "application/sdp" MIME bodies shall be encoded as described in IETF RFC 3261 [13] and in IETF RFC 4566 [147]. + +The offer/answer model with the SDP as defined in IETF RFC 3264 [146] shall be applied. + +The procedures and the SDP rules as defined in IETF RFC 4145 [162] may be applied if media streams with TCP is used. + +### 6.1.3 Major capabilities + +This clause contains the major capabilities to be supported over the II-NNI. + +The table 6.1.3.1 specifies which capabilities are applicable for II-NNI. The profile status codes within table 6.1.3.1 are defined in table 6.1.3.2. + +For the "Basic SIP" capabilities part of table 6.1.3.1, the last column "Profile status over II-NNI" specifies the general status of applicability of the IETF RFC 3261 [13] main mechanisms described in the 2nd column "Capability over the Ici". + +For the "Extensions to basic SIP" capabilities part, the last column "Profile status over II-NNI" specifies the general status of applicability of the RFC referenced in the 2nd column "Capability over the Ici". + +If necessary, the applicability of RFCs at the II-NNI level is further detailed in the present Technical Specification. + +The columns "Reference item in 3GPP TS 24.229 [5] for the profile status" provide informative references for comparison purposes into the UA and Proxy role major capabilities tables in 3GPP TS 24.229 [5], where the capabilities are defined via additional references. + +**Table 6.1.3.1: Major capabilities over II-NNI** + +| Item | Capability over the Ict | Reference item in 3GPP TS 24.229 [5] for the profile status | | Profile status over II-NNI | +|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|----------------------------------------|----------------------------| +| | | UA Role (NOTE 1) | Proxy role (NOTE 2) | | +| | Basic SIP (IETF RFC 3261 [13]) | | | | +| 1 | registrations | 1, 2, 2A | - | c2 | +| 2 | initiating a session | 2B, 3, 4 | - | m | +| 3 | terminating a session | 5 | 3 | m | +| 4 | General proxy behaviour | - | 4, 5, 14, 15 | n/a | +| 5 | Managing several responses due to forking | 9,10 | 6 | m | +| 6 | support of indication of TLS connections in the Record-Route header | - | 7, 8 | n/a | +| 7 | Support of authentication | 7, 8, 8A | 8A | c2 | +| 8 | Timestamped requests (Timestamp header field) | 6 | - | m | +| 9 | Presence of date in requests and responses (Date header field) | 11 | 9 | m | +| 10 | Presence of alerting information data (Alert-info header field) | 12 | 10 | o | +| 11 | Support and handling of the Require header field for REGISTER and other requests or responses for methods other than REGISTER | - | 11, 12, 13 | m | +| 12 | Support and reading of the Supported and Unsupported header fields | - | 16, 17, 18 | m | +| 13 | Support of the Error-Info header field in 3xx - 6xx responses | - | 19 | o | +| 14 | Support and handling of the Organization header field | - | 19A, 19B | m | +| 15 | Support and handling of the Call-Info header field | - | 19C, 19D | m | +| 16 | Support of the Contact header field in 3xx response | - | 19E | m | +| 16A | Proxy reading the contents of a body or including a body in a request or response | - | 19F | n/a | +| | Extensions to basic SIP | | | | +| 16B | 3GPP TS 24.237 [131]: proxy modifying the content of a body | - | 19G | n/a | +| 17 | IETF RFC 6086 [39]: SIP INFO method and package framework | 13 | 20 | o | +| 17A | IETF RFC 6086 [39]: legacy INFO usage | 13A | 20A | o | +| 18 | IETF RFC 3262 [18]: reliability of provisional responses in SIP (PRACK method) | 14 | 21 | m | +| 19 | IETF RFC 3515 [22]: the SIP REFER method | 15 | 22 | o | +| 19A | IETF RFC 7647 [194]: Clarifications for the Use of REFER with RFC6665 | 15A | 22A | n/a | +| 19B | IETF RFC 7614 [195]: Explicit Subscriptions for the REFER Method | 15B | 22B | o | +| 20 | IETF RFC 3312 [40] and IETF RFC 4032 [41]: integration of resource management and SIP (Preconditions framework) | 2C, 16 | 23 | o | +| 21 | IETF RFC 3311 [23]: the SIP UPDATE method | 17 | 24 | m | +| 22 | IETF RFC 3313 [42]: SIP extensions for media authorization (P-Media-Authorization header field) | 19 | 26 | n/a | +| 23 | IETF RFC 6665 [20]: SIP specific event notification (SUBSCRIBE/NOTIFY methods) | 20, 22, 23 | 27 | c1 | +| 23A | IETF RFC 7621 [196]: A Clarification on the Use of Globally Routable User Agent URIs (GRUUs) in the Session Initiation Protocol SIP Event Notification Framework | 22A | 28 | n/a | +| 24 | IETF RFC 3327 [43]: session initiation protocol extension header field for registering non-adjacent contacts (Path header field) | 24 | 29 | c2 | +| 25 | IETF RFC 3325 [44]: private extensions to the Session Initiation Protocol (SIP) for network asserted identity within trusted networks | 25 | 30 | c4 | +| 26 | IETF RFC 3325 [44]: the P-Preferred-Identity header field extension | - | - | n/a | +| 27 | IETF RFC 3325 [44]: the P-Asserted-Identity header field extension | - | - | c4 | +| 28 | IETF RFC 3323 [34], IETF RFC 3325 [44] and IETF RFC 7044 [25]: a privacy mechanism for the Session Initiation Protocol (SIP) (Privacy header field) | 26, 26A, 26B, 26C, 26D, 26E, 26F, 26G, | 31, 31A, 31B, 31C, 31D, 31E, 31F, 31G, | m | + +| | | | | | +|--|--|-----|-----|--| +| | | 26H | 31H | | +|--|--|-----|-----|--| + +| | | | | | +|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|----------------------------------|-----| +| 29 | IETF RFC 3428 [19]: a messaging mechanism for the Session Initiation Protocol (SIP) (MESSAGE method) | 27 | 33 | o | +| 30 | IETF RFC 3608 [45]: session initiation protocol extension header field for service route discovery during registration (Service-Route header field) | 28 | 32 | c2 | +| 31 | IETF RFC 3486 [46]: compressing the session initiation protocol | 29 | 34 | n/a | +| 32 | IETF RFC 7315 [24]: private header extensions to the session initiation protocol for the 3 rd -Generation Partnership Project (3GPP) | 30 | 35 | o | +| 32A | IETF RFC 3325 [44]: act as first entity within the trust domain for asserted identity | 30A | 30A | n/a | +| 32B | IETF RFC 3325 [44]: act as entity within trust network that can route outside the trust network | 30B | 30B | n/a | +| 32C | IETF RFC 3325 [44]: act as entity passing on identity transparently independent of trust domain | 30C | 30C | n/a | +| 33 | IETF RFC 7315 [24] and IETF RFC 7976 [24A]: the P-Associated-URI header field extension | 31 | 36 | c2 | +| 34 | IETF RFC 7315 [24] and IETF RFC 7976 [24A]: the P-Called-Party-ID header field extension | 32 | 37 | c2 | +| 35 | IETF RFC 7315 [24] and IETF RFC 7976 [24A]: the P-Visited-Network-ID header field extension | 33 | 38, 39 | c2 | +| 36 | IETF RFC 7315 [24], IETF RFC 7976 [24A] and IETF RFC 7913 [24B]: the P-Access-Network-Info header field extension | 34 | 41, 42, 43 | c4 | +| 37 | IETF RFC 7315 [24] and IETF RFC 7976 [24A]: the P-Charging-Function-Addresses header field extension | 35 | 44, 44A | n/a | +| 38 | IETF RFC 7315 [24] and IETF RFC 7976 [24A]: the P-Charging-Vector header field extension | 36 | 45, 46 | c1 | +| 39 | IETF RFC 3329 [47]: security mechanism agreement for the session initiation protocol | 37 | 47 | n/a | +| 39A | 3GPP TS 24.229 [5] clause 7.2A.7: Capability Exchange for Media Plane Security | 37A | 47A | n/a | +| 40 | IETF RFC 3326 [48]: the Reason header field for the session initiation protocol | 38 | 48 | o | +| 41 | IETF RFC 6432 [49]: carrying Q.850 codes in reason header fields in SIP (Session Initiation Protocol) responses | 38A | 48A | c4 | +| 41A | IETF RFC 8606 [214]: the Location Parameter for the SIP Reason Header Field | 38B | 48B | o | +| 41B | IETF RFC 9410 [220]: Handling of Identity Header Errors for Secure Telephone Identity Revisited (STIR) (carrying STIR codes in Reason header fields in SIP responses) | 38C | 48C | c5 | +| 41C | IETF RFC 9366 [221]: Multiple SIP Reason Header Field Values | 38D | 48D | c5 | +| 42 | IETF RFC 3581 [50]: an extension to the session initiation protocol for symmetric response routing | 39 | 49 | o | +| 43 | IETF RFC 3841 [51]: caller preferences for the session initiation protocol (Accept-Contact, Reject-Contact and Request-Disposition header fields) | 40, 40A, 40B, 40C, 40D, 40E, 40F | 50, 50A, 50B, 50C, 50D, 50E, 50F | m | +| 44 | IETF RFC 3903 [21]: an event state publication extension to the session initiation protocol (PUBLISH method) | 41 | 51 | c1 | +| 45 | IETF RFC 4028 [52]: SIP session timer (Session-Expires and Min-SE headers) | 42 | 52 | m | +| 46 | IETF RFC 3892 [53]: the SIP Referred-By mechanism | 43 | 53 | m | +| 47 | IETF RFC 3891 [54]: the Session Initiation Protocol (SIP) "Replaces" header | 44 | 54 | o | +| 48 | IETF RFC 3911 [55]: the Session Initiation Protocol (SIP) "Join" header | 45 | 55 | o | +| 49 | IETF RFC 3840 [56]: the callee capabilities | 46 | 56 | o | +| 50 | IETF RFC 7044 [25]: an extension to the session initiation protocol for request history information (History-Info header field) | 47 | 57 | o | +| 50A | IETF RFC 7044 [25]: the "mp" header field parameter | 47A | 57A | o | +| 50B | IETF RFC 7044 [25]: the "rc" header field parameter | 47B | 57B | o | +| 50C | IETF RFC 7044 [25]: the "np" header field parameter | 47C | 57C | o | + +| | | | | | +|-----|----------------------------------------------------------------------------------------------------------------------------------------------------|--------------|--------------|-------------------| +| 51 | IETF RFC 5079 [57]: Rejecting anonymous requests in the session initiation protocol | 48 | 58 | o | +| 52 | IETF RFC 4458 [58]: session initiation protocol URIs for applications such as voicemail and interactive voice response (NOTE 3) | 49 | 59 | o | +| 52A | IETF RFC 8119 [193]: Session Initiation Protocol (SIP) Cause URI parameter for Service Number translation | 49A | 59A | o | +| 53 | IETF RFC 4320 [59]: Session Initiation Protocol's (SIP) non-INVITE transactions | 50 | 61 | m | +| 54 | IETF RFC 4457 [60]: the P-User-Database private header field extension | 51 | 60 | n/a | +| 55 | IETF RFC 5031 [61]: A Uniform Resource Name (URN) for Emergency and Other Well-Known Services | 52 | 62 | c7 | +| 56 | IETF RFC 5627 [62]: obtaining and using GRUUs in the Session Initiation Protocol (SIP) | 53 | 63 | c1 | +| 57 | Void | | | | +| 58 | IETF RFC 4168 [27]: the Stream Control Transmission Protocol (SCTP) as a Transport for the Session Initiation Protocol (SIP) | 55 | 65 | o | +| 59 | IETF RFC 5002 [64]: the SIP P-Profile-Key private header field extension | 56 | 66, 66A, 66B | c3 | +| 60 | IETF RFC 5626 [65]: managing client initiated connections in SIP | 57 | 67 | c1 | +| 61 | IETF RFC 5768 [66]: indicating support for interactive connectivity establishment in SIP | 58 | 68 | n/a | +| 62 | IETF RFC 5365 [67]: multiple-recipient MESSAGE requests in the session initiation protocol | 59 | 69 | o if 29, else n/a | +| 63 | IETF RFC 6442 [68]: Location conveyance for the Session Initiation Protocol | 60 | 70, 70A, 70B | m | +| 64 | IETF RFC 5368 [69]: referring to multiple resources in the session initiation protocol | 61 | 71 | o if 19, else n/a | +| 65 | IETF RFC 5366 [70]: conference establishment using request-contained lists in the session initiation protocol | 62 | 72 | o | +| 66 | IETF RFC 5367 [71]: subscriptions to request-contained resource lists in the session initiation protocol | 63 | 73 | o if 23, else n/a | +| 67 | IETF RFC 4967 [72]: dialstring parameter for the session initiation protocol uniform resource identifier | 64 | 74 | c2 | +| 68 | IETF RFC 4964 [73]: the P-Answer-State header extension to the session initiation protocol for the open mobile alliance push to talk over cellular | 65 | 75 | o | +| 69 | IETF RFC 5009 [74]: the SIP P-Early-Media private header field extension for authorization of early media | 66 | 76 | c4 | +| 70 | IETF RFC 4694 [75]: number portability parameters for the 'tel' URI | 67, 67A, 67B | 77, 77A, 77B | o | +| 71 | Void | | | | +| 72 | IETF RFC 4411 [77]: extending the session initiation protocol Reason header for preemption events | 69 | 79 | o | +| 73 | IETF RFC 4412 [78]: communications resource priority for the session initiation protocol (Resource-Priority header field) | 70, 70A, 70B | 80, 80A, 80B | o | +| 74 | IETF RFC 5393 [79]: addressing an amplification vulnerability in session initiation protocol forking proxies | 71 | 81 | m | +| 75 | IETF RFC 5049 [80]: the remote application identification of applying signalling compression to SIP | 72 | 82 | n/a | +| 76 | IETF RFC 5688 [81]: a session initiation protocol media feature tag for MIME application sub-types | 73 | 83 | c1 | +| 77 | IETF RFC 6050 [26]: Identification of communication services in the session initiation protocol | 74 | 84, 84A | o | +| 78 | IETF RFC 5360 [82]: a framework for consent-based communications in SIP | 75, 75A, 75B | 85 | o | +| 79 | IETF RFC 7433 [83]: a mechanism for transporting user-to-user call control information in SIP | 76 | 86 | c1 | +| 79A | IETF RFC 7434 [83A]: interworking ISDN call control user information with SIP | 76A | - | c1 | +| 80 | IETF RFC 7316 [84]: The SIP P-Private-Network-Indication private header (P-Header) | 77 | 87 | c1 | +| 81 | IETF RFC 5502 [85]: the SIP P-Served-User private header | 78 | 88 | c2 | + +| | | | | | +|------|------------------------------------------------------------------------------------------------------------------------------------------|------|---------|-------------------| +| 82 | IETF 8498 [203]: the SIP P-Served-User header extension for Originating CDIV session case | 79 | 89 | n/a | +| 83 | IETF RFC 8497 [87]: marking SIP messages to be logged | 80 | 90 | o | +| 84 | IETF RFC 6228 [88]: the 199 (Early Dialog Terminated) response code | 81 | 91 | m | +| 85 | IETF RFC 5621 [89]: message body handling in SIP | 82 | 92 | m | +| 86 | IETF RFC 6223 [90]: indication of support for keep-alive | 83 | 93 | o | +| 87 | IETF RFC 5552 [91]: SIP Interface to VoiceXML Media Services | 84 | 94 | n/a | +| 88 | IETF RFC 3862 [92]: common presence and instant messaging (CPIM): message format | 85 | 95 | o | +| 89 | IETF RFC 5438 [93]: instant message disposition notification | 86 | 96 | o | +| 90 | IETF RFC 5373 [94]: requesting answering modes for SIP (Answer-Mode and Priv-Answer-Mode header fields) | 87 | 97, 97A | o | +| 91 | Void | | | | +| 92 | IETF RFC 3959 [96]: the early session disposition type for SIP | 89 | 99 | o | +| 93 | Void | | | | +| 94 | IETF RFC 7989 [124]: End-to-End Session Identification in IP-Based Multimedia Communication Networks | 91 | 101 | o | +| 95 | IETF RFC 6026 [125]: correct transaction handling for 200 responses to Session Initiation Protocol INVITE requests | 92 | 102 | m | +| 96 | IETF RFC 5658 [126]: addressing Record-Route issues in the Session Initiation Protocol (SIP) | 93 | 103 | o | +| 97 | IETF RFC 5954 [127]: essential correction for IPv6 ABNF and URI comparison in IETF RFC 3261 [13] | 94 | 104 | m | +| 98 | IETF RFC 4488 [135]: suppression of session initiation protocol REFER method implicit subscription | 95 | 105 | m if 19, else n/a | +| 99 | IETF RFC 7462 [136]: Alert-Info URNs for the Session Initiation Protocol | 96 | 106 | o | +| 100 | 3GPP TS 24.229 [5] clause 3.1: multiple registrations | 97 | 107 | c2 | +| 101 | IETF RFC 5318 [141]: the SIP P-Refused-URI-List private-header | 98 | 108 | c5 | +| 102 | IETF RFC 4538 [140]: request authorization through dialog Identification in the session initiation protocol (Target-Dialog header field) | 99 | 109 | o | +| 103 | IETF RFC 6809 [143]: Mechanism to indicate support of features and capabilities in the Session Initiation Protocol (SIP) | 100 | 110 | o | +| 104 | IETF RFC 6140 [160]: registration of bulk number contacts | 101 | 111 | c3 | +| 105 | IETF RFC 6230 [161]: media control channel framework | 102 | 112 | o | +| 105A | 3GPP TS 24.229 [5] clause 4.14: S-CSCF restoration procedures | 103 | 113 | c3 | +| 106 | IETF RFC 6357 [164]: SIP overload control | 104 | 114 | o | +| 107 | IETF RFC 7339 [165]: feedback control | 104A | 114A | o | +| 108 | IETF RFC 7200 [167]: distribution of load filters | 104B | 114B | o | +| 109 | 3GPP TS 24.229 [5] clauses 5.1.2A.1.1, 5.1.3.1, 5.1.6.8, and 5.2.10: Handling of a 380 (Alternative service) response | 105 | 115 | n/a | +| 110 | IETF RFC 7090 [184]: Public Safety Answering Point (PSAP) Callback | 107 | 117 | o | +| 111 | IETF RFC 8055 [185]: Via header field parameter to indicate received realm | 106 | 116 | n/a | +| 112 | IETF RFC 7549 [188]: SIP URI parameter to indicate traffic leg | 108 | 118 | o
(NOTE 4) | +| 113 | 3GPP TS 24.229 [5] clause 4.14: PCF or PCRF based P-CSCF restoration | 109 | 119 | c3 | +| 114 | 3GPP TS 24.229 [5] clause 4.14: UDM/HSS or HSS based P-CSCF restoration | 110 | 120 | c3 | +| 115 | 3GPP TS 24.229 [5] clause 7.2.12: the Relayed-Charge header extension | 111 | 121 | n/a | +| 116 | 3GPP TS 24.229 [5]: resource sharing | 112 | 122 | c3 | +| 117 | 3GPP TS 24.229 [5] clause 7.2.15: the Cellular-Network-Info header extension | 113 | 123 | c4 | +| 118 | 3GPP TS 24.229 [5] clause 7.2.16: the Priority-Share header field | 114 | 124 | c3 | +| 119 | IETF RFC 8224 [206]: Authenticated Identity Management in | 116 | 126 | c5 | + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|-----|-----|----| +| | the Session Initiation Protocol (SIP) | | | | +| 120 | IETF RFC 8197 [207]: A SIP Response Code for Unwanted Calls | 117 | 127 | o | +| 121 | 3GPP TS 24.229 [5] clause 7.2.17: the Response-Source header extension | 115 | 125 | c6 | +| 121A | 3GPP TS 24.229 [5]: the 3GPP PS data off extension | 118 | - | c3 | +| 121B | 3GPP TS 24.229 [5]: Next-Generation Pan-European eCall emergency service | 120 | - | c8 | +| 122 | IETF RFC 8262 [216]: Content-ID Header Field in the Session Initiation Protocol (SIP) | 119 | - | o | +| 123 | 3GPP TS 24.229 [5] clause 7.2.18: the Attestation-Info header field | 121 | 128 | c5 | +| 124 | 3GPP TS 24.229 [5] clause 7.2.19: the Origination-Id | 122 | 129 | c5 | +| 125 | 3GPP TS 24.229 [5] clause 4.18: Dynamic services interactions | 123 | 130 | c6 | +| 126 | 3GPP TS 24.229 [5] clause 7.2.20: the Additional-Identity | 124 | 131 | c6 | +| 127 | 3GPP TS 24.229 [5] clause 4.19: RLOS | 125 | 132 | c3 | +| 128 | 3GPP TS 24.229 [5] clause 7.2.21: the Priority-Verstat header field | 126 | 133 | c6 | +| c1: m in case of roaming II-NNI, else o
c2: m in case of roaming II-NNI, else n/a
c3: o in case of roaming II-NNI, else n/a
c4: m in case of trust relationship between the interconnected networks, else n/a
c5: o in case of non-roaming II-NNI and loopback traversal scenario, else n/a
c6: o in case of trust relationship between the interconnected networks, else n/a
c7: m in case of IMS emergency session traversal scenario on non-roaming II-NNI, else n/a
c8: o in case of IMS emergency session traversal scenario on non-roaming II-NNI, else n/a | | | | | +| NOTE 1: The item numbering corresponds to the one provided in table A.4 in 3GPP TS 24.229 [5]. | | | | | +| NOTE 2: The item numbering corresponds to the one provided in table A.162 in 3GPP TS 24.229 [5]. | | | | | +| NOTE 3: A common URI namespace is required to apply this feature on the II-NNI. | | | | | +| NOTE 4: For the roaming II-NNI the support of this major capability is recommended. | | | | | + +**Table 6.1.3.2: Key to notation codes for major capabilities** + +| Notation code | Notation name | Explanation | +|----------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| m | mandatory | The capability shall be supported at II-NNI.
SIP message relating to this capability shall be sent over the II-NNI if received from the serving network, unless they also make use of other unsupported capabilities.
SIP headers or other information elements relating to this capability shall be passed over the II-NNI if received from the sending side.
This does not imply that network elements inside the serving network or served network or user equipment connected to these networks shall support this capability. | +| o | optional | The capability may or may not be supported at II-NNI. The support of the capability is provided based on bilateral agreement between the operators. | +| n/a | not applicable | It is impossible to use/support the capability at the II-NNI. | +| c
| conditional | The support of the capability ("m", "o" or "n/a") depends on the support of other optional or conditional items. is the identifier of the conditional expression. | + +### 6.1.4 SIP message bodies + +The MIME type "application/sdp" and multipart message bodies (multipart/mixed, multipart/related and multipart/alternative) shall be supported according to IETF RFC 5621 [89] over the II-NNI. Other MIME types may be supported over the II-NNI based on agreement between operators. + +The SDP message bodies contained in the INVITE request shall not be encrypted over the II-NNI. + +NOTE 1: Some MIME types in SIP requests and responses are listed in annex A of 3GPP TS 24.229 [5]. + +NOTE 2: The multipart message bodies are used for carrying two or more message body types as described in IETF RFC 5621 [89]. + +NOTE 3: The IBCF can provide the capabilities to examine the length of a SIP message body and take an appropriate action (e.g. reject the request, remove the body) as specified in clause 5.10.6.3 of 3GPP TS 24.229 [5]. + +NOTE 4: In the INVITE request, the SDP message body is present over the II-NNI, except when the INVITE request without SDP message body is required to provide services (e.g. 3rd party call control). + +#### **Table 6.1.4.1: List of MIME bodies** + +| Item | MIME body name | II-NNI requirements
in ref
(NOTE 1) | Defined in ref
(NOTE 2) | +|------|-------------------------------------------------|-----------------------------------------------------------------------------------------------------|------------------------------------------| +| 1 | application/3gpp-ims+xml | - | 3GPP TS 24.229 [5], clause 7.6 | +| 3 | message/cpim | - | IETF RFC 3862 [92] | +| 4 | message/imdn+xml | - | IETF RFC 5438 [93] | +| 5 | application/im-iscomposing+xml | clause 16.2 | IETF RFC 3994 [175] | +| 6 | multipart/mixed | clause 15.1,
clause 15.4,
clause 15.6.2,
clause 15.6.3,
clause 15.6.4,
clause 18.3.3 | IETF RFC 2046 [169] | +| 7 | multipart/related | clause 15.1,
clause 15.2,
clause 15.6.5 | IETF RFC 2387 [170] | +| 8 | multipart/alternative | - | IETF RFC 2046 [169] | +| 9 | application/pidf+xml | clause 15.1,
clause 28.2.3.2,
clause 28.2.9 | IETF RFC 3863 [174] | +| 10 | application/pidf-diff+xml | clause 15.1 | IETF RFC 5262 [179] | +| 11 | application/resource-lists+xml | clause 12.19,
clause 15.1,
clause 15.6.3,
clause 16.5,
clause 28.2.1,
clause 28.2.7 | IETF RFC 4826 [178] | +| 12 | application/rlmi+xml | clause 15.2,
clause 15.6.5 | IETF RFC 4662 [177] | +| 13 | application/sdp | - | IETF RFC 4566 [147] | +| 14 | application/simple-filter+xml | clause 15.1,
clause 15.6.4,
clause 28.2.3.2 | IETF RFC 4661 [176] | +| 15 | application/simple-message-summary+xml | clause 12.9 | IETF RFC 3842 [172] | +| 16 | message/sipfrag | clause 12.13,
clause 18.2,
clause 18.3.1 | IETF RFC 3420 [171] | +| 17 | application/vnd.3gpp.access-transfer-events+xml | clause 14.5.3 | 3GPP TS 24.237 [131], clause D.5.4 | +| 18 | application/vnd.3gpp.cw+xml | clause 12.7 | 3GPP TS 24.615 [37], clause C.1.1 | +| 19 | application/vnd.3gpp.iut+xml | clause 18.3.2,
clause 18.3.3 | 3GPP TS 24.337 [149], clause C.2.3 | +| 20 | application/vnd.3gpp.mid-call+xml | clause 14.4 | 3GPP TS 24.237 [131], clause D.1.3 | +| 21 | application/
vnd.3gpp.replication+xml | clause 18.4.1,
clause 18.4.2 | 3GPP TS 24.337 [149], clause C.1.3 | +| 22 | application/vnd.3gpp.sms | - | | +| 23 | application/vnd.3gpp.srvcc-ext+xml | clause 14.5.1 | 3GPP TS 24.237 [131], clause D.4.4 | +| 24 | application/vnd.3gpp.srvcc-info+xml | clause 14.2.3 | 3GPP TS 24.237 [131], clause D.3.4 | +| 25 | application/vnd.3gpp.state-and-event-info+xml | clause 14.2.2,
clause 14.4 | 3GPP TS 24.237 [131], clause D.2.4 | +| 26 | application/vnd.3gpp.ussd | clause 12.24 | 3GPP TS 24.390 [163], clause 5.1.3 | +| 27 | application/vnd.etsi.aoc+xml | clause 12.22 | 3GPP TS 24.647 [122], clause E.1.1 | +| 28 | application/vnd.etsi.cug+xml | clause 12.16 | 3GPP TS 24.654 [103], clause 4.4.1 | +| 29 | application/vnd.etsi.mcid+xml | clause 12.2 | 3GPP TS 24.616 [33], clause 4.4 | +| 30 | application/vnd.etsi.pstn+xml | - | 3GPP TS 29.163 [168], clause F.2 | +| 31 | application/
vnd.oma.suppnot+xml | clause 15.6.2,
clause 15.6.3 | OMA-SUP-XSD_prs_suppnotFilter-V1_0 [182] | +| 32 | application/watcherinfo+xml | clause 15.3 | IETF RFC 3858 [173] | +| 33 | application/xcap-diff+xml | clause 15.4,
clause 15.6.5 | IETF RFC 5874 [180] | +| 34 | application/session-info | - | 3GPP TS 29.163 [168], clause G.2 | +| 35 | application/load-control+xml | clause 21 | IETF RFC 7200 [167] | + +| | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------| +| 36 | application/vnd.etsi.sci+xml | clause 11.3 | 3GPP TS 29.658 [186] | +| 37 | text/plain | - | IETF RFC 2646 [197] | +| 38 | application/x-www-form-urlencoded | - | IETF RFC 1866 [198], clause 8.2.1 (NOTE 3) | +| 39 | application/vnd.3gpp.crs+xml | clause 12.15 | 3GPP TS 24.183 [98], clause D.1 | +| 40 | message/sip | - | IETF RFC 3261 [13] | +| 41 | application/vnd.3gpp.mcptt-info+xml | clause 28.2.1,
clause 28.2.3.2,
clause 28.2.3.3,
clause 28.2.4,
clause 28.2.5,
clause 28.2.6,
clause 28.2.7,
clause 28.2.9 | 3GPP TS 24.379 [201], clause F.1 | +| 42 | application/vnd.3gpp.mcptt-mbms-usage-info+xml | clause 28.2.2 | 3GPP TS 24.379 [201], clause F.2 | +| 42A | application/vnd.3gpp.mcvideo-mbms-usage-info+xml | clause 28.2.2 | 3GPP TS 24.281 [210], clause F.2 | +| 43 | application/vnd.3gpp.mcptt-location-info+xml | clause 28.2.2 | 3GPP TS 24.379 [201], clause F.3 | +| 43A | application/vnd.3gpp.mcvideo-location-info+xml | clause 28.2.2 | 3GPP TS 24.281 [210], clause F.3 | +| 44 | application/conference-info+xml | clause 12.19,
clause 28.2.4,
clause 16.5 | IETF RFC 4575 [204] | +| 45 | application/poc-settings+xml | clause 28.2.5 | IETF RFC 4354 [205] | +| 46 | application/vnd.3gpp.mcptt-floor-request+xml | clause 28.2.7 | 3GPP TS 24.379 [201], clause F.5 | +| 47 | application/vnd.3gpp.mcptt-affiliation-command+xml | clause 28.2.3.3 | 3GPP TS 24.379 [201], clause F.4 | +| 47A | application/vnd.3gpp.mcptt-signed+xml | clause 28.2.5,
clause 28.2.6 | 3GPP TS 24.379 [201], clause F.6 | +| 48 | application/call-completion | clause 12.11,
clause 12.12,
clause 12.23 | IETF RFC 6910 [208] | +| 49 | application/vnd.3gpp.mcvideo-info+xml | clause 28.2.1
clause 28.2.3.2,
clause 28.2.3.3,
clause 28.2.5,
clause 28.2.4,
clause 28.2.6, | 3GPP TS 24.281 [210], clause F.1 | +| 50 | application/vnd.3gpp.mcvideo-affiliation-command+xml | clause 28.2.3.3 | 3GPP TS 24.281 [210], clause F.4 | +| 51 | application/vnd.3gpp.mcdata-signalling | clause 28.2.1,
clause 28.2.8 | 3GPP TS 24.282 [211], clause E.1 | +| 52 | application/vnd.3gpp.mcdata-payload | clause 28.2.8 | 3GPP TS 24.282 [211], clause E.2 | +| 53 | application/vnd.3gpp.mcdata-info+xml | clause 28.2.1
clause 28.2.3.2,
clause 28.2.3.3,
clause 28.2.5,
clause 28.2.6,
clause 28.2.8 | 3GPP TS 24.282 [211], clause D.1.4 | +| 54 | application/vnd.3gpp.mcdata-affiliation-command+xml | clause 28.2.3.3 | 3GPP TS 24.282 [211], clause D.3.4 | +| NOTE 1: When no specific II-NNI requirements are defined, the II-NNI requirements may be derived from the additional information about MIME types in SIP requests and responses in annex A of 3GPP TS 24.229 [5]. | | | | +| NOTE 2: This column references the definition of the MIME body for informative purpose only, the usage is defined in other specifications not listed here. | | | | +| NOTE 3 The MIME body contains a string that is coded as described in the IETF RFC 1866 [198]. | | | | + +Applicable characteristics of the SIP message body MIMEs (i.e. the value(s) of Content-Disposition header field and Content-Language header field) over the II-NNI may be a subject of operator agreements. + +## 6.2 Control Plane Transport + +### 6.2.1 General + +The control plane transport of the II-NNI shall comply with clause 4.2A of 3GPP TS 24.229 [5]. + +Support of SCTP as specified in IETF RFC 4168 [27] is optional for an IBCF connected by II-NNI. Nevertheless this option is favourable if the operators would like to improve reliability over the Ici. + +## 6.3 SIP timers + +Table 6.3.1 shows values of SIP timers that should be supported at II-NNI. It contains the following items: + +- the first column, titled "SIP Timer", shows the timer names as defined in IETF RFC 3261 [13] or IETF RFC 6026 [125]; +- the second column reflects the timer meaning as defined in IETF RFC 3261 [13]; +- the third column reflects the reference to the proper clause in the IETF RFC 3261 [13] and in 3GPP TS 24.229 [5] and +- the final column lists the values recommended for the functional entities closest to the border of an II-NNI (see reference model in clause 5). + +Table 6.3.1 reports information from 3GPP TS 24.229 [5], table 7.7.1. Values between IM CN subsystem elements shown in the second column in 3GPP TS 24.229 [5], table 7.7.1 are applicable for the II-NNI and are reported in the fourth column of table 6.3.1. If there are any differences between table 6.3.1 and 3GPP TS 24.229 [5], table 7.7.1, the information within 3GPP TS 24.229 [5], table 7.7.1 is applicable. + +**Table 6.3.1: SIP timers at II-NNI** + +| SIP Timer | Meaning | Reference | Recommended values | +|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|----------------------------------| +| T1 | RTT estimate | [13] clause 17.1.1.1
[5] table 7.7.1 | 500ms default
(see NOTE) | +| T2 | The maximum retransmit interval for non-INVITE requests and INVITE responses | [13] clause 17.1.2.2
[5] table 7.7.1 | 4s
(see NOTE) | +| T4 | Maximum duration a message will remain in the network | [13] clause 17.1.2.2
[5] table 7.7.1 | 5s
(see NOTE) | +| Timer A | INVITE request retransmit interval, for UDP only | [13] clause 17.1.1.2
[5] table 7.7.1 | initially T1 | +| Timer B | INVITE transaction timeout timer | [13] clause 17.1.1.2
[5] table 7.7.1 | 64*T1 | +| Timer C | proxy INVITE transaction timeout | [13] clause 16.6
[5] table 7.7.1 | > 3min | +| Timer D | Wait time for response retransmits | [13] clause 17.1.1.2
[5] table 7.7.1
[13] clause 17.1.1.2
[5] table 7.7.1 | > 32s for UDP
0s for TCP/SCTP | +| Timer E | non-INVITE request retransmit interval, UDP only | [13] clause 17.1.2.2
[5] table 7.7.1 | initially T1 | +| Timer F | non-INVITE transaction timeout timer | [13] clause 17.1.2.2
[5] table 7.7.1 | 64*T1 | +| Timer G | INVITE response retransmit interval | [13] clause 17.2.1
[5] table 7.7.1 | initially T1 | +| Timer H | Wait time for ACK receipt. | [13] clause 17.2.1
[5] table 7.7.1 | 64*T1 | +| Timer I | Wait time for ACK retransmits | [13] clause 17.2.1
[5] table 7.7.1
[13] clause 17.2.1
[5] table 7.7.1 | T4 for UDP
0s for TCP/SCTP | +| Timer J | Wait time for non-INVITE request retransmits | [13] clause 17.2.2
[5] table 7.7.1
[13] clause 17.2.2
[5] table 7.7.1 | 64*T1 for UDP
0s for TCP/SCTP | +| Timer K | Wait time for response retransmits | [13] clause 17.1.2.2
[5] table 7.7.1
[13] clause 17.1.2.2
[5] table 7.7.1 | T4 for UDP
0s for TCP/SCTP | +| Timer L | Wait time for accepted INVITE request retransmits | [125] clause 8.11
[5] table 7.7.1 | 64*T1 | +| Timer M | Wait time for retransmission of 2xx to INVITE or additional 2xx from other branches of a forked INVITE | [125] clause 8.11
[5] table 7.7.1 | 64*T1 | +| Timer N | Wait time for receipt of a NOTIFY request upon sending SUBSCRIBE | [20] clause 4.1.2
[5] table 7.7.1 | 64*T1 | +| NOTE: | As a network option, SIP T1 Timer's value can be extended, along with the necessary modifications of SIP T2 and SIP T4 Timer values, to take into account the specificities of the supported services when the MRFC and the controlling AS are under the control of the same operator and the controlling AS knows, based on local configuration, that the MRFC implements a longer value of SIP T1 Timer. | | | + +# 7 User plane Interconnection + +## 7.1 Media and Codec + +For "end-to-end" media session involving the II-NNI, the SIP/SDP codec negotiation procedure can be applied between IM CN subsystems using different media codecs. It is possible that the end-to-end codec negotiation could fail because no common codec could be supported by the UEs, in particular for voice services. + +To enhance interoperability, the IBCF, the MRFC, or other IMS network entities can interfere with the end-to-end codec negotiation to offer additional codec(s) available via transcoding, or to remove codecs. The IBCF can configure an attached TrGW to transcode, and the MRFC can configure an attached MRFP to transcode. + +Codecs applicable at the II-NNI may be a subject of interworking agreements. + +NOTE 1: Possible codecs which could be used at the II-NNI are described in 3GPP TS 26.114 [11] and ETSI TS 181 005 [12]. + +NOTE 2: As described in 3GPP TS 24.229 [5], the IETF RFC 4733 [157] is used to encode DTMF events and a payload type number associated with the MIME subtype "telephone-event" is included in a SDP message. + +However, to avoid that transcoding is performed several times, applicable codecs at the II-NNI should be restricted as little as possible in the inter-operator agreements. It is not recommended to set only codecs which are not agreed to use by the inter-operator agreement into the SDP of the SIP message at the II-NNI. Whether it is allowed to offer codecs which are not included in the applicable codec list made by inter-operator agreements over the II-NNI is also determined by the inter-operator agreement if necessary. + +NOTE 3: Transcoding can be performed in an IMS network serving an SDP offerer or in an IMS network serving an SDP answerer. To avoid that transcoding is performed multiple times, inter-operator agreements can clarify if it is preferred that IMS network serving an SDP offerer (with respect to the initial offer-answer exchange) or IMS network serving an SDP answerer (with respect to the initial offer-answer exchange) modify an SDP offer to offer transcoding. Furthermore, if transcoding is ongoing then subsequent SDP negotiation should avoid adding transcoding steps as specified in 3GPP TS 24.229 [5] Annex T.2 steps G), H), and I). + +If the IBCF performs media transcoding control, the IBCF shall apply the related procedures in 3GPP TS 24.229 [5]. + +## 7.2 User Plane Transport + +The user plane transport of the II-NNI may use the protocols listed in table 7.2.1. Protocols that use UDP, RTP, SCTP or TCP as the underlying transport protocol may be used based on agreements between operators. The used protocols to transport media are negotiated by means of the SDP offer/answer procedure specified in IETF RFC 3264 [146]. + +**Table 7.2.1: Supported transport-level RFCs to be described in SIP/SDP messages** + +| Item | RFC | Title | Support | +|------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| 1 | IETF RFC 3550 [151] | RTP: A Transport Protocol for Real-Time Applications | Mandatory | +| 2 | IETF RFC 768 [152] | User Datagram Protocol | Mandatory | +| 3 | IETF RFC 3551 [153] | RTP Profile for Audio and Video Conferences with Minimal Control | Mandatory | +| 4 | IETF RFC 3556 [154] | Session Description Protocol (SDP) Bandwidth Modifiers for RTP Control Protocol (RTCP) Bandwidth | Mandatory | +| 5 | IETF RFC 4585 [155] | Extended RTP Profile for Real-time Transport Control Protocol (RTCP) - Based Feedback (RTP/AVPF) | Optional
(NOTE 1) | +| 6 | IETF RFC 793 [156] | Transmission Control Protocol | Optional
(NOTE 2) | +| 7 | IETF RFC 8841 [190] | Session Description Protocol (SDP) Offer/Answer Procedures for Stream Control Transmission Protocol (SCTP) over Datagram Transport Layer Security (DTLS) Transport | Optional
(NOTE 3) | + +NOTE 1: Used by MTSI, as indicated in 3GPP TS 26.114 [11]. + +NOTE 2: Used for MSRP service. + +NOTE 3: Used for data channel in telepresence using IMS, as indicated in 3GPP TS 24.103 [189]. + +# 8 Numbering, Naming and Addressing + +## 8.1 Numbering, Naming and Addressing for SIP message + +The following URI formats in SIP messages may be applied at the Icf as standardized in 3GPP TS 24.229 [5]: + +- SIP URI defined in IETF RFC 3261 [13]; +- tel URI defined in IETF RFC 3966 [14]; +- IM URI defined in IETF RFC 3860 [15]; and +- PRES URI defined in IETF RFC 3859 [16]. + +According to 3GPP TS 24.229 [5], the IBCF acting as an exit or entry point in the IMS network supports these URI formats. These URI formats shall be supported at the roaming II-NNI. The SIP URI format shall be supported at the non-roaming II-NNI. For the loopback traversal scenario both the SIP URI and the tel URI shall be supported. The tel URI, IM URI and PRES URI formats may be supported at the non-roaming II-NNI based on agreement between operators. For the loopback traversal scenario the IM URI and PRES URI may be supported based on agreement between operators. Other URI formats may be supported over the II-NNI depending on the operator agreements. + +A global number as defined in IETF RFC 3966 [14] shall be used in a tel URI or in the user portion of a SIP URI with the user=phone parameter when conveyed via a non-roaming II-NNI or for the loopback traversal scenario in the Request-URI and in the P-Asserted-Identity header field, except when agreement exists between the operators to also allow other kinds of numbers. + +NOTE 1: In a SIP URI the user portion of the Request-URI represents a telephone number only if the SIP URI includes the user=phone parameter. + +NOTE 2: Agreements can exist between operators to allow local number (e.g. national service numbers, business trunking numbers, or private numbers) at a non-roaming II-NNI or for the loopback traversal scenario. A SIP URI with such a number, a user=phone parameter, and a phone-context parameter agreed between the operators can then be used. + +NOTE 3: 3GPP TS 24.229 [5] allows to restrict the number within a SIP Request-URI with user=phone parameter at a non-roaming II-NNI or for the loopback traversal scenario to be a global number (i.e. E.164 in international format) via an appropriate Application Server. Suitable configuration by the operator is needed to achieve the desired modification of the format. + +NOTE 4: The allowed phone number formats in the P-Asserted-Identity header field of a served user are configured by the operator. According to 3GPP TS 23.003 [35], international E.164 format is used within a P-Asserted-Identity header field. + +NOTE 5: The global number format usage within a SIP Request-URI with the user=phone parameter at a non-roaming II-NNI or for the loopback traversal scenario allows the terminating network to find the called subscriber, via HSS interrogation, without any further number translation and thus improves the success of the interconnection between IMS operators. + +NOTE 6: According to 3GPP TS 23.003 [35] and 3GPP TS 24.229 [5], public user identity takes the form of either SIP URI or tel URI. + +NOTE 7: Agreements can exist between operators to allow the "Unavailable User Identity" as defined in 3GPP TS 23.003 [35] in the P-Asserted-Identity header field at a non-roaming II-NNI or for the loopback traversal scenario. + +The optional "oli" and "cpc" tel URI parameters associated with a tel URI or a SIP URI with user=phone are described in 3GPP TS 24.229 [5] clause 7.2A.12 and can be part of the P-Asserted-Identity header field. Depending on operator agreements, those URI parameters may be supported at the non-roaming II-NNI or for the loopback traversal scenario. + +The "sos" SIP URI parameter associated with a URI in the Contact header field of a REGISTER request or a 200 (OK) response to REGISTER request is described in 3GPP TS 24.229 [5]. The "sos" SIP URI parameter shall be supported at the roaming II-NNI. + +The "sos" SIP URI parameter associated with the Request-URI for all dialogs and standalone SIP requests described in clause 5.2.10.3 of 3GPP TS 24.229 [5] and shall be supported at the roaming II-NNI. + +The "rn" and "npdi" number portability parameters for the tel URI and the SIP URI with user=phone as described within IETF RFC 4694 [75] can be part of the Request-URI. Depending on operator agreements these parameters may be exchanged over the non-roaming II-NNI or for the loopback traversal scenario. + +NOTE 7: The "rn" and "npdi" parameters can be used to address the entry point of the terminating operator depending on national rules for number portability. + +The "isub" tel URI parameter for the tel URI and the SIP URI with user=phone as described within IETF RFC 3966 [14] can be part of the Request-URI, To header field and P-Asserted-Identity header field. Depending on operator agreements, this URI parameter may be exchanged over the II-NNI. + +The "premium-rate" tel URI parameter for the tel URI and the SIP URI with user=phone as described within 3GPP TS 24.229 [5] clause 7.2A.17 can be part of the Request-URI. Depending on operator agreements, this URI parameter may be exchanged at the roaming II-NNI. + +The public service identity (PSI) that takes a form of a SIP URI without including a port number as described in clause 13.5 of 3GPP TS 23.003 [35] may be exchanged over the II-NNI depending on operator agreements. + +## 8.2 Numbering, Naming and Addressing for SDP + +The following URI format in the SDP exchange may be applied at the Ici as standardized in 3GPP TS 24.229 [5]: + +- MSRP URI for a session of instant messages defined in IETF RFC 4975 [17]. + +This URI format shall be supported at the roaming II-NNI and may be supported at the non-roaming II-NNI and for the loopback traversal scenario based on agreement between operators. Other URI formats may be supported over the II-NNI depending on the operator's agreements. + +# --- 9 IP Version + +The network elements interconnected by means of the II-NNI may support IPv4 only, IPv6 only or both. + +The support of one or both of the IP versions is an operator option and should be based on bilateral agreement. + +In case IPv4 and IPv6 networks are interconnected, the involved IBCFs and TrGWs shall apply the IP version interworking procedures as indicated in 3GPP TS 29.162 [8]. + +# --- 10 Security + +The supported security mechanisms for IP signalling transport over II-NNI interfaces are described in 3GPP TS 33.210 [10]. + +# --- 11 Charging + +## 11.1 General + +The accounting information to be supported over the Ici is described in 3GPP TS 32.260 [29] and 3GPP TS 32.240 [183]. It shall be configurable by the operator to use or not the accounting mechanisms provided by the IBCF. + +## 11.2 Inter-operator accounting + +For inter-operator accounting, the procedures related to the P-Charging-Vector header field specified in 3GPP TS 24.229 [5] shall be supported over the II-NNI as further specified below. + +NOTE 1: The "icid-value" header field parameter identifying a dialog or a transaction outside a dialog is included in the P-Charging-Vector header field as specified in 3GPP TS 24.229 [5]. The "icid-value" header field parameter value of a SIP response to a SIP request is identical to the "icid-value" of the SIP request. + +For the roaming II-NNI: + +- the P-Charging-Vector header field in the REGISTER requests, initial SIP requests and stand-alone SIP requests, containing the type 1 "orig-ioi" with the entry which identifies the visited network; and +- the P-Charging-Vector header field in the REGISTER responses (except the 100 (Trying) response), SIP responses (except the 100 (Trying) response) to initial SIP requests and SIP stand-alone requests, containing type 1 "orig-ioi" and type 1 "term-ioi" header field parameters with the entries which identify the visited network and the home network respectively; + +shall be supported. + +NOTE 2: Operator network identifiers populated in the type 1 "orig-ioi" and type 1 "term-ioi" header field parameters need to be exchanged by inter-operator agreements in advance. + +For the II-NNI between IMS home networks: + +- the P-Charging-Vector header field in the SIP requests containing the type 2 "orig-ioi" with the entry which identifies the home originating network; and +- the P-Charging-Vector header field in the SIP responses (except the 100 (Trying) response) containing the type 2 "orig-ioi" and type 2 "term-ioi" header field parameters with the entries which identify the home originating network and the home terminating network respectively; + +may be supported based on inter-operator agreements. + +If the roaming architecture for voice over IMS with local breakout is used, for the II-NNI between the caller's visited network and the callee's home network except for the roaming II-NNI: + +- the P-Charging-Vector header field in the SIP requests containing the type 2 "orig-ioi" with the entry which identifies the visited originating network; and +- the P-Charging-Vector header field in the SIP responses (except the 100 (Trying) response) containing the type 2 "orig-ioi" and type 2 "term-ioi" header field parameters with the entries which identify the visited originating network and the home terminating network respectively; + +may be supported based on inter-operator agreements. + +NOTE 3: Operator network identifiers populated in the type 2 "orig-ioi" and type 2 "term-ioi" header field parameters need to be exchanged by inter-operator agreements in advance. + +For the II-NNI for the transit scenario: + +- the P-Charging-Vector header field in the SIP requests and responses (except the 100 (Trying) response) containing the "transit-ioi" header field parameter with the entry(ies) which identify the transit network(s); + +may be supported based on inter-operator agreements. + +NOTE 4: Operator network identifiers populated in the value(s) of "transit-ioi" header field parameter need to be exchanged by inter-operator agreements in advance. + +## 11.3 Transfer of IP multimedia service tariff information + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), transfer of IP multimedia service tariff information as specified in 3GPP TS 29.658 [186] may be supported on the II- + +NNI between two IMS networks. The support of transfer of IP multimedia service tariff information is based on agreement between operators. + +If transfer of IP multimedia service tariff information is supported, the "application/vnd.etsi.sci+xml" MIME body with the Content-Disposition header field set to either "render" with the "handling" parameter set to "optional" or to "signal" with the "handling" parameter set to "required" or "optional" based on operator agreement in 18x responses to the INVITE request and in the INFO request shall be supported at the II-NNI. + +# --- 12 Supplementary services associated with the IMS multimedia telephony communication service + +## 12.1 General + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), the associated supplementary services of the multimedia telephony communication service may be supported on the II-NNI between the two IMS networks. + +The MMTEL communication service is identified by means of the "urn:urn-7:3gpp-service.ims.icsi.mmtel" URN. The "urn:urn-7:3gpp-service.ims.icsi.mmtel" can appear in: + +- the media feature tag "g.3gpp.icsi-ref" (specified in 3GPP TS 24.229 [5] clause 7.2A.8) in the Contact header field and the Accept-Contact header field; +- the feature-capability indicator "g.3gpp.icsi-ref" (specified in 3GPP TS 24.229 [5] clause 7.9A.2) in the Feature-Caps header field; and +- the P-Asserted-Service header field. + +The support of each associated supplementary service is based on agreement between operators. + +If a supplementary service is supported, the related procedures from the 3GPP TS 22.173 [30], the protocol details from the 3GPP TS 24.173 [31] and specifications referenced in the 3GPP TS 24.173 [31] shall be applied with the requirements in the relevant clause below due to the crossing of the II-NNI. + +A classification of the importance of supplementary services applicable over the II-NNI is available in the informative annex Db of 3GPP TS 22.173 [30]. + +NOTE: Agreeing on interworking of entire class of services according to this classification can simplify the cooperation between interconnecting networks but remains optional. + +## 12.2 Malicious Communication IDeNtification (MCID) + +Service specific requirements in accordance with 3GPP TS 24.616 [33] shall be supported over the II-NNI. + +The P-Asserted-Identity header field shall be supported at the II-NNI. + +The INFO request and the 200 (OK) response to the INFO request containing the "application/vnd.etsi.mcid+xml" MIME body defined in 3GPP TS 24.616 [33] may be supported at the II-NNI. + +If a network terminating the dialog supports MCID, the terminating network shall only deliver the MCID request in the "application/vnd.etsi.mcid+xml" MIME body, as specified in the 3GPP TS 24.616 [33], if an agreement to use the MCID supplementary service according to the 3GPP TS 24.616 [33] exists with the network originating the dialog and if the INVITE request received by the terminating network does not contain the information of the originating party. + +NOTE: The IBCF and the AS in the terminating network interact to deliver the MCID request only if an agreement to use the MCID supplementary service exists, as specified in 3GPP TS 24.616 [33] and 3GPP TS 24.229 [5]. + +The originating network and the terminating network shall have a bilateral agreement to support transportation of the minimum information specified in clause 4.5.2.5.0 of the 3GPP TS 24.616 [33] between the networks. + +## 12.3 Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR) + +Service specific requirements in accordance with 3GPP TS 24.607 [32] and 3GPP TS 24.229 [5] shall be supported over the II-NNI. + +The P-Asserted-Identity header field and the Privacy header field with values "id", "user", "none", "header" and "critical" shall be supported at the II-NNI. + +NOTE 1: P-Asserted-Identity header fields are intended for end-to-end operation. Removal of such header fields will impact the intended end-to-end operation between the end users. Where a trust relationship exists on the P-Asserted-Identity header field between the two IMS networks, this header field cannot be altered when passing through the II-NNI according to 3GPP TS 24.229 [5]. Where no trust relationship exists on the P-Asserted-Identity header field between the two IMS networks, the IBCF determines whether to remove the P-Asserted-Identity header field according to procedures described in 3GPP TS 24.229 [5] clause 4.4.2 referencing IETF RFC 3325 [44] and local policy rules for using additional screening capabilities as defined in 3GPP TS 24.229 [5] clause 5.10.6. + +NOTE 2: Where a trust relationship exists with the remote domain the From header field will be passed transparently by the IBCF. If a SIP request is received by the terminating network and the application of the OIR service is required with the value "user" for the Privacy header field then the From header field will be anonymised in accordance with IETF RFC 3323 [34] by the terminating network. Where no trust relationship exists with the remote domain, the From header field can be, based on local policy rules, anonymised by the IBCF of the originating network prior passing through the II-NNI using screening capabilities defined in 3GPP TS 24.229 [5] clause 5.10.6 and clause 5.10.8. + +NOTE 3: The privacy level "session" and "critical" are not used in the OIP/OIR service as described in 3GPP TS 24.607 [32]. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.4 Terminating Identification Presentation (TIP) and Terminating Identification Restriction (TIR) + +Service specific requirements in accordance with 3GPP TS 24.608 [113] shall be supported over the II-NNI. + +The P-Asserted-Identity header field and the Privacy header field with values "id", "user", "none", "header" and "critical" shall be supported at the II-NNI. + +NOTE: P-Asserted-Identity header fields are intended for end-to-end operation. Removal of such header fields will impact the intended end-to-end operation between the end users. Where a trust relationship exists on the P-Asserted-Identity header field between the two IMS networks, this header field will be passed transparently through the II-NNI according to 3GPP TS 24.229 [5]. Where no trust relationship exists on the P-Asserted-Identity header field between the two IMS networks, the IBCF determines whether to remove the P-Asserted-Identity header field according to procedures described in 3GPP TS 24.229 [5] clause 4.4.2, referencing IETF RFC 3325 [44] and local policy rules for using additional screening capabilities as defined in 3GPP TS 24.229 [5] clause 5.10.6. + +The option tag "from-change" defined in IETF RFC 4916 [158], in the Supported header field should be supported at II-NNI. + +## 12.5 Anonymous Communication Rejection (ACR) + +Service specific requirements in accordance with 3GPP TS 24.611 [114] shall be supported over the II-NNI. + +The P-Asserted-Identity header field and the Privacy header field shall be supported at the II-NNI. + +Procedures as described in clause 12.21.4 are used to provide announcements. + +The response code 433 (Anonymity Disallowed) shall be supported at the II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.6 Communication DIVersion (CDIV) + +Service specific requirements in accordance with 3GPP TS 24.604 [117] shall be supported over the II-NNI. + +NOTE 1: The support of the Diversion header field not adopted in 3GPP TS 24.604 [117] requires bilateral agreement between the operators. + +Procedures as described in clause 12.21.2 are used to provide announcements. + +The Privacy header field with a priv-value set to "history" included in the hi-targeted-to-uri or as a standalone header field shall be supported at the II-NNI. + +The History-Info header field as described by 3GPP TS 24.604 [117] containing an "mp" header field parameter as defined by IETF RFC 7044 [25] and a "cause" SIP URI parameter with cause values as defined by the IETF RFC 4458 [58] shall be supported over the II-NNI. + +NOTE 2: The networks can have an internal limit in the number of allowed diversions, as described in 3GPP TS 24.604 [117], clause 4.5.2.6.1. To ensure efficiency of this control operators can indicate in their bilateral agreements their own number of allowed communication diversions, the parameter that is used for counting, and the network behavior when the internal limit is reached. + +The response code 181 (Call Is Being Forwarded) shall be supported at the II-NNI. + +The MESSAGE request procedure for indication of communication diversion to the diverting user as specified in 3GPP TS 24.604 [117] and 3GPP TS 24.229 [5] should be supported at the roaming II-NNI. + +NOTE 3: The content of the MESSAGE request is operator specific. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.7 Communication Waiting (CW) + +Service specific requirements in accordance with 3GPP TS 24.615 [37] shall be supported over the II-NNI. + +The "application/vnd.3gpp.cw+xml" MIME body defined in 3GPP TS 24.615 [37] in the INVITE request shall be supported at the roaming II-NNI. + +The Alert-Info header field set to "urn:alert:service:call-waiting" in a 180 (Ringing) response shall be supported at the II-NNI. + +As a network option, in case of expiry of the CW timer, the response code 480 (Temporarily Unavailable) including a Reason header field containing the protocol value "Q.850" and the "cause" header field parameter set to "19" shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +Procedures as described in clause 12.21.2 are used to provide announcements. + +## 12.8 Communication HOLD (HOLD) + +Service specific requirements in accordance with 3GPP TS 24.610 [36] shall be supported over the II-NNI. + +NOTE: The support of an alternative method not adopted in 3GPP TS 24.610 [36] requires bilateral agreement between the operators and is outside the scope of the present document. + +Procedures as described in clause 12.21.3 are used to provide announcements. + +## 12.9 Message Waiting Indication (MWI) + +Service specific requirements in accordance with 3GPP TS 24.606 [112] shall be supported over the II-NNI. + +The event package name "message-summary" in the Event header field according to IETF RFC 6665 [20] and 3GPP TS 24.229 [5] in the SUBSCRIBE request shall be supported at the roaming II-NNI. + +The "application/simple-message-summary" MIME body described in 3GPP TS 24.606 [112] in the NOTIFY request shall be supported at the roaming II-NNI. + +## 12.10 Communication Barring (CB) + +### 12.10.1 Incoming Communication Barring (ICB) + +Service specific requirements in accordance with 3GPP TS 24.611 [114] shall be supported over the II-NNI. + +Procedures as described in clause 12.21.4 are used to provide announcements. + +The response code 603 (Decline) including a Reason header field containing the protocol value set to "SIP" and the "cause" header field parameter set to value "603" as described in 3GPP TS 24.611 [114] shall be supported at the II-NNI. + +A Reason header field containing the protocol value set to "SIP" and the "cause" header field parameter set to value "603" as described in 3GPP TS 24.611 [114] included in the BYE request shall be supported at the II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +If the option IIFC (Inhibition of Incoming Forwarded Calls) is supported the transparency of information related to communication diversion (see clause 12.6) shall be supported at II-NNI. + +### 12.10.2 Outgoing Communication Barring (OCB) + +Service specific requirements in accordance with 3GPP TS 24.611 [114] shall be supported over the II-NNI. + +Procedures as described in clause 12.21.4 are used to provide announcements. + +The response code 603 (Decline) including a Reason header field containing the protocol value set to "SIP" and the "cause" header field parameter set to "603" as described in 3GPP TS 24.611 [114] shall be supported at the roaming II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.11 Completion of Communications to Busy Subscriber (CCBS) + +Service specific requirements in accordance with 3GPP TS 24.642 [109] shall be supported over the II-NNI. + +The response code 486 (Busy Here) containing a Call-Info header field with a "purpose" header field parameter set to "call-completion" and the "m" parameter set to "BS" shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +For invoking and revoking of the CCBS supplementary service, announcement procedures shall be used to provide announcements and inband-interaction procedures as described in clause 12.21.3 and clause 12.21.4 shall be supported at the roaming II-NNI. + +The response code 199 (Early Dialog Terminated) shall be supported at the roaming II-NNI. + +Basic call procedures and in case of a call-completion recall initiated by a REFER request, normal REFER method handling procedures according to 3GPP TS 24.229 [5] shall be supported at the roaming II-NNI. + +As a network option the special REFER request handling procedures according to 3GPP TS 24.628 [38] should be supported at the roaming II-NNI. + +NOTE 1: 3rd party call control procedures can be used when the REFER request is not supported at the II-NNI. + +NOTE 2: A REFER request can be rejected by IBCF based on operator policy as specified by 3GPP TS 24.229 [5]. + +The SUBSCRIBE and NOTIFY methods according to IETF RFC 6665 [20] and 3GPP TS 24.229 [5] containing the event package name "call-completion" in the Event header field and the Call-Info header field with a purpose parameter set to 'call-completion' and the m parameter set to "BS" shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +The NOTIFY request containing the "application/call-completion" MIME body as defined in IETF RFC 6910 [208] shall be supported at the non-roaming II-NNI. + +The Request-URI with the "m" SIP URI parameter with a value set to "BS" and the Call-Info header field with a purpose parameter set to 'call-completion' and the "m" parameter set to "BS" in the INVITE method shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +The Date header field in the 486 (Busy Here) response to the INVITE request shall be supported at the roaming II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.12 Completion of Communications by No Reply (CCNR) + +Service specific requirements in accordance with 3GPP TS 24.642 [109] shall be supported over the II-NNI. + +The response code 180 (Ringing) containing a Call-Info header field with a purpose parameter set to 'call-completion' and the "m" parameter set to "NR" shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +For invoking and revoking of the CCNR supplementary service, announcement procedures shall be used to provide announcements and inband-interaction procedures as described in clause 12.21.3 and clause 12.21.4 shall be supported at the roaming II-NNI. + +The response code 199 (Early Dialog Terminated) shall be supported at the roaming II-NNI. + +Basic call procedures and in case of a call-completion recall initiated by a REFER request, normal REFER method handling procedures according to 3GPP TS 24.229 [5] shall be supported at the roaming II-NNI. + +As a network option the special REFER request handling procedures according to 3GPP TS 24.628 [38] should be supported at the roaming II-NNI. + +NOTE 1: 3rd party call control procedures can be used when the REFER request is not supported at the II-NNI. + +NOTE 2: A REFER request can be rejected by IBCF based on operator policy as specified by 3GPP TS 24.229 [5]. + +The SUBSCRIBE and NOTIFY methods according to IETF RFC 6665 [20] and 3GPP TS 24.229 [5] containing the event package name "call-completion" in the Event header field and the Call-Info header field with a purpose parameter set to 'call-completion' and the m parameter set to "NR" shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +The NOTIFY request containing the "application/call-completion" MIME body as defined in IETF RFC 6910 [208] shall be supported at the non-roaming II-NNI. + +The Request-URI with the "m" SIP URI parameter with a value set to "NR" and the Call-Info header field with a purpose parameter set to 'call-completion' and the "m" parameter set to "NR" in the INVITE method shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +The Date header field in the 480 (Temporarily Unavailable) response to the INVITE request shall be supported at the roaming II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.13 Explicit Communication Transfer (ECT) + +### 12.13.1 Consultative and blind transfer + +Service specific requirements in accordance with 3GPP TS 24.629 [116] shall be supported over the II-NNI. + +The REFER method, the Referred-By header field and the Replaces header field as specified in 3GPP TS 24.629 [116] and the NOTIFY method containing an "application/sipfrag" MIME body shall be supported at the II-NNI for call transfer without third party call control. + +The REFER method, the Referred-By header field and the Replaces header field as specified in 3GPP TS 24.629 [116] and the NOTIFY method containing an "application/sipfrag" MIME body shall be supported at the roaming II-NNI for call transfer with third party call control. + +The Refer-To URI header parameter in the REFER request containing the Require header field set to "replaces" shall be supported at the roaming II-NNI. + +The Replaces header field in the INVITE request shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +### 12.13.2 Assured transfer + +The requirements for the assured transfer are the same as in clause 12.13.1 with the additional requirements in this clause. + +An Expires header field parameter in the Refer-To URI of the REFER Request shall be supported at the II-NNI for call transfer without third party call control. + +An Expires header field parameter in the Refer-To URI of the REFER Request shall be supported at the roaming II-NNI for call transfer with third party call control. + +The Refer-To header field in the REFER request containing the method parameter set to "CANCEL" shall be supported at the II-NNI for call transfer without third party call control. + +The Refer-To header field in the REFER request containing the method parameter set to "CANCEL" shall be supported at the roaming II-NNI with third party call control. + +## 12.14 Customized Alerting Tone (CAT) + +Service specific requirements in accordance with 3GPP TS 24.182 [129] shall be supported over the II-NNI. + +The P-Early-Media header field as described in 3GPP TS 24.182 [129] shall be supported at the II-NNI. + +The response code 180 (Ringing) and the response code 183 (Session Progress) including a P-Early-Media header field shall be supported over the II-NNI. + +The response code 199 (Early Dialog Terminated) shall be supported over the II-NNI. + +The Supported header field and the Require header field with "early-session" option-tag shall be supported at the II-NNI, if the early session model is supported. + +An "application/sdp" MIME body with the Content-Disposition header field set to "early-session" as specified in IETF RFC 3959 [96] shall be supported at II-NNI, if the early session model is supported. + +A SDP "a=content" attribute with a "g.3gpp.cat" value in the 18x responses shall be supported at the II-NNI. + +The SIP INFO mechanism for DTMF transport, as defined in 3GPP TS 24.229 [5] may be supported at the roaming II-NNI. + +NOTE 1: For telephone-event based DTMF transport, the DTMF digits are sent as media and not visible in the control plane. + +NOTE 2: Multiple methods for DTMF transport are defined in 3GPP TS 24.182 [129]. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.15 Customized Ringing Signal (CRS) + +Service specific requirements in accordance with 3GPP TS 24.183 [98] shall be supported over the II-NNI. + +An Alert-Info header field in the initial INVITE request containing an URI followed by a URN "urn:alert:service:crs" shall be supported at the II-NNI. + +An "application/vnd.3gpp.crs+xml" MIME body in the initial INVITE request shall be supported at the II-NNI. + +A SDP "a=content" attribute with a "g.3gpp.crs" value in the PRACK request or the re-INVITE request may be supported at the II-NNI. + +The Supported header field and the Require header field with "early-session" option-tag may be supported at the II-NNI. + +An "application/sdp" MIME body with the Content-Disposition header field set to "early-session" as specified in IETF RFC 3959 [96] may be supported at II-NNI. + +The SIP INFO mechanism for DTMF transport, as defined in 3GPP TS 24.229 [5] may be supported at the II-NNI. + +NOTE: For telephone-event based DTMF transport, the DTMF digits are sent as media and not visible in the control plane. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.16 Closed User Group (CUG) + +Service specific requirements in accordance with 3GPP TS 24.654 [103] shall be supported over the II-NNI. + +The "application/vnd.etsi.cug+xml" MIME body as specified 3GPP TS 24.654 [103] shall be supported in INVITE requests at the II-NNI. + +NOTE: If no agreement between the originating network and the terminating network exists to support the CUG supplementary service the INVITE request is rejected as described in IETF RFC 5621 [89] when the "handling" parameter in the Content-Disposition header field of the " application/vnd.etsi.cug+xml" MIME body is set to "required". + +The 403 (Forbidden) response, the 603 (Decline) response and the 500 (Server Internal Error) response shall be supported at II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.17 Personal Network Management (PNM) + +Service specific requirements in accordance with 3GPP TS 24.259 [99] shall be supported over the II-NNI. + +A "g.3gpp.iari\_ref" feature tag with the value "urn:urn-7:3gpp-application.ims.iari.pnm-controller" in the Contact header field of the REGISTER request shall be supported at the roaming II-NNI. + +A "g.3gpp.iari\_ref" feature tag with the value "urn:urn-7:3gpp-application.ims.iari.pnm-controller" in the Accept-Contact header field shall be supported at the II-NNI. + +The History-Info header field shall be supported at II-NNI. + +A "histinfo" option tag as described by 3GPP TS 24.259 [99] in the Supported header field shall be supported at II-NNI. + +## 12.18 Three-Party (3PTY) + +Service specific requirements in accordance with 3GPP TS 24.605 [105] shall be supported over the II-NNI. + +NOTE 1: The requirements below can be relaxed by bilateral agreements between operators. + +The requirements for the 3PTY supplementary service are the same as for the CONF supplementary service specified in clause 12.19 with the following additional requirement: + +- If a REFER request is supported at the II-NNI, a Replaces header field in the header portion of the SIP URI of the Refer-to header field of the REFER request shall also be supported at II-NNI. + +NOTE 2: Clause 12.19 describes the conditions for the support of the REFER request. + +## 12.19 Conference (CONF) + +Service specific requirements in accordance with 3GPP TS 24.605 [105] and 3GPP TS 24.147 [106] shall be supported over the II-NNI. + +NOTE 1: The requirements below can be relaxed by bilateral agreements between operators. + +The REFER request shall be supported at the roaming II-NNI in the direction from visited to home network. Based on inter-operator agreement, the REFER request may be supported at the non-roaming II-NNI, for the loopback traversal scenario, and at the roaming II-NNI in the direction from home network to visited network. + +NOTE 2: If the REFER request is not supported at the non-roaming II-NNI, for the loopback traversal scenario, or at the roaming II-NNI in the direction from home network to visited network, an attempt of an UE to send the REFER directly to peers to invite them to a conference without involvement of the conference focus can fail over such an II-NNI. However such failures can also occur if a peer is located in a circuit switched network, or if a peer does not support the REFER method. An operator can avoid such failures by configuring an AS to convert the REFER to an INVITE, as detailed in 3GPP TS 24.628 [38]. Information on security risks associated with the REFER request is provided within the "security consideration" of IETF RFC 3515 [22]. + +NOTE 3: A REFER request can be rejected by IBCF based on operator policy as specified by 3GPP TS 24.229 [5]. + +The "application/resource-lists+xml" MIME body in the INVITE request shall be supported at the roaming II-NNI. + +The Referred-By header field in the INVITE request shall be supported at the II-NNI. + +The "isfocus" feature parameter indicated in Contact header field of the INVITE request and in the 200 (OK) response shall be supported at the II-NNI. + +The SUBSCRIBE request including the "conference" event package name in the Event header field and the Accept header field containing an "application/conference-info+xml" MIME type shall be supported at the II-NNI. + +The NOTIFY request including an "application/conference-info+xml" MIME body shall be supported at the II-NNI. + +NOTE 4: The subscription to "conference event" package does not apply at the roaming II-NNI between the MSC Server enhanced for ICS/MSC Server enhanced for SRVCC/MSC server enhanced for dual radio and the IMS network where the communication is anchored. + +The Allow-Events header field in the INVITE request with the value "conference" shall be supported at the roaming II-NNI and may be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +## 12.20 Flexible Alerting (FA) + +Service specific requirements in accordance with 3GPP TS 24.239 [101] shall be supported over the II-NNI. + +The 486 (Busy Here) response code shall be supported at the II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.21 Announcements + +### 12.21.1 General + +Announcements may be provided during the establishment of a communication session, during an established communication session or when a communication request is rejected. All of them shall be managed over the II-NNI. + +### 12.21.2 Providing announcements during the establishment of a communication session + +Procedures as described in 3GPP TS 24.628 [38] are used to provide announcements during the establishment of a communication session. + +There are two methods defined in 3GPP TS 24.628 [38] to provide the announcement: + +- 1) sending an announcement as an early media; and + +NOTE 1: There are two methods to use early media for sending the announcement in-band. First method is the gateway model defined by IETF RFC 3960 [150] and 3GPP TS 24.628 [38] annex G, second method is described in 3GPP TS 24.628 [38] annex D. + +- 2) sending an Alert-Info header field in 180 (Ringing) response to the INVITE request. + +The P-Early-Media header field authorizing early media as defined in IETF RFC 5009 [74] during the establishment of a communication shall be supported at the II-NNI. + +The Alert-Info header field in the 180 (Ringing) response to the INVITE request during the establishment of a communication, should be supported at the II-NNI. + +NOTE 2: The IBCF can decide to remove the Alert-Info header field if required by local policy. + +### 12.21.3 Providing announcements during an established communication session + +Procedures as described in 3GPP TS 24.628 [38] are used to provide announcements during an established communication session. + +In case of provision of an announcement to a user over the II-NNI during an established communication, the Call-Info header field in a re-INVITE request should be supported at the II-NNI. + +NOTE 1: An alternative method to provide announcements is to use the existing media stream. + +NOTE 2: The IBCF can decide to remove the Call-Info header field if required by local policy. + +### 12.21.4 Providing announcements when communication request is rejected + +Procedures as described in 3GPP TS 24.628 [38] are used to provide announcements when a communication request is rejected. + +There are three methods defined in 3GPP TS 24.628 [38] to provide the announcement: + +- 1) sending an announcement as an early media; + +NOTE 1: There are two methods to use early media for sending the announcement in-band. First method is the gateway model defined by IETF RFC 3960 [150] and 3GPP TS 24.628 [38] annex G, second method is described in 3GPP TS 24.628 [38] annex D. + +- 2) sending an Error-Info header field in the 3xx, 4xx, 5xx or 6xx response to the INVITE request; and +- 3) accept the communication request and then provide the announcement. + +NOTE 2: The II-NNI requirements for accepting the communication request and then provide the announcement is not within the scope of this clause. + +The P-Early-Media header field authorizing early media as defined in IETF RFC 5009 [74] and the Reason header field with the proper cause value shall be supported at the II-NNI. + +The Error-Info header field in the 3xx, 4xx, 5xx or 6xx response to the INVITE request when rejecting the communication request, should be supported at the II-NNI. + +NOTE 3: The IBCF can decide to remove the Error-Info header field if required by local policy. + +## 12.22 Advice Of Charge (AOC) + +Service specific requirements in accordance with 3GPP TS 24.647 [122] shall be supported over the II-NNI. + +The Accept header field with "application/vnd.etsi.aoc+xml" shall be supported at the roaming II-NNI. + +The INVITE method containing an "application/vnd.etsi.aoc+xml" MIME body shall be supported at the roaming II-NNI. + +Non-100 provisional responses and the 200 (OK) response to the initial INVITE request containing an "application/vnd.etsi.aoc+xml" MIME body shall be supported at the roaming II-NNI. + +The INFO method containing an "application/vnd.etsi.aoc+xml" MIME body shall be supported at the roaming II-NNI. + +The response code 504 (Server Time-out) shall be supported at the II-NNI. + +A Reason header field containing the protocol value set to "SIP" and the "cause" header field parameter set to "504" or containing the protocol value set to "Q.850" and the "cause" header field parameter set to "31" in the BYE method shall be supported at the II-NNI. + +An "application/vnd.etsi.aoc+xml" MIME body in the BYE request or the final response to the BYE request shall be supported over the roaming II-NNI. + +## 12.23 Completion of Communications on Not Logged-in (CCNL) + +Service specific requirements in accordance with 3GPP TS 24.642 [109] shall be supported over the II-NNI. + +The response code 480 (Temporarily unavailable) containing a Call-Info header field with a purpose parameter set to 'call-completion' and the "m" parameter set to "NL" shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +For invoking and revoking of the CCNL supplementary service, announcement procedures shall be used to provide announcements and inband-interaction procedures as described in clause 12.21.3 and clause 12.21.4 shall be supported at the roaming II-NNI. + +The response code 199 (Early Dialog Terminated) shall be supported at the roaming II-NNI. + +Basic call procedures and in case of a call-completion recall initiated by a REFER request, normal REFER method handling procedures according to 3GPP TS 24.229 [5] shall be supported at the roaming II-NNI. + +As a network option the special REFER request handling procedures according to 3GPP TS 24.628 [38] should be supported at the roaming II-NNI. + +NOTE: 3rd party call control procedures can be used when the REFER request is not supported at the II-NNI. + +The SUBSCRIBE and NOTIFY methods according to IETF RFC 6665 [20] and 3GPP TS 24.229 [5] containing the event package name "call-completion" in the Event header field and the Call-Info header field with a purpose parameter set to 'call-completion' and the "m" parameter set to "NL" shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +The NOTIFY request containing the "application/call-completion" MIME body as defined in IETF RFC 6910 [208] shall be supported at the non-roaming II-NNI. + +The Request-URI with the "m" SIP URI parameter with a value set to "NL" and the Call-Info header field with a purpose parameter set to 'call-completion' and the "m" parameter set to "NL" in the INVITE method shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +The Date header field in the 480 (Temporarily Unavailable) response to the INVITE request shall be supported at the roaming II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.24 Unstructured Supplementary Service Data (USSD) + +Service specific requirements in accordance with 3GPP TS 24.390 [163] shall be supported over the II-NNI. + +The Recv-Info header field containing the "g.3gpp.ussd" info package name and the "application/vnd.3gpp.ussd" MIME body as described in annex B of 3GPP TS 24.390 [163] in the INVITE request shall be supported at the roaming II-NNI. + +The Recv-Info header field containing the "g.3gpp.ussd" info package name in the 200 (OK) response to the INVITE request shall be supported at the roaming II-NNI. + +The INFO request containing "application/vnd.3gpp.ussd" MIME body and the Info-Package header field containing the "g.3gpp.ussd" info package name shall be supported at the roaming II-NNI. + +The "application/vnd.3gpp.ussd" MIME body in the BYE request shall be supported at the roaming II-NNI. + +## 12.25 Enhanced Calling Name (eCNAM) + +Service specific requirements in accordance with 3GPP TS 24.196 [217] shall be supported over the II-NNI. + +An initial INVITE request with: + +- a display-name in a From header field; +- a display-name in a P-Asserted-Identity header field; and +- Call-Info header field(s), + +shall be supported at the roaming II-NNI in the direction from home to visited network. + +## 12.26 Multi-Device and Multi-Identity (MuD and MiD) + +### 12.26.1 Multi-Device (MuD) + +Service specific requirements in accordance with 3GPP TS 24.174 [218] shall be supported over the II-NNI. + +NOTE: No specific SIP signalling requirements exist for MuD over the II-NNI. + +### 12.26.2 Multi-Identity (MiD) + +Service specific requirements in accordance with 3GPP TS 24.174 [218] shall be supported over the II-NNI. + +An initial INVITE request, a REFER request and a MESSAGE request with an Additional-Identity header field (as defined in 3GPP TS 24.229 [5] clause 7.2.20) shall be supported over the roaming II-NNI. + +# 13 Interoperability of IMS Centralized Services (ICS) over II-NNI + +## 13.1 General + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), the associated service of the IMS Centralized Services (ICS) may be supported on the II-NNI between two IMS networks. The support of ICS is based on agreement between operators. + +If ICS is supported, the related procedures from the 3GPP TS 24.292 [121] and 3GPP TS 29.292 [130] shall be applied with the requirements in the clause 13.2 due to the crossing of the II-NNI. + +## 13.2 IMS Centralized Services (ICS) + +Service specific requirements in accordance with 3GPP TS 24.292 [121] and 3GPP TS 29.292 [130] shall be supported over the II-NNI. + +The "g.3gpp.ics" media feature tag in the Contact header field as specified in annex B of 3GPP TS 24.292 [121] shall be supported at the roaming II-NNI. + +The "g.3gpp.accesstype" media feature tag in the Contact header field as specified in annex B of 3GPP TS 24.292 [121] shall be supported at the roaming II-NNI. + +The "g.3gpp.icsi-ref" media feature tag as specified in 3GPP TS 24.229 [5] the value for the IMS Multimedia Telephony Communication Service as specified in 3GPP TS 24.173 [31] shall be supported at the roaming II-NNI. + +An Accept-Contact header field and a Reject-Contact header field including the media feature tag "g.3gpp.accesstype" and the media feature tag "g.3gpp.ics" in any combination in the INVITE request shall be supported at the roaming II-NNI. + +The Target-Dialog header field in the INVITE request shall be supported at the roaming II-NNI. + +The P-Early-Media header field in the INVITE request and in non-100 provisional responses to the INVITE request shall be supported on the roaming II-NNI. + +The Reason header field containing the protocol value "Q.850" and the header field parameter "cause" with a various set of values in the CANCEL request, the BYE request and in 4xx responses and 6xx responses to the INVITE request shall be supported at the roaming II-NNI. + +The REFER request with the "method" SIP URI parameter set to the value "BYE" or "INVITE" or without the "method" SIP URI parameter in the Refer-To header field as specified in 3GPP TS 24.292 [121] shall be supported at the roaming II-NNI. + +The Event header field containing the event package name "conference" and the Accept header field with "application/conference-info+xml" in a SUBSCRIBE request shall be supported at the roaming II-NNI. + +The Allow-Event header field with "application/conference-info+xml" in an INVITE request shall be supported at the roaming II-NNI. + +The "application/conference-info+xml" MIME body and the Event header field containing the event package name "conference" in a NOTIFY request shall be supported at the roaming II-NNI. + +NOTE: Supplementary services as specified in clause 12 can be supported based on agreement between operators. + +# 14 Interoperability of IMS Service Continuity over II-NNI + +## 14.1 General + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), the associated services of the IMS Service Continuity may be supported on the II-NNI between two IMS networks. The support of each service is based on agreement between operators. + +If a service is supported, the related procedures from the 3GPP TS 24.237 [131] shall be applied with the requirements in the relevant clause below due to the crossing of the II-NNI. + +## 14.2 PS to CS Single Radio Voice Call Continuity (SRVCC) and Single Radio Video Call Continuity (vSRVCC) + +### 14.2.1 Basic PS to CS SRVCC + +Service specific requirements in accordance with 3GPP TS 24.237 [131] shall be supported over the roaming II-NNI. + +Media type "video" in SDP m-lines may be supported at the roaming II-NNI. Related SDP can appear in SDP offer answer exchanges within INVITE dialogues at the roaming II-NNI, and in responses to OPTIONS requests at the roaming II-NNI. If media type "video" is supported within INVITE dialogues at the roaming II-NNI, it shall also be supported within responses to OPTIONS requests at the roaming II-NNI. + +The "+g.3gpp.srvcc" header field parameter (specified in 3GPP TS 24.237 [131] annex C) in the Feature-Caps header field of the INVITE request and in non-100 provisional responses or the 2xx response should be supported at the roaming II-NNI. + +The Reason header field containing the protocol value set to "SIP" and "cause" header field parameter set to "487" in the re-INVITE request shall be supported at the roaming II-NNI. + +The Reason header field containing the protocol value set to "SIP" and "cause" header field parameter set to "503" in the BYE request shall be supported at the roaming II-NNI. + +Procedures as described in clause 14.4 are used to provide MSC server assisted mid-call features. + +### 14.2.2 PS to CS SRVCC for calls in alerting phase + +The requirements for the PS to CS transfer for alerting calls are the same as in clause 14.2.1 with the following additional requirements: + +The "g.3gpp.srvcc-alerting" media feature tag (described in 3GPP TS 24.237 [131] annex C) in a Contact header field of the INVITE request and in non-100 provisional responses and the 2xx response to the INVITE request shall be supported at the roaming II-NNI. + +The "+g.3gpp.srvcc-alerting" header field parameter (described in 3GPP TS 24.237 [131] annex C) included in a Feature-Caps header field as described in IETF RFC 6809 [143] in an INVITE request and in non-100 provisional responses and the 2xx response to the INVITE request or in the UPDATE request and in the 2xx response to the UPDATE request shall be supported at the roaming II-NNI. + +The Target-Dialog header field in the INVITE request shall be supported at the roaming II-NNI. + +An INFO request containing the Info-Package header field as specified in IETF RFC 6086 [39] with "3gpp.state-and-event" info package name and an "application/vnd.3gpp.state-and-event-info+xml" XML body shall be supported at the roaming II-NNI. + +### 14.2.3 Using the ATCF based architecture + +The requirements for the ATCF based architecture is the same as in clause 14.2.1 with the following additional requirements: + +The "+g.3gpp.atcf", the "+g.3gpp.atcf-mgmt-uri" and the "+g.3gpp.atcf-path" header field parameters (specified in 3GPP TS 24.237 [131] annex C) in the Feature-Caps header field of the REGISTER request as described in IETF RFC 6809 [143] shall be supported at the roaming II-NNI. + +A MESSAGE request containing the "application/vnd.3gpp.srvcc-info+xml" MIME body as defined in annex D of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +The URIs of SCC ASs authorised to provide PS to CS SRVCC information in the MESSAGE request need to be specified in the roaming agreement. + +The Target-Dialog header field in the INVITE request shall be supported at the roaming II-NNI. + +### 14.2.4 PS to CS SRVCC for originating calls in pre-alerting phase + +The requirements for the PS to CS transfer for originating calls in pre-alerting phase are the same as in clause 14.2.1 and in clause 14.2.2 with the additional requirements in this clause. + +NOTE: If PS to CS transfer for originating calls in pre-alerting phase is supported also PS to CS SRVCC for calls in alerting phase specified in clause 14.2.2 is supported. + +The "g.3gpp.ps2cs-srvcc-orig-pre-alerting" media feature tag described in 3GPP TS 24.237 [131] annex C in a Contact header field of the REGISTER request and in the INVITE request shall be supported at the roaming II-NNI. + +The "g.3gpp.ps2cs-srvcc-orig-pre-alerting" feature-capability indicator as described in 3GPP TS 24.237 [131] annex C in the Feature-Caps header field as described in IETF RFC 6809 [143] in non-100 provisional responses and the 2xx response to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +### 14.2.5 PS to CS SRVCC with the MSC server assisted mid-call feature + +The requirements for the PS to CS SRVCC with the assisted mid-call feature are the same as in clause 14.2.1 and in clause 14.4. + +### 14.2.6 PS to CS SRVCC for terminating calls in pre-alerting phase + +The requirements for the PS to CS transfer for terminating calls in pre-alerting phase are the same as in clause 14.2.1 and in clause 14.2.2 with the additional requirements in this clause. + +NOTE: If PS to CS transfer for terminating calls in pre-alerting phase is supported also PS to CS SRVCC for calls in alerting phase specified in clause 14.2.2 is supported. + +The "g.3gpp.ps2cs-srvcc-term-pre-alerting" media feature tag described in 3GPP TS 24.237 [131] annex C in a Contact header field of the REGISTER request and in the INVITE request shall be supported at the roaming II-NNI. + +The g.3gpp.ps2cs-srvcc-term-pre-alerting feature-capability indicator as described in 3GPP TS 24.237 [131] annex C in the Feature-Caps header field as described in IETF RFC 6809 [143] in non-100 provisional responses and the 2xx response to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +## 14.3 Inter UE Transfer (IUT) + +IUT is described in clause 18. + +## 14.4 MSC server assisted mid-call feature + +Service specific requirements in accordance with 3GPP TS 24.237 [131] shall be supported over the roaming II-NNI. + +The Contact header field of the REGISTER request and the 200 (OK) response containing "g.3gpp.mid-call" media feature tag as described in annex C of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +The Feature-Cap header field of the REGISTER request and the 200 (OK) response containing "+g.3gpp.mid-call" header field parameter specified in annex C of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +The media feature tag "g.3gpp.accesstype" in the Contact header field of the REGISTER request shall be supported at roaming II-NNI. + +A Contact header field of the INVITE request and the 200 (OK) response containing the "g.3gpp.mid-call" media feature tag as described in annex C of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +The "g.3gpp.mid-call" feature-capability indicator according to 3GPP TS 24.237 [131] annex C included in the Feature-Caps header field of the INVITE request, in responses to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +The Recv-Info header field containing the "g.3gpp.mid-call" package name in the INVITE request as specified in annex D of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +An Accept header field in the INVITE request containing the MIME type "application/vnd.3gpp.mid-call+xml" as specified in clause D.1 of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +The "application/vnd.3gpp.mid-call+xml" MIME body described in clause D.1.3 of 3GPP TS 24.237 [131] in the INVITE request shall be supported at the roaming II-NNI. + +The SUBSCRIBE request containing a "g.3gpp.mid-call" media feature tag in the Contact header field shall be supported at the roaming II-NNI. + +NOTE: The "g.3gpp.mid-call" media feature tag in the Contact header field of the SUBSCRIBE request may appear if the CONF supplementary service is supported at roaming II-NNI as described in clause 12.9. + +An INFO request containing the Info-Package header field as specified in IETF RFC 6086 [39] with "3gpp.state-and-event" info package name and an "application/vnd.3gpp.state-and-event-info+xml" XML body shall be supported at the roaming II-NNI. + +A REFER request sent inside an existing SIP dialog containing the "application/vnd.3gpp.mid-call+xml" MIME body specified in the clause D.1.3 of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +The Contact header field of the REFER request and the 2xx response to the request containing "g.3gpp.mid-call" media feature tag as described in annex C of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +The Target-Dialog header field in the INVITE request shall be supported at the roaming II-NNI. + +The communication HOLD supplementary service as specified in clause 12.8 for the roaming II-NNI shall be supported. + +The Allow-Event header field with "application/conference-info+xml" in an INVITE request shall be supported at the roaming II-NNI. + +The Event header field containing the event package name "conference" and the Accept header field with "application/conference-info+xml" in a SUBSCRIBE request shall be supported at the roaming II-NNI. + +The "application/conference-info+xml" MIME body and the Event header field containing the event package name "conference" in a NOTIFY request shall be supported at the roaming II-NNI. + +The REFER request with the "method" header field parameter set to the value "BYE" sent in the Refer-To header field shall be supported at the roaming II-NNI. + +## 14.5 CS to PS Single Radio Voice Call Continuity (SRVCC) + +### 14.5.1 Basic CS to PS SRVCC + +Service specific requirements in accordance with 3GPP TS 24.237 [131] shall be supported over the roaming II-NNI. + +Requirements for the ATCF based architecture at II-NNI as described in clause 14.2.3 shall be supported at the roaming II-NNI. + +Requirements for IMS Centralized Services (ICS) at II-NNI as described in clause 13 shall be supported at the roaming II-NNI. + +The "g.3gpp.cs2ps-srvcc" and "g.3gpp.path" media feature tags in the Contact header field of the REGISTER request shall be supported at the roaming II-NNI. + +The Feature-Caps header field with the "g.3gpp.cs2ps-srvcc" feature-capability indicator in the REGISTER request shall be supported at the roaming II-NNI. + +The MESSAGE request containing the Accept-Contact header field with the "g.3gpp.path" media feature tag and the "application/vnd.3gpp.srvcc-ext+xml" MIME body shall be supported at the roaming II-NNI. + +The URIs of SCC ASs authorised to provide CS to PS SRVCC information in the MESSAGE request need to be specified in the roaming agreement. + +### 14.5.2 CS to PS SRVCC for calls in alerting phase + +The requirements for the CS to PS SRVCC for calls in alerting phase are the same as in clause 14.5.1 with the following additional requirement: + +The "g.3gpp.cs2ps-srvcc-alerting" media feature tag in the Contact header field of the REGISTER request shall be supported at the roaming II-NNI. + +The REFER request sent inside an existing SIP dialog with the Refer-Sub header field and the "application/vnd.3gpp.state-and-event-info+xml" MIME body shall be supported at the roaming II-NNI. + +The INFO request with the Info-Package header field containing the "g.3gpp.state-and-event" package name and the "application/vnd.3gpp.state-and-event-info+xml" MIME body shall be supported at the roaming II-NNI. + +### 14.5.3 CS to PS SRVCC with the assisted mid-call feature + +The requirements for the CS to PS SRVCC with the assisted mid-call feature are the same as in clause 14.5.1 with the following additional requirement: + +The "application/vnd.3gpp.access-transfer-events+xml" MIME body in the REFER request shall be supported at the roaming II-NNI. + +## 14.6 PS to CS dual radio voice call continuity (DRVCC) + +### 14.6.1 Basic PS to CS DRVCC + +Service specific requirements in accordance with 3GPP TS 24.237 [131] shall be supported over the roaming II-NNI. + +The "g.3gpp.dynamic-stn" media feature tag according to 3GPP TS 24.237 [131] annex C included in the Contact header field of the INVITE request and in responses to the INVITE request shall be supported at the roaming II-NNI. + +The "g.3gpp.dynamic-stn" feature-capability indicator according to 3GPP TS 24.237 [131] annex C included in the Feature-Caps header field of the INVITE request, in responses to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +NOTE 1: The g.3gpp.dynamic-stn feature capability indicator from the home network contains an STN. The STN is a tel URI that the UE will use when establishing the call in CS. If the STN is known by the visited network the STN can also be used to identify that a call from a UE is a PS to CS dual radio access transfer allowing the visited network to suppress services and announcement that otherwise is executed during the CS call setup. The value of the tel URI STN needs to be communicated between operators when DRVCC is supported. + +The requirements for providing IMS Centralized Services (ICS) as described in clause 13.2 should be supported at the roaming II-NNI. + +NOTE 2: The support of IMS Centralized Services (ICS) as described in clause 13.2 is only needed if MSC servers in the visited network are enhanced for ICS. + +### 14.6.2 PS to CS DRVCC with the assisted mid-call feature + +The requirements for the PS to CS DRVCC with the assisted mid-call feature are the same as in clause 14.6.1 and in clause 14.4. + +NOTE: Transfer of an additional call requires the use of IMS Centralized Services (ICS). + +### 14.6.3 PS to CS DRVCC for calls in alerting phase + +The requirements for the PS to CS DRVCC for calls in alerting phase are the same as in clause 14.6.1 with the additional requirements in this clause. + +The "g.3gpp.drvcc-alerting" media feature tag according to 3GPP TS 24.237 [131] annex C and IETF RFC 3840 [56] included in the Contact header field of the INVITE request and in responses to the INVITE request shall be supported at the roaming II-NNI. + +The "g.3gpp.drvcc-alerting" feature-capability indicator according to 3GPP TS 24.237 [131] annex C included in the Feature-Caps header field of the INVITE request, in responses to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +A 488 (Not Acceptable Here) response to the INVITE request without an SDP body shall be supported at the roaming II-NNI. + +### 14.6.4 PS to CS DRVCC for originating calls in pre-alerting phase + +The requirements for the PS to CS DRVCC for originating calls in pre-alerting phase are the same as in clause 14.6.1 and in clause 14.6.3 with the additional requirements in this clause. + +The "g.3gpp.ps2cs-drvcc-orig-pre-alerting" media feature tag according to 3GPP TS 24.237 [131] annex C and IETF RFC 3840 [56] in the Contact header field of the INVITE request shall be supported at the roaming II-NNI. + +The "g.3gpp.ps2cs-drvcc-orig-pre-alerting" feature-capability indicator according to 3GPP TS 24.237 [131] annex C included in the Feature-Caps header field of the INVITE request, in responses to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +## 14.7 CS to PS Dual Radio Voice Call Continuity (DRVCC) + +### 14.7.1 Basic CS to PS DRVCC + +Service specific requirements in accordance with 3GPP TS 24.237 [131] shall be supported over the roaming II-NNI. + +The requirements for providing IMS Centralized Services (ICS) as described in clause 13.2 should be supported at the roaming II-NNI. + +NOTE: The support of IMS Centralized Services (ICS) as described in clause 13.2 is only needed if MSC servers in the visited network are enhanced for ICS. + +### 14.7.2 CS to PS DRVCC with the assisted mid-call feature + +The requirements for the PS to CS DRVCC with the assisted mid-call feature are the same as in clause 14.7.1 and in clause 14.4. + +### 14.7.3 CS to PS DRVCC for calls in alerting phase + +The requirements for the CS to PS DRVCC for calls in alerting phase are the same as in clause 14.7.1 with the additional requirements in this clause. + +The "g.3gpp.cs2ps-drvcc-alerting" media feature tag as described included in the Contact header field of the INVITE request and in responses to the INVITE request shall be supported at the roaming II-NNI. + +The "g.3gpp.cs2ps-drvcc-alerting" feature-capability indicator according to 3GPP TS 24.237 [131] annex C included in the Feature-Caps header field of the INVITE request, in responses to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +A 488 (Not Acceptable Here) response to the INVITE request without an SDP body shall be supported at the roaming II-NNI. + +### 14.7.4 CS to PS DRVCC for originating calls in pre-alerting phase + +The requirements for the CS to PS DRVCC for originating calls in pre-alerting phase are the same as in clause 14.7.1 and in clause 14.7.3 with the following additional requirements: + +The "g.3gpp.cs2ps-drvcc-orig-pre-alerting" media feature tag according to 3GPP TS 24.237 [131] annex C and IETF RFC 3840 [56] in the Contact header field of the INVITE request shall be supported at the roaming II-NNI. + +The "g.3gpp.cs2ps-drvcc-orig-pre-alerting" feature-capability indicator according to 3GPP TS 24.237 [131] annex C included in the Feature-Caps header field of the INVITE request, in responses to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +## 14.8 PS to PS access transfer + +Service specific requirements in accordance with 3GPP TS 24.237 [131] clause 10 shall be supported over the roaming II-NNI. + +The "g.3gpp.pstops-sti" media feature tag in the Contact header field of the REGISTER request shall be supported at the roaming II-NNI. + +The INVITE request containing: + +- a) the "g.3gpp.ics" media feature tag; and +- b) either: + - the Replaces header field and the option tag value "replaces" in the Require header field; or + - the Target-Dialog header field and the option tag value "tdialog" in the Require header field, + +shall be supported at the roaming II-NNI. + +A Recv-Info header field containing the "g.3gpp.state-and-event" info package name in the 183 (Session Progress) response shall be supported at the roaming II-NNI. + +The INFO request containing the Info-Package header field as specified in IETF RFC 6086 [39] with the "g.3gpp.state-and-event" info package name and the "application/vnd.3gpp.state-and-event-info+xml" XML body shall be supported at the roaming II-NNI. + +# 15 Presence service + +## 15.0 General + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), the associated functions of the Presence service may be supported on the II-NNI between two IMS networks. The support of each function is based on agreement between operators. + +If a function is supported, the related procedures from the 3GPP TS 24.141 [132] shall be applied with the requirements in the relevant clause below due to the crossing of the II-NNI. + +## 15.1 Subscription of presence information + +Service specific requirements in accordance with 3GPP TS 24.141 [132] shall be supported over the II-NNI. + +A PUBLISH request identifying the presentity using a SIP URI, a tel URI or a PRES URI and the Event header field with the value "presence" and containing an "application/pidf+xml" MIME body shall be supported at the roaming II-NNI. + +Additionally to the above and in any combination, a Content-Type header field with the value "multipart/related" and an "application/pidf-diff+xml" MIME body can be included in the PUBLISH request and shall be supported at the roaming II-NNI. + +A SUBSCRIBE request with a Request-URI containing a SIP URI, a tel URI or a pres URI, the Event header field set to "presence" and Accept header fields with values "application/pidf+xml" and "multipart/related" shall be supported at the II-NNI. + +Additionally to the above an "application/simple-filter+xml" MIME body can appear in the SUBSCRIBE request and shall be supported at the II-NNI. + +Additionally to the above and in any combination a Content-Type header field with the value "multipart/mixed" and an "application/resource-lists" MIME body can appear in the SUBSCRIBE request and shall be supported at the roaming II-NNI. + +A NOTIFY request including an Event header field with the value "presence" and an "application/pidf" MIME body shall be supported at the II-NNI. + +NOTE: The NOTIFY request can contain substantial amount of data and TCP is expected to be used as the transport protocol. + +The Allow-Events header field with the value "presence" shall be supported at the roaming II-NNI and may be supported at the non-roaming II-NNI. + +## 15.2 Watcher subscribing to Presence List + +Service specific requirements in accordance with 3GPP TS 24.141 [132] shall be supported over the II-NNI. + +The requirements for the watcher subscribing to the Presence List are the same as subscribing to presence information as specified in clause 15.1 with the following additional requirement: + +- The SUBSCRIBE request containing a Supported header field with the value "eventlist" shall also be supported at the roaming II-NNI; +- The SUBSCRIBE request containing a Accept header field with the value "application/rlmi+xml" shall be supported at the roaming II-NNI; +- A response code 200 (OK) to the SUBSCRIBE request containing the Require header field with the value "eventlist" shall be supported at the roaming II-NNI; and + +- A NOTIFY message containing the "multipart/related" content type and an "application/rlmi+xml" MIME body shall be supported at the roaming II-NNI. + +NOTE: The NOTIFY request can contain substantial amount of data and TCP is expected to be used as the transport protocol. + +## 15.3 Subscription to Watcher Information + +Service specific requirements in accordance with 3GPP TS 24.141 [132] shall be supported over the II-NNI. + +A SUBSCRIBE request containing an Event header field with the value "presence.wininfo" and an Accept header field with value "application/watcherinfo+xml" shall be supported at the roaming II-NNI. + +A NOTIFY request containing the Event header field with the value "presence.wininfo" and an "application/watcherinfo+xml" MIME body shall be supported at the roaming II-NNI. + +NOTE: The NOTIFY request can contain substantial amount of data and TCP is expected to be used as the transport protocol. + +The Allow-Events header field with the value "presence.wininfo" shall be supported at the roaming II-NNI and may be supported at the non-roaming II-NNI. + +## 15.4 Subscription to state changes in XML documents + +Service specific requirements in accordance with 3GPP TS 24.141 [132] shall be supported over the II-NNI. + +A SUBSCRIBE request containing the Event header field with the value "xcap-diff" and parameters specified in IETF RFC 5875 [134], using the updated procedures from IETF RFC 6665 [20], shall be supported at the roaming II-NNI. + +A NOTIFY request containing the Event header field with the value "xcap-diff", the Content-Type header field with the value "multipart/mixed" and any MIME body shall be supported at the roaming II-NNI. + +NOTE: The NOTIFY request can contain substantial amount of data and TCP is expected to be the transport protocol. + +The Allow-Events header field with the value "xcap-diff" shall be supported at the roaming II-NNI and may be supported at the non-roaming II-NNI. + +For backward compatible reasons the Event header field with the value "ua-profile" should be supported at the roaming II-NNI. + +## 15.5 Presence enhancements specified in Open Mobile Alliance (OMA) Release 1.1 + +### 15.5.1 General + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), the associated functions of the OMA Presence service may be supported on the II-NNI between two IMS networks. The support of each function is based on agreement between operators. + +If a function of the OMA Presence Release 1.1 is supported, the related procedures from the OMA-TS-Presence\_SIMPLE-V1\_1\_1 [142] shall be applied with the requirements in the relevant clause below due to the crossing of the II-NNI. + +### 15.5.2 OMA subscription of presence information + +The requirements for the OMA subscription of presence information are the same as clause 15.1. + +### 15.5.3 OMA watcher subscribing to Presence List + +The requirements for the OMA watcher subscribing to Presence List are the same as clause 15.2. + +### 15.5.4 OMA subscription to Watcher Information + +The requirements for the OMA subscription to Watcher Information are the same as clause 15.3. + +## 15.6 Presence enhancements specified in Open Mobile Alliance (OMA) Release 2.0 + +### 15.6.1 General + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), the associated functions of the OMA Presence service may be supported on the II-NNI between two IMS networks. The support of each function is based on agreement between operators. + +If a function of the OMA Presence Release 2.0 is supported, the related procedures from the OMA-TS-Presence\_SIMPLE-V2\_0 [138] shall be applied with the requirements in the relevant clause below due to the crossing of the II-NNI. + +### 15.6.2 OMA subscription of presence information + +The requirements for the OMA subscription of presence information are the same as clause 15.5.2 with the following additional requirement: + +- An Allow header field containing the value "REFER" in a PUBLISH request shall be supported at the II-NNI. +- A Policy-Contact header field defined in IETF RFC 6794 [133] in a 488 (Not Acceptable Here) response to a PUBLISH request shall be supported at the II-NNI. + +NOTE: Conveyance of this header field in a 488 response to a PUBLISH request is not supported by IETF RFC 6794 [133] but is required to support Presence services according to OMA specifications OMA-TS-Presence\_SIMPLE-V2\_0 [138]. + +- A Suppress-If- Match header field in a SUBSCRIBE request shall be supported at the II-NNI. +- An Accept-Encoding header field containing the value "gzip" in a SUBSCRIBE request shall be supported at the II-NNI. +- An "application/vnd.oma.supnot+xml" MIME body in a SUBSCRIBE request shall be supported at the II-NNI. +- A Content-Encoding header field containing the value "gzip" in a NOTIFY request shall be supported at the II-NNI. +- A Content-Type header field with the value "multipart/mixed" in a SUBSCRIBE request shall be supported at the II-NNI. +- A Refer-To header field with the value "method=PUBLISH?event=presence", a Refer-Sub header field and a SIP-If-Match header field in a REFER request shall be supported at the II-NNI. + +### 15.6.3 OMA watcher subscribing to Presence List + +The requirements for the OMA watcher subscribing to Presence List are the same as clause 15.5.3 with the following additional requirements: + +- A Suppress-If-Match header field in a SUBSCRIBE request shall be supported at the II-NNI. +- An Accept-Encoding header field containing the value "gzip" in a SUBSCRIBE request shall be supported at the II-NNI. + +- An "application/vnd.oma.supnot+xml" MIME body in a SUBSCRIBE request shall be supported at the II-NNI. +- An "application/resource-lists+xml" MIME body in a SUBSCRIBE request shall be supported at the II-NNI. +- A Content-Type header field with the value "multipart/mixed" in a SUBSCRIBE request shall be supported at the II-NNI. +- A NOTIFY request with a Content-Encoding header field containing the value "gzip" shall be supported at the II-NNI. + +### 15.6.4 OMA subscription to Watcher Information + +The requirements for the OMA subscription to Watcher Information are the same as clause 15.5.4 with the following additional requirements: + +- Indicating support for "multipart/mixed" and "application/simple-filter+xml" in the Accept header field of the SUBSCRIBE request shall be supported at the II-NNI. +- Multiple "application/simple-filter+xml" MIME bodies in the NOTIFY request shall be supported at the II-NNI. +- A Suppress-If-Match header field in a SUBSCRIBE request shall be supported at the II-NNI. +- An Accept-Encoding header field containing the value "gzip" in the SUBSCRIBE request shall be supported at the II-NNI. +- A Content-Type header field with the value "multipart/mixed" in a NOTIFY request shall be supported at the II-NNI. +- A Content-Encoding header field with the value "gzip" in a NOTIFY request shall be supported at the II-NNI. +- A Refer-To header field with the value "method=SUBSCRIBE?Event=presence.wininfo" and a Refer-Sub header field in a REFER request sent to a Watcher Information Subscriber shall be supported at the II-NNI. + +### 15.6.5 Subscription to state changes in XML documents + +The requirements for the OMA watcher subscribing to Presence List are the same as clause 15.4 with the following additional requirements: + +- An Accept header field indicating the support for "application/xcap-diff+xml", "application/rlmi+xml" and "multipart/related" in a SUBSCRIBE request shall be supported at the II-NNI. +- An Accept-Encoding header field with the value "gzip" in a SUBSCRIBE request shall be supported at the II-NNI. +- A Content-Encoding header field containing the value "gzip" in a NOTIFY request shall be supported at the II-NNI. +- Multiple "multipart/related" MIME bodies in a NOTIFY request shall be supported at the II-NNI. +- An "application/rlmi+xml" MIME bodies in a NOTIFY request shall be supported at the II-NNI. + +15.6.6 Void + +15.6.7 Void + +# --- 16 Messaging service + +## 16.1 General + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), the associated function of the messaging service may be supported on the II-NNI between two IMS networks. + +If a function is supported, the related procedures from the 3GPP TS 24.247 [139] shall be applied with the requirements in the relevant clause below due to the crossing of the II-NNI. + +## 16.2 Page-mode messaging + +Service specific requirements in accordance with clause 5 of 3GPP TS 24.247 [139] shall be supported over the II-NNI. + +A MESSAGE request containing the "application/recipient-list" MIME body specified in IETF RFC 5365 [67], a Required header field with the 'recipient-list-message' option-tag; and a body carrying payload shall be supported at the roaming II-NNI. + +A MESSAGE request containing: + +- a body that carrying payload; or +- the "application/im-iscomposing+xml" MIME body, + +shall be supported at the II-NNI. + +The response code 415 (Unsupported Media Type) and the response code 202 (Accepted) shall be supported at the II-NNI. + +## 16.4 Session-mode messaging + +Service specific requirements in accordance with clause 6 of 3GPP TS 24.247 [139] shall be supported over the II-NNI. + +No restrictions at the II-NNI identified. + +## 16.5 Session-mode messaging conferences + +Service specific requirements in accordance with clause 7 of 3GPP TS 24.247 [139] and 3GPP TS 24.147 [106] shall be supported over the II-NNI. + +The "application/resource-lists+xml" MIME body included in the INVITE request shall be supported at the roaming II-NNI. + +The media feature tag "isfocus" in the Contact header field of the INVITE request and responses to the INVITE request shall be supported at the II-NNI. + +The SUBSCRIBE request including the "conference" event package name in the Event header field and the Accept header field containing an "application/conference-info+xml" MIME type shall be supported at the II-NNI. + +The NOTIFY request including an "application/conference-info+xml" MIME body shall be supported at the II-NNI. + +The REFER request containing a Referred-By header field and NOTIFY requests procedures shall be supported at the II-NNI. + +The REFER request containing the BYE method URI parameter in the Refer-To header field shall be supported at the II-NNI. + +The Referred-By header field in the INVITE request shall be supported at the II-NNI. + +The Allow-Events header field in the INVITE request with the value "conference" shall be supported at the roaming II-NNI and may be supported at the non-roaming II-NNI. + +# --- 17 Optimal Media Routeing + +## 17.1 General + +Based on inter-operator agreement, the Optimal Media Routeing (OMR) procedures may be supported over the II-NNI. + +If OMR procedures are supported, the procedures in 3GPP TS 29.079 [148] shall be applied and the capabilities below shall be provided at the II-NNI. + +## 17.2 OMR related SDP attributes + +The "visited-realm", "secondary-realm", "omr-codecs", "omr-m-att", "omr-s-att", "omr-m-bw", "omr-s-bw", "omr-s-cksum", and "omr-m-cksum" SDP attributes defined in 3GPP TS 24.229 [5] shall be supported at the II-NNI. + +## 17.3 IP realm names + +Operators need to agree on unique names for IP realms (as defined in 3GPP TS 29.079 [148]) used in their own and interconnecting networks to avoid a collision of IP realm names. Operators may choose to share an IP realm, and shall then also assign a single unique name to that realm. As defined in 3GPP TS 24.229 [5], a public IPv4 or IPv6 address reachable from the open internet is associated with the special realm "IN". + +# --- 18 Inter-UE transfer (IUT) + +## 18.1 General + +Inter-UE transfer may be supported over the II-NNI. The IUT consist of several functional blocks, as described in the clauses below. The support of each of these functional blocks is based on agreement between operators. + +If a function is supported, the related procedures from the 3GPP TS 24.337 [149] shall be applied with the requirements in the relevant clause below. + +## 18.2 IUT without establishment of a collaborative session + +Service specific requirements in accordance with 3GPP TS 24.337 [149] shall be supported over the II-NNI. + +The REFER request shall be supported at the roaming II-NNI. + +The Refer-To header field containing a body parameter including a Replaces header field and the Require header field set to "replaces" shall be supported at the roaming II-NNI. + +The Refer-To header field containing a body parameter including a Target-Dialog header field and the Require header field set to "tdialog" shall be supported at the roaming II-NNI. + +The Refer-To header field containing a body parameter including an Accept-Contact header field with the "g.3gpp.icsi-ref" media feature tag and a P-Preferred-Service header field set to the IMS communication service identifier shall be supported at the roaming II-NNI. + +The Contact header field of the REFER request containing a public GRUU or temporary GRUU as specified in 3GPP TS 24.229 [5] shall be supported at the roaming II-NNI. + +The "g.3gpp.icsi-ref" media feature tag in the Accept-Contact header field of the REFER request shall be supported at the roaming II-NNI. + +NOTIFY requests containing a "sipfrag" MIME body as specified in IETF RFC 3515 [22], using the updated procedures from IETF RFC 6665 [20], shall be supported at the roaming II-NNI. + +## 18.3 IUT using a collaborative session + +### 18.3.1 Collaborative session of participants of the same subscription + +This clause describes the requirements at the II-NNI for an ongoing session. Service specific requirements in accordance with 3GPP TS 24.337 [149] shall be supported over the II-NNI. + +The "g.3gpp.iut-controller" media feature tag in the Accept-Contact header field in the REGISTER request shall be supported. + +A REFER request sent outside an existing dialog shall be supported at the roaming II-NNI with the following additional requirements: + +- The Refer-To header field containing a body parameter including a MIME sdp body and no method parameter, the method parameter set to "INVITE" or "BYE" shall be supported at the roaming II-NNI. +- The Accept header field containing the MIME type "message/sipfrag" in the REFER request shall be supported at the roaming II-NNI. +- The Target-Dialog header field in the REFER request shall be supported at the roaming II-NNI. +- The Contact header field in the REFER request containing the "g.3gpp.iut-controller" media feature tag as described in annex B of 3GPP TS 24.337 [149] shall be supported at the roaming II-NNI. +- The Contact header field in the REFER request containing the "g.3gpp.current-iut-controller" media feature tag as described in annex B of 3GPP TS 24.337 [149] shall be supported at the roaming II-NNI. +- The "g.3gpp.iut-controller" media feature tag in the Accept-Contact header field shall be supported at the roaming II-NNI. +- The Referred-By header field shall be supported at the roaming II-NNI at the roaming II-NNI. + +The NOTIFY request containing a "sipfrag" MIME body as specified in IETF RFC 3515 [22], using the updated procedures from IETF RFC 6665 [20], shall be supported at the roaming II-NNI. + +Initial INVITE requests and re-INVITE requests as follows: + +- The Referred-By header field included in initial INVITE requests and re-INVITE requests shall be supported at the roaming II-NNI; +- The "g.3gpp.iut-controller" media feature tag as described in annex B of 3GPP TS 24.337 [149] in the Contact header field shall be supported at the roaming II-NNI. + +The "g.3gpp.iut-controller" media feature tag in responses to the INVITE request shall be supported at the roaming II-NNI. + +The SUBSCRIBE request including the Event header field with the "dialog" event package; and including the Accept-Contact header field with the "g.3gpp.iut-focus" media feature shall be supported at the roaming II-NNI. + +The "dialog-info+xml" MIME body in NOTIFY requests shall be supported at the roaming II-NNI. + +### 18.3.2 Establishment of a collaborative session during session setup + +Service specific requirements in accordance with 3GPP TS 24.337 [149] shall be supported over the II-NNI. + +The Accept header field containing the MIME type "application/vnd.3gpp.iut+xml" in initial INVITE requests shall be supported at the roaming II-NNI. + +A Content-Type header field containing the MIME type "application/vnd.3gpp.iut+xml" and an "application/vnd.3gpp.iut+xml" MIME body in the 300 (Multiple Choices) response shall be supported at the roaming II-NNI. + +### 18.3.3 Assignment and transfer of control of a collaborative session + +Service specific requirements in accordance with 3GPP TS 24.337 [149] shall be supported over the II-NNI. + +The "g.3gpp.current-iut-controller" media feature tag in the Contact header field of the 200 (OK) response to INVITE request shall be supported at the roaming II-NNI. + +A "multipart/mixed" MIME body containing the "application/vnd.3gpp.iut+xml" and the "application/sdp" MIME bodies in the INVITE request shall be supported at the roaming II-NNI. + +### 18.3.4 Collaborative session of participants of different subscriptions + +Service specific requirements in accordance with 3GPP TS 24.337 [149] shall be supported over the II-NNI. + +In addition to the requirements in clause 18.3.1, 18.3.2 or 18.3.3 the following applies: + +- The "g.3gpp.iut-focus" media feature tag (specified in 3GPP TS 24.337 [149] annex B) in the Contact header field shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. +- The "+g.3gpp.iut-focus" header field parameter (specified in 3GPP TS 24.337 [149] annex B) in the Feature-Caps header field as described in IETF RFC 6809 [143] shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +## 18.4 Session replication / media replication + +### 18.4.1 Pull mode + +Service specific requirements in accordance with 3GPP TS 24.337 [149] shall be supported over the II-NNI. + +The Target-Dialog header field and the Accept-Contact header field containing the "g.3gpp.iut-focus" media feature tag of the INVITE request shall be supported at the roaming II-NNI. + +A REFER request including: + +- the method parameter set to "MESSAGE" in the Refer-To header field; +- the In-Reply-To header field; +- the Target-Dialog header field; +- the Require header field populated with the option tag value "tdialog"; and +- the "application/vnd.3gpp.replication+xml" MIME body, + +shall be supported at the roaming II-NNI. + +A MESSAGE request including the In-Reply-To header field and the "application/vnd.3gpp.replication+xml" MIME body shall be supported at the roaming II-NNI. + +### 18.4.2 Push mode + +Service specific requirements in accordance with 3GPP TS 24.337 [149] shall be supported over the II-NNI. + +A REFER request including: + +- the Accept-Contact header field containing the "g.3gpp.iut-focus" media feature tag with explicit and require tags; +- the Target-Dialog header field; and +- the Refer-To header field containing the Accept-Contact header field, the P-Preferred-Service header field and the "application/sdp" MIME body, + +shall be supported at the roaming II-NNI. + +The "application/vnd.3gpp.replication+xml" MIME body of the REFER request shall be supported at the roaming II-NNI. + +# --- 19 Roaming Architecture for Voice over IMS with Local Breakout + +Based on inter-operator agreement, the roaming architecture for voice over IMS with local breakout procedure may be supported over the II-NNI. + +If the roaming architecture for voice over IMS with local breakout procedure is supported, the procedures in 3GPP TS 24.229 [5] shall be applied and the capabilities below shall be provided at the II-NNI. + +The "+g.3gpp.trf" header field parameter (defined in 3GPP TS 24.229 [5] clause 7.9A.3) with a TRF address included in a Feature-Caps header field as described in IETF RFC 6809 [143] in the INVITE request or in the UPDATE request and in the 2xx response to the UPDATE request shall be supported at the roaming II-NNI. + +The "+g.3gpp.loopback" header field parameter (defined in 3GPP TS 24.229 [5] clause 7.9A.4) with the identity of the caller's home network included in the Feature-Caps header field as described in IETF RFC 6809 [143] in the INVITE request or in the UPDATE request and in the 2xx response to the UPDATE request shall be supported for the loopback traversal scenario. + +The "loopback-indication" header field parameter (defined in 3GPP TS 24.229 [5] clause 7.2A.5) included the P-Charging-Vector header field in 18x and 2xx responses to the INVITE request , in subsequent requests and in responses to subsequent requests shall be supported for the loopback traversal scenario and at the roaming II-NNI. + +The procedures in clause 17 shall be supported at the II-NNI. + +# --- 20 Delivery of Media Resource Broker address information + +Based on inter-operator agreement, the procedure to deliver MRB address information may be supported over the roaming II-NNI. + +NOTE: Subsequent interaction between home network MRB and visited network MRB is outside the scope of this document. + +If the procedure to enable optimised allocation of media resources is supported, the procedures in 3GPP TS 24.229 [5] shall be applied and the capabilities below shall be provided at the roaming II-NNI. + +The "g.3gpp.mrb" feature-capability indicator (defined in 3GPP TS 24.229 [5] clause 7.9A.6) with the MRB address included in the Feature-Caps header field as described in IETF RFC 6809 [143] in the INVITE request or in the UPDATE request and in the 2xx response to the UPDATE request shall be supported at the roaming II-NNI. + +# --- 21 Overload control + +## 21.1 General + +Based on inter-operator agreement, overload control may be supported over the II-NNI. + +The overload control defines two optional mechanisms: + +- a feedback based mechanism; +- and a load filter mechanism. + +The support of either one of the mechanism is based on operator agreements. + +If a mechanism is supported, the related procedures from the 3GPP TS 24.229 [5] shall be applied with the requirements in the relevant clause below. + +Based on regional/national requirements and inter-operator agreement, Multimedia Priority Service (MPS), as specified in 3GPP TS 22.153 [187], shall be exempted from SIP overload controls across II-NNI up to the point where further exemption would cause network instability. + +## 21.2 Feedback based mechanism + +The procedures in 3GPP TS 24.229 [5] shall be applied and the capabilities below shall be provided at the II-NNI. + +The feedback based mechanism, defined in IETF RFC 7339 [165], requires no additional support at the II-NNI as it is supported using header field parameters within existing header fields supported at the II-NNI. + +**NOTE:** An algorithm will need to be selected. The IETF RFC 7339 [165] also defines the default algorithm for usage of the feedback based mechanism in the IM CN subsystem. Additional algorithms are either already defined, e.g. the rate-based scheme defined in IETF RFC 7415 [166], or can also be defined in the future. + +## 21.3 The load filter mechanism + +The procedures in 3GPP TS 24.229 [5] shall be applied and the capabilities below shall be provided at the II-NNI. + +A SUBSCRIBE request containing the Event header field "load-control" and, optionally, an Accept header field containing the "application/load-control+xml" MIME type as defined in IETF RFC 7200 [167] shall be supported on the II-NNI. + +**NOTE:** The addresses to targets that can be supervised need to form part of the service level agreement. + +A NOTIFY request containing the "application/load-control+xml" MIME body defined in IETF RFC 7200 [167] shall be supported on the II-NNI. + +# --- 22 Delivery of original destination identity + +Based on inter-operator agreement, the procedure to deliver original identity may be supported over the II-NNI. + +**NOTE:** Service requirement related to the procedure is available in 3GPP TS 22.228 [9]. + +If the procedure to enable delivery of original destination identity is supported, the procedures in 3GPP TS 24.229 [5] shall be supported as further specified below. + +The "mp" header field parameter in the History-Info header field of the initial INVITE request, as defined in IETF RFC 7044 [25], shall be supported over the II-NNI. + +# 23 Telepresence using IMS + +Based on inter-operator agreement, the procedure to support telepresence using IMS may be supported over the II-NNI. + +NOTE: Service requirement related to the procedure is available in clause 7.10.2.2 of 3GPP TS 22.228 [9]. + +If the telepresence using IMS is supported, the procedures in 3GPP TS 24.103 [189] shall be applied and the capabilities below shall be provided at the II-NNI. + +The "+sip.clue" header field parameter included in a Contact header field as described in 3GPP TS 24.103 [189] in the INVITE request or in the UPDATE request and in the 2xx response to the UPDATE request shall be supported at the II-NNI. + +# 24 Barring of premium rate numbers + +Based on inter-operator agreement, barring of premium rate numbers as described in 3GPP TS 24.315 [191] may be supported over the II-NNI. + +If barring of premium rate numbers is supported, the "premium-rate" tel URI parameter defined in 3GPP TS 24.229 [5] clause 7.2A.17 shall be supported at the roaming II-NNI. + +# 25 P-CSCF restoration + +## 25.1 General + +Based on inter-operator agreement, P-CSCF restoration may be supported over the II-NNI. + +The P-CSCF restoration defines two optional mechanisms: + +- a PCRF or PCF based mechanism; and + +NOTE 1: In 5GS the mechanism is called "PCF based P-CSCF restoration" since the PCF takes the role of the PCRF. + +- an HSS or UDM/HSS based mechanism. + +NOTE 2: In 5GS the mechanism is called "UDM/HSS based P-CSCF restoration" since the UDM participates in the procedure. + +The support of either one of the mechanisms is based on operator agreements. + +If a mechanism is supported, the related procedures from the 3GPP TS 24.229 [5] shall be applied with the requirements in the relevant clause below. + +## 25.2 PCRF or PCF based P-CSCF restoration + +The procedures in 3GPP TS 24.229 [5] shall be applied and the capabilities below shall be provided at the II-NNI. + +The Restoration-Info header field containing IMSI information defined in 3GPP TS 24.229 [5] in the home-to-visited initial INVITE request shall be supported on the roaming II-NNI. + +## 25.3 HSS or UDM/HSS based P-CSCF restoration + +The procedures in 3GPP TS 24.229 [5] shall be applied and the capabilities below shall be provided at the II-NNI. + +The Restoration-Info header field containing information about failed node defined in 3GPP TS 24.229 [5] in the 408 (Request Timeout) response to the home-to-visited initial INVITE request and in the 504 (Server Time-out) response to + +the MESSAGE request, NOTIFY request, OPTIONS request, PUBLISH request, REFER request and the SUBSCRIBE request shall be supported on the roaming II-NNI. + +# --- 26 Resource sharing + +Based on inter-operator agreement, resource sharing may be supported over the II-NNI. + +If resource sharing is supported, the related procedures from the 3GPP TS 24.229 [5] shall be applied with the requirements in this clause. + +The Resource-Share header field shall be supported on the roaming II-NNI in the following SIP requests and SIP responses: + +- the ACK request, the INVITE request, the PRACK request, the REGISTER and UPDATE; +- 18x responses to the INVITE request; and +- 2xx responses to the PRACK request, INVITE request and the UPDATE request. + +# --- 27 Service access number translation + +Based on inter-operator agreement, service access number translation may be supported over the II-NNI. + +If service access number translation is supported, the related procedures in 3GPP TS 24.229 [5] shall be applied with the requirements in this clause. + +The Request-URI containing a "cause" SIP URI parameter, defined in IETF RFC 4458 [58], set to the value "380" defined in IETF RFC 8119 [193] shall be supported at the II-NNI. + +The History-Info header field containing a "cause" SIP URI parameter, defined in IETF RFC 4458 [58], set to the value "380" defined in IETF RFC 8119 [193] shall be supported at the II-NNI. + +# --- 28 Mission critical services + +## 28.1 General + +In order to assure the end-to-end service interoperability through the II-NNI, the associated services of the Mission Critical communication may be supported on the II-NNI. The support of mission critical services is based on the business relationships defined in 3GPP TS 23.280 [200] clause 6. + +II-NNI requirements for SIP signalling related to mission critical services interface SIP-1 and SIP-3 (see figure 7.3.1-2 in 3GPP TS 23.280 [200]) are addressed in the present specification as follows: + +- Apart from differences specified in the present clause 28, the SIP-1 interface is identical to the roaming II-NNI. +- Apart from differences specified in the present clause 28, the SIP-3 interface is identical to the non-roaming II-NNI. + +SIP signalling traversing the NNI between an mission critical services server and a SIP core (interface SIP-2 in figure 7.3.1-2 in 3GPP TS 23.280 [200]) is not considered in the present release of this specification. + +The mission critical services are identified by means of the following IMS Communication Service Identifiers: + +- 1) for MCPTT, the "urn:urn-7:3gpp-service.ims.icsi.mcptt" URN (defined in annex E of 3GPP TS 24.379 [201]) ; +- 2) for mission critical video communications, the "urn:urn-7:3gpp-service.ims.icsi.mcvideo" URN (defined in annex E of 3GPP TS 24.281 [210]); and + +- 3) for mission critical data communications, the "urn:urn-7:3gpp-service.ims.icsi.mcdata" URN (defined in annex C of 3GPP TS 24.282 [211]) and additionally: + - for Short Data Service (SDS), the "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" URN (defined in annex C of 3GPP TS 24.282 [211]); and + - for File Distribution (FD), the "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" URN (defined in annex C of 3GPP TS 24.282 [211]). + +The IMS Communication Service Identifiers listed above can appear in: + +- the media feature tag "g.3gpp.icsi-ref" (specified in 3GPP TS 24.229 [5] clause 7.9.2) in the Contact header field and the Accept-Contact header field; +- the P-Asserted-Service header field; and +- the P-Preferred-Service header field. + +If the mission critical services are supported, the related procedures from 3GPP TS 24.379 [201], 3GPP TS 24.380 [202], 3GPP TS 24.281 [210], 3GPP TS 24.581 [212], 3GPP TS 24.282 [211] and 3GPP TS 24.582 [213] shall be applied with the requirements in the clauses below due to the crossing of the II-NNI. + +## 28.2 Interoperability of mission critical services for communication over II-NNI + +### 28.2.1 Mission Critical services session establishment + +Service specific requirements in accordance with 3GPP TS 22.179 [199], 3GPP TS 22.280 [209], 3GPP TS 24.379 [201], 3GPP TS 24.281 [210] and 3GPP TS 24.282 [211] shall be supported over the II-NNI. + +The INVITE request including: + +#### A) For MCPTT: + +- 1) the "g.3gpp.mcptt" media feature tag (defined in annex C of 3GPP TS 24.379 [201]) in the Contact header field; +- 2) the media feature tag "isfocus" (defined in IETF RFC 3840 [56]) in the Contact header field; +- 3) the Content-Type header field with the value "multipart/mixed"; and +- 4) the "application/vnd.3gpp.mcptt-info+xml" MIME body; + +#### B) For MCVideo: + +- 1) the "g.3gpp.mcvideo" media feature tag (defined in annex D of 3GPP TS 24.281 [210]) in the Contact header field; +- 2) the media feature tag "isfocus" (defined in IETF RFC 3840 [56]) in the Contact header field; +- 3) the Content-Type header field with the value "multipart/mixed"; and +- 4) the "application/vnd.3gpp.mcvideo-info+xml" MIME body; + +#### C) For MCData: + +- 1) the: + - a) "g.3gpp.mcdata.sds" media feature tag; or + - b) "g.3gpp.mcdata.fd" media feature tag,(defined in annex B of 3GPP TS 24.282 [211]) in the Contact header field; + +- 2) the media feature tag "isfocus" (defined in IETF RFC 3840 [56]) in the Contact header field; +- 3) the Content-Type header field with the value "multipart/mixed"; +- 4) the "application/vnd.3gpp.mcdata-info+xml" MIME body; and +- 5) the "application/vnd.3gpp.mcdata-signalling" MIME body; + +shall be supported at the II-NNI. + +Responses to the INVITE request including: + +- 1) the: + - a) "g.3gpp.mcptt"; + - b) "g.3gpp.mcvideo"; + - c) "g.3gpp.mcdata.sds"; or + - d) "g.3gpp.mcdata.fd" + media feature tag in the Contact header field; +- 2) the media feature tag "isfocus" in the Contact header field; +- 3) the Content-Type header field with the value "multipart/mixed"; +- 4) the "application/vnd.3gpp.mcptt-info+xml" for MCPTT or "application/vnd.3gpp.mcvideo-info+xml" for MCVideo or "application/vnd.3gpp.mcdata-info+xml" for MCData MIME body; and +- 5) the Warning header field with the warn-code set to "399" and with the warn-text set to a quoted-string as specified in 3GPP TS 24.379 [201] clause 4.4.2 and 3GPP TS 24.281 [210] clause 4.4.2 and 3GPP TS 24.282 [211] clause 4.9; + +shall be supported at the II-NNI. + +The initial INVITE request including the Priority-Share header field (defined in 3GPP TS 24.229 [5]), the Resource-Share header field (defined in 3GPP TS 24.229 [5]) and the "application/resource-lists+xml" MIME body shall be supported at the roaming II-NNI. + +The Resource-Share header field and the Priority-Share header field in 18x and 2xx responses to the INVITE request shall be supported at the roaming II-NNI. + +The Resource-Share header field and the Priority-Share header field in the PRACK requests, the UPDATE requests, the ACK requests and in 2xx responses to the PRACK requests and the UPDATE requests shall be supported at the roaming II-NNI. + +The REFER request containing an "application/vnd.3gpp.mcptt-info+xml" MIME body in the headers portion in the Refer-To header field shall be supported at the roaming II-NNI. + +NOTE: How the "application/vnd.3gpp.mcptt-info+xml" MIME body is included in the headers portion is described in IETF RFC 3261 [13] clause 19.1.1. + +The "m=" line set to "application UDP MCPTT" and associated parameters in the "a=fmpt:MCPTT" media line attribute shall be supported at the II-NNI. + +An "i=" line set to "speech" in the audio media definition in the SDP offer and SDP answer shall be supported at the II-NNI. + +### 28.2.2 MBMS transmission usage and location procedures + +For MCPTT: + +- a) Service specific requirements in accordance with 3GPP TS 24.379 [201] clauses 13 and 14 shall be supported over the II-NNI. + +- b) The MESSAGE request containing the "application/vnd.3gpp.mcptt-info+xml" MIME body shall be supported over the roaming II-NNI. +- c) The MESSAGE request containing the "application/vnd.3gpp.mcptt-location-info+xml" MIME body shall be supported over the roaming II-NNI. +- d) The MESSAGE request containing the "application/vnd.3gpp.mcptt-mbms-usage-info+xml" MIME body shall be supported over the roaming II-NNI. +- e) The P-Preferred-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcptt" of the MESSAGE request shall be supported at the roaming II-NNI. +- f) The "g.3gpp.mcptt" media feature tag in the Accept-Contact header field of the MESSAGE request from the home network to the visited network shall be supported at the roaming II-NNI. +- g) The "g.3gpp.icsi-ref" media feature tag with the value "urn:urn-7:3gpp-service.ims.icsi.mcptt" in the Accept-Contact header field of the MESSAGE request shall be supported at the roaming II-NNI. + +For MCVideo: + +- a) Service specific requirements in accordance with 3GPP TS 24.281 [210] clauses 16 shall be supported over the II-NNI. +- b) The MESSAGE request containing the "application/vnd.3gpp.mcvideo-info+xml" MIME body shall be supported over the roaming II-NNI. +- c) The MESSAGE request containing the "application/vnd.3gpp.mcvideo-location-info+xml" MIME body shall be supported over the roaming II-NNI. +- d) The MESSAGE request containing the "application/vnd.3gpp.mcvideo-mbms-usage-info+xml" MIME body shall be supported over the roaming II-NNI. +- e) The P-Preferred-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcvideo" of the MESSAGE request shall be supported at the roaming II-NNI. +- f) The "g.3gpp.mcvideo" media feature tag in the Accept-Contact header field of the MESSAGE request from the home network to the visited network shall be supported at the roaming II-NNI. +- g) The "g.3gpp.icsi-ref" media feature tag with the value "urn:urn-7:3gpp-service.ims.icsi.mcvideo" in the Accept-Contact header field of the MESSAGE request shall be supported at the roaming II-NNI. + +### 28.2.3 Affiliation procedure + +#### 28.2.3.1 General + +The affiliation consists of two procedures. One mandatory mode procedure and one negotiated mode procedure. + +Both procedures shall be supported over the II-NNI. + +#### 28.2.3.2 Mandatory mode + +Service specific requirements in accordance with 3GPP TS 24.379 [201] clause 9, 3GPP TS 24.281 [210] clause 8 and 3GPP TS 24.282 [211] clause 8 shall be supported over the II-NNI. + +The SIP PUBLISH request including: + +- 1) an Event header field set to the value "presence"; +- 2) an "application/vnd.3gpp.mcptt-info+xml" for MCPTT, "application/vnd.3gpp.mcvideo-info+xml" for MCVideo or "application/vnd.3gpp.mcdata-info+xml" for MCData MIME body; and +- 3) an "application/pidf+xml" MIME body; + +shall be supported at the II-NNI. + +A SUBSCRIBE request including: + +- 1) an Event header field set to the value "presence"; +- 2) an "application/vnd.3gpp.mcptt-info+xml" for MCPTT or "application/vnd.3gpp.mcvideo-info+xml" for MCVideo or "application/vnd.3gpp.mcdata-info+xml" for MCData MIME body; +- 3) an Accept header field containing the "application/pidf+xml" MIME type; and +- 4) an "application/simple-filter+xml" MIME body according to IETF RFC 4661 [176]; + +shall be supported at the II-NNI. + +An NOTIFY request including: + +- 1) an Event header field set to the value "presence"; and +- 2) an "application/pidf+xml" MIME body + +shall be supported at the II-NNI. + +#### 28.2.3.3 Negotiated mode + +Service specific requirements in accordance with 3GPP TS 24.379 [201] clause 9, 3GPP TS 24.281 [210] clause 8 and 3GPP TS 24.282 [211] clause 8 shall be supported over the II-NNI. + +A MESSAGE request including: + +- 1) an "application/vnd.3gpp.mcptt-info+xml" for MCPTT, "application/vnd.3gpp.mcvideo-info+xml" for MCVideo or "application/vnd.3gpp.mcdata-info+xml" for MCData MIME body; and +- 2) an "application/vnd.3gpp.mcptt-affiliation-command+xml" for MCPTT, "application/vnd.3gpp.mcvideo-affiliation-command+xml" for MCVideo or "application/vnd.3gpp.mcdata-affiliation-command+xml" for MCData MIME body; + +shall be supported at the II-NNI. + +### 28.2.4 Conference event package subscription + +Service specific requirements in accordance with 3GPP TS 24.379 [201] clause 10.1.3 shall be supported over the II-NNI. + +The SUBSCRIBE request including: + +- 1) a "conference" event package name in the Event header field; +- 2) an Accept header field containing the "application/conference-info+xml" MIME type; and +- 3) an "application/vnd.3gpp.mcptt-info+xml" for MCPTT or "application/vnd.3gpp.mcvideo-info+xml" for MCVideo MIME body; + +shall be supported at the II-NNI. + +The NOTIFY request including: + +- 1) the "conference" event package name in the Event header field; +- 2) the Content-Type header field with the value "multipart/mixed"; +- 3) an "application/vnd.3gpp.mcptt-info+xml" for MCPTT or "application/vnd.3gpp.mcvideo-info+xml" for MCVideo MIME body; and +- 4) an "application/conference-info+xml" MIME body; + +shall be supported at the II-NNI. + +## 28.2.5 Mission critical services settings + +Service specific requirements in accordance with 3GPP TS 24.379 [201] clause 7, 3GPP TS 24.281 [210] clause 7 and 3GPP TS 24.282 [211] clause 7 shall be supported over the roaming II-NNI. + +A PUBLISH request including: + +- 1) an Event header field set to the "poc-settings" value; +- 2) one of the following sets of MIME bodies: + - an "application/vnd.3gpp.mcptt-info+xml" for MCPTT; + - an "application/vnd.3gpp.mcvideo-info+xml" MIME body and an "application/vnd.3gpp.mcptt-signed+xml" for MCVideo MIME body; or + - an "application/vnd.3gpp.mcdata-info+xml" MIME body and an "application/vnd.3gpp.mcptt-signed+xml" MIME body for MCData; and +- 3) an "application/poc-settings+xml" MIME body according to IETF RFC 4354 [205]; + +shall be supported at the roaming II-NNI. + +## 28.2.6 Registration procedures + +Service specific requirements in accordance with 3GPP TS 24.379 [201] clause 7 shall be supported over the roaming II-NNI. + +The REGISTER request including: + +- 1) the: + - a) "g.3gpp.mcptt"; + - b) "g.3gpp.mcvideo"; + - c) "g.3gpp.mcdata.sds"; or + - d) "g.3gpp.mcdata.fd"media feature tag in the Contact header field; +- 2) the Content-Type header field with the value "multipart/mixed"; +- 3) the application/mikey MIME body; +- 4) one of the following sets of MIME bodies: + - an "application/vnd.3gpp.mcptt-info+xml" for MCPTT; + - an "application/vnd.3gpp.mcvideo-info+xml" MIME body and an "application/vnd.3gpp.mcptt-signed+xml" for MCVideo MIME body; or + - an "application/vnd.3gpp.mcdata-info+xml" MIME body and an "application/vnd.3gpp.mcptt-signed+xml" MIME body for MCData; +- 5) the Resource-Share header field (defined in 3GPP TS 24.229 [5]); and +- 6) the "g.3gpp.priority-share" feature-capability indicator (defined in 3GPP TS 24.229 [5] clause 7.9A.10) in the Feature-Caps header field; + +shall be supported at the roaming II-NNI. + +## 28.2.7 Group regrouping + +Service specific requirements in accordance with 3GPP TS 24.379 [201] clause 10 shall be supported over the non-roaming II-NNI. + +In addition to the requirements in clause 28.2.1 the 403 (Forbidden) response to the INVITE request including a P-Refused-URI-List header field and an "application/resource-lists+xml" MIME body shall be supported at the non-roaming II-NNI. + +The MESSAGE request including: + +- 1) a Content-Type header field with the value "multipart/mixed"; +- 2) an "application/vnd.3gpp.mcptt-info+xml" MIME body; and +- 3) an "application/vnd.3gpp.mcptt-floor-request+xml" MIME body; + +shall be supported at the non-roaming II-NNI. + +## 28.2.8 Signalling plane messages for mission critical data + +Service specific requirements in accordance with 3GPP TS 24.282 [211] clause 9.2.2 shall be supported over the II-NNI. + +A MESSAGE request including: + +- 1) an "application/vnd.3gpp.mcdata-info+xml" MIME body; and +- 2) an "application/vnd.3gpp.mcdata-signalling" MIME body or an "application/vnd.3gpp.mcdata-payload" MIME body or both; + +shall be supported at the II-NNI. + +## 28.2.9 Functional alias management procedure + +Service specific requirements in accordance with 3GPP TS 24.379 [201] clause 9A shall be supported over the II-NNI. + +A SIP PUBLISH request including: + +- 1) an Event header field set to the value "presence"; +- 2) an "application/vnd.3gpp.mcptt-info+xml" MIME body for MCPTT; and +- 3) an "application/pidf+xml" MIME body; + +shall be supported at the II-NNI. + +A SIP SUBSCRIBE request including: + +- 1) an Event header field set to the value "presence"; +- 2) an "application/vnd.3gpp.mcptt-info+xml" MIME body; and +- 3) an Accept header field containing the "application/pidf+xml" MIME body; + +shall be supported at the II-NNI. + +A SIP NOTIFY request including: + +- 1) an Event header field set to the value "presence"; and +- 2) an "application/pidf+xml" MIME body. + +shall be supported at the II-NNI. + +--- + +## 29 Calling number verification using signature verification and attestation information + +Based on inter-operator agreement, "Calling number verification using signature verification and attestation information" functionality, as described in IETF RFC 8224 [206] and 3GPP TS 24.229 [5], may be supported over the II-NNI. + +If the "Calling number verification using signature verification and attestation information" is supported, the related procedures in 3GPP TS 24.229 [5] shall be applied with the requirements in this clause. + +A 200 (OK) response to a REGISTER request including a "g.3gpp.verstat" feature-capability indicator (defined in 3GPP TS 24.229 [5] clause 7.9A.11) and a "sip.607" feature-capability indicator (defined in IETF RFC 8197 [207]) in a Feature-Caps header field shall be supported at the roaming II-NNI. + +An initial INVITE request and a MESSAGE request containing a P-Asserted-Identity header field and a From header field with a "verstat" tel URI parameter (defined in 3GPP TS 24.229 [5] clause 7.2A.20) in a tel URI or in a SIP URI with a "user=phone" parameter shall be supported at the roaming II-NNI. + +An initial INVITE request and a MESSAGE request containing: + +- an Identity header field (defined in IETF RFC 8224 [206]); +- an Attestation-Info header field (defined in 3GPP TS 24.229 [5] clause 7.2.18); and +- an Origination-id header field (defined in 3GPP TS 24.229 [5] clause 7.2.19), + +shall be supported at the non-roaming II-NNI. + +A 607 (Unwanted) response (defined in IETF RFC 8197 [207]) to an initial INVITE request and a MESSAGE request shall be supported at the II-NNI. + +A Reason header field with a protocol value set to "SIP" and a "cause" header field parameter set to "607" in a BYE request shall be supported at the II-NNI. + +A Reason header field with a protocol value set to "STIR", "cause" and "ppi" header field parameters (specified in IETF RFC 9410 [220]) in a provisional response or a final response to an initial INVITE or a MESSAGE request shall be supported at the non-roaming II-NNI. + +NOTE: Multiple Reason header fields with the protocol value set to "STIR" can be present in a provisional response or a final response to an initial INVITE or a MESSAGE request. + +--- + +## 30 IMS emergency service + +### 30.1 IMS emergency registration + +See clause 8.1 for the signalling requirements of IMS emergency registration regarding the "sos" URI parameter on the roaming II-NNI. + +### 30.2 IMS emergency session + +Based on inter-operator agreements or national requirements, IMS emergency session may be supported over the non-roaming II-NNI. + +NOTE 1: The details of the SIP signalling requirements for IMS emergency session on the non-roaming II-NNI can be defined by inter-operator agreements or national requirements. + +If the IMS emergency session is supported, the related procedures in 3GPP TS 24.229 [5] shall be applied with the requirements in this clause. + +The Request-URI containing a uniform resource name (URN) for emergency services, defined in IETF RFC 5031 [61] and 3GPP TS 24.229 [5], shall be supported for the IMS emergency session traversal scenario on the non-roaming II-NNI. + +NOTE 2: The emergency service URN(s) to use can be defined by inter-operator agreements or national requirements. + +### 30.3 Next-Generation Pan-European eCall emergency service + +Based on inter-operator agreements or national requirements, Next-Generation Pan-European eCall emergency service may be supported over the non-roaming II-NNI. + +If Next-Generation Pan-European eCall emergency service is supported, the related procedures in 3GPP TS 24.229 [5] shall be applied with the requirements in this clause. + +The MSD in an INVITE and INFO request shall be supported over the non-roaming II-NNI as described in 3GPP TS 24.229 [5]. + +--- + +## 31 Restricted Local Operator Services (RLOS) + +Based on inter-operator agreement, RLOS as described in 3GPP TS 24.229 [5] may be supported over the roaming II-NNI. + +If RLOS is supported, a REGISTER request with a "+g.3gpp.rlos" Contact header field parameter, as defined in 3GPP TS 24.229 [5] clause 7.9.9 shall be supported at the roaming II-NNI. + +An initial request for a dialog or a request for a standalone transaction with the Request-URI containing the dummy MSISDN value as defined in 3GPP TS 23.003 [35] or a RLOS service specific dial string and a P-Preferred-Service header field set to "urn:urn-7:3gpp-service.ims.icsi.rlos", as defined in 3GPP TS 24.229 [5] clause 7.11.2 shall be supported at the roaming II-NNI. + +--- + +## 32 3GPP PS data off extension + +Based on inter-operator agreement, 3GPP PS data off extension as described in 3GPP TS 24.229 [5] may be supported over the roaming II-NNI. + +If the 3GPP PS data off extension is supported, "+g.3gpp.ps-data-off" media feature tag in the Contact header field parameter of the REGISTER request shall be supported at the roaming II-NNI. + +--- + +## 33 MTSI Data channel + +Based on inter-operator agreement, data channel as described in 3GPP TS 26.114 [11] may be supported at the II-NNI. + +If MTSI data channel is supported, the procedures specified in 3GPP TS 26.114 [11] shall be applied and the capabilities below shall be provided at the II-NNI. + +The "+sip.app-subtype" media feature tag with a value of "webrtc-datachannel" in the Contact header field parameter of the REGISTER request shall be supported at the roaming II-NNI. + +The "+sip.app-subtype" media feature tag with a value of "webrtc-datachannel" in the Contact header field parameter of INVITE and UPDATE requests and in 18x and 2xx responses to INVITE and UPDATE requests shall be supported at the II-NNI. + +The "m=" line set to "application UDP/DTLS/SCTP webrtc-datachannel" and associated parameters in the media line attributes "a=dcmmap" and "a=3GPP-qos-hint" of the SDP body shall be supported at the II-NNI. For the "bootstrap" data channel as defined in table 6.2.10.1-2 of 3GPP TS 26.114 [11] only stream ID 100 and stream ID 110 shall be supported at the II-NNI. + +NOTE: Stream ID 0 and stream ID 10 "bootstrap" data channels are strictly local between the UE and its local network. + +--- + +## 34 Support for signed attestation for emergency and priority IMS sessions + +### 34.1 General + +Where a network has requirements on a signed attestation for emergency IMS sessions the "Calling number verification using signature verification and attestation information" and "Priority verification using assertion of priority information" features described in 3GPP TS 24.229 [5] need to be supported. + +Where a network has requirements on a signed attestation for priority IMS sessions (e.g., MPS sessions) the "Priority verification using assertion of priority information" feature described in 3GPP TS 24.229 [5] needs to be supported and the "Calling number verification using signature verification and attestation information" feature described in 3GPP TS 24.229 [5] might need to be supported. + +Based on inter-operator agreement, the signed attestation for emergency and priority IMS sessions may be supported over the II-NNI as further specified below. + +### 34.2 Calling number verification using signature verification and attestation information + +The requirements to support the "Calling number verification using signature verification and attestation information" functionality for emergency and priority IMS sessions over the II-NNI are the same as in clause 29. + +### 34.3 Priority verification using assertion of priority information + +"Priority verification using assertion of priority information" functionality, as described in 3GPP TS 24.229 [5], may be supported over the II-NNI. + +If the "Priority verification using assertion of priority information" is supported, the related procedures in 3GPP TS 24.229 [5] shall be applied with the requirements in this clause. + +An initial INVITE request containing: + +- a Resource-Priority header field; and +- optionally, a Priority header field with a "psap-callback" header field value, for emergency call-back cases; + +shall be supported at the II-NNI. + +An initial INVITE request containing: + +- an Identity header field (defined in IETF RFC 8224 [206]); and +- a Priority-Verstat header field (defined in 3GPP TS 24.229 [5] clause 7.2.21) + +shall be supported at the non-roaming II-NNI. + +A re-INVITE request containing a Resource-Priority header field shall be supported at the II-NNI. + +A re-INVITE request containing: + +- an Identity header field (defined in IETF RFC 8224 [206]); and +- a Priority-Verstat header field (defined in 3GPP TS 24.229 [5] clause 7.2.21) + +shall be supported at the non-roaming II-NNI. + +--- + +## Annex A (informative): Summary of SIP header fields + +A summary of the SIP header fields to be used in case of interconnection by using II-NNI is proposed in table A.1. + +The starting point is the sending behaviour described for proxy and UA roles in annex A of 3GPP TS 24.229 [5]: + +- In case of misalignment between table A.1 and the behaviour described in 3GPP TS 24.229 [5], the behaviour in 3GPP TS 24.229 [5] has the precedence. +- In case a header field is not described in table A.1 and it is described in 3GPP TS 24.229 [5], the description in 3GPP TS 24.229 [5] is applicable over II-NNI. +- If a header field is not described in 3GPP TS 24.229 [5], the description in table A.1 is applicable over II-NNI. + +The definition of the notation codes used in table A.1 is provided in table A.2. + +**Table A.1: Supported header fields** + +| Item | Header field | Ref. | II-NNI | +|------|--------------------------|---------------------------------------------------------------------|---------------------------------------------------------------------------------| +| 1 | Accept | [5] | m | +| 2 | Accept-Contact | [5] | m | +| 3 | Accept-Encoding | [5] | m | +| 4 | Accept-Language | [5] | m | +| 4a | Accept-Resource-Priority | [5] | o | +| 4b | Additional-Identity | [5], clause 6.1.1.3.1
(table 6.2, item 25)
and clause 12.26.2 | o in case of a trust relationship between the interconnected networks, else n/a | +| 5 | Alert-Info | [5] | o | +| 6 | Allow | [5] | m | +| 7 | Allow-Events | [5] | m on roaming II-NNI, else o | +| 7a | Attestation-Info | [5], clause 6.1.1.3.1
(table 6.2, item 23)
and clause 29 | o on non-roaming II-NNI, else n/a | +| 8 | Authentication-Info | [5] | m on roaming II-NNI, else n/a | +| 9 | Authorization | [5] | m on roaming II-NNI, else n/a | +| 9a | Answer-Mode | [5] | o | +| 10 | Call-ID | [5] | m | +| 11 | Call-Info | [5] | m | +| 11a | Cellular-Network-Info | clause 6.1.1.3.1
(table 6.2, item 21) | o | +| 12 | Contact | [5] | m | +| 13 | Content-Disposition | [5] | m | +| 14 | Content-Encoding | [5] | m | +| 14a | Content-ID | [5] | o | +| 15 | Content-Language | [5] | m | +| 16 | Content-Length | [5] | m | +| 17 | Content-Type | [5] | m | +| 18 | CSeq | [5] | m | +| 19 | Date | [5] | m | +| 20 | Error-Info | [5] | o | +| 21 | Expires | [5] | m | +| 21a | Flow-Timer | [5] | m on roaming II-NNI, else o | +| 21b | Feature-Caps | clause 6.1.1.3.1
(table 6.2, item 13) | o | +| 22 | Event | [5] | m | +| 23 | From | [5] | m | +| 24 | Geolocation | [5] | m | +| 24a | Geolocation-Error | [5] | m | +| 24b | Geolocation-Routing | [5] | m | +| 25 | History-Info | clause 6.1.1.3.1
(table 6.2, item 4) | o | +| 25b | Identity | [206], clause 29 and
clause 34 | o on non-roaming II-NNI, else n/a | +| 25a | Info-Package | [5] | o | +| 26 | In-Reply-To | [5] | o | +| 27 | Join | [5] | o | +| 27a | Max-Breadth | [5] | m | +| 28 | Max-Forwards | [5] | m | +| 29 | Min-Expires | [5] | m | +| 30 | MIME-Version | [5] | m | +| 31 | Min-SE | [5] | m | +| 32 | Organization | [5] | m | +| 32a | Origination-Id | [5], clause 6.1.1.3.1
(table 6.2, item 24)
and clause 29 | o on non-roaming II-NNI, else n/a | +| 33 | P-Access-Network-Info | clause 6.1.1.3.1
(table 6.2, item 2) | m in case of a trust relationship between the interconnected networks, else n/a | +| 33a | P-Answer-state | [5] | o | +| 34 | P-Asserted-Identity | clause 6.1.1.3.1
(table 6.2, item 1) | m in case of a trust relationship between the interconnected networks, else n/a | +| 35 | P-Asserted-Service | clause 6.1.1.3.1
(table 6.2, item 5) | o | + +| Item | Header field | Ref. | II-NNI | +|------|-------------------------------|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| 35a | P-Associated-URI | [5] | m on roaming II-NNI, else n/a | +| 36 | P-Called-Party-ID | [5] | m on roaming II-NNI, else n/a | +| 37 | P-Charging-Function-Addresses | clause 6.1.1.3.1
(table 6.2, item 7) | n/a | +| 38 | P-Charging-Vector | clause 6.1.1.3.1
(table 6.2, item 6) | m on roaming II-NNI, else o | +| 39 | P-Early-Media | clause 6.1.1.3.1
(table 6.2, item 12) | m in case of a trust relationship between the interconnected networks, else n/a | +| 40 | P-Media-Authorization | [5] | n/a | +| 41 | P-Preferred-Identity | [5] | n/a | +| 42 | P-Preferred-Service | [5] | m on roaming II-NNI, else n/a | +| 43 | P-Private-Network-Indication | clause 6.1.1.3.1
(table 6.2, item 9) | m on roaming II-NNI, else o | +| 44 | P-Profile-Key | clause 6.1.1.3.1
(table 6.2, item 8) | o on roaming II-NNI, else n/a | +| 44a | P-Refused-URI-List | [5] | o on non-roaming II-NNI, else n/a | +| 45 | P-Served-User | clause 6.1.1.3.1
(table 6.2, item 10) | m on roaming II-NNI, else n/a | +| 46 | P-User-Database | [5] | n/a | +| 47 | P-Visited-Network-ID | [5] | m on roaming II-NNI, else n/a | +| 47a | Path | [5] | m on roaming II-NNI, else n/a | +| 47b | Permission-Missing | [5] | o | +| 47c | Policy-Contact | [133] and
clause 15.6.2 | o | +| 48 | Priority | clause 6.1.1.3.1
(table 6.2, item 14) | o | +| 48b | Priority-Share | [5] clause 7.2.16 | o on roaming II-NNI, else n/a | +| 48c | Priority-Verstat | [5], clause 6.1.1.3.1
(table 6.2, item 26)
and clause 34 | o on non-roaming II-NNI, else n/a | +| 48a | Priv-Answer-Mode | [5] | o | +| 49 | Privacy | [5] | m | +| 50 | Proxy-Authenticate | [5] | m on roaming II-NNI, else n/a | +| 51 | Proxy-Authorization | [5] | m on roaming II-NNI, else n/a | +| 52 | Proxy-Require | [5] | m | +| 52a | RAck | [5] | m | +| 53 | Reason | [5] and
clause 6.1.1.3.1
(table 6.2, item 11) | o when in a request.
When in a response, m in case of a trust relationship between the interconnected networks, else n/a | +| 54 | Record-Route | [5] | m | +| 54a | Recv-Info | [5] | o | +| 55 | Referred-By | [5] | m | +| 55a | Refer-Sub | [5] | m in the case the REFER request is supported, else n/a | +| 55b | Refer-To | [5] | m in the case the REFER request is supported, else n/a | +| 56 | Reject-Contact | [5] | m | +| 56a | Relayed-Charge | clause 6.1.1.3.1
(table 6.2, item 19) | n/a | +| 57 | Replaces | [5] | o | +| 58 | Reply-To | [5] | o | +| 59 | Request-Disposition | [5] | m | +| 60 | Require | [5] | m | +| 61 | Resource-Priority | clause 6.1.1.3.1
(table 6.2, item 3) | o | +| 61c | Resource-Share | [5] clause 7.2.13 | o on roaming II-NNI, else n/a | +| 61d | Response-Source | [5] | o in case of a trust relationship between the interconnected networks, else n/a | +| 61b | Restoration-Info | clause 6.1.1.3.1
(table 6.2, item 18) | o on roaming II-NNI, else n/a | +| 61a | Retry-After | [5] | o | +| 62 | Route | [5] | m | + +| Item | Header field | Ref. | II-NNI | +|------|-----------------------|-----------------------------------------------|---------------------------------------------------------------------------------| +| 62a | RSeq | [5] | m | +| 63 | Security-Client | [5] | n/a | +| 63a | Security-Server | [5] | n/a | +| 64 | Security-Verify | [5] | n/a | +| 65 | Server | [5] | o | +| 65c | Service-Interact-Info | [5] and clause 6.1.1.3.1 (table 6.2, item 20) | o in case of a trust relationship between the interconnected networks, else n/a | +| 65a | Service-Route | [5] | m on roaming II-NNI, else n/a | +| 65b | Session-ID | [5] | o | +| 66 | Session-Expires | [5] | m | +| 66a | SIP-ETag | [5] | m in the case the PUBLISH request is supported, else n/a | +| 66b | SIP-If-Match | [5] | m in the case the PUBLISH request is supported, else n/a | +| 67 | Subject | [5] | o | +| 67a | Subscription-State | [5] | m in the case the NOTIFY request is supported, else n/a | +| 67b | Suppress-If-Match | [144] and clause 15.6.4 | o | +| 68 | Supported | [5] | m | +| 68a | Target-Dialog | [5] | o | +| 69 | Timestamp | [5] | m | +| 70 | To | [5] | m | +| 71 | Trigger-Consent | [5] | m | +| 71a | Unsupported | [5] | m | +| 72 | User-Agent | [5] | m | +| 73 | User-to-User | [5] | o | +| 74 | Via | [5] | m | +| 75 | Warning | [5] | o | +| 76 | WWW-Authenticate | [5] | m on roaming II-NNI, else n/a | + +**Table A.2: Key to notation codes for SIP header fields** + +| Notation code | Meaning | +|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| m | The SIP header field is applicable at II-NNI. Supporting a SIP header field at the II-NNI means that this header field is passed through the IBCF. It does not imply that network elements inside the serving and served networks or user equipment connected to these networks shall support this header field, where 3GPP TS 24.229 [5] is applied. If specified in 3GPP TS 24.229 [5], the IBCF modifies the SIP header field. | +| o | The applicability of SIP header field at II-NNI depends on bilateral agreement between the operators. | +| n/a | It is impossible to use the SIP header field at the II-NNI. This header field could be discarded by the IBCF. | + +--- + +## Annex B (informative): Dynamic view of SIP header fields within SIP messages + +### B.1 Scope + +This annex provides the applicability of SIP header fields in SIP messages over II-NNI by using the methodology of a so-called "dynamic view", as used in IETF RFC 3261 [13] and other SIP related RFCs. This methodology documents the presence of SIP header fields in SIP messages over the II-NNI and also takes into account dynamic conditions, for instance the presence of a SIP header field in a SIP request message as condition for the SIP header field in the corresponding SIP response message. + +Specific information about the applicability of SIP header fields in SIP messages in a dynamic view is also provided for cases where an MMTEL supplementary service is supported over the II-NNI between operators. + +The applicability of SIP header fields described in this annex is based on the procedures described in 3GPP TS 24.229 [5] and the list of SIP header fields in annex A of 3GPP TS 24.229 [5]. + +--- + +### B.2 Methodology + +The meaning of the notation codes used in the tables in subsequent clauses is as follows: + +In the "RFC status" column, the notation codes defined in IETF RFC 3261 [13] clause 20 are applied. + +In the "II-NNI condition" column the notation codes defined in table B.2.1 are used. If a capability of a SIP header field is specified as either optional or conditional in table 6.1.3.1, then "II-NNI condition" of the SIP header field is described with conditional expression. + +In each request-related table, the order of SIP header fields inherits that of clause A.2.2 of 3GPP TS 24.229 [5]. + +In each response-related table, the SIP status code for which the header field is applicable is described in the "SIP status code" column. The notation codes for the "where" column as defined in IETF RFC 3261 [13] clause 20 are applied. The notation code "r" in "SIP status code" column corresponds to any SIP status code which is described in annex A of 3GPP TS 24.229 [5] for the corresponding method. Any SIP header field not listed in a table is not applicable for the corresponding SIP message. + +**Table B.2.1: Key to notation codes for SIP header fields in dynamic view for II-NNI** + +| Notation code
(NOTE 1) | Meaning | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dc | The SIP header field is required to be present in a SIP message over II-NNI according to the procedures specified in other specifications e.g. 3GPP TS 24.229 [5]. | +| dm | The SIP header field shall be always present in a SIP message over II-NNI, and if received, it must be handled according to 3GPP TS 24.229 [5]. | +| dm* | The SIP header field should be present in a SIP message over II-NNI, but the IMS network need to be prepared to receive a SIP message without that header field. | +| do | The SIP header field can be present in a SIP message over II-NNI, and if received, it must be handled according to 3GPP TS 24.229 [5]. (NOTE 2) | +| dt | The header field should be present in a SIP message over II-NNI, but the IMS network need to be prepared to receive a SIP message without that header field.
If TCP is used as a transport, then the header field must be present in a SIP message. | +| d* | The SIP header field is required to be present in a SIP message if the message body is not empty. | +| dn/a | The SIP header field is shall not be present in a SIP message over II-NNI. (NOTE 3) | +| dc | The condition for the presence of the SIP header field. is the identifier of the condition.
This notation code is applied only in each request-related or response-related table. | +| NOTE 1: The meaning of the notation codes is same as in IETF RFC 3261 [13] clause 20 and "d" is used to emphasise the dynamic view. | | +| NOTE 2: If specified by local policy rules, the IBCF acting as entry point may omit or modify any received SIP header fields prior to forwarding SIP messages as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | +| NOTE 3: The SIP header field can be removed at the IBCF acting as exit point by using screening functionality defined in 3GPP TS 24.229 [5] clause 5.10.6.2. | | + +## B.3 ACK method + +The table B.3.1 lists the supported header fields within the ACK request. + +**Table B.3.1: Supported header fields within the ACK request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-----------------------|--------------------|------------|----------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept-Contact | [51] | o | do | +| 2 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 3 | Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 4 | Call-ID | [13] | m | dm | +| 5 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 6 | Content-Disposition | [13] | o | do | +| 7 | Content-Encoding | [13] | o | do | +| 8 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 9 | Content-Language | [13] | o | do | +| 10 | Content-Length | [13] | t | dt | +| 11 | Content-Type | [13] | * | d* | +| 12 | CSeq | [13] | m | dm | +| 13 | Date | [13] | o | do | +| 14 | From | [13] | m | dm | +| 15 | Max-Breadth | [79] | o | do | +| 16 | Max-Forwards | [13] | m | dm | +| 17 | MIME-Version | [13] | o | do | +| 18 | P-Access-Network-Info | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 19 | Priority-Share | [5] | n/a | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/118 THEN do (NOTE) | +| 20 | Privacy | [34] | o | do | +| 21 | P-Charging-Vector | [24], [24A] | o | IF table 6.1.3.1/38 THEN do (NOTE) | +| 22 | Proxy-Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 23 | Proxy-Require | [13] | n/a | dn/a | +| 24 | Reason | [48] | o | IF table 6.1.3.1/40 THEN do (NOTE) | +| 25 | Record-Route | [13] | o | do | +| 26 | Recv-Info | [39] | n/a | dn/a | +| 27 | Reject-Contact | [51] | o | do | +| 28 | Relayed-Charge | [5] | n/a | dn/a | +| 29 | Request-Disposition | [51] | o | do | +| 30 | Require | [13] | n/a | dn/a | +| 31 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 32 | Resource-Share | [5] | n/a | IF (home-to-visited request on roaming II-NNI OR visited-to-home request on roaming II-NNI) AND table 6.1.3.1/116 THEN do (NOTE) | +| 33 | Route | [13] | c | dc | +| 34 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 35 | Timestamp | [13] | o | do | +| 36 | To | [13] | m | dm | +| 37 | User-Agent | [13] | o | do | +| 38 | Via | [13] | m | dm | + +NOTE: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +--- + +## B.4 BYE method + +The table B.4.1 lists the supported header fields within the BYE request. + +**Table B.4.1: Supported header fields within the BYE request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|------------|------------------------------------------------------------------------------| +| 1 | Accept | [13] | o | IF dc1 (AOC: clause 12.22) THEN dm ELSE do | +| 2 | Accept-Contact | [51] | o | do | +| 3 | Accept-Encoding | [13] | o | do | +| 4 | Accept-Language | [13] | o | do | +| 5 | Allow | [13] | o | do | +| 6 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 7 | Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 8 | Call-ID | [13] | m | dm | +| 9 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 10 | Content-Disposition | [13] | o | IF dc2 (AOC: clause 12.22) THEN dm ELSE do | +| 11 | Content-Encoding | [13] | o | do | +| 12 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 13 | Content-Language | [13] | o | do | +| 14 | Content-Length | [13] | t | dt | +| 15 | Content-Type | [13] | * | d* | +| 16 | CSeq | [13] | m | dm | +| 17 | Date | [13] | o | do | +| 18 | From | [13] | m | dm | +| 19 | Geolocation | [68] | o | do | +| 20 | Geolocation-Routing | [68] | o | do | +| 21 | Max-Breadth | [79] | o | do | +| 22 | Max-Forwards | [13] | m | dm | +| 23 | MIME-Version | [13] | o | do | +| 24 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 25 | P-Asserted-Identity | [44] | o | IF table 6.1.3.1/27 THEN do (NOTE) | +| 26 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 27 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 THEN do (NOTE) | +| 28 | P-Preferred-Identity | [44] | o | dn/a | +| 29 | Privacy | [34] | o | do | +| 30 | Proxy-Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 31 | Proxy-Require | [13] | o | do | +| 32 | Reason | [48] | o | IF dc3 (ICB: clause 12.10.1) THEN dm ELSE IF table 6.1.3.1/40 THEN do (NOTE) | +| 33 | Record-Route | [13] | o | do | +| 34 | Referred-By | [53] | o | do | +| 35 | Reject-Contact | [51] | o | do | +| 36 | Relayed-Charge | [5] | n/a | dn/a | +| 37 | Request-Disposition | [51] | o | do | +| 38 | Require | [13] | c | dc | +| 39 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 40 | Route | [13] | c | dc | +| 41 | Security-Client | [47] | o | dn/a | +| 42 | Security-Verify | [47] | o | dn/a | +| 43 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 44 | Supported | [13] | o | do | +| 45 | Timestamp | [13] | o | do | +| 46 | To | [13] | m | dm | +| 47 | User-Agent | [13] | o | do | +| 48 | User-to-User | [83] | o | IF table 6.1.3.1/79 THEN do (NOTE) | +| 49 | Via | [13] | m | dm | +| dc1: | request invoked due to AOC AND visited-to-home request on roaming II-NNI | | | | +| dc2: | request invoked due to AOC AND home-to-visited request on roaming II-NNI | | | | +| dc3: | request invoked due to "dynamic ICB" on a confirmed status | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.4.2 lists the supported header fields within the BYE response. + +**Table B.4.2: Supported header fields within the BYE response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|---------------------------------|----------------------|------------|--------------------------------------------| +| 1 | Accept | 415 | [13] | c | dc | +| 2 | Accept-Encoding | 415 | [13] | c | dc | +| 3 | Accept-Language | 415 | [13] | c | dc | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405 | [13] | m | dm | +| | | others | | o | do | +| 6 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 2) | +| 7 | Authentication-Info | 2xx | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100 | [13] | m | dm | +| | | others | | | | +| 9 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 10 | Contact | 3xx
485 | [13] | o | do | +| 11 | Content-Disposition | r | [13] | o | IF dc1 (AOC: clause 12.22) THEN dm ELSE do | +| 12 | Content-Encoding | r | [13] | o | do | +| 13 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 14 | Content-Language | r | [13] | o | do | +| 15 | Content-Length | 100 | [13] | t | dt | +| | | others | | | | +| 16 | Content-Type | r | [13] | * | d* | +| 17 | CSeq | 100 | [13] | m | dm | +| | | others | | | | +| 18 | Date | 100 | [13] | o | do | +| | | others | | | | +| 19 | Error-Info | 3xx-6xx | [13] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 20 | From | 100 | [13] | m | dm | +| | | others | | | | +| 21 | Geolocation-Error | 424 | [68] | m | dm | +| | | others | | o | do | +| 22 | MIME-version | r | [13] | o | do | +| 23 | P-Access-Network-Info | r | [24], [2 4A], [2 4B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 24 | P-Asserted-Identity | r | [44] | o | IF table 6.1.3.1/27 THEN do (NOTE 2) | +| 25 | P-Charging-Function-Addresses | r | [24], [2 4A] | o | dn/a | +| 26 | P-Charging-Vector | 100 | [24], [2 4A] | o | dn/a | +| | | others | | o | IF table 6.1.3.1/38 THEN do (NOTE 2) | +| 27 | P-Preferred-Identity | r | [44] | o | dn/a | +| 28 | Privacy | r | [34] | o | do | +| 29 | Proxy-Authenticate | 401 (NOTE 1) | [13] | o | do | +| | | 407 (NOTE 1) | | m | dm | +| 30 | Record-Route | 2xx | [13] | o | do | +| 31 | Relayed-Charge | r | [5] | n/a | dn/a | +| 32 | Require | r | [13] | c | dc | +| 33 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | +| 34 | Retry-After | 404
413
480
486
500 | [13] | o | do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-------------------|-------|------------|-----------------------------------------|--|--| +| | | 503
600
603 | | | | | | +| 35 | Security-Server | 421
494 | [47] | o | dn/a | | | +| 36 | Server | r | [13] | o | do | | | +| 37 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm
(NOTE 2) | | | +| 38 | Supported | 2xx | [13] | o | do | | | +| 39 | Timestamp | r | [13] | o | do | | | +| 40 | To | 100
others | [13] | m | dm | | | +| 41 | Unsupported | 420 | [13] | m | dm | | | +| 42 | User-Agent | r | [13] | o | do | | | +| 43 | User-to-User | r | [83] | o | IF table 6.1.3.1/79 THEN do
(NOTE 2) | | | +| 44 | Via | 100
others | [13] | m | dm | | | +| 45 | Warning | r | [13] | o | do | | | +| 46 | WWW-Authenticate | 401
(NOTE 1) | [13] | m | dm | | | +| | | 407
(NOTE 1) | | o | do | | | +| dc1: 200 (OK) response invoked due to AOC AND home-to-visited response on roaming II-NNI | | | | | | | | +| NOTE 1: The SIP status code is only applicable over the roaming II-NNI. | | | | | | | | +| NOTE 2: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | | | | + +## B.5 CANCEL method + +The table B.5.1 lists the supported header fields within the CANCEL request. + +**Table B.5.1: Supported header fields within the CANCEL request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|-------|------------|--------------------------------------------------------------------------| +| 1 | Accept-Contact | [51] | o | do | +| 2 | Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 3 | Call-ID | [13] | m | dm | +| 4 | Content-Length | [13] | t | dt | +| 5 | Content-Type | [13] | * | IF table 6.1.3.1/20 THEN do (NOTE) | +| 6 | CSeq | [13] | m | dm | +| 7 | Date | [13] | o | do | +| 8 | From | [13] | m | dm | +| 9 | Max-Breadth | [79] | o | do | +| 10 | Max-Forwards | [13] | m | dm | +| 11 | Privacy | [34] | o | do | +| 12 | Reason | [48] | o | IF dc1 (CW: clause 12.7) THEN dm ELSE IF table 6.1.3.1/40 THEN do (NOTE) | +| 13 | Record-Route | [13] | o | do | +| 14 | Reject-Contact | [51] | o | do | +| 15 | Request-Disposition | [51] | o | do | +| 16 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 17 | Route | [13] | c | dc | +| 18 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 19 | Supported | [13] | o | do | +| 20 | Timestamp | [13] | o | do | +| 21 | To | [13] | m | dm | +| 22 | User-Agent | [13] | o | do | +| 23 | Via | [13] | m | dm | +| dc1: request invoked due to CW at the expiry of the "CW timer" | | | | | +| NOTE: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | + +The table B.5.2 lists the supported header fields within the CANCEL response. + +**Table B.5.2: Supported header fields within the CANCEL response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|--------------------------|------------------------------------------------------|-------|------------|-------------------------------------| +| 1 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 2 | Call-ID | r | [13] | m | dm | +| 3 | Content-Length | r | [13] | t | dt | +| 4 | CSeq | r | [13] | m | dm | +| 5 | Date | r | [13] | o | do | +| 6 | Error-Info | 3xx-6xx | [13] | o | IF table 6.1.3.1/13 THEN do (NOTE) | +| 7 | From | r | [13] | m | dm | +| 8 | Privacy | r | [34] | o | do | +| 9 | Record-Route | 2xx | [13] | o | do | +| 10 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE) | +| 11 | Retry-After | 404
413
480
486
500
503
600
603 | [13] | o | do | +| 12 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 13 | Supported | 2xx | [13] | o | do | +| 14 | Timestamp | r | [13] | o | do | +| 15 | To | r | [13] | m | dm | +| 16 | User-Agent | r | [13] | o | do | +| 17 | Via | r | [13] | m | dm | +| 18 | Warning | r | [13] | o | do | + +NOTE: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +--- + +## B.6 INFO method + +As described in table 6.1, the support of INFO method over the II-NNI is based on bilateral agreement between the operators. + +The table B.6.1 lists the supported header fields within the INFO request. + +**Table B.6.1: Supported header fields within the INFO request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|------------|--------------------------------------------| +| 1 | Accept | [13], [39] | o | do | +| 2 | Accept-Encoding | [13], [39] | o | do | +| 3 | Accept-Language | [13], [39] | o | do | +| 4 | Allow | [13], [39] | o | do | +| 5 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 6 | Authorization | [13], [39] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 7 | Call-ID | [13], [39] | m | dm | +| 8 | Call-Info | [13], [39] | o | do | +| 9 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 10 | Content-Disposition | [13], [39] | o | IF dc1 (AOC: clause 12.22) THEN dm ELSE do | +| 11 | Content-Encoding | [13], [39] | o | do | +| 12 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 13 | Content-Language | [13], [39] | o | do | +| 14 | Content-Length | [13], [39] | o | do | +| 15 | Content-Type | [13], [39] | * | d* | +| 16 | CSeq | [13], [39] | m | dm | +| 17 | Date | [13], [39] | o | do | +| 18 | From | [13], [39] | m | dm | +| 19 | Geolocation | [68] | o | do | +| 20 | Geolocation-Routing | [68] | o | do | +| 21 | Info-Package | [39] | m* | IF table 6.1.3.1/17 THEN do (NOTE) | +| 22 | Max-Breadth | [79], [39] | n/a | dn/a | +| 23 | Max-Forwards | [13], [39] | o | do | +| 24 | MIME-Version | [13], [39] | o | do | +| 25 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 26 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 27 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 THEN do (NOTE) | +| 28 | Privacy | [34], [39] | o | do | +| 29 | Proxy-Authorization | [13], [39] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 30 | Proxy-Require | [13], [39] | o | do | +| 31 | Reason | [48], [39] | o | IF table 6.1.3.1/40 THEN do (NOTE) | +| 32 | Record-Route | [13], [39] | o | do | +| 33 | Referred-By | [53], [39] | o | do | +| 34 | Relayed-Charge | [5] | n/a | dn/a | +| 35 | Request-Disposition | [51], [39] | o | do | +| 36 | Require | [13], [39] | o | do | +| 37 | Resource-Priority | [78], [39] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 38 | Route | [13], [39] | o | do | +| 39 | Security-Client | [47], [39] | o | dn/a | +| 40 | Security-Verify | [47], [39] | o | dn/a | +| 41 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 42 | Subject | [13], [39] | o | do | +| 43 | Supported | [13], [39] | o | do | +| 44 | Timestamp | [13], [39] | o | do | +| 45 | To | [13], [39] | m | dm | +| 46 | User-Agent | [13], [39] | o | do | +| 47 | Via | [13], [39] | m | dm | +| dc1: | request invoked due to AOC AND home-to-visited request on roaming II-NNI | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.6.2 lists the supported header fields within the INFO response. + +**Table B.6.2: Supported header fields within the INFO response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|--------------------------|--------------------|------------|---------------------------------------| +| 1 | Accept | 2xx
415 | [13], [39] | o | do | +| 2 | Accept-Encoding | 2xx | [13], [39] | o | do | +| | | 415 | | c | dc | +| 3 | Accept-Language | 2xx
415 | [13], [39] | o | do | +| 4 | Accept-Resource-Priority | 2xx
417 | [78], [39] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405 | [13], [39] | m | dm | +| | | others | | o | do | +| 6 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 2) | +| 7 | Authentication-Info | 2xx | [13], [39] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100 | [13], [39] | m | dm | +| | | others | | | | +| 9 | Call-Info | r | [13], [39] | o | do | +| 10 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 11 | Content-Disposition | r | [13], [39] | o | do | +| 12 | Content-Encoding | r | [13], [39] | o | do | +| 13 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 14 | Content-Language | r | [13], [39] | o | do | +| 15 | Content-Length | 100 | [13], [39] | o | do | +| | | others | | | | +| 16 | Content-Type | r | [13], [39] | * | d* | +| 17 | CSeq | 100 | [13], [39] | m | dm | +| | | others | | | | +| 18 | Date | 100 | [13], [39] | o | do | +| | | others | | | | +| 19 | Error-Info | 3xx-6xx | [13], [39] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 20 | From | 100 | [13], [39] | m | dm | +| | | others | | | | +| 21 | Geolocation-Error | 424 | [68], [39] | m | dm | +| | | others | | o | do | +| 22 | MIME-version | r | [13], [39] | o | do | +| 23 | Organization | r | [13], [39] | n/a | dn/a | +| 24 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 25 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 26 | P-Charging-Vector | 100 | [24], [24A] | o | dn/a | +| | | others | | o | IF table 6.1.3.1/38 THEN do (NOTE 2) | +| 27 | Privacy | r | [34], [39] | o | do | +| 28 | Proxy-Authenticate | 401 (NOTE 1) | [13], [39] | o | do | +| 29 | Record-Route | 2xx | [13], [39] | o | do | +| 30 | Relayed-Charge | r | [5] | n/a | dn/a | +| 31 | Require | r | [13], [39] | o | do | +| 32 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | +| 33 | Retry-After | 404
413
480
486 | [13], [39] | o | do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|------------------|--------------------------|------------|------------|-----------------------------------------| +| | | 500
503
600
603 | | | | +| 34 | Security-Server | 421
494 | [47], [39] | o | dn/a | +| 35 | Server | r | [13], [39] | o | do | +| 36 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm
(NOTE 2) | +| 37 | Supported | 2xx | [13], [39] | o | do | +| 38 | Timestamp | r | [13], [39] | o | do | +| 39 | To | 100
others | [13], [39] | m | dm | +| 40 | Unsupported | 420 | [13], [39] | o | do | +| 41 | User-Agent | r | [13], [39] | o | do | +| 42 | Via | 100
others | [13], [39] | m | dm | +| 43 | Warning | r | [13], [39] | o | do | +| 44 | WWW-Authenticate | 401
(NOTE 1) | [13], [39] | m | dm | + +NOTE 1: The SIP status code is only applicable over the roaming II-NNI. + +NOTE 2: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +--- + +## B.7 INVITE method + +The table B.7.1 lists the supported header fields within the INVITE request. + +**Table B.7.1: Supported header fields within the INVITE request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | [13] | o | IF dc1 (AOC: clause 12.22) THEN dm ELSE do | +| 2 | Accept-Contact | [51] | o | IF dc2 (PNM: clause 12.17) THEN dm ELSE do | +| 3 | Accept-Encoding | [13] | o | do | +| 4 | Accept-Language | [13] | o | do | +| 5 | Additional-Identity | [5] | n/a | IF table 6.1.3.1/126 THEN do (NOTE 3) | +| 6 | Alert-Info | [13] | o | IF dc3 (CRS: clause 12.15) THEN dm ELSE IF table 6.1.3.1/10 THEN do (NOTE 3) | +| 7 | Allow | [13] | o | do | +| 8 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 3) | +| 9 | Answer-Mode | [94] | o | IF table 6.1.3.1/90 THEN do (NOTE 3) | +| 10 | Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE 3) | +| 11 | Attestation-Info | [5] | n/a | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/123 THEN do (NOTE 3) | +| 12 | Call-ID | [13] | m | dm | +| 13 | Call-Info | [13] | o | IF dc4 (CCBS/CCNR/CCNL: clause 12.11/12.12/12.23) OR dc5 (announcements: clause 12.21) OR dc13 (eCNAM: clause 12.25) THEN dm ELSE do | +| 14 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 3) | +| 15 | Contact | [13] | m | dm | +| 16 | Content-Disposition | [13] | o | IF dc6 (AOC: clause 12.22) THEN dm ELSE do | +| 17 | Content-Encoding | [13] | o | do | +| 18 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 19 | Content-Language | [13] | o | do | +| 20 | Content-Length | [13] | t | dt | +| 21 | Content-Type | [13] | * | d* | +| 22 | CSeq | [13] | m | dm | +| 23 | Date | [13] | o | do | +| 24 | Expires | [13] | o | do | +| 25 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE 3) | +| 26 | From | [13] | m | dm | +| 27 | Geolocation | [68] | o | do | +| 28 | Geolocation-Routing | [68] | o | do | +| 29 | History-Info | [25] | o | IF dc7 (CDIV: clause 12.6) OR dc2 (PNM: clause 12.17) THEN dm ELSE IF table 6.1.3.1/50 AND initial request THEN do (NOTE 1, NOTE 3) | +| 30 | Identity | [206] | o | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/119 THEN do (NOTE 3) | +| 31 | In-Reply-To | [13] | o | do | +| 32 | Join | [55] | o | IF table 6.1.3.1/48 THEN do (NOTE 3) | +| 33 | Max-Breadth | [79] | o | do | +| 34 | Max-Forwards | [13] | m | dm | +| 35 | MIME-Version | [13] | o | do | +| 36 | Min-SE | [52] | o | do | +| 37 | Organization | [13] | o | do | +| 38 | Origination-Id | [5] | n/a | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/124 THEN do (NOTE 3) | +| 39 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 3) | +| 40 | P-Asserted-Identity | [44] | o | IF table 6.1.3.1/27 AND initial request THEN dm (NOTE 2, NOTE 3) | +| 41 | P-Asserted-Service | [26] | o | IF (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) AND table 6.1.3.1/77 AND initial request THEN do (NOTE 3) | +| 42 | P-Called-Party-ID | [24] | o | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/34 THEN do (NOTE 3) | +| 43 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 44 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 AND initial request THEN | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|--------------|------|------------|------------------| +| | | | | dm (NOTE 3) | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|------------------------------|-------|------------|------------------------------------------------------------------------------------------------------------------------------------| +| 45 | P-Early-Media | [74] | o | IF table 6.1.3.1/69 THEN do (NOTE 3) | +| 46 | P-Media-Authorization | [42] | o | dn/a | +| 47 | P-Preferred-Identity | [44] | o | dn/a | +| 48 | P-Preferred-Service | [26] | o | IF visited-to-home request on roaming II-NNI AND table 6.1.3.1/77 AND initial request THEN do (NOTE 3) | +| 49 | P-Private-Network-Indication | [84] | o | IF table 6.1.3.1/80 AND initial request THEN do (NOTE 3) | +| 50 | P-Profile-Key | [64] | o | IF table 6.1.3.1/59 AND initial request THEN do (NOTE 3) | +| 51 | P-Served-User | [85] | o | IF visited-to-home request on roaming II-NNI AND initial request being sent from "privileged sender" THEN dm (NOTE 3) | +| 52 | P-User-Database | [60] | o | dn/a | +| 53 | P-Visited-Network-ID | [24] | o | dn/a | +| 54 | Priority | [13] | o | do | +| 55 | Priority-Share | [5] | n/a | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/118 THEN do (NOTE 3) | +| 56 | Priority-Verstat | [5] | n/a | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/128 THEN do (NOTE 3) | +| 57 | Privacy | [34] | o | IF dc8 (OIP/OIR: clause 12.3) THEN dm ELSE do | +| 58 | Priv-Answer-Mode | [94] | o | IF table 6.1.3.1/90 THEN do (NOTE 3) | +| 59 | Proxy-Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE 3) | +| 60 | Proxy-Require | [13] | o | do | +| 61 | Reason | [48] | o | IF table 6.1.3.1/40 AND subsequent request THEN do (NOTE 3) | +| 62 | Record-Route | [13] | o | do | +| 63 | Recv-Info | [39] | m | IF table 6.1.3.1/17 THEN dm (NOTE 3) | +| 64 | Referred-By | [53] | o | IF dc9 (ECT: clause 12.13) OR dc10 (CONF: clause 12.19) THEN dm ELSE do | +| 65 | Reject-Contact | [51] | o | do | +| 66 | Relayed-Charge | [5] | n/a | dn/a | +| 67 | Replaces | [54] | o | IF dc11 (ECT: clause 12.13) OR dc12 (CONF: clause 12.19) THEN dm ELSE IF table 6.1.3.1/47 THEN do (NOTE 3) | +| 68 | Reply-To | [13] | o | do | +| 69 | Request-Disposition | [51] | o | do | +| 70 | Require | [13] | c | IF dc11 (ECT: clause 12.13) THEN dm ELSE dc | +| 71 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 3) | +| 72 | Resource-Share | [5] | n/a | IF (home-to-visited request on roaming II-NNI OR visited-to-home request on roaming II-NNI) AND table 6.1.3.1/116 THEN do (NOTE 3) | +| 73 | Restoration-Info | [5] | n/a | IF home-to-visited request on roaming II-NNI AND initial request AND table 6.1.3.1/113 THEN do (NOTE 3) | +| 74 | Route | [13] | c | dc | +| 75 | Security-Client | [47] | o | dn/a | +| 76 | Security-Verify | [47] | o | dn/a | +| 77 | Service-Interact-Info | [5] | n/a | IF table 6.1.3.1/125 AND initial request THEN do (NOTE 3) | +| 78 | Session-Expires | [52] | o | do | +| 79 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE 3) | +| 80 | Subject | [13] | o | do | +| 81 | Supported | [13] | m* | IF dc2 (PNM: clause 12.17) THEN dm ELSE dm* | +| 82 | Target-Dialog | [140] | o | IF table 6.1.3.1/102 THEN do (NOTE 3) | +| 83 | Timestamp | [13] | o | do | +| 84 | To | [13] | m | dm | +| 85 | Trigger-Consent | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE 3) | +| 86 | User-Agent | [13] | o | do | +| 87 | User-to-User | [83] | o | IF table 6.1.3.1/79 THEN do (NOTE 3) | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|------------|------------------| +| 88 | Via | [13] | m | dm | +| dc1: | request invoked due to AOC AND visited-to-home request on roaming II-NNI | | | | +| dc2: | initial request invoked due to PNM in case of ("PN UE redirection" OR "PN access control") AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc3: | initial request invoked due to CRS AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc4: | initial request invoked due to CCBS/CCNR/CCNL AND "CC call" request AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc5: | subsequent request invoked due to announcements using the Call-info header field AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc6: | request invoked due to AOC AND home-to-visited request on roaming II-NNI | | | | +| dc7: | initial request towards the network serving "the diverted-to user" AND CFU/CFB/CFNR/CFNRc/CD/CFNL AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc8: | (initial request invoked due to OIP/OIR AND "override the default setting" in temporary mode AND visited-to-home request on roaming II-NNI) OR (initial request invoked due to OIP/OIR AND "presentation of the public user identity is restricted" AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI)) | | | | +| dc9: | initial request invoked due to ECT AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc10: | (initial request from "conference participant" receiving REFER request with Referred-By header field AND (visited-to-home request on roaming II-NNI OR non-roaming II-NNI OR loopback traversal scenario)) OR (initial request from "conference focus" receiving REFER request AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI)) | | | | +| dc11: | "Consultative transfer" due to ECT AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc12: | initial request from "conference focus" receiving REFER request with Replaces header field escaped in Refer-To header field AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc13: | initial request AND home-to-visited request on roaming II-NNI | | | | +| NOTE 1: | The Privacy header field can be escaped in the header field for CDIV. | | | | +| NOTE 2: | The header field is not included in some exceptional cases. (e.g. when an incoming call from a circuit-switched network has not included the required information to be mapped into the header field) | | | | +| NOTE 3: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.7.2 lists the supported header fields within the INVITE response. + +**Table B.7.2: Supported header fields within the INVITE response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|--------------------------|-----------------|-------------|------------|--------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | 2xx | [13] | o | do | +| | | 415 | | c | dc | +| 2 | Accept-Encoding | 2xx | [13] | o | do | +| | | 415 | | c | dc | +| 3 | Accept-Language | 2xx | [13] | o | do | +| | | 415 | | c | dc | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do
(NOTE 3) | +| 5 | Alert-Info | 180 | [13] | o | IF dc1 (CW: clause 12.7) OR
dc2 (announcements: clause 12.21)
THEN dm ELSE IF table 6.1.3.1/10
THEN do (NOTE 3) | +| 6 | Allow | 2xx | [13] | m* | dm* | +| | | 405 | | m | dm | +| | | others | | o | do | +| 7 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do
(NOTE 3) | +| 8 | Answer-Mode | 2xx | [94] | o | IF table 6.1.3.1/90 THEN do
(NOTE 3) | +| 9 | Authentication-Info | 2xx | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE 3) | +| 10 | Call-ID | 100 | [13] | m | dm | +| | | others | | | | +| 11 | Call-Info | r | [13] | o | IF dc3 (CCBS: clause 12.11) OR
dc4 (CCNR: clause 12.12) OR
dc5 (CCNL: clause 12.23) THEN dm
ELSE do | +| 12 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do
(NOTE 3) | +| 13 | Contact | 18x | [13]
[5] | o | dm | +| | | 199 | | | | +| | | 2xx | | m | dm | +| | | 3xx
485 | | o | do | +| 14 | Content-Disposition | r | [13] | o | IF dc6 (AOC: clause 12.22) THEN dm
ELSE do | +| 15 | Content-Encoding | r | [13] | o | do | +| 16 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 17 | Content-Language | r | [13] | o | do | +| 18 | Content-Length | 100
others | [13] | t | dt | +| 19 | Content-Type | r | [13] | * | IF dc7 (CCBS: clause 12.11) OR
dc8 (CCNR/CCNL:
clause 12.12/12.23) THEN dm ELSE
d* | +| 20 | CSeq | 100 | [13] | m | dm | +| | | others | | | | +| 21 | Date | 100
others | [13] | o | IF dc7 (CCBS: clause 12.11) OR
dc8 (CCNR/CCNL:
clause 12.12/12.23) THEN dm ELSE
do | +| 22 | Error-Info | 3xx-6xx | [13] | o | IF dc9 (announcements:
clause 12.21) THEN dm ELSE IF
table 6.1.3.1/13 THEN do (NOTE 3) | +| 23 | Expires | r | [13] | o | do | +| 24 | Feature-Caps | 18x
2xx | [143] | o | IF table 6.1.3.1/103 THEN do
(NOTE 3) | +| 25 | From | 100
others | [13] | m | dm | +| 26 | Geolocation-Error | 424 | [68] | m | dm | +| | | others | | o | do | +| 27 | History-Info | r | [25] | o | IF table 6.1.3.1/50 AND response to
initial request THEN do (NOTE 2, | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-----------------------|----------------------|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | | NOTE 3, NOTE 4) | +| 28 | MIME-version | r | [13] | o | do | +| 29 | Min-SE | 422 | [52] | m | dm | +| 30 | Organization | r | [13] | o | do | +| 31 | P-Access-Network-Info | r | [24], [2 4A], [2 4B] | o | IF table 6.1.3.1/36 THEN do (NOTE 3) | +| 32 | P-Answer-State | 18x
2xx | [73] | o | IF table 6.1.3.1/68 THEN do (NOTE 3) | +| 33 | P-Asserted-Identity | r | [44] | o | IF dc11 (TIP/TIR: clause 12.4) THEN dm ELSE IF table 6.1.3.1/27 AND response to initial request THEN do (NOTE 3) | +| 34 | P-Charging-Function-Addresses | r | [24], [2 4A] | o | dn/a | +| 35 | P-Charging-Vector | 100 | [24], [24A] | o | dn/a | +| | | 18x, 2xx | | o | IF (table 6.1.3.1/38 AND response to initial request) OR dc 12(CONF: clause 12.19) THEN dm (NOTE 3) | +| | | 3xx-6xx | | o | do (NOTE 3) | +| 36 | P-Early-Media | 18x | [74] | o | IF dc13 (CAT: clause 12.14) OR dc14 (announcements: clause 12.21) THEN dm ELSE IF table 6.1.3.1/69 THEN do (NOTE 3) | +| 37 | P-Media-Authorization | 18x
2xx | [42] | o | dn/a | +| 38 | P-Preferred-Identity | r | [44] | o | dn/a | +| 39 | P-Refused-URI-List | 403 | [141] | o | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/101 THEN do (NOTE 3) | +| 40 | Permission-Missing | 470 | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE 3) | +| 41 | Priority-Share | 18x
2xx | [5] | n/a | IF home-to-visited response on roaming II-NNI AND table 6.1.3.1/118 THEN do (NOTE 3) | +| 42 | Privacy | r | [34] | o | IF dc15 (TIP/TIR: clause 12.4) THEN dm ELSE do | +| 43 | Priv-Answer-Mode | 2xx | [94] | o | IF table 6.1.3.1/90 THEN do (NOTE 3) | +| 44 | Proxy-Authenticate | 401 (NOTE 1) | [13] | o | do | +| | | 407 (NOTE 1) | | m | dm | +| 45 | Reason | 18x
199
3xx-6xx | [48] | o | IF dc16 (CW: clause 12.7) OR dc17 (ICB: clause 12.10.1) OR dc18 (announcements: clause 12.21) THEN dm ELSE IF table 6.1.3.1/40 OR ((non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/41B) THEN do (NOTE 3) | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-----------------------|------------------------------------------------------|-------|------------|--------------------------------------------------------------------------------------------------------------------------------------| +| | | 2xx | [48] | o | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/41B THEN do (NOTE 3) | +| 46 | Record-Route | 18x
199
2xx | [13] | o | do | +| 47 | Recv-Info | 18x
199
2xx | [39] | c | IF table 6.1.3.1/17 THEN dc (NOTE 3) | +| 48 | Relayed-Charge | r | [5] | n/a | dn/a | +| 49 | Reply-To | r | [13] | o | do | +| 50 | Require | r | [13] | c | IF dc19 (CAT: clause 12.14) THEN dm ELSE dc | +| 51 | Resource-Share | 18x
2xx | [5] | n/a | IF (home-to-visited response on roaming II-NNI OR visited-to-home response on roaming II-NNI) AND table 6.1.3.1/116 THEN do (NOTE 3) | +| 52 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 3) | +| 53 | Restoration-Info | 408 | [5] | n/a | IF table 6.1.3.1/114 AND response to initial request AND visited-to-home response on roaming II-NNI THEN do (NOTE 3) | +| 54 | Retry-After | 404
413
480
486
500
503
600
603 | [13] | o | do | +| 55 | RSeq | 18x
199 | [18] | o | do | +| 56 | Security-Server | 421
494 | [47] | o | dn/a | +| 57 | Server | r | [13] | o | do | +| 58 | Service-Interact-Info | 18x
2xx | [5] | n/a | IF table 6.1.3.1/125 AND response to initial request THEN do (NOTE 3) | +| 59 | Session-Expires | 2xx | [52] | o | do | +| 60 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE 3) | +| 61 | Supported | 2xx | [13] | m* | dm* | +| 62 | Timestamp | r | [13] | o | do | +| 63 | To | 100
others | [13] | m | dm | +| 64 | Unsupported | 420 | [13] | m | dm | +| 65 | User-Agent | r | [13] | o | do | +| 66 | User-to-User | r | [83] | o | IF table 6.1.3.1/79 THEN do (NOTE 3) | +| 67 | Via | 100
others | [13] | m | dm | +| 68 | Warning | r | [13] | o | IF dc20 (CDIV: clause 12.6) THEN dm ELSE do | +| 69 | WWW-Authenticate | 401
(NOTE 1) | [13] | m | dm | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------|------------|------------------| +| | | 407
(NOTE 1) | | o | do | +| dc1: | response invoked due to CW AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc2: | response to initial request invoked due to announcements using the Alert-Info header field AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc3: | 486 (Busy Here) response invoked due to CCBS AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc4: | 180 (Ringing) response invoked due to CCNR AND (non-roaming II-NNI OR loopback traversal scenario) | | | | | +| dc5: | 480 (Temporarily Unavailable) response invoked due to CCNL AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc6: | non-100 provisional response /200 (OK) response invoked due to AOC AND home-to-visited response on roaming II-NNI | | | | | +| dc7: | 486 (Busy Here) response invoked due to CCBS AND home-to-visited response on roaming II-NNI | | | | | +| dc8: | 480 (Temporarily Unavailable) response invoked due to CCNR/CCNL AND home-to-visited response on roaming II-NNI | | | | | +| dc9: | response to initial request invoked due to announcements using the Error-Info header field AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc11: | (TIP/TIR AND 2xx response to initial request AND (visited-to-home response on roaming II-NNI OR non-roaming II-NNI OR loopback traversal scenario)) OR (TIP/TIR AND response to initial request AND "presentation is allowed" AND home-to-visited response on roaming II-NNI) | | | | | +| dc12: | first response from "conference focus" to initial request AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc13: | reliable 18x response to initial request invoked due to CAT using ("forking model" OR "gateway model") AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc14: | 18x response to initial request invoked due to announcements authorizing early media AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc15: | (TIP/TIR AND non-100 response to initial request AND "override the default setting" in temporary mode AND visited-to-home response on roaming II-NNI) OR (TIP/TIR AND 2xx response to initial request AND "presentation of the network asserted identity is restricted" AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI)) | | | | | +| dc16: | 480 (Temporarily Unavailable) response invoked due to CW at the expiry of the "CW timer" | | | | | +| dc17: | 603 (Decline) response invoked due to "dynamic ICB" on an early dialog | | | | | +| dc18: | 183 (Session Progress) response to initial request invoked due to announcements authorizing early media when rejecting a communication request AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc19: | first 18x response to initial request invoked due to CAT using "early session model" AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc20: | 480 (Temporarily Unavailable)/486 (Busy Here) response to initial request AND CFU/CFB/CFNR/CFNRc/CD/CFNL in case "maximum number of diversions" exceeds AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| NOTE 1: | The SIP status code is only applicable over the roaming II-NNI. | | | | | +| NOTE 2: | The Privacy header field can be escaped in the header field for CDIV. | | | | | +| NOTE 3: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | +| NOTE 4: | History-Info header field is always included, if the AS supporting CDIV requirements is applied to the corresponding initial INVITE request applying CDIV at the home IMS network of the terminating user. | | | | | + +--- + +## B.8 MESSAGE method + +As described in table 6.1, the support of MESSAGE method over the II-NNI is based on bilateral agreement between the operators. + +The table B.8.1 lists the supported header fields within the MESSAGE request. + +**Table B.8.1: Supported header fields within the MESSAGE request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept-Contact | [51] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 2 | Additional-Identity | [5] | n/a | IF table 6.1.3.1/126 THEN do (NOTE) | +| 3 | Allow | [13], [19] | o | do | +| 4 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 5 | Attestation-Info | [5] | n/a | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/123 THEN do (NOTE) | +| 6 | Authorization | [13], [19] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 7 | Call-ID | [13], [19] | m | dm | +| 8 | Call-Info | [13], [19] | o | do | +| 9 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 10 | Content-Disposition | [13], [19] | o | do | +| 11 | Content-Encoding | [13], [19] | o | do | +| 12 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 13 | Content-Language | [13], [19] | o | do | +| 14 | Content-Length | [13], [19] | t | dt | +| 15 | Content-Type | [13], [19] | * | d* | +| 16 | CSeq | [13], [19] | m | dm | +| 17 | Date | [13], [19] | o | do | +| 18 | Expires | [13], [19] | o | do | +| 19 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 AND request outside an existing dialog THEN do (NOTE) | +| 20 | From | [13], [19] | m | dm | +| 21 | Geolocation | [68] | o | do | +| 22 | Geolocation-Routing | [68] | o | do | +| 23 | History-Info | [25] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE IF table 6.1.3.1/50 AND request outside an existing dialog THEN do (NOTE) | +| 24 | Identity | [206] | o | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/119 THEN do (NOTE) | +| 25 | In-Reply-To | [13], [19] | o | do | +| 26 | Max-Breadth | [79] | o | do | +| 27 | Max-Forwards | [13], [19] | m | dm | +| 28 | MIME-Version | [13] | o | do | +| 29 | Organization | [13], [19] | o | do | +| 30 | Origination-Id | [5] | n/a | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/124 THEN do (NOTE) | +| 31 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 32 | P-Asserted-Identity | [44] | o | IF table 6.1.3.1/27 AND request outside an existing dialog THEN dm (NOTE) | +| 33 | P-Asserted-Service | [26] | o | IF (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 34 | P-Called-Party-ID | [24] | o | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/34 THEN do (NOTE) | +| 35 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 36 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 AND request outside an existing dialog THEN dm (NOTE) | +| 37 | P-Preferred-Identity | [44] | o | dn/a | +| 38 | P-Preferred-Service | [26] | o | IF visited-to-home request on roaming II-NNI AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 39 | P-Private-Network-Indication | [84] | o | IF table 6.1.3.1/80 AND request outside an existing dialog THEN do (NOTE) | +| 40 | P-Profile-Key | [64] | o | IF table 6.1.3.1/59 AND request outside an existing dialog THEN do (NOTE) | +| 41 | P-Served-User | [85] | o | IF visited-to-home request on roaming II-NNI AND request outside an existing dialog being sent from "privileged sender" THEN dm (NOTE) | +| 42 | P-User-Database | [60] | o | dn/a | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|------------|----------------------------------------------------------------------------| +| 43 | P-Visited-Network-ID | [24] | o | dn/a | +| 44 | Priority | [13], [19] | o | do | +| 45 | Privacy | [34] | o | IF dc2 (OIP/OIR: clause 12.3) THEN dm ELSE do | +| 46 | Proxy-Authorization | [13], [19] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 47 | Proxy-Require | [13], [19] | o | do | +| 48 | Reason | [48] | o | IF table 6.1.3.1/40 AND request inside an existing dialog THEN do (NOTE) | +| 49 | Referred-By | [53] | o | do | +| 50 | Reject-Contact | [51] | o | do | +| 51 | Relayed-Charge | [5] | n/a | dn/a | +| 52 | Reply-To | [13], [19] | o | do | +| 53 | Request-Disposition | [51] | o | do | +| 54 | Require | [13], [19] | c | dc | +| 55 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 56 | Route | [13], [19] | c | dc | +| 57 | Security-Client | [47] | o | dn/a | +| 58 | Security-Verify | [47] | o | dn/a | +| 59 | Service-Interact-Info | [5] | n/a | IF table 6.1.3.1/125 AND request outside an existing dialog THEN do (NOTE) | +| 60 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 61 | Subject | [13], [19] | o | do | +| 62 | Supported | [13] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 63 | Timestamp | [13], [19] | o | do | +| 64 | To | [13], [19] | m | dm | +| 65 | Trigger-Consent | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE) | +| 66 | User-Agent | [13], [19] | o | do | +| 67 | Via | [13], [19] | m | dm | +| dc1: | request outside an existing dialog invoked due to PNM in case of ("PN UE redirection" OR "PN access control") AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) | | | | +| dc2: | (request outside an existing dialog invoked due to OIP/OIR AND "override the default setting" in temporary mode AND visited-to-home request on roaming II-NNI) OR (request outside an existing dialog invoked due to OIP/OIR AND "presentation of the public user identity is restricted" AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI)) | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.8.2 lists the supported header fields within the MESSAGE response. + +**Table B.8.2: Supported header fields within the MESSAGE response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-----------------|--------------------|------------|------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | 415 | [13], [19] | m* | dm* | +| 2 | Accept-Encoding | 415 | [13], [19] | m* | dm* | +| 3 | Accept-Language | 415 | [13], [19] | m* | dm* | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405 | [13], [19] | m | dm | +| | | others | | o | do | +| 6 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 2) | +| 7 | Authentication-Info | 2xx | [13], [19] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100 | [13], [19] | m | dm | +| | | others | | | | +| 9 | Call-Info | r | [13], [19] | o | do | +| 10 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 11 | Contact | 3xx
485 | [13], [19] | o | do | +| 12 | Content-Disposition | r | [13], [19] | o | do | +| 13 | Content-Encoding | r | [13], [19] | o | do | +| 14 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | r | [13], [19] | o | do | +| 16 | Content-Length | 100 | [13], [19] | t | dt | +| | | others | | | | +| 17 | Content-Type | r | [13], [19] | * | d* | +| 18 | CSeq | 100 | [13], [19] | m | dm | +| | | others | | | | +| 19 | Date | 100 | [13], [19] | o | do | +| | | others | | | | +| 20 | Error-Info | 3xx-6xx | [13], [19] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 21 | Expires | r | [13], [19] | o | do | +| 22 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 23 | From | 100 | [13], [19] | m | dm | +| | | others | | | | +| 24 | Geolocation-Error | 424 | [68] | m | dm | +| | | others | | o | do | +| 25 | History-Info | r | [25] | o | IF table 6.1.3.1/50 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 26 | MIME-version | r | [13] | o | do | +| 27 | Organization | r | [13], [19] | o | do | +| 28 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 29 | P-Asserted-Identity | r | [44] | o | IF dc1 (TIP/TIR: clause 12.4) THEN dm ELSE IF table 6.1.3.1/27 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 30 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 31 | P-Charging-Vector | 100 | [24], | o | dn/a | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-----------------------|------------------------------------------------------|------------|------------|-----------------------------------------------------------------------------------------------| +| | | 18x, 2xx | [24A] | o | IF table 6.1.3.1/38 AND response to request outside an existing dialog THEN dm (NOTE 2) | +| | | 3xx-6xx | | o | do (NOTE 3) | +| 32 | P-Preferred-Identity | r | [44] | o | dn/a | +| 33 | Permission-Missing | 470 | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE 2) | +| 34 | Privacy | r | [34] | o | IF dc2(TIP/TIR: clause 12.4) THEN dm ELSE do | +| 35 | Proxy-Authenticate | 401 (NOTE 1) | [13], [19] | o | do | +| | | 407 (NOTE 1) | | m | dm | +| 36 | Reason | 18x
199
2xx
3xx-6xx | [48] | o | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/41B THEN do (NOTE 2) | +| 37 | Relayed-Charge | r | [5] | n/a | dn/a | +| 38 | Reply-To | r | [13], [19] | o | do | +| 39 | Require | r | [13], [19] | c | dc | +| 40 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | +| 41 | Restoration-Info | 504 | [5] | n/a | IF table 6.1.3.1/114 AND visited-to-home response on roaming II-NNI THEN do (NOTE 2) | +| 42 | Retry-After | 404
413
480
486
500
503
600
603 | [13], [19] | o | do | +| 43 | Security-Server | 421
494 | [47] | o | dn/a | +| 44 | Server | r | [13], [19] | o | do | +| 45 | Service-Interact-Info | 18x
2xx | [5] | n/a | IF table 6.1.3.1/125 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 46 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE 2) | +| 47 | Supported | 2xx | [13] | o | do | +| 48 | Timestamp | r | [13], [19] | o | do | +| 49 | To | 100
others | [13], [19] | m | dm | +| 50 | Unsupported | 420 | [13], [19] | o | do | +| 51 | User-Agent | r | [13], [19] | o | do | +| 52 | Via | 100
others | [13], [19] | m | dm | +| 53 | Warning | r | [13], [19] | o | do | +| 54 | WWW-Authenticate | 401 (NOTE 1) | [13], [19] | m | dm | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------|------------|------------------| +| | | 407
(NOTE 1) | | o | do | +| dc1: | (TIP/TIR AND 2xx response to request outside an existing dialog AND (visited-to-home response on roaming II-NNI OR non-roaming II-NNI)) OR (TIP/TIR AND response to request outside an existing dialog AND "presentation is allowed" AND home-to-visited response on roaming II-NNI) | | | | | +| dc2: | (TIP/TIR AND non-100 response to request outside an existing dialog AND "override the default setting" in temporary mode AND visited-to-home response on roaming II-NNI) OR (TIP/TIR AND 2xx response to request outside an existing dialog AND "presentation of the network asserted identity is restricted" AND (non-roaming II-NNI OR home-to-visited response on roaming II-NNI)) | | | | | +| NOTE 1: | The SIP status code is only applicable over the roaming II-NNI. | | | | | +| NOTE 2: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | + +--- + +## B.9 NOTIFY method + +As described in table 6.1, the support of NOTIFY method over the non-roaming II-NNI is based on bilateral agreement between the operators. + +The table B.9.1 lists the supported header fields within the NOTIFY request. + +**Table B.9.1: Supported header fields within the NOTIFY request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|-------------------------------------| +| 1 | Accept | [13], [20] | o | do | +| 2 | Accept-Contact | [51] | o | do | +| 3 | Accept-Encoding | [13], [20] | o | do | +| 4 | Accept-Language | [13], [20] | o | do | +| 5 | Allow | [13], [20] | o | do | +| 6 | Allow-Events | [20] | o | do | +| 7 | Authorization | [13], [20] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 8 | Call-ID | [13], [20] | m | dm | +| 9 | Call-Info | [13] | o | do | +| 10 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 11 | Contact | [13], [20] | m | dm | +| 12 | Content-Disposition | [13], [20] | o | do | +| 13 | Content-Encoding | [13], [20] | o | do | +| 14 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | [13], [20] | o | do | +| 16 | Content-Length | [13], [20] | t | dt | +| 17 | Content-Type | [13], [20] | * | d* | +| 18 | CSeq | [13], [20] | m | dm | +| 19 | Date | [13], [20] | o | do | +| 20 | Event | [20] | m | dm | +| 21 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE) | +| 22 | From | [13], [20] | m | dm | +| 23 | Geolocation | [68] | o | do | +| 24 | Geolocation-Routing | [68] | o | do | +| 25 | History-Info | [25] | o | IF table 6.1.3.1/50 THEN do (NOTE) | +| 26 | Max-Breadth | [79] | o | do | +| 27 | Max-Forwards | [13], [20] | m | dm | +| 28 | MIME-Version | [13], [20] | o | do | +| 29 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 30 | P-Asserted-Identity | [44] | o | IF table 6.1.3.1/27 THEN do (NOTE) | +| 31 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 32 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 THEN dm (NOTE) | +| 33 | P-Preferred-Identity | [44] | o | dn/a | +| 34 | Privacy | [34] | o | do | +| 35 | Proxy-Authorization | [13], [20] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 36 | Proxy-Require | [13], [20] | o | do | +| 37 | Reason | [48] | o | IF table 6.1.3.1/40 THEN do (NOTE) | +| 38 | Record-Route | [13], [20] | o | do | +| 39 | Referred-By | [53] | o | do | +| 40 | Reject-Contact | [51] | o | do | +| 41 | Relayed-Charge | [5] | n/a | dn/a | +| 42 | Request-Disposition | [51] | o | do | +| 43 | Require | [13], [20] | o | do | +| 44 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 45 | Route | [13], [20] | c | dc | +| 46 | Security-Client | [47] | o | dn/a | +| 47 | Security-Verify | [47] | o | dn/a | +| 48 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 49 | Subscription-State | [20] | m | dm | +| 50 | Supported | [13], [20] | o | do | +| 51 | Timestamp | [13], [20] | o | do | +| 52 | To | [13], [20] | m | dm | +| 53 | User-Agent | [13], [20] | o | do | +| 54 | Via | [13], [20] | m | dm | +| 55 | Warning | [13], [20] | o | do | + +NOTE: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +The table B.9.2 lists the supported header fields within the NOTIFY response. + +**Table B.9.2: Supported header fields within the NOTIFY response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|------------------------------|--------------------|-------------|--------------------------------------------------------------------------------------| +| 1 | Accept | 415 | [13], [20] | o | do | +| 2 | Accept-Encoding | 415 | [13], [20] | o | do | +| 3 | Accept-Language | 415 | [13], [20] | o | do | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405
others | [13], [20] | m
o | dm
do | +| 6 | Allow-Events | 2xx
489 | [20] | o
m | do
dm | +| 7 | Authentication-Info | 2xx | [13], [20] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100
others | [13], [20] | m | dm | +| 9 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 10 | Contact | 2xx
3xx
485 | [13], [20] | o
m
o | do
dm
do | +| 11 | Content-Disposition | r | [13], [20] | o | do | +| 12 | Content-Encoding | r | [13], [20] | o | do | +| 13 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 14 | Content-Language | r | [13], [20] | o | do | +| 15 | Content-Length | 100
others | [13], [20] | t | dt | +| 16 | Content-Type | r | [13], [20] | * | d* | +| 17 | CSeq | 100
others | [13], [20] | m | dm | +| 18 | Date | 100
others | [13], [20] | o | do | +| 19 | Error-Info | 3xx-6xx | [13], [20] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 20 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE 2) | +| 21 | From | 100
others | [13], [20] | m | dm | +| 22 | Geolocation-Error | 424
others | [68] | m
o | dm
do | +| 23 | MIME-version | r | [13], [20] | o | do | +| 24 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 25 | P-Asserted-Identity | r | [44] | o | IF table 6.1.3.1/27 THEN do (NOTE 2) | +| 26 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 27 | P-Charging-Vector | 100
18x, 2xx
3xx-6xx | [24], [24A] | o
o
o | dn/a
IF table 6.1.3.1/38 THEN dm (NOTE 2)
do (NOTE 3) | +| 28 | P-Preferred-Identity | r | [44] | o | dn/a | +| 29 | Privacy | r | [34] | o | do | +| 30 | Proxy-Authenticate | 401 (NOTE 1)
407 (NOTE 1) | [13], [20] | o
m | do
dm | +| 31 | Record-Route | 2xx | [13], [20] | o | do | +| 32 | Relayed-Charge | r | [5] | n/a | dn/a | +| 33 | Require | r | [13], [20] | o | do | +| 34 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | +| 35 | Restoration-Info | 504 | [5] | n/a | IF table 6.1.3.1/114 AND visited-to-home response on roaming II-NNI THEN do (NOTE 2) | +| 36 | Retry-After | 404 | [13], [20] | o | do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|------------------|-----------------------------------------------|------------|------------|-----------------------------------------| +| | | 413
480
486
500
503
600
603 | | | | +| 37 | Security-Server | 421
494 | [47] | o | dn/a | +| 38 | Server | r | [13], [20] | o | do | +| 39 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm
(NOTE 2) | +| 40 | Supported | 2xx | [13], [20] | o | do | +| 41 | Timestamp | r | [13], [20] | o | do | +| 42 | To | 100
others | [13], [20] | m | dm | +| 43 | Unsupported | 420 | [13], [20] | o | do | +| 44 | User-Agent | r | [13], [20] | o | do | +| 45 | Via | 100
others | [13], [20] | m | dm | +| 46 | Warning | r | [13], [20] | o | do | +| 47 | WWW-Authenticate | 401
(NOTE 1) | [13], [20] | m | dm | +| | | 407
(NOTE 1) | | o | do | + +NOTE 1: The SIP status code is only applicable over the roaming II-NNI. + +NOTE 2: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +--- + +## B.10 OPTIONS method + +The table B.10.1 lists the supported header fields within the OPTIONS request. + +**Table B.10.1: Supported header fields within the OPTIONS request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | [13] | m* | dm* | +| 2 | Accept-Contact | [51] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 3 | Accept-Encoding | [13] | o | do | +| 4 | Accept-Language | [13] | o | do | +| 5 | Allow | [13] | o | do | +| 6 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 7 | Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 8 | Call-ID | [13] | m | dm | +| 9 | Call-Info | [13] | o | do | +| 10 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 11 | Contact | [13] | o | do | +| 12 | Content-Disposition | [13] | o | do | +| 13 | Content-Encoding | [13] | o | do | +| 14 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | [13] | o | do | +| 16 | Content-Length | [13] | t | dt | +| 17 | Content-Type | [13] | * | d* | +| 18 | CSeq | [13] | m | dm | +| 19 | Date | [13] | o | do | +| 20 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 AND request outside an existing dialog THEN do (NOTE) | +| 21 | From | [13] | m | dm | +| 22 | Geolocation | [68] | o | do | +| 23 | Geolocation-Routing | [68] | o | do | +| 24 | History-Info | [25] | o | IF (dc1 (PNM: clause 12.17) THEN dm ELSE IF table 6.1.3.1/50 AND request outside an existing dialog THEN do (NOTE) | +| 25 | Max-Breadth | [79] | o | do | +| 26 | Max-Forwards | [13] | m | dm | +| 27 | MIME-Version | [13] | o | do | +| 28 | Organization | [13] | o | do | +| 29 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 30 | P-Asserted-Identity | [44] | o | IF table 6.1.3.1/27 AND request outside an existing dialog THEN dm (NOTE) | +| 31 | P-Asserted-Service | [26] | o | IF (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 32 | P-Called-Party-ID | [24] | o | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/34 THEN do (NOTE) | +| 33 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 34 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 AND request outside an existing dialog THEN dm (NOTE) | +| 35 | P-Preferred-Identity | [44] | o | dn/a | +| 36 | P-Preferred-Service | [26] | o | IF visited-to-home request on roaming II-NNI AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 37 | P-Private-Network-Indication | [84] | o | IF table 6.1.3.1/80 AND request outside an existing dialog THEN do (NOTE) | +| 38 | P-Profile-Key | [64] | o | IF table 6.1.3.1/59 AND request outside an existing dialog THEN do (NOTE) | +| 39 | P-Served-User | [85] | o | IF visited-to-home request on roaming II-NNI AND request outside an existing dialog being sent from "privileged sender" THEN dm (NOTE) | +| 40 | P-User-Database | [60] | o | dn/a | +| 41 | P-Visited-Network-ID | [24] | o | dn/a | +| 42 | Privacy | [34] | o | IF dc2 (OIP/OIR: clause 12.3) THEN dm ELSE do | +| 43 | Proxy-Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 44 | Proxy-Require | [13] | o | do | +| 45 | Reason | [48] | o | IF table 6.1.3.1/40 AND request inside an existing dialog THEN do (NOTE) | +| 46 | Record-Route | [13] | o | do | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------------|--------------------------------------------| +| 47 | Recv-Info | [39] | n/a | dn/a | +| 48 | Referred-By | [53] | o | do | +| 49 | Reject-Contact | [51] | o | do | +| 50 | Relayed-Charge | [5] | n/a | dn/a | +| 51 | Request-Disposition | [51] | o | do | +| 52 | Require | [13] | c | dc | +| 53 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 54 | Route | [13] | c | dc | +| 55 | Security-Client | [47] | o | dn/a | +| 56 | Security-Verify | [47] | o | dn/a | +| 57 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 58 | Supported | [13] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 59 | Timestamp | [13] | o | do | +| 60 | To | [13] | m | dm | +| 61 | User-Agent | [13] | o | do | +| 62 | Via | [13] | m | dm | +| dc1: | request outside an existing dialog invoked due to PNM in case of ("PN UE redirection" OR "PN access control") AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) | | | | +| dc2: | (request outside an existing dialog invoked due to OIP/OIR AND "override the default setting" in temporary mode AND visited-to-home request on roaming II-NNI) OR (request outside an existing dialog invoked due to OIP/OIR AND "presentation of the public user identity is restricted" AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI)) | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.10.2 lists the supported header fields within the OPTIONS response. + +**Table B.10.2: Supported header fields within the OPTIONS response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------------|----------------------|------------|------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | 2xx | [13] | m* | dm* | +| | | 415 | | c | dc | +| 2 | Accept-Encoding | 2xx | [13] | m* | dm* | +| | | 415 | | c | dc | +| 3 | Accept-Language | 2xx | [13] | m* | dm* | +| | | 415 | | c | dc | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 2xx | [13] | m* | dm* | +| | | 405 | | m | dm | +| | | others | | o | do | +| 6 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 2) | +| 7 | Authentication-Info | 2xx | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100 | [13] | m | dm | +| | | others | | | | +| 9 | Call-Info | r | [13] | o | do | +| 10 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 11 | Contact | 2xx
3xx
485 | [13] | o | do | +| 12 | Content-Disposition | r | [13] | o | do | +| 13 | Content-Encoding | r | [13] | o | do | +| 14 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | r | [13] | o | do | +| 16 | Content-Length | 100 | [13] | t | dt | +| | | others | | | | +| 17 | Content-Type | r | [13] | * | d* | +| 18 | CSeq | 100 | [13] | m | dm | +| | | others | | | | +| 19 | Date | 100 | [13] | o | do | +| | | others | | | | +| 20 | Error-Info | 3xx-6xx | [13] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 21 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 22 | From | 100 | [13] | m | dm | +| | | others | | | | +| 23 | Geolocation-Error | 424 | [68] | m | dm | +| | | others | | o | do | +| 24 | History-Info | r | [25] | o | IF table 6.1.3.1/50 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 25 | MIME-version | r | [13] | o | do | +| 26 | Organization | r | [13] | o | do | +| 27 | P-Access-Network-Info | r | [24], [2 4A], [2 4B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 28 | P-Asserted-Identity | r | [44] | o | IF dc1 (TIP/TIR: clause 12.4) THEN dm ELSE IF table 6.1.3.1/27 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 29 | P-Charging-Function-Addresses | r | [24], [2 4A] | o | dn/a | +| 30 | P-Charging-Vector | 100 | [24], | o | dn/a | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|-------|------------|-----------------------------------------------------------------------------------------|--| +| | | 18x, 2xx | [24A] | o | IF table 6.1.3.1/38 AND response to request outside an existing dialog THEN dm (NOTE 2) | | +| | | 3xx-6xx | | o | do (NOTE 2) | | +| 31 | P-Preferred-Identity | r | [44] | o | dn/a | | +| 32 | Privacy | r | [34] | o | IF dc2 (TIP/TIR: clause 12.4) THEN dm ELSE do | | +| 33 | Proxy-Authenticate | 401 (NOTE 1) | [13] | o | do | | +| | | 407 (NOTE 1) | | m | dm | | +| 34 | Record-Route | 2xx | [13] | o | do | | +| 35 | Recv-Info | 2xx
others | [39] | n/a | dn/a | | +| 36 | Relayed-Charge | r | [5] | n/a | dn/a | | +| 37 | Require | r | [13] | c | dc | | +| 38 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | | +| 39 | Restoration-Info | 504 | [5] | n/a | IF table 6.1.3.1/114 AND visited-to-home response on roaming II-NNI THEN do (NOTE 2) | | +| 40 | Retry-After | 404
413
480
486
500
503
600
603 | [13] | o | do | | +| 41 | Security-Server | 421
494 | [47] | o | dn/a | | +| 42 | Server | r | [13] | o | do | | +| 43 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE 2) | | +| 44 | Supported | 2xx | [13] | m* | dm* | | +| 45 | Timestamp | r | [13] | o | do | | +| 46 | To | 100
others | [13] | m | dm | | +| 47 | Unsupported | 420 | [13] | m | dm | | +| 48 | User-Agent | r | [13] | o | do | | +| 49 | Via | 100
others | [13] | m | dm | | +| 50 | Warning | r | [13] | o | do | | +| 51 | WWW-Authenticate | 401 (NOTE 1) | [13] | m | dm | | +| | | 407 (NOTE 1) | | o | do | | +| dc1: | (TIP/TIR AND 2xx response to request outside an existing dialog AND (visited-to-home response on roaming II-NNI OR non-roaming II-NNI)) OR (TIP/TIR AND response to request outside an existing dialog AND "presentation is allowed" AND home-to-visited response on roaming II-NNI) | | | | | | +| dc2: | (TIP/TIR AND non-100 response to request outside an existing dialog AND "override the default setting" in temporary mode AND visited-to-home response on roaming II-NNI) OR (TIP/TIR AND 2xx response to request outside an existing dialog AND "presentation of the network asserted identity is restricted" AND (non-roaming II-NNI OR home-to-visited response on roaming II-NNI)) | | | | | | +| NOTE 1: | The SIP status code is only applicable over the roaming II-NNI. | | | | | | +| NOTE 2: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | | + +--- + +## B.11 PRACK method + +The table B.11.1 lists the supported header fields within the PRACK request. + +**Table B.11.1: Supported header fields within the PRACK request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|------------|----------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | [13], [18] | o | do | +| 2 | Accept-Contact | [51] | o | do | +| 3 | Accept-Encoding | [13], [18] | o | do | +| 4 | Accept-Language | [13], [18] | o | do | +| 5 | Allow | [13], [18] | o | do | +| 6 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 7 | Authorization | [13], [18] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 8 | Call-ID | [13], [18] | m | dm | +| 9 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 10 | Content-Disposition | [13], [18] | o | do | +| 11 | Content-Encoding | [13], [18] | o | do | +| 12 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 13 | Content-Language | [13], [18] | o | do | +| 14 | Content-Length | [13], [18] | t | dt | +| 15 | Content-Type | [13], [18] | * | d* | +| 16 | CSeq | [13], [18] | m | dm | +| 17 | Date | [13], [18] | o | do | +| 18 | From | [13], [18] | m | dm | +| 19 | Max-Breadth | [79] | o | do | +| 20 | Max-Forwards | [13], [18] | m | dm | +| 21 | MIME-Version | [13], [18] | o | do | +| 22 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 23 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 24 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 THEN do (NOTE) | +| 25 | P-Early-Media | [74] | o | IF dc1 (CAT: clause 12.14) THEN dm ELSE IF table 6.1.3.1/69 THEN do (NOTE) | +| 26 | Priority-Share | [5] | n/a | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/118 THEN do (NOTE) | +| 27 | Privacy | [34] | o | do | +| 28 | Proxy-Authorization | [13], [18] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 29 | Proxy-Require | [13], [18] | o | do | +| 30 | RAck | [18] | m | dm | +| 31 | Reason | [48] | o | IF table 6.1.3.1/40 THEN do (NOTE) | +| 32 | Record-Route | [13], [18] | o | do | +| 33 | Recv-Info | [39] | o | IF table 6.1.3.1/17 THEN do (NOTE) | +| 34 | Referred-By | [53] | o | do | +| 35 | Reject-Contact | [51] | o | do | +| 36 | Relayed-Charge | [5] | n/a | dn/a | +| 37 | Request-Disposition | [51] | o | do | +| 38 | Require | [13], [18] | c | dc | +| 39 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 40 | Resource-Share | [5] | n/a | IF (home-to-visited request on roaming II-NNI OR visited-to-home request on roaming II-NNI) AND table 6.1.3.1/116 THEN do (NOTE) | +| 41 | Route | [13], [18] | c | dc | +| 42 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 43 | Supported | [13], [18] | o | do | +| 44 | Timestamp | [13], [18] | o | do | +| 45 | To | [13], [18] | m | dm | +| 46 | User-Agent | [13], [18] | o | do | +| 47 | Via | [13], [18] | m | dm | +| dc1: | request invoked due to CAT to first 18x response with P-Early-Media header field cancelling "CAT service" provided by terminating AS AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.11.2 lists the supported header fields within the PRACK response. + +**Table B.11.2: Supported header fields within the PRACK response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-----------------|--------------------|------------|--------------------------------------------------------------------------------------| +| 1 | Accept | 415 | [13], [18] | c | dc | +| 2 | Accept-Encoding | 415 | [13], [18] | c | dc | +| 3 | Accept-Language | 415 | [13], [18] | c | dc | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405 | [13], [18] | m | dm | +| | | others | | o | do | +| 6 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 2) | +| 7 | Authentication-Info | 2xx | [13], [18] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100 | [13], [18] | m | dm | +| | | r | | | | +| 9 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 10 | Contact | 3xx
485 | [13], [18] | o | do | +| 11 | Content-Disposition | r | [13], [18] | o | do | +| 12 | Content-Encoding | r | [13], [18] | o | do | +| 13 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 14 | Content-Language | r | [13], [18] | o | do | +| 15 | Content-Length | 100 | [13], [18] | t | dt | +| | | others | | | | +| 16 | Content-Type | r | [13], [18] | * | d* | +| 17 | CSeq | 100 | [13], [18] | m | dm | +| | | others | | | | +| 18 | Date | 100 | [13], [18] | o | do | +| | | others | | | | +| 19 | Error-Info | 3xx-6xx | [13], [18] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 20 | From | 100 | [13], [18] | m | dm | +| | | others | | | | +| 21 | MIME-version | r | [13], [18] | o | do | +| 22 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 23 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 24 | P-Charging-Vector | 100 | [24], [24A] | o | dn/a | +| | | others | | o | IF table 6.1.3.1/38 THEN do (NOTE 2) | +| 25 | P-Early-Media | 2xx | [74] | o | IF table 6.1.3.1/69 THEN do (NOTE 2) | +| 26 | Priority-Share | 2xx | [5] | n/a | IF home-to-visited response on roaming II-NNI AND table 6.1.3.1/118 THEN do (NOTE 2) | +| 27 | Privacy | r | [34] | o | do | +| 28 | Proxy-Authenticate | 401 (NOTE 1) | [13], [18] | o | do | +| | | 407 (NOTE 1) | | m | dm | +| 29 | Record-Route | 2xx | [13], [18] | o | do | +| 30 | Recv-Info | 2xx | [39] | c | IF table 6.1.3.1/17 THEN dc (NOTE 2) | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|------------------|------------------------------------------------------|------------|------------|--------------------------------------------------------------------------------------------------------------------------------------| +| | | others | | o | IF table 6.1.3.1/17 THEN do (NOTE 2) | +| 31 | Relayed-Charge | r | [5] | n/a | dn/a | +| 32 | Require | r | [13], [18] | c | dc | +| 33 | Resource-Share | 2xx | [5] | n/a | IF (home-to-visited response on roaming II-NNI OR visited-to-home response on roaming II-NNI) AND table 6.1.3.1/116 THEN do (NOTE 2) | +| 34 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | +| 35 | Retry-After | 404
413
480
486
500
503
600
603 | [13], [18] | o | do | +| 36 | Security-Server | 421
494 | [47] | n/a | dn/a | +| 37 | Server | r | [13], [18] | o | do | +| 38 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE 2) | +| 39 | Supported | 2xx | [13], [18] | o | do | +| 40 | Timestamp | r | [13], [18] | o | do | +| 41 | To | 100
others | [13], [18] | m | dm | +| 42 | Unsupported | 420 | [13], [18] | m | dm | +| 43 | User-Agent | r | [13], [18] | o | do | +| 44 | Via | 100
others | [13], [18] | m | dm | +| 45 | Warning | r | [13], [18] | o | do | +| 46 | WWW-Authenticate | 401
(NOTE 1) | [13], [18] | m | dm | +| | | 407
(NOTE 1) | | o | do | + +NOTE 1: The SIP status code is only applicable over the roaming II-NNI. + +NOTE 2: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +--- + +## B.12 PUBLISH method + +As described in table 6.1, the support of PUBLISH method over the non-roaming II-NNI is based on bilateral agreement between the operators. + +The table B.12.1 lists the supported header fields within the PUBLISH request. + +**Table B.12.1: Supported header fields within the PUBLISH request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept-Contact | [51] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 2 | Allow | [13], [21] | o | do | +| 3 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 4 | Authorization | [13], [21] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 5 | Call-ID | [13], [21] | m | dm | +| 6 | Call-Info | [13], [21] | o | IF dc2 (CCBS/CCNR/CCNL: clause 12.11/12.12/12.23) THEN dm ELSE do | +| 7 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 8 | Contact | [13], [21] | n/a | dn/a | +| 9 | Content-Disposition | [13], [21] | o | do | +| 10 | Content-Encoding | [13], [21] | o | do | +| 11 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 12 | Content-Language | [13], [21] | o | do | +| 13 | Content-Length | [13], [21] | t | dt | +| 14 | Content-Type | [13], [21] | * | d* | +| 15 | CSeq | [13], [21] | m | dm | +| 16 | Date | [13], [21] | o | do | +| 17 | Event | [20] | m | dm | +| 18 | Expires | [13], [21] | o | IF dc2 (CCBS/CCNR/CCNL: clause 12.11/12.12/12.23) THEN dm ELSE do | +| 19 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 AND request outside an existing dialog THEN do | +| 20 | From | [13], [21] | m | dm | +| 21 | Geolocation | [68] | o | do | +| 22 | Geolocation-Routing | [68] | o | do | +| 23 | History-Info | [25] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE IF table 6.1.3.1/50 AND request outside an existing dialog THEN do (NOTE) | +| 24 | In-Reply-To | [13], [21] | n/a | dn/a | +| 25 | Max-Breadth | [79] | o | do | +| 26 | Max-Forwards | [13], [21] | m | dm | +| 27 | MIME-Version | [13], [21] | o | do | +| 28 | Organization | [13], [21] | o | do | +| 29 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 30 | P-Asserted-Identity | [44] | o | IF dc2 (CCBS/CCNR/CCNL: clause 12.11/12.12/12.23) OR table 6.1.3.1/27 AND request outside an existing dialog THEN dm (NOTE) | +| 31 | P-Asserted-Service | [26] | o | IF (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 32 | P-Called-Party-ID | [24] | o | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/34 THEN do (NOTE) | +| 33 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 34 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 AND request outside an existing dialog THEN dm (NOTE) | +| 35 | P-Preferred-Identity | [44] | o | dn/a | +| 36 | P-Preferred-Service | [26] | o | IF visited-to-home request on roaming II-NNI AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 37 | P-Private-Network-Indication | [84] | o | IF table 6.1.3.1/80 AND request outside an existing dialog THEN do (NOTE) | +| 38 | P-Profile-Key | [64] | o | IF table 6.1.3.1/59 AND request outside an existing dialog THEN do (NOTE) | +| 39 | P-Served-User | [85] | o | IF visited-to-home request on roaming II-NNI AND request outside an existing dialog being sent from "privileged sender" THEN dm (NOTE) | +| 40 | P-User-Database | [60] | o | dn/a | +| 41 | P-Visited-Network-ID | [24] | o | dn/a | +| 42 | Priority | [13], [21] | o | do | +| 43 | Privacy | [34] | o | IF dc3 (OIP/OIR: clause 12.3) THEN dm ELSE do | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|------------|--------------------------------------------------------------------------| +| 44 | Proxy-Authorization | [13], [21] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 45 | Proxy-Require | [13], [21] | o | do | +| 46 | Reason | [48] | o | IF table 6.1.3.1/40 AND request inside an existing dialog THEN do (NOTE) | +| 47 | Referred-By | [53] | o | do | +| 48 | Reject-Contact | [51] | o | do | +| 49 | Relayed-Charge | [5] | n/a | dn/a | +| 50 | Reply-To | [13], [21] | n/a | dn/a | +| 51 | Request-Disposition | [51] | o | do | +| 52 | Require | [13], [21] | o | do | +| 53 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 54 | Route | [13], [21] | c | dc | +| 55 | Security-Client | [47] | o | dn/a | +| 56 | Security-Verify | [47] | o | dn/a | +| 57 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 58 | SIP-If-Match | [21] | o | do | +| 59 | Subject | [13], [21] | o | do | +| 60 | Supported | [13], [21] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 61 | Timestamp | [13], [21] | o | do | +| 62 | To | [13], [21] | m | dm | +| 63 | User-Agent | [13], [21] | o | do | +| 64 | Via | [13], [21] | m | dm | +| dc1: | request outside an existing dialog invoked due to PNM in case of ("PN UE redirection" OR "PN access control") AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) | | | | +| dc2: | (request inside an existing dialog invoked due to CCBS/CCNR/CCNL suspending the "CC request" AND (non-roaming II-NNI OR loopback traversal scenario) OR (request inside an existing dialog invoked due to CCBS/CCNR/CCNL resuming the "CC request" AND (non-roaming II-NNI OR loopback traversal scenario))) | | | | +| dc3: | (request outside an existing dialog invoked due to OIP/OIR AND "override the default setting" in temporary mode AND visited-to-home request on roaming II-NNI) OR (request outside an existing dialog invoked due to OIP/OIR AND "presentation of the public user identity is restricted" AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI)) | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.12.2 lists the supported header fields within the PUBLISH response. + +**Table B.12.2: Supported header fields within the PUBLISH response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-----------------|--------------------|------------|------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | 415 | [13], [21] | m* | dm* | +| 2 | Accept-Encoding | 415 | [13], [21] | m* | dm* | +| 3 | Accept-Language | 415 | [13], [21] | m* | dm* | +| 4 | Accept-Resource-Priority | 200
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405
others | [13], [21] | m
o | dm
do | +| 6 | Allow-Events | 489 | [20] | m | dm | +| 7 | Authentication-Info | 2xx | [13], [21] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100
others | [13], [21] | m | dm | +| 9 | Call-Info | r | [13], [21] | o | do | +| 10 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 11 | Contact | 3xx
485 | [13], [21] | o | do | +| 12 | Content-Disposition | r | [13], [21] | o | do | +| 13 | Content-Encoding | r | [13], [21] | o | do | +| 14 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | r | [13], [21] | o | do | +| 16 | Content-Length | 100
others | [13], [21] | t | dt | +| 17 | Content-Type | r | [13], [21] | * | d* | +| 18 | CSeq | 100
others | [13], [21] | m | dm | +| 19 | Date | 100
others | [13], [21] | o | do | +| 20 | Error-Info | 3xx-6xx | [13], [21] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 21 | Expires | 2xx
others | [13], [21] | m
o | dm
do | +| 22 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 AND response to request outside an existing dialog THEN do | +| 23 | From | 100
others | [13], [21] | m | dm | +| 24 | Geolocation-Error | 424
others | [68] | m
o | dm
do | +| 25 | History-Info | r | [25] | o | IF table 6.1.3.1/50 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 26 | MIME-version | r | [13], [21] | o | do | +| 27 | Min-Expires | 423 | [13], [21] | m | dm | +| 28 | Organization | r | [13], [21] | o | do | +| 29 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 30 | P-Asserted-Identity | r | [44] | o | IF dc1 (TIP/TIR: clause 12.4) THEN dm ELSE IF table 6.1.3.1/27 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 31 | P-Charging-Function-Addresses | r | [24], [24A], [24B] | o | dn/a | +| 32 | P-Charging-Vector | 100 | [24], | o | dn/a | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------|------------|-----------------------------------------------------------------------------------------|--| +| | | 18x, 2xx | [24A] | o | IF table 6.1.3.1/38 AND response to request outside an existing dialog THEN dm (NOTE 2) | | +| | | 3xx-6xx | | o | do (NOTE 2) | | +| 33 | P-Preferred-Identity | r | [44] | o | dn/a | | +| 34 | Privacy | r | [34] | o | IF dc2 (TIP/TIR: clause 12.4) THEN dm ELSE do | | +| 35 | Proxy-Authenticate | 401 (NOTE 1) | [13], [21] | o | do | | +| | | 407 (NOTE 1) | | m | dm | | +| 36 | Relayed-Charge | r | [5] | n/a | dn/a | | +| 37 | Require | r | [13], [21] | o | do | | +| 38 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | | +| 39 | Restoration-Info | 504 | [5] | n/a | IF table 6.1.3.1/114 AND visited-to-home response on roaming II-NNI THEN do (NOTE 2) | | +| 40 | Retry-After | 404
413
480
486
500
503
600
603 | [13], [21] | o | do | | +| 41 | Security-Server | 421
494 | [47] | o | dn/a | | +| 42 | Server | r | [13], [21] | o | do | | +| 43 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE 2) | | +| 44 | SIP-Etag | 2xx | [21] | m | dm | | +| 45 | Supported | 2xx | [13], [21] | o | do | | +| 46 | Timestamp | r | [13], [21] | o | do | | +| 47 | To | 100
others | [13], [21] | m | dm | | +| 48 | Unsupported | 420 | [13], [21] | o | do | | +| 49 | User-Agent | r | [13], [21] | o | do | | +| 50 | Via | 100
others | [13], [21] | m | dm | | +| 51 | Warning | r | [13], [21] | o | do | | +| 52 | WWW-Authenticate | 401 (NOTE 1) | [13], [21] | m | dm | | +| | | 407 (NOTE 1) | | o | do | | +| dc1: | (TIP/TIR AND 2xx response to request outside an existing dialog AND (visited-to-home response on roaming II-NNI OR non-roaming II-NNI)) OR (TIP/TIR AND response to request outside an existing dialog AND "presentation is allowed" AND home-to-visited response on roaming II-NNI) | | | | | | +| dc2: | (TIP/TIR AND non-100 response to request outside an existing dialog AND "override the default setting" in temporary mode AND visited-to-home response on roaming II-NNI) OR (TIP/TIR AND 2xx response to request outside an existing dialog AND "presentation of the network asserted identity is restricted" AND (non-roaming II-NNI OR home-to-visited response on roaming II-NNI)) | | | | | | +| NOTE 1: | The SIP status code is only applicable over the roaming II-NNI. | | | | | | +| NOTE 2: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | | + +--- + +## B.13 REFER method + +As described in table 6.1, the support of REFER method over the II-NNI is based on bilateral agreement between the operators. + +The table B.13.1 lists the supported header fields within the REFER request. + +**Table B.13.1: Supported header fields within the REFER request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | [13], [22] | o | do | +| 2 | Accept-Contact | [51] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 3 | Accept-Encoding | [13], [22] | o | do | +| 4 | Accept-Language | [13], [22] | o | do | +| 5 | Additional-Identity | [5] | n/a | IF table 6.1.3.1/126 THEN do (NOTE) | +| 6 | Allow | [13], [22] | o | do | +| 7 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 8 | Authorization | [13], [22] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 9 | Call-ID | [13], [22] | m | dm | +| 10 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 11 | Contact | [13], [22] | m | dm | +| 12 | Content-Disposition | [13], [22] | o | do | +| 13 | Content-Encoding | [13], [22] | o | do | +| 14 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | [13], [22] | o | do | +| 16 | Content-Length | [13], [22] | o | do | +| 17 | Content-Type | [13], [22] | * | d* | +| 18 | CSeq | [13], [22] | m | dm | +| 19 | Date | [13], [22] | o | do | +| 20 | Expires | [13], [22] | o | do | +| 21 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 AND request outside an existing dialog THEN do (NOTE) | +| 22 | From | [13], [22] | m | dm | +| 23 | Geolocation | [68] | o | do | +| 24 | Geolocation-Routing | [68] | o | do | +| 25 | History-Info | [25] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE IF table 6.1.3.1/50 AND request outside an existing dialog THEN do (NOTE) | +| 26 | Max-Breadth | [79] | o | do | +| 27 | Max-Forwards | [13], [22] | m | dm | +| 28 | MIME-Version | [13], [22] | o | do | +| 29 | Organization | [13], [22] | o | do | +| 30 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 31 | P-Asserted-Identity | [44] | o | IF table 6.1.3.1/27 AND request outside an existing dialog THEN dm (NOTE) | +| 32 | P-Asserted-Service | [26] | o | IF (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 33 | P-Called-Party-ID | [24], [24A] | o | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/34 THEN do (NOTE) | +| 34 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 35 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 AND request outside an existing dialog THEN dm (NOTE) | +| 36 | P-Preferred-Identity | [44] | o | dn/a | +| 37 | P-Preferred-Service | [26] | o | IF visited-to-home request on roaming II-NNI AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 38 | P-Private-Network-Indication | [84] | o | IF table 6.1.3.1/80 AND request outside an existing dialog THEN do (NOTE) | +| 39 | P-Profile-Key | [64] | o | IF table 6.1.3.1/59 AND request outside an existing dialog THEN do (NOTE) | +| 40 | P-Served-User | [85] | o | IF visited-to-home request on roaming II-NNI AND request outside an existing dialog being sent from "privileged sender" THEN dm (NOTE) | +| 41 | P-User-Database | [60] | o | dn/a | +| 42 | P-Visited-Network-ID | [24] | o | dn/a | +| 43 | Privacy | [34] | o | IF dc2 (OIP/OIR: clause 12.3) OR dc3 (ECT: clause 12.13) THEN dm ELSE do | +| 44 | Proxy-Authorization | [13], [22] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 45 | Proxy-Require | [13], [22] | o | do | +| 46 | Reason | [48] | o | IF table 6.1.3.1/40 AND request inside an existing dialog THEN do (NOTE) | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|------------|--------------------------------------------| +| 47 | Record-Route | [13], [22] | o | do | +| 48 | Refer-Sub | [135] | o | do | +| 49 | Refer-To | [22] | dm | dm | +| 50 | Referred-By | [53] | o | IF dc4 (ECT: clause 12.13) THEN dm ELSE do | +| 51 | Reject-Contact | [51] | o | do | +| 52 | Relayed-Charge | [5] | n/a | dn/a | +| 53 | Request-Disposition | [51] | o | do | +| 54 | Require | [13], [22] | c | dc | +| 55 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 56 | Route | [13], [22] | c | dc | +| 57 | Security-Client | [47] | o | dn/a | +| 58 | Security-Verify | [47] | o | dn/a | +| 59 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 60 | Supported | [13], [22] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 61 | Target-Dialog | [140] | o | IF table 6.1.3.1/102 THEN do (NOTE) | +| 62 | Timestamp | [13], [22] | o | do | +| 63 | To | [13], [22] | m | dm | +| 64 | Trigger-Consent | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE) | +| 65 | User-Agent | [13], [22] | o | do | +| 66 | Via | [13], [22] | m | dm | +| dc1: | request outside an existing dialog invoked due to PNM in case of ("PN UE redirection" OR "PN access control") AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) | | | | +| dc2: | (request outside an existing dialog invoked due to OIP/OIR AND "override the default setting" in temporary mode AND visited-to-home request on roaming II-NNI) OR (request outside an existing dialog invoked due to OIP/OIR AND "presentation of the public user identity is restricted" AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI)) | | | | +| dc3: | request inside an existing dialog invoked due to ECT including Referred-By header field with privacy requested in the "original communication" | | | | +| dc4: | request inside an existing dialog invoked due to ECT AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.13.2 lists the supported header fields within the REFER response. + +**Table B.13.2: Supported header fields within the REFER response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|----------------------------|--------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | 415 | [13], [22] | c | dc | +| 2 | Accept-Encoding | 415 | [13], [22] | c | dc | +| 3 | Accept-Language | 415 | [13], [22] | c | dc | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405
others | [13], [22] | m
o | dm
do | +| 6 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 2) | +| 7 | Authentication-Info | 2xx | [13], [22] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100
others | [13], [22] | m | dm | +| 9 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 10 | Contact | 2xx
3xx-6xx | [13], [22] | m
o | dm
do | +| 11 | Content-Disposition | r | [13], [22] | o | do | +| 12 | Content-Encoding | r | [13], [22] | o | do | +| 13 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 14 | Content-Language | r | [13], [22] | o | do | +| 15 | Content-Length | 100
others | [13], [22] | t | dt | +| 16 | Content-Type | r | [13], [22] | * | d* | +| 17 | CSeq | 100
others | [13], [22] | m | dm | +| 18 | Date | 100
others | [13], [22] | o | do | +| 19 | Error-Info | 3xx-6xx | [13], [22] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 20 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 21 | From | 100
others | [13], [22] | m | dm | +| 22 | Geolocation-Error | 424
others | [68] | m
o | dm
do | +| 23 | History-Info | r | [25] | o | IF table 6.1.3.1/50 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 24 | MIME-version | r | [13], [22] | o | do | +| 25 | Organization | r | [13], [22] | o | do | +| 26 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 27 | P-Asserted-Identity | r | [44] | o | IF dc1 (TIP/TIR: clause 12.4) THEN dm ELSE IF table 6.1.3.1/27 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 28 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 29 | P-Charging-Vector | 100
18x, 2xx
3xx-6xx | [24], [24A] | o
o
o | dn/a
IF dc2 (CONF: clause 12.19) OR (table 6.1.3.1/38 AND response to request outside an existing dialog) THEN dm (NOTE 2)
do (NOTE 2) | +| 30 | P-Preferred-Identity | r | [44] | o | dn/a | +| 31 | Permission-Missing | 470 | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE 2) | +| 32 | Privacy | r | [34] | o | IF dc3 (TIP/TIR: clause 12.4) THEN dm ELSE do | +| 33 | Proxy-Authenticate | 401 (NOTE 1) | [13], [22] | o | do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------|------------|--------------------------------------------------------------------------------------|--| +| | | 407
(NOTE 1) | | m | dm | | +| 34 | Record-Route | 2xx | [13], [22] | o | do | | +| 35 | Refer-Sub | 2xx | [135] | o | IF table 6.1.3.1/98 THEN do
(NOTE 2) | | +| 36 | Relayed-Charge | r | [5] | n/a | dn/a | | +| 37 | Require | r | [13], [22] | c | dc | | +| 38 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do
(NOTE 2) | | +| 39 | Restoration-Info | 504 | [5] | n/a | IF table 6.1.3.1/114 AND visited-to-home response on roaming II-NNI THEN do (NOTE 2) | | +| 40 | Retry-After | 404
413
480
486
500
503
600
603 | [13], [22] | o | do | | +| 41 | Security-Server | 421
494 | [47] | o | dn/a | | +| 42 | Server | r | [13], [22] | o | do | | +| 43 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm
(NOTE 2) | | +| 44 | Supported | 2xx | [13], [22] | o | do | | +| 45 | Timestamp | r | [13], [22] | o | do | | +| 46 | To | 100
others | [13], [22] | m | dm | | +| 47 | Unsupported | 420 | [13], [22] | o | do | | +| 48 | User-Agent | r | [13], [22] | o | do | | +| 49 | Via | 100
others | [13], [22] | m | dm | | +| 50 | Warning | r | [13], [22] | o | do | | +| 51 | WWW-Authenticate | 401
(NOTE 1) | [13], [22] | m | dm | | +| | | 407
(NOTE 1) | | o | do | | +| dc1: | (TIP/TIR AND 2xx response to request outside an existing dialog AND (visited-to-home response on roaming II-NNI OR non-roaming II-NNI)) OR (TIP/TIR AND response to request outside an existing dialog AND "presentation is allowed" AND home-to-visited response on roaming II-NNI) | | | | | | +| dc2: | first response from "conference focus" to request outside an existing dialog AND (non-roaming II-NNI OR home-to-visited response on roaming II-NNI) | | | | | | +| dc3: | (TIP/TIR AND non-100 response to request outside an existing dialog AND "override the default setting" in temporary mode AND visited-to-home response on roaming II-NNI) OR (TIP/TIR AND 2xx response to request outside an existing dialog AND "presentation of the network asserted identity is restricted" AND (non-roaming II-NNI OR home-to-visited response on roaming II-NNI)) | | | | | | +| NOTE 1: | The SIP status code is only applicable over the roaming II-NNI. | | | | | | +| NOTE 2: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | | + +--- + +## B.14 REGISTER method + +As described in table 6.1, the REGISTER method is supported only over the roaming II-NNI. + +The table B.14.1 lists the supported header fields within the REGISTER request. + +**Table B.14.1: Supported header fields within the REGISTER request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|-----------------------------------------------------------------------------------| +| 1 | Accept | [13] | o | do | +| 2 | Accept-Encoding | [13] | o | do | +| 3 | Accept-Language | [13] | o | do | +| 4 | Allow | [13] | o | do | +| 5 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 6 | Authorization | [13] | o | IF using IMS AKA OR using SIP digest THEN dm ELSE do | +| 7 | Call-ID | [13] | m | dm | +| 8 | Call-Info | [13] | o | do | +| 9 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 10 | Contact | [13] | o | dm | +| 11 | Content-Disposition | [13] | o | do | +| 12 | Content-Encoding | [13] | o | do | +| 13 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 14 | Content-Language | [13] | o | do | +| 15 | Content-Length | [13] | t | dt | +| 16 | Content-Type | [13] | * | d* | +| 17 | CSeq | [13] | m | dm | +| 18 | Date | [13] | o | do | +| 19 | Expires | [13] | o | do | +| 20 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE) | +| 21 | From | [13] | m | dm | +| 22 | Geolocation | [68] | o | do | +| 23 | Geolocation-Routing | [68] | o | do | +| 24 | History-Info | [25] | o | IF table 6.1.3.1/50 AND request outside an existing dialog THEN do (NOTE) | +| 25 | Max-Breadth | [79] | o | do | +| 26 | Max-Forwards | [13] | m | dm | +| 27 | MIME-Version | [13] | o | do | +| 28 | Organization | [13] | o | do | +| 29 | P-Access-Network-Info | [24] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 30 | P-Charging-Function-Addresses | [24], [24B] | o | dn/a | +| 31 | P-Charging-Vector | [24] | o | dm | +| 32 | P-User-Database | [60] | o | dn/a | +| 33 | P-Visited-Network-ID | [24] | o | dm | +| 34 | Path | [43] | o | dm | +| 35 | Privacy | [34] | o | dn/a | +| 36 | Proxy-Authorization | [13] | o | do | +| 37 | Proxy-Require | [13] | o | do | +| 38 | Reason | [48] | o | IF table 6.1.3.1/40 THEN do (NOTE) | +| 39 | Recv-Info | [39] | o | IF table 6.1.3.1/17 THEN do (NOTE) | +| 40 | Referred-By | [53] | o | do | +| 41 | Relayed-Charge | [5] | n/a | dn/a | +| 42 | Request-Disposition | [51] | o | do | +| 43 | Require | [13] | c | dm | +| 44 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 45 | Resource-Share | [5] | n/a | IF visited-to-home request on roaming II-NNI AND table 6.1.3.1/116 THEN do (NOTE) | +| 46 | Route | [13] | c | dn/a | +| 47 | Security-Client | [47] | o | dn/a | +| 48 | Security-Verify | [47] | o | dn/a | +| 49 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 50 | Supported | [13] | o | dm | +| 51 | Timestamp | [13] | o | do | +| 52 | To | [13] | m | dm | +| 53 | User-Agent | [13] | o | do | +| 54 | Via | [13] | m | dm | + +NOTE: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +The table B.14.2 lists the supported header fields within the REGISTER response. + +**Table B.14.2: Supported header fields within the REGISTER response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-----------------|--------------------|------------|---------------------------------------------------------------------------------------| +| 1 | Accept | 2xx | [13] | o | do | +| | | 415 | | c | dc | +| 2 | Accept-Encoding | 2xx | [13] | o | do | +| | | 415 | | c | dc | +| 3 | Accept-Language | 2xx | [13] | o | do | +| | | 415 | | c | dc | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 5 | Allow | 405 | [13] | m | dm | +| | | others | | o | do | +| 6 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 7 | Authentication-Info | 2xx | [13] | o | do | +| 8 | Call-ID | 100 | [13] | m | dm | +| | | others | | o | do | +| 9 | Call-Info | r | [13] | o | do | +| 10 | Contact | 2xx | [13] | o | dm | +| | | 3xx | | o | do | +| | | 485 | | o | do | +| 11 | Content-Disposition | r | [13] | o | do | +| 12 | Content-Encoding | r | [13] | o | do | +| 13 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 14 | Content-Language | r | [13] | o | do | +| 15 | Content-Length | 100 | [13] | t | dt | +| | | others | | o | do | +| 16 | Content-Type | r | [13] | * | d* | +| 17 | CSeq | 100 | [13] | m | dm | +| | | others | | o | do | +| 18 | Date | 100 | [13] | o | do | +| | | others | | o | do | +| 19 | Error-Info | 3xx-6xx | [13] | o | IF table 6.1.3.1/13 THEN do (NOTE) | +| 20 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE) | +| 21 | Flow-Timer | 2xx | [65] | o | do | +| 22 | From | 100 | [13] | m | dm | +| | | others | | o | do | +| 23 | Geolocation-Error | 424 | [68] | m | dm | +| | | others | | o | do | +| 24 | History-Info | r | [25] | o | IF table 6.1.3.1/50 AND response to request outside an existing dialog THEN do (NOTE) | +| 25 | MIME-version | r | [13] | o | do | +| 26 | Min-Expires | 423 | [13] | m | dm | +| 27 | Organization | r | [13] | o | do | +| 28 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 29 | P-Associated-URI | 2xx | [24] | o | dm | +| 30 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 31 | P-Charging-Vector | 100 | [24], [24A] | o | dn/a | +| | | 18x, 2xx | | o | dm | +| | | 3xx-6xx | | o | do | +| 32 | Path | 2xx | [43] | o | dm | +| 33 | Privacy | r | [34] | o | do | +| 34 | Proxy-Authenticate | 401 | [13] | o | do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|-------|------------|-------------------------------------| +| | | 407 | | m | dm | +| 35 | Relayed-Charge | r | [5] | n/a | dn/a | +| 36 | Require | r | [13] | c | dc | +| 37 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE) | +| 38 | Retry-After | 404
413
480
486
500
503
600
603 | [13] | o | do | +| 39 | Security-Server | 2xx
401 | [47] | n/a | dn/a | +| | | 421
494 | | o | dn/a | +| 40 | Server | r | [13] | o | do | +| 41 | Service-Route | 2xx | [45] | o | dm | +| 42 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 43 | Supported | 2xx | [13] | o | do | +| 44 | Timestamp | r | [13] | o | do | +| 45 | To | 100
others | [13] | m | dm | +| 46 | Unsupported | 420 | [13] | m | dm | +| 47 | User-Agent | r | [13] | o | do | +| 48 | Via | 100
others | [13] | m | dm | +| 49 | Warning | r | [13] | o | do | +| 50 | WWW-Authenticate | 401 | [13] | m | dm | +| | | 407 | | o | do | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | + +--- + +## B.15 SUBSCRIBE method + +As described in table 6.1, the support of SUBSCRIBE method over the non-roaming II-NNI is based on bilateral agreement between the operators. + +The table B.15.1 lists the supported header fields within the SUBSCRIBE request. + +**Table B.15.1: Supported header fields within the SUBSCRIBE request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | [13], [20] | o | do | +| 2 | Accept-Contact | [51] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 3 | Accept-Encoding | [13], [20] | o | do | +| 4 | Accept-Language | [13], [20] | o | do | +| 5 | Allow | [13], [20] | o | do | +| 6 | Allow-Events | [20] | o | do | +| 7 | Authorization | [13], [20] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 8 | Call-ID | [13], [20] | m | dm | +| 9 | Call-Info | [13], [20] | o | IF dc2 (CCBS/CCNR/CCNL: clause 12.11/12.12/12.23) THEN dm ELSE dn/a | +| 10 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 11 | Contact | [13], [20] | m | dm | +| 12 | Content-Disposition | [13], [20] | o | do | +| 13 | Content-Encoding | [13], [20] | o | do | +| 14 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | [13], [20] | o | do | +| 16 | Content-Length | [13], [20] | t | dt | +| 17 | Content-Type | [13], [20] | * | d* | +| 18 | CSeq | [13], [20] | m | dm | +| 19 | Date | [13], [20] | o | do | +| 20 | Event | [20] | m | dm | +| 21 | Expires | [13], [20] | o | IF dc2 (CCBS/CCNR/CCNL: clause 12.11/12.12/12.23) OR using reg event package THEN dm ELSE do | +| 22 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE) | +| 23 | From | [13], [20] | m | dm | +| 24 | Geolocation | [68] | o | do | +| 25 | Geolocation-Routing | [68] | o | do | +| 26 | History-Info | [25] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE IF table 6.1.3.1/50 AND initial request THEN do (NOTE) | +| 27 | Max-Breadth | [79] | o | dn/a | +| 28 | Max-Forwards | [13], [20] | m | dm | +| 29 | MIME-Version | [13], [20] | o | do | +| 30 | Organization | [13], [20] | o | do | +| 31 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 32 | P-Asserted-Identity | [44] | o | IF dc2 (CCBS/CCNR/CCNL: clause 12.11/12.12/12.23) OR table 6.1.3.1/27 AND initial request THEN dm (NOTE) | +| 33 | P-Asserted-Service | [26] | o | IF (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) AND table 6.1.3.1/77 AND initial request THEN do (NOTE) | +| 34 | P-Called-Party-ID | [24] | o | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/34 THEN do (NOTE) | +| 35 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 36 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 AND initial request THEN dm (NOTE) | +| 37 | P-Preferred-Identity | [44] | o | dn/a | +| 38 | P-Preferred-Service | [26] | o | IF visited-to-home request on roaming II-NNI AND table 6.1.3.1/77 AND initial request THEN do (NOTE) | +| 39 | P-Private-Network-Indication | [84] | o | IF table 6.1.3.1/80 AND initial request THEN do (NOTE) | +| 40 | P-Profile-Key | [64] | o | IF table 6.1.3.1/59 AND initial request THEN do (NOTE) | +| 41 | P-Served-User | [85] | o | IF visited-to-home request on roaming II-NNI AND initial request being sent from "privileged sender" THEN dm (NOTE) | +| 42 | P-User-Database | [60] | o | dn/a | +| 43 | P-Visited-Network-ID | [24] | o | dn/a | +| 44 | Priority | [13], [20] | o | do | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|------------|-----------------------------------------------------------| +| 45 | Privacy | [34] | o | IF dc3 (OIP/OIR: clause 12.3) THEN dm ELSE do | +| 46 | Proxy-Authorization | [13], [20] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 47 | Proxy-Require | [13], [20] | o | do | +| 48 | Reason | [48] | o | IF table 6.1.3.1/40 AND subsequent request THEN do (NOTE) | +| 49 | Record-Route | [13], [20] | o | do | +| 50 | Referred-By | [53] | o | do | +| 51 | Reject-Contact | [51] | o | do | +| 52 | Relayed-Charge | [5] | n/a | dn/a | +| 53 | Request-Disposition | [51] | o | do | +| 54 | Require | [13], [20] | o | do | +| 55 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 56 | Route | [13], [20] | c | dc | +| 57 | Security-Client | [47] | o | dn/a | +| 58 | Security-Verify | [47] | o | dn/a | +| 59 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 60 | Supported | [13], [20] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 61 | Target-Dialog | [140] | o | IF table 6.1.3.1/102 THEN do (NOTE) | +| 62 | Timestamp | [13], [20] | o | do | +| 63 | To | [13], [20] | m | dm | +| 64 | Trigger-Consent | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE) | +| 65 | User-Agent | [13], [20] | o | do | +| 66 | Via | [13], [20] | m | dm | +| dc1: | initial request invoked due to PNM in case of ("PN UE redirection" OR "PN access control") AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) | | | | +| dc2: | ("CC invocation request" due to CCBS/CCNR/CCNL AND non-roaming II-NNI) OR ("CC revocation request" due to CCBS/CCNR/CCNL AND non-roaming II-NNI) | | | | +| dc3: | (initial request invoked due to OIP/OIR AND "override the default setting" in temporary mode AND visited-to-home request on roaming II-NNI) OR (initial request invoked due to OIP/OIR AND "presentation of the public user identity is restricted" AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI)) | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.15.2 lists the supported header fields within the SUBSCRIBE response. + +**Table B.15.2: Supported header fields within the SUBSCRIBE response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|----------------------------|--------------------|-------------|-----------------------------------------------------------------------------------------------------------------| +| 1 | Accept | 415 | [13], [20] | o | do | +| 2 | Accept-Encoding | 415 | [13], [20] | o | do | +| 3 | Accept-Language | 415 | [13], [20] | o | do | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405
others | [13], [20] | m
o | dm
do | +| 6 | Allow-Events | 2xx
489 | [20] | o
m | do
dm | +| 7 | Authentication-Info | 2xx | [13], [20] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100
r | [13], [20] | m | dm | +| 9 | Call-Info | r | [13], [20] | o | do | +| 10 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 11 | Contact | 2xx
3xx
485 | [13], [20] | m
o | dm
do | +| 12 | Content-Disposition | r | [13], [20] | o | do | +| 13 | Content-Encoding | r | [13], [20] | o | do | +| 14 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | r | [13], [20] | o | do | +| 16 | Content-Length | 100
others | [13], [20] | t | dt | +| 17 | Content-Type | r | [13], [20] | * | d* | +| 18 | CSeq | 100
others | [13], [20] | m | dm | +| 19 | Date | 100
others | [13], [20] | o | do | +| 20 | Error-Info | 3xx-6xx | [13], [20] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 21 | Expires | 2xx | [13], [20] | m | dm | +| 22 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE 2) | +| 23 | From | 100
others | [13], [20] | m | dm | +| 24 | Geolocation-Error | 424
others | [68] | m
o | dm
do | +| 25 | History-Info | r | [25] | o | IF table 6.1.3.1/50 AND response to initial request THEN do (NOTE 2) | +| 26 | MIME-version | r | [13], [20] | o | do | +| 27 | Min-Expires | 423 | [13], [20] | m | dm | +| 28 | Organization | r | [13], [20] | o | do | +| 29 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 30 | P-Asserted-Identity | r | [44] | o | IF dc1 (TIP/TIR: clause 12.4) THEN dm ELSE IF table 6.1.3.1/27 AND response to initial request THEN do (NOTE 2) | +| 31 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 32 | P-Charging-Vector | 100
18x, 2xx
3xx-6xx | [24], [24A] | o
o
o | dn/a
IF table 6.1.3.1/38 AND response to initial request THEN dm (NOTE 2)
do | +| 33 | P-Preferred-Identity | r | [44] | o | dn/a | +| 34 | Permission-Missing | 470 | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE 2) | +| 35 | Privacy | r | [34] | o | IF dc2 (TIP/TIR: clause 12.4) THEN dm ELSE do | +| 36 | Proxy-Authenticate | 401 (NOTE 1)
407 | [13], [20] | o
m | do
dm | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | | | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------|------------|--------------------------------------------------------------------------------------|--|--|--|--|--|--| +| | | (NOTE 1) | | | | | | | | | | +| 37 | Record-Route | 2xx | [13], [20] | o | do | | | | | | | +| 38 | Relayed-Charge | r | [5] | n/a | dn/a | | | | | | | +| 39 | Require | r | [13], [20] | o | do | | | | | | | +| 40 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | | | | | | | +| 41 | Restoration-Info | 504 | [5] | n/a | IF table 6.1.3.1/114 AND visited-to-home response on roaming II-NNI THEN do (NOTE 2) | | | | | | | +| 42 | Retry-After | 404
413
480
486
500
503
600
603 | [13], [20] | o | do | | | | | | | +| 43 | Security-Server | 421
494 | [47] | o | dn/a | | | | | | | +| 44 | Server | r | [13], [20] | o | do | | | | | | | +| 45 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE 2) | | | | | | | +| 46 | Supported | 2xx | [13], [20] | o | do | | | | | | | +| 47 | Timestamp | r | [13], [20] | o | do | | | | | | | +| 48 | To | 100
others | [13], [20] | m | dm | | | | | | | +| 49 | Unsupported | 420 | [13], [20] | o | do | | | | | | | +| 50 | User-Agent | r | [13], [20] | o | do | | | | | | | +| 51 | Via | 100
others | [13], [20] | m | dm | | | | | | | +| 52 | Warning | r | [13], [20] | o | do | | | | | | | +| 53 | WWW-Authenticate | 401
(NOTE 1) | [13], [20] | m | dm | | | | | | | +| | | 407
(NOTE 1) | | o | do | | | | | | | +| dc1: | (TIP/TIR AND 2xx response to initial request AND (visited-to-home response on roaming II-NNI OR non-roaming II-NNI)) OR (TIP/TIR AND response to initial request AND "presentation is allowed" AND home-to-visited response on roaming II-NNI) | | | | | | | | | | | +| dc2: | (TIP/TIR AND non-100 response to initial request AND "override the default setting" in temporary mode AND visited-to-home response on roaming II-NNI) OR (TIP/TIR AND 2xx response to initial request AND "presentation of the network asserted identity is restricted" AND (non-roaming II-NNI OR home-to-visited response on roaming II-NNI)) | | | | | | | | | | | +| NOTE 1: The SIP status code is only applicable over the roaming II-NNI. | | | | | | | | | | | | +| NOTE 2: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | | | | | | | | + +--- + +## B.16 UPDATE method + +The table B.16.1 lists the supported header fields within the UPDATE request. + +**Table B.16.1: Supported header fields within the UPDATE request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|----------------------------------------------------------------------------------------------------------|-------------|------------|----------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | [13], [23] | o | do | +| 2 | Accept-Contact | [51] | o | do | +| 3 | Accept-Encoding | [13], [23] | o | do | +| 4 | Accept-Language | [13], [23] | o | do | +| 5 | Allow | [13], [23] | o | do | +| 6 | Allow-Events | [20] | n/a | dn/a | +| 7 | Authorization | [13], [23] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 8 | Call-ID | [13], [23] | m | dm | +| 9 | Call-Info | [13], [23] | o | do | +| 10 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 11 | Contact | [13], [23] | m | dm | +| 12 | Content-Disposition | [13], [23] | o | do | +| 13 | Content-Encoding | [13], [23] | o | do | +| 14 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | [13], [23] | o | do | +| 16 | Content-Length | [13], [23] | t | dt | +| 17 | Content-Type | [13], [23] | * | d* | +| 18 | CSeq | [13], [23] | m | dm | +| 19 | Date | [13], [23] | o | do | +| 20 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE) | +| 21 | From | [13], [23] | m | dm | +| 22 | Geolocation | [68] | o | do | +| 23 | Geolocation-Routing | [68] | o | do | +| 24 | Max-Breadth | [79] | o | dn/a | +| 25 | Max-Forwards | [13], [23] | m | dm | +| 26 | MIME-Version | [13], [23] | o | do | +| 27 | Min-SE | [52] | o | do | +| 28 | Organization | [13], [23] | o | do | +| 29 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 30 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 31 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 THEN do (NOTE) | +| 32 | P-Early-Media | [74] | o | IF dc1 (CAT: clause 12.14) OR dc2 (announcements: clause 12.21) THEN dm ELSE IF table 6.1.3.1/69 THEN do (NOTE) | +| 33 | Priority-Share | [5] | n/a | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/118 THEN do (NOTE) | +| 34 | Privacy | [34] | o | do | +| 35 | Proxy-Authorization | [13], [23] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 36 | Proxy-Require | [13], [23] | o | do | +| 37 | Reason | [48] | o | IF table 6.1.3.1/40 THEN do (NOTE) | +| 38 | Record-Route | [13], [23] | o | do | +| 39 | Recv-Info | [39] | o | IF table 6.1.3.1/17 THEN do (NOTE) | +| 40 | Referred-By | [53] | o | do | +| 41 | Reject-Contact | [51] | o | do | +| 42 | Relayed-Charge | [5] | n/a | dn/a | +| 43 | Request-Disposition | [51] | o | do | +| 44 | Require | [13], [23] | c | dc | +| 45 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 46 | Resource-Share | [5] | n/a | IF (home-to-visited request on roaming II-NNI OR visited-to-home request on roaming II-NNI) AND table 6.1.3.1/116 THEN do (NOTE) | +| 47 | Route | [13], [23] | c | dc | +| 48 | Security-Client | [47] | o | dn/a | +| 49 | Security-Verify | [47] | o | dn/a | +| 50 | Session-Expires | [52] | o | do | +| 51 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 52 | Supported | [13], [23] | o | do | +| 53 | Timestamp | [13], [23] | o | do | +| 54 | To | [13], [23] | m | dm | +| 55 | User-Agent | [13], [23] | o | do | +| 56 | Via | [13], [23] | m | dm | +| dc1: | request invoked due to stopping or restarting CAT early media on an existing dialog AND (non-roaming II- | | | | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|------------|------------------| +| dc2: | NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI)
request invoked due to stopping or restarting announcement early media AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.16.2 lists the supported header fields within the UPDATE response. + +**Table B.16.2: Supported header fields within the UPDATE response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-----------------|--------------------|------------|--------------------------------------------------------------------------------------------| +| 1 | Accept | 2xx | [13], [23] | o | do | +| | | 415 | | c | dc | +| 2 | Accept-Encoding | 2xx | [13], [23] | o | do | +| | | 415 | | c | dc | +| 3 | Accept-Language | 2xx | [13], [23] | o | do | +| | | 415 | | c | dc | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do
(NOTE 2) | +| 5 | Allow | 405 | [13], [23] | m | dm | +| | | others | | o | do | +| 6 | Allow-Events | 2xx | [20] | n/a | dn/a | +| 7 | Authentication-Info | 2xx | [13], [23] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100 | [13], [23] | m | dm | +| | | others | | | | +| 9 | Call-Info | r | [13], [23] | o | do | +| 10 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do
(NOTE 2) | +| 11 | Contact | 2xx | [13], [23] | m | dm | +| | | 3xx
485 | | o | do | +| | | others | | o | do | +| 12 | Content-Disposition | r | [13], [23] | o | do | +| 13 | Content-Encoding | r | [13], [23] | o | do | +| 14 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | r | [13], [23] | o | do | +| 16 | Content-Length | 100 | [13], [23] | t | dt | +| | | others | | | | +| 17 | Content-Type | r | [13], [23] | * | d* | +| 18 | CSeq | 100 | [13], [23] | m | dm | +| | | others | | | | +| 19 | Date | 100 | [13], [23] | o | do | +| | | others | | | | +| 20 | Error-Info | 3xx-6xx | [13], [23] | o | IF table 6.1.3.1/13 THEN do
(NOTE 2) | +| 21 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 THEN do
(NOTE 2) | +| 22 | From | 100 | [13], [23] | m | dm | +| | | others | | | | +| 23 | Geolocation-Error | 424 | [68] | m | dm | +| | | others | | o | do | +| 24 | MIME-version | r | [13], [23] | o | do | +| 25 | Min-SE | 422 | [52] | m | dm | +| 26 | Organization | r | [13], [23] | o | do | +| 27 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do
(NOTE 2) | +| 28 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 29 | P-Charging-Vector | 100 | [24], [24A] | o | dn/a | +| | | others | | o | IF table 6.1.3.1/38 THEN do
(NOTE 2) | +| 30 | P-Early-Media | 2xx | [74] | o | IF table 6.1.3.1/69 THEN do
(NOTE 2) | +| 31 | Priority-Share | 2xx | [5] | n/a | IF home-to-visited response on
roaming II-NNI AND table 6.1.3.1/118
THEN do (NOTE 2) | +| 32 | Privacy | r | [34] | o | do | +| 33 | Proxy-Authenticate | 401
(NOTE 1) | [13], [23] | o | do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|------------------|------------------------------------------------------|------------|------------|--------------------------------------------------------------------------------------------------------------------------------------| +| | | 407
(NOTE 1) | | m | dm | +| 34 | Record-Route | 2xx | [13], [23] | o | do | +| 35 | Recv-Info | 2xx | [39] | c | IF table 6.1.3.1/17 THEN dc
(NOTE 2) | +| | | others | | o | IF table 6.1.3.1/116 THEN do
(NOTE 2) | +| 36 | Relayed-Charge | r | [5] | n/a | dn/a | +| 37 | Require | r | [13], [23] | c | dc | +| 38 | Resource-Share | 2xx | [5] | n/a | IF (home-to-visited response on roaming II-NNI OR visited-to-home response on roaming II-NNI) AND table 6.1.3.1/116 THEN do (NOTE 2) | +| 39 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do
(NOTE 2) | +| 40 | Retry-After | 404
413
480
486
500
503
600
603 | [13], [23] | o | do | +| 41 | Security-Server | 421
494 | [47] | o | dn/a | +| 42 | Server | r | [13], [23] | o | do | +| 43 | Session-Expires | 2xx | [52] | o | do | +| 44 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm
(NOTE 2) | +| 45 | Supported | 2xx | [13], [23] | o | do | +| 46 | Timestamp | r | [13], [23] | o | do | +| 47 | To | 100 | [13], [23] | m | dm | +| | | others | | | | +| 48 | Unsupported | 420 | [13], [23] | m | dm | +| 49 | User-Agent | r | [13], [23] | o | do | +| 50 | Via | 100 | [13], [23] | m | dm | +| | | others | | | | +| 51 | Warning | r | [13], [23] | o | do | +| 52 | WWW-Authenticate | 401
(NOTE 1) | [13], [23] | m | dm | +| | | 407
(NOTE 1) | | o | do | + +NOTE 1: The SIP status code is only applicable over the roaming II-NNI. + +NOTE 2: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +--- + +## Annex C (informative): The list of option items for II-NNI + +### C.1 Scope + +This annex provides a list of items that are recommended to be selected by inter-operator agreements for the interconnection between IMS operators using the II-NNI. The items in this annex have an influence on the service interconnection. + +For the purposes of this annex, these items are called "option items". The option items are extracted from the present document other than this annex, and are categorized from the aspect of service provisioning by IMS operators. + +If an option item is used based on inter-operator agreements, then relating capabilities described in the references are used over the II-NNI. In case of misalignment between the normative part of the present document and this annex, the normative part of the present document takes precedence. + +--- + +### C.2 Format of option item table + +The format of option item table used in the subsequent clauses is as follows: + +- The 2nd column "Option item" shows the option item. +- The 3rd column "References" shows the relevant clauses of the present document for each option item. +- The 4th column "Applicability at the II-NNI" shows the selectable patterns for each option item. +- The 5th column "Details for operator choice" shows the details for the inter-operator agreements in case the corresponding pattern is chosen. This column intends to be used to exchange each detailed conditions of the II-NNI by means of filling the conditions in the columns corresponding to the selected pattern. Blank row intends to be used as a place holder for describing additional detailed II-NNI conditions specific to the operator network not associated with the explicit descriptions in this annex. + +--- + +### C.3 Option item table + +#### C.3.0 Supported II-NNI traversal scenarios + +In this clause the table C.3.0.1 shows the supported II-NNI traversal scenarios option items. + +**Table C.3.0.1: Supported II-NNI traversal scenarios** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------------|------------------------------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Roaming II-NNI support | entire present specification | Yes | Option items in clauses C.3.1 and C.3.2. | +| | | | | Applicability of "Roaming Architecture for Voice over IMS with Local Breakout" (Clause 19). | +| | | | | If "Roaming Architecture for Voice over IMS with Local Breakout" is applicable:
+ option items in clause C.3.3;
and
+ the default TRF address to use when not included in the "g.3gpp.trf" feature-capability indicator. | +| | | | No | | +| 2 | Non-roaming II-NNI support | entire present specification | Yes | Option items in clauses C.3.1 and C.3.3. | +| | | | | | +| | | | No | | + +### C.3.1 Option item table common to roaming, non-roaming II-NNI and loopback traversal scenario + +This clause describes the option item tables common to the roaming II-NNI, the loopback traversal scenario, and the non-roaming II-NNI as follows: + +- Table C.3.1.1 shows the SIP methods option items. +- Table C.3.1.1A shows the SIP overload control option items. +- Table C.3.1.2 shows the SIP negotiation of resource reservation option item. +- Table C.3.1.2A shows the periodic refresh of SIP sessions option item. +- Table C.3.1.3 shows the replacing of SIP dialogs option item. +- Table C.3.1.4 shows the session participation option item. +- Table C.3.1.5 shows the conveying capabilities of UE option item. +- Table C.3.1.5A shows the authorization of early media option item. +- Table C.3.1.6 shows the asserting the service of authenticated users option item. +- Table C.3.1.7 shows the mode of signalling. +- Table C.3.1.7A shows the SIP message bodies option item. +- Table C.3.1.7B shows the SIP message body size option item. +- Table C.3.1.8 shows the control plane transport option item. +- Table C.3.1.9 shows the user plane transport, media, and codec option items. +- Table C.3.1.10 shows the dual tone multi frequency (DTMF) option item. +- Table C.3.1.10A shows the numbering, naming and addressing option item. +- Table C.3.1.11 shows the IP version option item. + +- Table C.3.1.12 shows the supplementary services option items. +- Table C.3.1.13 shows the additional functions option items. +- Table C.3.1.14 shows the SDP lines option items. +- Table C.3.1.15 shows the emergency services option items. +- Table C.3.1.16 shows indicating the II-NNI traversal scenario option items. +- Table C.3.1.17 shows the Mission critical services option items. +- Table C.3.1.18 shows the Calling number verification using signature verification and attestation information option items. +- Table C.3.1.19 shows the Signed attestation for emergency and priority IMS sessions option items. + +**Table C.3.1.1: SIP method** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------|------------------------------|-----------------------------|--------------------------------------------------------------------| +| 1 | INFO method | table 6.1/5A
table 6.1/5B | Yes | Info package name to use. | +| | | | No | | +| 2 | MESSAGE method | table 6.1/9A
table 6.1/9B | Yes | Inside or outside existing dialog, and content of MESSAGE request. | +| | | | No | | +| 3 | REFER method | table 6.1/16
table 6.1/17 | Yes | Inside or outside existing dialog. | +| | | | No | | + +**Table C.3.1.1A: SIP overload control** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------|----------------------------------|-----------------------------|-----------------------------------------------------------------------------| +| 1 | SIP overload control | table 6.1.3.1/106
clause 21.1 | Yes | Mechanisms to be used.
Whether to exempt MPS from SIP overload controls. | +| | | | No | | +| 2 | Feedback control | table 6.1.3.1/107
clause 21.2 | Yes | Algorithm to be used if not default (see clause 21.2). | +| | | | No | | +| 3 | Event control | table 6.1.3.1/108
clause 21.3 | Yes | Addresses to targets that can be supervised. | +| | | | No | | + +**Table C.3.1.2: Negotiation of resource reservation** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | Negotiation of resource reservation (precondition) | table 6.1.3.1/20 | Yes | | +| | | | No | | + +**Table C.3.1.2A: Periodic refresh of SIP sessions** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|---------------------------|------------------|-----------------------------|-------------------------------------------------------------------------------------------------------------------| +| 1 | SIP session timer (timer) | table 6.1.3.1/45 | Yes | Use conditions (Possible restriction on range of times and whether SIP session timer is applied in all sessions). | + +**Table C.3.1.3: Replacing of SIP dialogs** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | Replacing of SIP dialogs (replaces) | table 6.1.3.1/47 | Yes | | +| | | | No | | + +**Table C.3.1.4: Session participation** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | Session participation (join) | table 6.1.3.1/48 | Yes | | +| | | | No | | + +**Table C.3.1.5: Conveying capabilities of UE** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | Conveying capabilities of UE | table 6.1.3.1/49 | Yes | | +| | | | No | | + +**Table C.3.1.5A: Authorization of early media** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------|------------------|-----------------------------|------------------------------------------------------------------------------------------------------| +| 1 | Authorization of early media | table 6.1.3.1/69 | Yes | Whether to use authorization request of early media generated by the entity outside the IMS network. | +| | | | No | | + +**Table C.3.1.6: Asserting the service of authenticated users** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------------------------------------------------|------------------|-----------------------------|-----------------------------------| +| 1 | Managing the indication of the asserted service (P-Asserted-Service header field) | table 6.1.3.1/77 | Yes | Service identifier values to use. | +| | | | No | | + +**Table C.3.1.7: Mode of signalling** + +| No. | Option item | | References | Applicability at the II-NNI | Details for operator choice | +|-----|--------------------|------------------|----------------|-----------------------------|-----------------------------| +| 1 | Overlap signalling | In-dialog method | clause 6.1.1.5 | Yes | | +| | | | | No | | +| | | Multiple-INVITE | | Yes | | + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------|------------|-----------------------------|-----------------------------| +| | method | | No | | + +**Table C.3.1.7A: SIP message bodies** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------|--------------|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | MIME type | clause 6.1.4 | Yes | MIME types to use.
Applicable characteristics of the SIP message body MIMEs (i.e. the value(s) of Content-Disposition header field and Content-Language header field) if necessary. | + +**Table C.3.1.7B: SIP message body size** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------------------------------------|--------------|-----------------------------|-----------------------------| +| 1 | Limitation on maximum length of a SIP message body | clause 6.1.4 | Yes | Maximum length accepted. | +| | | | No | | + +**Table C.3.1.8: Control plane transport** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------|------------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------| +| 1 | TCP | clause 6.2 | Yes | Use conditions (e.g. port number to accept, number of simultaneous connections in case of reuse of the existing connections). | +| | | | No | | +| 2 | UDP | clause 6.2 | Yes | Use conditions (e.g. port number to accept). | +| | | | No | | +| 3 | SCTP | clause 6.2 | Yes | Use conditions (e.g. port number to accept). | +| | | | No | | + +**Table C.3.1.9: User plane transport, media, and codec** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------------------------|------------------------------|-----------------------------|---------------------------------------------------------------------------------------------------------------| +| 1 | Speech media (m=audio) | clause 7.1 | Yes | Names of speech codecs to use.
(NOTE 1, NOTE 2) | +| | | | No | | +| 2 | Video media (m=video) | clause 7.1 | Yes | Names of video codecs to use.
(NOTE 1, NOTE 2) | +| | | | No | | +| 3 | Other media | clause 7.1 | Yes | Media type (m=line of SDP) to use
(e.g. application, image, message). | +| | | | No | | +| 4 | RTP/AVPF | clause 7.2 | Yes | Media type (m=line of SDP) that
uses the protocol. | +| | | | No | | +| 5 | Transmission Control Protocol | clause 6.1.2.1
clause 7.2 | Yes | Media type (m=line of SDP) that
uses the protocol. | +| | | | No | | +| 6 | Other user plane protocols | clause 7.2 | Yes | Protocols to use (e.g. udptl,
TCP/MSRP) and media types
(m=line of SDP) that describe the
protocols. | +| | | | No | | + +NOTE 1: Codecs which are included in the applicable codec list made by inter-operator agreements are guaranteed to be supported at the II-NNI by the peer operators. + +NOTE 2: Whether it is allowed to offer codecs which are not included in the applicable codec list made by inter-operator agreements over the II-NNI is also determined by the inter-operator agreement if necessary. + +**Table C.3.1.10: Dual tone multi frequency (DTMF)** + +| No. | Option item | | References | Applicability at the II-NNI | Details for operator choice | | +|-----|----------------|----------------------------------------|----------------------------------------------------------------------------|-----------------------------|-----------------------------|--| +| 1 | DTMF transport | "telephone-event" based DTMF transport | clause 7.1
table 6.1/5A
table 6.1/5B
clause 12.14
clause 12.15 | Yes | Sampling rate to use. | | +| | | The SIP INFO mechanism | | No | | | +| | | | | Yes | | | +| | | | | No | | | + +**Table C.3.1.10A: Numbering, naming and addressing** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------------------|------------|-----------------------------|-----------------------------| +| 1 | Subaddress
("isub" tel URI parameter) | clause 8.1 | Yes | | +| | | | No | | + +**Table C.3.1.11: IP version** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------|------------|-----------------------------|----------------------------------------------------------| +| 1 | IPv4 | clause 9 | Yes | Use conditions (e.g. for control plane, for user plane). | +| | | | No | | +| 2 | IPv6 | clause 9 | Yes | Use conditions (e.g. for control plane, for user plane). | +| | | | No | | + +**Table C.3.1.12: Supplementary services** + +| No. | Option item | | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------------------------------------------------------------------------|---------------------------------------------|----------------|-----------------------------|--------------------------------------------------------------------------| +| 1 | Malicious Communication Identification (MCID) | | clause 12.2 | Yes | Minimum information exchanged over the II-NNI. | +| | | | | No | | +| 2 | Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR) | | clause 12.3 | Yes | | +| | | | | No | | +| 3 | Terminating Identification Presentation (TIP) and Terminating Identification Restriction (TIR) | | clause 12.4 | Yes | | +| | | | | No | | +| 4 | Anonymous Communication Rejection (ACR) | | clause 12.5 | Yes | | +| | | | | No | | +| 5 | Communication DIVersion (CDIV) | | clause 12.6 | Yes | | +| | | | | No | | +| 6 | Communication Waiting (CW) | | clause 12.7 | Yes | | +| | | | | No | | +| 7 | Communication HOLD (HOLD) | | clause 12.8 | Yes | | +| | | | | No | | +| 8 | Message Waiting Indication (MWI) | | clause 12.9 | Yes | | +| | | | | No | | +| 9 | Incoming Communication Barring (ICB) | | clause 12.10.1 | Yes | | +| | | | | No | | +| 10 | Completion of Communications to Busy Subscriber (CCBS) | | clause 12.11 | Yes | | +| | | | | No | | +| 11 | Completion of Communications by No Reply (CCNR) | | clause 12.12 | Yes | | +| | | | | No | | +| 12 | Explicit Communication Transfer (ECT) | | clause 12.13 | Yes | Type of explicit communication transfer to support. | +| | | | | No | | +| 13 | Customized Alerting Tone (CAT) | | clause 12.14 | Yes | CAT model to use (Gateway model, forking model and early session model). | +| | | | | | Media type (m=line of SDP) applicable to CAT. | +| | | | | No | | +| 14 | Customized Ringing Signal (CRS) | | clause 12.15 | Yes | | +| | | | | No | | +| 15 | Closed User Group (CUG) | | clause 12.16 | Yes | | +| | | | | No | | +| 16 | Personal Network Management (PNM) | | clause 12.17 | Yes | | +| | | | | No | | +| 17 | Three-Party (3PTY) | | clause 12.18 | Yes | | +| | | | | No | | +| 18 | Conference (CONF) | | clause 12.19 | Yes | | +| | | | | No | | +| 19 | Flexible Alerting (FA) | | clause 12.20 | Yes | | +| | | | | No | | +| 20 | Announcements | During the establishment of a session | clause 12.21.2 | Yes | Methods for sending announcement. | +| | | No | | | | +| | | During an established communication session | clause 12.21.3 | Yes | Methods for sending announcement. | +| | | No | | | | +| | | Providing announcements | clause 12.21.4 | Yes | Methods for sending announcement. | + +| No. | Option item | | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------------------------------|----------------------------------------|---------------------------------------------------------|-----------------------------|-----------------------------------------------------------------------------| +| | | when communication request is rejected | | No | | +| | | | | | | +| 21 | Advice Of Charge (AOC) | | clause 12.22 | Yes | | +| | | | | No | | +| 22 | Completion of Communications on Not Logged-in (CCNL) | | clause 12.23 | Yes | | +| | | | | No | | +| 23 | Presence service | | clause 15 | Yes | Presence services to use (TS 24.141 [132], OMA 1.1 [142] or OMA 2.0 [138]). | +| | | | | No | | +| 24 | Messaging service | Page-mode messaging | clause 16.2 | Yes | | +| | | | | No | | +| | | Session-mode messaging | clause 16.4 | Yes | | +| | | | | No | | +| | | Session-mode messaging conferences | clause 16.5 | Yes | | +| | | | | No | | +| 24A | Delivery of original destination identity | | clause 22 | Yes | Services to apply the function. | +| | | | | No | | +| 24B | Service access number translation | | table 6.1.3.1/52A
clause 27 | Yes | | +| | | | | No | | +| 25 | Other additional service using other SIP extensions | | clause 6.1.1.3.2
clause 12.6 | Yes | The SIP extensions to use and the service that uses the extensions. | +| | | | | No | | +| 26 | Multi-Identity (MiD) | | clause 6.1.1.3.1
table 6.1.3.1/126
clause 12.26.2 | Yes | Types of non-native identities to support. (NOTE) | +| | | | | No | | + +NOTE: The non-native identities, as defined in 3GPP TS 24.174 [218] are: + an alternative identity, an external alternative identity and a virtual identity. + +**Table C.3.1.13: Additional functions** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------------------------------|-------------------|-----------------------------|-------------------------------------------------------------------------------------------------| +| 1 | Optimal Media Routeing | clause 17 | Yes | | +| | | | No | | +| 2 | Applying forking (NOTE 1) | table 6.1.3.1/5 | Yes | Usage of Request-Disposition header field with value "no-fork". (NOTE 3) | +| | | | No (NOTE 2) | | +| 3 | Transfer of IP multimedia service tariff information | clause 11.3 | Yes | The value of the Content-Disposition header field. | +| | | | No | | +| 4 | Telepresence using IMS | clause 23 | Yes | The value of "+sip.clue" media feature tag in Contact header field. | +| | | | No | | +| 5 | Dynamic services interactions | table 6.1.3.1/125 | Yes | The identities of the services in the Service-Interact-Info header field. | +| | | | No | | +| 6 | MTSI Data channel | clause 33 | Yes | The value "webrtc-datachannel" of "+sip.app-subtype" media feature tag in Contact header field. | +| | | | No | | + +NOTE 1: Support of handling of several responses due to forking and of the Request-Disposition header field, is mandated on the II-NNI. + +NOTE 2: In case the operator interconnects with IMS non-compliant networks, and wishes to use the II-NNI anyway, then the operators might want to negotiate if the forking procedures are applicable. + +NOTE 3: The Request-Disposition header field with value "no-fork" can be used to suppress that forking occurs. However, a peer operator might require the usage of forking e.g. to implement certain services. + +**Table C.3.1.14: SDP lines** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------|--------------|-----------------------------|----------------------------------------------------| +| 1 | m=line | clause 6.1.2 | Yes | Used static RTP payload type numbers. | +| | | | | | +| 2 | b=line | clause 6.1.2 | Yes | Used bandwidth modifier types. | +| | | | | | +| 3 | a=line | clause 6.1.2 | Yes | Used attributes. | +| | | | | For the "rtpmap" attribute, used "encoding names". | + +**Table C.3.1.15: Emergency services** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------------|-------------------|-----------------------------|-------------------------------| +| 1 | Public Safety Answering Point (PSAP) Callback | table 6.1.3.1/110 | Yes | Used PSAP callback indicator. | +| | | | No | | + +**Table C.3.1.16: Indicating the II-NNI traversal scenario** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------------------------------------------------------------------|---------------------------------|-----------------------------|-----------------------------| +| 1 | Support of the "iotl" SIP URI parameter indicating the II-NNI traversal scenario | table 6.1.3.1/112
clause 5.3 | Yes | | +| | | | No | | + +**Table C.3.1.17: Mission critical services** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|--------------------------------------|---------------|-----------------------------|----------------------------------------------------------| +| 1 | Support of Mission critical services | clause 28.2.2 | Yes | MBMS transmission usage and location procedures support. | +| | | | No | | + +**Table C.3.1.18: Calling number verification using signature verification and attestation information** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|-----------------------------|-----------------------------| +| 1 | Calling number verification using signature verification and attestation information | table 6.1.3.1/119
table 6.1.3.1/120
table 6.1.3.1/123
table 6.1.3.1/124
clause 29 | Yes | | +| | | | No | | + +**Table C.3.1.19: Signed attestation for emergency and priority IMS sessions** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|--------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|-----------------------------|-------------------------------------------------------------------------| +| 1 | Calling number verification using signature verification and attestation information | table 6.1.3.1/119
table 6.1.3.1/120
table 6.1.3.1/123
table 6.1.3.1/124
clause 34.2 | Yes | Support for emergency, emergency callback and/or priority IMS sessions. | +| | | | No | | +| 2 | Priority verification using assertion of priority information | table 6.1.3.1/73
table 6.1.3.1/110
table 6.1.3.1/119
table 6.1.3.1/128
clause 34.3 | Yes | Support for emergency, emergency callback and/or priority IMS sessions. | +| | | | No | | + +## C.3.2 Option item table specific to roaming II-NNI + +This clause describes the option item tables specific to roaming II-NNI as follows: + +- Table C.3.2.1 shows the mechanism for authentication option items. +- Table C.3.2.1A shows the charging option items. +- Table C.3.2.2 shows the key of service profile for HSS query option item. +- Table C.3.2.3 shows the numbering, naming and addressing option items. +- Table C.3.2.4 shows the supplementary services option items. +- Table C.3.2.5 shows the access transfer services option items. +- Table C.3.2.6 shows the registration of bulk number contacts option items. + +- Table C.3.2.7 shows the P-CSCF restoration option items. +- Table C.3.2.8 shows the resource sharing option items. +- Table C.3.2.9 shows the Priority sharing option items. +- Table C.3.2.9A shows the PS data off extension option items. +- Table C.3.2.10 shows the RLOS option items. + +**Table C.3.2.1: Mechanism for authentication** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------|-----------------|-----------------------------|-----------------------------| +| 1 | IMS AKA plus Ipsec ESP | table 6.1.3.1/7 | Yes | | +| | | | No | | +| 2 | SIP digest plus check of IP association | table 6.1.3.1/7 | Yes | | +| | | | No | | +| 3 | SIP digest plus Proxy Authentication | table 6.1.3.1/7 | Yes | | +| | | | No | | +| 4 | SIP digest with TLS | table 6.1.3.1/7 | Yes | | +| | | | No | | + +**Table C.3.2.1A: Charging** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------------------------------------|---------------------------------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Inter-operator accounting | table 6.1.3.1/38
clause 11.2 | Yes | Operator network identifiers populated in the type 1 "orig-ioi" and "term-ioi" header field parameters of the P-Charging-Vector header field. | +| | | | No | | +| 2 | Inter-operator accounting for the transit scenario | clause 11.2 | Yes | Operator network identifiers populated in the "transit-ioi" header field parameters of the P-Charging-Vector header field. | +| | | | No | | + +**Table C.3.2.2: The key of service profile for HSS query** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | The key of service profile for HSS query (P-Profile-Key header field) | table 6.1.3.1/59 | Yes | | +| | | | No | | + +**Table C.3.2.3: Numbering, naming and addressing** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|---------------------------------------------------------------|--------------------------|-----------------------------|-----------------------------| +| 1 | Dial string ("user=dialstring" SIP URI parameter) | table 6.1.3.1/67 | Yes | | +| | | | No | | +| 2 | Barring of premium numbers ("premium-rate" tel URI parameter) | clause 8.1,
clause 24 | Yes | | +| | | | No | | + +**Table C.3.2.4: Supplementary services** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------|----------------|-----------------------------|-----------------------------| +| 1 | Outgoing Communication Barring (OCB) | clause 12.10.2 | Yes | | +| | | | No | | +| 2 | Unstructured Supplementary Service Data | clause 12.24 | Yes | | +| | | | No | | +| 3 | Enhanced Calling Name | clause 12.25 | Yes | | +| | | | No | | + +**Table C.3.2.5: Access transfer services** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------------------|-------------|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | IMS Centralized Services (ICS) | clause 13 | Yes | | +| | | | No | | +| 2 | PS to CS Single Radio Voice Call Continuity (SRVCC) | clause 14 | Yes | Additional use conditions (PS to CS SRVCC for calls in alerting phase, support of ATCF architecture, PS to CS SRVCC for calls in pre-alerting phase and PS to CS SRVCC with the MSC server assisted mid-call feature).
If the ATCF architecture applies, the URIs of SCC ASs authorised to provide PS to CS SRVCC information in the MESSAGE request. | +| | | | No | | +| | | | Yes | Additional use condition (transfer in alerting phase). | +| | | | No | | +| 3 | Single Radio Video Call Continuity (vSRVCC) | clause 14 | Yes | | +| | | | No | | +| 4 | Inter UE Transfer (IUT) | clause 18 | Yes | | +| | | | No | | +| 5 | CS to PS Single Radio Voice Call Continuity (SRVCC) | clause 14.5 | Yes | The URIs of SCC ASs authorised to provide CS to PS SRVCC information in the MESSAGE request.
Additional use conditions (support of CS to PS SRVCC for calls in alerting phase and support of CS to PS SRVCC with the assisted mid-call feature). | +| | | | No | | +| | | | Yes | | +| | | | No | | +| 6 | PS to CS Dual Radio Voice Call Continuity (DRVCC) | clause 14.6 | Yes | Additional use conditions (PS to CS DRVCC for calls in alerting phase, PS to CS DRVCC for originating calls in pre-alerting phase, PS to CS DRVCC with the MSC server assisted mid-call feature and the use of IMS Centralized Services (ICS) and the tel URI in STN). | +| | | | No | | +| | | | Yes | | +| | | | No | | +| 7 | CS to PS Dual Radio Voice Call Continuity (DRVCC) | clause 14.7 | Yes | Additional use conditions (CS to PS DRVCC for calls in alerting phase, CS to PS DRVCC for originating calls in pre-alerting phase, CS to PS DRVCC with the MSC server assisted mid-call feature) and the use of IMS Centralized Services (ICS). | +| | | | No | | +| | | | Yes | | +| | | | No | | + +**Table C.3.2.6: Registration of bulk number contacts** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|--------------------------------------|-------------------|-----------------------------|-----------------------------| +| 1 | Registration of bulk number contacts | table 6.1.3.1/104 | Yes | | +| | | | No | | + +**Table C.3.2.7: P-CSCF restoration** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------|-------------|-----------------------------|-----------------------------| +| 1 | PCRF or PCF based P-CSCF restoration | clause 25.2 | Yes | | +| | | | No | | +| 2 | HSS or UDM/HSS based P-CSCF restoration | clause 25.3 | Yes | | +| | | | No | | + +**Table C.3.2.8: Resource sharing** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------|------------|-----------------------------|-----------------------------| +| 1 | Resource sharing | clause 26 | Yes | | +| | | | No | | + +**Table C.3.2.9: Priority sharing** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------|---------------------------------|-----------------------------|-----------------------------| +| 1 | Priority sharing | clause 28,
table 6.1.3.1/118 | Yes | | +| | | | No | | + +**Table C.3.2.9A: 3GPP PS data off extension** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------------|----------------------------------|-----------------------------|-----------------------------| +| 1 | 3GPP PS data off extension | clause 32,
table 6.1.3.1/121A | Yes | | +| | | | No | | + +**Table C.3.2.10: RLOS** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------|---------------------------------|-----------------------------|-----------------------------| +| 1 | RLOS | clause 31,
table 6.1.3.1/127 | Yes | | +| | | | No | | + +### C.3.3 Option item table specific to non-roaming II-NNI and loopback traversal scenario + +This clause describes the option item tables specific to the non-roaming II-NNI and the loopback traversal scenario as follows: + +- Table C.3.3.1 shows the SIP method option items. +- Table C.3.3.2 shows the charging option items. +- Table C.3.3.3 shows the GRUU option items. +- Table C.3.3.4 shows the media feature tags option items. +- Table C.3.3.5 shows the ISDN interworking option items. +- Table C.3.3.6 shows the corporate network option items. +- Table C.3.3.7 shows the numbering, naming and addressing option items. +- Table C.3.3.8 shows the additional functions option item. + +- Table C.3.3.9 shows IMS emergency session traversal scenario option item. + +**Table C.3.3.1: SIP method** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------|--------------------------------|-----------------------------|-----------------------------| +| 1 | NOTIFY method | table 6.1/10
table 6.1/11 | Yes | Event package name to use. | +| | | | No | | +| 2 | SUBSCRIBE method | table 6.1/20
table 6.1/21 | Yes | Event package name to use. | +| | | | No | | +| 3 | PUBLISH method | table 6.1/15A
table 6.1/15B | Yes | Event package name to use. | +| | | | No | | + +**Table C.3.3.2: Charging** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------------------------------------|---------------------------------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Inter-operator accounting | table 6.1.3.1/38
clause 11.2 | Yes | Operator network identifiers populated in the type 2 "orig-ioi" and "term-ioi" header field parameters of the P-Charging-Vector header field. | +| | | | No | | +| 2 | Inter-operator accounting for the transit scenario | clause 11.2 | Yes | Operator network identifiers populated in the "transit-ioi" header field parameters of the P-Charging-Vector header field. | +| | | | No | | + +**Table C.3.3.3: Globally routable user agent URIs (GRUU)** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | Globally Routable User Agent URIs (gruu) | table 6.1.3.1/56 | Yes | | +| | | | No | | + +**Table C.3.3.4: Media feature tags** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|--------------------|-----------------------------------------------------------------------------------|-----------------------------|-------------------------------------| +| 1 | Media feature tags | table 6.1.3.1/76
clause 12
clause 13
clause 14
clause 16
clause 18 | Yes | Names of media feature tags to use. | +| | | | No | | + +**Table C.3.3.5: ISDN interworking** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|--------------------------------------------------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | User to User Call Control Information in SIP for ISDN Interworking (uui) | table 6.1.3.1/79 | Yes | | +| | | | No | | + +**Table C.3.3.6: Corporate network** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|---------------------------------------------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | Private network traffic (P-Private-Network-Indication header field) | table 6.1.3.1/80 | Yes | | +| | | | No | | + +**Table C.3.3.7: Numbering, naming and addressing** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------------------------------------------------|------------|-----------------------------|---------------------------------------------------------------------------------------| +| 0 | SIP URI | clause 8.1 | Yes | Any local numbers that are allowed in addition to global numbers. | +| | | | | Domain name(s) and/or IP address(es) of hostportion to accept. | +| | | | | Applicability of PSI to use. | +| | | | | Applicability of "Unavailable User Identity" in the P-Asserted-Identity header field. | +| | | | | | +| 0A | tel URI (NOTE) | clause 8.1 | Yes | Any local numbers that are allowed in addition to global numbers. | +| | | | | Applicability of the URI in the P-Asserted-Identity header field and/or Request-URI. | +| | | | No | | +| 0B | IM URI | clause 8.1 | Yes | | +| | | | No | | +| 0C | PRES URI | clause 8.1 | Yes | | +| | | | No | | +| 1 | Number Portability Routing Number ("rn" and "npdi" tel URI parameters) | clause 8.1 | Yes | | +| | | | No | | +| 2 | Calling Party's Category ("cpc" tel URI parameter) | clause 8.1 | Yes | cpc-values to use. | +| | | | No | | +| 3 | Originating Line Information ("oli" tel URI parameter) | clause 8.1 | Yes | oli-values to use. | +| | | | No | | + +NOTE: The option item is only for the non-roaming II-NNI. + +**Table C.3.3.8: Additional functions** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------|------------------------------|-----------------------------|-----------------------------| +| 1 | Support of out-of-dialog OPTIONS method | table 6.1/12
table 6.1/13 | Yes | The purpose of the method. | +| | | | No | | + +**Table C.3.3.9: IMS emergency session traversal scenario** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------------------------------|------------------------------------------------|-----------------------------|---------------------------------------------------------------| +| 1 | IMS emergency session traversal scenario | table 6.1.3.1/55
clause 30.1
clause 30.2 | Yes | The emergency service URN(s) to use. | +| | | | | The PSAP URI to use in the Route header field, if applicable. | +| | | | No | | +| 2 | Next-Generation Pan-European eCall emergency service | clause 30.3 | Yes | | +| | | | No | | + +## Annex D (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|------|-----|-----------------------------------------------------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 03/2015 | CT-67 | CP-150129 | 736 | 1 | Addition of an optional capability regarding a new cause-param value for service number translation | 12.7.0 | 13.0.0 | +| 03/2015 | CT-67 | CP-150130 | 719 | | Correction of a minor error in subclause C.3.1 | 12.7.0 | 13.0.0 | +| 03/2015 | CT-67 | CP-150130 | 723 | | Annex A corrections | 12.7.0 | 13.0.0 | +| 03/2015 | CT-67 | CP-150130 | 726 | 3 | Applying drafting rules | 12.7.0 | 13.0.0 | +| 03/2015 | CT-67 | CP-150130 | 729 | 1 | Adding missing abbreviations | 12.7.0 | 13.0.0 | +| 06/2015 | CT-68 | CP-150339 | 0741 | - | Reference Update: RFC 7462 (alert-info urns) | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150341 | 0746 | - | Condition on usage of Refer-Sub header field | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150356 | 0747 | 3 | Introducing resource sharing | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150346 | 0749 | 1 | Correcting errors in annex B | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150347 | 0751 | - | draft-holmberg-dispatch-iottl-parameter-04 updated to RFC 7549 | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150350 | 0753 | 1 | Additional RFC 6665 related IETF drafts added | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150357 | 0754 | 1 | Correcting inconsistencies in the major capability table | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0756 | 1 | Correction of Record-Route header field applicability in annex B | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0758 | - | Correction of applicable SIP status code for SIP header fields in PUBLISH response in annex B | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0760 | - | Addition of missing text referring to an option item table in annex C | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0762 | 1 | Correction of the P-Charging-Vector header field in annex B | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0763 | 1 | Correction of the P-Early-Media header field within the PRACK response in annex B | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0765 | - | Correction of the Server header field within the SUBSCRIBE response in annex B | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0766 | - | Correction of the Allow header field in annex B | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0767 | - | Clarifications on NNI impacts due to CAT service | 13.0.0 | 13.1.0 | +| 06/2015 | - | - | - | - | MCC Correction of implementation of CR0765 | 13.1.0 | 13.1.1 | +| 09/2015 | CT-69 | CP-150486 | 0768 | 3 | The privacy level "session" and "critical" are not used in OIP/OIR | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150479 | 0769 | 1 | Service access number translation | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150471 | 0771 | 1 | Reference update: draft-ietf-mmusic-sctp-sdp | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150475 | 0773 | - | Missing SIP request in HSS based P-CSCF restoration | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150479 | 0774 | - | draft-mohali-dispatch-cause-for-service-number updated to latest version | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150486 | 0775 | 1 | The Service-Interact-Info header field | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150478 | 0776 | 1 | Plain text message body missing in table 6.1.4.1 | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150478 | 0777 | 1 | application/x-www-form-urlencoded missing in table 6.1.4.1 | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150486 | 0778 | 1 | application/vnd.3gpp.crs+xml MIME body missing in CRS | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150478 | 0779 | - | message/sip MIME body missing in table 6.1.4.1 | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150478 | 0780 | - | Applicability of SIP header fields on a roaming II-NNI | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150469 | 0783 | - | Reference update: RFC 7415 | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150465 | 0787 | 1 | Correction for the II-NNI conditions | 13.1.1 | 13.2.0 | +| 12/2015 | CT-70 | CP-150796 | 0790 | 2 | Clarification on the II-NNI specifications of announcement | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150796 | 0791 | 2 | Updating for annex B | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150654 | 0795 | - | Telepresence IETF draft update | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150659 | 0796 | 3 | Introducing MCPTT | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150657 | 0797 | 2 | Reference update of draft-mohali-dispatch-cause-for-service-number | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150664 | 0800 | 2 | Adding the "loopback-indication" to RAVEL | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150731 | 0804 | 1 | ICS and the conference service | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150660 | 0805 | - | SRVCC and subscription to conference package | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150660 | 0806 | 1 | ICS and subscription to conference package | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150656 | 0807 | 1 | Clarification of applicable URI formats for public user identity | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150796 | 0808 | - | Miscellaneous editorial modification | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150671 | 0810 | 1 | Update of UP6665 references | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150662 | 0812 | 1 | P-CSCF restoration corrections | 13.2.0 | 13.3.0 | + +| Change history | | | | | | | | +|----------------|-------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +| 2016-03 | CT#71 | CP-160088 | 0813 | 2 | B | Adding MBMS usage info and location info procedure | 13.4.0 | +| 2016-03 | CT#71 | CP-160088 | 0814 | 2 | F | Adding "application/vnd.3gpp.mcptt-info" MIME body | 13.4.0 | +| 2016-03 | CT#71 | CP-160088 | 0815 | 2 | B | Adding MCPTT as option item in annex C | 13.4.0 | +| 2016-03 | CT#71 | CP-160088 | 0816 | 1 | B | Adding affiliation | 13.4.0 | +| 2016-03 | CT#71 | CP-160098 | 0817 | 1 | F | Adding "Timer N" in the timer table | 13.4.0 | +| 2016-03 | CT#71 | CP-160096 | 0819 | 1 | A | Updating "Details for operator choice" in DRVCC to include the STN | 13.4.0 | +| 2016-03 | CT#71 | CP-160088 | 0821 | 1 | F | Addressed MCPTT SIP interfaces | 13.4.0 | +| 2016-06 | CT#72 | CP-160262 | 0822 | 2 | F | Some error corrections and removing an editor's note | 13.5.0 | +| 2016-06 | CT#72 | CP-160262 | 0823 | 2 | F | Group regrouping | 13.5.0 | +| 2016-06 | CT#72 | CP-160262 | 0824 | 1 | F | Conference event package subscription | 13.5.0 | +| 2016-06 | CT#72 | CP-160262 | 0825 | 1 | F | MCPTT service settings | 13.5.0 | +| 2016-06 | CT#72 | CP-160262 | 0826 | - | F | Clarifying the Accept-Contact header field in MBMS usage info | 13.5.0 | +| 2016-06 | CT#72 | CP-160262 | 0827 | 2 | F | The affiliation procedure update | 13.5.0 | +| 2016-06 | CT#72 | CP-160259 | 0828 | 1 | F | Adding the Cellular-Network-Info header field | 13.5.0 | +| 2016-06 | CT#72 | CP-160258 | 0834 | 1 | A | Adding draft-mohali-dispatch-originating-cdiv-parameter | 13.5.0 | +| 2016-06 | CT#72 | CP-160258 | 0840 | 1 | A | Updates to RFC 7315 P-header extensions usage in SIP requests/responses | 13.5.0 | +| 2016-06 | CT#72 | CP-160258 | 0843 | 1 | A | P-Access-Network-Info ABNF Update | 13.5.0 | +| 2016-06 | CT#72 | CP-160261 | 0844 | 1 | F | Update ref to draft-mohali-dispatch-cause-for-service-number-06 | 13.5.0 | +| 2016-06 | CT#72 | CP-160273 | 0830 | 1 | F | Clarification of the note about forking | 14.0.0 | +| 2016-06 | CT#72 | CP-160273 | 0831 | - | F | Changing content type to correct terminology | 14.0.0 | +| 2016-06 | CT#72 | CP-160273 | 0835 | 1 | F | Clarification of Public Service Identity at II-NNI | 14.0.0 | +| 2016-06 | CT#72 | CP-160273 | 0836 | 1 | F | Correcting the subscription to the conference package for CONF and the session-mode messaging service | 14.0.0 | +| 2016-06 | CT#72 | CP-160273 | 0837 | 1 | F | Clarification on the applicability of P-Early-Media header field and early media over the II-NNI | 14.0.0 | +| 2016-09 | CT#73 | CP-160446 | 0846 | 1 | A | Usage of the Resource-Share header field | 14.1.0 | +| 2016-09 | CT#73 | CP-160447 | 0852 | 1 | A | Reference update: RFC 7913 | 14.1.0 | +| 2016-09 | CT#73 | CP-160449 | 0855 | 1 | A | Updated ref to draft-mohali-dispatch-cause-for-service-number-07 | 14.1.0 | +| 2016-12 | CT#74 | CP-160624 | 0857 | 1 | A | Updated ref to draft-mohali-dispatch-cause-for-service-number-09 | 14.2.0 | +| 2016-12 | CT#74 | CP-160620 | 0861 | 1 | A | Updated ref to draft-mohali-dispatch-originating-cdiv-parameter-02 | 14.2.0 | +| 2016-12 | CT#74 | CP-160620 | 0865 | - | A | Reference update: RFC 7976 | 14.2.0 | +| 2016-12 | CT#74 | CP-160621 | 0875 | - | A | Reference update: RFC 7989 | 14.2.0 | +| 2016-12 | CT#74 | CP-160623 | 0877 | 2 | A | Missing support of priority sharing | 14.2.0 | +| 2016-12 | CT#74 | CP-160631 | 0878 | - | F | Additional routeing functionality at the IBCF | 14.2.0 | +| 2017-03 | CT#75 | CP-170087 | 0882 | 1 | A | Correction on PSAP callback indicator option item | 14.3.0 | +| 2017-03 | CT#75 | CP-170087 | 0883 | 1 | A | Correction on the architecture diagram of II-NNI | 14.3.0 | +| 2017-03 | CT#75 | CP-170087 | 0884 | 1 | A | Addition of application/call-completion MIME Type | 14.3.0 | +| 2017-03 | CT#75 | CP-170080 | 0886 | 1 | A | Update ref to draft-mohali-dispatch-cause-for-service-number | 14.3.0 | +| 2017-03 | CT#75 | CP-170078 | 0890 | 2 | A | Update ref to draft-mohali-dispatch-originating-cdiv-parameter | 14.3.0 | +| 2017-03 | CT#75 | CP-170079 | 0894 | - | A | Reference update: RFC 8055 | 14.3.0 | +| 2017-03 | CT#75 | CP-170077 | 0896 | - | A | Applicability of Resource-Share header field | 14.3.0 | +| 2017-03 | CT#75 | CP-170085 | 0897 | 1 | B | Support of "Calling number verification" | 14.3.0 | +| 2017-06 | CT#76 | CP-171134 | 0872 | 5 | F | Clarification of II-NNI for IMS emergency session | 14.4.0 | +| 2017-06 | CT#76 | CP-171130 | 0898 | 2 | B | Addition of the location parameter | 14.4.0 | +| 2017-06 | CT#76 | CP-171128 | 0900 | - | A | MIME body types used by MCPTT | 14.4.0 | +| 2017-06 | CT#76 | CP-171126 | 0901 | - | F | Modifying references to align with rel-14 MCPTT stage 1 and stage 2 restructuring | 14.4.0 | +| 2017-06 | CT#76 | CP-171134 | 0902 | 1 | F | Missing support of Response-Source header field | 14.4.0 | +| 2017-06 | CT#76 | CP-171124 | 0904 | 1 | A | Reference Update RFC8119 | 14.4.0 | +| 2017-06 | CT#76 | CP-171123 | 0908 | 1 | A | Update ref to new naming of draft-mohali-sipcore-originating-cdiv-parameter | 14.4.0 | +| 2017-06 | CT#76 | CP-171131 | 0909 | 2 | F | Support of feature capability indicator "sip.607" | 14.4.0 | +| 2017-06 | CT#76 | CP-171122 | 0913 | - | A | Reference update: draft-ietf-mmusic-sctp-sdp | 14.4.0 | +| 2017-06 | CT#76 | CP-171131 | 0914 | - | F | Reference update: draft-ietf-stir-rfc4474bis | 14.4.0 | +| 2017-06 | CT#76 | CP-171125 | 0915 | 3 | B | IMS Trace (ISAT) Procedures | 14.4.0 | +| 2017-06 | CT#76 | CP-171127 | 0916 | 3 | B | Adding other Mission Critical services | 14.4.0 | +| 2017-06 | CT#76 | CP-171135 | 0910 | 1 | F | Added unspecified abbreviations | 15.0.0 | +| 2017-06 | CT#76 | CP-171135 | 0918 | 2 | F | Misalignment regarding transcoding between TS 24.229 and TS 29.165 | 15.0.0 | +| 2017-06 | CT#76 | | | | | Editorial changes by MCC | 15.0.1 | +| 2017-09 | CT#77 | CP-172049 | 0919 | 1 | A | Added the profile status in proxy role regarding "A SIP Response Code for Unwanted Calls" | 15.1.0 | +| 2017-09 | CT#77 | CP-172040 | 0920 | 1 | B | Support of IETF draft-ietf-sipcore-content-id | 15.1.0 | +| 2017-09 | CT#77 | CP-172045 | 0922 | 1 | A | Reference Update for the ISUP location parameter | 15.1.0 | +| 2017-09 | CT#77 | CP-172049 | 0925 | - | A | Reference update from draft-ietf-sipcore-status-unwanted-06 to | 15.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------------------------------|--------| +| | | | | | | RFC 8197 | | +| 2017-12 | CT#78 | CP-173099 | 0928 | 1 | A | Reference Update for the ISUP location parameter | 15.2.0 | +| 2017-12 | CT#78 | CP-173091 | 0933 | 1 | A | Update draft ref for Originating-CDIV param in P-Served-User | 15.2.0 | +| 2017-12 | CT#78 | CP-173090 | 0934 | - | D | Editorial modification | 15.2.0 | +| 2017-12 | CT#78 | CP-173095 | 0935 | 1 | A | Adding MCData related MIME bodies | 15.2.0 | +| 2017-12 | CT#78 | CP-173098 | 0938 | 1 | A | Correction of II-NNI condition related to P-Early-Media header field | 15.2.0 | +| 2017-12 | CT#78 | CP-173102 | 0940 | - | A | Correction of II-NNI condition related to P-Early-Media header field for the UPDATE request | 15.2.0 | +| 2017-12 | CT#78 | CP-173096 | 0943 | - | A | Addition of sign XML MIME body | 15.2.0 | +| 2017-12 | CT#78 | CP-173092 | 0945 | - | F | Reference update: RFC 8262 | 15.2.0 | +| 2018-03 | CT#79 | CP-180038 | 0946 | 1 | B | Support of "Enhanced calling name" service | 15.3.0 | +| 2018-03 | CT#79 | CP-180048 | 0947 | - | F | bSRVCC-MT NNI | 15.3.0 | +| 2018-03 | CT#79 | CP-180048 | 0948 | 1 | F | Operator choice of DTMF sampling rate | 15.3.0 | +| 2018-03 | CT#79 | CP-180042 | 0950 | - | A | Reference Update for the ISUP location parameter | 15.3.0 | +| 2018-03 | CT#79 | CP-180048 | 0951 | - | F | Updating the title of referenced TS 22.179 | 15.3.0 | +| 2018-03 | CT#79 | CP-180044 | 0953 | - | A | Reference update: RFC 8224 | 15.3.0 | +| 2018-03 | CT#79 | CP-180048 | 0955 | - | F | Correction on the terminology of non-global number | 15.3.0 | +| 2018-03 | CT#79 | CP-180048 | 0956 | - | F | Correction of the option item name for Calling number verification | 15.3.0 | +| 2018-03 | CT#79 | CP-180048 | 0957 | 1 | F | Operator choice of CAT media type | 15.3.0 | +| 2018-06 | CT#80 | CP-181022 | 0958 | 1 | F | Missing explanation of abbreviation "5xx" | 15.4.0 | +| 2018-06 | CT#80 | CP-181016 | 0959 | 1 | B | Calling number verification using signature verification and attestation information | 15.4.0 | +| 2018-06 | CT#80 | CP-181170 | 0960 | 4 | F | MBMS transmission and location procedures for MCVideo service | 15.4.0 | +| 2018-09 | CT#81 | CP-182021 | 0961 | 1 | B | Functional Alias Management over II-NNI | 15.5.0 | +| 2018-09 | CT#81 | CP-182020 | 0966 | 1 | A | Update draft ref for Originating-CDIV param in P-Served-User | 15.5.0 | +| 2018-09 | CT#81 | CP-182018 | 0967 | 1 | F | Correction of NOTE numbering for trust relationship | 15.5.0 | +| 2018-09 | CT#81 | CP-182024 | 0969 | - | A | Reference Update for the ISUP Q.850 location parameter | 15.5.0 | +| 2018-12 | CT#82 | CP-183113 | 0974 | 2 | A | Update draft ref for Originating-CDIV param in P-Served-User | 15.6.0 | +| 2018-12 | CT#82 | CP-183114 | 0977 | 1 | A | Removal of editor's note on Service-Interact-Info | 15.6.0 | +| 2018-12 | CT#82 | CP-183111 | 0978 | - | F | Support of Origination-Id in INVITE and MESSAGE methods | 15.6.0 | +| 2019-03 | CT#83 | CP-190124 | 0980 | 2 | A | References update for ISAT after related RFC completed in IETF | 15.7.0 | +| 2019-03 | CT#83 | CP-190126 | 0982 | 2 | A | Reference Update for the ISUP Cause Location Parameter Draft | 15.7.0 | +| 2019-03 | CT#83 | CP-190123 | 0988 | 1 | A | P-Served-User case orig-cdiv is now RFC 8498 | 15.7.0 | +| 2019-06 | CT#84 | CP-191094 | 0989 | - | A | Reference Update for the ISUP Cause Location Parameter Draft | 15.8.0 | +| 2019-09 | CT#85 | CP-192166 | 0992 | 1 | A | Reference Update RFC8606 | 15.9.0 | +| 2019-09 | CT#85 | CP-192174 | 0990 | 3 | F | Clarification of the usage restriction of P-Asserted-Identity header field over the II-NNI. | 16.0.0 | +| 2019-09 | CT#85 | CP-192162 | 0993 | 1 | B | Support of "Multi-Device" and "Multi-Identity" services | 16.0.0 | +| 2019-12 | CT#86 | CP-193190 | 0995 | 2 | A | P-CSCF restoration in 5GS | 16.1.0 | +| 2019-12 | CT#86 | CP-193205 | 0996 | - | B | Additional-Identity header in REFER request | 16.1.0 | +| 2019-12 | CT#86 | CP-193207 | 1004 | 1 | A | Correction for setting condition of the Contact header field | 16.1.0 | +| 2020-03 | CT#87e | CP-200229 | 1005 | 2 | F | Clarification of the scope | 16.2.0 | +| 2020-06 | CT#88e | CP-201329 | 1006 | - | F | Corrections on the II-NNI specifications on the P-Charging-Vector header field | 16.3.0 | +| 2020-06 | CT#88e | CP-201240 | 1007 | 1 | F | Re-structure of subclause for MuD/MiD service | 16.3.0 | +| 2020-06 | CT#88e | CP-201242 | 1008 | 1 | F | Adding the RLOS requirements over the II-NNI | 16.3.0 | +| 2020-09 | CT#89e | CP-202076 | 1011 | 1 | A | Addition of missing capability | 16.4.0 | +| 2020-09 | CT#89e | CP-202075 | 1015 | - | A | Support of P-Charging-Vector header field in BYE and PRACK | 16.4.0 | +| 2020-12 | CT#90e | CP-203145 | 1016 | 2 | F | Adding the description of Ix reference point. | 17.0.0 | +| 2021-03 | CT#91e | CP-210213 | 1017 | 1 | F | Correction of the dynamic view status for History-Info header field. | 17.1.0 | +| 2021-03 | CT#91e | CP-210242 | 1023 | - | A | Reference update: RFC 8841 | 17.1.0 | +| 2021-06 | CT#92e | CP-211236 | 1024 | 3 | A | IMS data channel at the II-NNI | 17.2.0 | +| 2021-06 | CT#92e | CP-211222 | 1028 | - | A | Correction on Calling number verification using signature verification and attestation information | 17.2.0 | +| 2021-06 | CT#92e | CP-211258 | 1029 | 1 | B | Support for signed attestation for emergency and priority IMS sessions | 17.2.0 | +| 2021-09 | CT#93e | CP-212227 | 1030 | 1 | B | IBCF RPH signing for MPS | 17.3.0 | +| 2022-09 | CT#97e | CP-222124 | 1032 | 2 | F | Support of Reason header for handling of Identity header errors | 17.4.0 | +| 2022-12 | CT#98e | CP-223195 | 1033 | - | F | Capability alignment: Identity Header Error Handling | 17.5.0 | +| 2022-12 | CT#98e | CP-223195 | 1034 | 1 | F | Reference update: draft-ietf-stir-identity-header-errors-handling | 17.5.0 | +| 2022-12 | CT#98e | CP-223182 | 1035 | - | B | Support of IETF draft-ietf-sipcore-multiple-reasons | 18.0.0 | +| 2023-06 | CT#100 | CP-231187 | 1036 | - | F | Reference update: RFC 9366 | 18.1.0 | +| 2023-09 | CT#101 | CP-232117 | 1038 | - | A | Reference update: RFC 9410 | 18.2.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29172/raw.md b/marked/Rel-18/29_series/29172/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..9d3ef22c26ea74f0565a21f3559705eabc886c44 --- /dev/null +++ b/marked/Rel-18/29_series/29172/raw.md @@ -0,0 +1,1708 @@ + + +# 3GPP TS 29.172 V18.1.0 (2023-06) + +Technical Specification + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Location Services (LCS); Evolved Packet Core (EPC) LCS Protocol (ELP) between the Gateway Mobile Location Centre (GMLC) and the Mobile Management Entity (MME); SLg interface (Release 18)** + +![LTE Advanced Pro logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for LTE Advanced Pro, featuring the word "lte" in black lowercase letters, with "Advanced" in green and "Pro" in red above the "e". A green signal icon is above the word "Advanced". A small "TM" symbol is at the bottom right. + +LTE Advanced Pro logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters "3GPP" in a stylized black font. The "3" has a red signal icon below it. Below the logo, the text "A GLOBAL INITIATIVE" is written in a smaller, all-caps font. A small "TM" symbol is at the bottom right of the logo. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|----------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 9 | +| 4 Functional Overview..... | 9 | +| 4.1 General ..... | 9 | +| 5 ELP Message Transport..... | 10 | +| 5.1 General ..... | 10 | +| 5.2 Use of Diameter base protocol..... | 10 | +| 5.3 Securing Diameter Messages ..... | 11 | +| 5.4 Accounting functionality..... | 11 | +| 5.5 Use of sessions ..... | 11 | +| 5.6 Transport protocol..... | 11 | +| 5.7 Routing considerations..... | 11 | +| 5.8 Advertising Application Support ..... | 11 | +| 6 ELP Procedures..... | 12 | +| 6.1 General ..... | 12 | +| 6.2 Provide Subscriber Location ..... | 12 | +| 6.2.1 General ..... | 12 | +| 6.2.2 Successful Operation..... | 12 | +| 6.2.3 Unsuccessful Operation..... | 17 | +| 6.3 Subscriber Location Report..... | 17 | +| 6.3.1 General ..... | 17 | +| 6.3.2 Successful Operation..... | 17 | +| 6.3.3 Unsuccessful Operation..... | 21 | +| 7 ELP Messages and Message Formats ..... | 21 | +| 7.1 General ..... | 21 | +| 7.2 Message Formats..... | 22 | +| 7.3 ELP Messages ..... | 22 | +| 7.3.1 Provide-Location-Request (PLR) Command ..... | 22 | +| 7.3.2 Provide-Location-Answer (PLA) Command ..... | 23 | +| 7.3.3 Location-Report-Request (LRR) Command ..... | 24 | +| 7.3.4 Location-Report-Answer (LRA) Command..... | 24 | +| 7.4 Information Elements..... | 25 | +| 7.4.1 General ..... | 25 | +| 7.4.2 SLG-Location-Type ..... | 27 | +| 7.4.3 LCS-EPS-Client-Name..... | 27 | +| 7.4.4 LCS-Requestor-Name ..... | 28 | +| 7.4.5 LCS-Priority ..... | 28 | +| 7.4.6 LCS-QoS ..... | 28 | +| 7.4.7 Horizontal-Accuracy ..... | 28 | +| 7.4.8 Vertical-Accuracy..... | 28 | +| 7.4.9 Vertical-Requested ..... | 28 | +| 7.4.10 Velocity-Requested ..... | 29 | +| 7.4.11 Response-Time ..... | 29 | +| 7.4.12 Supported-GAD-Shapes ..... | 29 | +| 7.4.13 LCS-Codeword..... | 29 | +| 7.4.14 LCS-Privacy-Check..... | 29 | +| 7.4.15 Accuracy-Fulfilment-Indicator ..... | 30 | +| 7.4.16 Age-Of-Location-Estimate ..... | 30 | + +| | | | +|---------|-------------------------------------------------------------|----| +| 7.4.17 | Velocity-Estimate ..... | 30 | +| 7.4.18 | EUTRAN-Positioning-Data ..... | 30 | +| 7.4.19 | ECGI..... | 30 | +| 7.4.20 | Location-Event ..... | 30 | +| 7.4.21 | Pseudonym-Indicator..... | 31 | +| 7.4.22 | LCS-Service-Type-ID ..... | 31 | +| 7.4.23 | LCS-Privacy-Check-Non-Session..... | 31 | +| 7.4.24 | LCS-Privacy-Check-Session ..... | 31 | +| 7.4.25 | Feature-List-ID ..... | 31 | +| 7.4.26 | Feature-List..... | 31 | +| 7.4.27 | LCS-QoS-Class ..... | 31 | +| 7.4.28 | Serving-Node..... | 32 | +| 7.4.29 | GERAN-Positioning-Info ..... | 32 | +| 7.4.30 | GERAN-Positioning-Data ..... | 32 | +| 7.4.31 | GERAN-GNSS-Positioning-Data ..... | 32 | +| 7.4.32 | UTRAN-Positioning-Info..... | 32 | +| 7.4.33 | UTRAN-Positioning-Data ..... | 32 | +| 7.4.34 | UTRAN-GNSS-Positioning-Data ..... | 32 | +| 7.4.35 | LRR-Flags ..... | 33 | +| 7.4.36 | Deferred-Location-Type..... | 33 | +| 7.4.37 | LCS-Reference-Number..... | 33 | +| 7.4.38 | Area-Event-Info ..... | 33 | +| 7.4.39 | Area-Definition..... | 34 | +| 7.4.40 | Area ..... | 34 | +| 7.4.41 | Area-Type..... | 34 | +| 7.4.42 | Area-Identification ..... | 35 | +| 7.4.43 | Occurrence-Info..... | 35 | +| 7.4.44 | Interval-Time ..... | 35 | +| 7.4.45 | Periodic-LDR-Info ..... | 35 | +| 7.4.46 | Reporting-Amount..... | 35 | +| 7.4.47 | Reporting-Interval ..... | 35 | +| 7.4.48 | Reporting-PLMN-List ..... | 35 | +| 7.4.49 | PLMN-ID-List..... | 36 | +| 7.4.50 | Periodic-Location-Support-Indicator..... | 36 | +| 7.4.51 | Prioritized-List-Indicator ..... | 36 | +| 7.4.52 | PLR-Flags..... | 36 | +| 7.4.53 | PLA-Flags..... | 37 | +| 7.4.54 | Deferred-MT-LR-Data ..... | 37 | +| 7.4.55 | Termination-Cause ..... | 38 | +| 7.4.56 | LRA-Flags ..... | 38 | +| 7.4.57 | ESMLC-Cell-Info..... | 38 | +| 7.4.58 | Cell-Portion-ID ..... | 39 | +| 7.4.59 | 1xRTT-RCID..... | 39 | +| 7.4.60 | Delayed-Location-Reporting-Data ..... | 39 | +| 7.4.61 | Civic-Address ..... | 39 | +| 7.4.62 | Barometric-Pressure ..... | 39 | +| 7.4.63 | UTRAN-Additional-Positioning-Data ..... | 39 | +| 7.4.64 | Motion-Event-Info..... | 39 | +| 7.4.65 | Linear-Distance ..... | 40 | +| 7.4.66 | Maximum-Interval..... | 40 | +| 7.4.67 | Sampling-Interval ..... | 40 | +| 7.4.68 | Reporting-Duration..... | 40 | +| 7.4.69 | Reporting-Location-Requirements ..... | 40 | +| 7.4.70 | Additional-Area ..... | 40 | +| 7.4.71 | AMF-Instance-Id ..... | 41 | +| 7.5 | Result-Code AVP and Experimental-Result AVP Values ..... | 41 | +| 7.5.1 | General ..... | 41 | +| 7.5.2 | Success ..... | 41 | +| 7.5.3 | Permanent Failures ..... | 41 | +| 7.5.3.1 | DIAMETER_ERROR_USER_UNKNOWN (5001) ..... | 41 | +| 7.5.3.2 | DIAMETER_ERROR_UNAUTHORIZED_REQUESTING_NETWORK (5490) ..... | 41 | +| 7.5.4 | Transient Failures ..... | 41 | + +7.5.4.1 DIAMETER\_ERROR\_UNREACHABLE\_USER (4221)..... 41 +7.5.4.2 DIAMETER\_ERROR\_SUSPENDED\_USER (4222) ..... 41 +7.5.4.3 DIAMETER\_ERROR\_DETACHED\_USER (4223) ..... 42 +7.5.4.4 DIAMETER\_ERROR\_POSITIONING\_DENIED (4224)..... 42 +7.5.4.5 DIAMETER\_ERROR\_POSITIONING\_FAILED (4225) ..... 42 +7.5.4.6 DIAMETER\_ERROR\_UNKNOWN\_UNREACHABLE LCS\_CLIENT (4226) ..... 42 +**Annex A (informative): Change history..... 43** + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document specifies the procedures and information coding for the EPC LCS Protocol (ELP) that is needed to support the location services in E-UTRAN, UTRAN and GERAN. The ELP message set is applicable to the SLg interface between the MME and the GMLC and the Lgd interface between the SGSN and the GMLC. ELP is developed in accordance to the general principles stated in 3GPP TS 23.271 [2]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.271: "Functional stage 2 description of Location Services (LCS)". +- [3] 3GPP TS 23.032: "Universal Geographical Area Description (GAD)". +- [4] Void. +- [5] IETF RFC 2234: "Augmented BNF for syntax specifications". +- [6] 3GPP TS 23.003: "Numbering, addressing and identification". +- [7] 3GPP TS 29.171: "LCS Application Protocol (LCS-AP) between the MME and E-SMLC". +- [8] 3GPP TS 29.274: "Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C)". +- [9] Void +- [10] 3GPP TS 32.299: "Charging management; Diameter charging applications". +- [11] 3GPP TS 29.272: "Evolved Packet System; MME and SGSN Related Interfaces Based on Diameter Protocol". +- [12] 3GPP TS 29.329: "Sh Interface based on the Diameter protocol". +- [13] 3GPP TS 33.210: "3G Security; Network Domain Security; IP Network Layer Security". +- [14] IETF RFC 4960: "Stream Control Transmission Protocol". +- [15] 3GPP TS 22.071: "Location Services (LCS); Service description". +- [16] IETF RFC 5778: "Diameter Mobile IPv6: Support for Home Agent to Diameter Server Interaction". +- [17] 3GPP TS 29.229: "Cx and Dx Interfaces based on the Diameter protocol; protocol details". +- [18] 3GPP TS 29.173: "Location Services; Diameter-based SLh interface for Control Plane LCS". +- [19] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". + +- [20] 3GPP TS 49.031: "Location Services (LCS) – Base Station System Application Part LCS Extension – (BSSAP-LE)". +- [21] 3GPP TS 25.413: "UTRAN Iu Interface RANAP signalling". +- [22] 3GPP2 A.S0014-D v5.0: "Interoperability Specification (IOS) for cdma2000 Access Network Interfaces – Part 4 (A1, A1p, A2, and A5 Interfaces) UTRAN Iu Interface RANAP signalling". +- [23] IETF RFC 6733: "Diameter Base Protocol". +- [24] 3GPP TS 24.080: "Mobile radio interface layer 3 Supplementary services specification; Formats and coding". +- [25] IETF RFC 7944: "Diameter Routing Message Priority". +- [26] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +**EPC-MO-LR:** EPC Mobile Originating Location Request + +**EPC-MT-LR:** EPC Mobile Terminating Location Request + +**EPC-NI-LR:** EPC Network Induced Location Request + +**PS-MO-LR:** Packet Switched Mobile Originating Location Request + +**PS-MT-LR:** Packet Switched Mobile Terminating Location Request + +**PS-NI-LR:** Packet Switched Network Induced Location Request + +**LCS:** LoCation Services + +**LCS Client:** software and/or hardware entity that interacts with a LCS Server (in this case, the GMLC) for the purpose of obtaining location information for one or more Mobile Stations. LCS Clients subscribe to LCS in order to obtain location information. LCS Clients may or may not interact with human users. The LCS Client is responsible for formatting and presenting data and managing the user interface (dialogue). The LCS Client may reside in the Mobile Station (UE). + +**LCS QoS:** The QoS class determines the degree of adherence to the quality of service information as required by the source of a location request. + +**Target:** UE being positioned + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|-----|---------------------------------| +| SLg | Interface between GMLC and MME | +| Lgd | Interface between GMLC and SGSN | + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|------|--------------------------------------------------| +| DRMP | Diameter Routing Message Priority | +| EPC | Enhanced Packet Core | +| GMLC | Gateway Mobile Location Centre | +| IMEI | International Mobile Equipment Identity | +| IMS | IP Multimedia Subsystem | +| IMSI | International Mobile Subscriber Identity | +| MME | Mobility Management Entity | +| TTTP | Transfer To Third Party | +| UE | User Equipment, as defined in 3GPP TS 23.032 [3] | + +# 4 Functional Overview + +## 4.1 General + +This document defines the EPC LCS Protocol (ELP) used on the SLg interface between the GMLC and the MME and on the Lgd interface between the GMLC and the SGSN in the Evolved Packet Core (EPC). + +The location of the SLg interface within the LCS logical architecture is shown in Figure 4.1-1. + +![Diagram of the SLg interface in the LCS Architecture](99bae07626f60f9ede10e2e387ef7051_img.jpg) + +The diagram illustrates the LCS logical architecture. On the left, a 'UE' (User Equipment) is connected to an 'eNB' (evolved NodeB). The 'eNB' is connected to an 'MME' (Mobility Management Entity). The 'MME' is connected to an 'HSS' (Home Subscriber Server) above it and an 'E-SMLC' (Evolved SMLC) below it. The 'E-SMLC' is connected to a 'Serving Gateway' (SGW), which is connected to a 'PDN Gateway' (PDN-GW). The 'PDN-GW' is connected to an 'IMS' (IP Multimedia Subsystem), which is connected to a 'PSAP' (Packet Switched Application Processor). The 'MME' is connected to a 'GMLC' (Gateway Mobile Location Centre) via an 'SLg' interface. The 'GMLC' is connected to an 'LRF' (Location Retrieval Function). The 'GMLC' and 'LRF' are enclosed in a dashed box. The 'LRF' is connected to the 'IMS' and the 'PSAP'. + +Diagram of the SLg interface in the LCS Architecture + +Figure 4.1-1 SLg interface in the LCS Architecture + +The location of the Lgd interface within the LCS logical architecture is shown in Figure 4.1-2. + +![Diagram of the LCS Architecture showing the Lgd interface. The diagram illustrates the flow of location information from a UE through various network elements. A UE is connected to an RNC/BSS, which is connected to an SGSN. The SGSN is connected to an HSS and a Serving Gateway. The Serving Gateway is connected to a PDN Gateway, which is connected to an IMS. The IMS is connected to a PSAP. A GMLC and an LRF are shown in a dashed box, with the GMLC connected to the SGSN via the Lgd interface. The LRF is connected to the IMS and the PSAP.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +graph LR + UE[UE] --> RNC[RNC/BSS] + RNC --> SGSN[SGSN] + SGSN --> HSS[HSS] + SGSN --> LGD[Lgd] + LGD --> GMLC[GMLC] + GMLC --> LRF[LRF] + LRF --> IMS((IMS)) + IMS --> PSAP((PSAP)) + SGSN --> SG[Serving Gateway] + SG --> PG[PDN Gateway] + PG --> IMS + +``` + +Diagram of the LCS Architecture showing the Lgd interface. The diagram illustrates the flow of location information from a UE through various network elements. A UE is connected to an RNC/BSS, which is connected to an SGSN. The SGSN is connected to an HSS and a Serving Gateway. The Serving Gateway is connected to a PDN Gateway, which is connected to an IMS. The IMS is connected to a PSAP. A GMLC and an LRF are shown in a dashed box, with the GMLC connected to the SGSN via the Lgd interface. The LRF is connected to the IMS and the PSAP. + +**Figure 4.1-2 Lgd interface in the LCS Architecture** + +The high level functions of the ELP protocol are described in 3GPP TS 23.271 [2]. + +The main functions of the protocol are: + +- To allow the GMLC to request position estimates for a particular target UE from the MME or SGSN in order to support the EPC-MT-LR or PS-MT-LR positioning procedures. This is achieved using the Provide Subscriber Location message; +- To allow the MME or SGSN to return a position estimate or an error report to the GMLC in response to a Provide Subscriber Location request as part of an EPC-MT-LR or PS-MT-LR positioning procedure; +- To allow the MME to forward an unsolicited position estimate to the GMLC as part of the EPC-MO-LR or EPC-NI-LR procedures. This is achieved using the Subscriber Location Report message; +- To allow the SGSN to forward an unsolicited position estimate to the GMLC as part of the PS-MO-LR, PS-NI-LR or periodic MO-LR TTTP procedures. This is achieved using the Subscriber Location Report message; +- To allow the GMLC to acknowledge receipt of an unsolicited position estimate as part of the EPC-MO-LR, EPC-NI-LR, PS-MO-LR, PS-NI-LR or periodic MO-LR TTTP procedures; +- To allow the GMLC to request position estimates for a particular target UE from the SGSN or MME as part of the deferred MT-LR procedure. This is achieved using the Provide Subscriber Location message; +- To allow the SGSN or MME to acknowledge receipt of position estimate request to the GMLC as part of a deferred MT-LR procedure; +- To support the procedures for handover of an IMS emergency call with EPS/GPRS access. + +# 5 ELP Message Transport + +## 5.1 General + +The ELP protocol is defined as a Vendor Specific diameter application (SLg application). It reuses the basic mechanisms defined by the Diameter base protocol as specified in IETF RFC 6733 [23], and it defines a number of additional commands and AVPs to implement the SLg, Lgd specific procedures. + +## 5.2 Use of Diameter base protocol + +The Diameter base protocol as specified in IETF RFC 6733 [23] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as described in this + +specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified. + +## 5.3 Securing Diameter Messages + +For secure transport of Diameter messages, see 3GPP TS 33.210 [13]. + +## 5.4 Accounting functionality + +Accounting functionality (Accounting Session State Machine, related command codes and AVPs) shall not be used on the SLg, Lgd interfaces. + +## 5.5 Use of sessions + +Between the MME and the GMLC and between the SGSN and the GMLC, Diameter sessions shall be implicitly terminated. An implicitly terminated session is one for which the server does not maintain state information. The client shall not send any re-authorization or session termination requests to the server. + +The Diameter base protocol as specified in IETF RFC 6733 [23] includes the Auth-Session-State AVP as the mechanism for the implementation of implicitly terminated sessions. + +The client (server) shall include in its requests (responses) the Auth-Session-State AVP set to the value NO\_STATE\_MAINTAINED (1), as described in IETF RFC 6733 [23]. As a consequence, the server shall not maintain any state information about this session and the client shall not send any session termination request. Neither the Authorization-Lifetime AVP nor the Session-Timeout AVP shall be present in requests or responses. + +## 5.6 Transport protocol + +Diameter messages over the SLg and Lgd interfaces shall make use of SCTP (see IETF RFC 4960 [14]). + +## 5.7 Routing considerations + +This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host. + +Destination-Realm AVP shall always be included in all diameter requests, and therefore is declared as mandatory in the ABNF for all commands. + +When a request is initiated by the GMLC, the name of the MME or SGSN shall be determined by querying the HSS over the SLh interface, and retrieve the specific MME or SGSN that is currently serving the UE. Therefore, Destination-Host AVP shall always be included in the commands originated at the GMLC, and is declared as mandatory in the ABNF. + +When a request is initiated by the MME or SGSN, the name of the GMLC may be either locally configured in the MME/SGSN (e.g., in the intra-domain scenario, when the GMLC belongs to the same PLMN as the MME/SGSN), or it is known from a previously received location procedure initiated at the GMLC. Therefore, the Destination-Host AVP is declared as mandatory in the ABNF of the commands originated at the MME or SGSN. + +If the Vendor-Specific-Application-ID AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node, and it shall not be used for routing purposes. + +## 5.8 Advertising Application Support + +The MME, SGSN and GMLC shall advertise support of the Diameter SLg Application by including the value of the application identifier in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The vendor identifier value of 3GPP (10415) shall be included in the Supported-Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The Vendor-Id AVP included in Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [23]. + +# 6 ELP Procedures + +## 6.1 General + +The ELP procedures, between the GMLC and the MME over SLg interface and between GMLC and SGSN over Lgd interface, are used to exchange messages related to location services. The ELP can be divided into the following sub-procedures. + +- Provide Subscriber Location +- Subscriber Location Report + +## 6.2 Provide Subscriber Location + +### 6.2.1 General + +The Provide Subscriber Location operation is used by a GMLC to request the location of a target UE from the MME or SGSN at any time, as part of EPC-MT-LR or PS-MT-LR positioning procedures. The response contains a location estimate of the target UE and other additional information. + +The Provide Subscriber Location operation is also used by a GMLC to request the location of the target UE from the SGSN or MME at any time, as part of deferred MT-LR procedure. The response contains the acknowledgment of the receipt of the request and other additional information. + +### 6.2.2 Successful Operation + +![Sequence diagram showing the successful operation of the Provide Subscriber Location procedure. The GMLC sends a PROVIDE SUBSCRIBER LOCATION REQUEST to the MME/SGSN, and the MME/SGSN responds with a PROVIDE SUBSCRIBER LOCATION RESPONSE.](426efb7efdc753a13f2fa16f7bff9429_img.jpg) + +``` +sequenceDiagram + participant GMLC + participant MME_SGSN as MME/SGSN + Note left of MME_SGSN: + GMLC->>MME_SGSN: PROVIDE SUBSCRIBER LOCATION REQUEST + MME_SGSN-->>GMLC: PROVIDE SUBSCRIBER LOCATION RESPONSE + Note right of GMLC: +``` + +Sequence diagram showing the successful operation of the Provide Subscriber Location procedure. The GMLC sends a PROVIDE SUBSCRIBER LOCATION REQUEST to the MME/SGSN, and the MME/SGSN responds with a PROVIDE SUBSCRIBER LOCATION RESPONSE. + +**Figure 6.2.2-1: Provide Subscriber Location procedure. Successful operation.** + +The GMLC initiates the procedure by sending a PROVIDE SUBSCRIBER LOCATION REQUEST message to the MME or SGSN. This message carries the type of location information requested (e.g. current location and optionally, velocity), the UE subscriber's IMSI, LCS QoS information (e.g. accuracy, response time), an indication of whether the LCS client has the override capability, and an indication of whether delayed location reporting for UEs transiently not reachable (e.g. UEs in extended idle mode DRX or Power Saving Mode) is supported as specified in clauses 9.1.6 and 9.1.15 of 3GPP TS 23.271 [2]. The message also carries an LCS reference number, if delayed location reporting is supported. For deferred MT-LR procedure, additionally, the message carries Deferred location type, LCS reference number, H-GMLC address, periodic LDR info, triggered LDR info, etc. + +Upon reception of PROVIDE SUBSCRIBER LOCATION REQUEST message, the MME or SGSN shall perform authentication privacy verification on the location request. After that, for EPC-MT-LR or PS-MT-LR procedures the MME or SGSN shall retrieve the location information of the target UE from E-UTRAN or UTRAN/GERAN according to the procedures described in 3GPP TS 23.271 [2]. For a deferred EPC-MT-LR procedure, the MME shall wait until the UE becomes reachable before performing authentication privacy verification on the location request and instigating periodic or triggered location in the UE. + +The MME or SGSN returns a PROVIDE SUBSCRIBER LOCATION RESPONSE to the GMLC. For EPC-MT-LR or PS-MT-LR procedures, if the target UE is transiently not reachable and delayed location reporting for UEs transiently not reachable is supported, the message shall contain an indication that the UE is transiently not reachable; otherwise the message shall contain the location estimate, its age and obtained accuracy. If the MME or SGSN failed to get the current location and the LCS client is requesting the current or last known location, the MME or SGSN may return the last known location of the target UE if this is known. + +For a deferred EPC-MT-LR procedure for periodic or triggered location, the MME returns a PROVIDE SUBSCRIBER LOCATION RESPONSE to the GMLC to indicate that the MME is able and willing to support the procedure. After the MME has performed successful authentication privacy verification on the location request and successfully instigated periodic or triggered location in the UE, the MME returns a SUBSCRIBER LOCATION REPORT to the GMLC to indicate that periodic or triggered location has been activated in the UE. The MME (or a different MME) returns additional SUBSCRIBER LOCATION REPORT messages to the GMLC (or possibly to a different GMLC if not the HGMLC) for each periodic or triggered location event detected by the UE. For details, refer to 3GPP TS 23.271 [2]. + +If the GMLC has received indication from the HSS indicating the combined MME/SGSN node supporting the optimized LCS procedure (see 3GPP TS 29.173 [18] clause 5.2.1.2) and if the GMLC also supports optimized LCS procedure, the GMLC shall set the "Optimized-LCS-Proc-Req" bit within the PLR-Flags of the PROVIDE SUBSCRIBER LOCATION REQUEST message during EPC-MT-LR and/or PS-MT-LR procedures. When the combined MME/SGSN receives this message with "Optimized-LCS-Proc-Req" bit within the PLR-Flags set, the combined MME/SGSN shall perform EPC-MT-LR or PS-MT-LR procedure depending upon the knowledge of the current RAT type of the UE. E.g. if the UE is in active mode in E-UTRAN, the combined MME/SGSN shall perform only EPC-MT-LR procedure; if the ISR activated UE is in idle mode, the combined MME/SGSN shall perform the paging followed by either EPC-MT-LR or PS-MT-LR procedure (depending upon the RAT where the UE is active). Hence, the combined MME/SGSN shall perform optimized LCS procedure to retrieve the location information of the target UE from either E-UTRAN or UTRAN/GERAN. + +The combined MME/SGSN shall return a PROVIDE SUBSCRIBER LOCATION RESPONSE to the GMLC. If the target UE is transiently not reachable and delayed location reporting for UEs transiently not reachable is supported, the message shall contain an indication that the UE is transiently not reachable; otherwise the message shall contain the location estimate, its age and obtained accuracy. If the combined MME/SGSN failed to get the current location and the LCS client is requesting the current or last known location, the combined MME/SGSN should return the latest of the last known EPS or UTRAN/GERAN location of the target UE if this is known. In both the cases, the combined MME/SGSN may set "Optimized-LCS-Proc-Performed" bit within PLA-Flags, if it has performed optimized LCS procedure. + +This procedure is mapped to the commands Provide-Location-Request/Answer in the Diameter application specified in clauses 7.3.1 and 7.3.2. + +Table 6.2.2-1: Provide Subscriber Location Request + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------------|-------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location Type | SLg-Location-Type | M | This Information Element shall contain the type of location measurement requested, such as current location, initial location, last known location, etc. (see 3GPP TS 22.071 [15]). | +| IMSI | User-Name | C | If present, this Information Element shall contain the IMSI of the user whose UE is to be positioned (see Note 1). | +| MSISDN | MSISDN | C | If present, this Information Element shall contain the MSISDN of the user whose UE is to be positioned (see Note 1). | +| IMEI | IMEI | C | If present, this Information Element shall contain the IMEI of the UE to be positioned (see Note 1). | +| Client Name | LCS-EPS-Client-Name | M | This Information Element shall contain the name of the LCS client issuing the positioning request. | +| Client Type | LCS-Client-Type | M | This Information Element shall contain the type of LCS client (Emergency, Lawful Interception ...) issuing the positioning request (see 3GPP TS 23.271 [2] and 3GPP TS 32.299 [10]). | +| Requestor Name | LCS-Requestor-Name | O | If present, this Information Element contains the identity of the originating entity which has requested the location of the target UE from the LCS Client. | +| Priority | LCS-Priority | O | If present, this Information Element shall contain the priority of the LCS client issuing the positioning request. | +| QoS | LCS-QoS | O | If present, this Information Element shall contain the quality of service requested, such as the accuracy of the positioning measurement and the response time of the positioning operation. | +| Velocity Requested | Velocity-Requested | O | If present, this information element shall contain an indication of whether or not the Velocity of the target UE is requested. | +| Supported GAD Shapes | LCS-Supported-GAD-Shapes | O | If present, this Information Element shall contain the list of supported GAD shapes by the LCS client. | +| Service Type ID | LCS-Service-Type-ID | O | If present, this Information Element shall contain the service type associated for the particular positioning request (the meaning of the different service types is defined in 3GPP TS 22.071 [15]). | +| Codeword | LCS-Codeword | O | If present, this Information Element shall contain the Codeword to be used between an LCS client and a target UE in order to check and accept or reject the positioning request. | +| APN | Service-Selection | C | If present, this Information Element shall contain the Access Point Name (APN) Network Identifier of the LCS client, as used by the target UE. It shall only be included in session-related location requests. | +| Session-Related Privacy Check | LCS-Privacy-Check-Session | O | If present, this Information Element shall contain an indication of how the positioning operation should proceed in the relation to the checking of the session-related privacy settings of the user. | +| Non-Session-Related Privacy Check | LCS-Privacy-Check-Non-Session | O | If present, this Information Element shall contain an indication of how the positioning operation should proceed in the relation to the checking of the non-session-related privacy settings of the user. | +| Deferred Location Type | Deferred-Location-Type | O | If present, this Information Element shall contain the type of the event until when the location estimation is deferred. Applicable event types are: UE available, UE entering or leaving or being in a pre-defined geographical area, periodic location, UE moving by more than a minimum linear distance (NOTE). This Information Element is applicable only for the deferred MT-LR procedure.
NOTE: this value is only applicable to a deferred EPC-MT-LR. | +| LCS-Reference Number | LCS-Reference-Number | O | If present, this Information Element shall contain the reference number identifying the deferred location request or identifying the request for which delayed location reporting for UEs transiently not reachable is supported. This Information Element is applicable only when:
- the deferred MT-LR procedure is initiated; or
- an EPC-MT-LR or PS-MT-LR procedure is initiated and the message includes the indication that delayed location reporting for UEs transiently not reachable is supported. | +| Area Event Info | Area-Event-Info | O | If present, this Information Element shall contain area definition, type of area event, occurrence info and minimum interval time. For a deferred EPC-MT-LR, this Information Element may also contain the duration of event reporting, the maximum time interval between event reports, the maximum event sampling interval, and whether location | + +| | | | | +|--------------------------------------------------------------------|--------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | estimates shall be included in event reports. This Information Element is applicable only when the deferred MT-LR is initiated for the area event (UE entering or leaving or being in a pre-defined geographical area). | +| H-GMLC Address | GMLC-Address | O | If present, this Information Element shall contain the address identifying the H-GMLC which initiated the deferred MT-LR procedure. This Information Element is applicable only when the deferred MT-LR procedure is performed. | +| PLR Flags | PLR-Flags | O | This Information Element contains a bit mask. See 7.4.52 for the meaning of the bits. | +| Periodic LDR Information | Periodic-LDR-Information | O | If present, this Information Element shall contain reporting amount and reporting interval of deferred periodic location. This Information Element is applicable only when the deferred MT-LR procedure is initiated for the periodic location event. | +| Reporting PLMN List | Reporting-PLMN-List | O | If present, this Information Element shall contain a list of PLMNs in which the subsequent location estimates must be obtained, or the subsequent triggered or periodic events must be reported, by the UE as part of a periodic MO-LR TTTP or periodic MT-LR procedure. | +| Supported Features (See 3GPP TS 29.229 [17]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Motion Event Info | Motion-Event-Info | O | If present, this Information Element shall contain information for motion event reporting. This information includes the minimum linear distance for a motion event report, the duration of event reporting, the minimum and maximum time intervals between event reports, the maximum event sampling interval, whether location estimates shall be included in event reports, and whether only one location report is required or more than one. This Information Element is applicable only for a deferred EPC-MT-LR. | +| NOTE 1: At least one of these IEs shall be present in the message. | | | | + +Table 6.2.2-2: Provide Subscriber Location Answer + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This Information Element shall contain the result of the operation. The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [23]). The Experimental-Result AVP shall be used for ELP errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Location Estimate | Location-Estimate | O | If present, this Information Element shall contain an estimate of the location of the UE in universal coordinates and the accuracy of the estimate.
This Information Element shall not be included if the PLA Flags Information Element is present and if the bit corresponding to the "UE-Transiently-Not-Reachable-Indicator" is set. | +| Accuracy Fulfilment Indicator | Accuracy-Fulfilment-Indicator | O | If present, this Information Element shall contain an indication of whether the requested accuracy (as indicated in the LCS-QoS IE in the request message) was fulfilled or not. | +| Age of Location Estimate | Age-of-Location-Estimate | O | If present, this Information Element shall contain an indication of how long ago the location estimate was obtained. | +| Velocity Estimate | Velocity-Estimate | O | If present, this Information Element shall contain an estimate of the velocity of the target UE, composed by horizontal speed, vertical speed, and their respective uncertainty (see 3GPP TS 23.032 [3]). | +| EUTRAN Positioning Data | EUTRAN-Positioning-Data | O | If present, this Information Element shall indicate the usage of each positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. The internal structure and encoding is defined in 3GPP TS 29.171 [7]. This Information Element is applicable only when the UE is attached to E-UTRAN access and when the message is sent by the MME or the combined MME/SGSN. | +| ECGI | ECGI | O | If present, this Information Element shall contain the current cell location of the target UE as delivered by the eNB to the MME. The E-UTRAN Cell Global Identifier (ECGI) is used to globally identify a cell. This Information Element is applicable only when the UE is attached to E-UTRAN access and when the message is sent by the MME or combined MME/SGSN. | +| GERAN Positioning Info | GERAN-Positioning-Info | O | If present, this Information Element shall indicate the usage of each positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. This Information Element is applicable only when the UE is attached to GERAN access and when the message is sent by the SGSN or combined MME/SGSN. | +| CGI | Cell-Global-Identity | O | If present, this Information Element shall contain the current cell location of the target UE. The Cell Global Identifier (CGI) is used to globally identify a cell. This Information Element is applicable only when the UE is attached to GERAN access and when the message is sent by the SGSN or combined MME/SGSN. | +| UTRAN Positioning Info | UTRAN-Positioning-Info | O | If present, this Information Element shall indicate the usage of each positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. This Information Element is applicable only when the UE is attached to UTRAN access and when the message is sent by the SGSN or combined MME/SGSN. | +| SAI | Service-Area-Identity | O | If present, this Information Element shall contain the current service area of the target UE. The Service Area Identifier (SAI) is used to globally identify a service area. This Information Element is applicable only when the UE is attached to UTRAN access and when the message is sent by the SGSN or combined MME/SGSN. | +| Target Serving Node Identity | Serving-Node | O | If present, this information element shall contain the address of the target side serving node for handover of an IMS Emergency Call. | +| PLA Flags | PLA-Flags | O | This Information Element contains a bit mask. See 7.4.53 for the meaning of the bits.
If this Information Element is present and if the bit corresponding to the "Deferred-MT-LR-Response-Indicator" is set, the "Location-Estimate" Information Element is ignored in this message. | + +| | | | | +|----------------------------------------------|---------------------|---|----------------------------------------------------------------------------------------------------------------------| +| E-SMLC provided Cell Info | ESMLC-Cell-Info | O | If present, this Information Element shall contain the current cell information of the target UE as known by E-SMLC. | +| Civic Address | Civic-Address | O | If present, this Information Element contains a location estimate for the target UE expressed as a Civic address. | +| Barometric Pressure | Barometric-Pressure | O | If present, this Information Element contains the barometric pressure measurement as reported by the target UE. | +| Supported Features (See 3GPP TS 29.229 [17]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +### 6.2.3 Unsuccessful Operation + +On receipt of a PROVIDE SUBSCRIBER LOCATION RESPONSE with a Result-Code or Experimental-Result AVP indicating failure the GMLC considers the positioning request as failed. + +If the GMLC receives "Optimized-LCS-Proc-Performed" bit within PLA-Flags set, it shall assume that the combined MME/SGSN has either performed EPC-MT-LR or PS-MT-LR procedure to retrieve the location of the target UE. And hence, it need not send another PROVIDE SUBSCRIBER LOCATION REQUEST message to the combined MME/SGSN. + +## 6.3 Subscriber Location Report + +### 6.3.1 General + +The Subscriber Location Report operation is used by an MME or SGSN to provide the location of a target UE to a GMLC, when a request for location has been implicitly issued or when a Delayed Location Reporting is triggered after receipt of a request for location for a UE transiently not reachable. + +### 6.3.2 Successful Operation + +![Sequence diagram showing the successful operation of the Subscriber Location Report procedure. The MME/SGSN sends a SUBSCRIBER LOCATION REPORT message to the GMLC, and the GMLC responds with a SUBSCRIBER LOCATION REPORT ACK message.](b0d4609bc46c2d88a8318706bb5321f7_img.jpg) + +``` + +sequenceDiagram + participant MME/SGSN + participant GMLC + Note left of MME/SGSN: + MME/SGSN->>GMLC: SUBSCRIBER LOCATION REPORT + Note right of GMLC: + GMLC-->>MME/SGSN: SUBSCRIBER LOCATION REPORT ACK + Note left of MME/SGSN: + +``` + +Sequence diagram showing the successful operation of the Subscriber Location Report procedure. The MME/SGSN sends a SUBSCRIBER LOCATION REPORT message to the GMLC, and the GMLC responds with a SUBSCRIBER LOCATION REPORT ACK message. + +**Figure 6.3.2-1: Subscriber Location Report procedure. Successful operation.** + +The MME or SGSN initiates the procedure by sending a SUBSCRIBER LOCATION REPORT message to the GMLC. The message may carry the identity of the UE, the location estimate and its age, and the event causing the location report. + +Upon reception of SUBSCRIBER LOCATION REPORT message, the GMLC shall return a SUBSCRIBER LOCATION REPORT ACK to the MME or SGSN and process the location report accordingly, e.g. transfer of the location estimate to an external LCS Client according to procedure described in 3GPP TS 23.271 [2]. + +If the Location-Event indicates a DEFERRED\_LR\_RESPONSE then the Location-Estimate shall not be sent if the LCS-Supported-GAD-Shapes had been received in Provide Subscriber Location request and the shape encoded in Location-Estimate was not marked as supported in LCS-Supported-GAD-Shapes. In such a case Termination-Cause in Deferred-MT-LR-Data shall be present with value SHAPE\_OF\_LOCATION\_ESTIMATE\_NOT\_SUPPORTED. + +If the Location-Event indicates a HANDOVER\_TO\_5GC, the Subscriber Location Report shall include Location-Event, UE identifies and AMF ID as target node information, EPC-GMLC identifies the handover by Location-Event and target AMF. + +This procedure is mapped to the commands Location-Report-Request/Answer in the Diameter application specified in clauses 7.3.3 and 7.3.4. + +Table 6.3.2-1: Subscriber Location Report + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------|-------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location Event | Location-Event | M | This Information Element shall contain the type of event that caused the location procedure to be initiated. | +| IMSI | User-Name | C | If present, this Information Element shall contain the IMSI of the user whose UE is to be positioned (see Note 1). | +| MSISDN | MSISDN | C | If present, this Information Element shall contain the MSISDN of the user whose UE is to be positioned (see Note 1). | +| IMEI | IMEI | C | If present, this Information Element shall contain the IMEI of the UE to be positioned (see Note 1). | +| Client Name | LCS-EPS-Client-Name | O | If present, this Information Element shall contain the name of the LCS client where the result of the positioning operation should be sent. | +| Location Estimate | Location-Estimate | O | If present, this Information Element shall contain an estimate of the location of the UE in universal coordinates and the accuracy of the estimate. | +| Accuracy Fulfilment Indicator | Accuracy-Fulfilment-Indicator | O | If present, this Information Element shall contain an indication of whether the requested accuracy was fulfilled or not. | +| Age of Location Estimate | Age-of-Location-Estimate | O | If present, this Information Element shall contain an indication of how long ago the location estimate was obtained. | +| Velocity Estimate | Velocity-Estimate | O | If present, this Information Element shall contain an estimate of the velocity of the UE, composed by horizontal speed, vertical speed, and their respective uncertainty (see 3GPP TS 23.032 [3]). | +| EUTRAN Positioning Data | EUTRAN-Positioning-Data | O | If present, this Information Element shall indicate the usage of each positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. The internal structure and encoding is defined in 3GPP TS 29.171 [7]. This Information Element is applicable only when the UE is attached to E-UTRAN access and when the message is sent by the MME or the MME part of the combined MME/SGSN. | +| ECGI | ECGI | O | If present, this Information Element shall contain the current cell location of the target UE as delivered by the eNB to the MME. The E-UTRAN Cell Global Identifier (ECGI) is used to globally identify a cell. This Information Element is applicable only when the UE is attached to E-UTRAN access and when the message is sent by the MME or the MME part of the combined MME/SGSN. | +| GERAN Positioning Info | GERAN-Positioning-Info | O | If present, this Information Element shall indicate the usage of each positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. This Information Element is applicable only when the UE is attached to GERAN access and when the message is sent by the SGSN or the SGSN part of the combined MME/SGSN. | +| CGI | Cell-Global-Identity | O | If present, this Information Element shall contain the current cell location of the target UE. The Cell Global Identifier (CGI) is used to globally identify a cell. This Information Element is applicable only when the UE is attached to GERAN access and when the message is sent by the SGSN or the SGSN part of the combined MME/SGSN. | +| UTRAN Positioning Info | UTRAN-Positioning-Info | O | If present, this Information Element shall indicate the usage of each positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. This Information Element is applicable only when the UE is attached to UTRAN access and when the message is sent by the SGSN or the SGSN part of the combined MME/SGSN. | +| SAI | Service-Area-Identity | O | If present, this Information Element shall contain the current service area of the target UE. The Service Area Identifier (SAI) is used to globally identify a service area. This Information Element is applicable only when the UE is attached to UTRAN access and when the message is sent by the SGSN or the SGSN part of the combined MME/SGSN. | +| Service Type ID | LCS-Service-Type-ID | O | If present, this Information Element shall contain the service type associated for the particular positioning report identifying the service at the receiving LCS Client (the meaning of the different service types is defined in 3GPP TS 22.071 [15]). | +| Pseudonym Indicator | Pseudonym-Indicator | O | If present, this Information Element shall contain an indication of whether or not a pseudonym must be allocated by the network and | + +| | | | | +|----------------------------------------------------|-----------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | transferred to the LCS client as the identity of the UE. | +| Supported Features
(See 3GPP TS
29.229 [17]) | Supported-
Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| LCS QoS Class | LCS-QoS-Class | O | If present, this Information Element shall contain the LCS-QoS-Class requested by the target UE. | +| Target Serving
Node Identity | Serving-Node | O | If present, this information element shall contain the address of the target side serving node for handover of an IMS Emergency Call. | +| LRR Flags
(See 7.4.35) | LRR-Flags | C | This Information Element contains a bit mask. See 7.4.35 for the meaning of the bits.
It shall be present when the message is sent over Lgd interface. | +| LCS-Reference
Number | LCS-Reference-
Number | O | If present, this Information Element shall contain the reference number identifying the deferred location request or identifying the request for which Delayed Location Reporting is triggered. This is same as the reference number included in the Provide Subscriber Location request for the deferred MT-LR procedure or for the EPC-MT-LR or PS-MT-LR with the Delayed-Location-Reporting-Support indication, or the reference number included in the Subscriber Location Report Ack for periodic MO-LR TTTP procedure. This Information Element shall be included if the Location-Event is set to:
- "DEFERRED_MT_LR_RESPONSE"; or
- "DELAYED_LOCATION_REPORTING". | +| Deferred MT-LR
Data | Deferred-MT-LR-
Data | O | If present, this Information Element is used to report the deferred location event type, the location information and optionally a reason why the serving node or UE aborted monitoring the event to the GMLC. The deferred location event type may correspond to the location event type requested in the Provide Subscriber Location Request. For a deferred EPC-MT-LR, the deferred location event type may also indicate LDR activation in the UE or expiration of the maximum time interval between event reports. This Information Element shall be included when the Location-Event is set to "DEFERRED_MT_LR_RESPONSE". | +| H-GMLC Address | GMLC-Address | O | If present, this Information Element shall contain the address identifying the H-GMLC which should receive location estimates. This is the same as the H-GMLC address included in the Provide Subscriber Location request for the deferred MT-LR procedure or the H-GMLC address included in the Subscriber Location Report Ack for periodic MO-LR TTTP procedure. | +| Sequence Number | Reporting-
Amount | O | If present, this parameter contains the number of the periodic location reports completed. The sequence number would be set to 1 in the first location report and increment by 1 for each new report. When the number reaches the reporting amount value, the H-GMLC (for a periodic MT-LR or a periodic MO-LR TTTP) will know the procedure is complete. This Information Element is applicable only when the message is sent by the SGSN or the SGSN part of the combined MME/SGSN. | +| Periodic LDR
Information | Periodic-LDR-
Information | O | If present, this Information Element shall contain the UE requested reporting amount and reporting interval of deferred periodic location reporting. This Information Element is applicable only when the periodic MO-LR TTTP procedure is initiated by the UE and when the message is sent by the SGSN or the SGSN part of the combined MME/SGSN. | +| E-SMLC provided
Cell Info | ESMLC-Cell-Info | O | If present, this Information Element shall contain the current cell information of the target UE as known by E-SMLC. | +| 1xRTT Reference
Cell ID | 1xRTT-RCID | O | If present, this Information Element shall contain the 1xRTT Reference Cell ID uniquely identifying of the target cell location for handover of an IMS emergency call. This Information Element is applicable only when the UE is making handover to a cdma2000 1xRTT access and when the message is sent by the MME or the MME part of the combined MME/SGSN. | +| Delayed Location
Reporting Data | Delayed-
Location-
Reporting-Data | O | If present, this Information Element is used to report to the GMLC the reason why the serving node ended an earlier EPC-MT-LR or PS-MT-LR with the Delayed-Location-Reporting-Support indication received for a UE transiently not reachable.
This Information Element shall be included when the Location-Event is set to "DELAYED_LOCATION_REPORTING". | + +| | | | | +|--------------------------------------------------------------------|---------------------|---|-------------------------------------------------------------------------------------------------------------------| +| Civic Address | Civic-Address | O | If present, this Information Element contains a location estimate for the target UE expressed as a Civic address. | +| Barometric Pressure | Barometric-Pressure | O | If present, this Information Element contains the barometric pressure measurement as reported by the target UE. | +| AMF Instance ID | AMF-Instance-Id | | If present, this Information Element contains the AMF ID for LCS Handover to 5GC. | +| NOTE 1: At least one of these IEs shall be present in the message. | | | | + +Table 6.3.2-2: Subscriber Location Report Ack + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|-----------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This Information Element shall contain the result of the operation. The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [23]). The Experimental-Result AVP shall be used for ELP errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| H-GMLC Address | GMLC-Address | O | If present, this Information Element shall contain the address identifying the H-GMLC which should receive location estimates as part of periodic MO-LR TTTP procedure. This Information Element is applicable only when the message is sent towards the SGSN or the SGSN part of the combined MME/SGSN. | +| LRA Flags | LRA-Flags | O | This Information Element contains a bit mask. See 7.4.56 for the meaning of the bits. | +| Reporting PLMN List | Reporting-PLMN-List | O | If present, this Information Element shall contain a list of PLMNs in which the subsequent location estimates must be obtained as part of periodic MO-LR TTTP procedure. This Information Element is applicable only when the message is sent towards the SGSN or the SGSN part of the combined MME/SGSN. | +| LCS Reference Number | LCS-Reference-Number | O | If present, this Information Element shall contain the reference number identifying the deferred location request or identifying the request for which Delayed Location Reporting was triggered. This Information Element is applicable only when the message is sent towards the SGSN or the SGSN part of the combined MME/SGSN. | +| Supported Features (See 3GPP TS 29.229 [17]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +### 6.3.3 Unsuccessful Operation + +If for some reason the GMLC does not accept the SUBSCRIBER LOCATION REPORT APDU, the GMLC shall send a SUBSCRIBER LOCATION REPORT ACK message with a Result-Code or Experimental-Result AVP indicating failure. + +# 7 ELP Messages and Message Formats + +## 7.1 General + +The Diameter base protocol as specified in IETF RFC 6733 [23] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified. + +This clause specifies a Diameter application that allows a Diameter server and a Diameter client: + +- to retrieve the location information of a target UE +- to report the location information of a target UE + +The SLg/Lgd interface protocol is defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the SLg interface application is 16777255 (allocated by IANA). + +The Lgd interface uses the Diameter application identifier defined for the SLg interface application. + +## 7.2 Message Formats + +This clause defines Command-Code values for the SLg interface application. These Command-Code values are applicable for the SLg and Lgd interfaces. + +Every command is defined by means of the ABNF syntax IETF RFC 2234 [5], according to the Command Code Format (CCF) specification defined in IETF RFC 6733 [23]. If the definition and use of an AVP is not specified in this document, the guidelines IETF RFC 6733 [23] shall apply. + +For these commands, the Application-ID field shall be set to 16777255 (application identifier of the SLg interface application). + +The Vendor-Specific-Application-Id AVP shall not be included in any command sent by Diameter nodes supporting applications defined in this specification. If the Vendor-Specific-Application-Id AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node. + +NOTE: The Vendor-Specific-Application-Id is included as an optional AVP in all Command Code Format specifications defined in this specification in order to overcome potential interoperability issues with intermediate Diameter agents non-compliant with IETF RFC 6733 [23]. + +The following Command Codes are defined in this specification: + +**Table 7.2-1: Command-Code values** + +| Command-Name | Abbreviation | Code | Clause | +|--------------------------|--------------|---------|--------| +| Provide-Location-Request | PLR | 8388620 | 7.3.1 | +| Provide-Location -Answer | PLA | 8388620 | 7.3.2 | +| Location-Report-Request | LRR | 8388621 | 7.3.3 | +| Location-Report-Answer | LRA | 8388621 | 7.3.4 | + +## 7.3 ELP Messages + +### 7.3.1 Provide-Location-Request (PLR) Command + +The Provide-Location-Request (PLR) command, indicated by the Command-Code field set to 8388620 and the 'R' bit set in the Command Flags field, is sent by the GMLC in order to request subscriber location to the MME or SGSN. + +Message Format + +``` +< Provide-Location-Request > ::= < Diameter Header: 8388620, REQ, PXY, 16777255 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + { SLg-Location-Type } + [ User-Name ] + [ MSISDN ] + [ IMEI ] + { LCS-EPS-Client-Name } +``` + +``` + +{ LCS-Client-Type } +[ LCS-Requestor-Name ] +[ LCS-Priority ] +[ LCS-QoS ] +[ Velocity-Requested ] +[ LCS-Supported-GAD-Shapes ] +[ LCS-Service-Type-ID ] +[ LCS-Codeword ] +[ LCS-Privacy-Check-Non-Session ] +[ LCS-Privacy-Check-Session ] +[ Service-Selection ] +[ Deferred-Location-Type ] +[ LCS-Reference-Number ] +[ Area-Event-Info ] +[ GMLC-Address ] +[ PLR-Flags ] +[ Periodic-LDR-Information ] +[ Reporting-PLMN-List ] +[ Motion-Event-Info ] +*[ Supported-Features ] +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +### 7.3.2 Provide-Location-Answer (PLA) Command + +The Provide-Location-Answer (PLA) command, indicated by the Command-Code field set to 8388620 and the 'R' bit cleared in the Command Flags field, is sent by the MME or SGSN to the GMLC in response to the Provide-Location-Request command. + +Message Format + +``` + +< Provide-Location-Answer > ::= < Diameter Header: 8388620, PXY, 16777255 > +< Session-Id > +[ DRMP ] +[ Vendor-Specific-Application-Id ] +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ Location-Estimate ] +[ Accuracy-Fulfilment-Indicator ] +[ Age-Of-Location-Estimate ] +[ Velocity-Estimate ] +[ EUTRAN-Positioning-Data ] +[ ECGI ] +[ GERAN-Positioning-Info ] +[ Cell-Global-Identity ] +[ UTRAN-Positioning-Info ] +[ Service-Area-Identity ] +[ Serving-Node ] +[ PLA-Flags ] +[ ESMLC-Cell-Info ] +[ Civic-Address ] +[ Barometric-Pressure ] +*[ Supported-Features ] +*[ AVP ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +### 7.3.3 Location-Report-Request (LRR) Command + +The Location-Report-Request (LRR) command, indicated by the Command-Code field set to 8388621 and the 'R' bit set in the Command Flags field, is sent by the MME or SGSN in order to provide subscriber location data to the GMLC. + +#### Message Format + +``` +< Location-Report-Request > ::= < Diameter Header: 8388621, REQ, PXY, 16777255 > +< Session-Id > +[ DRMP ] +[ Vendor-Specific-Application-Id ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +{ Destination-Host } +{ Destination-Realm } +{ Location-Event } +[ LCS-EPS-Client-Name ] +[ User-Name ] +[ MSISDN ] +[ IMEI ] +[ Location-Estimate ] +[ Accuracy-Fulfilment-Indicator ] +[ Age-Of-Location-Estimate ] +[ Velocity-Estimate ] +[ EUTRAN-Positioning-Data ] +[ ECGI ] +[ GERAN-Positioning-Info ] +[ Cell-Global-Identity ] +[ UTRAN-Positioning-Info ] +[ Service-Area-Identity ] +[ LCS-Service-Type-ID ] +[ Pseudonym-Indicator ] +[ LCS-QoS-Class ] +[ Serving-Node ] +[ LRR-Flags ] +[ LCS-Reference-Number ] +[ Deferred-MT-LR-Data ] +[ GMLC-Address ] +[ Reporting-Amount ] +[ Periodic-LDR-Information ] +[ ESMLC-Cell-Info ] +[ 1xRTT-RCID ] +[ Delayed-Location-Reporting-Data ] +[ Civic-Address ] +[ Barometric-Pressure ] +*[ Supported-Features ] +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] +``` + +### 7.3.4 Location-Report-Answer (LRA) Command + +The Location-Report-Answer (LRA) command, indicated by the Command-Code field set to 8388621 and the 'R' bit cleared in the Command Flags field, is sent by the GMLC to the MME or SGSN in response to the Location-Report-Request command. + +#### Message Format + +``` +< Location-Report-Answer > ::= < Diameter Header: 8388621, PXY, 16777255 > +< Session-Id > +[ DRMP ] +``` + +[ Vendor-Specific-Application-Id ] +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ GMLC-Address ] +[ LRA-Flags ] +[ Reporting-PLMN-List ] +[ LCS-Reference-Number ] +\*[ Supported-Features ] +\*[ AVP ] +[ Failed-AVP ] +\*[ Proxy-Info ] +\*[ Route-Record ] + +## 7.4 Information Elements + +### 7.4.1 General + +The following table describes the Diameter AVPs defined for the SLg interface protocol, their AVP Code values, types, possible flag values and whether the AVP may or not be encrypted. + +For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x00000001 should be used. + +Table 7.4.1-1: Diameter ELP Application AVPs + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | | +|-------------------------------------|----------|----------------|-------------|----------------|-----|------------|----------|-------------| +| | | | | Must | May | Should not | Must not | May Encrypt | +| SLG-Location-Type | 2500 | 7.4.2 | Enumerated | M, V | | | | No | +| LCS-EPS-Client-Name | 2501 | 7.4.3 | Grouped | M, V | | | | No | +| LCS-Requestor-Name | 2502 | 7.4.4 | Grouped | M, V | | | | No | +| LCS-Priority | 2503 | 7.4.5 | Unsigned32 | M, V | | | | No | +| LCS-QoS | 2504 | 7.4.6 | Grouped | M, V | | | | No | +| Horizontal-Accuracy | 2505 | 7.4.7 | Unsigned32 | M, V | | | | No | +| Vertical-Accuracy | 2506 | 7.4.8 | Unsigned32 | M, V | | | | No | +| Vertical-Requested | 2507 | 7.4.9 | Enumerated | M, V | | | | No | +| Velocity-Requested | 2508 | 7.4.10 | Enumerated | M, V | | | | No | +| Response-Time | 2509 | 7.4.11 | Enumerated | M, V | | | | No | +| Supported-GAD-Shapes | 2510 | 7.4.12 | Unsigned32 | M, V | | | | No | +| LCS-Codeword | 2511 | 7.4.13 | UTF8String | M, V | | | | No | +| LCS-Privacy-Check | 2512 | 7.4.14 | Enumerated | M, V | | | | No | +| Accuracy-Fulfilment-Indicator | 2513 | 7.4.15 | Enumerated | M, V | | | | No | +| Age-Of-Location-Estimate | 2514 | 7.4.16 | Unsigned32 | M, V | | | | No | +| Velocity-Estimate | 2515 | 7.4.17 | OctetString | M, V | | | | No | +| EUTRAN-Positioning-Data | 2516 | 7.4.18 | OctetString | M, V | | | | No | +| ECGI | 2517 | 7.4.19 | OctetString | M, V | | | | No | +| Location-Event | 2518 | 7.4.20 | Enumerated | M, V | | | | No | +| Pseudonym-Indicator | 2519 | 7.4.21 | Enumerated | M, V | | | | No | +| LCS-Service-Type-ID | 2520 | 7.4.22 | Unsigned32 | M, V | | | | No | +| LCS-Privacy-Check-Non-Session | 2521 | 7.4.23 | Grouped | M, V | | | | No | +| LCS-Privacy-Check-Session | 2522 | 7.4.24 | Grouped | M, V | | | | No | +| LCS-QoS-Class | 2523 | 7.4.27 | Enumerated | M, V | | | | No | +| GERAN-Positioning-Info | 2524 | 7.4.29 | Grouped | V | | | M | No | +| GERAN-Positioning-Data | 2525 | 7.4.30 | OctetString | V | | | M | No | +| GERAN-GANSS-Positioning-Data | 2526 | 7.4.31 | OctetString | V | | | M | No | +| UTRAN-Positioning-Info | 2527 | 7.4.32 | Grouped | V | | | M | No | +| UTRAN-Positioning-Data | 2528 | 7.4.33 | OctetString | V | | | M | No | +| UTRAN-GANSS-Positioning-Data | 2529 | 7.4.34 | OctetString | V | | | M | No | +| LRR-Flags | 2530 | 7.4.35 | Unsigned32 | V | | | M | No | +| LCS-Reference-Number | 2531 | 7.4.37 | OctetString | V | | | M | No | +| Deferred-Location-Type | 2532 | 7.4.36 | Unsigned32 | V | | | M | No | +| Area-Event-Info | 2533 | 7.4.38 | Grouped | V | | | M | No | +| Area-Definition | 2534 | 7.4.39 | Grouped | V | | | M | No | +| Area | 2535 | 7.4.40 | Grouped | V | | | M | No | +| Area-Type | 2536 | 7.4.41 | Unsigned32 | V | | | M | No | +| Area-Identification | 2537 | 7.4.42 | Grouped | V | | | M | No | +| Occurrence-Info | 2538 | 7.4.43 | Enumerated | V | | | M | No | +| Interval-Time | 2539 | 7.4.44 | Unsigned32 | V | | | M | No | +| Periodic-LDR-Information | 2540 | 7.4.45 | Grouped | V | | | M | No | +| Reporting-Amount | 2541 | 7.4.46 | Unsigned32 | V | | | M | No | +| Reporting-Interval | 2542 | 7.4.47 | Unsigned32 | V | | | M | No | +| Reporting-PLMN-List | 2543 | 7.4.48 | Grouped | V | | | M | No | +| PLMN-ID-List | 2544 | 7.4.49 | Grouped | V | | | M | No | +| PLR-Flags | 2545 | 7.4.52 | Unsigned32 | V | | | M | No | +| PLA-Flags | 2546 | 7.4.53 | Unsigned32 | V | | | M | No | +| Deferred-MT-LR-Data | 2547 | 7.4.54 | Grouped | V | | | M | No | +| Termination-Cause | 2548 | 7.4.55 | Unsigned32 | V | | | M | No | +| LRA-Flags | 2549 | 7.4.56 | Unsigned32 | V | | | M | No | +| Periodic-Location-Support-Indicator | 2550 | 7.4.50 | Enumerated | V | | | M | No | +| Prioritized-List-Indicator | 2551 | 7.4.51 | Enumerated | V | | | M | No | +| ESMLC-Cell-Info | 2552 | 7.4.57 | Grouped | V | | | M | No | +| Cell-Portion-ID | 2553 | 7.4.58 | Unsigned32 | V | | | M | No | +| 1xRTT-RCID | 2554 | 7.4.59 | OctetString | V | | | M | No | +| Delayed-Location-Reporting-Data | 2555 | 7.4.60 | Grouped | V | | | M | No | + +| | | | | | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|--------|-------------|---|--|--|---|----| +| Civic-Address | 2556 | 7.4.61 | UTF8String | V | | | M | No | +| Barometric-Pressure | 2557 | 7.4.62 | Unsigned32 | V | | | M | No | +| UTRAN-Additional-Positioning-Data | 2558 | 7.4.63 | OctetString | V | | | M | No | +| Motion-Event-Info | 2559 | 7.4.64 | Grouped | V | | | M | No | +| Linear-Distance | 2560 | 7.4.65 | Unsigned32 | V | | | M | No | +| Maximum-Interval | 2561 | 7.4.66 | Unsigned32 | V | | | M | No | +| Sampling-Interval | 2562 | 7.4.67 | Unsigned32 | V | | | M | No | +| Reporting-Duration | 2563 | 7.4.68 | Unsigned32 | V | | | M | No | +| Reporting-Location-Requirements | 2564 | 7.4.69 | Unsigned32 | V | | | M | No | +| Additional-Area | 2565 | 7.4.70 | Grouped | V | | | M | No | +| AMF-Instance-Id | 2566 | 7.4.71 | UTF8String | V | | | M | No | +| Note: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [23]. | | | | | | | | | + +Table 7.4.1-2: Diameter ELP Application reused AVPs + +| Attribute Name | AVP Code | Reference | Value Type | Comment | +|-------------------------|----------|-----------------------------------------|-------------|---------------------------------------| +| LCS-Format-Indicator | 1237 | 3GPP TS 32.299 [10] | Enumerated | | +| LCS-Name-String | 1238 | 3GPP TS 32.299 [10] | UTF8String | | +| LCS-Client-Type | 1241 | 3GPP TS 32.299 [10] | Enumerated | | +| LCS-Requestor-Id-String | 1240 | 3GPP TS 32.299 [10] | UTF8String | | +| Location-Estimate | 1242 | 3GPP TS 32.299 [10] | OctetString | | +| IMEI | 1402 | 3GPP TS 29.272 [11] | UTF8String | | +| MSISDN | 701 | 3GPP TS 29.329 [12] | OctetString | | +| Service-Selection | 493 | 3GPP TS 29.272 [11], IETF RFC 5778 [16] | UTF8String | It is used to define the APN | +| User-Name | 1 | IETF RFC 6733 [23] | UTF8String | It is used to include the user's IMSI | +| Supported-Features | 628 | 3GPP TS 29.229 [17] | Grouped | | +| Feature-List-ID | 629 | 3GPP TS 29.229 [17] | Unsigned32 | See clause 7.4.25 | +| Feature-List | 630 | 3GPP TS 29.229 [17] | Unsigned32 | See clause 7.4.26 | +| Serving-Node | 2401 | 3GPP TS 29.173 [18] | Grouped | See clause 6.4.3 | +| Cell-Global-Identity | 1604 | 3GPP TS 29.272 [11] | OctetString | See clause 7.3.119 | +| Service-Area-Identity | 1607 | 3GPP TS 29.272 [11] | OctetString | See clause 7.3.122 | +| GMLC-Address | 2405 | 3GPP TS 29.173 [18] | Address | See clause 6.4.7 | +| Visited-PLMN-Id | 1407 | 3GPP TS 29.272 [11] | OctetString | See clause 7.3.9 | +| DRMP | 301 | IETF RFC 7944 [25] | Enumerated | DRMP | + +### 7.4.2 SLg-Location-Type + +The SLg-Location-Type AVP is of type Enumerated. The following values are defined: + +CURRENT\_LOCATION (0) + +CURRENT\_OR\_LAST\_KNOWN\_LOCATION (1) + +INITIAL\_LOCATION (2) + +ACTIVATE\_DEFERRED\_LOCATION (3) + +CANCEL\_DEFERRED\_LOCATION (4) + +NOTIFICATION\_VERIFICATION\_ONLY (5) + +### 7.4.3 LCS-EPS-Client-Name + +The LCS-EPS-Client-Name AVP is of type Grouped. + +AVP format: + +LCS-EPS-Client-Name ::= + +[ LCS-Name-String ] +[ LCS-Format-Indicator ] + +The details of the LCS-Name-String AVP and the LCS-Format-Indicator AVP are described in 3GPP TS 32.299 [10]. + +### 7.4.4 LCS-Requestor-Name + +The LCS-Requestor-Name AVP is of type Grouped. + +AVP format: + +LCS-Requestor-Name ::= + +[ LCS-Requestor-Id-String ] +[ LCS-Format-Indicator ] + +The details of the LCS-Requestor-Id-String AVP and the LCS-Format-Indicator AVP are described in 3GPP TS 32.299 [10]. + +### 7.4.5 LCS-Priority + +The LCS-Priority AVP is of type Unsigned32. It indicates the priority of the location request. The value 0 shall indicate the highest priority, and the value 1 shall indicate normal priority. All other values shall be treated as 1 (normal priority). For details, refer to 3GPP TS 22.071 [15]. + +### 7.4.6 LCS-QoS + +The LCS-QoS AVP is of type Grouped. + +AVP format: + +LCS-QoS ::= + +[ LCS-QoS-Class ] +[ Horizontal-Accuracy ] +[ Vertical-Accuracy ] +[ Vertical-Requested ] +[ Response-Time ] + +### 7.4.7 Horizontal-Accuracy + +The Horizontal-Accuracy AVP is of type Unsigned32. Bits 6-0 corresponds to Uncertainty Code defined in 3GPP TS 23.032 [3]. The horizontal location error should be less than the error indicated by the uncertainty code with 67% confidence. Bits 7 to 31 shall be ignored. + +### 7.4.8 Vertical-Accuracy + +The Vertical-Accuracy AVP is of type Unsigned32. Bits 6-0 corresponds to Uncertainty Code defined in 3GPP TS 23.032 [3]. The vertical location error should be less than the error indicated by the uncertainty code with 67% confidence. Bits 7 to 31 shall be ignored. + +### 7.4.9 Vertical-Requested + +The Vertical-Requested AVP is of type Enumerated. The following values are defined: + +VERTICAL\_COORDINATE\_IS\_NOT\_REQUESTED (0) + +VERTICAL\_COORDINATE\_IS\_REQUESTED (1) + +Default value if AVP is not present is: VERTICAL\_COORDINATE\_IS\_NOT\_REQUESTED (0). + +### 7.4.10 Velocity-Requested + +The Velocity-Requested AVP is of type Enumerated. The following values are defined: + +VELOCITY\_IS\_NOT\_REQUESTED (0) + +VELOCITY\_IS\_REQUESTED (1) + +Default value if AVP is not present is: VELOCITY\_IS\_NOT\_REQUESTED (0). + +### 7.4.11 Response-Time + +The Response-Time AVP is of type Enumerated. The following values are defined: + +LOW\_DELAY (0) + +DELAY\_TOLERANT (1) + +### 7.4.12 Supported-GAD-Shapes + +The Supported-GAD-Shapes AVP is of type Unsigned32 and it shall contain a bitmask. + +A node shall mark in the BIT STRING all Shapes defined in 3GPP TS 23.032 [3] it supports. + +Bits 10-0 in shall indicate the supported Shapes defined in 3GPP TS 23.032 [3]. Bits 11 to 31 shall be ignored. + +ellipsoidPoint (0) + +ellipsoidPointWithUncertaintyCircle (1) + +ellipsoidPointWithUncertaintyEllipse (2) + +polygon (3) + +ellipsoidPointWithAltitude (4) + +ellipsoidPointWithAltitudeAndUncertaintyEllipsoid (5) + +ellipsoidArc (6) + +highAccuracyEllipsoidPointWithUncertaintyEllipse (7) + +highAccuracyEllipsoidPointWithAltitudeAndUncertaintyEllipsoid (8) + +highAccuracyEllipsoidPointWithScalableUncertaintyEllipse (9) + +highAccuracyEllipsoidPointWithAltitudeAndScalableUncertaintyEllipsoid (10) + +### 7.4.13 LCS-Codeword + +The LCS-Codeword AVP is of type UTF8String. It indicates the potential codeword string to send in a notification message to the UE. + +### 7.4.14 LCS-Privacy-Check + +The LCS-Privacy-Check AVP is of type Enumerated. The following values are defined: + +ALLOWED\_WITHOUT\_NOTIFICATION (0) + +ALLOWED\_WITH\_NOTIFICATION (1) + +ALLOWED\_IF\_NO\_RESPONSE (2) + +RESTRICTED\_IF\_NO\_RESPONSE (3) + +NOT\_ALLOWED (4) + +Default value if AVP is not present is: ALLOWED\_WITHOUT\_NOTIFICATION (0). + +### 7.4.15 Accuracy-Fulfilment-Indicator + +The Accuracy-Fulfilment-Indicator AVP is of type Enumerated. The following values are defined: + +REQUESTED\_ACCURACY\_FULFILLED (0) + +REQUESTED\_ACCURACY\_NOT\_FULFILLED (1) + +### 7.4.16 Age-Of-Location-Estimate + +The Age-Of-Location-Estimate AVP is of type Unsigned32. It indicates how long ago the location estimate was obtained in minutes, as indicated in 3GPP TS 29.002 [19]. + +### 7.4.17 Velocity-Estimate + +The Velocity-Estimate AVP is of type OctetString. It is composed of 4 or more octets with an internal structure according to 3GPP TS 23.032 [3]. + +### 7.4.18 EUTRAN-Positioning-Data + +The EUTRAN-Positioning-Data AVP is of type OctetString. It shall contain the encoded content of the "Positioning-Data" Information Element as defined in 3GPP TS 29.171 [7]. + +### 7.4.19 ECGI + +The ECGI AVP is of type OctetString. It indicates the E-UTRAN Cell Global Identifier. It is coded according to clause 8.21.5, in 3GPP TS 29.274 [8]. + +### 7.4.20 Location-Event + +The Location-Event AVP is of type Enumerated. The following values are defined: + +EMERGENCY\_CALL\_ORIGINATION (0) + +EMERGENCY\_CALL\_RELEASE (1) + +MO\_LR (2) + +EMERGENCY\_CALL\_HANDOVER (3) + +DEFERRED\_MT\_LR\_RESPONSE (4) + +DEFERRED\_MO\_LR\_TTTP\_INITIATION (5) + +DELAYED\_LOCATION\_REPORTING (6) + +HANDOVER\_TO\_5GC (7) + +DEFERRED\_MT\_LR\_RESPONSE is applicable to the delivery of an event report and/or a location estimate for an LDR initiated earlier by either the network (via an MT-LR activate deferred location) or the UE (via a periodic MO-LR TTTP initiation for a UE with UTRAN access). + +DELAYED\_LOCATION\_REPORTING is applicable to the delivery of a location estimate for an EPC-MT-LR or PS-MT-LR initiated earlier by the network for a UE which was transiently not reachable. + +### 7.4.21 Pseudonym-Indicator + +The Pseudonym-Indicator AVP is of type Enumerated. It defines if a pseudonym is requested. The following values are defined: + +PSEUDONYM\_NOT\_REQUESTED (0) + +PSEUDONYM\_REQUESTED (1) + +Default value if AVP is not present is: PSEUDONYM\_NOT\_REQUESTED (0). + +### 7.4.22 LCS-Service-Type-ID + +The LCS-Service-Type-ID is of type Unsigned32. It defines the identifier associated to one of the Service Types for which the LCS client is allowed to locate the particular UE. + +### 7.4.23 LCS-Privacy-Check-Non-Session + +The LCS-Privacy-Check-Non-Session AVP is of type Grouped. + +AVP format: + +LCS-Privacy-Check-Non-Session ::= +{ LCS-Privacy-Check } + +Default value if AVP is not present is that AVP LCS-Privacy-Check take value: ALLOWED\_WITHOUT\_NOTIFICATION (0). + +### 7.4.24 LCS-Privacy-Check-Session + +The LCS-Privacy-Check-Session AVP is of type Grouped. + +AVP format: + +LCS-Privacy-Check-Session ::= +{ LCS-Privacy-Check } + +Default value if AVP is not present is that AVP LCS-Privacy-Check take value: NOT\_ALLOWED (4). + +### 7.4.25 Feature-List-ID + +The syntax of this AVP is defined in 3GPP TS 29.229 [17]. For this release, the Feature-List-ID AVP value shall be set to 1. + +### 7.4.26 Feature-List + +The syntax of this AVP is defined in 3GPP TS 29.229 [17]. A null value indicates that there is no feature used by the application. + +NOTE: There are no features defined for this release. + +### 7.4.27 LCS-QoS-Class + +The LCS-QoS-Class AVP is of the type Enumerated. The following values are defined. + +ASSURED (0) + +BEST EFFORT (1) + +### 7.4.28 Serving-Node + +The Serving-Node AVP is of type Grouped. This AVP shall contain the information about the network node serving the targeted user. + +### 7.4.29 GERAN-Positioning-Info + +The GERAN-Positioning-Info AVP is of type Grouped. + +AVP format: + +``` +GERAN-Positioning-Info ::= + [ GERAN-Positioning-Data ] + [ GERAN-GNSS-Positioning-Data ] + *[ AVP ] +``` + +### 7.4.30 GERAN-Positioning-Data + +The GERAN-Positioning-Data AVP is of type OctetString. It shall contain the encoded content of the "Positioning Data" Information Element as defined in 3GPP TS 49.031 [20]. + +### 7.4.31 GERAN-GNSS-Positioning-Data + +The GERAN-GNSS-Positioning-Data AVP is of type OctetString. It shall contain the encoded content of the "GNSS Positioning Data" Information Element as defined in 3GPP TS 49.031 [20]. + +### 7.4.32 UTRAN-Positioning-Info + +The UTRAN-Positioning-Info AVP is of type Grouped. + +AVP format: + +``` +UTRAN-Positioning-Info ::= + [ UTRAN-Positioning-Data ] + [ UTRAN-GNSS-Positioning-Data ] + [ UTRAN-Additional-Positioning-Data ] + *[ AVP ] +``` + +### 7.4.33 UTRAN-Positioning-Data + +The UTRAN-Positioning-Data AVP is of type OctetString. It shall contain the encoded content of the "positioningDataDiscriminator" and the "positioningDataSet" included in the "positionData" Information Element as defined in 3GPP TS 25.413 [21]. + +### 7.4.34 UTRAN-GNSS-Positioning-Data + +The UTRAN-GNSS-Positioning-Data AVP is of type OctetString. It shall contain the encoded content of the "GNSS-PositioningDataSet" only, included in the "positionData" Information Element as defined in 3GPP TS 25.413 [21]. + +### 7.4.35 LRR-Flags + +The LRR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.4.35/1: + +**Table 7.4.35/1: LRR-Flags** + +| Bit | Name | Description | +|-----|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Lgd/SLg-Indicator | This bit, when set, indicates that the Location Report Request message is sent on the Lgd interface, i.e. the source node is an SGSN (or a combined MME/SGSN to which the UE is attached via UTRAN or GERAN).
This bit, when cleared, indicates that the Location Report Request message is sent on the SLg interface, i.e. the source node is an MME (or a combined MME/SGSN to which the UE is attached via E-UTRAN). | +| 1 | MO-LR-ShortCircuit-Indicator | This bit, when set, indicates that the MO-LR short circuit feature is used by the UE for location estimate. This bit is applicable only when for deferred MT-LR procedure and when the message is sent over Lgd interface. | +| 2 | MO-LR-ShortCircuit-Requested | This bit, when set, indicates that the UE is requesting to use MO-LR short circuit feature for location estimate. This bit is applicable only when periodic MO-LR TTTP procedure is initiated by the UE and when the message is sent over Lgd interface. | + +NOTE1: Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving GMLC. + +### 7.4.36 Deferred-Location-Type + +The Deferred-Location-Type AVP is of type Unsigned32 and it shall contain a bit mask. Each bit indicates a type of event, until when the location estimation is deferred. For details, please refer to 3GPP TS 23.271 [3] clause 4.4.2. The meaning of the bits shall be as defined in table 7.4.36/1: + +**Table 7.4.36/1: Deferred-Location-Type** + +| Bit | Event Type | Description | +|-----|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| 0 | UE-Available | Any event in which the SGSN has established a contact with the UE. | +| 1 | Entering-Into-Area | An event where the UE enters a pre-defined geographical area. | +| 2 | Leaving-From-Area | An event where the UE leaves a pre-defined geographical area. | +| 3 | Being-Inside-Area | An event where the UE is currently within the pre-defined geographical area. | +| 4 | Periodic-LDR | An event where a defined periodic timer expires in the UE and activates a location report or a location request. | +| 5 | Motion-Event | An event where the UE moves by more than a minimum linear distance. This event is applicable to a deferred EPC-MT-LR only. | +| 6 | LDR-Activated | An event where deferred location reporting has been activated in the UE. This event is applicable to a deferred EPC-MT-LR only. | +| 7 | Maximum-Interval-Expiration | An event where the maximum reporting interval has expired. This event is applicable to a deferred EPC-MT-LR only. | + +### 7.4.37 LCS-Reference-Number + +The LCS-Reference-Number AVP is of type OctetString of length 1. It shall contain the reference number identifying the deferred location request. + +### 7.4.38 Area-Event-Info + +The Area-Event-Info AVP is of type Grouped. + +AVP format: + +``` +Area-Event-Info ::= + { Area-Definition } + [ Occurrence-Info ] + [ Interval-Time ] + [ Maximum-Interval ] + [ Sampling-Interval ] + [ Reporting-Duration ] + [ Reporting-Location-Requirements ] + *[ AVP ] +``` + +If not included, the default value of Occurrence-Info shall be considered as "ONE\_TIME\_EVENT" (0). Interval-Time and Maximum-Interval AVPs are only applicable when the Occurrence-Info is set to "MULTIPLE\_TIME\_EVENT" (1). If not included, the default value of Interval-Time shall be considered as one and the default values of Maximum-Interval, Sampling-Interval and Reporting-Duration shall each be considered as the maximum value. + +### 7.4.39 Area-Definition + +The Area-Definition AVP is of type Grouped. + +AVP format: + +``` +Area-Definition ::= + 1*10{ Area } + *240[ Additional-Area ] + *[ AVP ] +``` + +For a PS-MT-LR over the Lgd interface, the Additional-Area AVP shall not be included. + +### 7.4.40 Area + +The Area AVP is of type Grouped. + +AVP format: + +``` +Area ::= + { Area-Type } + { Area-Identification } + *[ AVP ] +``` + +### 7.4.41 Area-Type + +The Area-Type AVP is of type Unsigned32. The following values are defined: + +``` +"Country Code" 0 +"PLMN ID" 1 +"Location Area ID" 2 +"Routing Area ID" 3 +``` + +"Cell Global ID" 4 +"UTRAN Cell ID" 5 +"Tracking Area ID" 6 +"E-UTRAN Cell Global ID" 7 + +### 7.4.42 Area-Identification + +The Area-Identification AVP is of type OctetString and shall contain the identification of the area applicable for the change of area event based deferred location reporting. For Area-Type 0 to 5, octets are coded as described in 3GPP TS 29.002 [24]. For Area-Type 6, octets are coded as defined for the Tracking Area Identity area identification in 3GPP TS 24.080 [24]. For Area-Type 7, octets are coded as defined for the ECGI area identification in 3GPP TS 24.080 [24]. For a deferred EPC-MT-LR for the area event, only Area-Type 6 and 7 are applicable. + +### 7.4.43 Occurrence-Info + +The Occurrence-Info AVP is of type Enumerated. The following values are defined: + +ONE\_TIME\_EVENT (0) +MULTIPLE\_TIME\_EVENT (1) + +### 7.4.44 Interval-Time + +The Interval-Time AVP is of type Unsigned32 and it contains the minimum time interval between area reports or motion reports, in seconds. The minimum value shall be 1 second and the maximum value 32767 seconds. + +### 7.4.45 Periodic-LDR-Info + +The Periodic-LDR-Info AVP is of type Grouped. + +AVP format: + +Periodic-LDR-Info ::= +                          { Reporting-Amount } +                          { Reporting-Interval } +                          \*[ AVP ] + +Reporting-Interval x Reporting-Amount shall not exceed 8639999 (99 days, 23 hours, 59 minutes and 59 seconds) for compatibility with OMA MLP and RLP. + +### 7.4.46 Reporting-Amount + +The Reporting-Amount AVP is of type Unsigned32 and it contains reporting frequency. Its minimum value shall be 1 and maximum value shall be 8639999. + +### 7.4.47 Reporting-Interval + +The Interval-Time AVP is of type Unsigned32 and it contains reporting interval in seconds. Its minimum value shall be 1 and maximum value shall be 8639999. + +### 7.4.48 Reporting-PLMN-List + +The Reporting-PLMN-List AVP is of type Grouped. + +AVP format: + +Reporting-PLMN-List ::= +                          1\*20{ PLMN-ID-List } +                          [ Prioritized-List-Indicator ] +                          \*[ AVP ] + +If not included, the default value of Prioritized-List-Indicator shall be considered as "NOT\_PRIORITIZED" (0). + +### 7.4.49 PLMN-ID-List + +The PLMN-ID-List AVP is of type Grouped. + +AVP format: + +PLMN-ID-List ::= +                          { Visited-PLMN-Id } +                          [ Periodic-Location-Support-Indicator ] +                          \*[ AVP ] + +If not included, the default value of Periodic-Location-Support-Indicator shall be considered as "NOT\_SUPPORTED" (0). + +### 7.4.50 Periodic-Location-Support-Indicator + +The Periodic-Location-Support-Indicator AVP is of type Enumerated and it indicates if the given PLMN-ID (indicated by Visited-PLMN-Id) supports periodic location or not. The following values are defined: + +NOT\_SUPPORTED (0) +SUPPORTED (1) + +### 7.4.51 Prioritized-List-Indicator + +The Prioritized-List-Indicator AVP is of type Enumerated and it indicates if the PLMN-ID-List is provided in prioritized order or not. The following values are defined: + +NOT\_PRIORITIZED (0) +PRIORITIZED (1) + +### 7.4.52 PLR-Flags + +The PLR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.4.52/1: + +**Table 7.4.52/1: PLR-Flags** + +| Bit | Name | Description | +|-----|----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | MO-LR-ShortCircuit-Indicator | This bit, when set, indicates that the MO-LR short circuit feature is requested for the periodic location. This bit is applicable only when the deferred MT-LR procedure is initiated for a periodic location event and when the message is sent over Lgd interface. | +| 1 | Optimized-LCS-Proc-Req | This bit, when set, indicates that the GMLC is requesting the optimized LCS procedure for the combined MME/SGSN. This bit is applicable only when the MT-LR procedure is initiated by the GMLC over the Lgd interface. The GMLC shall set this bit only when the HSS indicates the combined MME/SGSN node supporting the optimized LCS procedure. | +| 2 | Delayed-Location-Reporting-Support-Indicator | This bit, when set, indicates that the GMLC supports delayed location reporting for UEs transiently not reachable (e.g. UEs in extended idle mode DRX or Power Saving Mode) as specified in clauses 9.1.6 and 9.1.15 of 3GPP TS 23.271 [2], i.e. that the GMLC supports
- receiving a PROVIDE SUBSCRIBER LOCATION RESPONSE with the UE-Transiently-Not-Reachable-Indicator set in the PLA-Flags IE; and
- receiving the location information in a subsequent SUBSCRIBER LOCATION REPORT when the UE becomes reachable. | + +NOTE1: Bits not defined in this table shall be cleared by the sending GMLC and discarded by the receiving MME or SGSN. + +### 7.4.53 PLA-Flags + +The PLA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.4.53/1: + +**Table 7.4.53/1: PLA-Flags** + +| Bit | Name | Description | +|-----|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Deferred-MT-LR-Response-Indicator | This bit, when set, indicates that the message is sent in response to the deferred-MT location request. | +| 1 | MO-LR-ShortCircuit-Indicator | This bit, when set, indicates that the MO-LR short circuit feature is accepted by the UE, for periodic location reporting. This bit is applicable only when the message is sent over Lgd interface. | +| 2 | Optimized-LCS-Proc-Performed | This bit, when set, indicates that the combined MME/SGSN has performed the optimized LCS procedure to retrieve the location of the target UE. This bit is applicable only when the message is sent for the MT-LR procedure over the Lgd interface. | +| 3 | UE-Transiently-Not-Reachable-Indicator | This bit, when set, indicates that the UE is transiently not reachable due to power saving (e.g. UE is in extended idle mode DRX or in Power Saving Mode), and that the location information will be returned in a subsequent Subscriber Location Report when the UE becomes reachable. | + +NOTE1: Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving GMLC. + +### 7.4.54 Deferred-MT-LR-Data + +The Deferred-MT-LR-Data AVP is of type Grouped. + +AVP format: + +``` +Deferred-MT-LR-Data ::= + { Deferred-Location-Type } + [ Termination-Cause ] +``` + +[ Serving-Node ] + +\*[ AVP ] + +Serving-Node may be included only when the Termination-Cause is present indicating MT\_LR\_RESTART. + +The Serving-Node refers to the node where the UE has moved to and shall be included, if available. + +### 7.4.55 Termination-Cause + +The Termination-Cause AVP is of type Unsigned32. The following values are defined: + +| | | +|--------------------------------------------|---| +| "Normal" | 0 | +| "Error Undefined" | 1 | +| "Internal Timeout" | 2 | +| "Congestion" | 3 | +| "MT_LR_Restart" | 4 | +| "Privacy Violation" | 5 | +| "Shape of Location Estimate Not Supported" | 6 | +| "Subscriber Termination" | 7 | +| "UE Termination" | 8 | +| "Network Termination" | 9 | + +"MT\_LR\_Restart" cause code shall be used to trigger the GMLC to restart the location procedure, either because the sending node knows that the terminal has moved under coverage of another SGSN or MME, or because the subscriber has been deregistered due to a Cancel Location received from HSS. + +Any unrecognized value of Termination-Cause shall be treated the same as value 1 ("Error Undefined"). + +### 7.4.56 LRA-Flags + +The LRA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.4.56/1: + +**Table 7.4.56/1: LRA-Flags** + +| Bit | Name | Description | +|------------------------------------------------------------------------------------------------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | MO-LR-ShortCircuit-Indicator | This bit, when set, indicates that the MO-LR short circuit feature is used for obtaining location estimate. This bit is applicable only when the message is sent over Lgd interface. | +| NOTE1: Bits not defined in this table shall be cleared by the sending GMLC and discarded by the receiving MME or SGSN. | | | + +### 7.4.57 ESMLC-Cell-Info + +The ESMLC-Cell-Info AVP is of type Grouped. + +AVP format: + +ESMLC-Cell-Info ::= + +[ ECGI ] + +[ Cell-Portion-ID ] + +\*[ AVP ] + +### 7.4.58 Cell-Portion-ID + +The Cell-Portion-ID AVP is of type Unsigned32. It indicates the current Cell Portion location of the target UE as provided by the E-SMLC. It shall contain the value of the "Cell Portion ID" Information Element as defined in 3GPP TS 29.171 [7]. + +### 7.4.59 1xRTT-RCID + +The 1xRTT-RCID AVP is of type OctetString. It indicates the 1xRTT Reference Cell Id that consists of a Cell Identification Discriminator and a Cell Identification and shall be formatted according to octets 3 through the end of the Cell Identifier element defined in clause 4.2.17 in 3GPP2 A.S0014-D [22]. The allowable cell discriminator values are "0000 0010", and "0000 0111". + +### 7.4.60 Delayed-Location-Reporting-Data + +The Delayed-Location-Reporting-Data AVP is of type Grouped. + +AVP format: + +``` +Delayed-Location-Reporting-Data ::= + [ Termination-Cause ] + [ Serving-Node ] + *[ AVP ] +``` + +Serving-Node may be included only when the Termination-Cause is present indicating MT\_LR\_RESTART. + +The Serving-Node refers to the node where the UE has moved to and shall be included, if available. + +### 7.4.61 Civic-Address + +The Civic-Address AVP is of type UTF8String. It contains the XML document carried in the "Civic Address" Information Element as defined in 3GPP TS 29.171 [7]. + +### 7.4.62 Barometric-Pressure + +The Barometric-Pressure AVP is of type Unsigned32. It contains the "Barometric Pressure" Information Element as defined in 3GPP TS 29.171 [7]. + +### 7.4.63 UTRAN-Additional-Positioning-Data + +The UTRAN-Additional-Positioning-Data AVP is of type OctetString. It contains the "UTRAN Additional Positioning Data" Information Element as defined in 3GPP 25.413 [21]. + +### 7.4.64 Motion-Event-Info + +The Motion-Event-Info AVP is of type Grouped. + +AVP format: + +``` +Motion-Event-Info ::= + { Linear-Distance } + [ Occurrence-Info ] + [ Interval-Time ] + [ Maximum-Interval ] +``` + +[ Sampling-Interval ] + +[ Reporting-Duration ] + +[ Reporting-Location-Requirements ] + +\*[ AVP ] + +If not included, the default value of Occurrence-Info shall be considered as "ONE\_TIME\_EVENT" (0). Interval-Time and Maximum-Interval AVPs are only applicable when the Occurrence-Info is set to "MULTIPLE\_TIME\_EVENT" (1). If not included, the default value of Interval-Time shall be considered as one and the default values of Maximum-Interval, Sampling-Interval and Reporting-Duration shall each be considered as the maximum value. The Motion-Event-Info AVP is only applicable to a deferred EPC-MT-LR. + +### 7.4.65 Linear-Distance + +The Linear-Distance AVP is of type Unsigned32 and it contains the minimum linear (straight line) distance for motion event reports, in meters. The minimum value shall be 1 and maximum value shall be 10,000. The Linear-Distance AVP is only applicable to a deferred EPC-MT-LR. + +### 7.4.66 Maximum-Interval + +The Maximum-Interval AVP is of type Unsigned32 and it contains the maximum time interval between consecutive event reports, in seconds. The minimum value shall be 1 second and the maximum value 86400 seconds. The Maximum-Interval AVP is only applicable to a deferred EPC-MT-LR. + +### 7.4.67 Sampling-Interval + +The Sampling-Interval AVP is of type Unsigned32 and it contains the maximum time interval between consecutive evaluations by a UE of an area event or motion event, in seconds. The minimum value shall be 1 second and the maximum value 3600 seconds. The Sampling-Interval AVP is only applicable to a deferred EPC-MT-LR. + +### 7.4.68 Reporting-Duration + +The Reporting-Duration AVP is of type Unsigned32 and it contains the maximum duration of event reporting, in seconds. Its minimum value shall be 1 and maximum value shall be 8640000. The Reporting-Duration AVP is only applicable to a deferred EPC-MT-LR. + +### 7.4.69 Reporting-Location-Requirements + +The Reporting-Location-Requirements AVP is of type Unsigned32 and it shall contain a bit string indicating requirements on location provision for a deferred EPC-MT-LR. When a bit is set to one, the corresponding requirement is present. When a bit is set to zero or when the AVP is omitted, the corresponding requirement is not present. For support of backward compatibility, a receiver shall ignore any bits that are set to one but are not supported + +The meaning of the bits shall be as defined in table 7.4.69/1: + +**Table 7.4.69/1: Reporting-Location-Requirements** + +| Bit | Requirement | Description | +|------|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Location-Estimate | A location estimate is required for each area event, motion event report or expiration of the maximum time interval between event reports. | +| 1-31 | None | Spare | + +### 7.4.70 Additional-Area + +The Additional-Area AVP is of type Grouped. + +AVP format: + +``` +Additional-Area ::= + { Area-Type } + { Area-Identification } + *[ AVP ] +``` + +#### 7.4.7.1 AMF-Instance-Id + +The AMF-Instance-Id AVP is of type UTF8String and contain the AMF Instance ID. It is coded as the NfInstanceId according to clause 5.3.2-1, in 3GPP TS 29.571 [26]. + +## 7.5 Result-Code AVP and Experimental-Result AVP Values + +### 7.5.1 General + +This clause defines result code values that shall be supported by all Diameter implementations that conform to this specification. + +### 7.5.2 Success + +Result codes that fall within the Success category shall be used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in the Diameter base protocol specified in IETF RFC 6733 [23] shall be applied. + +### 7.5.3 Permanent Failures + +Errors that fall within the Permanent Failures category shall be used to inform the peer that the request has failed, and should not be attempted again. The Result-Code AVP values defined in the Diameter base protocol specified in IETF RFC 6733 [23] shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +#### 7.5.3.1 DIAMETER\_ERROR\_USER\_UNKNOWN (5001) + +This result code shall be sent by the MME/SGSN to indicate that the user is unknown. This error code is defined in 3GPP TS 29.229 [17] + +#### 7.5.3.2 DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_NETWORK (5490) + +This result code shall be sent by the MME/SGSN to indicate that the requesting GMLC's network is not authorized to request UE location information. This error code is defined in 3GPP TS 29.173 [18] + +### 7.5.4 Transient Failures + +Errors that fall within the transient failures category are those used to inform a peer that the request could not be satisfied at the time that it was received. The request may be able to be satisfied in the future. + +#### 7.5.4.1 DIAMETER\_ERROR\_UNREACHABLE\_USER (4221) + +This result code shall be sent by the MME/SGSN to indicate that the user could not be reached in order to perform positioning procedure. + +#### 7.5.4.2 DIAMETER\_ERROR\_SUSPENDED\_USER (4222) + +This result code shall be sent by the MME/SGSN to indicate that the user is suspended in the MME. + +#### 7.5.4.3 DIAMETER\_ERROR\_DETACHED\_USER (4223) + +This result code shall be sent by the MME/SGSN to indicate that the user is detached in the MME. + +#### 7.5.4.4 DIAMETER\_ERROR\_POSITIONING\_DENIED (4224) + +This result code shall be sent by the MME/SGSN to indicate that the positioning procedure was denied. + +#### 7.5.4.5 DIAMETER\_ERROR\_POSITIONING\_FAILED (4225) + +This result code shall be sent by the MME/SGSN to indicate that the positioning procedure failed. + +#### 7.5.4.6 DIAMETER\_ERROR\_UNKNOWN\_UNREACHABLE LCS\_CLIENT (4226) + +This result code shall be sent by the GMLC to indicate that the LCS Client was not known or could not be reached. + +# Annex A (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +|---------|--------|-----------|------|-----|-----|----------------------------------------------------------------------------------------|--------| +| 2010-03 | CT-47 | CP-100055 | | | | 3GPP TS presented for approval in CT#47 | 9.0.0 | +| 2010-06 | CT-48 | CP-100286 | 0001 | | | Velocity-Requested IE | 9.1.0 | +| 2010-09 | CT-49 | CP-100463 | 0002 | 1 | | Addition of Command Codes | 9.2.0 | +| 2010-09 | CT-49 | CP-100463 | 0003 | 1 | | Notification Verification Only in Location Type | | +| 2010-09 | CT-49 | CP-100463 | 0004 | 1 | | SLg for Inter Domain Scenarios | | +| 2010-09 | CT-49 | CP-100463 | 0005 | | | Editorial Updates | | +| 2010-09 | CT-49 | CP-100463 | 0007 | | | Definition of EUTRAN-Positioning-Data | | +| 2010-12 | CT-50 | CP-100681 | 0009 | | | Clarification of LCS-priority AVP | 9.3.0 | +| 2010-12 | CT-50 | CP-100681 | 0010 | | | Correction of error code assignment | | +| 2010-12 | CT-50 | CP-100681 | 0011 | | | Correction of bit numbering in Horizontal and Vertical Accuracy IEs in SLg | | +| 2010-12 | CT-50 | CP-100681 | 0012 | | | Units of Age of Location Estimate IE in SLg | | +| 2011-03 | CT-51 | CP-110054 | 0013 | 1 | | Add missing Vendor Specific Application Id | 9.4.0 | +| 2011-03 | CT-51 | CP-110054 | 0014 | 2 | | Essential correction on the value type of the ELP Application AVPs | | +| 2011-03 | | | | | | Update to Rel-10 version (MCC) | 10.0.0 | +| 2011-09 | CT-53 | CP-110565 | 0015 | 2 | | Correction to references | 10.1.0 | +| 2012-09 | CT-57 | | | | | Update to Rel-11 version (MCC) | 11.0.0 | +| 2013-03 | CT-59 | CP-130156 | 0016 | 1 | | Definition of Lgd interface between SGSN and GMLC (Clause 1, 3, 4, 5) | 12.0.0 | +| 2013-03 | CT-59 | CP-130156 | 0017 | 1 | | Definition of Lgd interface between SGSN and GMLC (Clause 2, 6, 7) | | +| 2013-06 | CT-60 | CP-130291 | 0018 | 2 | | Support of deferred MT-LR and periodic MO-LR TTTP procedures over Lgd interface | 12.1.0 | +| 2013-09 | CT-61 | CP-130458 | 0019 | 1 | | Addressing the editor's note of the Location-Event AVP | 12.2.0 | +| 2013-12 | CT-62 | CP-130631 | 0024 | 1 | | Adding E-SMLC provided Cell info and Cell Portion | 12.3.0 | +| 2013-12 | CT-62 | CP-130624 | 0023 | 3 | | Optimized LCS procedure between GMLC and combined MME/SGSN | | +| 2014-03 | CT-63 | CP-140032 | 0025 | 2 | | E-SMLC provided Cell info and Cell Portion | 12.4.0 | +| 2015-03 | CT-67 | CP-150015 | 0031 | - | | Renaming of Location-Type AVP | 12.5.0 | +| 2015-03 | CT-67 | CP-150018 | 0027 | 1 | | Location reporting in emergency 1xSRVCC | | +| 2015-12 | CT-70 | CP-150776 | 0032 | 1 | | EPC-MT-LR and PS-MT-LR procedure for UEs transiently not reachable due to power saving | 13.0.0 | +| 2015-12 | CT-70 | CP-150776 | 0034 | 2 | | Indoor Positioning support in SLg/Lgd | | +| 2016-06 | CT-72 | CP-160226 | 0035 | 1 | | Delayed Location Reporting Data in Subscriber Location Report | 13.1.0 | +| 2017-03 | CT#75 | CP-170036 | 0037 | 1 | | Bit ordering in Diameter AVPs used as bit-masks | 14.0.0 | +| 2017-03 | CT#75 | CP-170048 | 0038 | - | | Update of reference for the Diameter base protocol | 14.0.0 | +| 2017-03 | CT#75 | CP-170048 | 0039 | - | | Handling of the Vendor-Specific-Application-Id AVP | 14.0.0 | +| 2017-03 | CT#75 | CP-170048 | 0040 | 1 | | Cardinality of the Failed-AVP AVP in answer | 14.0.0 | +| 2017-06 | CT#76 | CP-171030 | 0036 | 3 | | Enhancements to Location Services for CLoT | 14.1.0 | +| 2018-03 | CT#79 | CP-180016 | 0041 | 1 | | Deferred location for the UE availability event with EPC Access | 14.2.0 | +| 2018-06 | CT#80 | - | - | - | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2019-09 | CT#85 | CP-192095 | 0042 | 1 | | Addition of High Accuracy location estimates | 15.1.0 | +| 2019-12 | CT#86 | CP-193018 | 0046 | - | | Missing AVPs in Provide-Location-Request Command | 15.2.0 | +| 2019-12 | CT#86 | CP-193022 | 0048 | - | | Motion-Event-Info AVP | 15.2.0 | +| 2020-07 | CT#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | +| 2022-03 | CT#95e | CP-220085 | 0049 | 1 | F | High Accuracy GAD Shape with Scalable Uncertainty | 16.1.0 | +| 2022-03 | CT#95e | - | - | - | | Update to Rel-17 version (MCC) | 17.0.0 | +| 2022-09 | CT#97e | CP-222022 | 0050 | - | B | Diameter message priority over SLg and Lgd | 18.0.0 | +| 2023-06 | CT#100 | CP-231031 | 0052 | 1 | B | Support of Location service bi-directional continuity from EPS to 5GS | 18.1.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29175/raw.md b/marked/Rel-18/29_series/29175/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..8236a425ee1f0e6d45a41812fcecd1c11126fe59 --- /dev/null +++ b/marked/Rel-18/29_series/29175/raw.md @@ -0,0 +1,1921 @@ + + +# 3GPP TS 29.175 V18.6.0 (2025-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; IP Multimedia Subsystem; IP Multimedia Subsystem (IMS) Application Server (AS) Services Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'G' has a red signal wave icon below it. + +3GPP logo + +A GLOBAL INITIATIVE + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis + +Valbonne - FRANCE + +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members + +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +LTET™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions, symbols and abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Symbols..... | 9 | +| 3.3 Abbreviations ..... | 9 | +| 4 Overview..... | 9 | +| 5 Services offered by the IMS AS ..... | 10 | +| 5.1 Introduction ..... | 10 | +| 5.2 Nimsas_SessionEventControl Service ..... | 10 | +| 5.2.1 Service Description ..... | 10 | +| 5.2.2 Service Operations..... | 10 | +| 5.2.2.1 Introduction..... | 10 | +| 5.2.2.1A Subscribe..... | 11 | +| 5.2.2.2 Notify ..... | 11 | +| 5.2.2.2.1 General ..... | 11 | +| 5.2.2.2.2 Notification for Session Event ..... | 11 | +| 5.3 Nimsas_MediaControl Service ..... | 12 | +| 5.3.1 Service Description ..... | 12 | +| 5.3.2 Service Operations..... | 12 | +| 5.3.2.1 Introduction..... | 12 | +| 5.3.2.2 MediaInstruction..... | 12 | +| 5.3.2.2.1 General ..... | 12 | +| 5.3.2.2.2 Media Instruction ..... | 12 | +| 6 API Definitions ..... | 13 | +| 6.1 Nimsas_SessionEventControl Service API..... | 13 | +| 6.1.1 API URI..... | 13 | +| 6.1.2 Usage of HTTP..... | 13 | +| 6.1.2.1 General..... | 13 | +| 6.1.2.2 HTTP standard headers..... | 14 | +| 6.1.2.2.1 General ..... | 14 | +| 6.1.2.2.2 Content type ..... | 14 | +| 6.1.2.3 HTTP custom headers..... | 14 | +| 6.1.3 Resources..... | 14 | +| 6.1.3.1 Overview..... | 14 | +| 6.1.3.2 Resource: Session Event Subscriptions ..... | 15 | +| 6.1.3.2.1 Description ..... | 15 | +| 6.1.3.2.2 Resource Definition..... | 15 | +| 6.1.3.2.3 Resource Standard Methods..... | 15 | +| 6.1.3.2.4 Resource Custom Operations..... | 15 | +| 6.1.4 Custom Operations without associated resources ..... | 15 | +| 6.1.5 Notifications ..... | 15 | +| 6.1.5.1 General..... | 15 | +| 6.1.5.2 Session Event Notification..... | 16 | +| 6.1.5.2.1 Description ..... | 16 | +| 6.1.5.2.2 Target URI..... | 16 | +| 6.1.5.2.3 Standard Methods..... | 16 | +| 6.1.6 Data Model ..... | 17 | +| 6.1.6.1 General..... | 17 | +| 6.1.6.2 Structured data types..... | 18 | +| 6.1.6.2.1 Introduction ..... | 18 | +| 6.1.6.2.2 Type: SessionEventNotification..... | 19 | + +| | | | +|-----------|----------------------------------------------------------------------------------|----| +| 6.1.6.2.3 | Type: NotificationEvent..... | 19 | +| 6.1.6.2.4 | Type: SessionInfo..... | 20 | +| 6.1.6.2.5 | Type: MediaInfo..... | 20 | +| 6.1.6.2.6 | Type: DcMediaSpec..... | 21 | +| 6.1.6.2.7 | Type: QosHintInfo..... | 21 | +| 6.1.6.3 | Simple data types and enumerations..... | 21 | +| 6.1.6.3.1 | Introduction ..... | 21 | +| 6.1.6.3.2 | Simple data types ..... | 21 | +| 6.1.6.3.3 | Enumeration: EventType..... | 22 | +| 6.1.6.3.4 | Enumeration: MediaType..... | 22 | +| 6.1.6.3.5 | Enumeration: SessionCase..... | 22 | +| 6.1.6.3.6 | Enumeration: EventInitiator..... | 22 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 23 | +| 6.1.6.5 | Binary data..... | 23 | +| 6.1.7 | Error Handling..... | 23 | +| 6.1.7.1 | General..... | 23 | +| 6.1.7.2 | Protocol Errors ..... | 23 | +| 6.1.7.3 | Application Errors..... | 23 | +| 6.1.8 | Feature negotiation ..... | 23 | +| 6.1.9 | Security..... | 23 | +| 6.1.10 | HTTP redirection..... | 24 | +| 6.2 | Nimsas_MediaControl Service API..... | 24 | +| 6.2.1 | API URI..... | 24 | +| 6.2.2 | Usage of HTTP..... | 24 | +| 6.2.2.1 | General..... | 24 | +| 6.2.2.2 | HTTP standard headers..... | 25 | +| 6.2.2.2.1 | General ..... | 25 | +| 6.2.2.2.2 | Content type ..... | 25 | +| 6.2.2.3 | HTTP custom headers..... | 25 | +| 6.2.3 | Resources..... | 25 | +| 6.2.3.1 | Overview..... | 25 | +| 6.2.3.2 | Resource: Individual call session..... | 26 | +| 6.2.3.2.1 | Description ..... | 26 | +| 6.2.3.2.2 | Resource Definition..... | 26 | +| 6.2.3.2.3 | Resource Standard Methods..... | 26 | +| 6.2.3.2.4 | Resource Custom Operations ..... | 26 | +| 6.2.4 | Custom Operations without associated resources ..... | 27 | +| 6.2.5 | Notifications ..... | 27 | +| 6.2.6 | Data Model ..... | 27 | +| 6.2.6.1 | General..... | 27 | +| 6.2.6.2 | Structured data types..... | 28 | +| 6.2.6.2.1 | Introduction ..... | 28 | +| 6.2.6.2.2 | Type: MediaInstructionData ..... | 28 | +| 6.2.6.2.3 | Type: MediaInstructions ..... | 29 | +| 6.2.6.2.4 | Type: DcMediaSpecification..... | 30 | +| 6.2.6.2.5 | Type: ArMediaSpecification..... | 30 | +| 6.2.6.2.6 | Type: Mdc2EndpointInfo..... | 31 | +| 6.2.6.2.7 | Type: AudioVideoReNegotiationInd ..... | 31 | +| 6.2.6.3 | Simple data types and enumerations..... | 32 | +| 6.2.6.3.1 | Introduction ..... | 32 | +| 6.2.6.3.2 | Simple data types ..... | 32 | +| 6.2.6.3.3 | Enumeration: MediaInstruction..... | 32 | +| 6.2.6.3.4 | Enumeration: MediaConnSide..... | 32 | +| 6.2.6.4 | Data types describing alternative data types or combinations of data types ..... | 32 | +| 6.2.6.5 | Binary data..... | 32 | +| 6.2.7 | Error Handling..... | 33 | +| 6.2.7.1 | General..... | 33 | +| 6.2.7.2 | Protocol Errors ..... | 33 | +| 6.2.7.3 | Application Errors..... | 33 | +| 6.2.8 | Feature negotiation ..... | 33 | +| 6.2.9 | Security..... | 33 | +| 6.2.10 | HTTP redirection..... | 33 | + +**Annex A (normative): OpenAPI specification ..... 35** +A.1 General..... 35 +A.2 Nimsas\_SessionEventControl API ..... 35 +A.3 Nimsas\_MediaControl API..... 39 +**Annex B (informative): Change history..... 43** + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nimsas Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the IMS AS. + +The 5G System stage 2 architecture and procedures are specified in TS 23.501 [2] and TS 23.502 [3]. + +The IP Multimedia Subsystem (IMS) supporting DC architecture and procedures are specified in TS 23.228 [14]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in TS 29.500 [4] and TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 7807: "Problem Details for HTTP APIs". +- [14] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [15] 3GPP TS 29.562: "5G System; Home Subscriber Server (HSS) Services; Stage 3". +- [16] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [17] 3GPP TS 29.176: "IP Multimedia Subsystems (IMS); Media Function (MF) Services; Stage 3". +- [18] 3GPP TS 24.610: "Communication HOLD (HOLD) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". + +- [19] 3GPP TS 24.186: "IMS Data Channel applications; Protocol specification". +- [20] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [21] 3GPP TS 24.604: "Communication Diversion (CDIV) using IP Multimedia (IM); Core Network (CN) subsystem; Protocol specification". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.228 [14] apply: + +- **Bootstrap data channel** +- **DC Application Server** + +## 3.2 Symbols + +For the purposes of the present document, the following symbols given in 3GPP TS 23.228 [14] apply: + +| | | +|-----|---------------------------------------------------------| +| DC1 | Reference Point between an SBI capable IMS AS and DCSF. | +| DC2 | Reference Point between an SBI capable IMS AS and MF. | + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|------|----------------------------------| +| AR | Augmented Reality | +| DC | Data Channel | +| DCSF | Data Channel Signalling Function | +| MF | Media Function | + +# --- 4 Overview + +The IP Multimedia Subsystem (IMS) architecture supporting the Data Channel services is defined in 3GPP TS 23.228 [14]. + +The IP Multimedia Subsystem (IMS) Application Server (AS) is enhanced to offer services to DCSF via the Nimsas service-based interface (see 3GPP TS 23.228 [14]) and support the following functionalities: + +- The IMS AS interacts with the DCSF via DC1 for event notifications; +- The IMS AS receives the data channel control instructions from the DCSF and accordingly interacts with the MF via DC2 for data channel media resource management. + +Figure 4-1 provides the reference model (in service-based interface representation and in reference point representation), with focus on the IMS AS. + +![Figure 4-1: Reference model – IMS AS. The diagram shows a box labeled DCSF connected to a line labeled DC1. The line DC1 connects to a point labeled Nimsas, which is connected to a large green box labeled IMS AS.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +graph LR + DCSF[DCSF] --- DC1[DC1] + DC1 --- Nimsas((Nimsas)) + Nimsas --- IMSAS[IMS AS] + +``` + +Figure 4-1: Reference model – IMS AS. The diagram shows a box labeled DCSF connected to a line labeled DC1. The line DC1 connects to a point labeled Nimsas, which is connected to a large green box labeled IMS AS. + +**Figure 4-1: Reference model – IMS AS** + +DC1 is the reference point between an SBI capable IMS AS and DCSF. + +# 5 Services offered by the IMS AS + +## 5.1 Introduction + +The IMS AS offers to other NFs the following services: + +- Nimsas\_SessionEventControl. This service enables the consumer to be notified about session events when served IMS subscribers take part in IMS sessions. +- Nimsas\_MediaControl. This service enables the consumer to control IMS AS handling of media flow within an IMS session. + +Table 5.1-1 summarizes the SBI services produced by the IMS AS and the corresponding APIs defined for this specification. + +**Table 5.1-1: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|----------------------------|--------|------------------------------------|-----------------------------------------|------------|-------| +| Nimsas_SessionEventControl | 6.1 | IMS AS SessionEventControl Service | TS29175_Nimsas_SessionEventControl.yaml | nimsas-sec | A.2 | +| Nimsas_MediaControl | 6.2 | IMS AS MediaControl Service | TS29175_Nimsas_MediaControl.yaml | nimsas-mc | A.3 | + +## 5.2 Nimsas\_SessionEventControl Service + +### 5.2.1 Service Description + +The Nimsas\_SessionEventControl service enables the consumer to be notified about session events when served IMS subscribers take part in IMS sessions. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +The Service operations defined for the Nimsas\_SessionEventControl service are as follows: + +- Notify: It allows the IMS AS to notify the IMS session control events of a specific IMS subscriber to NFs. This service operation reports the event to the consumer that has subscribed implicitly. + +NOTE: Explicit subscription to receive session events is another service operation defined in TS 23.228 [14] which has not specified in this Release. In this Release an implicit subscription is assumed where the IMS AS notifies a configured or discovered the NF consumer of a call event through a Notify. + +**Table 5.2.2.1-1: Service operations supported by the Nimsas\_SessionEventControl service** + +| Service Operations | Description | Operation Semantics | Example Consumer(s) | +|--------------------|-----------------------------------------------------------------------------|---------------------|---------------------| +| Notify | Notification about IMS session control events of a specific IMS subscriber. | Subscribe/Notify | DCSF | + +#### 5.2.2.1A      Subscribe + +This is a pseudo operation, the IMS AS does not actually provide Subscribe service operation through Nimsas\_SessionEventControl service in this Release. The actual subscription is implicitly subscribed with the SessionEventNotificationUri. + +#### 5.2.2.2      Notify + +##### 5.2.2.2.1      General + +This service operation is invoked by IMS AS and used to enables the IMS AS to notify the NF service consumers (e.g. DCSF) of IMS session events related to a specific served IMS subscriber requesting use of IMS media (e.g. data channel media). + +##### 5.2.2.2.2      Notification for Session Event + +![Sequence diagram showing the notification process between an NF Service Consumer and an IMS AS. The NF Service Consumer sends a POST request to the IMS AS. The IMS AS responds with either a 204 No Content (2a) or a 4xx/5xx (ProblemDetails) or 3xx (2b) status code.](b3c108e7145f2017957569d06ea359cb_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant IMS AS + Note left of NF Service Consumer: 1. POST {SessionEventNotificationUri}{SessionEventNotification} + NF Service Consumer->>IMS AS: Request + Note right of IMS AS: 2a. 204 No Content + IMS AS-->>NF Service Consumer: Response 2a + Note right of IMS AS: 2b. 4xx/5xx (ProblemDetails) or 3xx + IMS AS-->>NF Service Consumer: Response 2b + +``` + +Sequence diagram showing the notification process between an NF Service Consumer and an IMS AS. The NF Service Consumer sends a POST request to the IMS AS. The IMS AS responds with either a 204 No Content (2a) or a 4xx/5xx (ProblemDetails) or 3xx (2b) status code. + +**Figure 5.2.2.2.2-1: Notification for Session Event** + +- If the IMS AS observes the IMS session control events of a specific IMS subscriber that requesting use of IMS data channel media, and it determines based on the IMS subscriber's service profile that the events need to be notified to the DCSF, the IMS AS shall send a POST request to the SessionEventNotificationUri as specified in clause 6.1.5.2.2. + +The IMS AS discovers the DCSF and its session event notification URI based on local configuration or via NRF, as specified in clause AC.7.1 of 3GPP TS 23.228 [14]. + +- Upon success, the NF Service Consumer responds with "204 No Content". The NF service consumer may invoke the Nimsas\_MediaControl service before sending the session event notification response to IMS AS if the NF service consumer determines that media resources for data channel are needed. +- On failure or redirection: + - If the NF Service Consumer does not consider the "SessionEventNotificationUri" as a valid notification URI, the NF Service Consumer shall return "404 Not Found" status code with the ProblemDetails IE providing details of the error. + - In the case of redirection, the NF service consumer shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NF service consumer endpoint. A RedirectResponse IE may be included in the content of POST response. + +## 5.3 Nimsas\_MediaControl Service + +### 5.3.1 Service Description + +The Nimsas\_MediaControl service enables the consumer to control IMS AS handling of media flow within an IMS session. The service can be used by the consumer before responding to a Nimsas\_SessionEventControl\_Notify request. + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +The Service operations defined for the Nimsas\_MediaControl service are as follows: + +- MediaInstruction: It provides instructions to the IMS AS for all media flows a consumer wants to control based on its policies for the received IMS session event, and that may require media resource reservation on MF. + +NOTE: For the case when a specific media flow needs to be terminated in MF media resource (i.e. termination of a Data Channel media descriptor offered by one of the IMS subscribers) or originated by the MF (i.e. origination of a data channel media descriptor to be offered towards one of the IMS subscribers), the consumer must provide a complete MF media specification including information required by MF to know how to terminate or originate the media flow. + +**Table 5.3.2.1-1: Service operations supported by the Nimsas\_MediaControl service** + +| Service Operations | Description | Operation Semantics | Example Consumer(s) | +|--------------------|-------------------------------------------------------------------------------------------------------------------------------------|---------------------|---------------------| +| MediaInstruction | Instructions to the IMS AS for all media flows a consumer wants to control based on its policies for the received IMS session event | Request/Response | DCSF | + +#### 5.3.2.2 MediaInstruction + +##### 5.3.2.2.1 General + +This service operation provides instructions to the IMS AS for all media flows a consumer wants to control based on its policies for the received IMS session event, and that may require resource reservation in media resource + +The MediaInstruction service operation defined for Nimsas\_MediaControl service is used: + +- to enable the NF consumer to instruct the IMS AS how to manage the MF media resource. E.g., setting up the bootstrap data channel with MF both for originating and terminating side, terminating the media flow of the originating UE to MF and updating the MF resource with MDC2 media endpoint information of DC Application Server. + +##### 5.3.2.2.2 Media Instruction + +Figure 5.3.2.2.2-1 shows a scenario where the NF service consumer (e.g. DCSF) sends a request to the IMS AS to instruct the IMS AS how to manage the MF media resource. The request contains the IMS session identity ({sessionId}) which is assigned by the IMS AS during the IMS session setup and will be notified to consumer via Nimsas\_SessionEventControl notify service operation. After that, the consumer shall reuse the session ID it received from the IMS AS for referencing the same session. + +![Sequence diagram showing the interaction between an NF Service Consumer and an IMS AS. The NF Service Consumer sends a POST request to the IMS AS. The IMS AS responds with either a 200 OK (MedialInstructionData) or a 4xx/5xx (ProblemDetails) or 3xx status code.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant IMS AS + Note left of NF Service Consumer: 1. POST ../call-sessions/{sessionId}/media-instruction (MedialInstructionData) + NF Service Consumer->>IMS AS: Request + Note right of IMS AS: 2a. 200 OK (MedialInstructionData) +2b. 4xx/5xx (ProblemDetails) or 3xx + IMS AS-->>NF Service Consumer: Response + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an IMS AS. The NF Service Consumer sends a POST request to the IMS AS. The IMS AS responds with either a 200 OK (MedialInstructionData) or a 4xx/5xx (ProblemDetails) or 3xx status code. + +**Figure 5.3.2.2.2-1: Media instruction from NF service consumer** + +1. The NF service consumer shall send a POST request to the resource representing the individual session resource in the IMS AS. The payload body of the POST request shall contain the media instructions for all the media flows that the NF Service Consumer want to control based on its policies for the received IMS session event via Nimsas\_SessionEventControl notification. + +- 2a. Upon success, the IMS AS responds with "200 OK" with the message body containing a representation of the created media instruction data. + +- 2b. On failure or redirection: + +In the case of failure, one of the HTTP status code listed in Table 6.2.3.2.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.2.3.2.4.2.2-2. + +In the case of redirection, the NF service producer shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NF service producer endpoint. + +# 6 API Definitions + +## 6.1 Nimsas\_SessionEventControl Service API + +### 6.1.1 API URI + +The Nimsas\_SessionEventControl service shall use the Nimsas\_SessionEventControl API. + +The API URI of the Nimsas\_SessionEventControl API shall be: + +**{apiRoot}//** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nimsas-sec". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 7540 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nimsas\_SessionEventControl API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [13]. + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.1.3.1-1 depicts the resource URIs structure for the Nimsas\_SessionEventControl service API. + +![Diagram showing the resource URI structure for the Nimsas_SessionEventControl API. The base URI is {apiRoot}/nimsas-sec/. A line branches from the end of the base URI to a rounded rectangle containing the path /session-event-subscriptions.](9db324c513563a95ae55c77f4462a969_img.jpg) + +``` + +graph LR + A["{apiRoot}/nimsas-sec/"] --> B["/session-event-subscriptions"] + +``` + +Diagram showing the resource URI structure for the Nimsas\_SessionEventControl API. The base URI is {apiRoot}/nimsas-sec/. A line branches from the end of the base URI to a rounded rectangle containing the path /session-event-subscriptions. + +**Figure 6.1.3.1-1: Resource URI structure of the Nimsas\_SessionEventControl API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource purpose/name | Resource URI (relative path after API URI) | HTTP method or custom operation | Description (service operation) | +|------------------------------------------|--------------------------------------------|---------------------------------|---------------------------------| +| Session Event Subscriptions (Collection) | /session-event-subscriptions | POST | This is a pseudo resource. | + +#### 6.1.3.2 Resource: Session Event Subscriptions + +##### 6.1.3.2.1 Description + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nimsas-sec//session-event-subscriptions + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| Any | | | | + +**Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------| +| n/a | | | | | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +##### 6.1.3.2.4 Resource Custom Operations + +None. + +### 6.1.4 Custom Operations without associated resources + +None in this release of the specification. + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 6.1.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|----------------------------|-------------------------------|---------------------------------|------------------------------------| +| Session Event Notification | {SessionEventNotificationUri} | POST | Report the session event observed. | + +#### 6.1.5.2 Session Event Notification + +##### 6.1.5.2.1 Description + +The Session Event Notification is used by the IMS AS to report the observed Session Event to notification endpoints. + +##### 6.1.5.2.2 Target URI + +The Callback URI "{SessionEventNotificationUri}" shall be used with the callback URI variables defined in table 6.1.5.2.2-1. + +**Table 6.1.5.2.2-1: Callback URI variables** + +| Name | Definition | +|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SessionEventNotificationUri |

The notification URI of the Service Consumer (i.e., DCSF) to receive the session events.

In this release, the SessionEventNotificationUri of the Service Consumer is locally configured in the IMS AS or discovered by the IMS AS via NRF (in the default notification subscription with the "DC_SESSION_EVENT_NOTIFICATION" notification type).

| + +##### 6.1.5.2.3 Standard Methods + +###### 6.1.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.2.3.1-1 and the response data structures and response codes specified in table 6.1.5.2.3.1-1. + +**Table 6.1.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|-----------------------------------------------------------| +| SessionEventNotification | M | 1 | The session event notification to notification endpoints. | + +**Table 6.1.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents a successful notification of the event. | +| ProblemDetails | O | 0..1 | 404 Not Found | Indicates the session event notification has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND, e.g. if the NF Service Consumer (e.g. DCSF) does not serve this service user;
- NOTIFICATION_URI_NOT_FOUND, if the NF Service Consumer (e.g. DCSF) considers the "SessionEventNotificationUri" is not recognized. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.5.2.3-3: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer instance to which the request should be sent. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF instance ID towards which the notification is redirected | + +**Table 6.1.5.2.3-4: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer instance to which the request should be sent. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF instance ID towards which the notification is redirected | + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nimsas\_SessionEventControl service based interface protocol. + +**Table 6.1.6.1-1: Nimsas\_SessionEventControl specific Data Types** + +| Data type | Clause defined | Description | +|--------------------------|----------------|-----------------------------------------------------------------------------------------------| +| SessionEventNotification | 6.1.6.2.2 | The session event notification item. | +| NotificationEvent | 6.1.6.2.3 | The notification event information. | +| SessionInfo | 6.1.6.2.4 | The session information related to the notification event. | +| MediaInfo | 6.1.6.2.5 | The media information related to the notification event. | +| DcMediaSpec | 6.1.6.2.6 | The data channel media specification information which includes media description attributes. | +| QosHintInfo | 6.1.6.2.7 | The QoS requirement of the media. | +| EventType | 6.1.6.3.3 | The type of the event for which the notification is generated. | +| MediaType | 6.1.6.3.4 | The type of the media for which the notification is generated. | +| SessionCase | 6.1.6.3.5 | The type of the session case. | +| EventInitiator | 6.1.6.3.6 | The initiator of the event for which the notification is generated. | + +Table 6.1.6.1-2 specifies data types re-used by the Nimsas\_SessionEventControl service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nimsas\_SessionEventControl service based interface. + +**Table 6.1.6.1-2: Nimsas\_SessionEventControl re-used Data Types** + +| Data type | Reference | Comments | +|----------------|---------------------|----------------------------------------------------------------------| +| ImsPublicId | 3GPP TS 29.562 [15] | IMS Public Identity. | +| DcStream | 3GPP TS 29.571 [16] | Data Channel mapping and configuration information. | +| MaxMessageSize | 3GPP TS 29.571 [16] | Maximum message size of to be expected. | +| DcEndpoint | 3GPP TS 29.571 [16] | local or remote endpoint for the Data Channel. | +| SessionId | 3GPP TS 29.571 [16] | IMS Session Identity. | +| MediaId | 3GPP TS 29.571 [16] | IMS media flow identity. | +| BdcUsedBy | 3GPP TS 29.571 [16] | The party using the bootstrap data channel. | +| AppBindingInfo | 3GPP TS 29.571 [16] | The application binding information of the application data channel. | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: SessionEventNotification + +Table 6.1.6.2.2-1: Definition of type SessionEventNotification + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificationEvent | NotificationEvent | M | 1 | The NotificationEvent corresponds to a report on one subscribed event. | +| sessionId | SessionId | M | 1 | The session ID is the identity of the IMS session for which the event relates to.
This IE contains the information in the Call-ID header which is the typical header of SIP message. | +| sessionInfo | SessionInfo | C | 0..1 | The sessionInfo is the IMS session related information, e.g. the calling and called identity. It shall be contained when the attribute eventType of the notificationEvent is one of the "SESSION_ESTABLISHMENT_REQUEST", "MEDIA_CHANGE_REQUEST", "SESSION_ESTABLISHMENT_SUCCESS" (NOTE). | +| mediaInfoList | map(MediaInfo) | C | 1..N | Media info list includes a list of media related information, e.g. media identity, media type and media specifications. The mediaId attribute within the MediaInfo data type is the key of the map.
It shall be contained when the attribute eventType of the notificationEvent is one of the "SESSION_ESTABLISHMENT_REQUEST", "SESSION_ESTABLISHMENT_PROGRESS", "SESSION_ESTABLISHMENT_ALERTING", "SESSION_ESTABLISHMENT_SUCCESS", "MEDIA_CHANGE_REQUEST", "MEDIA_CHANGE_SUCCESS", "MEDIA_CHANGE_FAILURE", or "MEDIA_CHANGE_CANCEL". | +| NOTE: The sessionInfo shall be present when the attribute eventType of the notificationEvent is set to "SESSION_ESTABLISHMENT_SUCCESS" and the originating IMS AS received the redirected-to party identity via the History-Info header field in the 200 OK responses to the initial INVITE request. | | | | | + +##### 6.1.6.2.3 Type: NotificationEvent + +Table 6.1.6.2.3-1: Definition of type NotificationEvent + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| eventType | EventType | M | 1 | The event type of the event for which the notification is generated. | +| eventInitiator | EventInitiator | C | 0..1 | Event initiator indicates initiator of the event, e.g. "served IMS subscriber" vs "remote IMS subscriber".
It shall be contained when the eventType is "SESSION_ESTABLISHMENT_REQUEST" or "MEDIA_CHANGE_REQUEST". | + +##### 6.1.6.2.4 Type: SessionInfo + +Table 6.1.6.2.4-1: Definition of type SessionInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-------------|---|-------------|---------------------------------------------------------------------------------------| +| callingIdentity | ImsPublicId | O | 0..1 | The public identity of the calling IMS subscriber.
(NOTE 1) | +| calledIdentity | ImsPublicId | O | 0..1 | The public identity of the called IMS Subscriber.
(NOTE 2) | +| sessionCase | SessionCase | O | 0..1 | Indicator to indicate that whether this is an originating or terminating IMS session. | + +NOTE 1: The callingIdentity shall be set to the value of the P-Asserted-Identity header field of the received initial INVITE request, see 3GPP TS 24.186 [19] clause 9.3.2.2 and clause 9.3.3.2. + +NOTE 2: The calledIdentity shall be set to the Request URI of the received initial INVITE request, see 3GPP TS 24.186 [19] clause 9.3.2.2 and clause 9.3.3.2. If communication diversion occurs and the originating IMS AS received the History-Info header field in the 200 OK responses to the initial INVITE request, the originating IMS AS shall set the calledIdentity attribute based on the received History-Info header field, see 3GPP TS 24.604 [21] clause 4.5.2.7. + +##### 6.1.6.2.5 Type: MedialInfo + +Table 6.1.6.2.5-1: Definition of type MedialInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mediaId | MediaId | M | 1 | The media ID uniquely identifies this media item within the list. The identity is allocated by IMS AS. | +| mediaType | MediaType | M | 1 | The media type of the media for which the notification is generated. | +| dcMediaSpec | DcMediaSpec | C | 0..1 | The data channel media specification includes the relevant media attributes of interest to the consumer. It shall be contained if the mediaType is set to "DC". | +| mediaSuspended | boolean | C | 0..1 | This IE indicates whether the media is suspended or not.

It shall be contained if the media is suspended or resumed as specified in 3GPP TS 24.610 [18] and 3GPP TS 24.186 [19].
  • - true: the media is suspended.
  • - false: the media is resumed.
| +| mediaRemovalInd | boolean | C | 0..1 | This IE indicates whether the media is to be removed or not.

It shall be only present with true value if the media is to be removed, e.g. removal of bootstrap data channel media during the interaction with supplementary service, or removal of application data channel in other cases.

Presence with false value shall be prohibited. | + +##### 6.1.6.2.6 Type: DcMediaSpec + +Table 6.1.6.2.6-1: Definition of type DcMediaSpec + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| streams | map(DcStream) | M | 1..N | Represents the data channel mapping and configuration information when originating/terminating data channel media flows on the Mb interface.
The streamId attribute within the DcStream data type is the key of the map.
(NOTE) | +| maxMessageSize | MaxMessageSize | O | 0..1 | Represents the maximum message size of to be expected.
(NOTE) | +| receivedDcEndpoint | DcEndpoint | M | 0..1 | Represents the SCTP and DTLS endpoint information for the Data Channel received from the SDP offer/answer.
(NOTE) | +| bdcUsedBy | BdcUsedBy | C | 0..1 | Represents the party using the bootstrap data channel. It shall be contained when the mediaId in the data type MediaInfo represents bootstrap data channel and the streamId set to 100 and 110. | +| appBindingInfo | AppBindingInfo | C | 0..1 | Represents the application binding information of the application data channel. It shall be contained when the mediaId in the data type MediaInfo represents application data channel. | +| qosHintInfo | QosHintInfo | C | 0..1 | Represents the QoS information that is provided within the SDP media level attribute "a=3gpp-qos-hint".
It shall be included if the received SDP offer and SDP answer contains the "a=3gpp-qos-hint" attribute line. | + +NOTE: The attribute and the value are derived from the SDP received by the IMS AS in a SIP INVITE or a re-INVITE request and the corresponding response related to an IMS Data Channel. + +##### 6.1.6.2.7 Type: QosHintInfo + +Table 6.1.6.2.7-1: Definition of type QosHintInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| loss | number | O | 0..1 | Represents the maximum desirable end-to-end transport level packet loss rate in percent (without "%" sign) as a zero-based-integer or as a non-zero-real value. | +| localLoss | number | O | 0..1 | Represents the maximum desirable end-to-end transport level packet loss rate applied across the local link.
It may be included if the loss is included. | +| latency | number | O | 0..1 | Represents the maximum desirable end-to-end transport level packet latency in milliseconds as a zero-based-integer or as a non-zero-real value. | +| localLatency | number | O | 0..1 | Represents the maximum desirable end-to-end transport level packet latency applied across the local link.
It may be included if the loss is included. | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +##### 6.1.6.3.3 Enumeration: EventType + +The enumeration EventType represents the type of the event for which the notification is generated. It shall comply with the provisions defined in table 6.1.6.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration EventType** + +| Enumeration value | Description | +|----------------------------------|---------------------------------------| +| "SESSION_ESTABLISHMENT_REQUEST" | Session establishment request event. | +| "SESSION_ESTABLISHMENT_PROGRESS" | Session establishment progress event. | +| "SESSION_ESTABLISHMENT_ALERTING" | Session establishment alerting event. | +| "SESSION_ESTABLISHMENT_SUCCESS" | Session establishment success event. | +| "SESSION_ESTABLISHMENT_FAILURE" | Session establishment failure event. | +| "SESSION_ESTABLISHMENT_CANCEL" | Session establishment cancel event. | +| "MEDIA_CHANGE_REQUEST" | Media change request event. | +| "MEDIA_CHANGE_SUCCESS" | Media change success event. | +| "MEDIA_CHANGE_FAILURE" | Media change failure event. | +| "MEDIA_CHANGE_CANCEL" | Media change cancel event. | +| "SESSION_TERMINATION" | Session termination event. | + +##### 6.1.6.3.4 Enumeration: MediaType + +The enumeration MediaType represents the type of the media for which the notification is generated. It shall comply with the provisions defined in table 6.1.6.3.4-1. + +**Table 6.1.6.3.4-1: Enumeration MediaType** + +| Enumeration value | Description | +|-------------------|--------------------------| +| "DC" | Data channel media type. | +| "AUDIO" | Audio media type. | +| "VIDEO" | Video media type. | + +##### 6.1.6.3.5 Enumeration: SessionCase + +The enumeration SessionCase represents the type of the session to for which the notification is generated. It shall comply with the provisions defined in table 6.1.6.3.5-1. + +**Table 6.1.6.3.5-1: Enumeration SessionCase** + +| Enumeration value | Description | +|---------------------------|--------------------------| +| "ORIGINATING IMS_SESSION" | Originating IMS session. | +| "TERMINATING IMS_SESSION" | Terminating IMS session. | + +##### 6.1.6.3.6 Enumeration: EventInitiator + +The enumeration eventInitiator represents the initiator of the event for which the notification is generated. It shall comply with the provisions defined in table 6.1.6.3.6-1. + +**Table 6.1.6.3.6-1: Enumeration EventInitiator** + +| Enumeration value | Description | +|-------------------------|------------------------| +| "SERVED IMS SUBSCRIBER" | Served IMS subscriber. | +| "REMOTE IMS SUBSCRIBER" | Remote IMS subscriber. | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +None in this release of the specification. + +#### 6.1.6.5 Binary data + +None in this release of the specification. + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nimsas\_SessionEventControl API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nimsas\_SessionEventControl API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nimsas\_SessionEventControl service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nimsas\_SessionEventControl service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------|------------------|------------------------------------------------------------------------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The service user is not served by this DCSF, e.g. no data channel configurations for this service user is found. | +| NOTIFICATION_URI_NOT_FOUND | 404 Not Found | The session event notification URI is not recognized by the NF service consumer (i.e. DCSF). | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nimsas\_SessionEventControl API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nimsas\_SessionEventControl API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the + +"Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nimsas\_SessionEventControl API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nimsas\_SessionEventControl service. + +The Nimsas\_SessionEventControl API defines a single scope "nimsas-sessioneventcontrol" for the entire service, and it does not define any additional scopes at resource or operation level. + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different IMS AS service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different NF consumer (e.g. DCSF) instance will return the NF Instance ID of the new NF consumer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an NF consumer (e.g. DCSF) redirects a service request to a different NF consumer using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new NF consumer towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.2 Nimsas\_MediaControl Service API + +### 6.2.1 API URI + +The Nimsas\_MediaControl service shall use the Nimsas\_MediaControl API. + +The API URI of the Nimsas\_MediaControl API shall be: + +**{apiRoot}** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nimsas-mc". +- The shall be "v1". +- The shall be set as described in clause 6.2.3. + +### 6.2.2 Usage of HTTP + +#### 6.2.2.1 General + +HTTP/2, IETF RFC 7540 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nimsas\_MediaControl API is contained in Annex A. + +#### 6.2.2.2 HTTP standard headers + +##### 6.2.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.2.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [13]. + +#### 6.2.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +### 6.2.3 Resources + +#### 6.2.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.2.3.1-1 depicts the resource URIs structure for the Nimsas\_MediaControl service API. + +![Diagram showing the resource URI structure of the Nimsas_MediaControl API. The root URI is {apiRoot}/nimsas-mc/. A vertical line descends from the root to a horizontal line that branches to /call-sessions. From /call-sessions, a vertical line descends to a horizontal line that branches to a rounded rectangle containing /{sessionId}. From the bottom of the /{sessionId} box, a vertical line descends to a horizontal line that branches to a dashed rounded rectangle containing /media-instruction.](88a6d9692a52989caa6b208a1ba70dc0_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nimsas-mc/"] --> CS["/call-sessions"] + CS --> SessionId["/{sessionId}"] + SessionId --> MediaInstruction["/media-instruction"] + style MediaInstruction stroke-dasharray: 5 5 + +``` + +Diagram showing the resource URI structure of the Nimsas\_MediaControl API. The root URI is {apiRoot}/nimsas-mc/. A vertical line descends from the root to a horizontal line that branches to /call-sessions. From /call-sessions, a vertical line descends to a horizontal line that branches to a rounded rectangle containing /{sessionId}. From the bottom of the /{sessionId} box, a vertical line descends to a horizontal line that branches to a dashed rounded rectangle containing /media-instruction. + +**Figure 6.2.3.1-1: Resource URI structure of the Nimsas\_MediaControl API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource purpose/name | Resource URI (relative path after API URI) | HTTP method or custom operation | Description (service operation) | +|------------------------------------|----------------------------------------------|---------------------------------|-------------------------------------------------------------| +| Individual call session (Document) | /call-sessions/{sessionId}/media-instruction | media-instruction (POST) | Instructs the IMS AS on how to control the media resources. | + +#### 6.2.3.2 Resource: Individual call session + +##### 6.2.3.2.1 Description + +This resource represents an individual call session created in the IMS AS. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nimsas-mc//call-sessions/{sessionId} + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| sessionId | SessionId | Session ID assigned by the IMS AS during the IMS session setup and will be notified to consumer via Nimsas_SessionEventControl service. The consumer shall reuse the session ID it received from the IMS AS for referencing the same session. | + +##### 6.2.3.2.3 Resource Standard Methods + +None. + +##### 6.2.3.2.4 Resource Custom Operations + +###### 6.2.3.2.4.1 Overview + +**Table 6.2.3.2.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|-------------------|---------------------------------|--------------------|----------------------------------------| +| media-instruction | {resourceUri}/media-instruction | POST | Update call session service operation. | + +###### 6.2.3.2.4.2 Operation: media-instruction + +###### 6.2.3.2.4.2.1 Description + +###### 6.2.3.2.4.2.2 Operation Definition + +This custom operation updates an individual call session resource and provide a set of media instruction information for a given IMS session, towards IMS AS. + +This operation shall support the request data structures specified in table 6.2.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.2.3.2.4.2.2-2. + +**Table 6.2.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-------------------------------------------------------------| +| MediaInstructionData | M | 1 | Representation of the updates to apply to the call session. | + +**Table 6.2.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MediaInstructionData | C | 0..1 | 200 OK | Successful update of the call session, when the IMS AS needs to return information in the response. | +| n/a | | | 204 No Content | Successful update of the call session, when the IMS AS does not need to return information in the response. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 400 Bad Request | Indicates the media instruction has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- MEDIA_ID_NOT_FOUND | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.3.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer instance to which the request should be sent. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF instance ID towards which the request is redirected. | + +**Table 6.2.3.3.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer instance to which the request should be sent. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected. | + +### 6.2.4 Custom Operations without associated resources + +None in this release of the specification. + +### 6.2.5 Notifications + +None in this release of the specification. + +### 6.2.6 Data Model + +#### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Nimsas\_MediaControl service based interface protocol. + +**Table 6.2.6.1-1: Nimsas\_MediaControl specific Data Types** + +| Data type | Clause defined | Description | +|----------------------------|----------------|---------------------------------------------------------------------------------------------------------------------| +| ArMediaSpecification | 6.2.6.2.5 | The AR media specification information needed for AR communication services from application layer. | +| AudioVideoReNegotiationInd | 6.2.6.2.7 | The audio/video media re-negotiation indication information to connect the UE's audio/video media stream to MF. | +| DcMediaSpecification | 6.2.6.2.4 | The data channel media specification information needed for data channel media stream from application layer. | +| Mdc2EndpointInfo | 6.2.6.2.6 | The MDC2 media endpoint information. | +| MediaInstruction | 6.2.6.3.3 | The media instruction for handling a specific media flow. | +| MediaInstructionData | 6.2.6.2.2 | The media instruction data for a specific session. | +| MediaInstructions | 6.2.6.2.3 | The media instructions for a specific media flow. | +| MediaConnSide | 6.2.6.3.4 | The side that the audio or video media need to be connected to MF. E.g., both the originating and terminating side. | + +Table 6.2.6.1-2 specifies data types re-used by the Nimsas\_MediaControl service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nimsas\_MediaControl service based interface. + +**Table 6.2.6.1-2: Nimsas\_MediaControl re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|---------------------|----------------------------------------------------------------------| +| DcStream | 3GPP TS 29.571 [16] | Data Channel mapping and configuration information. | +| MdcEndpoint | 3GPP TS 29.571 [16] | The MDC1 and MDC2 Endpoint information. | +| MaxMessageSize | 3GPP TS 29.571 [16] | Maximum SCTP user message size. | +| Mdc2Protocol | 3GPP TS 29.176 [17] | Transport layer protocols for MDC2 interface. | +| MediaIdRm | 3GPP TS 29.571 [16] | IMS media flow identity. | +| MediaProxy | 3GPP TS 29.571 [16] | Media proxy configuration applicable to the media flow. | +| MediaResourceType | 3GPP TS 29.571 [16] | IMS media resource type. | +| ReplaceHttpUrl | 3GPP TS 29.571 [16] | A list of replacement HTTP URL per stream ID. | +| SessionId | 3GPP TS 29.571 [16] | IMS session identity. | +| Uri | 3GPP TS 29.571 [16] | URI | +| BdcUsedBy | 3GPP TS 29.571 [16] | The party using the bootstrap data channel. | +| AppBindingInfo | 3GPP TS 29.571 [16] | The application binding information of the application data channel. | +| QosHintInfo | 6.1.6.2.7 | The QoS hint information of the media. | + +#### 6.2.6.2 Structured data types + +##### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.2.6.2.2 Type: MediaInstructionData + +**Table 6.2.6.2.2-1: Definition of type MediaInstructionData** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sessionId | SessionId | M | 1 | The session ID is the identity of the IMS session for which the MediaInstructions applies. | +| mediaInstructionSet | map(MediaInstructions) | M | 1..N | The mediaInstructionSet includes a set of instructions for each media flow to control. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [20], with a maximum of 32 characters. | + +##### 6.2.6.2.3 Type: MediaInstructions + +Table 6.2.6.2.3-1: Definition of type MediaInstructions + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------|----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mediaId | MediaIdRm | M | 1 | The media ID uniquely identifies this media item within the list and used by the producer (IMS AS) and the consumer for referencing purposes. The consumer reuses the media ID it received from the IMS AS for referencing the same media. This field shall be null for instructions related to originating new media. | +| mediaResourceType | MediaResourceType | M | 1 | The mediaResourceType identify the Media Resource types the Media instruction is intended for. | +| mediaInstruction | MediaInstruction | C | 0..1 | It shall be included if the mediaResourceType is set to "DC". When present, mediaInstruction includes instructions to the producer (IMS AS) for handling the media. | +| dcMediaSpecification | DcMediaSpecification | C | 0..1 | Represents the additional media specifications needed for data channel media stream from application layer.
It shall be contained if the mediaResourceType is set to "DC". | +| arMediaSpecification | ArMediaSpecification | O | 0..1 | Represents the additional media specifications needed for AR communication services from application layer. | +| mediaProcessingUrl | Uri | C | 0..1 | The mediaProcessingURL indicates the address where MF receive service-related media instructions. This field shall be contained in the response when originating a new media. | +| audioVideoReNegotiationInd | AudioVideoReNegotiationInd | C | 0..1 | Represents the audio/video media re-negotiation indication information to connect the UE's audio/video media stream to MF which is required by the application data channel.

It shall be included if the mediaResourceType is set to "AUDIO" or "VIDEO". | + +##### 6.2.6.2.4 Type: DcMediaSpecification + +Table 6.2.6.2.4-1: Definition of type DcMediaSpecification + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mediaProxyConfig | MediaProxy | M | 1 | Represents the media proxy configuration on the MF. The value shall be set to "HTTP_PROXY" if the mediaId represents the bootstrap data channel. | +| replaceHttpUrls | map(ReplaceHttpUrl) | C | 1..N | Represents a list of replacement HTTP URL per stream ID allocated by the application layer for the specific IMS subscriber when requesting the application list (e.g. graphical user interface) via the MDC1 interface. It shall be included if the mediaId represents a bootstrap data channel and streamId is 0 or 100. The streamId attribute within the ReplaceHttpUrl data type is the key of the map. | +| mdc1EndpointDcsf | MdcEndpoint | C | 0..1 | Represents the MDC1 media endpoint information reserved on DCSF, e.g., the IP address and port number of DCSF. It shall be included in the request of the media instruction if the mediaId represents a bootstrap data channel. (NOTE) | +| mdc1EndpointMf | MdcEndpoint | C | 0..1 | Represents the negotiated MDC1 media endpoint information on MF, e.g., the IP address and port number of DC capable MF. It shall be included in the request of the media instruction if the mediaId represents a bootstrap data channel. (NOTE) | +| mdc2EndpointInfo | Mdc2EndpointInfo | C | 0..1 | Represents the negotiated MDC2 media endpoint information, e.g., the protocol stack, IP address and port number. It shall be included if in the request of the media instruction the mediaId represents an application data channel. | +| streams | map(DcStream) | M | 1..N | Represents the data channel mapping and configuration information when originating/terminating data channel media flows on the Mb interface. The streamId attribute within the DcStream data type is the key of the map. | +| bdcUsedby | BdcUsedBy | C | 0..1 | Represents the party using the bootstrap data channel. It shall be contained when the mediaId in the data type MediaInstructions represents bootstrap data channel and the streamId sets to 100 and 110. | +| appBindingInfo | AppBindingInfo | C | 0..1 | Represents the application binding information of the application data channel. It shall be contained when the mediaId in the data type MediaInstructions represents application data channel. | +| qosHintInfo | QosHintInfo | O | 0..1 | Represents the QoS information that is provided within the SDP media level attribute "a=3gpp-qos-hint". | +| NOTE: The MDC1 interface shall use "TCP/TLS/HTTP" protocol stack and the corresponding IP, TCP, TLS and HTTP related attributes in MdcEndpoint should be included. | | | | | + +##### 6.2.6.2.5 Type: ArMediaSpecification + +Table 6.2.6.2.5-1: Definition of type ArMediaSpecification + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------| +| mediaProcessingSpec | string | M | 1 | It specifies how the AR media stream should be processed. It indicates how the MF assists in the AR media rendering function. | + +##### 6.2.6.2.6 Type: Mdc2EndpointInfo + +Table 6.2.6.2.6-1: Definition of type Mdc2EndpointInfo + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|--------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mdc2Protocol | Mdc2Protocol | C | 0..1 | Represents the transport layer protocol or protocol stack for MDC2 interface when the "HTTP_PROXY" media proxy configuration is used in MF.

It shall be included if the value of the mediaProxyConfig within the data type DcMediaSpecification is set to "HTTP_PROXY". | +| mdc2EndpointDcAs | MdcEndpoint | C | 0..1 | Represents the negotiated MDC2 media endpoint information on DC AS.
It shall be included in the POST request message for the media control.
The attributes "tlsId", "sctpPort" and "fingerprint" within the MdcEndpoint shall be present when the value of the mediaProxyConfig within the DcMediaSpecification is set to "UDP_PROXY".
(NOTE) | +| mdc2EndpointMf | MdcEndpoint | C | 0..1 | Represents the negotiated MDC2 media endpoint information on MF.
It shall be included in the successful POST response message for the media control API.
The attributes "tlsId", "sctpPort" and "fingerprint" within the MdcEndpoint shall not be present when the value of the mediaProxyConfig within the data type DcMediaSpecification is set to "UDP_PROXY".
(NOTE) | + +NOTE: When the mdc2Protocol is set to "UDP/DTLS/SCTP", "TCP/TLS" or "SCTP/DTLS", the attributes "tlsId" and "fingerprint" within the data type MdcEndpoint shall be included, and the "securitySetup" may be included. When the value of mdc2Protocol is set to "UDP/DTLS/SCTP", the attribute "sctpPort" within the data type MdcEndpoint shall be included. + +##### 6.2.6.2.7 Type: AudioVideoReNegotiationInd + +Table 6.2.6.2.7-1: Definition of type AudioVideoReNegotiationInd + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reNegotiation | boolean | M | 1 | When present, the IE shall indicate whether the audio or video media re-negotiation to connect the UE's media stream to MF is required by the application data channel. The media type will be represented by the value of the mediaResourceType.

- true: media re-negotiation to connect the UE's audio or video media stream to MF is required.
- false: media re-negotiation to connect the UE's audio or video media stream to MF is not required. | +| mediaConnSide | MediaConnSide | C | 0..1 | Represent the audio or video media connection side that the application data channel required.

It shall be included if the reNegotiation present and the attribute value is set to true. | + +#### 6.2.6.3 Simple data types and enumerations + +##### 6.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +**Table 6.2.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|-----------------|-------------| +| | | | + +##### 6.2.6.3.3 Enumeration: MediaInstruction + +The enumeration MediaInstruction represents the instructions to the producer (IMS AS) for handling the media. It shall comply with the provisions defined in table 6.2.6.3.3-1. + +**Table 6.2.6.3.3-1: Enumeration MediaInstruction** + +| Enumeration value | Description | +|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| "TERMINATE_MEDIA" | Terminate the offered media descriptor of the UE in the media resource. | +| "ORIGINATE_MEDIA" | Originate and offer a media descriptor from the mediaResource to the UE. | +| "TERMINATE_AND_ORIGINATE_MEDIA" | Terminate the offered media flow in the mediaResource from the UE and originate the same media flow from the mediaResource to the other UE. | +| "UPDATE_MEDIA" | Update a media flow of the mediaResource previously allocated by the instructions "TerminateMedia", "OriginateMedia" and "TerminateAndOriginateMedia". | +| "DELETE_MEDIA" | Delete a media flow of the mediaResource previously allocated by the instructions "TerminateMedia", "OriginateMedia" and "TerminateAndOriginateMedia". | +| "REJECT_MEDIA" | Remove an offered media flow. | + +##### 6.2.6.3.4 Enumeration: MediaConnSide + +The enumeration MediaConnSide represents the audio or video media connection side. It shall comply with the provisions defined in table 6.2.6.3.4-1. + +**Table 6.2.6.3.4-1: Enumeration MediaConnSide** + +| Enumeration value | Description | +|-------------------|------------------------------------------------------------------------------------------------------------| +| "BOTH" | Both the originating and terminating side of the audio or video media stream shall be connected to the MF. | + +#### 6.2.6.4 Data types describing alternative data types or combinations of data types + +None in this release of the specification. + +#### 6.2.6.5 Binary data + +None in this release of the specification. + +### 6.2.7 Error Handling + +#### 6.2.7.1 General + +For the Nimsas\_MediaControl API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nimsas\_MediaControl API. + +#### 6.2.7.2 Protocol Errors + +No specific procedures for the Nimsas\_MediaControl service are specified. + +#### 6.2.7.3 Application Errors + +The application errors defined for the Nimsas\_MediaControl service are listed in table 6.2.7.3-1. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|--------------------|------------------|------------------------------------------------------------------| +| MEDIA_ID_NOT_FOUND | 400 Bad Request | Indicates that the requested mediaId is not found in the IMS AS. | + +### 6.2.8 Feature negotiation + +The optional features in table 6.2.8-1 are defined for the Nimsas\_MediaControl API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.2.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nimsas\_MediaControl API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nimsas\_MediaControl API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nimsas\_MediaControl service. + +The Nimsas\_MediaControl API defines a single scope "nimsas-mc" for the entire service, and it does not define any additional scopes at resource or operation level. + +### 6.2.10 HTTP redirection + +An HTTP request may be redirected to a different IMS AS service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different IMS AS producer instance will return the NF Instance ID of the new IMS AS producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an IMS AS redirects a service request to a different IMS AS using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new IMS AS towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5.3.1 of 3GPP TS 29.501 [5] and clause 5B of 3GPP TR 21.900 [7]). + +## --- A.2 Nimsas\_SessionEventControl API + +``` +openapi: 3.0.0 + +info: + title: 'IMS AS SessionEventControl Service' + version: 1.0.2 + description: | + Nimsas_SessionEventControl Service. + © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.175 V18.4.0; IP Multimedia Subsystem; IP Multimedia Subsystem (IMS) Application + Server (AS) Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.175/' + +servers: + - url: '{apiRoot}/nimsas-sec/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nimsas-sec + +paths: + /session-event-subscriptions: + post: + # This is a pseudo operation, NF service consumers shall NOT invoke this method! + summary: Nimsas_SessionEventControl Subscribe service operation, pseudo operation + tags: + - Session Event Subscriptions (Collection) + operationId: Subscribe + requestBody: + required: true + content: + application/json: + # Unspecified schema for the JSON body, since this is not used by consumer or producer. + schema: {} + responses: + default: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/default' + +callbacks: + eeNotification: + '{SessionEventNotificationUri}': + # The notification URI is provided by local configuration or via NRF. + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SessionEventNotification' + responses: + '204': + description: No Content, notification was successful. + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: > + The URI pointing to the resource located on the redirect target NF + service consumer. + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: > + The URI pointing to the resource located on the redirect target NF + service consumer. + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: +``` + +nimsas-sec: Access to the Nimsas\_SessionEventControl API + +schemas: + +### # STRUCTURED DATA TYPES + +``` +SessionEventNotification: + description: The session event notification item. + type: object + required: + - notificationEvent + - sessionId + properties: + notificationEvent: + $ref: '#/components/schemas/NotificationEvent' + sessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SessionId' + sessionInfo: + $ref: '#/components/schemas/SessionInfo' + mediaInfoList: + description: > + Contains a media related information. The mediaId attribute within the MediaInfo + data type is the key of the map. + type: object + additionalProperties: + $ref: '#/components/schemas/MediaInfo' + minItems: 1 + +NotificationEvent: + description: The notification event information. + type: object + required: + - eventType + properties: + eventType: + $ref: '#/components/schemas/EventType' + eventInitiator: + $ref: '#/components/schemas/EventInitiator' + +SessionInfo: + description: The session information related to the notification event. + type: object + properties: + callingIdentity: + $ref: 'TS29562_Nhss_imsSDM.yaml#/components/schemas/ImsPublicId' + calledIdentity: + $ref: 'TS29562_Nhss_imsSDM.yaml#/components/schemas/ImsPublicId' + sessionCase: + $ref: '#/components/schemas/SessionCase' + +MediaInfo: + description: The media information related to the notification event. + type: object + required: + - mediaId + - mediaType + properties: + mediaId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MediaId' + mediaType: + $ref: '#/components/schemas/MediaType' + dcMediaSpec: + $ref: '#/components/schemas/DcMediaSpec' + mediaSuspended: + type: boolean + mediaRemovalInd: + type: boolean + enum: + - true + +DcMediaSpec: + description: > + The data channel media specification information contains media description attributes. + type: object + required: + - streams + - receivedDcEndpoint +``` + +``` +properties: + streams: + description: > + Contains a data channel mapping and configuration information. The streamId + attribute within the DcStream data type is the key of the map. + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DcEndpoint' + minItems: 1 + maxMessageSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MaxMessageSize' + receivedDcEndpoint: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DcEndpoint' + bdcUsedBy: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BdcUsedBy' + appBindingInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AppBindingInfo' + qosHintInfo: + $ref: '#/components/schemas/QosHintInfo' + +QosHintInfo: + description: The QoS hint information used for the media. + type: object + properties: + loss: + description: the maximum desirable end-to-end transport level packet loss rate + type: number + format: zero-based-integer or non-zero-real + localLoss: + description: the maximum desirable end-to-end transport level packet loss rate applied +across the local link + type: number + format: zero-based-integer or non-zero-real + latency: + description: the maximum desirable end-to-end transport level packet latency + type: number + format: zero-based-integer or non-zero-real + localLatency: + description: the maximum desirable end-to-end transport level packet latency applied +across the local link + type: number + format: zero-based-integer or non-zero-real + +# ENUMS + +EventType: + description: The type of the event for which the notification is generated. + anyOf: + - type: string + enum: + - SESSION_ESTABLISHMENT_REQUEST + - SESSION_ESTABLISHMENT_PROGRESS + - SESSION_ESTABLISHMENT_ALERTING + - SESSION_ESTABLISHMENT_SUCCESS + - SESSION_ESTABLISHMENT_FAILURE + - SESSION_ESTABLISHMENT_CANCEL + - MEDIA_CHANGE_REQUEST + - MEDIA_CHANGE_SUCCESS + - MEDIA_CHANGE_FAILURE + - MEDIA_CHANGE_CANCEL + - SESSION_TERMINATION + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + +MediaType: + description: The type of the media for which the notification is generated. + anyOf: + - type: string + enum: + - DC + - AUDIO + - VIDEO + - type: string + description: > +``` + +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +``` +SessionCase: + description: The type of the session case. + anyOf: + - type: string + enum: + - ORIGINATING IMS_SESSION + - TERMINATING IMS_SESSION + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + +EventInitiator: + description: The initiator of the event for which the notification is generated. + anyOf: + - type: string + enum: + - SERVED IMS_SUBSCRIBER + - REMOTE IMS_SUBSCRIBER + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. +``` + +## --- A.3 Nimsas\_MediaControl API + +openapi: 3.0.0 + +``` +info: + title: 'IMS AS MediaControl Service' + version: 1.0.3 + description: | + Nimsas_MediaControl Service. + © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.175 V18.6.0; IP Multimedia Subsystem; IP Multimedia Subsystem (IMS) Application + Server (AS) Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.175' + +servers: +- url: '{apiRoot}/nimsas-mc/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: +- {} +- oAuth2ClientCredentials: + - nimsas-mc + +paths: + +/call-sessions/{sessionId}/media-instruction: + post: + summary: Update + operationId: UpdateCallSession + tags: + - Individual call session (Document) + parameters: + - name: sessionId + in: path + description: Session ID assigned by the IMS AS during the IMS session setup. + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SessionId' + requestBody: +``` + +``` +description: Representation of the updates to apply to the call session. +required: true +content: + application/json: + schema: + $ref: '#/components/schemas/MediaInstructionData' +responses: + '200': + description: > + Successful update of the call session, when the IMS AS needs to return information + in the response. + content: + application/json: + schema: + $ref: '#/components/schemas/MediaInstructionData' + '204': + description: > + Successful update of the call session, when the IMS AS does not need to return + information in the response. + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target IMS AS. + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target IMS AS. + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nimsas-mc: Access to the Nimsas_MediaControl API. +``` + +schemas: + +### # STRUCTURED DATA TYPES + +MediaInstructionData: +description: The media instruction data for a specific session. +type: object +required: +- sessionId +- mediaInstructionSet +properties: +sessionId: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/SessionId' +mediaInstructionSet: +description: > +Contains a set of instructions for each media flow to control. The mediaId +attribute within the MediaInstructions data type is the key of the map. +type: object +additionalProperties: +\$ref: '#/components/schemas/MediaInstructions' +minProperties: 1 + +MediaInstructions: +description: The media instructions for a specific media flow. +type: object +required: +- mediaId +- mediaResourceType +properties: +mediaId: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/MediaIdRm' +mediaResourceType: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/MediaResourceType' +mediaInstruction: +\$ref: '#/components/schemas/MediaInstruction' +dcMediaSpecification: +\$ref: '#/components/schemas/DcMediaSpecification' +arMediaSpecification: +\$ref: '#/components/schemas/ArMediaSpecification' +mediaProcessingUrl: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Uri' +audioVideoReNegotiationInd: +\$ref: '#/components/schemas/AudioVideoReNegotiationInd' + +DcMediaSpecification: +description: The data channel media specification information. +type: object +required: +- streams +- mediaProxyConfig +properties: +mediaProxyConfig: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/MediaProxy' +replaceHttpUrls: +description: > +Contains a list of replacement HTTP URLs. The streamId +attribute within the ReplaceHttpUrl data type is the key of the map. +type: object +additionalProperties: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/ReplaceHttpUrl' +minProperties: 1 +mdc1EndpointDcsf: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/MdcEndpoint' +mdc1EndpointMf: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/MdcEndpoint' +mdc2EndpointInfo: +\$ref: '#/components/schemas/Mdc2EndpointInfo' +streams: +description: > +Contains a data channel mapping and configuration information. The streamId +attribute within the DcStream data type is the key of the map. +type: object +additionalProperties: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/DcStream' +minProperties: 1 +bdcUsedBy: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/BdcUsedBy' + +``` +appBindingInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AppBindingInfo' +qosHintInfo: + $ref: 'TS29175_Nimsas_SessionEventControl.yaml#/components/schemas/QosHintInfo' + +ArMediaSpecification: + description: The AR media specification information. + type: object + required: + - mediaProcessingSpec + properties: + mediaProcessingSpec: + type: string + +Mdc2EndpointInfo: + description: Represents the negotiated MDC2 media endpoint information. + type: object + properties: + mdc2Protocol: + $ref: 'TS29176_Nmf_MRM.yaml#/components/schemas/Mdc2Protocol' + mdc2EndpointDcAs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MdcEndpoint' + mdc2EndpointMf: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MdcEndpoint' + +AudioVideoReNegotiationInd: + description: The audio/video media re-negotiation indication information. + type: object + required: + - reNegotiation + properties: + reNegotiation: + type: boolean + mediaConnSide: + $ref: '#/components/schemas/MediaConnSide' +``` + +### # ENUMS + +``` +MediaInstruction: + description: The media instruction for handling a specific media flow. + anyOf: + - type: string + enum: + - TERMINATE_MEDIA + - ORIGINATE_MEDIA + - TERMINATE_AND_ORIGINATE_MEDIA + - UPDATE_MEDIA + - DELETE_MEDIA + - REJECT_MEDIA + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + +MediaConnSide: + description: The audio or video media connection side. + anyOf: + - type: string + enum: + - BOTH + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. +``` \ No newline at end of file diff --git a/marked/Rel-18/29_series/29303/raw.md b/marked/Rel-18/29_series/29303/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..8213ffa0847cc037207f9baf0517d5df1ea0b3c7 --- /dev/null +++ b/marked/Rel-18/29_series/29303/raw.md @@ -0,0 +1,3883 @@ + + +# 3GPP TS 29.303 V18.0.0 (2024-03) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Domain Name System Procedures; Stage 3; (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|----------------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 7 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions, symbols and abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Abbreviations ..... | 10 | +| 4 General DNS Based Node Selection Description ..... | 10 | +| 4.1 Resource Records..... | 10 | +| 4.1.1 A and AAAA ..... | 10 | +| 4.1.2 NAPTR..... | 10 | +| 4.1.3 SRV ..... | 11 | +| 4.2 Selecting Domain Names..... | 11 | +| 4.3 Identifying Nodes, Services and Protocols ..... | 11 | +| 4.3.1 IETF RFC 3958 Service and Protocol service names for 3GPP ..... | 11 | +| 4.3.2 Identification of canonical node names..... | 11 | +| 4.3.3 Services from node names or other FQDN identifying a service..... | 13 | +| 4.3.3.1 General..... | 13 | +| 4.3.3.2 Procedure ..... | 13 | +| 4.3.3.2.1 S-NAPTR Procedure - General..... | 13 | +| 4.3.3.2.2 S-NAPTR Procedure for a canonical node name..... | 14 | +| 4.3.3.3 Services of a PGW from PGW node name (or collocated PGW/GGSN)..... | 14 | +| 4.3.3.4 Services of a MME from MME node name (or GUTI or 5G-GUTI)..... | 15 | +| 4.3.3.5 Services of an SGSN from a P-TMSI..... | 16 | +| 4.3.3.6 Services of an SGW from SGW canonical node name ..... | 17 | +| 4.3.3.7 Services of an MSC Server from MSC Server canonical node name ..... | 18 | +| 4.3.3.8 Services of an AMF from AMF instance name (or 5G-GUTI) ..... | 18 | +| 4A SGW/PGW selection using GTP-C load control ..... | 19 | +| 4A.1 General ..... | 19 | +| 4A.2 Node-level load control..... | 19 | +| 4A.3 APN-level load control..... | 20 | +| 5 Procedures for EPC Node Discovery and Selection ..... | 21 | +| 5.1 Procedures for Discovering and Selecting a PGW..... | 21 | +| 5.1.1 Discovering a PGW for a 3GPP Access..... | 21 | +| 5.1.1.1 General..... | 21 | +| 5.1.1.2 Discovering a PGW or collocated PGW/GGSN for a 3GPP Access - S8/Gp roaming case existing PDN..... | 23 | +| 5.1.1.3 Discovering a PGW or collocated PGW/GGSN for a 3GPP Access - S5/Gn intra-operator existing PDN..... | 24 | +| 5.1.1.4 Discovering a PGW, collocated PGW/GGSN or GGSN for a 3GPP Access - S5/Gn intra-operator initial attach ..... | 25 | +| 5.1.2 Discovering a PGW for a non-3GPP Access with Network Based Mobility Management..... | 25 | +| 5.1.2.1 Discovering a PGW for a non-3GPP Access – S2a/S2b initial attach for roaming and non-roaming ..... | 25 | +| 5.1.2.2 Discovering a PGW for a non-3GPP Access – S2a/S2b initial attach and chained PMIP-based S8-S2a/S2b..... | 26 | +| 5.1.3 Discovering a PGW for a non-3GPP Access with DSMIPv6 ..... | 26 | +| 5.1.3.1 Discovering a PGW for a non-3GPP Access – S2c initial attach..... | 26 | +| 5.1.4 Discovering a PGW-C/SMF in a PGW-C/SMF Set..... | 27 | +| 5.1.4.1 General..... | 27 | +| 5.1.4.2 Using the PGW Set FQDN ..... | 27 | +| 5.1.4.3 Using Alternative PGW-C/SMF FQDNs ..... | 27 | +| 5.2 Procedures for Discovering and Selecting a SGW..... | 27 | +| 5.2.1 General ..... | 27 | + +| | | | +|----------|----------------------------------------------------------------------------------------------------------------|----| +| 5.2.2 | SGW Selection during TAU or RAU with SGW change - 3GPP roaming case..... | 28 | +| 5.2.3 | SGW Selection during TAU or RAU with SGW change - non-roaming case..... | 29 | +| 5.2.4 | SGW Selection during non-3GPP handover to 3GPP access..... | 30 | +| 5.3 | Procedures for Discovering and Selecting a PGW and SGW ..... | 30 | +| 5.4 | Procedures for Discovering and Selecting an MME ..... | 31 | +| 5.4A | Procedures for Discovering and Selecting an AMF with N26 interface..... | 33 | +| 5.4B | Procedures for Discovering and Selecting an MME_SRVCC..... | 33 | +| 5.5 | Procedures for Discovering and Selecting an SGSN ..... | 34 | +| 5.5.1 | General ..... | 34 | +| 5.5.2 | SGSN initial target selection based on RAI (UTRAN target/GERAN Iu mode target/GERAN Gb mode target)..... | 34 | +| 5.5.3 | SGSN initial target selection based on RNC-ID (UTRAN target/GERAN Iu mode target)..... | 36 | +| 5.5.4 | Void ..... | 37 | +| 5.6 | GW Selection for SIPTO..... | 37 | +| 5.6.1 | SIPTO above RAN ..... | 37 | +| 5.6.2 | SIPTO at the local network with LGW collocated with the (H)(e)NB ..... | 37 | +| 5.6.3 | SIPTO at the local network with stand-alone GW (LGW collocated with SGW) ..... | 37 | +| 5.6.4 | SIPTO for eHRPD ..... | 38 | +| 5.7 | Procedures for Discovering and Selecting an MSC Server..... | 38 | +| 5.7.1 | General ..... | 38 | +| 5.7.2 | Selection of the MSC server enhanced for SRVCC based on target RAI (UTRAN / GERAN Iu & A/Gb mode target) ..... | 38 | +| 5.8 | Procedures to support Dedicated Core Networks ..... | 39 | +| 5.8.1 | General ..... | 39 | +| 5.8.2 | SGW, PGW and GGSN Selection Procedure..... | 39 | +| 5.8.3 | MMEGI and Null-NRI/SGSN Group ID Retrieval Procedure..... | 40 | +| 5.8.4 | MME and SGSN Selection Procedure ..... | 41 | +| 5.8.5 | AMF Selection Procedure ..... | 41 | +| 5.9 | Procedures to support Cellular Internet of Things ..... | 42 | +| 5.9.1 | DCN based solution..... | 42 | +| 5.9.2 | Alternative solution ..... | 42 | +| 5.10 | Procedures for Discovering and Selecting an SGW-U ..... | 42 | +| 5.11 | Procedures for Discovering and Selecting PGW-U ..... | 43 | +| 5.12 | Procedures to select a node supporting a particular network capability ..... | 44 | +| 5.12.1 | General principles..... | 44 | +| 5.12.1.1 | General..... | 44 | +| 5.12.1.2 | Selecting a node supporting a particular network capability within a Dedicated Core Network..... | 45 | +| 5.12.1.3 | Selecting an SGW or PGW supporting a particular network capability..... | 45 | +| 5.12.2 | Procedures to support Dual Connectivity with NR ..... | 46 | +| 5.12.2.1 | General..... | 46 | +| 5.12.3 | Procedures to support interworking with 5GC ..... | 46 | +| 5.12.3.1 | General..... | 46 | +| 5.12.3.2 | PGW-C/SMF selection ..... | 46 | +| 5.12.3.3 | PGW-U/UPF selection..... | 47 | +| 5.12.3.4 | PGW-U/UPF/MB-UPF selection..... | 47 | +| 5.13 | Procedures to support Ethernet PDN Connection in EPS ..... | 47 | +| 5.13.1 | DCN based solution..... | 47 | +| 5.13.2 | Network Capability based solution ..... | 47 | +| 5.13.3 | Alternative solutions..... | 47 | +| 5.14 | Procedures for Discovering and Selecting a UCMF ..... | 48 | +| 6 | Procedures for OAM System Node Discovery ..... | 48 | +| 6.1 | Procedures for Relay Node OAM System Discovery ..... | 48 | +| 6.1.1 | General ..... | 48 | +| 6.1.2 | OAM System Selection based on Type Allocation Code ..... | 48 | +| 7 | Procedures for NF Discovery in 5G System..... | 48 | +| 7.1 | General ..... | 48 | +| 7.2 | Procedure for AMF Discovery by 5G-AN ..... | 49 | + +| | | | +|-------------------------------|----------------------------------------------------------------------------------------------|-----------| +| Annex A (Informative): | Examples ..... | 50 | +| A.1 | Introduction..... | 50 | +| A.2 | Preconditions..... | 50 | +| A.3 | Collocated Simple LTE Example ..... | 51 | +| A.3.1 | Network description ..... | 51 | +| A.3.2 | Master file for "Collocated Simple LTE Example" ..... | 51 | +| A.3.3 | SOA and NS records ..... | 52 | +| A.3.4 | MME file for "Collocated Simple LTE Example" ..... | 52 | +| A.3.5 | APN file for "Collocated Simple LTE Example" ..... | 54 | +| A.3.6 | PGW/SGW node file for "Collocated Simple LTE Example"..... | 55 | +| A.3.7 | TAI/TAC file for "Collocated Simple LTE Example"..... | 56 | +| A.3.8 | MME lookup based on GUTI for "Simple LTE Example"..... | 58 | +| A.3.9 | APN lookup for "Simple LTE Example" (i.e. PGW candidate list) ..... | 60 | +| A.3.10 | TAI lookup for "Simple LTE Example" (i.e. SGW candidate list)..... | 62 | +| A.3.11 | Finding the collocated SGW and PGW together ..... | 63 | +| A.3.12 | S11 lookup by SGW canonical node name..... | 64 | +| A.3.13 | TAI lookup for "Colocation Simple LTE Example" (i.e. MME candidate list) ..... | 65 | +| A.4 | LTE Example with Dedicated Core Network..... | 66 | +| A.4.1 | General ..... | 66 | +| A.4.2 | APN file for DCN ..... | 67 | +| A.4.3 | PGW/SGW node file for "Collocated Simple LTE Example"..... | 67 | +| A.4.4 | TAI/TAC file for DCN..... | 68 | +| Annex B (Normative): | DNS procedures clarifications..... | 70 | +| B.1 | DNS RFC procedures general clarifications..... | 70 | +| B.2 | DNS procedures 3GPP clarifications on S-NAPTR ..... | 70 | +| B.3 | DNS procedures 3GPP clarifications for Dedicated Core Networks..... | 71 | +| B.4 | DNS procedures 3GPP clarifications for Network Capability..... | 71 | +| Annex C (Informative): | DNS Pseudo-Code ..... | 71 | +| C.1 | S-NAPTR procedure base pseudo-code..... | 71 | +| C.2 | S-NAPTR procedure - no topon..... | 73 | +| C.3 | S-NAPTR procedure candidate list..... | 74 | +| C.4 | S-NAPTR procedure pseudo-code with topon..... | 74 | +| Annex D (Informative): | SGSN examples..... | 77 | +| D.1 | Introduction..... | 77 | +| D.2 | Preconditions..... | 77 | +| D.3 | SGSN file ..... | 77 | +| D.4 | Null-NRI/SGSN Group ID file for DCN ..... | 78 | +| Annex E (Informative): | SGW/PGW selection examples using GTP-C load control ..... | 79 | +| E.1 | PGW selection using GTP-C load control at node level..... | 79 | +| E.2 | PGW selection using GTP-C load control at APN level ..... | 79 | +| E.2.1 | PGW selection when APN load control information is available for each candidate PGW..... | 79 | +| E.2.2 | PGW selection when APN load control information is not available for each candidate PGW..... | 80 | + +| | | | +|-------------------------------|--------------------------------------------------------------------------------|-----------| +| Annex F (Informative): | Examples for AMF Discovery by 5G AN ..... | 80 | +| F.1 | Introduction ..... | 80 | +| F.2 | Preconditions..... | 80 | +| F.3 | Example of an AMF Region with 2 AMF Sets..... | 81 | +| F.3.1 | Master file ..... | 81 | +| F.3.2 | SOA and NS records ..... | 81 | +| F.3.3 | AMF Set file..... | 81 | +| Annex G (Informative): | Examples for selecting an alternative PGW-C/SMF in a PGW-C/SMF Set..... | 82 | +| G.1 | Introduction ..... | 82 | +| G.2 | Preconditions..... | 82 | +| G.3 | Example of an PGW-C/SMF Set ..... | 82 | +| G.3.1 | Master file ..... | 82 | +| G.3.2 | SOA and NS records ..... | 82 | +| G.3.3 | PGW-C/SMF Set file ..... | 82 | +| Annex H (Informative): | Change history..... | 84 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document describes Domain Name System (DNS) Procedures for the Evolved Packet System. This document covers the Evolved Packet Core gateway node selection using DNS (e.g. SGW and PGW nodes) excluding all User Equipment (UE) initiated DNS-based discovery and selection procedures. + +The present document specifies functions, procedures and information which apply to GERAN Iu mode. However, functionality related to GERAN Iu mode is neither maintained nor enhanced. + +The present document also describes the Domain Name System (DNS) Procedures for the Evolved Packet System interworking with the 5G System, as specified in 3GPP TS 23.501 [28] and 3GPP TS 23.502 [29]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] IETF RFC 1034: "DOMAIN NAMES - CONCEPTS AND FACILITIES". +- [3] IETF RFC 1035: "DOMAIN NAMES - IMPLEMENTATION AND SPECIFICATION". +- [4] 3GPP TS 23.003: "Numbering, addressing and identification". +- [5] GSMA PRD IR.67: "DNS Guidelines for Operators" Version 2.1.0. +- [6] IETF RFC 3596: "DNS Extensions to Support IP Version 6". +- [7] IETF RFC 3403: " Dynamic Delegation Discovery System (DDDS) Part Three: The Domain Name System (DNS) Database". +- [8] IETF RFC 2782: "A DNS RR for specifying the location of services (DNS SRV)". +- [9] IETF RFC 3958: "Domain-Based Application Service Location Using SRV RRs and the Dynamic Delegation Discovery Service (DDDS)". +- [10] IETF RFC 3401: "Dynamic Delegation Discovery System (DDDS) Part One: The Comprehensive DDDS". +- [11] 3GPP TS 23.401: "GPRS enhancements for E-UTRAN access ". +- [12] 3GPP TS 25.413: "UTRAN Iu interface RANAP signalling". + +- [13] IETF RFC 2671: "Extension Mechanisms for DNS (EDNS0)". +- [14] IETF RFC 3402: "Dynamic Delegation Discovery System (DDDS) Part Two: The Algorithm". +- [15] IETF RFC 2308: "Negative Caching of DNS Queries (DNS NCACHE)". +- [16] IETF RFC 3330: "Special Use IPv4 Addresses". +- [17] IETF RFC 3849: "IPv6 Address Prefix Reserved for Documentation". +- [18] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service Description; Stage 2". +- [19] 3GPP TS 36.413: "Evolved Universal Terrestrial Access Network (E-UTRAN); S1 Application Protocol (S1AP)". +- [20] 3GPP TS 23.216: "Single Radio Voice Call Continuity (SRVCC)". +- [21] 3GPP TS 36.413: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 Application Protocol (S1AP)". +- [22] 3GPP TS 36.300: " Evolved Universal Terrestrial Radio Access (E-UTRA) and Evolved Universal Terrestrial Radio Access Network (E-UTRAN); Overall description; Stage 2". +- [23] 3GPP TS 29.274: "3GPP Evolved Packet System (EPS); Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C); Stage 3". +- [24] 3GPP2 X.S0057-B: "E-UTRAN - eHRPD Connectivity and Interworking: Core Network Aspects". +- [25] 3GPP TS 23.402: "Architecture enhancements for non-3GPP accesses". +- [26] 3GPP TS 29.244: "Interface between the Control Plane and the User Plane of EPC Nodes; stage 3". +- [27] 3GPP TS 29.272: "Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related interfaces based on Diameter protocol". +- [28] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [29] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [30] 3GPP TS 29.273: "Evolved Packet System (EPS); 3GPP EPS AAA interfaces". +- [31] 3GPP TS 23.007: "Restoration procedures". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +Domain Name System as defined in IETF RFC 1034 [2], IETF RFC 1035[3], and as used in 3GPP in 3GPP TS 23.003 [4] and GSMA PRD IR.67 [5] + +The phrase "operators shall provision" in this document is intended to convey what is required to provision in DNS to provide DNS based selection for the corresponding function documented here. If there is a non-DNS procedure in an operator's network for that function then there is no functional requirement for the operator to provision such DNS records. + +The term "S4-SGSN" refers to a Release-8 SGSN that has at least one set of S4/S3/S16 interfaces enabled. + +The term "Release 8 SGSN supporting only Gn/Gp" refers to a Release 8 or later SGSN that either explicitly does not support S4 interfaces or all S4/S3/S16 interfaces are disabled due to operator policy. Such a node cannot use an SGW but can use a collocated PGW/GGSN. See 3GPP TS 23.401 [11] Annex D for use cases. + +The term "Release-8 SGSN" applies to either case. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905[1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|--------------------------------------| +| DCN | Dedicated Core Network | +| DDDS | Dynamic Delegation Discovery Service | +| DNS | Domain Name System | +| ECGI | E-UTRAN Cell Global Identification | +| eHRPD | evolved High Rate Packet Data | +| FQDN | Fully Qualified Domain Name | +| GUTI | Globally Unique Temporary Identity | +| HSGW | eHRPD Serving Gateway | +| LGW | Local Gateway | +| LIPA | Local IP Access | +| NR | New Radio | +| PGW | PDN Gateway | +| RAI | Routing Area Identity | +| SGW | Serving Gateway | +| SIPTO | Selected IP Traffic Offload | +| TAI | Tracking Area Identity | +| TAU | Tracking Area Update | +| TWAN | Trusted WLAN Access Network | + +# --- 4 General DNS Based Node Selection Description + +## 4.1 Resource Records + +### 4.1.1 A and AAAA + +The A resource record is used to define IPv4 host address corresponding to fully qualified name of the host as defined in IETF RFC 1035 [3]. The AAAA resource record is used to define IPv6 host address corresponding to fully qualified name of the host as defined in IETF RFC 3596 [6]. + +It should be noted that in DNS A or AAAA record names, in general, represent a host and its "equivalent" interface. Host names, in general, cannot be used as node names. A node may need to have more than one host name for the simple reason that it can have multiple interfaces for different purposes. + +### 4.1.2 NAPTR + +The NAPTR resource record is defined in IETF RFC 3403 [7] and is a powerful tool that allows DNS to be used to lookup services for a wide variety of resource names, which are not in domain name syntax. NAPTR would be used by a client program to rewrite a string into a domain name. The rewrite process is controlled by flags that provide information on how to communicate with the host at the domain name that was the result of the rewrite. If DNS returns multiple NAPTR resource records those can be prioritized using embedded order and preference values defined by the DNS administrator. + +The S-NAPTR procedure i.e., the "Straightforward-NAPTR" procedure, is defined in IETF RFC 3958 [9] and describes a Dynamic Delegation Discovery System (DDDS) [10] application procedures on how to resolve a domain name, application service name, and application protocol dynamically to target server and port by using both NAPTR and + +SRV (see IETF RFC 2782 [8]) resource records. The S-NAPTR also simplifies the use of NAPTR by limiting the NAPTR flags only to "a", "s" and "". Furthermore, only NAPTR "replacement" expressions are allowed, not "regular expressions", during the rewrite process. The changes compared to IETF RFC 3403 [7] NAPTR usage are procedural and are limited only to the resolver. The S-NAPTR use of the NAPTR resource record is exactly the same as defined in IETF RFC 3403 [7] from the DNS server and DNS infrastructure point of view. Additional information on S-NAPTR usage is provided in Annex B and Annex C. + +The NAPTR resource record flags "s" and "" allow another layer of indirection in the DNS configuration. The "" flag causes the S-NAPTR procedure to query for new NAPTR resource records from the DNS infrastructure. The "s" flag causes the S-NAPTR procedure to query for an intermediary SRV resource record pointing to A/AAAA resource records. This additional query provides a selection mechanism by which the operator is able to assign different weights to different A/AAAA resource records while larger weights are given a proportionately higher probability of being selected. A DNS server might provide the A/AAAA records together with the SRV resource records as per IETF RFC 2782 [7]. The length of the NAPTR resource record indirection chain enabled using the "" flag is unbounded and may lead to a deep chaining of resource records over time in the DNS configuration. Additional layer of indirection and possible deep chaining both grows the DNS configuration significantly in size and complexity, and also makes the configuration prone to hard to trace errors. The use of NAPTR resource record "" flag pointing to other NAPTR resource records with flag "" is strongly discouraged. Specifically, NAPTR resource flag "" should only be provisioned to point to terminal NAPTR records (i.e., flag "a" or flag "s"). Generally, the use of flag "a" or of flag "s" is encouraged. + +### 4.1.3 SRV + +The SRV resource record is defined in IETF RFC 2782 [8] and allows DNS administrators to use pool of servers for a single domain with static load balancing to each server, to move services from host to host, and to designate some hosts as primary servers for a service from a pool of hosts. A resolver can ask for a specific service/protocol combination for a specific domain name and get back a Fully Qualified Domain Names (FQDN) of any available servers. + +## 4.2 Selecting Domain Names + +When using the S-NAPTR procedure under the DDDS framework, it becomes essential which domain name gets used for querying the actual NAPTR records. In the S-NAPTR procedure, the Application-Unique String used by the DDDS algorithm is the starting domain name for which the information of the services, protocols and actual canonical node names are sought. Related to the Application-Unique String, the First well-Known Rule of the DDDS algorithm in the S-NAPTR procedure outputs the same domain name that constitutes the Application-Unique String. For each node type in EPC that can be queried for information using the S-NAPTR procedure, the authoritative DNS server for the given domain should be provisioned with unique domain name for each EPC node or other identifier that is explicitly specified by a procedure in this specification (for example one based on APN, TAI, GUTI, etc) and corresponding NAPTR records. The authoritative DNS server for a given domain shall provision at least the EPC node names that may be exposed to the inter-operator roaming interfaces. + +## 4.3 Identifying Nodes, Services and Protocols + +### 4.3.1 IETF RFC 3958 Service and Protocol service names for 3GPP + +Service and protocol service names for the S-NAPTR procedure shall be used in accordance with 3GPP TS 23.003 [4], clause 19.4.3. + +### 4.3.2 Identification of canonical node names + +There are many use cases where it is desirable to select a collocated node in preference to a non-collocated node, or a topologically closer (with respect to the network topology) node in preference to a less topologically closer node. To easily do this action a "canonical" node name shall be employed so that the "canonical" node names from two or more sets of records can be compared to see if nodes are actually the same nodes, or topologically closer nodes. + +In DNS neither A or AAAA host names, in general, represent a node name, but rather a set of "equivalent" interfaces. A node may need to have more than one host name for the simple reason that it can have different interfaces for different purposes. For example, a node can have a set of roaming interfaces on a completely different network than the internal + +network due to security needs. Hence, there are always situations where multiple A/AAAA record sets must exist that implies multiple distinct host names. Therefore, host names, in general, cannot be used as node names. + +Instead of creating new DNS records to map a host name to a node name this specification defines how host names shall be constructed and used in S-NAPTR procedure within 3GPP EPC. + +The host names shall have form: + +<"topon" | "topoff"> . . + +Where the first label is "topon" or "topoff" to indicate whether or not collocated and topologically close node selection shall be preferred, "single-label-interface-name" is a single label used to name a specific interface on a node (e.g. Eth-0, S8, vip, board3), "canonical-node-name" is the canonical node name of a specific node. A node shall have exactly one canonical node name so a host name always includes the unique canonical node name of the node. Hence, when comparing the host name FQDNs to find out whether the nodes are actually the same, the first two labels of the host name FQDN shall be ignored. + +NOTE 1: The canonical node name is not related to canonical name in the CNAME DNS record. + +When using host names with "topon" as the first label the canonical node names of nodes shall be hierarchically structured to allow an operator to reflect the topological closeness of two nodes by naming the nodes with canonical node names sharing a common suffix domain name. The number of labels in the common suffix shall represent how close the operator considers them during node selection. The higher the number of labels in the common suffix is, the closer the nodes are. In other words, two topologically closest nodes are those with the longest matching suffix in their respective canonical node names. + +The following list contains examples of domain names where canonical node names are in bold: + +topon.Eth-0.gw32.california.west. **example.com** + +topon.S8.gw32.california.west. **example.com** + +topon.vip.gw3.oregon.west. **example.com m** + +topon.board3.pgw1.cluster1.net27. **example.net** + +topon.S5.gw4.cluster1.net27. **example.net** + +topon.board3.pgw1.cluster2.net27. **example.net** + +In the examples above, "Eth-0.gw32.california.west.example.com" and "S8.gw32.california.west.example.com" are two different interfaces on the same node, "gw32.california.west.example.com". On the other hand, "gw4.cluster1.net27.example.net" is topologically closer to "pgw1.cluster1.net27.example.net" (they are both connected to the "cluster1.net27.example.net" subnetwork) than to "pgw1.cluster2.net27.example.net" (only connected to the wider "net27.example.net" subnetwork.) + +Interface names and node names do NOT identify a function in the procedures here. The interface is part of the natural hierarchy within a node and the host name is already returned with the existing DNS records. The approach of identifying a canonical node name from a host name is believed to be simpler and more logical to maintain than creating additional DNS records simply to return a node name. + +The topologically aware naming restriction (i.e. the format above using "topon" or "topoff") shall be placed only on all targets/replacements pointing logically to a A/AAAA record sets from the S-NAPTR procedure. These targets/replacements are denoted host names here (following the normal DNS terminology unless a CNAME is used to point to the actual A or AAAA record). This restriction shall NOT apply to any other DNS records the operator may be using. + +Specifically, a NAPTR with flag "a" will have a replacement target pointing to the A/AAAA record directly, thus the topologically aware naming restriction on the host name applies to the replacement in the NAPTR record with a flag "a". For the NAPTR flag "s" case the topologically aware naming restriction on the host name applies to the target in the SRV record, and not the NAPTR record replacement. For the NAPTR empty flag "" case the topologically aware naming does not apply any restriction since this is not a host name. Other flags are not used in S-NAPTR. + +During DNS provisioning for the S-NAPTR procedure the operator is free to add another layer of indirection using a CNAME record (see clause 6.6.2 of IETF RFC 1034 [2]). + +While operators shall provision host names in DNS according to the above rules, it is still possible that the host name might be incorrectly configured (i.e. not conforming to the above format with first label of "topon" or "topoff"). For such misconfigured records implementations shall treat the misconfigured host name as valid within the S-NAPTR procedure where that host name was found, but may favor correctly configured records. Misconfigured host name for topological matching and colocation checks shall be treated as if the misconfigured host name had the label "topoff." prepended. Operators shall not depend on this behavior. + +The order of using DNS records to contact a node is based on following ordering. When collocation of a pair of node types is explicitly stated as applicable in a procedure, collocation of the nodes shall have highest importance. When topological matching is explicitly stated as applicable in a procedure then topological matching with "topon", is of second highest importance. Then finally the ordering obtained by the S-NAPTR output. When collocation and topological ordering applies, collocated sets of nodes have highest importance, then sets of nodes with "topon" and the most labels in their common suffix, then sets of nodes with "topon" and second most number of labels and so on until we reach non-collocated nodes with "topoff" and within sets with same colocation or topological order then S-NAPTR order of one of the two nodes is used (specified in the specific procedure). Additional informative clarifications on how S-NAPTR is employed in the context of 3GPP EPC node usage and specifically how topological matching using the "topon" label interacts with S-NAPTR ordering is provided in Annex C.4. + +### 4.3.3 Services from node names or other FQDN identifying a service + +#### 4.3.3.1 General + +There are potential use cases where a node has a logical name of a peer or other FQDN identifier for a service but does not have the protocols it supports. The NAPTR record for any of the services can be provisioned at the nodes logical name or other FQDN identifier for a service. The node logical name or other FQDN identifier for a service is equal to the domain name under which NAPTR records are provisioned. This allows any core network node to discover the available services based on node's logical name or other FQDN identifier for a service. + +#### 4.3.3.2 Procedure + +##### 4.3.3.2.1 S-NAPTR Procedure - General + +These procedures are employed when any core network node has the FQDN of an entity and needs to find one or more services at that entity. + +**NOTE:** There are three likely sources of the entity name. O&M provisioned, 3GPP specified based on some other identifier of a service (such as GUTI, TAC, IMSI, MISDN etc.), or the canonical node name obtained from a previous S-NAPTR procedure. Note that a node can have more than one name, i.e. an alias, but there shall be only one canonical node name for a node. (CNAME records are a way to create aliases for the canonical node name or any other FQDN as per IETF RFC 1034 [2]) + +The S-NAPTR procedure requires that DNS NAPTR records shall be consistently provisioned as described in IETF RFC 3958 [9]. This means a NAPTR record for each protocol using "a" flag and the service field populated with the service and proto value may be provisioned. If a more sophisticated load balancing or non-standard ports are desired, NAPTR with "s" flag for each protocol and the corresponding SRV records with relative weighting for each interface need to be provisioned. NAPTR records with empty "" flag records may also be used. + +A DNS resolver that intends to use the S-NAPTR procedure shall use the FQDN of the node or a specified FQDN identifier of a service as the Application-Unique String. If all protocols are desired, then the resolver simply runs the S-NAPTR procedure as if all protocols match. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This list can be obtained one host name at a time, in a procedure similar to Annex C.2, or a complete ordered list of all nodes, in a procedure similar to Annex C.3. Such a complete list obtained from an S-NAPTR procedure is referred here as a candidate list. + +**NOTE:** The candidate list is valid for at most for finite period of time due to DNS time to live and order of the records can change due to statistical selection. Operators should provision records with reasonable time to live values. + +##### 4.3.3.2.2 S-NAPTR Procedure for a canonical node name + +One very important special case is S-NAPTR based on a node's canonical node name. + +Operators shall provision NAPTR records for all enabled interfaces of a node that are explicitly listed in clause 19.4.3 of 3GPP TS 23.003 [4] at the FQDN of the node's unique canonical node name. + +NOTE 1: Exception to this rule: The NAPTR records for x-3gpp-mme: x-s1-mme and x-3gpp-sgw: x-s1-u from clause 19.4.3 of 3GPP TS 23.003 [4] are to be considered entirely optional in this release of 3GPP. + +With such provisioning by an operator a DNS resolver can at any time use the S-NAPTR procedure with a valid canonical node name to find all interfaces and protocols supported by that node that are listed in clause 19.4.3 of 3GPP TS 23.003 [4]. This includes interfaces of co-located functions that might not be easily discovered by other means. + +NOTE 2: The remaining clauses within clause 4.3.3 cover cases where the FQDN used for the Application-Unique String is known to correspond to the resource of exactly one node and are relatively simple. These include the cases where an explicit identifier is defined by 3GPP for S-NAPTR lookup and examples of S-NAPTR based on canonical node names (the later is not intended to be an exhaustive list of examples). More complicated cases that cover identifiers for multiple nodes are covered in other clauses. + +#### 4.3.3.3 Services of a PGW from PGW node name (or collocated PGW/GGSN) + +A UE with both a 3GPP access capability and non-3GPP access capability can roam in and out of the 3GPP network while maintaining the same PDN connection. + +To support roaming to or from a non-3GPP network the HSS (or AAA) server can have an FQDN of a particular PGW or collocated PGW/GGSN node. One reason for using an FQDN instead of an IP address is that a PGW can be multihomed (i.e. more than one IP address). Another possible use case is when the PGW interface needs to be changed between PMIP and GTP. Even if each interface type only uses one IP address, the different interfaces can still use different IP addresses. For example, roaming and non-roaming interfaces are likely to be separated from each other using firewall or other mechanisms. Another possible use case is when the Home Agent (HA) functionality of a particular PGW needs to be discovered, e.g., during the HA reallocation procedure. + +If the PGW node name employed by the operator is the PGW canonical node name then see clause 4.3.3.2 for provisioning. + +If the PGW node name employed by the operator is not the PGW canonical node name then the operators shall provision at least the NAPTR records for S5 and S8 interfaces of a PGW node (see clause 19.4.3 of 3GPP TS 23.003 [4]) at that PGW node name. If the GGSN function is co-located then the NAPTR records for the Gn/Gp interfaces of the collocated PGW/GGSN shall be included as well. Only interfaces that exist and are allowed by the operator policy need be included. + +NOTE 1: The PGW node name in HSS/AAA may or may not be the PGW's canonical node name if the PGW's FQDN was placed in the HSS/AAA from a non-3GPP source. + +To resolve the allowed PMIPv6 interfaces the S-NAPTR procedure shall be used with the "Service Parameters" of + +"x-3gpp-pgw:x-s5-pmip" , "x-3gpp-pgw:x-s8-pmip" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the FQDN of the PGW or collocated PGW/GGSN node. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This list can be obtained one host name at a time, in a procedure similar to Annex C.2, or a complete ordered list of all nodes, in a procedure similar to Annex C.3. Such a complete list obtained from an S-NAPTR procedure is referred here as a candidate list. + +For a more explicit example, an operator might provision a PGW name at: + +gw1.pgw.node.epc.mnc.mcc.3gppnetwork.org + +Similarly for the GTPv2 interfaces the S-NAPTR procedure shall use "Service Parameters" of + +"x-3gpp-pgw:x-s5-gtp" , "x-3gpp-pgw:x-s8-gtp" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the FQDN of the specific PGW or collocated PGW/GGSN node. + +Similarly for the GTPv1 Gn/Gp interfaces the S-NAPTR procedure shall use "Service Parameters" of + +"x-3gpp-pgw:x-gn", "x-3gpp-pgw:x-gp" "x-3gpp-ggsn:x-gn", "x-3gpp-ggsn:x-gp" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the FQDN of the specific PGW, collocated PGW/GGSN node. The "Service Parameters" of "x-3gpp-pgw:x-gn", "x-3gpp-pgw:x-gp" represent collocated PGW/GGSN nodes and "x-3gpp-ggsn:x-gn", "x-3gpp-ggsn:x-gp" represent a GGSN that does not have a PGW co-located. + +Similarly for the Home Agent functionality of a PGW the S-NAPTR procedure shall use "Service Parameters" of + +"x-3gpp-pgw:x-s2c-dsmip" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the FQDN of the specific PGW. + +Similarly for the S2a interface the S-NAPTR procedure shall use "Service Parameters" of + +"x-3gpp-pgw:x-s2a-pmip", "x-3gpp-pgw:x-s2a-gtp" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the FQDN of the specific PGW. + +Similarly for the S2b interface the S-NAPTR procedure shall use "Service Parameters" of + +"x-3gpp-pgw:x-s2b-pmip", "x-3gpp-pgw:x-s2b-gtp" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the FQDN of the specific PGW. + +Additional requirements to support DCN are specified in clause 5.8. It is also possible for the DNS resolver to leave "Service Parameters" unspecified in the S-NAPTR procedure in order to identify all interfaces for all supported services and protocols. + +NOTE 2: The services based on S-NAPTR at the canonical node name of the PGW might return services other than ones starting with x-3gpp-pgw or x-3gpp-ggsn since the PGW node can have a co-located SGW function or other functions. + +#### 4.3.3.4 Services of a MME from MME node name (or GUTI or 5G-GUTI) + +There are procedures when: + +- the old MME must be contacted by the new AMF, MME or S4 SGSN (a Release-8 SGSN supporting only Gn/Gp may also optionally use this procedure); +- the old AMF must be contacted by the new MME. + +The primary use case is context transfer. + +The 3GPP defined MME node FQDN shall be constructed as defined in clause 19.4.2.4 of 3GPP TS 23.003 [4] where the needed data can be obtained from the UE's old GUTI (or mapped from old P-TMSI and old RAI see clause 4.3.3.5 for more details, or mapped from the 5G-GUTI). The 3GPP defined MME node FQDN is either the canonical node name itself or an alias of the MME's canonical node name (the operator is free to choose the canonical node name). + +If the MME node name employed by the operator is the 3GPP defined MME node FQDN then see clause 4.3.3.2 for provisioning. + +If the MME node name employed by the operator is the 3GPP defined MME node FQDN, the operator shall provision NAPTR records under the 3GPP defined MME node FQDN for at least "x-3gpp-mme:x-s10", "x-3gpp-mme:x-s3" if S3/S4 GERAN/UTRAN is supported, and "x-3gpp-mme:x-gn" or "x-3gpp-mme:x-gp" if Gn/Gp is supported. + +So, for example, for an MME or AMF to find all S10 interfaces of an MME based on the old GUTI or 5G-GUTI, the S-NAPTR procedure shall be prefixed with "Service Parameters" of + +"x-3gpp-mme:x-s10" + +and set the Application-Unique String to the FQDN as defined in clause 19.4.2.4 of 3GPP TS 23.003 [4], with the initial query targeted at 3GPP defined MME node FQDN. + +Similarly, for example, for an MME to find all N26 interfaces of an AMF based on the old GUTI, the S-NAPTR procedure shall be prefixed with "Service Parameters" of + +"x-3gpp-mme:x-s10" + +and set the Application-Unique String to the FQDN as defined in clause 19.4.2.4 of 3GPP TS 23.003 [4], with the initial query targeted at 3GPP defined MME node FQDN. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This list can be obtained one host name at a time, in a procedure similar to Annex C.2, or a complete ordered list of all nodes, in a procedure similar to Annex C.3. Such a complete list obtained from an S-NAPTR procedure is referred here as a candidate list. + +Similarly, for an S4-SGSN to find all S3 interfaces of an MME based on the old GUTI it would use a "Service Parameter" of "x-3gpp-mme:x-s3". + +Similarly, for a Release 8 Gn/Gp-SGSN to find all Gn and Gp interfaces of an MME based on the old GUTI it would use a "Service Parameter" of "x-3gpp-mme:x-gn", "x-3gpp-mme:x-gp". + +To find all MME related services of an MME based on the MME's canonical node name, the S-NAPTR procedure shall be prefixed with "Service Parameters" of + +"x-3gpp-mme:x-s10", "x-3gpp-mme:x-s3", "x-3gpp-mme:x-s11", "x-3gpp-mme:x-gn", "x-3gpp-mme:x-gp", + +and set the Application-Unique String to the MME's canonical node name. + +It is also possible for the DNS resolver to use only the interfaces it is interested in or leave "Service Parameters" unspecified in the S-NAPTR procedure in order to identify all interfaces for all supported services and protocols. + +NOTE 1: The services based on MME canonical node name can return services not starting with x-3gpp-mme since the MME node might, for example, have a co-located SGSN. + +NOTE 2: The above procedures for discovering and selecting an AMF are identical to the procedures specified for discovering and selecting an MME; they can be used by MMEs not upgraded to support the procedure specified in clause 4.3.3.8. In this case, AMFs are provisioned in DNS as MMEs, following the mapping rules specified for EPS interworking with 5GS in clause 2.10.2 of 3GPP TS 23.003 [4], and the code space between AMF Region ID and MMEGI needs to be coordinated. + +#### 4.3.3.5 Services of an SGSN from a P-TMSI + +There are procedures where the source SGSN must be contacted by the target MME or a target S4-SGSN. A Release 8 SGSN supporting only Gn/Gp may also optionally use this procedure. + +During a mobility procedure towards a new core network node, a UE served by a SGSN has a previously assigned P-TMSI by the source SGSN. A pre-Release-8 UE will provide the P-TMSI. A Release-8 UE will map P-TMSI to a derived GUTI using the procedure in 3GPP TS 23.003 [4] clause 2.8.2 and referred to in Annex H of 3GPP TS 23.401 [11]. + +The target MME or a target S4-SGSN extracts the source's NRI, RAC, LAC, MNC and MCC from the P-TMSI (or GUTI based on the procedure described in 3GPP TS 23.003 [4] clause 2.8.2). + +The FQDN based on NRI, RAC, LAC, MNC and MCC as defined in 3GPP TS 23.003 [4] clause 19.4.2.6 is denoted in this specification as the NRI-RAI FQDN. + +If the SGSN canonical node name employed by the operator is the NRI-RAI FQDN then see clause 4.3.3.2 for provisioning. + +If the 3GPP defined NRI-RAI FQDN is not employed by an operator as the SGSN's canonical node name then the operator shall provision NAPTR records under the NRI-RAI FQDN with at least "x-3gpp-sgsn:x-s3", "x-3gpp-sgsn:x- + +s4", "x-3gpp-sgsn:x-s16" (assuming the SGSN supports S3/S4/S16 GERAN/U-TRAN) and at least "x-3gpp-sgsn:x-gn", "x-3gpp-sgsn:x-gp" (assuming the SGSN supports legacy Gn/Gp). + +The S-NAPTR procedure for finding the old SGSN services and interfaces from the P-TMSI is started with "Service Parameters" of + +"x-3gpp-sgsn:x-gn", "x-3gpp-sgsn:x-gp", "x-3gpp-sgsn:x-s3", "x-3gpp-sgsn:x-s16" + +as defined in 3GPP TS 23.003 [4] and setting the Application-Unique String to the NRI-RAI FQDN based on NRI, RAC, LAC, MNC and MCC as defined in 3GPP TS 23.003 [4] clause 19.4.2.6: + +NOTE 1: In the event a valid NRI is not available then the value shall be excluded from the FQDN. The default SGSN in the SGSN pool shall be provisioned under that record (or the sole SGSN if there is no SGSN pool for that RAI). + +NOTE 2: Service Parameters are logically limited to those supported by the target node that is performing the search for the source SGSN. So for example, a target Release-8 SGSN supporting only Gn/Gp would employ "x-3gpp-sgsn:x-gn" and "x-3gpp-sgsn:x-gp". An S4-SGSN only supporting S4/S3/S16 would employ "x-3gpp-sgsn:x-s3", "x-3gpp-sgsn:x-s16". A target MME would employ "x-3gpp-sgsn:x-s3" and may additionally include "x-3gpp-sgsn:x-gn" and "x-3gpp-sgsn:x-gp", to support the procedures in Annex D of 3GPP TS 23.401 [11]. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This list can be obtained one host name at a time, in a procedure similar to Annex C.2, or a complete ordered list of all nodes, in a procedure similar to Annex C.3. Such a complete list obtained from an S-NAPTR procedure is referred here as a candidate list. + +NOTE 3: The services based on canonical node name can return services not starting with x-3gpp-sgsn since the SGSN node might, for example, have a co-located MME. + +For a pre-Release-8 target node i.e. a UE moving from eUTRAN to pre-Release-8 UTRAN/GERAN the UE will provide a derived P-TMSI based on a GUTI (See Annex H of 3GPP TS 23.401 [11]). As a result the source MME or Release-8 SGSN looks like a pre-Release-8 SGSN to a pre-Release-8 target node. For pre-Release-8 compatibility operators would continue to provision A/AAAA records as described in Annex C.1 of 3GPP TS 23.003 [4] for the corresponding Gn/Gp interfaces regardless of whether the source SGSN is pre-Release-8 or not. + +NOTE 4: Gn/Gp interfaces are provisioned redundantly for both ".gprs" and ".3gppnetwork.org" top level domains during the transition to Release-8 to allow a gradual forward migration to 3gppnetwork.org while still supporting existing pre-Release-8 usage. + +#### 4.3.3.6 Services of an SGW from SGW canonical node name + +An MME or S4-SGSN may need to find SGW interfaces on a SGW based solely on SGW's canonical node name. The most common use cases are: + +- An MME finding an S11 interface from an SGW node name where the SGW node name was determined from an S5/S8 interface selection based on TAI/eNodeB-ID (see clause 5.2). +- An S4-SGSN finding an S4 interface from an SGW node name where the SGW node name was determined from an S5/S8 interface selection based on RAI/RNC-ID (see clause 5.2). +- Finding if an SGW node has PGW interfaces from an SGW node name (both SGW and PGW functions would be listed under one canonical node name for co-located PGW/SGW). + +See clause 4.3.3.2 for DNS provisioning of the canonical node name records. + +For LTE initial attach cases, the S11 interface is initially unknown by an MME. The S5/S8 interface and the SGW hostname will be selected by procedures in clause 5. The MME will obtain SGW S11 interfaces from the SGW canonical node name. The S-NAPTR procedure shall use "Service Parameter" of + +"x-3gpp-sgw:x-s11" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the canonical node name of the specific SGW node to find the available S11 interfaces + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This is a "candidate" list of services and interfaces of that SGW (see Annex C.2 for a more detailed description of a candidate list). + +For example, an operator might provision an SGW name at: + +gw21.sgw.node.epc.mnc.mcc.3gppnetwork.org + +Similarly, for GERAN/UTRAN initial attach cases the S4-SGSN will need to obtain the SGW S4 interface after procedures in clause 5 select the S5/S8 interface and SGW hostname. The only change from the MME case is the "Service Parameter" of + +"x-3gpp-sgw:x-s4" + +is employed. + +In cases where a new PDN connection is added to an existing SGW the available SGW S5/S8 interfaces are commonly needed. + +To resolve the allowed SGW PMIPv6 interfaces the S-NAPTR procedure shall be used with the "Service Parameters" of + +"x-3gpp-sgw:x-s5-pmip", "x-3gpp-sgw:x-s8-pmip" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the canonical node name of the specific SGW node + +Similarly for the S5/S8 GTP interfaces the S-NAPTR procedure shall use "Service Parameters" of + +"x-3gpp-sgw:x-s5-gtp", "x-3gpp-sgw:x-s8-gtp" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the FQDN of the specific SGW node. + +Additional requirements to support DCN are specified in clause 5.8. + +It is also possible to combine the "Service Parameters" in the S-NAPTR or to leave "Service Parameters" as logically unspecified initially in the S-NAPTR procedure in order to identify all interfaces for all 3GPP TS 29.303 supported protocols of the node. + +NOTE 1: The services based on canonical node name can return services not starting with x-3gpp-sgw since the SGW node might, for example, have a co-located PGW. + +#### 4.3.3.7 Services of an MSC Server from MSC Server canonical node name + +During the SRVCC operations (see 3GPP TS 23.216 [20]), an MME or an SGSN may need to find the MSC Server Sv interface based on MSC Server canonical node name. The most common use cases are: + +- An MME or an SGSN finding the Sv interface from an MSC Server node name, where the MSC server node name was determined from the Sv interface selection based on the Target RAI. + +See clause 4.3.3.2 for DNS provisioning of the canonical node name records. + +To find the MSC server services under the MSC server node name, the operator shall at least provision the "Service Parameter" of + +"x-3gpp-msc:x-sv" + +#### 4.3.3.8 Services of an AMF from AMF instance name (or 5G-GUTI) + +During a 5GS to EPS Idle mode mobility using N26 interface (see clause 4.11.1.3.2 of 3GPP TS 23.502 [29]), the MME needs to contact the old AMF for contexts transfer. + +The 3GPP defined AMF instance FQDN shall be constructed as defined in clause 28.3.2.8 of 3GPP TS 23.003 [4] where the needed data can be obtained from the UE's old GUTI (mapped from the 5G-GUTI). The 3GPP defined AMF + +instance FQDN is either the canonical node name itself or an alias of the AMF's canonical node name (the operator is free to choose the canonical node name). + +If the AMF node name employed by the operator is the 3GPP defined AMF instance FQDN then see clause 4.3.3.2 for provisioning. + +If the AMF node name employed by the operator is the 3GPP defined AMF instance FQDN, the operator shall provision NAPTR records under the 3GPP defined AMF instance FQDN for "x-3gpp-amf:x-n26". + +So, for example, for an MME to find all N26 interfaces of an AMF based on the old GUTI, the S-NAPTR procedure shall be prefixed with "Service Parameters" of + +"x-3gpp-amf:x-n26" + +and set the Application-Unique String to the FQDN as defined in clause 28.3.2.8 of 3GPP TS 23.003 [4], with the initial query targeted at 3GPP defined AMF instance FQDN. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This list can be obtained one host name at a time, in a procedure similar to Annex C.2, or a complete ordered list of all nodes, in a procedure similar to Annex C.3. Such a complete list obtained from an S-NAPTR procedure is referred here as a candidate list. + +NOTE: The above procedure avoids the need for code space coordination between AMF Region ID and MMEGI for EPS interworking with 5GS, i.e. the full address space of the AMF Region ID can be used for 5GS. + +# --- 4A SGW/PGW selection using GTP-C load control + +## 4A.1 General + +The nodes responsible for the SGW or PGW selection (i.e. the MME, S4-SGSN, TWAN or ePDG) shall apply the additions specified in this clause, if GTP-C load control is supported and enabled (see clause 12.2 of 3GPP TS 29.274 [23]). + +GTP-C load control allows for the advertising of load information at node level (i.e. the SGW or PGW load) or at APN level (for a PGW only) and selecting the target node (i.e. the SGW or PGW) based on this information. + +The nodes responsible for the SGW or PGW selection shall take into account the load control information reported via GTP-C signalling and shall implement a SGW or PGW selection logic according to the principles specified in the following clauses. + +NOTE: The exact algorithm used at the node performing the SGW or PGW selection, as per the aforementioned requirements, is implementation specific. + +## 4A.2 Node-level load control + +This clause specifies the extensions to the SGW or PGW selection procedures which shall be supported when GTP-C load control is supported and enabled at node level. + +The node level load information consists of the "Load Metric" of the target node, i.e. the SGW or PGW, representing the current utilization of the resources as compared to the overall available resources at the target node. + +Using the DNS based procedures specified in this document, the node performing the SGW or PGW selection (i.e. the MME, S4-SGSN, ePDG or TWAN), referred to as "selecting node" hereafter, shall prepare the candidate list of the target nodes satisfying the required criteria to serve the new session request. + +The criteria for ordering the candidate list of target nodes shall be as specified in clause 4.3.2, i.e. giving priority to collocation when applicable, then to topological matching when applicable, then to the ordering obtained by the S-NAPTR output and then to the ordering obtained by the priority in the SRV records (when SRV records are used). However, the selecting node may select a candidate target node with a lower relative order if all the candidate target nodes with a higher relative order are not available, e.g. when they have reported a Load-Metric=100. + +Then within sets of available candidates with the same relative order (e.g. with the same topological order or with the same NAPTR order field) and with the same priority in SRV records (when SRV records are used), further called the "TNodeList" for the list of candidate target nodes "TNode", the node performing the SGW or PGW selection shall use the "Load Metric" and, if available (i.e. when SRV records are used), the DNS-weight-factor of each candidate target node to perform the node selection as indicated below: + +- 1) The selecting node shall calculate the effective available load of each candidate target nodes, considering the current available load and the DNS weight-factor of the target node as follows: + +$$\text{TNode-effective-available-load} = (100 - \text{TNode-load-metric})\% \times \text{TNode-weight-factor}$$ + +- 2) The selecting node shall then calculate the relative available load of each candidate target node, representing the effective-available-load of the target node, as compared to the effective-available-load of all the other candidate target nodes as follows: + +$$\text{TNode-relative-available-load} = (\text{TNode-effective-available-load} / \text{sum-of-effective-available-load-of-all-the-nodes-in-TNodeList}) \times 100\%$$ + +- 3) The selecting node shall then select the SGW or PGW for new session requests according to the TNode-relative-available-load of each target candidate node, e.g. a TNode-relative-available-load value of X% indicates that the corresponding target node should be selected for X% of the new sessions requests. + +The selecting node shall assume the following in the calculations above: + +- The selecting node shall assume the TNode-load-metric=0 for a candidate target node for which no node level load-metric is available (e.g. due to the load control feature being not supported between two PLMNs and that the PGW and the MME are from different PLMNs); +- The selecting node shall compute the TNode-weight-factor as (65535-NAPTR preference), as per Annex B.2, for each candidate target node if no SRV weight factor is received from the DNS, i.e. when only NAPTR records with the "a" flag are provisioned. + +Annex E.1 provides an example illustrating these principles. + +When using GTP-C load control, the DNS should not be provisioned with a mix of NAPTR records with an "s" flag and with an "a" flag for a given FQDN. + +- NOTE: It is not possible to directly compare the TNode-weight-factor used with SRV records with the TNode-weight-factor used when there is no SRV record. It is implementation specific how to distribute the load among candidate SGW or PGWs if the DNS is provisioned with a mix of NAPTR records with an "s" flag and with an "a" flag. + +## 4A.3 APN-level load control + +This clause specifies the extensions to the PGW selection procedures which shall be supported when GTP-C load control is supported and enabled at node level and APN level. + +A PGW may report the following APN load control information for a given APN via GTP-C signalling (see clause 12.2.4 of 3GPP TS 29.274 [23]): + +- APN-Load-Metric: this indicates the current resource utilization for a particular APN, as a percentage, compared to the total resources reserved for that APN at the target PGW; and +- APN-relative-capacity: this indicates the total resources configured for a given APN, compared to the total resources of the target PGW, as a percentage. It is a static parameter and does not change unless the resources configured for the APN change. + +The selecting node shall calculate the TNode APN weight factor of each candidate target node, considering the TNode APN relative capacity and the TNode weight factor as follows: + +$$\text{TNode-APN-weight-factor} = \text{TNode-weight-factor} \times \text{TNode-APN-relative-capacity}.$$ + +The node performing the PGW selection shall then apply the principles and assumption specified in clause 4A.1 with the following additions or modifications: + +- the selecting node shall substitute node level (TNode-"X") parameters with their corresponding APN level (TNode-APN-"X") parameters to calculate the relative APN available load of each candidate target node, i.e.: + +$$\text{TNode-APNx-effective-available-load} = (100 - \text{TNode-APNx-load-metric})\% \times \text{TNode-APNx-weight-factor}$$ + +$$\text{TNode-APNx-relative-available-load} = (\text{TNode-APNx-effective-available-load} / \text{sum-of-APNx-effective-available-load-of-all-the-nodes-in-TNodeList}) \times 100\%$$ + +- the selecting node shall then select the PGW for new session requests according to the TNode-APN-relative-available-load of each target candidate node, e.g. a TNode-APN-relative-available-load value of X% indicates that the corresponding target node should be selected for X% of the new sessions requests towards the requested APN. + +- If the candidate PGW did not provide APN load control information for an APN (called "APNx"), but provided APN load control information for other APNs (called "APNn"), the selecting node shall assume the following when computing the relative APN available load for that candidate PGW for the "APNx": + +$$\text{TNode-APNx-relative-capacity} = (100 - \text{sum of [TNode-APN-relative-capacity of other APNs "APNn"]}]) \text{ for the same PGW}$$ + +$$\text{TNode-APNx-load-metric} = \{ \text{TNode-load-metric} - \text{sum of [for each APNs in APNn (TNode-APN-load-metric} \times \text{TNode-APN-relative-capacity) / 100]} \} / \{ 100 - \text{sum of [TNode-APN-relative-capacity of each APNs in APNn]} / 100 \}$$ + +NOTE: The formula to compute the APNx load metric results from the following equation: + +$$\text{TNode-load-metric} \times \text{TNode-capacity} = \text{sum of [for each APNs in APNn (TNode-APN-load-metric} \times \text{TNode-capacity} \times \text{TNode-APN-relative-capacity) / 100]} + \text{TNode-APNx-load-metric} \times \text{TNode-capacity} \times (100 - \text{sum of [TNode-APN-relative-capacity of each APNs in APNn]} / 100)$$ + +- If the candidate PGW did not provide APN load control information for any APN, the selecting node shall assume the following when computing the relative APN available load for that candidate PGW for an APN: + +$$\text{TNode-APNx-relative-capacity} = 100$$ + +$$\text{TNode-APNx-load-metric} = \text{TNode-load-metric (i.e. the load at the target node level)}$$ + +Annex E.2 provides examples illustrating these principles. + +# 5 Procedures for EPC Node Discovery and Selection + +## 5.1 Procedures for Discovering and Selecting a PGW + +### 5.1.1 Discovering a PGW for a 3GPP Access + +#### 5.1.1.1 General + +The procedures here give a list of possible PGWs and their interfaces that serve a particular APN. This is very similar to the existing function that resolves the GGSN IP address based on an APN. + +NOTE 1: The RAI/RNC-ID FQDN is used in addition to the APN FQDN when selecting the GGSN for SIPTO above RAN enabled APN. See clause 5.6. + +However, the Release-8 behaviour includes more functionality than pre-Release-8 systems since the PGW now can support more than one protocol and there is sometimes a desire to have the PGW and SGW collocated or topologically close to each other (with respect to the network topology), if possible. New DNS records are required to distinguish between different protocols and interfaces and assist in the more complicated selections. + +The operator shall provision the authoritative DNS server(s) responsible for the APN-FQDN, including all derivatives used by the operator in the APN-OI replacement field (as defined in 3GPP TS 23.060 [18] and 3GPP TS 23.401 [11]) with NAPTR records for the given APN-FQDN and corresponding PGWs under the APN-FQDN. + +See clause 19.4.2.2 of 3GPP TS 23.003 [4]. + +The above format is used in DNS for use in DNS queries by S4-SGSN and MME to networks with DNS provisioned to Release-8. A Release-8 SGSN only supporting Gn/Gp may also optionally use this procedure. + +The DNS records provisioned at that location are NAPTR records and include all S5/S8 and Gn/Gp interfaces for PGW, GGSN, and collocated PGW/GGSN that are intended to be used for that APN. + +When PGW-C/SMFs are deployed in a PGW-C/SMF set, as an operator option, one separate NAPTR DNS record may be provisioned for the PGW-C/SMF Set under the APN records of each APN supported by the PGW-C/SMF set (see example in Annex A.3.5); if so, in this DNS record, the NAPTR flag shall be set to "", and NAPTR "replacement" shall be set to the PGW Set FQDN as specified in clause 19.4.2.13 of 3GPP TS 23.003 [4]. An MME supporting the Restoration of PDN connections after a PGW-C/SMF Change procedure as specified in 3GPP TS 23.007 [31] shall be able to select a PGW-C/SMF from this PGW-C/SMF Set identified by the PGW Set FQDN as specified in clause 5.1.4. + +NOTE 2: The provisioning of the above DNS record is not necessary to support restoring the PDN connections after a PGW-C/SMF change. This provisioning can allow an MME to select a PGW pertaining to a PGW-C/SMF set for a given APN during the initial PDN connection establishment. + +The pre-Release-8 format APN as specified in clause 9.1 of 3GPP TS 23.003 [4] is still used in pre-Release-8 SGSN DNS queries and continues to be used as a fallback in Release-8 SGSN for discovering Gn/Gp interfaces. + +The DNS records provisioned at that location are A and/or AAAA records but only for the Gn/Gp interfaces of a standalone GGSN or collocated PGW/GGSN. + +The APN-FQDN is derived from the APN where the APN is typically in the legacy format of ".mnc.mcc.gprs" as specified in clause 9.1 of 3GPP TS 23.003 [4]. + +NOTE 3: The APN-FQDN is used for DNS query purposes in Release-8. It does not imply a change in the use or format of the APN in other protocols, nodes or UE/MS. The APN-FQDN and the APN use independent formats but are related as below for DNS usage by the MME and S4-SGSN. + +The APN received by the EPC node discovery function for 3GPP accesses, is always of the form of an APN-NI part and operator part. It is the output from Annex A of 3GPP TS 23.060 [18], which is exactly three labels with last label "gprs". + +If the APN is constructed using the default APN-OI or using the APN-OI Replacement field (as defined in 3GPP TS 23.060 [18] and 3GPP TS 23.401 [11]), then the APN-FQDN shall be obtained from the APN as specified in clause 19.4.2.2.1 of 3GPP TS 23.003 [4], otherwise the APN is considered to be invalid and cannot be used. + +In Annex A of 3GPP TS 23.060 [18] the SDL diagram refers to a "DNS interrogation" succeeding or failing which is the only DNS interaction. This is clarified as follows: + +For the procedures defined in the present document the APN-FQDN shall be used in the S-NAPTR with a NAPTR query (see later clauses for details). If the S-NAPTR procedure succeeds the "DNS interrogation" succeeds. If the S-NAPTR procedure fails to find a PGW or collocated PGW/GGSN then the "DNS interrogation" fails. + +For the legacy procedures defined in Annex A of 3GPP TS 23.060 [18] the unmodified APN shall be used in the DNS A query and DNS AAAA query. If either query succeeds, the "DNS interrogation" succeeds. If the A and AAAA queries both fail then the "DNS interrogation" fails. + +The nodes responsible for the PGW selection (i.e. the MME or S4-SGSN) shall apply the additions specified in clause 4A, if GTP-C load control is supported and enabled. + +#### 5.1.1.2 Discovering a PGW or collocated PGW/GGSN for a 3GPP Access - S8/Gp roaming case existing PDN + +This clause covers the case where the SGW or S4-SGSN is in the visiting network, the SGW is already pre-selected by having at least one existing PDN connection and a UE attempts to create a new PDN connection for a different APN to be selected in the home network. + +Operators shall provision NAPTR records for each APN-FQDN that allows roaming with at least "Service Parameters" of + +"x-3gpp-pgw:x-s8-gtp", "x-3gpp-pgw:x-s8-pmip", "x-3gpp-ggsn:x-gp", "x-3gpp-pgw:x-gp" + +for each such supported interface of that type. + +The S-NAPTR procedure, employed by the MME or S4-SGSN, to discover all S8 interfaces shall use "Service Parameters" of + +"x-3gpp-pgw:x-s8-gtp", "x-3gpp-pgw:x-s8-pmip"" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and set the Application-Unique String to the APN FQDN as defined in clause 19.4.2.2 of 3GPP TS 23.003 [4]. The "Service Parameter" of "x-3gpp-pgw:x-gp" shall be included if the MME or S4-SGSN wishes to potentially bias towards a collocated PGW/GGSN. + +Additional requirements to support DCN are specified in clause 5.8. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of candidate IPv4 and IPv6 addresses. This is a "candidate" list of PGW or collocated PGW/GGSN for that APN (see Annex C.2 for an informative description of a candidate list and Annex B for the S-NAPTR procedure). + +The above procedure shall be used by the MME or S4-SGSN to select the PGW or collocated PGW/GGSN. + +NOTE 1: When an LTE capable terminal is in GERAN/UTRAN access, the S4-SGSN might wish to preferentially select a node with both Gp and S8 (i.e. a co-located PGW/GGSN) based on an operator policy. A preference for a co-located PGW/GGSN may also exist in an LTE access based on operator policy. The MME, or Release-8 SGSN, may find co-located PGW/GGSN nodes by searching the APN "candidate" list for interfaces with the same canonical node name in a Gp interface host name and S8 interface host name. + +The PGW and SGW cannot be collocated in this case since the SGW and PGW are in different operator networks. Furthermore, topological matching by DNS host names shall not be done since the host names are under different operators' administrative control. + +The Service Parameter of "x-3gpp-pgw:x-gp" denotes a collocated Release 8 GGSN function on a PGW. A PGW with a collocated Release 8 GGSN function may be preferred subject to operator policies. If that is the case the collocated PGW/GGSN nodes should be moved to the front of the candidate list but otherwise retaining the same relative order. The interfaces from the candidate list that are not S8 based shall be removed. The PGW S8 interfaces are tried in order from the candidate list. + +NOTE 2: Contrary to the non-roaming case, in the roaming case the domain name of the SGW interface selected does not influence the PGW selection. + +In the above procedure after the PGW has been contacted, the selected PGW node name, selected IP address, port (if non standard) and selected protocol type (GTPv2 vs. PMIP) shall be stored in the MME or S4-SGSN so it can be accessed on a PDN basis. + +NOTE 3: In this release of 3GPP only standard ports are used. + +3GPP TS 23.401 [11] currently indicates only one of PMIP or GTPv2 will be used based on roaming agreements so the above query would actually not require both *gtp* and *pmip*. The operator could use the order field in the NAPTR records to accomplish an optional fallback to the other protocol type. + +Use cases where a SGW needs to be selected are covered in clause 5.2. However, since Gn/Gp access bypasses SGW selection completely both for subsequent PDP context activations and initial attach we note that special case here. + +If the UE is in GERAN or UTRAN access and the Release 8 SGSN supports Gp, but not S4, the procedure above is modified as follows. The "Service Parameters" shall be + +"x-3gpp-pgw:x-gp" , "x-3gpp-ggsn:x-gp" + +Additional requirements to support DCN are specified in clause 5.8. + +If an LTE capable mobile is in GERAN/UTRAN access a PGW with a collocated PGW/GGSN function may be preferred subject to operator policies. If that is the case the PGW/GGSN nodes should be moved to the front of the candidate list but otherwise retaining the same relative order. The rest of the procedure is the same as above. + +If the APN record does not exist at the .3gppnetwork.org domain and the UE is in GERAN or UTRAN access and the Release 8 SGSN supports Gp then the pre Release-8 DNS procedures shall apply for the APN lookup by the Release 8 SGSN (i.e. APN lookup by A/AAAA records in the domain .gprs). + +#### 5.1.1.3 Discovering a PGW or collocated PGW/GGSN for a 3GPP Access - S5/Gn intra-operator existing PDN + +Operators shall provision NAPTR records for each APN-FQDN for use within their network with at least "Service Parameters" of + +"x-3gpp-pgw:x-s5-gtp", "x-3gpp-pgw:x-s5-pmip", "x-3gpp-ggsn:x-gn", "x-3gpp-pgw:x-gn" + +for each such supported interface of that type. + +Assuming the SGW is already pre-selected by having an existing PDN connection and a UE attempts to create a new PDN connection for a different APN in the user's home network, then the MME or S4-SGSN shall perform the following procedure: + +The S-NAPTR procedure, employed by the MME or S4-SGSN to discover S5 interfaces shall use "Service Parameters" of + +"x-3gpp-pgw:x-s5-gtp", "x-3gpp-pgw:x-s5-pmip" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and set the Application-Unique String to the APN FQDN as defined in clause 19.4.2.2 of 3GPP TS 23.003 [4]. The "Service Parameter" of "x-3gpp-pgw:x-gn" shall be included if the MME or S4-SGSN wishes to potentially bias towards a collocated PGW/GGSN. + +Additional requirements to support DCN are specified in clause 5.8. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of candidate IPv4 and IPv6 addresses. This is a "candidate" list of PGW or collocated PGW/GGSN for that APN (see Annex C.2 for an informative description of a candidate list and Annex B for the S-NAPTR procedure). + +Collocation and topological ordering between the PGW and SGW applies in this case. + +If the existing SGW hostname has "topoff" then the candidate list of PGW shall be used in the order given to try to contact a PGW, after moving any colocated SGW/PGW to the front of the candidate list while maintaining relative order within that set. + +The Service Parameter of "x-3gpp-pgw:x-gn" denotes a collocated Release 8 GGSN function on a PGW. A PGW with a collocated Release 8 GGSN function may be preferred subject to operator policies. If that is the case the collocated PGW/GGSN nodes should be moved to the front of the candidate list but otherwise retaining the same relative order. The interfaces from the candidate list that are not S5 based shall be removed. The PGW S5 interfaces are tried in order from the candidate list.. + +If the existing SGW hostname has "topon" the two candidate lists shall be used in the procedure in Annex C.4 with the PGW as "A" and the SGW as "B". Annex C.4 results in a list of PGW to try in order. + +Once a PGW is successfully contacted the selected PGW host name, PGW IP address used, port (if non-standard) and selected protocol type (GTP vs PMIP) shall be stored in the MME or S4-SGSN so it can be accessed on a PDN basis. + +NOTE 1: In this release of 3GPP only standard ports are used. + +Use cases where a SGW needs to be selected are covered in clause 5.2 and clause 5.3. However, since Gn/Gp access bypasses SGW selection completely both for subsequent PDP context activations and initial attach we note that special case here. + +If the UE is in GERAN or UTRAN access and the Release 8 SGSN supports Gn, but not S4, the procedure above is modified as follows. The "Service Parameters" shall be + +"x-3gpp-pgw:x-gn" , "x-3gpp-ggsn:x-gn" + +Additional requirements to support DCN are specified in clause 5.8. + +NOTE 2: When the SGSN supports Gn selects the GGSN or collocated PGW/GGSN for SIPTO above RAN enabled APN, in addition to the APN FQDN, the S-NAPTR procedure use the "Service Parameters" of "x-3gpp-pgw:x-gn" , "x-3gpp-ggsn:x-gn", and set the Application-Unique String to the RAI FQDN as specified in clause 5.5.2 or the RNC-ID FQDN as specified in clause 19.4.2.7 of 3GPP TS 23.003 [4] . See clause 5.6. + +If an LTE capable mobile is in GERAN/UTRAN access a PGW with a collocated PGW/GGSN function may be preferred subject to operator policies. A preference for a co-located PGW/GGSN may also exist in an LTE access based on operator policy. The MME, or Release-8 SGSN, may find co-located PGW/GGSN nodes by searching the APN "candidate" list for interfaces with the same canonical node name in a Gn interface host name and S5 interface host name. If that is the case the PGW/GGSN nodes should be moved to the front of the candidate list but otherwise retaining the same relative order. The rest of the procedure is the same as above. + +If the APN record does not exist at the .3gppnetwork.org domain and the UE is in GERAN or UTRAN access and the Release 8 SGSN supports Gn then the pre Release-8 DNS procedures shall apply for the APN lookup by the Release 8 SGSN (i.e. APN lookup by A/AAAA records in the domain .gprs). + +Those procedures apply also to the case of roaming with local breakout when subscription data and network policy allow selection of a PGW from the VPLMN (see e.g. clause 4.2.2 in 3GPP TS 23.401 [11]). + +#### 5.1.1.4 Discovering a PGW, collocated PGW/GGSN or GGSN for a 3GPP Access - S5/Gn intra-operator initial attach + +During the initial attach and PDN connection creation using a 3GPP access both a PGW and an SGW need to be selected by an MME and will also be used by a S4-SGSN in PDP context creation. The discovery and selection procedures for cases employing a SGW are the same as for the PGW and the SGW discovery and selection procedure described in clause 5.3. + +The discovery and selection procedures for a Release-8 SGSN selecting a Gn interface for PDP context creation are in clause 5.1.1.3. + +### 5.1.2 Discovering a PGW for a non-3GPP Access with Network Based Mobility Management + +#### 5.1.2.1 Discovering a PGW for a non-3GPP Access – S2a/S2b initial attach for roaming and non-roaming + +The MAG functionality or TWAN within the trusted non-3GPP IP access or the e-PDG shall use the S-NAPTR procedure with "Service Parameters" of + +"x-3gpp-pgw:x-s2a-pmip", "x-3gpp-pgw:x-s2b-pmip", "x-3gpp-pgw:x-s2a-mipv4", "x-3gpp-pgw:x-s2b-gtp", "x-3gpp-pgw:x-s2a-gtp" + +and the APN-FQDN as the Application-Unique String. + +.apn.epc.mnc.mcc.3gppnetwork.org + +See clause 19.4.2.2 of 3GPP TS 23.003 [4]. + +Additional requirements to support DCN are specified in clause 5.8. + +When PGW-C/SMFs are deployed in a PGW-C/SMF set, as an operator option, one separate NAPTR DNS record may be provisioned for the PGW-C/SMF Set under the APN records of each APN supported by the PGW-C/SMF set (see example in Annex A.3.5); if so, in this DNS record, the NAPTR flag shall be set to "", and NAPTR "replacement" shall be set to the PGW Set FQDN as specified in clause 19.4.2.13 of 3GPP TS 23.003 [4]. An ePDG supporting the Restoration of PDN connections after a PGW-C/SMF Change procedure as specified in 3GPP TS 23.007 [31] shall be able to select a PGW-C/SMF from this PGW-C/SMF Set identified by the PGW Set FQDN as specified in clause 5.1.4. + +NOTE: The provisioning of the above DNS record is not necessary to support restoring the PDN connections after a PGW-C/SMF change. This provisioning can allow an ePDG to select a PGW pertaining to a PGW-C/SMF set for a given APN during the initial PDN connection establishment. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This is a "candidate" list of PGW for that APN (see Annex B for S-NAPTR procedure and see Annex C.2 for an informative description of a candidate list). + +There is no requirement for selection for a collocated PGW/SGW in this procedure. In the above procedure, the selected PGW node name, port and selected type (PMIPv6, MIPv4 or GTP) shall be stored in the MAG functionality, TWAN or the ePDG so it can be accessed on a PDN basis. + +The nodes responsible for the PGW selection (i.e. the TWAN or ePDG) shall apply the additions specified in clause 4A, if GTP-C load control is supported and enabled. + +#### 5.1.2.2 Discovering a PGW for a non-3GPP Access – S2a/S2b initial attach and chained PMIP-based S8-S2a/S2b + +The MAG functionality within the trusted non-3GPP IP access or the e-PDG shall use the S-NAPTR procedure with the "Service Parameters" of + +"x-3gpp-pgw:x-s2a-pmip", "x-3gpp-pgw:x-s2b-pmip" + +and the APN-FQDN as the Application-Unique String. + +.apn.epc.mnc.mcc.3gppnetwork.org + +See clause 19.4.2.2 of 3GPP TS 23.003 [4]. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This is a "candidate" list of PGW for that APN (see Annex B for S-NAPTR procedure and see Annex C.2 for an informative description of a candidate list). + +The MAG selects a PGW based on the protocol type (GTP v/s PMIPv6) supported over the S5/ S8 interface based on information received over STa and SWm interfaces. + +The PGW and SGW cannot be collocated in this case since the SGW and PGW are in different operator networks. + +The DNS records in the order returned are then used to contact the PGW node. + +The nodes responsible for the PGW selection (i.e. the TWAN or ePDG) shall apply the additions specified in clause 4A, if GTP-C load control is supported and enabled. + +### 5.1.3 Discovering a PGW for a non-3GPP Access with DSMIPv6 + +#### 5.1.3.1 Discovering a PGW for a non-3GPP Access – S2c initial attach + +This clause covers the case where the IP address of the Home Agent (HA) functionality of a particular PGW needs to be discovered from the FQDN of the PGW. This query may be sent from a trusted access gateway or from an ePDG. The trusted access gateway or ePDG shall use the S-NAPTR procedure with "Service Parameters" of + +"x-3gpp-pgw:x-s2c-dsmip" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the FQDN of the specific PGW. + +The nodes responsible for the PGW selection (i.e. the TWAN or ePDG) shall apply the additions specified in clause 4A, if GTP-C load control is supported and enabled. + +### 5.1.4 Discovering a PGW-C/SMF in a PGW-C/SMF Set + +#### 5.1.4.1 General + +The DNS procedure specified in this clause shall be used by an MME or an ePDG to select an alternative PGW-C/SMF from a PGW-C/SMF Set during an MME or ePDG triggered Restoration of a PDN connection after an PGW-C/SMF change, as specified in clause 31 of 3GPP TS 23.007 [31], if the MME or ePDG did not receive Alternative PGW-C/SMF IP Addresses from the PGW for the PDN connection, i.e. if the PGW Change Info IE received from the PGW for the PDN connection contains either the PGW Set FQDN IE or the Alternative PGW-C/SMF FQDN IE(s). + +#### 5.1.4.2 Using the PGW Set FQDN + +For deployments using a PGW Set FQDN, operators shall provision NAPTR records under the PGW Set FQDN (as defined in clause 19.2.4.13 of 3GPP TS 23.003 [4]) with at least "Service Parameters" of + +"x-3gpp-pgw:x-s5-gtp", "x-3gpp-pgw:x-s8-gtp", "x-3gpp-pgw:x-s2b-gtp" + +for each PGW-C/SMF within the PGW-C/SMF Set, + +The MME or ePDG shall discover the PGW-C/SMFs available within a PGW-C/SMF Set by initiating an S-NAPTR procedure, with the Application-Unique String set to the PGW Set FQDN, and with the "Service Parameters" set to "x-3gpp-pgw:x-s5-gtp" or "x-3gpp-pgw:x-s8-gtp" (for an MME) or to "x-3gpp-pgw:x-s2b-gtp" (for an ePDG). + +The PGW Set FQDN shall be the PGW Set FQDN last received (over S5/S8 and S11 interfaces or over the S2b interface) from the PGW for the PDN connection. + +The S-NAPTR procedure outputs a list of host names (PGWs) each with a service, protocol, port and a list of IPv4 and IPv6 addresses pertaining to the PGW-C/SMF set. See further details and examples in Annexes B, C and G. + +#### 5.1.4.3 Using Alternative PGW-C/SMF FQDNs + +For deployments using Alternative PGW-C/SMF FQDNs, the procedure specified in clause 4.3.3.3 shall apply, i.e.: + +- operators shall provision NAPTR records for the S5, S8 and/or S2b interfaces of the alternative PGW-C/SMFs of the PGW-C/SMF set, and +- the MME or ePDG shall use the S-NAPTR procedure using the "Service Parameters" of + +"x-3gpp-pgw:x-s5-gtp", "x-3gpp-pgw:x-s8-gtp", "x-3gpp-pgw:x-s2b-gtp" + +for the S5, S8 and S2b interface respectively, and the Application-Unique String set to the Alternative PGW-C/SMF FQDN received in the PGW Change Info IE. + +## 5.2 Procedures for Discovering and Selecting a SGW + +### 5.2.1 General + +These procedures are employed when an SGW needs to be selected by an EPC core node and a PGW has already been selected. In particular for the tracking area update procedure with SGW change. + +The SGW is selected based on the target cell where the UE has moved into. The MME has the new target eNodeB cell ID (eCID)/target eNodeB-ID and TAI available. The MME shall construct the TAI FQDN as defined in clause 19.4.2.3 of 3GPP TS 23.003 [4] and the MME shall construct the eNodeB-ID FQDN as defined in clause 19.4.2.10 of 3GPP TS 23.003 [4]. + +The selected SGW shall serve the UE's TAI and/or eNodeB-ID. During the attach/TAU/Handover procedure the MME receives the TAI value and eNodeB-ID which is derived from the ECGI or received from the source MME/SGSN. The + +MME shall construct the TAI FQDN as defined in clause 19.4.2.3 of 3GPP TS 23.003 [4] and eNodeB-ID FQDN as defined in clause 19.4.2.10 of 3GPP TS 23.003 [4]. + +Operators shall provision, for each TAI/eNodeB-ID value in their network, NAPTR records under the TAI/eNodeB-ID FQDN corresponding to each valid SGW interfaces from the following "Service Parameters" + +"x-3gpp-sgw:x-s8-gtp", "x-3gpp-sgw:x-s8-pmip", "x-3gpp-sgw:x-s5-gtp", "x-3gpp-sgw:x-s5-pmip" + +where additional "Service Parameters" may be included optionally. + +Additional requirements to support DCN are specified in clause 5.8. + +For each RAI/RNC-ID value that is served by a S4-SGSN the same records would be provisioned under the RAI FQDN (see clause 5.5.2 for the RAI FQDN) or the RNC-ID FQDN (see clause 19.4.2.7 of 3GPP TS 23.003 [4] for the RNC-ID FQDN). + +The S-NAPTR procedure employed by an MME for finding a candidate set of SGW nodes shall use the TAI FQDN/eNodeB-ID FQDN as the Application-Unique String. + +For the purposes of this document the NAPTR record-set at that location will be called the TAI/eNodeB-ID NAPTR record-set. + +The MME selects the S11 interface of the SGW from the SGW's canonical node record (see clause 4.3.3) if it is not obtained from the TAI/eNodeB-ID records. + +NOTE: If an operator does not use the "a" and "s" flags in the TAI/eNodeB-ID NAPTR records (i.e. they use the "" flag) and they are using SGW service areas it is strongly recommended that the TAI/eNodeB-ID NAPTR records point directly to NAPTR records representing the SGW service areas. This is to facilitate possible future use in the SGW Load Re-balancing procedure. + +For the case of an S4-SGSN making the SGW selection the RAI FQDN (see clause 5.5.2) or the RNC-ID FQDN (see clause 19.4.2.7 of 3GPP TS 23.003 [4] for the RNC-ID FQDN) is used instead of the TAI FQDN or the eNodeB-ID FQDN to select the SGW but is otherwise the same as the MME handling TAU. The S4-SGSN selects the S4 interface of the SGW from the SGW's canonical node record (see clause 4.3.3) if it is not obtained from the RAI/RNC-ID records. + +S-GW selection when SGW that acts as a local anchor for non-3GPP access in the case of S8-S2a/b chained roaming is outside the scope of this specification. + +The nodes responsible for the SGW selection (i.e. the MME or S4-SGSN) shall apply the additions specified in clause 4A, if GTP-C load control is supported and enabled. + +### 5.2.2 SGW Selection during TAU or RAU with SGW change - 3GPP roaming case + +For the roaming case the type of protocol (PMIP vs. GTP) is chosen based on a roaming agreement according to 3GPP TS 23.401 [11]. The MME shall therefore use the S-NAPTR procedure with "Service Parameters" of + +"x-3gpp-sgw:x-s8-gtp" or "x-3gpp-sgw:x-s8-pmip" + +Additional requirements to support DCN are specified in clause 5.8.(based on whether GTP v2 or PMIPv6 is used for the current PDN connection) + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and possibly restricted based on a roaming agreement to use only GTPv2 or PMIPv6 and set the Application-Unique String to the TAI FQDN as defined in clause 19.4.2.3 of 3GPP TS 23.003 [4] or the eNodeB-ID FQDN as defined in clause 19.4.2.10 of 3GPP TS 23.003 [4]. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This is a "candidate" list of SGW for that TAI/eNodeB-ID (see Annex B for S-NAPTR procedure and see Annex C.2 for an informative description of a candidate list). + +If the first choice protocol (PMIP or GTPv2) fails the second choice MAY be tried subject to the operators' roaming agreements. + +Neither collocation of PGW and SGW nor topological ordering rules apply in this case. + +The present clause to this point implicitly assumes only one PDN connection is currently employed by a UE which may not be the case with multiple PDN connections for the same UE. All PDN connections after the TAU must be on the same SGW since there is only one SGW at a time for a UE. + +If an existing PDN for the UE is PMIPv6 S8 and some existing PDN for the UE is GTPv2 S8 then a SGW supporting both protocols is required. If that occurs and there are no such SGW then the PDN connections with the least important retention (from the ARP value) would have to be dropped until a list of viable SGW of one protocol meeting the retention policies is found. If there are non viable SGW they are removed from the original SGW candidate list. After this point the SGW candidate list order is used in the same way as it was in the case of only one PDN connection. + +Once an SGW is successfully contacted the selected SGW host name, selected SGW IP address, selected port (if non-standard) and selected protocol type (GTPv2 vs. PMIP - which is unchanged here) shall be stored in the MME so it can be accessed on a PDN basis. + +NOTE 1: In this release of 3GPP only standard ports are used. + +For the case of an S4-SGSN making the SGW selection the RAI FQDN (see clause 5.5.2) or the RNC-ID FQDN (see clause 19.4.2.7 of 3GPP TS 23.003 [4] for the RNC-ID FQDN) is used instead of the TAI/eNodeB-ID FQDN to select the SGW but is otherwise the same as the MME handling TAU. The S4-SGSN selects the S4 interface of the SGW from the SGW's canonical node record (see clause 4.3.3) if it is not obtained from the RAI/RNC-ID records. + +NOTE 2: A SGW will need to be selected at a handover attach from another access type. The SGW selection method is the same as presented here since there are existing PDN connections (typically PMIPv6 for non-3GPP accesses). + +### 5.2.3 SGW Selection during TAU or RAU with SGW change - non-roaming case + +This differs from the 3GPP roaming case in 5.2.2 primarily in that the PGW and the SGW are in the same network. Hence, there is a need to be able of selecting a SGW collocated with the PGW or a topologically close SGW. The current PGW's node name should previously have been stored in the MME or S4-SGSN when the default bearer was established or transported from the old MME to the new MME, and is therefore available for comparison. + +For the non-roaming case the S-NAPTR procedure shall be initiated with "Service Parameters" of + +"x-3gpp-sgw:x-s5-gtp" and/or "x-3gpp-sgw:x-s5-pmip" + +Additional requirements to support DCN are specified in clause 5.8.(based on whether GTPv2 or PMIPv6 is used for the current PDN connection) + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and set the Application-Unique String to the TAI FQDN as defined in clause 19.4.2.3 of 3GPP TS 23.003 [4]. The Application-Unique-String may be set to the eNodeB-ID FQDN as defined in clause 19.4.2.10 of 3GPP TS 23.003 [4] as an operator specific deployment option. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This is a "candidate" list of SGW for that TAI/eNodeB-ID (see Annex B for S-NAPTR procedure and see Annex C.2 for a more detailed informative description of a candidate list). + +Collocation of PGW and SGW and topological ordering rules both apply in this case.If the existing PGW hostname for the PDN has "topoff" then the "candidate" list of SGW would be used in the order given to try to contact a SGW after moving the PGW with the same SGW node name to the front of the list keeping relative order. + +If the existing PGW hostname has "topon" the two candidate lists shall be used in the procedure in Annex C.4 with the SGW as "A" and the PGW as "B". Annex C.4 results in a list of SGW to try in order. + +The present clause to this point implicitly assumes only one PDN connection is currently employed by a UE which may not be the case with multiple PDN connections for the same UE. + +If an existing PDN for the UE is PMIPv6 S5 and some existing PDN for the UE is GTPv2 S5 then a SGW supporting both protocols is required. If that occurs and there are no such SGW then the PDN connections with the least important retention (from the ARP value) would have to be dropped until a list of viable SGW of one protocol meeting the retention policies is found. If there are non viable SGW they are removed from the original SGW candidate list. After this point the SGW candidate list order is used in the same way as it was in the case of only one PDN connection. + +After this point it is a matter of operator policy or vendor implementation which PDN or PDNs (and hence their corresponding PGW canonical node names) are used for selecting the corresponding best SGW interface. + +NOTE 1: One possible option would be as follows. First try to maximize the number of PDN connections that are on PGW colocated on the same viable SGW. If there are no colocated choices the PGW giving the closest topological match to any viable SGW are used. If they are all equal then SGW ordering from the SGW candidate list is used. This approach would be very similar, but not identical, to passing the list of PGW being used as list "B" and the SGW candidate list with only viable SGW as list "A" in the procedure in Annex C.4 + +Once an SGW is successfully contacted the selected SGW host name, SGW IP address used, port (if non-standard) and selected type (GTP vs PMIP) shall be stored in the MME so it can be accessed on a PDN basis. + +NOTE 2: In this release of 3GPP only standard ports are used. + +For the case of an S4-SGSN making the SGW selection the RAI FQDN (see clause 5.5.2) is used or as an operator deployment option the Application-Unique-String may be set to the RNC-ID FQDN as defined in clause 19.4.2.7 of 3GPP TS 23.003 [4] instead of the TAI/eNodeB-ID FQDN to select the SGW but is otherwise the same as the MME handling for TAU. The S4-SGSN selects the S4 interface of the SGW from the SGW's canonical node record (see clause 4.3.3) if it is not obtained from the RAI or RNC-ID records. + +NOTE 3: A SGW will need to be selected at a handover attach from another access type. The SGW selection method is the same as presented here since there are existing PDN connections (typically PMIPv6 for non-3GPP accesses). + +NOTE 4: eNodeB-ID and RNC-ID FQDN are only employed by Release 10 or onwards MME/SGSNs for SGW selection. + +### 5.2.4 SGW Selection during non-3GPP handover to 3GPP access + +The SGW selection is similar with other cases. For the non-roaming case, there is a need of selecting a SGW colocated with the PGW or a topologically close SGW. The current PGW's node name should previously have been stored in the HSS and would be sent to the MME during the access authentication procedure and is therefore available for comparison. + +The S-NAPTR procedure for SGW Selection is same as clause 5.2.2 for roaming case, and is same as clause 5.2.3 for non-roaming case. + +## 5.3 Procedures for Discovering and Selecting a PGW and SGW + +This scenario applies to the UE initial attach and PDP context activation cases, where the MME or S4-SGSN has not yet assigned a PGW or a SGW to the UE. During the attach procedures, the MME shall select the SGW and the PGW as described below. During the UTRAN/GERAN PDP context activation procedure, the S4-SGSN shall select the SGW and the PGW as described below. + +NOTE 1: The procedure specified in this clause is not applied for the LGW selection for LIPA service or for SIPTO at the local network with LGW colocated with (H)(e)NB. The MME/S4 SGSN uses the LGW address proposed by the (H)(e)NB in the S1-AP/RANAP message as specified in 3GPP TS 36.413 [19] and 3GPP TS 25.413 [12] to select the appropriate LGW for LIPA service or for SIPTO at the local network with LGW colocated with (H)(e)NB. + +For SIPTO at the local network with stand-alone GW, the SGW shall be selected based on the < LHN name> provided by the (H)(e)NodeB during the attach or SIPTO at local network PDN connection creation. The MME shall construct the Local Home Network-ID FQDN defined in clause 19.4.2.11 of 3GPP TS 23.003 [4]. + +The selected SGW shall serve the UE's TAI/eNodeB-ID. During the attach procedure the MME receives the TAI value and eNodeB-ID which is derived from the ECGI. The S-NAPTR procedure to obtain a list of "candidate" SGW shall be used with "Service Parameters" of + +"x-3gpp-sgw:x-s5-gtp", "x-3gpp-sgw:x-s5-pmip" + +Additional requirements to support DCN are specified in clause 5.8. as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and set the Application-Unique String set to the TAI FQDN as defined in clause 19.4.2.3 of 3GPP TS 23.003 [4] or as + +an operator specific deployment option the Application-Unique-String may be set to the eNodeB-ID FQDN as defined in clause 19.4.2.10 of 3GPP TS 23.003 [4]. For SIPTO at the Local Network with stand-alone GW the Local Home Network ID as defined in clause 19.4.2.11 of 3GPP TS 23.003 [4] shall be used to select the SGW. + +The S-NAPTR procedure logically outputs a list of host names each coupled with a service, a protocol, a port, and a list of IPv4 and IPv6 addresses. This is the "candidate" list of SGWs for a specific TAI/eNodeB-ID (see Annex B for S-NAPTR procedure and see Annex C.2 for an informative description of the candidate list). + +The list of "candidate" PGW is obtained as follows: + +The S-NAPTR procedure to get the list of "candidate" PGW shall use "Service Parameters" of + +"x-3gpp-pgw:x-s5-gtp", "x-3gpp-pgw:x-s5-pmip", "x-3gpp-pgw:x-gn" + +Additional requirements to support DCN are specified in clause 5.8. + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the APN FQDN as defined in clause 19.4.2.2 of 3GPP TS 23.003 [4]. + +The S-NAPTR procedure logically outputs a list of host names each coupled with a service, a protocol, a port, and a list of IPv4 and IPv6 addresses. This is the "candidate" list of PGWs for a specific APN (see Annex C.2 for a detailed description of a candidate list). + +The two candidate lists shall be used in the procedure described in Annex C.4 with the SGW as an "A" node type and the PGW as a "B" node type in the procedure. + +The procedure described in Annex C.4 results in a selection of a SGW and a PGW along with the protocol, the IP address and the port. In the case of a failure to contact the SGW or the PGW, the required gateway reselection procedures are described in Annex C.4. + +The MME selects the S11 interface of the SGW from the SGW's canonical node record (see clause 4.3.3) if it is not obtained from the TAI records. + +NOTE 2: The MME (S4-SGSN) send a GTPv2 Create Session Request to the SGW respectively over S11 or S4 with the IPv4/IPv6 address of the PGW. After the SGW has been successfully contacted over S11 or S4, the SGW can try to contact the PGW over S5/S8. + +Once the SGW has successfully been contacted, the selected SGW host name, the used SGW IP address, the port number and the selected protocol type shall be stored in the MME or S4-SGSN per PDN. + +Once the PGW has successfully been contacted, the selected PGW host name, the used PGW IP address, the port number and the selected protocol type shall be stored in the MME or S4-SGSN per PDN. + +For the case of an S4-SGSN making the selection the RAI FQDN is used, or as an operator deployment option the Application-Unique-String may be set to the RNC-ID FQDN as defined in clause 19.4.2.7 of 3GPP TS 23.003 [4] instead of the TAI FQDN/eNodeB-ID FQDN to select the SGW but is otherwise the same as an MME doing the selection. The S4-SGSN selects the S4 interface of the SGW from the SGW's canonical node record (see clause 4.3.3) if it is not obtained from the RAI or RNC-ID records. + +The nodes responsible for the SGW and PGW selection (i.e. the MME or S4-SGSN) shall apply the additions specified in clause 4A, if GTP-C load control is supported and enabled. + +## 5.4 Procedures for Discovering and Selecting an MME + +These procedures can be used as part of: + +- the 'Inter eNodeB handover with MME relocation' procedure to select an MME; +- the RAN Information Management (RIM) procedure to select an MME; +- UTRAN/GERAN to E-UTRAN SRVCC procedure to select an MME as specified in 3GPP TS 23.216 [20]; +- IMSI and APN Information retrieval procedure for RAN User Plane Congestion mitigation to select an MME as specified in clause 5.9.3 of 3GPP TS 23.401[11]; + +- NAS Message Redirection procedure to retrieve the MMEGI identifying the DCN serving a particular UE usage type as specified in 3GPP TS 23.401[11]; +- 5GS to EPS handover using N26 interface to select an MME, as specified in clause 4.11.1.2.1 of 3GPP TS 23.502 [29]; or +- EPS to 5GS handover using N26 interface to select an AMF, as specified in clause 4.11.1.2.2 of 3GPP TS 23.502 [29]. + +In the 'Inter eNodeB handover with MME relocation' procedure, the 'UTRAN Iu mode to E-UTRAN Inter RAT handover' procedure, the 'GERAN A/Gb mode to E-UTRAN Inter RAT handover' procedure, the 'UTRAN/GERAN to E-UTRAN SRVCC' procedure, the 5GS to EPS handover using N26 interface, the MME is selected based on the target cell where the UE is expected to move into. The MME has the new target eNodeB cell ID (eCID) and TAI available. The TAI includes the TAC, the MNC and the MCC. + +In the EPS to 5GS handover using N26 interface procedure, the AMF is selected based on the target 5GS TAI received from the source eNB. The 5GS TAI includes the 5GS TAC, the MNC and the MCC. + +In the 'IMSI and APN Information retrieval' procedure, the MME is selected based on the TAI of the cell or eNodeB that is congested in the user plane. The RCAF has the congested eNodeB cell ID (eCID) and TAI available. The TAI includes the TAC, the MNC and the MCC. + +The S-NAPTR procedure for finding a candidate set of MME nodes for a target TAI is always started at the TAI FQDN as defined in clause 19.4.2.3 of 3GPP TS 23.003 [4]. The S-NAPTR procedure performed at the source MME/S4-SGSN/AMF for finding a candidate set of target MME nodes is started with at least the "Service Parameters" of + +"x-3gpp-mme:x-s10" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4]. + +The S-NAPTR procedure for finding a candidate set of AMFs for a target 5GS TAI shall be started at the 5GS TAI FQDN as defined in clause 28.3.2.6 of 3GPP TS 23.003 [4]. The S-NAPTR procedure performed at the source MME for finding a candidate set of target AMF nodes is started with at least the "Service Parameters" of + +"x-3gpp-mme:x-s10" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4]. + +Additional requirements to support DCN are specified in clause 5.8. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This is a "candidate" list of MMEs (or AMFs) for that TAI (or 5GS TAI) (see Annex C.2 for a more detailed description of a candidate list). + +Topological closeness shall not be used for the MME selection so the MME candidate list would be used in the order given to try to contact a MME. + +NOTE 1: The source MME/S4-SGSN may wish to preferentially select a target MME that is co-located with a SGSN function based on an operator policy. The S-NAPTR procedure using the canonical node name (clause 4.3.3) may be used to find any co-located SGSN interfaces in the candidate list. Optionally an operator may provision NAPTR records with "x-3gpp-sgsn:x-gn" and/or "x-3gpp-sgsn:x-s4" at the TAI FQDN to allow an MME to directly get a candidate list for the co-located SGSN and hence for the source MME to match node names from the hostnames in the two candidate lists. + +NOTE 2: If an operator does not use the "a" and "s" flags in the TAI NAPTR records (i.e. they use the "" flag) it is strongly recommended that the TAI NAPTR records point directly to NAPTR records at mmegei.mme.epc.mnc.mcc.3gppnetwork.org (i.e. an MME pool ) + +NOTE 3: The above procedures for discovering and selecting an AMF are identical to the procedures specified for discovering and selecting an MME but using a 5GS TAI FQDN instead of a TAI FQDN; they can be used by MMEs not upgraded to support the procedure specified in clause 5.4A, during an EPS to 5GS handover using N26 interface. In this case, AMFs are provisioned in DNS as MMEs, following the mapping rules specified for EPS interworking with 5GS in clause 2.10.2 of 3GPP TS 23.003 [4]. + +For an S4-SGSN making the selection the "Service Parameter" of "x-3gpp-mme:x-s3" shall be employed instead of "x-3gpp-mme:x-s10". + +Additional requirements to support DCN are specified in clause 5.8. + +For an MSC making the selection the "Service Parameter" of "x-3gpp-mme:x-sv" shall be employed instead of "x-3gpp-mme:x-s10". + +For an RCAF making the selection of an MME the "Service Parameter" of "x-3gpp-mme:x-nq" shall be employed. + +An SGSN supporting only Gn/Gp may also optionally use this procedure with "Service Parameter" of "x-3gpp-mme:x-gn" in the '3G Gn/Gp SGSN to MME Combined Hard Handover and SRNS Relocation' procedure as specified in Annex D.3.4 of 3GPP TS 23.401 [11]. + +Additional requirements to support DCN are specified in clause 5.8. + +NOTE 4: The SGSN supporting only Gn/Gp need map the eNodeB id to the RNC id to avoid updating the Target ID IE in the GTPv1 Forward Relocation Request message. + +For the case when a UE is moving from a pre-Release-8 UTRAN/GERAN to an MME the pre-Release-8 source node will not be able to use the .3gppnetwork.org based records. As a result the MME being selected looks like a pre-Release-8 SGSN to a pre-Release-8 node performing a selection. For pre-Release 8 compatibility, operators would continue to provision A/AAAA records as per Annex C.1 of 3GPP TS 23.003 [4] for the corresponding MME Gn/Gp interfaces under the RNC-ID corresponding to the mapped target ID value (see clause D.3.4 of 3GPP TS 23.401 [11] and clause 5.5.3 of the present document). + +In the RAN Information Management (RIM) procedure, the MME is selected based on the Target eNodeB Identifier specified by source RAN node. + +## 5.4A Procedures for Discovering and Selecting an AMF with N26 interface + +These procedures can be used as part of: + +- EPS to 5GS handover using N26 interface to select an AMF, as specified in clause 4.11.1.2.2 of 3GPP TS 23.502 [29]. + +In the EPS to 5GS handover using N26 interface procedure, the AMF is selected based on the target 5GS TAI received from the source eNB. The 5GS TAI includes the 5GS TAC, the MNC and the MCC. + +The S-NAPTR procedure for finding a candidate set of AMFs for a target 5GS TAI shall be started at the 5GS TAI FQDN as defined in clause 28.3.2.6 of 3GPP TS 23.003 [4]. The S-NAPTR procedure performed at the source MME for finding a candidate set of target AMF nodes is started with at least the "Service Parameters" of + +"x-3gpp-amf:x-n26" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4]. + +Additional requirements to support DCN are specified in clause 5.8. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This is a "candidate" list of AMFs for that 5GS TAI (see Annex C.2 for a more detailed description of a candidate list). + +### 5.4B Procedures for Discovering and Selecting an MME\_SRVCC + +These procedures can be used as part of: + +- 5G-SRVCC from NG-RAN to UTRAN procedure to select an MME\_SRVCC, as specified in clause 6.5 of 3GPP TS 23.216 [20]. + +In the 5G-SRVCC from NG-RAN to UTRAN procedure, the MME\_SRVCC is selected based on the Target ID received from the source NG-RAN. The Target ID includes the Target RNC ID. + +The S-NAPTR procedure for finding a candidate set of MME\_SRVCCs for a Target RNC ID shall be started at the Target RNC ID for UTRAN FQDN as defined in clause 19.4.2.7 of 3GPP TS 23.003 [4]. The S-NAPTR procedure performed at the source AMF for finding a candidate set of target MME\_SRVCC nodes is started with at least the "Service Parameters" of + +"x-3gpp-mme:x-s10" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4]. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This is a "candidate" list of MME\_SRVCCs for that Target RNC ID (see Annex C.2 for a more detailed description of a candidate list). + +## 5.5 Procedures for Discovering and Selecting an SGSN + +### 5.5.1 General + +These procedures are employed: + +- when a target SGSN that serves the target cell or RNC needs to be initially selected by an EPC core node or Release-8 SGSN or an MSC. It explicitly does not cover selection of an SGSN by a RNC or BSS; +- as part of the UTRAN/GERAN to UTRAN (HSPA) SRVCC procedure to select an SGSN as specified in 3GPP TS 23.216 [20]; or +- for APN Information retrieval procedure for RAN User Plane Congestion mitigation to select an SGSN as specified in clause 6.17 of 3GPP TS 23.060[18]. +- NAS Message Redirection procedure to retrieve Null-NRI or the SGSN Group ID identifying the DCN serving a particular UE usage type as specified in 3GPP TS 23.401[11]. + +Clause 4.3.3.5 "Services of an SGSN from a P-TMSI" specifies how a target MME/S4-SGSN discovers the IP address of the source SGSN during Idle Mode Mobility from GERAN /UTRAN. + +EPC core nodes, i.e. the MME and the S4-SGSN employ the procedures below during the SRNS relocation procedure and the RAN Information Management (RIM) procedure. A Release-8 SGSN supporting only Gn/Gp may also optionally use this procedure. An MSC supporting UTRAN/GERAN to UTRAN (HSPA) SRVCC procedure to select an SGSN may also use this procedure as specified in 3GPP TS 23.216 [20]. + +The SGSN is selected based on information in the Target ID (see 3GPP TS 23.003 [4] and 3GPP TS 25.413 [12]). For PS GERAN the Target ID has the global cell ID including PLMN and for U-TRAN the Target ID has RAC, RNC-ID and PLMN. + +For the Fallback to GTPv1 scenario as specified in 3GPP TS 29.274 [23] clause 7.10, the new SGSN/MME shall send the related GTPv1 request message with the peer SGSN IP address on the Gn/Gp interface after receiving the GTPv2 response message with Cause "Fallback to GTPv1". The new MME/SGSN shall make another DNS query to obtain the peer SGSN IP address on the Gn/Gp interface if that address is not available. The A/AAAA query shall be used to obtain the peer SGSN IP address on the Gn/Gp interface. + +### 5.5.2 SGSN initial target selection based on RAI (UTRAN target/GERAN Iu mode target/GERAN Gb mode target) + +In both U-TRAN and GERAN cases the target RAC, LAC, MNC, and MCC are available from the information in the Target ID. This selection is done by an MME or Release-8 SGSN during SRNS relocation procedures and the RAN Information Management (RIM) procedures. + +The S-NAPTR procedure for an MME/SGSN finding a candidate set of SGSN services and interfaces serving the target Routing Area is started with "Service Parameters" of + +"x-3gpp-sgsn:x-gn", "x-3gpp-sgsn:x-gp", "x-3gpp-sgsn:x-s3", "x-3gpp-sgsn:x-nqprime" + +Additional requirements to support DCN are specified in clause 5.8. + +as defined in 3GPP TS 23.003 [4] and setting the Application-Unique String to the RAI FQDN based on RAC, LAC, MNC, MCC as defined in 3GPP TS 23.003 [4] clause 19.4.2.5: + +rac.lac.rac.epc.mnc.mcc.3gppnetwork.org + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This is a "candidate" list of SGSN for that RAI (see Annex B for S-NAPTR procedure and see Annex C.2 for a more informative description of a candidate list). + +NOTE 1: In the SRNS relocation procedure, for an MME making the selection there is an existing PDN connection (and hence an existing SGW) so the S3 interfaces would logically be preferred over the Gn/Gp interfaces to keep the existing PDN connection. However, if there is a colocated PGW/GGSN being employed with the 3GPP TS 23.401 [11] Annex D procedures then the Gn/Gp interfaces on the target SGSN can also be valid. Operators should prioritize the DNS records according to their preference. + +For an S4-SGSN making the selection the "Service Parameter" of "x-3gpp-sgsn:x-s16" shall be employed instead of "x-3gpp-sgsn:x-s3". + +Additional requirements to support DCN are specified in clause 5.8. + +For an MSC making the selection the "Service Parameter" of "x-3gpp-sgsn:x-sv" shall be employed instead of "x-3gpp-sgsn:x-s3". + +For an RCAF making the selection of an SGSN the "Service Parameter" of "x-3gpp-sgsn:x-nqprime" shall be employed. + +A Release 8 SGSN supporting only Gn/Gp may also optionally use this procedure with "Service Parameters" of "x-3gpp-sgsn:x-gn" and "x-3gpp-sgsn:x-gp". + +Additional requirements to support DCN are specified in clause 5.8. + +Operators shall provision, for each RAI value in their network, NAPTR records under the RAI FQDN corresponding to each valid SGSN interfaces from at least the following "Service Parameters" + +"x-3gpp-sgsn:x-gn", "x-3gpp-sgsn:x-gp", "x-3gpp-sgsn:x-s3", "x-3gpp-sgsn:x-s16", "x-3gpp-sgsn:x-nqprime" + +Additional requirements to support DCN are specified in clause 5.8. + +where NAPTR records for additional "Service Parameters" may be included optionally. + +NOTE 2: The NAPTR record at the RAI FQDN can be provisioned to correspond to only the default SGSN node(s) in the SGSN pool(s) serving that RAI. The default SGSN after the DNS procedure exits would be contacted with GTP, the default SGSN then selects the actual SGSN within that SGSN pool. This results in all relocation requests being handled by the default SGSN nodes. If the operator's goal is to avoid load on the default SGSN nodes then the records provisioned at the RAI FQDN should instead include the entire set of SGSN in all SGSN pools that service that RAI. The S-NAPTR procedure would then return each SGSN in the SGSN pool based on the provisioned DNS weights and priority. + +NOTE 3: The NAPTR record at the RAI FQDN for the service parameter of "x-3gpp-sgsn:x-nqprime" is provisioned with the entire set of SGSN in all SGSN pools that are serving that RAI. + +NOTE 4: The SGSN(s) closest to the geographical region covered by the RAI can be biased by provisioning the DNS records with higher priority or weights. + +3GPP does not require that collocation and "topon" naming is applicable in SGSN selection. + +NOTE 5: Service parameters are limited to those supported by the node doing the search. + +NOTE 6: SGW records will also be provisioned under the RAI FQDN see clause 5.2 + +In the SRNS relocation procedure, for the case when a UE is moving from a pre-Release-8 UTRAN/GERAN to a Release-8 target SGSN the pre-Release-8 source node will not be able to use the .3gppnetwork.org based records. As a result the Release 8 SGSN (or MME) being selected looks like a pre-Release 8 SGSN to a pre-Release-8 node performing a selection. For pre-Release 8 compatibility operators would continue to provision A/AAAA records as per Annex C.1 of 3GPP TS 23.003 [4] for the corresponding Gn/Gp interfaces regardless of whether the SGSN is pre-Release-8 or not. Vendors shall support pre-Release 8 DNS procedures on Release 8 SGSN. + +In the RAN Information Management (RIM) procedure, the SGSN is selected based on the RAI specified by source RAN node. + +### 5.5.3 SGSN initial target selection based on RNC-ID (UTRAN target/GERAN Iu mode target) + +NOTE 1: In the SRNS relocation procedure, the finer granularity this procedure allows only applies to UTRAN/GERAN Iu mode and only when different RNC-IDs have the same RAI values. + +This procedure is used for a UTRAN/GERAN Iu mode target in the SRNS relocation procedure and the RAN Information Management (RIM) procedure. + +In UTRAN/GERAN Iu mode case the target RNC-ID, MNC, and MCC are available from the information in the Target ID. + +The S-NAPTR procedure for an MME/S4- SGSN finding a candidate set of SGSN services and interfaces serving the target RNC is started with "Service Parameters" of + +"x-3gpp-sgsn:x-gn", "x-3gpp-sgsn:x-gp", "x-3gpp-sgsn:x-s3" + +Additional requirements to support DCN are specified in clause 5.8. + +as defined in 3GPP TS 23.003 [4] and setting the Application-Unique String to the RNC-ID FQDN based on RNC-ID,MNC,MCC as defined in 3GPP TS 23.003 [4] clause 19.4.2. 5. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This is a "candidate" list of SGSN for that RNC-ID (see Annex B for S-NAPTR procedure and see Annex C.2 for a more informative description of a candidate list). + +NOTE 2: In the SRNS relocation procedure, for an MME making the selection there is an existing PDN connection (and hence an existing SGW) so the S3 interfaces would logically be preferred over the Gn/Gp interfaces to keep the existing PDN connection. However, if there is a colocated PGW/GGSN being employed with the 3GPP TS 23.401 [11] Annex D procedures then the Gn/Gp interfaces on the target SGSN can also be valid. Operators should prioritize the DNS records accordingly. + +For an S4-SGSN making the selection the "Service Parameter" of "x-3gpp-sgsn:x-s16" shall be employed instead of "x-3gpp-sgsn:x-s3". + +Additional requirements to support DCN are specified in clause 5.8. + +For an MSC making the selection the "Service Parameter" of "x-3gpp-sgsn:x-sv" shall be employed instead of "x-3gpp-sgsn:x-s3". + +A Release 8 SGSN supporting only Gn/Gp may also optionally use this procedure with "Service Parameters" of "x-3gpp-sgsn:x-gn" and "x-3gpp-sgsn:x-gp". Additional requirements to support DCN are specified in clause 5.8. If there are no NAPTR records at that RNC-ID then the RAI based lookup in clause 5.5.2 shall be used as a fallback. + +Operators using this feature shall provision, for each RNC-ID value in their network, NAPTR records under the RNC-ID FQDN corresponding to each valid SGSN interfaces from the following "Service Parameters" + +"x-3gpp-sgsn:x-gn", "x-3gpp-sgsn:x-gp", "x-3gpp-sgsn:x-s3", "x-3gpp-sgsn:x-s16", + +Additional requirements to support DCN are specified in clause 5.8. + +where NAPTR records for additional "Service Parameters" may be included optionally. + +Operators not using this feature shall not provision the RNC-ID records. + +NOTE 3: The NAPTR record at the RNC-ID FQDN can be provisioned to correspond to only the default SGSN node(s) in the SGSN pool(s) serving that RNC. The default SGSN after the DNS procedure exits would be contacted with GTP, the default SGSN then selects the actual SGSN within that SGSN pool. This results in all relocation requests being handled by the default SGSN nodes. If the operator's goal is to avoid load on the default SGSN nodes then the records provisioned at the RNC-ID FQDN should instead include the entire set of SGSN in all SGSN pools that service that RNC. The S-NAPTR procedure would then return each SGSN in the SGSN pool based on the provisioned DNS weights and priority. + +NOTE 4: The SGSN(s) closest to the geographical region serving the RNC can be biased by provisioning the DNS records with higher priority or weights. + +3GPP does not require that collocation and "topon" naming is applicable in SGSN selection. + +NOTE 5: Service parameters are limited to those supported by the node doing the search. + +In the SRNS relocation procedure, for the case when a UE is moving from a pre-Release-8 UTRAN/GERAN to a Release-8 target SGSN the pre-Release-8 source node will not be able to use the .3gppnetwork.org based records. As a result the target Release-8 SGSN (or MME) looks like a pre-Release-8 SGSN to a pre-Release-8 source node. For pre-Release 8 compatibility operators would continue to provision A/AAAA records as per Annex C.3 of 3GPP TS 23.003 [4] for the corresponding Gn/Gp interfaces regardless of whether the target SGSN is pre-Release-8 or not. Vendors shall support pre-Release 8 DNS procedures on Release 8 SGSN. + +In the RAN Information Management (RIM) procedure, the SGSN is selected based on the RNC-ID specified by source RAN node. + +### 5.5.4 Void + +## 5.6 GW Selection for SIPTO + +### 5.6.1 SIPTO above RAN + +DNS procedures defined in the clause 5 in this specification also apply for the GW selection for SIPTO service. + +The S-NAPTR based selection of the SGW (based on TAI, eNodeB-ID, RAI, or RNC-ID) gives the shortest user plane path from the UE to the SGW from the S-NAPTR ordering. Topological naming should be employed (as specified in clause 4.3.2) to find the shortest user plane path from the SGW to the PGW based on the topological closeness. With this approach, the MME or SGSN can select an SGW and PGW to achieve the shortest user plane path to the UE for a SIPTO enabled APN. + +The S-NAPTR based selection of the GGSN gives the shortest user plane path from the UE to the GGSN from the S-NAPTR ordering. When the network supports Direct Tunnel, separate S-NAPTR procedures should be used, with APN FQDN and then with RAI FQDN or RNC-ID FQDN, to retrieve a list of candidates respectively, the common one from the S-NAPTR ordering should be selected. + +### 5.6.2 SIPTO at the local network with LGW collocated with the (H)(e)NB + +The LGW shall reside in the local network and be collocated with the (H)(e)NB. The MME/SGSN shall use the LGW address proposed by the (H)(e)NB in the S1-AP/RANAP message, instead of selecting the PGW via DNS interrogation as specified in clause 5. + +The SGW shall remain in the mobile operator's core network, i.e. collocation of the SGW and LGW is not applicable. + +DNS procedures defined in the clause 5 in this specification apply for the SGW selection (i.e. based on TAI, eNodeB-ID, RAI, or RNC-ID). + +**Editor's Note: procedures for Gn SGSN are FFS.** + +### 5.6.3 SIPTO at the local network with stand-alone GW (LGW collocated with SGW) + +The stand-alone GW shall reside in the local network and be collocated with the SGW. + +DNS procedures defined in the clause 5 in this specification also apply for the GW selection for SIPTO service with the following additions. + +The MME/SGSN shall use the Local (H)(e)NB Network ID provided by the (H)(e)NB in the S1-AP/RANAP message to discover the SGW via the DNS. The S-NAPTR based selection of the SGW (based on the Local (H)(e)NB Network + +ID) gives the shortest user plane path from the UE to the SGW from the S-NAPTR ordering. Topological naming should be employed (as specified in clause 4.3.2) to find collocated SGW and LGW. + +NOTE: Based on operator policy, the MME/SGSN can select a local SGW (based on the Local (H)(e)NB Network ID) at UE attachment to the (H)eNB regardless of whether a SIPTO at the local network PDN connection is established or not (see TS 23.401 clause 4.3.15.2). + +### 5.6.4 SIPTO for eHRPD + +For the support of the SIPTO service for eHRPD access, topological naming should be employed (as specified in clause 4.3.2) to find the shortest user plane path from the HSGW to the PGW based on the topological closeness. With this approach, the HSGW can select a PGW to achieve the shortest userplane to the UE for a SIPTO enabled APN. Details related to SIPTO support for eHRPD access are specified in 3GPP2 X.S0057 [24] and 3GPP TS 23.402 [25]. + +## 5.7 Procedures for Discovering and Selecting an MSC Server + +### 5.7.1 General + +These procedures are employed when a target MSC Server that serves the target cell or RNC needs to be initially selected by an EPC core node or Release-8 SGSN for the SRVCC operation. It explicitly does not cover selection of an MSC Server by a RAN node nor the selection of an MSC server at an SRNS relocation. + +EPC core nodes, i.e. the MME and the S4-SGSN employ the procedures below during the PS-to-CS relocation procedure for the SRVCC operation. A Release-8 SGSN supporting only Gn/Gp may also optionally use this procedure. + +The MSC server enhanced for SRVCC is selected based on information received in the Target ID from the source E-UTRAN or UTRAN (see 3GPP TS 23.003 [4], 3GPP TS 25.413 [12] and 3GPP TS 36.413 [21]). + +### 5.7.2 Selection of the MSC server enhanced for SRVCC based on target RAI (UTRAN / GERAN Iu & A/Gb mode target) + +In SRVCC operations towards UTRAN and GERAN, the target MCC, MNC, LAC and optionally the RAC are available from the information in the Target ID. + +The S-NAPTR procedure for an MME/SGSN finding the MSC Sv service and interfaces serving the target Routing Area is started with "Service Parameters" of + +"x-3gpp-msc:x-sv" + +as defined in 3GPP TS 23.003 [4] and setting the Application-Unique String to the RAI FQDN based on RAC, LAC, MNC, MCC as defined in 3GPP TS 23.003 [4] clause 19.4.2.5: + +rac.lac.rac.epc.mnc.mcc.3gppnetwork.org + +The MME/SGSN shall set the RAC to a default value, e.g. hexadecimal value 'FF', if it is not available from the information in the Target ID. + +A Release 8 SGSN supporting only Gn/Gp may also optionally use this procedure with "Service Parameters" of "x-3gpp-msc:x-sv". + +Operators shall provision, for each RAI value in their network, NAPTR records under the RAI FQDN corresponding to each valid MSC interfaces from at least the following "Service Parameters" + +"x-3gpp-msc:x-sv", + +where NAPTR records for additional "Service Parameters" may be included optionally. + +NOTE 1: The NAPTR record at the RAI FQDN can be provisioned to correspond to only the default MSC server node(s) in the MSC pool(s) serving that RAI. The default MSC Server would be contacted with GTP, the default MSC server then selects the actual MSC Server within that MSC Server pool. This results in all SRVCC PS to CS service requests being handled by the default MSC Server nodes. If the operator's goal is to avoid load on the default MSC Server nodes then the records provisioned at the RAI FQDN should instead include the entire set of MSC Servers in all MSC Server pools that service that RAI. The S-NAPTR procedure would then return each MSC Server in the MSC Server pool based on the provisioned DNS weights and priority. + +NOTE 2: The MSC Server closest to the geographical region covered by the RAI can be biased by provisioning the DNS records with higher priority or weights. + +3GPP does not require that collocation and "topon" naming is applicable in MSC Server selection. + +NOTE 3: Service parameters are limited to those supported by the node doing the search. + +NOTE 4: SGW records will also be provisioned under the RAI FQDN see clause 5.2 + +## 5.8 Procedures to support Dedicated Core Networks + +### 5.8.1 General + +These procedures shall be employed in PLMNs deploying DCNs for: + +- discovering and selecting an SGW, PGW or GGSN in a DCN serving a particular UE usage type; +- retrieving the MMEGI or Null-NRI/SGSN Group ID to identify the DCN serving a particular UE usage type and to determine whether to perform a NAS Message Redirection procedure (see clause 5.19.1 of 3GPP TS 23.401 [11]); +- discovering and selecting a target MME or SGSN serving a particular UE usage type during a handover procedure with a MME or SGSN change. + +DNS procedures to support DCNs shall be supported as specified in the rest of the specification, with the additions specified in the following clauses. + +The UE usage type used during DNS procedure shall be the one mapped from the UE Usage Type received from the HSS as part of the subscription, based on the serving network operator configured policies and the UE related context information available at the serving network, e.g. information about roaming. + +### 5.8.2 SGW, PGW and GGSN Selection Procedure + +The S-NAPTR procedure employed to discover and select an SGW, PGW or GGSN in a DCN shall use the Application-Unique String set to the FQDN specified in the rest of this specification, e.g. with the APN-FQDN for PGW selection or with the TAI/eNodeB-ID/RAI/RNC-ID FQDN for SGW selection, and use the enhanced "Service Parameters" as specified in clause 19.4.3 of 3GPP TS 23.003 [4], i.e. appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type for which the discovery and selection procedure is performed. + +For example, the MME or S4-SGSN shall discover all GTP based S8 interfaces using "Service Parameters" of + +"x-3gpp-pgw:x-s8-gtp+ue-" + +Operators shall provision corresponding NAPTR records for these FQDNs, with enhanced "Service Parameters" appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type(s) for which the record applies. + +The S-NAPTR procedure shall logically output a candidate list of SGWs, PGWs or GGSNs serving at least the requested UE usage type, according to the general principles specified in clause 4.3.3.2.1 and Annex B.3. If no candidate SGW, PGW or GGSN is found for the requested UE usage type, possibly also after using local configuration, the procedure shall be performed with Service Parameters without the "+ue-" appended to the 'app-protocol' name. + +NOTE 1: This is required to discover and select an SGW, PGW or GGSN when no dedicated SGW, PGW or GGSN is configured for a particular UE usage type and FQDN. + +As an exception to the above requirement if no candidate SGW, PGW or GGSN is found for the requested UE usage type for the selection of an SGW, PGW or GGSN in the same PLMN, the MME/SGSN, TWAN or ePDG may decide not to perform an S-NAPTR procedure with Service Parameters without the "+ue-" appended to the 'app-protocol' name if so configured by operator policies and abort the selection procedure. + +NOTE 2: This can avoid selecting an SGW, PGW or GGSN not intended to support specific UE usage type. + +Annex A.4 provides examples of DNS provisioning for SGW and PGW discovery and selection procedures in a DCN, and examples of procedures for discovery and selection of SGW/PGW. + +### 5.8.3 MMEGI and Null-NRI/SGSN Group ID Retrieval Procedure + +To retrieve the MMEGI identifying the DCN serving a particular UE usage type, the S-NAPTR procedure shall use the Application-Unique String set to the TAI FQDN as defined in clause 19.4.2.3 of 3GPP TS 23.003 [4] and use the enhanced service parameters as specified in clause 19.4.3 of 3GPP TS 23.003 [4], i.e. appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type for which the discovery and selection procedure is performed. The MME shall discover the MMEGI for a particular UE usage type by using the "Service Parameters" of + +"x-3gpp-mme:x-s10+ue-" + +To retrieve the Null-NRI/SGSN Group ID identifying the DCN serving a particular UE usage type, the S-NAPTR procedure shall use the Application-Unique String set to the RAI FQDN as defined in clause 19.4.2.5 of 3GPP TS 23.003 [4] and use the enhanced service parameters as specified in clause 19.4.3 of 3GPP TS 23.003 [4], i.e. appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type for which the discovery and selection procedure is performed. Gn/Gp SGSN shall discover the Null-NRI/SGSN Group ID for a particular UE usage type by using "Service Parameters" of + +"x-3gpp-sgsn:x-gn+ue-" + +S4-SGSN shall discover the Null-NRI/SGSN Group ID for a particular UE usage type by using "Service Parameters" of + +"x-3gpp-sgsn:x-s16+ue-" + +Operators shall provision corresponding NAPTR records for these FQDNs, with enhanced "Service Parameters" appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type(s) for which the record applies. The MMEGI or Null-NRI/SGSN Group ID shall be provisioned in the host name of these records. The MMEGI or Null-NRI/SGSN Group ID shall be retrieved from the host name. + +The NAPTR records associated to the TAI FQDN shall be provisioned with a host name in the replacement part, as specified in 4.3.2, having the canonical-node-name start as: + +mme.mmegei + +The NAPTR records associated to the RAI FQDN shall be provisioned with a host name in the replacement part, as specified in 4.3.2, having the canonical-node-name start as: + +nri-sgsn.null-nri + +The NAPTR records associated to the RAI FQDN shall be provisioned with a host name in the replacement part, as specified in 4.3.2, having the canonical-node-name start as: + +nri-sgsn.sgsngi + + and shall be Hex coded digits representing the Null-NRI code of the SGSNs and SGSN Group ID respectively (see 3GPP TS 25.413 [12]). If there are less than 4 significant digits in and , one or more "0" digit(s) is/are inserted at the left side to fill the 4 digit coding respectively. Coding for other fields is the same as specified in 3GPP TS 23.003 [4]. + +NOTE 1: Annex A provides examples of the MMEGI and Null-NRI/SGSN Group ID retrieval procedures. + +### 5.8.4 MME and SGSN Selection Procedure + +The S-NAPTR procedure employed to discover and select an MME or SGSN serving a particular UE usage type, during a handover procedure with a MME or SGSN change, shall use the Application-Unique String set to the FQDN specified in the rest of this specification, e.g. with the TAI-FQDN for MME selection or with an RAI or RNC-ID FQDN for SGSN selection, and use the enhanced "Service Parameters" as specified in clause 19.4.3 of 3GPP TS 23.003 [4], i.e. appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type for which the discovery and selection procedure is performed. + +For example, the procedure for an MME to find a candidate set of target MMEs makes use of the "Service Parameters" of: + +"x-3gpp-mme:x-s10+ue-" + +and the procedure for an MME to find a candidate set of target SGSNs makes use of the "Service Parameters" of: + +"x-3gpp-sgsn:x-s3+ue-" + +Operators shall provision corresponding NAPTR records for these FQDNs, with enhanced "Service Parameters" appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type(s) for which the record applies. + +The S-NAPTR procedure shall logically output a candidate list of MMEs and SGSNs serving at least the requested UE usage type, according to the general principles specified in clause 4.3.3.2.1 and Annex B.3. If no candidate MME or SGSN is found for the requested UE usage type, possibly also after using local configuration, the procedure shall be performed with Service Parameters without the "+ue-" appended to the 'app-protocol' name. + +NOTE 1: This is required to discover and select an MME or SGSN when no dedicated MME or SGSN is configured for a particular UE usage type and FQDN. + +As an exception to the above requirement if no candidate MME or SGSN is found for the requested UE usage type for the selection of an MME or SGSN in the same PLMN, the MME/SGSN may decide not to perform an S-NAPTR procedure with Service Parameters without the "+ue-" appended to the 'app-protocol' name if so configured by operator policies and abort the selection procedure. + +NOTE 2: This can avoid selecting an MME or SGSN not intended to support specific UE usage types. + +Annex A.4 provides examples of DNS provisioning for MME discovery and selection procedures in a DCN. + +### 5.8.5 AMF Selection Procedure + +The S-NAPTR procedure employed to discover and select an AMF serving a particular UE usage type, during a EPS to 5GS handover using N26 interface procedure, shall use the Application-Unique String set to the FQDN specified in the rest of this specification, e.g. with the 5GS TAI-FQDN for AMF selection, and use the enhanced "Service Parameters" as specified in clause 19.4.3 of 3GPP TS 23.003 [4], i.e. appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type for which the discovery and selection procedure is performed. + +For example, the procedure for an MME to find a candidate set of target AMFs with N26 interface makes use of the "Service Parameters" of: + +"x-3gpp-amf:x-n26+ue-" + +Operators shall provision corresponding NAPTR records for these FQDNs, with enhanced "Service Parameters" appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type(s) for which the record applies. + +The S-NAPTR procedure shall logically output a candidate list of AMFs serving at least the requested UE usage type, according to the general principles specified in clause 4.3.3.2.1 and Annex B.3. If no candidate AMF is found for the requested UE usage type, possibly also after using local configuration, the procedure shall be performed with Service Parameters without the "+ue-" appended to the 'app-protocol' name. + +NOTE 1: This is required to discover and select an AMF when no dedicated AMF is configured for a particular UE usage type and FQDN. + +As an exception to the above requirement if no candidate AMF is found for the requested UE usage type for the selection of an AMF in the same PLMN, the MME may decide not to perform an S-NAPTR procedure with Service Parameters without the "+ue-" appended to the 'app-protocol' name if so configured by operator policies and abort the selection procedure. + +NOTE 2: This can avoid selecting an AMF not intended to support specific UE usage types. + +## 5.9 Procedures to support Cellular Internet of Things + +### 5.9.1 DCN based solution + +When DCN is supported in the network, the node performing the selection function may use the DNS procedures enhanced for supporting DCNs as specified in clause 5.8, to select an EPC entity, e.g. an SGW or PGW, which supports CIoT by configuring a specific UE Usage Type(s) for CIoT. + +For a MS requesting a PDN Connection of type "Non-IP", the S4-SGSN may use the DNS procedures enhanced for supporting DCNs as specified in clause 5.8, to select an EPC entity, e.g. an SGW or PGW, which supports this PDN Connection of type "Non-IP" by configuring a specific UE Usage Type. + +For a MS requesting a PDP Context of type "Non-IP", the Gn/Gp-SGSN may use the DNS procedures enhanced for supporting DCNs as specified in clause 5.8, to select a GGSN which supports this PDP Context of type "Non-IP" by configuring a specific UE Usage Type. + +### 5.9.2 Alternative solution + +The SGSN shall use the DNS procedures specified in this specification for selecting a GGSN or PGW supporting the Non-IP PDN Type without any change. The GGSNs or PGWs configured in the DNS for an APN which can be used for a Non-IP PDN connection shall all support the Non-IP PDN type. + +The MME shall use the DNS procedures specified in this specification for selecting a PGW optimised for CIoT without any change. The PGWs configured in the DNS for an APN which can be used for NB-IoT access or for a Non-IP PDN connection shall all support NB-IoT or the Non-IP PDN type respectively. + +The MME or SGSN shall select an SGW optimised for CIoT, using the DNS procedures for selecting an SGW specified in clauses 5.2 and 5.3, but retaining then one SGW, from the candidate SGWs list, which is also known to support of CIoT. The MME or SGSN knows whether an SGW supports CIoT via the Notification of Supported features over the S11 or S4 interface (for the CIoT feature), as specified in 3GPP TS 29.274 [23]. + +A source MME or SGSN shall select a target MME or SGSN, during a handover procedure for a UE supporting some CIoT EPS Optimisations, using the DNS procedures for selecting an MME or SGSN during a handover procedure specified in clause 5.4 or 5.5, but retaining then one target MME or SGSN, from the candidate target MME or SGSN list, which is also known by local configuration to support at least one CIoT EPS optimisation. The selected target MME or SGSN may forward the Forward Relocation Request to another MME or SGSN in the target MME or SGSN pool, as specified in 3GPP TS 29.274 [23]. + +## 5.10 Procedures for Discovering and Selecting an SGW-U + +These procedures shall be employed when an SGW-U needs to be selected by an SGW-C and the SGW-C supports the UP selection function based on DNS specified in Annex B.2.6 of 3GPP TS 29.244 [26]. + +Operators shall provision, for each TAI/eNodeB-ID/RAI/RNC-ID value in their network, NAPTR records under the TAI/eNodeB-ID/RAI/RNC-ID FQDN corresponding to each UP function serving as an SGW-U with the following "Service Parameters": + +"x-3gpp-upf:x-sxa" + +where additional "Service Parameters" may be included optionally. + +When DCN is deployed, operators shall provision corresponding NAPTR records for these FQDNs, with enhanced "Service Parameters" appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type(s) for which the record applies: + +"x-3gpp-upf:x-sxa+ue-" + +The SGW-C may select a specific SGW-U for UE supporting a particular network capability (see clause 5.x). Operators shall provision corresponding NAPTR records for these FQDNs, with enhanced "Service Parameters" appending the character string "+nc-" to the 'app-protocol' name as follows: + +"x-3gpp-upf:x-sxa+nc-" + +To discover and select an SGW-U, the SGW-C shall use S-NAPTR procedure with the "Service Parameters" of: + +"x-3gpp-upf:x-sxa" + +and the TAI/eNodeB-ID/RAI/RNC-ID FQDN as the Application-Unique String. See clause 19.4 of 3GPP TS 23.003 [4]. + +The S-NAPTR procedure logically outputs a list of host names each coupled with a service, a protocol, a port, and a list of IPv4 and IPv6 addresses. This is the "candidate" list of SGW-U's for a given TAI/eNodeB-ID/RAI/RNC-ID. + +When DCN is deployed, the S-NAPTR procedure employed to discover and select an SGW-U shall use the Application-Unique String set to the TAI/eNodeB-ID/RAI/RNC-ID FQDN, and use the enhanced "Service Parameters" as specified in clause 19.4.3 of 3GPP TS 23.003 [4], i.e. appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type for which the discovery and selection procedure is performed. + +For example, the SGW-C shall discover a UP function capable to serve as a SGW-U using the "Service Parameters" of: + +"x-3gpp-upf:x-sxa+ue-" + +The S-NAPTR procedure employed to discover and select an SGW-U shall use the Application-Unique String set to the TAI/eNodeB-ID/RAI/RNC-ID FQDN, and use the enhanced "Service Parameters" as specified in clause 19.4.3 of 3GPP TS 23.003 [4], i.e. appending the character string "+nc-" to the 'app-protocol' name identifying specific SGW-U supporting a particular network capability. + +For example, the SGW-C shall discover a UP function capable to serve as a SGW-U using the "Service Parameters" of: + +"x-3gpp-upf:x-sxa+nc-" + +## 5.11 Procedures for Discovering and Selecting PGW-U + +These procedures shall be employed when a PGW-U needs to be selected by an PGW-C and the PGW-C supports the UP selection function based on DNS specified in Annex B.2.6 of 3GPP TS 29.244 [26]. + +Operators shall provision, for each APNs configured in their network, NAPTR records under the APN FQDN corresponding to each UP function serving as a PGW-U with the following "Service Parameters": + +"x-3gpp-upf:x-sxb" + +where additional "Service Parameters" may be included optionally. See clause 19.4.2.2 of 3GPP TS 23.003 [4]. + +When DCN is deployed, operators shall provision corresponding NAPTR records for these FQDNs, with enhanced "Service Parameters" appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type(s) for which the record applies: + +"x-3gpp-upf:x-sxb+ue-" + +The PGW-C may select a specific PGW-U supporting a particular network capability (see clause 5.x). Operators shall provision corresponding NAPTR records for these FQDNs, with enhanced "Service Parameters" appending the character string "+nc-" to the 'app-protocol' name, the following record applies: + +"x-3gpp-upf:x-sxb+nc-" + +To discover and select a PGW-U, the PGW-C shall use S-NAPTR procedure with the "Service Parameters" of: + +"x-3gpp-upf:x-sxb" + +and the APN FQDN as the Application-Unique String. + +The S-NAPTR procedure logically outputs a list of host names each coupled with a service, a protocol, a port, and a list of IPv4 and IPv6 addresses. This is the "candidate" list of PGW-U's for a given APN. + +When DCN is deployed, the S-NAPTR procedure employed to discover and select an PGW-U shall use the Application-Unique String set to the APN FQDN, and use the enhanced "Service Parameters" as specified in clause 19.4.3 of 3GPP TS 23.003 [4], i.e. appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type for which the discovery and selection procedure is performed. + +For example, the PGW-C shall discover a UP function capable to serve as a PGW-U using the "Service Parameters" of: + +"x-3gpp-upf:x-sxb+ue-". + +The S-NAPTR procedure employed to discover and select an PGW-U shall use the Application-Unique String set to the APN FQDN, and use the enhanced "Service Parameters" as specified in clause 19.4.3 of 3GPP TS 23.003 [4], i.e. appending the character string "+nc-" to the 'app-protocol' name identifying specific PGW-U supporting a particular network capability. + +For example, the PGW-C shall discover a UP function capable to serve as a PGW-U using the "Service Parameters" of: + +"x-3gpp-upf:x-sxb+nc-". + +## 5.12 Procedures to select a node supporting a particular network capability + +### 5.12.1 General principles + +#### 5.12.1.1 General + +Operators may need to discover and select a network node supporting a particular network capability. + +DNS procedures to select a node supporting a particular network capability shall be supported as specified in the rest of the specification, with the additions specified in clause 5.12. The following clauses also further define the specific network capabilities for which these procedures may be used. + +Enhanced "Service Parameters" as specified in clause 19.4.3 of 3GPP TS 23.003 [4] may be used to select a network node with a particular network capability, by appending the character string "+nc-" to the 'app-protocol' name. + +Operators shall provision corresponding NAPTR records for these FQDNs, with enhanced "Service Parameters" appending the character string "+nc-" to the 'app-protocol' name identifying the network capability(s) for which the record applies. + +The S-NAPTR procedure shall logically output a candidate list of network nodes supporting at least the requested network capability, according to the general principles specified in clause 4.3.3.2.1, Annex B.4. If no candidate network nodes are found for the requested network capability, possibly also after using local configuration, the procedure shall be performed with Service Parameters without the "+nc-" appended to the 'app-protocol' name. + +NOTE 1: This is required to discover and select a network node when no dedicated network node is configured for a particular network capability. + +As an exception to the above requirement if no network node is found for the requested network capability for the selection of a network node in the same PLMN, e.g. the SGW and PGW in the same PLMN, the node performing the node selection may decide to not perform an S-NAPTR procedure with Service Parameters listed in the above requirement, if so configured by operator policies, and abort the selection procedure. + +NOTE 2: This can avoid selecting a network node not supporting a particular network capability. + +#### 5.12.1.2 Selecting a node supporting a particular network capability within a Dedicated Core Network + +When using Dedicated Core Networks, the selection of a node supporting a particular network capability may solely rely on the procedures specified for DCNs in clause 5.8, or combine the procedures specified in clauses 5.12 and 5.8 by using Enhanced "Service Parameters" as specified in clause 19.4.3 of 3GPP TS 23.003 [4] to select a network node with a particular network capability within a particular DCN, by appending the character string "+nc-" and "+ue-" to the 'app-protocol' name and provisioning NAPTR records accordingly. + +For example, the MME or S4-SGSN shall discover all GTP based S5/S8 interfaces using "Service Parameters" of + +"x-3gpp-pgw:x-s5-gtp+nc-+ue-", "x-3gpp-pgw:x-s8-gtp+nc-+ ue-" + +or + +"x-3gpp-pgw:x-s5-gtp+ue-+nc-", "x-3gpp-pgw:x-s8-gtp+ ue-+nc-" + +NOTE: An 'app-protocol' name appears at most once in a NAPTR record. For instance, "x-3gpp-pgw:x-s5-gtp+nc-: x-s5-gtp+ue-" is not a valid NAPTR record. + +If no candidate network nodes are found for the requested network capability and UE usage type, possibly also after using local configuration, the procedure shall be performed with Service Parameters: + +- without the "+nc-" appended to the 'app-protocol' name; +- without the "+ue-" appended to the 'app-protocol' name; +- without the "+nc-" nor the "+ue-" appended to the 'app-protocol' name. + +As an exception to the above requirement if no network node is found for the requested network capability and UE usage type for the selection of a network node in the same PLMN, e.g. the SGW and PGW in the same PLMN, the node performing the node selection may decide to not perform an S-NAPTR procedure with Service Parameters listed in the above requirement, if so configured by operator policies, and abort the selection procedure. + +#### 5.12.1.3 Selecting an SGW or PGW supporting a particular network capability + +The S-NAPTR procedure employed to discover and select an SGW and PGW supporting a particular network capability shall use the Application-Unique String set to the FQDN specified in the rest of this specification, e.g. with the APN-FQDN for PGW selection or with the TAI/eNodeB-ID/RAT/RNC-ID FQDN for SGW selection, and use the enhanced "Service Parameters" as specified in clause 19.4.3 of 3GPP TS 23.003 [4], i.e. appending the character string "+nc-" to the 'app-protocol' name. + +For example, the MME or S4-SGSN shall discover all GTP based S5/S8 interfaces using "Service Parameters" of + +"x-3gpp-pgw:x-s5-gtp+nc-", "x-3gpp-pgw:x-s8-gtp+nc-" + +Operators shall provision corresponding NAPTR records for these FQDNs, with enhanced "Service Parameters" appending the character string "+nc-" to the 'app-protocol' name. + +The S-NAPTR procedure shall logically output a candidate list of SGWs or PGWs supporting the requested network capability. If no candidate SGW and PGW is found, possibly also after using local configuration, the procedure shall be performed with Service Parameters without the "+nc-" appended to the 'app-protocol' name. + +NOTE 1: This is required to discover and select an SGW or PGW when no dedicated SGW or PGW is configured to support the requested network capability. + +As an exception to the above requirement if no candidate SGW or PGW is found to support the requested network capability for the selection of an SGW or PGW in the same PLMN, the MME or S4-SGSN may decide not to perform an S-NAPTR procedure with Service Parameters without the "+nc-" appended to the 'app-protocol' name if so configured by operator policies and abort the selection procedure. + +NOTE 2: This can avoid selecting an SGW or PGW not supporting the requested network capability. + +### 5.12.2 Procedures to support Dual Connectivity with NR + +#### 5.12.2.1 General + +An MME or SGSN may select specific SGWs and PGWs for UEs supporting dual connectivity with NR and not restricted to use NR by user subscription (see "NR as Secondary RAT Not Allowed" bit within Access Restriction Data as specified in TS 29.272 [27]) or local operator policy, e.g. due to requirements of higher bitrates, data usage reporting over the secondary RAT, etc. A UE signals its support for dual connectivity with NR to the MME and SGSN in NAS signalling. The specific SGWs and PGWs may be combined SGW/PGW functions. + +DNS procedures to support Dual Connectivity with NR shall be supported as specified in clause 5.12.1, with the following additions: + +- the shall be set to "nr". + +For example, the MME or S4-SGSN shall discover all GTP based S5/S8 interfaces using "Service Parameters" of "x-3gpp-pgw:x-s5-gtp+nc-nr", "x-3gpp-pgw:x-s8-gtp+nc-nr" + +- this network capability may apply to: + - the 'app-service' names "x-3gpp-sgw", "x-3gpp-pgw"; + - the 'app-protocol' names: "x-s5-gtp", "x-s8-gtp", "x-s11". + +### 5.12.3 Procedures to support interworking with 5GC + +#### 5.12.3.1 General + +5GS interworking procedures with EPC rely on selecting a combined PGW-C/SMF and PGW-U/UPF during the PDN connection establishment (see clause 4.11 of 3GPP TS 23.501 [28]). + +#### 5.12.3.2 PGW-C/SMF selection + +An MME and an ePDG shall select a combined PGW-C/SMF for PDN connections that may be subject to mobility to 5GS, e.g. for UEs supporting N1 mode and not restricted to interworking with 5GS by user subscription (i.e. "5GC not allowed" bit within Core-Network-Restrictions AVP is not set and Interworking-5GS-Indicator AVP is set to "SUBSCRIBED" value as specified in 3GPP TS 29.272 [27] and 3GPP TS 29.273 [30]). A UE signals its support for 5GC NAS to the MME in NAS signalling and to the ePDG in IKEv2 signalling. + +An MME and an ePDG should also select a combined PGW-C/SMF, if possible, for PDN connections of UEs not supporting N1 mode that are not restricted to access the 5GC by user subscription (i.e. "5GC not allowed" bit within Core-Network-Restrictions AVP is not set and Interworking-5GS-Indicator AVP is set to "SUBSCRIBED" value as specified in 3GPP TS 29.272 [27] and 3GPP TS 29.273 [30]). + +A PDN connection of a subscription restricted from accessing the 5GC or without 5GS interworking subscribed for the APN is not subject to mobility to 5GS and may be connected to a PGW, a PGW-C or a combined PGW-C/SMF; when PGW-C (or PGW) and combined PGW-C/SMF are available for election, the preference order may be based on operator's policy in the MME or ePDG. + +DNS procedures to select a combined PGW-C/SMF shall be supported as specified in clause 5.12.1, with the following additions: + +- the shall be set to "smf". + +For example, the MME shall discover all GTP based S5/S8 interfaces using "Service Parameters" of "x-3gpp-pgw:x-s5-gtp+nc-smf", "x-3gpp-pgw:x-s8-gtp+nc-smf" and the ePDG shall discover all GTP based S2b interfaces using "Service Parameters" of "x-3gpp-pgw:x-s2b-gtp+nc-smf". + +- this network capability may apply to: + - the 'app-service' name "x-3gpp-pgw"; + - the 'app-protocol' names: "x-s5-gtp", "x-s8-gtp", "x-s2b-gtp". + +#### 5.12.3.3 PGW-U/UPF selection + +A PGW-C/SMF shall select a combined PGW-U/UPF for PDN connections that may be subject to mobility to 5GS and for PDN connections not subject to mobility to 5GS but that access the 5GC. + +If the PGW-C/SMF supports the UP function selection based on DNS procedures specified in Annex B.2.6 of 3GPP TS 29.244 [26], DNS procedures to select a combined PGW-U/UPF shall be supported as specified in clause 5.11 (for discovering and selecting a PGW-U), with the following additions: + +- the app-service of x-3gpp-upf with app-protocol "x-n4" identifies a User Plane function supporting N4 capabilities; +- the app-service of x-3gpp-upf with app-protocols "x-sxb:x-n4" identifies a PGW-U supporting N4 capabilities (i.e. a combined PGW-U/UPF). + +#### 5.12.3.4 PGW-U/UPF/MB-UPF selection + +A PGW-C/SMF/MB-SMF may select a combined PGW-U/UPF/MB-UPF for PDN connections that may be subject to mobility to 5GS and to be associated with MBS session. + +If the PGW-C/SMF/MB-SMF supports the UP function selection using DNS procedures, DNS procedures to select a combined PGW-U/UPF/MB-UPF shall be supported as specified in clause 5.12.3.3 (for discovering and selecting a PGW-U/UPF), with the following additions: + +- the app-service of x-3gpp-upf with app-protocol "x-n4mb" identifies a User Plane function supporting N4mb capabilities; +- the app-service of x-3gpp-upf with app-protocols "x-sxb:x-n4:x-n4mb" identifies a PGW-U/UPF supporting N4mb capabilities (i.e. a combined PGW-U/UPF/MB-UPF). + +## 5.13 Procedures to support Ethernet PDN Connection in EPS + +### 5.13.1 DCN based solution + +When DCN is supported in the network, the MME may use the DNS procedures enhanced for supporting DCNs as specified in clause 5.8, to select an EPC entity, e.g. an SGW or a combined PGW-C/SMF, which supports Ethernet PDN connection by configuring to support a specific UE Usage Type(s). + +### 5.13.2 Network Capability based solution + +An MME may use the DNS procedure as specified in clause 5.12.1, to select an EPC entity, e.g. an SGW or a combined PGW-C/SMF which supports Ethernet PDN connection, with the following additions: + +- the shall be set to "eth" for an SGW selection and shall be set to "smf.eth" for a combined PGW-C/PGW-U selection. (See also clause 5.12.3 and Annex B.4) + +For example, the MME shall discover all GTP based S5/S8 interfaces using "Service Parameters" of "x-3gpp-pgw:x-s5-gtp+nc-smf.eth", "x-3gpp-pgw:x-s8-gtp+nc-smf.eth" + +- this network capability may apply to: + - the 'app-service' names "x-3gpp-sgw", "x-3gpp-pgw"; + - the 'app-protocol' names: "x-s5-gtp", "x-s8-gtp", "x-s11". + +### 5.13.3 Alternative solutions + +The MME may use the DNS procedures specified in this specification for selecting a combined PGW-C/SMF supporting Ethernet PDN connection without any change if all combined PGW-C/SMFs configured in the DNS for an APN support Ethernet PDN connection. + +The MME may know whether an SGW supports Ethernet PDN connection via the Notification of Supported features over the S11 interface (for the ETH feature), as specified in 3GPP TS 29.274 [23]. + +## 5.14 Procedures for Discovering and Selecting a UCMF + +These procedures shall be employed when a UCMF needs to be discovered and selected by MME. + +Operators shall provision NAPTR records under UCMF FQDN corresponding to valid UCMF interfaces from the following "Service Parameters": + +- "x-3gpp-ucmf:x-urcmp", "x-3gpp-ucmf:x-n55" + +Where additional "Service Parameters" may be included optionally. + +MMEs are expected to select a UCMF based on MME's capability to support URCMP or N55 based signalling. If multiple UCMFs are deployed, implementation specific algorithms should be used to distribute load among available UCMFs. + +3GPP does not require that collocation and "topon" naming is applicable in UCMF selection. + +# --- 6 Procedures for OAM System Node Discovery + +## 6.1 Procedures for Relay Node OAM System Discovery + +### 6.1.1 General + +These procedures may be employed when a relay node (see 3GPP TS 36.300 [22], clause 4.7) needs to discover its Operations and Maintenance (OAM) system. The relay nodes employ the procedures below during the startup procedure in order to discover the OAM system, from which it obtains its configuration and updated software. + +The OAM system is selected based on the operator identity and the type allocation code identifying the relay node vendor, and optionally the tracking area code (see 3GPP TS 23.003 [4]). This enables vendor-specific OAM systems for relay nodes. + +### 6.1.2 OAM System Selection based on Type Allocation Code + +In both UTRAN and E-UTRAN cases the operator identity in terms of MNC and MCC is available from the information in IMSI (see 3GPP TS 23.003 [4], clause 2.2). The type allocation code (IMEI-TAC) identifying the relay node vendor is available from IMEI or IMEISV (see 3GPP TS 23.003 [4], clause 6.2). + +- 1) In relay node startup procedure, the relay node may use the vendor-specific relay node OAM system FQDN as it is defined in 3GPP TS 23.003 [4], clause 23.3.2.2, to discover its OAM system. Operator provisions A/AAAA record under 3GPP vendor-specific relay node OAM system FQDN. + +# --- 7 Procedures for NF Discovery in 5G System + +## 7.1 General + +The discovery of NFs in the 5G System is supported by the NRF (see 3GPP TS 23.501 [28] and 3GPP TS 23.502 [29]), except for the following scenarios for which DNS procedures are defined: + +- AMF discovery and selection by MME, for EPS interworking with the 5G System using the N26 interface (see clauses 4.3.3.4, 4.3.3.8, 5.4 and 5.4A); and +- AMF discovery by 5G-AN (see clause 7.2). + +## 7.2 Procedure for AMF Discovery by 5G-AN + +The 5G-AN selects an AMF Set and an AMF from the AMF set as specified in clause 6.3.5 of 3GPP TS 23.501 [28]. + +NOTE 1: The 5G-AN (NG-RAN and N3IWF) is responsible for initiating the SCTP connectivity and setting up the NG-C association with the AMF. This requires the 5G-AN to first obtain the AMF's IP address(es). + +In the 5G System, AMFs may be added or removed dynamically for scalability or planned maintenance. The DNS procedure specified in this clause may be used by the 5G-AN to discover the AMFs available in an AMF Set. + +NOTE 2: The 5G-AN might obtain the information about the available AMFs via alternative means, e.g. OAM. + +The AMFs available within an AMF Set should be provisioned within NAPTR records in the DNS, under the AMF Set FQDN (as defined in clause 28.3.2.7 of 3GPP TS 23.003 [4]), with the Service Parameters "x-3gpp-amf:x-n2". + +The 5G-AN may discover the AMFs available within an AMF Set by: + +- constructing the AMF Set FQDN, as defined in clause 28.3.2.7 of 3GPP TS 23.003 [4], identifying the AMF Set of the AMFs to be discovered; and +- initiating an S-NAPTR procedure, with the Application-Unique String set to that AMF Set FQDN, and with the "Service Parameters" set to "x-3gpp-amf:x-n2". + +The S-NAPTR procedure outputs a list of host names (AMFs) each with a service, protocol, port and a list of IPv4 and IPv6 addresses. See further details and examples in Annexes B, C and F. + +# --- Annex A (Informative): Examples + +## A.1 Introduction + +This annex includes examples of the DNS provisioning needed for EPC node discovery and selection procedures. Examples are not exhaustive either in scope or in content but are intended to be sufficient to illustrate the general techniques and some of the more important use cases. + +## --- A.2 Preconditions + +The following are general comments applying to all examples provided here. + +- a) DNS master file format follows IETF RFC 1035 [3] clause 5. The reader is reminded that in that format the character ":" is used for comments, "\$" is used for directives, and enclosing parenthesis ( ) combine lines. +- b) Examples are built from smaller files and merged with the \$INCLUDE directive. This is to allow each file to be documented in a separate clause and to allow reuse of files in some of the examples. +- c) Only one operator's network is used in all examples using MCC=311 (United States) and MNC=990 (currently an unassigned MNC value). All DNS records presented here are within the zone cut epc.mnc990.mcc311.3gppnetwork.org. +- d) Since the fully qualified domain names here are relatively long to avoid line wrapping and to save space in the examples we use the standard \$ORIGIN directive +\$ORIGIN epc.mnc990.mcc311.3gppnetwork.org. +Hence any domain names in the file that are not fully qualified (i.e. does not end with a period) would have epc.mnc990.mcc311.3gppnetwork.org. appended to them to form the fully qualified value. In the descriptive text in this Annex we use the same convention. +- e) When a printout is provided, it is from an actual printout of the "dig" command (from the BIND distribution) but with all values of the string .epc.mnc990.mcc311.3gppnetwork.org. replaced with .\$ORIGIN in order to keep the output on one line when possible. Note the "+tcp" option is used in the "dig" command to avoid truncating large DNS responses in the examples. +- f) Files provided here have been tested with a recent version of BIND and are presented here unmodified. In the examples the BIND server was set as authoritative only with default settings to make the configuration self contained. In a real network a recursive server is likely to be used as an intermediary and/or multiple authoritative servers. +- g) The time to live (TTL) in the examples are all set to 1 hour = 3600 seconds by using the \$TTL directive from IETF RFC 2308 [15]. +- h) IPv4 addresses in the examples are from the IPv4 example documentation address space of 192.0.2.0/24 of IETF RFC 3330 [16] and IPv6 addresses are from the IPv6 documentation address space of IETF RFC 3849 [17]. These are by no means representative and are used solely for example purposes. +- i) Since A/AAAA records are well known we only provide A/AAAA records for the simpler examples and do not document every A and AAAA lookup in detail. + +## A.3 Collocated Simple LTE Example + +### A.3.1 Network description + +This is a fairly complete example of an operator network with the following properties. + +- 1) Network only has LTE access with only interworking with LTE access. There is no support for Gn/Gp and no support for S3/S4. +- 2) Network does not support PMIPv6 for S5 but does allow very limited roaming use of S8 PMIPv6. This is a policy that is extremely unlikely to be used by a real operator and is used only for illustrative purposes. +- 3) There are two combined PGW/SGW nodes and two standalone MME nodes. +- 4) Any load balancing between nodes of the same functional type is on a strict bias. Hence, SRV records are not needed. +- 5) Operator desires the flattest DNS structure possible due to desire to minimize the number of DNS queries. The use of NATPR with flag "" is therefore not used by operator policy. This is feasible since the network is small. +- 6) Due to 4) and 5) only NAPTR records with flag "a" are used by the operator in this example. +- 7) One MME pool area. +- 8) One SGW service area. +- 9) Operator desires that S1-U link cost is minimized (i.e. SGW closest to eNodeB is used) +- 10) Operator does not care about distance or transport costs between SGW and PGW beyond the collocation for S5. Hence it does not use "topon" naming. +- 11) Small number of APNs + +Other than item 2) this set of conditions might fit a green field operator or government agency deploying LTE for use on laptop computers or high end hand held devices for internet access. This represents one of the simpler networks possible while still being non-trivial. + +Very large networks would tend to use MME pool areas and SGW service areas and NAPTR empty flag records. How complex the structure in DNS is employed between the initial NAPTR entry point and the final A/AAAA record set(s) is solely the operator's choice so long as the S-NAPTR requirements are met. + +Additional comments on this example are in each clause as needed. Also commented out DNS records are often included in the sample files to illustrate how additional interface types would be added. + +### A.3.2 Master file for "Collocated Simple LTE Example" + +The master file for this example will be CS\_EX.txt and has following content. + +``` +$ORIGIN epc.mnc990.mcc311.3gppnetwork.org. +; +$TTL 3600 ; 1 hour - this directive is defined in IETF RFC 2308 not RFC 1035 +; +$INCLUDE SOA_DB.txt +; +$INCLUDE CS_MME_DB.txt +; +$INCLUDE CS_SGW_PGW_NODE_DB.txt +; +$INCLUDE CS_TAI_DB.txt +; +$INCLUDE CS_APN_DB.txt +; +; End of file +``` + +The included files are detailed in following clauses. + +### A.3.3 SOA and NS records + +The SOA and NS records need to exist for any DNS zone. Our example will use the following file with name SOA\_DB.txt whose content is: + +``` +; SOA and NS glue records +; Note @, ns1, ns2 are relative to $ORIGIN +; +@ 1D IN SOA @ administrator.example.com. ( + 2008122401 ; serial + 1H ; refresh + 15 ; retry + 1w ; expire + 1h ; minimum - note this parameter + ; is used for negative caching + ; see RFC 2308 chapter 4 +) +IN NS ns1 +IN NS ns2 +; +; Glue records for the two DNS servers +ns1 IN A 192.0.2.247 +ns2 IN A 192.0.2.248 +; +; End of file +``` + +### A.3.4 MME file for "Collocated Simple LTE Example" + +The MME S10 record lookup by GUTI is probably the simplest example of the NAPTR records and is the simplest introduction to the S-NAPTR procedure as well. + +A NAPTR record is required to be provisioned at mmec.mmegi.mme (see clause 4.3.3.4 of this TS). This is used for GUTI based lookup of the old or source MME. Specifically, the target MME takes the UE's old GUTI value and derives the old MME's DNS name. The goal of the target MME is usually to be able to do a context transfer of the old MME's data (or similar action). MME to MME communication is done over S10. Hence, S10 is critical for the GUTI record in an LTE only network. + +The mmec.mmegi.mme is also the natural place for the MME canonical node record set. For this example we place the MME canonical node records and the required record for GUTI based lookup at the same location both for simplicity and better DNS caching. + +For this example we have two MMEs with MMEC codes of 1 and 2 respectively and both in the same MME pool (MMEGI = 8000 hexadecimal). + +The file containing the MME records for this example will be CS\_MME\_DB.txt and has following NAPTR record content. + +``` +; +; This is the GUTI related record and the MME node record +; The operator has decided to use the 3GPP name as the canonical node name of the MME +; rather than having two records (the 3GPP one and an operator defined value) +; +mmec01.mmegi8001.mme ( +; IN NAPTR order pref. flag service regexp replacement +; IN NAPTR 100 999 "a" "x-3gpp-mme:x-s10" "" topoff.eth1.mmec01.mmegi8001.mme ) +; IN NAPTR 200 999 "a" "x-3gpp-mme:x-s11" "" topoff.eth3.mmec01.mmegi8001.mme +; IN NAPTR 300 999 "a" "x-3gpp-mme:x-s3" "" topoff.eth5.mmec01.mmegi8001.mme +; IN NAPTR 400 999 "a" "x-3gpp-mme:x-gn" "" topoff.eth6.mmec01.mmegi8001.mme +; IN NAPTR 500 999 "a" "x-3gpp-mme:x-s1-mme" "" topoff.eth7.mmec01.mmegi8001.mme + +; This particular operator only supports LTE access in their accesses etc. +; So the S3 record is commented out above. If the operator wants the MME to be used with S3/S4 +; SGSN nodes then the record would have to be included. +; The Gn/Gp interface is commented out for same reason. This operator does not support it. +; If the operator wants the MME to be used for Gn/Gp SGSN interworking +; then the record would have to be included. +; +; Reminder: Canonical node name records must be complete. +``` + +``` + +; However, "x-3gpp-mme:x-s1-mme" is an exception. +; While S1-MME interface must be physically present and used in a MME +; it is explicitly optional for an operator to provision in this release of 3GPP +; So it too is commented out + +; NAPTR order plays no major role in this particular example since the MME node is already +; selected in GUTI case and as a canonical node name. In most cases the interface type +; (S10 vs S11 etc) is functionally determined so the NAPTR order is rarely used in this record set +; If the S3 and Gn records were not commented out the S10 is preferred over S3 over Gn +; I.e. a combined MME/SGSN could communicate to the MME above using any of the three protocols +; at context transfer. +; So the operator is stating that S10 is preferred over S3 over Gn +; +; Of course if the MME had multiple S10 interfaces +; the operator could provision more than one S10 record with different orders +; perhaps to select S10 IPv6 over S10 IPv4 + +; We have the same type of records for the other MME (same comments would apply) + +; +mmec02.mmegi8001.mme ( +; IN NAPTR order pref. flag service regexp replacement + IN NAPTR 100 999 "a" "x-3gpp-mme:x-s10" "" topoff.eth1.mmec02.mmegi8001.mme ) + IN NAPTR 200 999 "a" "x-3gpp-mme:x-s11" "" topoff.eth3.mmec02.mmegi8001.mme +; IN NAPTR 300 999 "a" "x-3gpp-mme:x-s3" "" topoff.eth5.mmec02.mmegi8001.mme +; IN NAPTR 400 999 "a" "x-3gpp-mme:x-gn" "" topoff.eth6.mmec02.mmegi8001.mme +; IN NAPTR 500 999 "a" "x-3gpp-mme:x-s1-mme" "" topoff.eth7.mmec02.mmegi8001.mme +; +; All MME IP addresses for both MME +; +topoff.eth1.mmec01.mmegi8001.mme IN A 192.0.2.11 + IN A 192.0.2.12 + IN AAAA 2001:db8:0:0:0:0:0:0 + IN AAAA 2001:db8:0:1:0:0:0:0 +topoff.eth3.mmec01.mmegi8001.mme IN A 192.0.2.13 + IN A 192.0.2.14 + IN AAAA 2001:db8:0:2:0:0:0:0 + IN AAAA 2001:db8:0:3:0:0:0:0 +topoff.eth1.mmec02.mmegi8001.mme IN A 192.0.2.17 + IN A 192.0.2.18 + IN AAAA 2001:db8:0:6:0:0:0:0 + IN AAAA 2001:db8:0:7:0:0:0:0 +topoff.eth3.mmec02.mmegi8001.mme IN A 192.0.2.19 + IN A 192.0.2.110 + IN AAAA 2001:db8:0:8:0:0:0:0 + IN AAAA 2001:db8:0:9:0:0:0:0 + +; end of file + +``` + +The partially qualified MME host names are topoff.eth1.mmec01.mmegi8001., topoff.eth3.mmec02.mmegi8001.mme and similar. The (partially qualified) canonical node names are mmec01.mmegi8001.mme and mmec02.mmegi8001.mme (obtained by stripping off the first two labels of the host names). + +The fully qualified MME node names are the relatively long + +mmec01.mmegi8001.mme.epc.mnc990.mcc311.3gppnetwork.org. + +and + +mmec02.mmegi8001.mme.epc.mnc990.mcc311.3gppnetwork.org. + +which are obtained by appending the value of \$ORIGIN to the partially qualified MME node names. As stated before we will use the partially qualified names in this Annex to avoid this visual clutter and for typographical reasons. + +Note that hostnames such as topoff.eth1.mmec01.mmegi8001.mme intentionally give back the node name mmec01.mmegi8001.mme so this record set is both for GUTI lookup and MME canonical node name lookup (and it is self consistent). + +For the purposes of GUTI lookup the S10 record is sufficient for LTE only access and LTE only interworking. As stated in the comments above, S3 would be added for S4-SGSN support and the Gn/Gp records for Gn/Gp SGSN support. + +For the purposes of being a canonical node record the S10 and S11 MME records are included (and they are mandatory to provision in the canonical node record of the MME). + +NOTE 1: The rule for canonical node records is to always include all services that are allowed to be used on a node and are defined in 3GPP TS 23.003 [4] clause 19.4.3 for that node. Node records are meant to be complete. We have an exception here since x-3gpp-mme:x-s1-mme is explicitly optional in this release of 3GPP. + +### A.3.5 APN file for "Collocated Simple LTE Example" + +Reminder, the format of the APN FQDN is standardized by 3GPP TS 23.003 [4] clause 19.4.2.2 and is of form .apn.epc.mnc.mcc.3gppnetwork.org + +Service names are in 3GPP TS 23.003 [4] clause 19.4.3 + +There are two APN-NI in this network "imsTV1", and "imsTV2". + +The file containing the APN records for this example will be CS\_APN\_DB.txt and has following content. + +``` +; +; +imsTV1.apn +; IN NAPTR order pref. flag service regexp replacement +; IN NAPTR 100 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" topoff.vip1.gw01.nodes ) +; IN NAPTR 200 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" topoff.vip1.gw21.nodes +; IN NAPTR 300 999 "a" "x-3gpp-pgw:x-gn:x-gp" "" topoff.vip3.gw01.nodes +; IN NAPTR 400 999 "a" "x-3gpp-pgw:x-gn:x-gp" "" topoff.vip3.gw21.nodes +; IN NAPTR 500 999 "a" "x-3gpp-pgw:x-s8-pmip" "" topoff.vip2.gw01.nodes +; IN NAPTR 600 999 "a" "x-3gpp-pgw:x-s8-pmip" "" topoff.vip2.gw21.nodes +; IN NAPTR 700 999 "" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" set12.pgwset + +; The MME can derive the NAPTR DNS record for a PGW Set based on the second label pgwset. +; Operator has imsTV1.apn using gw01.nodes when possible. Possibly one IMS core and video server +; are closer to gw01.nodes than gw21.nodes +; +; Operator only allows PMIPv6 for roaming type scenarios and only as a last choice +; The operator does not support Gn/Gp so those records are commented out + +imsTV2.apn +; IN NAPTR order pref. flag service regexp replacement +; IN NAPTR 200 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" topoff.vip1.gw01.nodes ) +; IN NAPTR 100 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" topoff.vip1.gw21.nodes +; IN NAPTR 400 999 "a" "x-3gpp-pgw:x-gn:x-gp" "" topoff.vip3.gw01.nodes +; IN NAPTR 300 999 "a" "x-3gpp-pgw:x-gn:x-gp" "" topoff.vip3.gw21.nodes +; IN NAPTR 600 999 "a" "x-3gpp-pgw:x-s8-pmip" "" topoff.vip2.gw01.nodes +; IN NAPTR 500 999 "a" "x-3gpp-pgw:x-s8-pmip" "" topoff.vip2.gw21.nodes +; +; This is almost the same as imsTV1. +; However, NAPTR order values for a particular interface type are reverse in comparison +; to imsTV1.apn +; +; Operator has imsTV2.apn using gw21.nodes when possible. + +; Obviously more APN would exist for a real operator +; +; end of file +``` + +If collocation were not a consideration then the APN-NI "imsTV1" causes topoff.vip1.gw01.nodes to be selected and the APN-NI "imsTV2" causes topoff.vip1.gw21.nodes to be selected. This is because in the corresponding record set the order 100 record is taken before the order 200 record in the S-NAPTR. In case of failure of a PGW then the other PGW can be used (the record with order 200). If there is deliberate bias to a specific PGW is solely the concern of this operator, the S-NAPTR procedure simply honors this. + +However, collocation is a consideration (topological checks are not relevant here since all records use topoff). + +The (partially qualified) PGW node names are gw01.nodes and gw21.nodes (obtained by stripping off the first two labels of the partially qualified host names topoff.vip1.gw01.nodes, topoff.vip1.gw21.nodes and so on). + +### A.3.6 PGW/SGW node file for "Collocated Simple LTE Example" + +The file containing the PGW/SGW canonical node name records (and A/AAAA records for the PGW/SGW nodes) for this example will be CS\_SGW\_PGW\_NODE\_DB.txt and has following content. + +``` +; Node records for the combined PGW/SGW + +gw01.nodes +; IN NAPTR order pref. flag service regexp replacement +; IN NAPTR 200 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" topoff.vip1.gw01.nodes ) +; IN NAPTR 400 999 "a" "x-3gpp-pgw:x-s8-pmip" "" topoff.vip2.gw01.nodes +; IN NAPTR 500 999 "a" "x-3gpp-pgw:x-gn:x-gp" "" topoff.vip3.gw01.nodes +; Above record is commented out since this operator does not support Release 8 Gn/Gp functions +; Would have to be included otherwise +; + +; Above are PGW records. +; Note this operator does NOT support PMIP for S5 +; Following are SGW records +; IN NAPTR 100 999 "a" "x-3gpp-sgw:x-s11" "" topoff.eth1.gw01.nodes +; IN NAPTR 300 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" topoff.eth4.gw01.nodes +; IN NAPTR 600 999 "a" "x-3gpp-sgw:x-s8-pmip" "" topoff.eth9.gw01.nodes +; IN NAPTR 700 999 "a" "x-3gpp-sgw:x-s4" "" topoff.eth6.gw01.nodes +; IN NAPTR 710 999 "a" "x-3gpp-sgw:x-s12" "" topoff.eth6.gw01.nodes +; IN NAPTR 800 999 "a" "x-3gpp-sgw:x-gn:x-gp" "" topoff.eth8.gw01.nodes +; Above records are commented out since this operator does not support any SGSN variant +; or UTRAN support. The operator is pure LTE in this example +; Above records would be included if the SGWs were able to be used with the corresponding +; SGSN function (or direct tunnel function) +; +; Reminder: Canonical node records must be complete. +; +; Exception, "x-3gpp-sgw:x-s1-u" records could be listed but are purely optional for an operator +; to provision +; in this release of 3GPP. + +; NAPTR order plays no real role in this particular example (except for S8) +; Reasons for this example are: +; This is the PGW/SGW canonical node record so there is no node selection based from the record +; The interface type is functionally determined in most use cases using this record set except S5/S8 +; This operator does NOT support PMIP for S5 and there is only one S5-GTP record. +; So order is not important except for S8. +; For S8 the operator does places PMIP with highest order just to be sure that GTP based S8 will be +; used first when possible even at re-selection of an S8 interface on the SGW or PGW as per this +; particular operators policy +; This is of course subject to the roaming agreements this operator has. + +; Same record for the other combined PGW/SGW + +gw21.nodes +; IN NAPTR order pref. flag service regexp replacement +; IN NAPTR 200 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" topoff.vip1.gw21.nodes ) +; IN NAPTR 400 999 "a" "x-3gpp-pgw:x-s8-pmip" "" topoff.vip2.gw21.nodes +; IN NAPTR 500 999 "a" "x-3gpp-pgw:x-gn:x-gp" "" topoff.vip3.gw21.nodes + +; Above are PGW records. + +; Following are SGW records +; IN NAPTR 100 999 "a" "x-3gpp-sgw:x-s11" "" topoff.eth1.gw21.nodes +; IN NAPTR 300 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" topoff.eth4.gw21.nodes +; IN NAPTR 600 999 "a" "x-3gpp-sgw:x-s8-pmip" "" topoff.eth9.gw21.nodes +; IN NAPTR 700 999 "a" "x-3gpp-sgw:x-s4" "" topoff.eth6.gw21.nodes +; IN NAPTR 710 999 "a" "x-3gpp-sgw:x-s12" "" topoff.eth6.gw21.nodes +; IN NAPTR 800 999 "a" "x-3gpp-sgw:x-gn:x-gp" "" topoff.eth8.gw21.nodes +``` + +``` + +; A/AAAA records +; +; IP addresses for gw01 +; +topoff.vip1.gw01.nodes IN A 192.0.2.113 + IN A 192.0.2.114 + IN AAAA 2001:db8:0:c:0:0:0:0:0 + IN AAAA 2001:db8:0:d:0:0:0:0:0 +topoff.vip2.gw01.nodes IN A 192.0.2.143 + IN A 192.0.2.144 + IN AAAA 2001:db8:0:2a:0:0:0:0:0 + IN AAAA 2001:db8:0:2b:0:0:0:0:0 +topoff.eth1.gw01.nodes IN A 192.0.2.129 + IN A 192.0.2.130 + IN AAAA 2001:db8:0:1c:0:0:0:0:0 + IN AAAA 2001:db8:0:1d:0:0:0:0:0 +topoff.eth4.gw01.nodes IN A 192.0.2.131 + IN A 192.0.2.132 + IN AAAA 2001:db8:0:1e:0:0:0:0:0 + IN AAAA 2001:db8:0:1f:0:0:0:0:0 +topoff.eth9.gw01.nodes IN A 192.0.2.133 + IN A 192.0.2.134 + IN AAAA 2001:db8:0:20:0:0:0:0:0 + IN AAAA 2001:db8:0:21:0:0:0:0:0 + +; IP addresses for gw21 +; +topoff.vip1.gw21.nodes IN A 192.0.2.115 + IN A 192.0.2.116 + IN AAAA 2001:db8:0:e:0:0:0:0:0 + IN AAAA 2001:db8:0:f:0:0:0:0:0 +topoff.vip2.gw21.nodes IN A 192.0.2.135 + IN A 192.0.2.136 + IN AAAA 2001:db8:0:22:0:0:0:0:0 + IN AAAA 2001:db8:0:23:0:0:0:0:0 +topoff.eth1.gw21.nodes IN A 192.0.2.137 + IN A 192.0.2.138 + IN AAAA 2001:db8:0:24:0:0:0:0:0 + IN AAAA 2001:db8:0:25:0:0:0:0:0 +topoff.eth4.gw21.nodes IN A 192.0.2.139 + IN A 192.0.2.140 + IN AAAA 2001:db8:0:26:0:0:0:0:0 + IN AAAA 2001:db8:0:27:0:0:0:0:0 +topoff.eth9.gw21.nodes IN A 192.0.2.141 + IN A 192.0.2.142 + IN AAAA 2001:db8:0:28:0:0:0:0:0 + IN AAAA 2001:db8:0:29:0:0:0:0:0 + +;end of file + +``` + +The above records are essentially standalone records representing the PGW/SGW node and its interfaces. An operator would normally define the records when a new node is brought into service and would only modify it when new IP interfaces or services are added to that particular node. + +The fact both record types are here under the same name is a result of the PGW/SGW being collocated and having the same canonical node name. + +NOTE: The rule for node records is to always include all services that are allowed to be used on a node and are defined in 3GPP TS 23.003 [4] clause 19.4.3 for that node. Node records are meant to be complete. + +The lack of a record in a canonical node name record set is just as important as the records that are there. The commented out records in the example would be included for supporting S4-SGSN and/or Gn/Gp interfaces. Their absence states that the node does not support the function. + +### A.3.7 TAI/TAC file for "Collocated Simple LTE Example" + +The format of the TAI/TAC name is standardized by 3GPP 23.003 [4] clause 19.4.2.3 and is of form tac-lb.tac-hb.tac.epc.mnc.mcc.3gppnetwork.org and service names are in 3GPP 23.003 [4] clause 19.4.3. + +The file containing the TAI/TAC records for this example will be SIMPLE\_TAI\_DB.txt and has following content. + +``` +; All TAC codes for one region + +*.tac-hb01.tac ( +; IN NAPTR order pref. flag service regexp replacement +; IN NAPTR 100 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" topoff.eth4.gw01.nodes ) +; IN NAPTR 200 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" topoff.eth4.gw21.nodes +; IN NAPTR 300 999 "a" "x-3gpp-sgw:x-s8-pmip" "" topoff.eth9.gw01.nodes +; IN NAPTR 400 999 "a" "x-3gpp-sgw:x-s8-pmip" "" topoff.eth9.gw21.nodes +; Above records are needed for SGW selection in initial attach of a UE (or TAU or handover attach) +; +; IN NAPTR 500 999 "a" "x-3gpp-mme:x-s10" "" topoff.eth1.mmec01.mmegi8001.mme +; IN NAPTR 600 999 "a" "x-3gpp-mme:x-s10" "" topoff.eth1.mmec02.mmegi8001.mme +; Above two records are needed for target MME selection by source MME +; +; IN NAPTR 700 999 "a" "x-3gpp-sgw:x-s11" "" topoff.eth1.gw01.nodes ) +; IN NAPTR 800 999 "a" "x-3gpp-sgw:x-s11" "" topoff.eth1.gw21.nodes +; Above two S11 records are purely optional for an operator to provision and are only +; an optimization when included so they are commented out for this example +; IN NAPTR 900 999 "a" "x-3gpp-sgw:x-s4" "" topoff.eth6.gw01.nodes ) +; IN NAPTR 1000 999 "a" "x-3gpp-sgw:x-s4" "" topoff.eth6.gw21.nodes +; This operator does not support S3/S4 so they are commented out for this example +; Above two S4 records are purely optional for an operator to provision even if S3/S4 is supported + +; Note relative value of NAPTR order is important between the S5/S8 records, +; relative value of NAPTR order is important between the S10 records, +; relative value of NAPTR order is important between the S11 records +; but is not really important between different interface types used here +; (i.e. the MME selection procedure does not look for an SGW interface) +; +; This operators policy is PMIPv6 is used only as last choice +; and only for S8 they don't allow S5 PMIPv6 at all + +; All TAC codes for another region + +*.tac-hb40.tac ( +; IN NAPTR order pref. flag service regexp replacement +; IN NAPTR 200 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" topoff.eth4.gw01.nodes ) +; IN NAPTR 100 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" topoff.eth4.gw21.nodes +; IN NAPTR 400 999 "a" "x-3gpp-sgw:x-s8-pmip" "" topoff.eth9.gw01.nodes +; IN NAPTR 300 999 "a" "x-3gpp-sgw:x-s8-pmip" "" topoff.eth9.gw21.nodes +; +; IN NAPTR 600 999 "a" "x-3gpp-mme:x-s10" "" topoff.eth1.mmec01.mmegi8001.mme +; IN NAPTR 500 999 "a" "x-3gpp-mme:x-s10" "" topoff.eth1.mmec02.mmegi8001.mme +; +; IN NAPTR 800 999 "a" "x-3gpp-sgw:x-s11" "" topoff.eth1.gw01.nodes ) +; IN NAPTR 700 999 "a" "x-3gpp-sgw:x-s11" "" topoff.eth1.gw21.nodes +; +; IN NAPTR 1000 999 "a" "x-3gpp-sgw:x-s4" "" topoff.eth6.gw01.nodes ) +; IN NAPTR 900 999 "a" "x-3gpp-sgw:x-s4" "" topoff.eth6.gw21.nodes + +; For the example the TAC values *.tac-hb40.tac are on other side of network than the *.tac-hb01.tac +; Relative order reverses in comparison to since those TAI are closer to the other set of nodes + +; end of file +``` + +SGW records are here since TAI is used to select the SGW in the initial attach procedure (and TAU with SGW change). The MME record is here for the the 'Inter eNodeB handover with MME relocation' procedure where a target MME must be selected by the source MME. + +Wild cards are used in this example to simplify provisioning assuming that the operator picks tac codes with the same high byte for each eNodeB that are equivalent in terms of prioritization. Otherwise each TAC code needs to be provisioned individually in DNS requiring a small amount of additional repetitive provisioning as each set of TAC codes is added to a network. + +From above SGW records we see only GTP based S5 so there is no PMIPv6 S5 support for the SGWs. The operator insists on GTP based S5 i.e. when one of their PGW is used and the UE is in their network (the operator does let roamers use another operators PMIPv6 PGW though). The S5/S8 SGW interfaces with (partially qualified) canonical node name gw01.nodes is used when possible for tac codes with high byte of 01 hex and the S5/S8 SGW interfaces with (partially qualified) canonical node name gw21.nodes is used when possible for tac codes with high byte of 40 hex. + +This follows from the NAPTR order 100 record being used before the order 200 record in the corresponding record set. This is the general mechanism an operator can use to steer the SGW selection based on which TAI the user initially attaches to (or during TAU with SGW service change). So an operator trying to minimize S1-U link costs would set the order to the smallest value for the SGW with the least cost S1-U link(s) to the eNodeB(s) serving that TAI and use higher order for the TAI corresponding to the more expensive links. + +The gw01.nodes and gw21.nodes are the collocated PGW/SGW canonical node names the operator chooses. These were defined in the file CS\_SGW\_PGW\_NODE\_DB.txt. + +The TAI records are not intended to determine the SGW S11 interface directly but only the candidate list SGW S5/S8 interfaces with node names. S11 interface lookup can be done from the SGW canonical node name (see records in CS\_SGW\_PGW\_NODE\_DB.txt) so inclusion of S11 here is not strictly needed. + +### A.3.8 MME lookup based on GUTI for "Simple LTE Example" + +Here we "manually" execute the S-NAPTR procedure using the standard "dig" command for finding the source MME at the target MME (for example in a TAU procedure) to illustrate the procedure and show how the DNS records work in practice. + +The target MME receives the LTE UE's old GUTI. The target MME extracts the MNC, MCC, MMEC and MMEGI values. In this example the UE is in a cell where the MME selected by the RAN is assumed to be MMEC=1 and MMEGI=8000 hexadecimal. The MME creates the Application Unique String mmec01.mmegi8001.mme.\$ORIGIN (see clause 4.3.3.4 of this TS) + +NOTE: Reminder \$ORIGIN is epc.mnc990.mcc311.3gppnetwork.org. and is employed here simply to keep the length of the example text manageable. + +The target MME starts the S-NAPTR with Application Unique String = mmec01.mmegi8001.mme.\$ORIGIN and desired services x-3gpp-mme:x-s10 since it is trying to contact the old MME to do a context transfer. + +Here we emulate the same action manually with the dig command. + +``` +----- Command to DNS server----- +command: dig @192.0.2.247 +tcp NAPTR mmec01.mmegi8001.mme.$ORIGIN +-----Start Response from DNS server----- + +; <<>> DiG 9.5.0-P2-W2 <<>> @192.0.2.247 +tcp NAPTR mmec01.mmegi8001.mme.$ORIGIN +; (1 server found) +;; global options: printcmd +;; Got answer: +;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 1399 +;; flags: qr aa rd; QUERY: 1, ANSWER: 2, AUTHORITY: 2, ADDITIONAL: 10 +;; WARNING: recursion requested but not available + +;; QUESTION CLAUSE: +;mmec01.mmegi8001.mme.$ORIGIN. IN NAPTR + +;; ANSWER CLAUSE: +mmec01.mmegi8001.mme.$ORIGIN. 3600 IN NAPTR 100 999 "a" "x-3gpp-mme:x-s10" "" +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. +mmec01.mmegi8001.mme.$ORIGIN. 3600 IN NAPTR 200 999 "a" "x-3gpp-mme:x-s11" "" +topoff.eth3.mmec01.mmegi8001.mme.$ORIGIN. + +;; AUTHORITY CLAUSE: +$ORIGIN. 3600 IN NS ns1.$ORIGIN. +$ORIGIN. 3600 IN NS ns2.$ORIGIN. + +;; ADDITIONAL CLAUSE: +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.12 +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.11 +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:: +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:0:1:: +topoff.eth3.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.14 +topoff.eth3.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.13 +topoff.eth3.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:0:2:: +topoff.eth3.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:0:3:: +ns1.$ORIGIN. 3600 IN A 192.0.2.247 +ns2.$ORIGIN. 3600 IN A 192.0.2.248 +``` + +``` +;; Query time: 15 msec +;; SERVER: 192.0.2.247#53(192.0.2.247) +;; WHEN: Wed Jan 21 16:30:20 2009 +;; MSG SIZE rcvd: 524 +``` + +``` +-----End Response from DNS server----- +``` + +MME retains only NAPTR with matching services matching x-3gpp-mme:x-s10 yielding + +``` +NAPTR record set +replacement service flag order preference +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN x-3gpp-mme:x-s10 "a" 100 999 +``` + +MME node sorts the NAPTR records by RFC 3958 rules. Obviously since this is a list of only one record it yields the same list back again unchanged. + +Since the record is the terminal ("a") flag we have the host name (and canonical node name inside it). + +Formally the A/AAAA record lookup can be performed at this point or it can be deferred until a later step. + +The MME can store the important content now + +topoff.eth1.mmec01.mmegi8001.mme.\$ORIGIN services of x-3gpp-mme:x-s10 + +Because there is only one match the MME now has the final candidate list (except for IP addresses). + +topoff.eth1.mmec01.mmegi8001.mme.\$ORIGIN services of x-3gpp-mme:x-s10 + +Note the needed A/AAAA records for topoff.eth1.mmec01.mmegi8001.mme are already present in the additional record clause of the response. + +``` +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.12 +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.11 +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:: +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:0:1:: +``` + +If the records had not been available in the additional record clause of the response then the MME would have had to do the A/AAAA record lookups directly. Emulated by dig command they would have been + +``` +command: dig @192.0.2.247 +tcp A topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN +and +``` + +``` +command: dig @192.0.2.247 +tcp AAAA topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN +``` + +or + +``` +command: dig @192.0.2.247 +tcp ANY topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN +``` + +Regardless of the source of the A and AAAA records, the order of the A records shall be randomly shuffled by the MME. The same shall be done for the AAAA records. (For our "manual" example it will be a coin flip as to which of the two records is first). + +The MME now has a candidate list (very short here) with the needed IPv4 and IPv6 addresses. I.e.: + +``` +(topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN, services of x-3gpp-mme:x-s10, {192.0.2.12,192.0.2.11}, { +2001:db8::, 2001:db8:0:1:: } ) +``` + +The target MME then can use the IPv4 (or IPv6) addresses to contact the source MME over S10 to get the UE's context information from the old MME. + +When an operator uses only NAPTR flag "a" records the S-NAPTR procedure will only require one NAPTR lookup from the Application Unique String in all cases greatly streamlining the DNS lookups. Also assuming a modern DNS server where the NAPTR and A/AAAA records in the same DNS server the needed A/AAAA records are likely to be in the additional record clause (as the above real output shows). + +However, the needed A/AAAA records would NOT have been present even in this small example if the DNS resolver (dig here) had not used TCP transport (or EDNS0 for UDP) since the packet size of the response in this example was 524 bytes which exceeds the 512 byte limit for using UDP transport without EDNS0. + +### A.3.9 APN lookup for "Simple LTE Example" (i.e. PGW candidate list) + +Assume a non-roaming LTE UE indicates it want to use APN-NI string "imsTV2" to the MME in our example network at initial attach. + +NOTE 1: Reminder \$ORIGIN is epc.mnc990.mcc311.3gppnetwork.org. and is employed here simply to keep the length of the example text manageable + +The MME starts the S-NAPTR procedure with Application Unique String = imsTV2.apn.\$ORIGIN and desired services x-3gpp-pgw:x-s5-gtp and x-3gpp-pgw:x-s5-pmip. + +Here we emulate the same action the MME would do manually with the dig command. + +MME starts with Application Unique String = imsTV2.apn.\$ORIGIN and the desired services x-3gpp-pgw:x-s5-gtp and x-3gpp-pgw:x-s5-pmip + +``` +----- Command to DNS server----- +command: dig @192.0.2.247 +tcp NAPTR imsTV2.apn.$ORIGIN +-----Start Response from DNS server----- + +; <<>> DiG 9.5.0-P2-W2 <<>> @192.0.2.247 +tcp NAPTR imsTV2.apn.$ORIGIN +; (1 server found) +;; global options: printcmd +;; Got answer: +;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 1796 +;; flags: qr aa rd; QUERY: 1, ANSWER: 4, AUTHORITY: 2, ADDITIONAL: 18 +;; WARNING: recursion requested but not available + +;; QUESTION CLAUSE: +;imsTV2.apn.$ORIGIN. IN NAPTR + +;; ANSWER CLAUSE: +imsTV2.apn.$ORIGIN. 3600 IN NAPTR 600 999 "a" "x-3gpp-pgw:x-s8-pmip" "" +topoff.vip2.gw01.node.$ORIGIN. +imsTV2.apn.$ORIGIN. 3600 IN NAPTR 100 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" +topoff.vip1.gw21.node.$ORIGIN. +imsTV2.apn.$ORIGIN. 3600 IN NAPTR 200 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" +topoff.vip1.gw01.node.$ORIGIN. +imsTV2.apn.$ORIGIN. 3600 IN NAPTR 500 999 "a" "x-3gpp-pgw:x-s8-pmip" "" +topoff.vip2.gw21.node.$ORIGIN. + +;; AUTHORITY CLAUSE: +$ORIGIN. 3600 IN NS ns2.$ORIGIN. +$ORIGIN. 3600 IN NS ns1.$ORIGIN. + +;; ADDITIONAL CLAUSE: +topoff.vip1.gw21.node.$ORIGIN. 3600 IN A 192.0.2.116 +topoff.vip1.gw21.node.$ORIGIN. 3600 IN A 192.0.2.115 +topoff.vip1.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:e:: +topoff.vip1.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:f:: +topoff.vip1.gw01.node.$ORIGIN. 3600 IN A 192.0.2.114 +topoff.vip1.gw01.node.$ORIGIN. 3600 IN A 192.0.2.113 +topoff.vip1.gw01.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:c:: +topoff.vip1.gw01.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:d:: +topoff.vip2.gw21.node.$ORIGIN. 3600 IN A 192.0.2.136 +topoff.vip2.gw21.node.$ORIGIN. 3600 IN A 192.0.2.135 +topoff.vip2.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:22:: +topoff.vip2.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:23:: +topoff.vip2.gw01.node.$ORIGIN. 3600 IN A 192.0.2.144 +topoff.vip2.gw01.node.$ORIGIN. 3600 IN A 192.0.2.143 +topoff.vip2.gw01.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:2a:: +topoff.vip2.gw01.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:2b:: +ns1.$ORIGIN. 3600 IN A 192.0.2.247 +ns2.$ORIGIN. 3600 IN A 192.0.2.248 +``` + +``` + +;; Query time: 0 msec +;; SERVER: 192.0.2.247#53(192.0.2.247) +;; WHEN: Wed Jan 21 19:21:14 2009 +;; MSG SIZE rcvd: 890 + +----------End Response from DNS server---------- +MME retains only NAPTR records with matching services x-3gpp-pgw:x-s5-gtp and +x-3gpp-pgw:x-s5-pmip yielding: +NAPTR record set +replacement service flag order preference +topoff.vip1.gw21.node.$ORIGIN x-3gpp-pgw:x-s5-gtp:x-s8-gtp "a" 100 999 +topoff.vip1.gw01.node.$ORIGIN x-3gpp-pgw:x-s5-gtp:x-s8-gtp "a" 200 999 +; Note the x-s8-gtp are not really included but are kept here to allow the +; reader to see which NAPTR record was kept from the DNS response. +; The DNS server "luckily" returns this in sorted order but the MME must sort it . +; The DNS server is not responsible for sorting but the DNS resolver (i.e. the MME) +MME node sorts NAPTR by RFC 3958 yielding +NAPTR record set +replacement service flag order preference +topoff.vip1.gw21.node.$ORIGIN x-3gpp-pgw:x-s5-gtp:x-s8-gtp "a" 100 999 +topoff.vip1.gw01.node.$ORIGIN x-3gpp-pgw:x-s5-gtp:x-s8-gtp "a" 200 999 +MME Stores records since they are flag "a" +topoff.vip1.gw21.node.$ORIGIN services of x-3gpp-pgw:x-s5-gtp +topoff.vip1.gw01.node.$ORIGIN services of x-3gpp-pgw:x-s5-gtp +MME now has final candidate list (A and AAAA lookup is deferred for our hand example) +topoff.vip1.gw21.node.$ORIGIN services of x-3gpp-pgw:x-s5-gtp +topoff.vip1.gw01.node.$ORIGIN services of x-3gpp-pgw:x-s5-gtp + +``` + +The needed A/AAAA records were included with additional records. I.e. + +``` + +topoff.vip1.gw21.node.$ORIGIN. 3600 IN A 192.0.2.116 +topoff.vip1.gw21.node.$ORIGIN. 3600 IN A 192.0.2.115 +topoff.vip1.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:e:: +topoff.vip1.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:f:: + +``` + +and + +``` + +topoff.vip1.gw01.node.$ORIGIN. 3600 IN A 192.0.2.114 +topoff.vip1.gw01.node.$ORIGIN. 3600 IN A 192.0.2.113 +topoff.vip1.gw01.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:c:: +topoff.vip1.gw01.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:d:: + +``` + +If the A and AAAA records were not available in the Additional Record clause (or a DNS cache) the MME would do the A/AAAA lookups. Which emulating with manual commands would look like: + +``` + +dig @192.0.2.247 +tcp A topoff.vip1.gw21.node.$ORIGIN +dig @192.0.2.247 +tcp AAAA topoff.vip1.gw21.node.$ORIGIN +dig @192.0.2.247 +tcp A topoff.vip1.gw01.node.$ORIGIN +dig @192.0.2.247 +tcp AAAA topoff.vip1.gw01.node.$ORIGIN + +``` + +We can form the full candidate list now (after random shuffling the A and AAAA records) to get + +``` + +(topoff.vip1.gw21.node.$ORIGIN ,services of x-3gpp-pgw:x-s5-gtp , {192.0.2.115,192.0.2.116}, { +2001:db8:0:e::,2001:db8:0:f::} ) +(topoff.vip1.gw01.node.$ORIGIN ,services of x-3gpp-pgw:x-s5-gtp , {192.0.2.114,192.0.2.113}, { +2001:db8:0:c::, 2001:db8:0:d::} ) + +``` + +The fact that the node topoff.vip1.gw21.node.\$ORIGIN comes first is a direct result of the two different NAPTR order values. + +NOTE 2: This is the last example in this Annex with A and AAAA lookups and IP addresses explicitly included in the candidate list. This detail is left for the reader for the remaining clauses. + +For the initial attach case the candidate list of SGW has to be formally found to handle the collocated PGW and SGW case. The SGW candidate list is found in the next clause. + +NOTE 3: If this DNS procedure was being used for an additional PDN connection for a UE with an existing SGW rather than a first attach, then the MME would check to see if the current SGW node name matches any of the PGW node names in the above list (gw01.node.\$ORIGIN and gw21.node.\$ORIGIN) to try to pick a collocated PGW on the current SGW. The canonical node name record of the current SGW can be used by the MME to find all S5/S8 SGW interfaces on the current PGW. This is a smaller example of what follows so we do not detail it further. + +### A.3.10 TAI lookup for "Simple LTE Example" (i.e. SGW candidate list) + +Assume a non-roaming LTE UE performs an initial attach and indicates it wants to use an APN-NI (an APN in this operator's network). The MME knows it does not need to use S8 since it is a non-roaming UE and must be local APN so S5 is used. + +NOTE 1: Reminder \$ORIGIN is epc.mnc990.mcc311.3gppnetwork.org. and is employed here simply to keep the length of the example text manageable. + +The MME has the TAI value where the UE has attached. We assume the low byte of the TAC is hex 11 and the high byte is hex 40. + +The MME starts the S-NAPTR procedure with Application Unique String = tac-lb11.tac-hb40.tac.\$ORIGIN and desired services x-3gpp-sgw:x-s11,x-3gpp-sgw:x-s5-gtp, x-3gpp-sgw:x-s5-pmip. + +NOTE 2: This particular MME vendor looks for the x-s11 values, which is only an optional optimization. This will not have any benefit in this example since the operator chose not to provision them. + +Here we emulate the same action the MME would do manually with the "dig" command. + +MME starts with Application Unique String = tac-lb11.tac-hb40.tac.\$ORIGIN +desired services x-3gpp-sgw:x-s11,x-3gpp-sgw:x-s5-gtp, x-3gpp-sgw:x-s5-pmip + +----- Command to DNS server----- + +command: dig @192.0.2.247 +tcp NAPTR tac-lb11.tac-hb40.tac.\$ORIGIN + +-----Start Response from DNS server----- + +``` +; <<>> DiG 9.5.0-P2-W2 <<>> @192.0.2.247 +tcp NAPTR tac-lb11.tac-hb40.tac.$ORIGIN +``` + +``` +; (1 server found) +``` + +``` +;; global options: printcmd +``` + +``` +;; Got answer: +``` + +``` +;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 622 +``` + +``` +;; flags: qr aa rd; QUERY: 1, ANSWER: 6, AUTHORITY: 2, ADDITIONAL: 26 +``` + +``` +;; WARNING: recursion requested but not available +``` + +``` +;; QUESTION CLAUSE: +``` + +``` +;tac-lb11.tac-hb40.tac.$ORIGIN. IN NAPTR +``` + +``` +;; ANSWER CLAUSE: +``` + +``` +tac-lb11.tac-hb40.tac.$ORIGIN. 3600 IN NAPTR 400 999 "a" "x-3gpp-sgw:x-s8-pmip" "" +``` + +``` +topoff.eth9.gw01.node.$ORIGIN. +``` + +``` +tac-lb11.tac-hb40.tac.$ORIGIN. 3600 IN NAPTR 500 999 "a" "x-3gpp-mme:x-s10" "" +``` + +``` +topoff.eth1.mmec02.mmegi8001.mme.$ORIGIN. +``` + +``` +tac-lb11.tac-hb40.tac.$ORIGIN. 3600 IN NAPTR 600 999 "a" "x-3gpp-mme:x-s10" "" +``` + +``` +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. +``` + +``` +tac-lb11.tac-hb40.tac.$ORIGIN. 3600 IN NAPTR 100 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" +``` + +``` +topoff.eth4.gw21.node.$ORIGIN. +``` + +``` +tac-lb11.tac-hb40.tac.$ORIGIN. 3600 IN NAPTR 200 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" +``` + +``` +topoff.eth4.gw01.node.$ORIGIN. +``` + +``` +tac-lb11.tac-hb40.tac.$ORIGIN. 3600 IN NAPTR 300 999 "a" "x-3gpp-sgw:x-s8-pmip" "" +``` + +``` +topoff.eth9.gw21.node.$ORIGIN. +``` + +``` +;; AUTHORITY CLAUSE: +``` + +``` +$ORIGIN. 3600 IN NS ns2.$ORIGIN. +``` + +``` +$ORIGIN. 3600 IN NS ns1.$ORIGIN. +``` + +``` +;; ADDITIONAL CLAUSE: +``` + +``` +topoff.eth4.gw21.node.$ORIGIN. 3600 IN A 192.0.2.140 +``` + +``` +topoff.eth4.gw21.node.$ORIGIN. 3600 IN A 192.0.2.139 +``` + +``` +topoff.eth4.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:26:: +``` + +``` + +topoff.eth4.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:27:: +topoff.eth4.gw01.node.$ORIGIN. 3600 IN A 192.0.2.132 +topoff.eth4.gw01.node.$ORIGIN. 3600 IN A 192.0.2.131 +topoff.eth4.gw01.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:1e:: +topoff.eth4.gw01.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:1f:: +topoff.eth9.gw21.node.$ORIGIN. 3600 IN A 192.0.2.142 +topoff.eth9.gw01.node.$ORIGIN. 3600 IN A 192.0.2.141 +topoff.eth9.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:28:: +topoff.eth9.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:29:: +topoff.eth9.gw01.node.$ORIGIN. 3600 IN A 192.0.2.134 +topoff.eth9.gw01.node.$ORIGIN. 3600 IN A 192.0.2.133 +topoff.eth9.gw01.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:20:: +topoff.eth9.gw01.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:21:: +topoff.eth1.mmec02.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.18 +topoff.eth1.mmec02.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.17 +topoff.eth1.mmec02.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:0:6:: +topoff.eth1.mmec02.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:0:7:: +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.12 +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.11 +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:: +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:0:1:: +ns1.$ORIGIN. 3600 IN A 192.0.2.247 +ns2.$ORIGIN. 3600 IN A 192.0.2.248 + +;; Query time: 0 msec +;; SERVER: 192.0.2.247#53(192.0.2.247) +;; WHEN: Wed Jan 21 19:33:00 2009 +;; MSG SIZE rcvd: 1285 + +-----End Response from DNS server----- +MME retains only the NAPTR with matching services x-3gpp-sgw:x-s11,x-3gpp-sgw:x-s5-gtp, +and x-3gpp-sgw:x-s5-pmip yielding +NAPTR record set +replacement service flag order preference +topoff.eth4.gw01.node.$ORIGIN x-3gpp-sgw:x-s5-gtp:x-s8-gtp "a" 200 999 +topoff.eth4.gw21.node.$ORIGIN x-3gpp-sgw:x-s5-gtp:x-s8-gtp "a" 100 999 +; Note the x-s8-gtp are not really included but are kept here to allow the +; reader to see which NAPTR record was kept from the DNS response. + +MME node sorts the NAPTR records by RFC 3958 yielding +NAPTR record set +replacement service flag order preference +topoff.eth4.gw21.node.$ORIGIN x-3gpp-sgw:x-s5-gtp:x-s8-gtp "a" 100 999 +topoff.eth4.gw01.node.$ORIGIN x-3gpp-sgw:x-s5-gtp:x-s8-gtp "a" 200 999 + +MME Stores +topoff.eth4.gw21.node.$ORIGIN services of x-3gpp-sgw:x-s5-gtp +topoff.eth4.gw01.node.$ORIGIN services of x-3gpp-sgw:x-s5-gtp + +MME now has candidate list +topoff.eth4.gw21.node.$ORIGIN services of x-3gpp-sgw:x-s5-gtp +topoff.eth4.gw01.node.$ORIGIN services of x-3gpp-sgw:x-s5-gtp + +``` + +Again the A/AAAA records were available in the additional record clause. + +``` + +topoff.eth4.gw21.node.$ORIGIN. 3600 IN A 192.0.2.140 +topoff.eth4.gw21.node.$ORIGIN. 3600 IN A 192.0.2.139 +topoff.eth4.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:26:: +topoff.eth4.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:27:: +and +topoff.eth4.gw01.node.$ORIGIN. 3600 IN A 192.0.2.132 +topoff.eth4.gw01.node.$ORIGIN. 3600 IN A 192.0.2.131 +topoff.eth4.gw01.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:1e:: +topoff.eth4.gw01.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:1f:: + +``` + +NOTE: The size of the response was 1285 bytes and indicates why EDNS0 or TCP transport should be used for S-NAPTR when feasible. Most of the data in the Additional Record Clause would not have been available if only 512 bytes had been sent. + +### A.3.11 Finding the collocated SGW and PGW together + +IP addresses are not included here for readability. + +We are now in a position to look at both the SGW candidate list and PGW candidate list at the same time. + +From A.3.9 we had the PGW candidate list for the APN-NI "imsTV2" was + +``` +topoff.vip1.gw21.node.$ORIGIN services of x-3gpp-pgw:x-s5-gtp +topoff.vip1.gw01.node.$ORIGIN services of x-3gpp-pgw:x-s5-gtp +``` + +From A.3.10 we had the SGW candidate list for TAI where low byte of TAC is hex 11 and the high byte is hex 40 was + +``` +topoff.eth4.gw21.node.$ORIGIN services of x-3gpp-sgw:x-s5-gtp +topoff.eth4.gw01.node.$ORIGIN services of x-3gpp-sgw:x-s5-gtp +``` + +We only have GTPv2 so the protocols match. + +Both nodes gw21.node.\$ORIGIN and gw01.node.\$ORIGIN are collocated. + +Hence, moving the collocated nodes to the front of both lists leaves them unchanged. + +The procedure requires we use the SGW ordering to select the SGW first. + +Hence, the SGW interface to try first is topoff.eth4.gw21.node.\$ORIGIN + +That is node gw21.node.\$ORIGIN. + +That means the PGW record that is collocated is: + +``` +topoff.vip1.gw21.node.$ORIGIN services of x-3gpp-pgw:x-s5-gtp +which is the first PGW interface to try. +``` + +NOTE: It is an "accident" that this is the same order as the APN-NI "imsTV2" gave back. If APN-NI had been "imsTV1" the order would have been reversed in the PGW candidate list and it would NOT have been first. Again the collocation ordering takes precedence. + +The MME would use the IP addresses from the records (not shown) for the S11 Create Session Request attempt. + +Assuming it succeeds we would not need to try any other PGW or SGW records. + +The MME needs the S11 interface so it can physically send the Create Session Request to the SGW. That is covered in the next clause. + +### A.3.12 S11 lookup by SGW canonical node name + +Assume an SGW has been picked with canonical node name of gw21.node.\$ORIGIN + +The MME starts with Application Unique String = gw21.node.\$ORIGIN obtained from the SGW selection with desired services x-3gpp-sgw:x-s11 + +``` +----- Command to DNS server----- +command: dig @192.0.2.247 +tcp NAPTR gw21.node.$ORIGIN +-----Start Response from DNS server----- + +; <<>> DiG 9.5.0-P2-W2 <<>> @192.0.2.247 +tcp NAPTR gw21.node.$ORIGIN +; (1 server found) +;; global options: printcmd +;; Got answer: +;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 23 +;; flags: qr aa rd; QUERY: 1, ANSWER: 5, AUTHORITY: 2, ADDITIONAL: 22 +;; WARNING: recursion requested but not available + +;; QUESTION CLAUSE: +;gw21.node.$ORIGIN. IN NAPTR + +;; ANSWER CLAUSE: +gw21.node.$ORIGIN. 3600 IN NAPTR 600 999 "a" "x-3gpp-sgw:x-s8-pmip" "" +topoff.eth9.gw21.node.$ORIGIN. +gw21.node.$ORIGIN. 3600 IN NAPTR 100 999 "a" "x-3gpp-sgw:x-s11" "" topoff.eth1.gw21.node.$ORIGIN. +``` + +``` + +gw21.node.$ORIGIN. 3600 IN NAPTR 200 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" +topoff.vip1.gw21.node.$ORIGIN. +gw21.node.$ORIGIN. 3600 IN NAPTR 300 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" +topoff.eth4.gw21.node.$ORIGIN. +gw21.node.$ORIGIN. 3600 IN NAPTR 400 999 "a" "x-3gpp-pgw:x-s8-pmip" "" +topoff.vip2.gw21.node.$ORIGIN. + +;; AUTHORITY CLAUSE: +$ORIGIN. 3600 IN NS ns2.$ORIGIN. +$ORIGIN. 3600 IN NS ns1.$ORIGIN. + +;; ADDITIONAL CLAUSE: +topoff.eth1.gw21.node.$ORIGIN. 3600 IN A 192.0.2.138 +topoff.eth1.gw21.node.$ORIGIN. 3600 IN A 192.0.2.137 +topoff.eth1.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:24:: +topoff.eth1.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:25:: +topoff.vip1.gw21.node.$ORIGIN. 3600 IN A 192.0.2.116 +topoff.vip1.gw21.node.$ORIGIN. 3600 IN A 192.0.2.115 +topoff.vip1.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:e:: +topoff.vip1.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:f:: +topoff.eth4.gw21.node.$ORIGIN. 3600 IN A 192.0.2.139 +topoff.eth4.gw21.node.$ORIGIN. 3600 IN A 192.0.2.140 +topoff.eth4.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:27:: +topoff.eth4.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:26:: +topoff.vip2.gw21.node.$ORIGIN. 3600 IN A 192.0.2.136 +topoff.vip2.gw21.node.$ORIGIN. 3600 IN A 192.0.2.135 +topoff.vip2.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:22:: +topoff.vip2.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:23:: +topoff.eth9.gw21.node.$ORIGIN. 3600 IN A 192.0.2.141 +topoff.eth9.gw21.node.$ORIGIN. 3600 IN A 192.0.2.142 +topoff.eth9.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:29:: +topoff.eth9.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:28:: +ns1.$ORIGIN. 3600 IN A 192.0.2.247 +ns2.$ORIGIN. 3600 IN A 192.0.2.248 + +;; Query time: 0 msec +;; SERVER: 192.0.2.247#53(192.0.2.247) +;; WHEN: Wed Jan 21 19:45:36 2009 +;; MSG SIZE rcvd: 1072 + +-----End Response from DNS server----- +MME retains only the NAPTR records with matching service x-3gpp-sgw:x-s11 yielding +NAPTR record set +replacement service flag order preference +topoff.eth1.gw21.node.$ORIGIN x-3gpp-sgw:x-s11 "a" 100 999 +MME node sorts NAPTR by RFC 3958 (trivially here) yielding +NAPTR record set +replacement service flag order preference +topoff.eth1.gw21.node.$ORIGIN x-3gpp-sgw:x-s11 "a" 100 999 +MME Stores +topoff.eth1.gw21.node.$ORIGIN services of x-3gpp-sgw:x-s11 +MME now has candidate list +topoff.eth1.gw21.node.$ORIGIN services of x-3gpp-sgw:x-s11 + +``` + +Again the needed A and AAAA records are in the additional record clause + +``` + +topoff.eth1.gw21.node.$ORIGIN. 3600 IN A 192.0.2.138 +topoff.eth1.gw21.node.$ORIGIN. 3600 IN A 192.0.2.137 +topoff.eth1.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:24:: +topoff.eth1.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:25:: + +``` + +### A.3.13 TAI lookup for "Colocation Simple LTE Example" (i.e. MME candidate list) + +This type of lookup is done for the "Inter eNodeB handover with MME relocation" procedure where the old MME selects the target MME in a new TAI. + +The service is x-3gpp-mme:x-s10 again. + +Since this also starts with the TAI NAPTR lookup we have the same type of record set as the SGW selection from TAI clause (see A.3.10) and to not waste space the same TAC value will be used. + +The only difference from that clause starts with which NAPTR records match. + +From the Answer clause these are: + +``` +;; ANSWER CLAUSE: +tac-lb11.tac-hb40.tac.$ORIGIN. 3600 IN NAPTR 500 999 "a" "x-3gpp-mme:x-s10" "" +topoff.eth1.mmec02.mmegi8001.mme.$ORIGIN. +tac-lb11.tac-hb40.tac.$ORIGIN. 3600 IN NAPTR 600 999 "a" "x-3gpp-mme:x-s10" "" +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. +``` + +Which are already in order. The NAPTR order of 500 is less than NAPTR order of 600. + +So S10 interfaces in order are: + +``` +topoff.eth1.mmec02.mmegi8001.mme.$ORIGIN. +``` + +``` +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. +``` + +and the needed A/AAAA records from the Additional clause in the DNS response in clause A.3.10 are: + +``` +topoff.eth1.mmec02.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.18 +topoff.eth1.mmec02.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.17 +topoff.eth1.mmec02.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:0:6:: +topoff.eth1.mmec02.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:0:7:: + +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.12 +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.11 +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:: +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:0:1:: +``` + +## A.4 LTE Example with Dedicated Core Network + +### A.4.1 General + +The example of an operator network for DCN deployment has same properties as described in A.3.1 with the following modifications: + +- 5) Combined PGW/SGW (01) supports UE usage type of 1, 10, 20 and Combined PGW/SGW (21) supports all the UEs except UEs associated with UE usage type 1, 10, 20. + - 7) Two MME pool areas are defined and each MME pool has two MMEs. The MME pool with MMEGI of 8001 supports UE usage type of 1, 10, 20 where the other MME pool supports all the UEs except UEs associated with UE usage type 1, 10, 20. +- 11) There is only one APN-NI in this network "imsTV1". + +The following figure shows the simple example of DCN deployment. + +![Diagram of DCN deployment showing a hierarchy of network elements. At the top is a cylinder representing the core. Below it are two ovals representing SGW/PGW nodes: SGW/PGW (01) with UE usage type=1, 10, 20 and SGW/PGW (21) with (Default) settings. Each SGW/PGW is connected to an MME group: MMEGI=8001 (containing MME01 and MME02 boxes, with UE usage type=1, 10, 20) and MMEGI=8002 (containing MME03 and MME04 boxes, with (Default) settings). Both MME groups are connected to a common LTE area oval at the bottom.](5801c19431e76330430e92a598cc7a16_img.jpg) + +``` + +graph TD + Core[(Core)] --- SGW01((SGW/PGW (01)
UE usage type=1, 10, 20)) + Core --- SGW21((SGW/PGW (21)
(Default))) + SGW01 --- MMEGI8001((MMEGI=8001
MME01 | MME02
UE usage type=1, 10, 20)) + SGW21 --- MMEGI8002((MMEGI=8002
MME03 | MME04
(Default))) + MMEGI8001 --- LTE_area([LTE area]) + MMEGI8002 --- LTE_area + +``` + +Diagram of DCN deployment showing a hierarchy of network elements. At the top is a cylinder representing the core. Below it are two ovals representing SGW/PGW nodes: SGW/PGW (01) with UE usage type=1, 10, 20 and SGW/PGW (21) with (Default) settings. Each SGW/PGW is connected to an MME group: MMEGI=8001 (containing MME01 and MME02 boxes, with UE usage type=1, 10, 20) and MMEGI=8002 (containing MME03 and MME04 boxes, with (Default) settings). Both MME groups are connected to a common LTE area oval at the bottom. + +Figure A.4.x1-1: Simple example of DCN depolyment + +### A.4.2 APN file for DCN + +The format of the APN FQDN is standardized by 3GPP TS 23.003 [4] clause 19.4.2.2 and is of form .apn.epc.mnc.mcc.3gppnetwork.org. + +Service names are in 3GPP TS 23.003 [4] clause 19.4.3 with +ue- appended to the 'app-protocol' name. + +The file containing the APN records for this example will be CS\_APN\_DB.txt and has following content. + +``` + +imstv1.apn ( +; IN NAPTR order pref. flag service regexp replacement + IN NAPTR 100 999 "a" "x-3gpp-pgw:x-s5-gtp+ue-1.10.20:x-s8-gtp+ue-1.10.20" "" topoff.vip1.gw01.nodes ) + IN NAPTR 200 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" topoff.vip1.gw21.nodes +; IN NAPTR 300 999 "a" "x-3gpp-pgw:x-gn+ue-1.10.20:x-gp+ue-1.10.20" "" topoff.vip3.gw01.nodes +; IN NAPTR 400 999 "a" "x-3gpp-pgw:x-gn:x-gp" "" topoff.vip3.gw21.nodes + IN NAPTR 500 999 "a" "x-3gpp-pgw:x-s8-pmip+ue-1.10.20" "" topoff.vip2.gw01.nodes + IN NAPTR 600 999 "a" "x-3gpp-pgw:x-s8-pmip" "" topoff.vip2.gw21.nodes +;The operator uses PGW01 for UE usage type of 1,10,20 and PGW21 for non DCN user. +;The operator does not support Gn/Gp so those records are commented out + +``` + +### A.4.3 PGW/SGW node file for "Collocated Simple LTE Example" + +The file containing the PGW/SGW canonical node name records (and A/AAAA records for the PGW/SGW nodes) for this example will be CS\_SGW\_PGW\_NODE\_DB.txt and has following content. + +``` + +; Node records for the combined PGW/SGW + +gw01.nodes ( + +``` + +``` + +; IN NAPTR order pref. flag service regexp replacement +; IN NAPTR 200 999 "a" "x-3gpp-pgw:x-s5-gtp+ue-1.10.20:x-s8-gtp+ue-1.10.20" "" +topoff.vip1.gw01.nodes ) +; IN NAPTR 400 999 "a" "x-3gpp-pgw:x-s8-pmip+ue-1.10.20" "" +topoff.vip2.gw01.nodes +; IN NAPTR 500 999 "a" "x-3gpp-pgw:x-gn+ue-1.10.20:x-gp+ue-1.10.20" "" +topoff.vip3.gw01.nodes +; The operator does not support Gn/Gp so those records are commented out +; +; Above are PGW records. + +; Following are SGW records + IN NAPTR 100 999 "a" "x-3gpp-sgw:x-s11+ue-1.10.20" "" topoff.eth1.gw01.nodes + IN NAPTR 300 999 "a" "x-3gpp-sgw:x-s5-gtp+ue-1.10.20:x-s8-gtp+ue-1.10.20" "" +topoff.eth4.gw01.nodes + IN NAPTR 600 999 "a" "x-3gpp-sgw:x-s8-pmip+ue-1.10.20" "" topoff.eth9.gw01.nodes +; IN NAPTR 700 999 "a" "x-3gpp-sgw:x-s4+ue-1.10.20" "" topoff.eth6.gw01.nodes +; IN NAPTR 710 999 "a" "x-3gpp-sgw:x-s12+ue-1.10.20" "" topoff.eth6.gw01.nodes +; IN NAPTR 800 999 "a" "x-3gpp-sgw:x-gn+ue-1.10.20:x-gp+ue-1.10.20" "" +topoff.eth8.gw01.nodes +; The records related to the non supported interfaces are commented out +; +; Same record for the other combined PGW/SGW +; As gw21 does not support any particular UE usage type, so no changes in the existing records + +gw21.nodes ( +; IN NAPTR order pref. flag service regexp replacement + IN NAPTR 200 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" topoff.vip1.gw21.nodes ) + IN NAPTR 400 999 "a" "x-3gpp-pgw:x-s8-pmip" "" topoff.vip2.gw21.nodes +; IN NAPTR 500 999 "a" "x-3gpp-pgw:x-gn:x-gp" "" topoff.vip3.gw21.nodes + +; Above are PGW records. + +; Following are SGW records + IN NAPTR 100 999 "a" "x-3gpp-sgw:x-s11" "" topoff.eth1.gw21.nodes + IN NAPTR 300 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" topoff.eth4.gw21.nodes + IN NAPTR 600 999 "a" "x-3gpp-sgw:x-s8-pmip" "" topoff.eth9.gw21.nodes +; IN NAPTR 700 999 "a" "x-3gpp-sgw:x-s4" "" topoff.eth6.gw21.nodes +; IN NAPTR 710 999 "a" "x-3gpp-sgw:x-s12" "" topoff.eth6.gw21.nodes +; IN NAPTR 800 999 "a" "x-3gpp-sgw:x-gn:x-gp" "" topoff.eth8.gw21.nodes + +; For A/AAAA records, see A.3.6. + +``` + +### A.4.4 TAI/TAC file for DCN + +The format of the TAI/TAC name is standardized by 3GPP 23.003 [4] clause 19.4.2.3 and is of form tac-lb.tac-hb.tac.epc.mnc.mcc.3gppnetwork.org and service names are in 3GPP 23.003 [4] clause 19.4.3 with +ue- appended to the 'app-protocol' name. + +The file containing the TAI/TAC records for this example will be SIMPLE\_TAI\_DB.txt and has following content. + +``` + +; All TAC codes for one region +; MME pool represented by mmegi8001 and mmegi8002 are for DCN user and non DCN user respectively. +*.tac-hb01.tac ( +; IN NAPTR order pref. flag service regexp replacement + IN NAPTR 100 999 "a" "x-3gpp-sgw:x-s5-gtp+ue-1.10.20:x-s8-gtp+ue-1.10.20" "" +topoff.eth4.gw01.nodes ) + IN NAPTR 200 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" topoff.eth4.gw21.nodes + IN NAPTR 300 999 "a" "x-3gpp-sgw:x-s8-pmip+ue-1.10.20" "" topoff.eth9.gw01.nodes + IN NAPTR 400 999 "a" "x-3gpp-sgw:x-s8-pmip" "" topoff.eth9.gw21.nodes +; The operator uses PGW01 for UE usage type of 1,10,20 and PGW21 for non DCN user. +; Above records are needed for SGW selection in initial attach of a UE (or TAU or handover attach) +; + IN NAPTR 500 999 "a" "x-3gpp-mme:x-s10+ue-1.10.20" "" topoff.eth1.mmec01.mmegi8001.mme + IN NAPTR 600 999 "a" "x-3gpp-mme:x-s10+ue-1.10.20" "" topoff.eth1.mmec02.mmegi8001.mme + IN NAPTR 700 999 "a" "x-3gpp-mme:x-s10" "" topoff.eth1.mmec03.mmegi8002.mme + IN NAPTR 800 999 "a" "x-3gpp-mme:x-s10" "" topoff.eth1.mmec04.mmegi8002.mme +; From the above records with +ue-, MMEGI information can be retrieved when +necessary. +; + +*.tac-hb40.tac ( +; IN NAPTR order pref. flag service regexp replacement + +``` + +``` +IN NAPTR 100 999 "a" "x-3gpp-sgw:x-s5-gtp+ue-1.10.20:x-s8-gtp+ue-1.10.20" "" +topoff.eth4.gw01.nodes ) +IN NAPTR 200 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" topoff.eth4.gw21.nodes +IN NAPTR 300 999 "a" "x-3gpp-sgw:x-s8-pmip+ue-1.10.20" "" topoff.eth9.gw01.nodes +IN NAPTR 400 999 "a" "x-3gpp-sgw:x-s8-pmip" "" topoff.eth9.gw21.nodes +; +IN NAPTR 600 999 "a" "x-3gpp-mme:x-s10+ue-1.10.20" "" topoff.eth1.mmec01.mmegi8001.mme +IN NAPTR 500 999 "a" "x-3gpp-mme:x-s10+ue-1.10.20" "" topoff.eth1.mmec02.mmegi8001.mme +IN NAPTR 800 999 "a" "x-3gpp-mme:x-s10" "" topoff.eth1.mmec03.mmegi8002.mme +IN NAPTR 700 999 "a" "x-3gpp-mme:x-s10" "" topoff.eth1.mmec04.mmegi8002.mme +; From the above records with +ue-, MMEGI information can be retrieved when +necessary. +; +``` + +# --- Annex B (Normative): DNS procedures clarifications + +## B.1 DNS RFC procedures general clarifications + +This clause clarifies DNS resolver use of the S-NAPTR procedures in EPC core network nodes. + +NOTE: The only EPC core network nodes identified explicitly at this time that employ S-NAPTR procedures are the MME and Release 8 SGSN. + +DNS resolvers in EPC core network nodes shall support recursive queries and responses over UDP transport as specified in IETF RFC 1035 [3]. The EPC core network nodes may assume the existence of a local caching DNS server (see GSMA PRD IR.67 [5]) and hence may not need to do iterative queries as specified in IETF RFC 1035 [3]. However, the final deployment decision of local caching DNS servers is up to the operators. It is recommended that the EPC core network nodes support DNS queries and responses over TCP transport up to the 65535 byte maximum. Support of IETF RFC 2671 [13] (EDNS0) is recommended, in order to allow DNS response packets sizes over 512 octets when using UDP transport. + +It is recommended that resolvers in EPC core network nodes cache frequently used DNS queries in order to lower load on DNS infrastructure. + +EPC core network nodes shall support SRV records as specified in IETF RFC 2782 [8]. However, in the 3GPP scope the ordering of SRV records of the same priority SHALL use the algorithm described in IETF RFC 2782 [8] page 4 instead of the the "SHOULD" requirement in the IETF RFC. This is a 3GPP specific requirement to strengthen the described algorithm and actually allow predictable behavior of the IETF RFC 2782 [8] based load balancing. + +## --- B.2 DNS procedures 3GPP clarifications on S-NAPTR + +IETF RFC 3958 [9] S-NAPTR procedures are unmodified with an exception of the following clarifications on the topological closeness and multi-protocol support: + +- 1) For topological closeness the "topon" label matching of clause 4.3.2 of the present document takes precedence over NAPTR ordering but NAPTR ordering is still used when matching label lengths are equal. Therefore, a full list of "candidate" records is needed as sketched in Appendix A.2 of IETF RFC 3958 [9], which in turn requires "backtracking" as described by IETF RFC 3958 [9] clause 2.2.4. When collocation is to be considered applicable in a procedure it takes precedence in ordering over both "topon" and NAPTR ordering regardless of the value of the "topon|topoff" label. +- 2) IETF RFC 3958 [9] has an ambiguity for S-NAPTR with multiple protocols in last paragraph of clause 2.2.5 "It MAY choose to run simultaneous DDDS resolutions for more than one protocol, in which case the requirements above apply for each protocol independently. That is, do not switch protocols mid- resolution." The term "simultaneous DDDS resolutions" and "apply for each protocol independently" are not defined and can have different meanings. To resolve that ambiguity in S-NAPTR, the present document formally defines "Service description meeting the client requirement" from IETF RFC 3402 [14] clause 3.3 step 4 as a NAPTR record with one or more of the 3GPP desired service and protocol field pair(s) and such that all ancestor NAPTR records in the current path to this point also include the identified service and protocol in the DDDS procedure. The present document uses that as the definition of "simultaneous DDDS resolutions". See clause C.1 for more practical information on this point. +- 3) Strict ordering within S-NAPTR is obtained from the NAPTR order value as required in IETF RFC 3402 [14] and IETF RFC 3958 [8]. The value of (65535- NAPTR preference) shall be used as a statistical weight the same way the SRV weight is used on page 4 of IETF RFC 2782 [8] for SRV records. + +Items 1) , 2) and 3) impact the ordering of DNS records in which they are returned by the S-NAPTR procedure. Items 1) and 2) also involve areas where the IETF RFC 3958 [9] only provides a sketch of the procedures needed and implicitly relies on IETF RFC 3402 [14] for details. To clarify these points as well as to guide implementations informative pseudo-code is provided in clauses C.1, C.2 and C.3. Item 3) allows an operators to load balance within one + +NAPTR record set without employing SRV records giving a simpler DNS provisioning and potentially reducing the number of DNS queries. + +## B.3 DNS procedures 3GPP clarifications for Dedicated Core Networks + +When the app-protocol as input to the S-NAPTR procedure has the substring with at least +ue included, then any app-protocol returned from DNS shall be considered to match as follows. The characters following the + character follows the ABNF grammar as follows. + +``` +"ue-" (USAGENUM)*( " ." USAGENUM) +USAGENUM = 1*3(DIGIT) +DIGIT = %x30-39; 0-9 +``` + +A record with any USAGENUM matching the input type value shall be considered as matching. As an example, x-s10+ue-8 as S-NAPTR input shall match a record with x-s10+ue-3.8.10.38, but shall not match a record with x-s10+ue-3.10.38. + +## B.4 DNS procedures 3GPP clarifications for Network Capability + +When the app-protocol as input to the S-NAPTR procedure has the substring with at least +nc included, then any app-protocol returned from DNS shall be considered to match as follows. The characters following the +nc follows the ABNF grammar as follows. + +``` +"nc-" (NETCAP)*( " ." NETCAP) +NETCAP = 1*5(DIGIT / ALPHA) +DIGIT = %x30-39; 0-9 +ALPHA = %x41-5A / %x61-7A; A-Z / a-z +``` + +A record with any NETCAP matching the input value shall be considered as matching. As an example, x-s5-gtp+nc-nr as S-NAPTR input shall match a record with x-s5-gtp+nc-nr.5gs, but shall not match a record with x-s5-gtp+nc-nrs. + +# Annex C (Informative): DNS Pseudo-Code + +## C.1 S-NAPTR procedure base pseudo-code + +The primary purpose of clause C.1 is to show practically any differences that are normatively documented in clause B.2. The changes to the IETF RFC 3958 [9] pseudo-code make this much clearer and self-contained than the normative text from clause B.2. + +The pseudo-code immediately following is the pseudo-code from IETF RFC 3958 [9] Appendix A.1 modified to incorporate the clarifications from clause B.2. + +``` +target = [initial domain] +; Next line is changed from Appendix A.1 of RFC 3958 +usable-service-protocol-set = [initial desired service and protocol pairs] + +naptr-done = false + +while (not naptr-done) +``` + +``` + +{ + NAPTR-RRset = [DNSlookup of NAPTR RRs for target] +; Next two lines are changed from Appendix A.1 of RFC 3958 + NAPTR weight := 65535 - NAPTR PREF for each RR + [sort NAPTR by ORDER, and by statistical NAPTR weight within each ORDER] + rr-done = false + cur-rr = [first NAPTR RR] + + while (not rr-done) +; Next three lines are changed from Appendix A.1 of RFC 3958 + compatable-service-protocol-set = [ [usable-service-protocol-set] set interclause with + [SERVICE field of cur-rr] ] + if ([compatable-service-protocol-set] is not empty) + rr-done = true + target= [REPLACEMENT target of NAPTR RR] +; Next line is changed from Appendix A.1 of RFC 3958 + usable-service-protocol-set = [compatable-service-protocol-set] + else + cur-rr = [next rr in list] + + if (not empty [FLAG in cur-rr]) + naptr-done = true +} + +port = -1 + +if ([FLAG in cur-rr is "S"]) +{ + SRV-RRset = [DNSlookup of SRV RRs for target] +; Next line is changed from Appendix A.1 + [Sort SRV RRset using the algorithm described on page 4 of IETF RFC 2782 [8]] + target = [target of first RR of SRV-RRset] + port = [port in first RR of SRV-RRset] +} + +; now, whether it was an "S" or an "A" in the NAPTR, we +; have the target for an A record lookup +; Remaining lines are changed from Appendix A.1 of RFC 3958 +; or AAAA record lookup + +IPv4_hosts = [DNSlookup of A RRs for target] +IPv6_hosts = [DNSlookup of AAAA RRs for target] +randomized order of IPv4_hosts and IPv6_hosts +hostname = [target] +return (hostname, usable-service-protocol-set, IPv4_hosts, IPv6_hosts, port) + +``` + +The significant differences in the above Pseudo-Code and the IETF RFC 3958 [9] Pseudo-Code are : + +- A) [Sort SRV RRset using the algorithm described on page 4 of IETF RFC 2782 [8]] + which was changed from + [sort SRV-RRset based on PREF] + The Pseudo-Code in IETF RFC 3958 [9] simply has an error. There isn't even a PREF in a SRV record. Again see page 4 of IETF RFC 2782 [8] for the proper procedure. + The NAPTR weight is defined to be 65535 - NAPTR preference and is handled analogously to the SRV case. +- B) IETF RFC 3958 [9] Appendix A.1 starts with "Assuming the client supports 1 protocol for a particular application" so the pseudo-code obviously was designed for one protocol at a time. The lines with usable-service-protocol-set and compatable-service-protocol-set above are the most important change to support multiple service/protocol combinations and are really the primary reason for providing the above Pseudo-Code. + +There are two possible ways to interpret the last paragraph of clause 2.2.5 of IETF RFC 3958 [9] when a list of multiple services/protocols is desired. One is the above interpretation using "set interclause" which allows multiple services/protocols. The other is to run the above procedure for one service and protocol at a time from the "desired service\_ and\_protocol\_set" and get a separate list for each service and protocol. In both approaches the relative ordering within a particular service and protocol is identical. If the proper interpretation of IETF RFC 3958 [9] is one service and protocol at a time, then the IETF RFC 3958 [9] does not define order between different service or protocols. Thus 3GPP is free to order between different 3GPP service and protocol types so long as the order within a service and protocol is + +respected. The above method does respect the order within a service and protocol therefore it is valid in either interpretation of clause 2.2.5 of IETF RFC 3958 [9] and also valid in IETF RFC 3402 [14]. + +The remaining changes in Pseudo-Code above are minor and mostly intended to show that the S-NAPTR procedure logically outputs following: + +(hostname, usable-service-protocol-set, IPv4\_hosts, IPv6\_hosts, port) + +where the returned hostname is the FQDN of the topologically aware node name with topon/topoff and interface information. + +NOTE: Lookup of the A and AAAA records to get the IPv4 and IPv6 addresses may be deferred until they are needed to contact a selected server as an optional optimization. + +In the 3GPP scope, a full implementation of RFC 3958 SHALL implement "backtracking" as described by IETF RFC 3958 [9] clause 2.2.4 as required in clause B.2. + +For simplicity of the presentation in this Annex we assume a full IETF RFC 3958 [9] implementation with a call back interface as described in Appendix A.2 of the IETF RFC 3958 [9]. + +``` +procedure S_NAPTR_to_callback(targetFQDN, + desired_service_and_protocol_set, + call_back_function) +``` + +where the call\_back\_function has interface + +``` +call_back_function (hostname, usable_service_and_protocol_set, port, IPv4_list, IPv6_list) +``` + +The call\_back\_function returns "stop" if it does not want more records otherwise it returns "looking" and will be called with the next record. + +## C.2 S-NAPTR procedure - no topon + +If topological closeness is not stated as specifically applicable to a procedure, or all node names are prefixed with "topoff", and if collocation is stated as not applicable to a procedure, then the first interface that can be successfully connected to would be sufficient to be returned from the S-NAPTR procedure. The following pseudo-code shows how the procedure works. + +``` +/* + * The Callback function called from the S-NAPTR procedure + * for each FQDN the S-NAPTR procedure finds.. + */ +procedure try_to_connect (hostname, service_and_protocol_set, port, IP4_list, IP6_list) + Begin procedure + // Comment does procedure as outlined in C.1 + Use 3GPP procedures to try to connect in turn to all combinations + of the service/protocols and IP addresses provided in the input. + Upon first success return(stop); + If all fail return(looking); + End procedure; +}; + +/* + * The S-NAPTR procedure follows + */ + +procedure connect_first_match (targetFQDN, desired_protocol_set) + Begin procedure + status:=S_NAPTR_to_callback(targetFQDN, + desired_service_and_protocol_set , + try_to_connect); + if status equals looking return(failure) else return(success); + End procedure; +``` + +## C.3 S-NAPTR procedure candidate list + +The following procedure will get the complete candidate list. This is the "sorted list of matches" described in Appendix A.2 of IETF RFC 3958 [9]. This is used for an exhaustive search of all matches. + +If the "topon" feature is specifically applicable to find "close" nodes, or collocation is applicable, then the simple approach of getting the first match as described in clause C.2 cannot be used. The S-NAPTR must be performed by exhaustive searching for all matching records since the best match by "topon" node name can be any record independent of S-NAPTR record ordering. + +``` + +/* + * The Callback function called by the S-NAPTR procedure for + * each found match.. + */ + +procedure private_store_candidate_list (hostname, service_and_protocol_set, port, IP4_list, IP6_list) + Begin procedure + increment snaptr_output_order; + create structure with fields + (hostname, service_and_protocol_set, port, IP4_list, IP6_list, snaptr_output_order, List_Name) + add structure to end of candidate_list; + return(looking); + End procedure; + +/* + * The procedure to find all candidate nodes. + */ + +procedure get_candidate_list (targetFQDN, desired_service_and_protocol_set, List_Name) + Begin procedure + candidate_list:= empty; + snaptr_output_order:=0; + + /* + * The S-NAPTR resolving starts here. + */ + status:=S_NAPTR_to_callback(targetFQDN, + desired_service_and_protocol_set , + private_store_candidate_list); + + return(candidate_list); + End procedure; + +``` + +The procedure includes the NAPTR output ordering explicitly as a field with each record which is important in the context of "topon" matches and checks for collocated nodes. + +## C.4 S-NAPTR procedure pseudo-code with topon + +Collocation, when stated as specifically applicable in a procedure, takes precedence over other criteria such as topological ordering or S-NAPTR ordering. Topological ordering, when stated as specifically applicable in a procedure, takes precedence over S-NAPTR ordering. However, S-NAPTR ordering is used for ordering nodes with equivalent topological distances. Pseudo code below is informative and shows how to implement the ordering of record selection. See clause 4.3.2 for normative text. + +Assume two distinct types of nodes "A" and "B" are being checked for closeness and the best record pair is needed. First step, which is documented in each case in the main text of this document is to get two candidate lists using a procedure such as that outlined in clause C.3. + +``` + +candidate_list_A:= get_candidates (targetFQDN_A, desired_service_and_protocol_set_A, "A"); +candidate_list_B:= get_candidates (targetFQDN_B, desired_service_and_protocol_set_B, "B"); + +``` + +As an example take the selection of a PGW and SGW by an MME during a UE initial attach procedure. Both a PGW and SGW need to be selected and if "topon" is used in both lists the selected pair is to be as close as possible (collocated being the closest). + +Sometimes one list in the procedure is not found by DNS (or was found previously) because the node was already selected. In that case, one of the candidate lists can be just one node. + +For example, an UE with an existing PDN connection adds a new PDN connection to a different APN, which may result in a different PGW but needs to continue using the current SGW. Here one of the two candidate lists would just be the data for the current SGW node (i.e., its node name and whether it supports GTPv2 and/or PMIPv6 for S5/S8). + +The following pseudo-code illustrates topological matching with full ordering. + +``` + +procedure topo_matching (candidate_list_A, candidate_list_B, topology_check, colocation_check) // +Comment: topology_check and colocation_check are booleans indicating if those checks are done + Begin procedure + paired_sets_list:=empty; + if (colocation_check) + Begin if + total_list:= candidate_list_A appended with candidate_list B; + // Comment: Below canonical_node_name is the hostname with first two labels removed + Foreach unique canonical_node_name from total_list do + Begin foreach + Foreach service and protocol do + Begin foreach + full_match_list:= get all records from total_list with service and protocol + and canonical_node name + If there is at least one "A" record and one "B" record in full_match_list then + Begin If + degree:=256; + suffix:=canonical_node_name; + create structure with fields + (degree, suffix, service_and_protocol, full_match_list) + add that structure to paired_sets_list + End If + End foreach + End foreach + End foreach + End foreach + End if; + if (topology_check) + Begin if + max_labels:=( maximum number of DNS labels in total_list)- 2 + else + max_labels =0; + End If; + + from number_labels_to_match:= max_labels down to 0 do + Begin do + if number_labels_to_match equals 0 then + Begin if + total_list:= candidate_list_A appended with candidate_list B + else + total_list:= get all records from candidate_list_A and candidate_list_B + with "topon" as first label and hostname has at least + (number_labels_to_match+2) labels + // Comment: Add 2 since the first two labels are not part of the node name + End If; + + // Comment: Below suffix is a hostname chopped off to include only the last number_labels_to_match + Foreach unique suffix from total_list do + Begin foreach + Foreach service and protocol do + Begin foreach + full_match_list:= get all records from total_list with service and protocol + and suffix contained in end of the hostname + If there is at least one "A" record and one "B" record in full_match_list then + Begin If + degree:=number_labels + create structure with fields + (degree, suffix, service_and_protocol, full_match_list) + add that structure to paired_sets_list + End If + End foreach + End foreach + End foreach + End do + end do + end if + end if + end if + end if + end procedure + sort paired sets by degree + return (paired_sets_list) +End Procedure; + +``` + +NOTE 1: Matching collocated nodes get a degree of 256, which is above any normal match. Also the above procedure is specific to this document and is not a part of S-NAPTR. + +NOTE 2: Order from S-NAPTR is from one S-NAPTR procedure. There is no meaningful order obtained from S-NAPTR between records from two different S-NAPTR procedures. So one node type will be selected "logically first" based on other criteria outside S-NAPTR information. + +The above procedure simply creates a list of records which are sorted by decreasing degree of matching in DNS labels. It also gives the list of paired nodes with the same suffix and compatible service which is needed by the 3GPP application. + +Since highest degree is preferred over S-NAPTR ordering with "topon" labels the selection is done by degree starting with the highest degree obtaining only the possible "A" and "B" nodes at that degree. A sublist of the paired\_sets\_list containing the highest degree is taken from paired\_sets\_list denoted as degree\_sublist. Assume the "A" node is to be selected "logically first". Sort the "A" parts of degree\_sublist in increasing "snaptr\_output\_order". For the records in that order try to connect to the node with the service and protocol in the record using 3GPP procedures. On failure proceed with the next record. When that degree\_sublist is exhausted then degree-1 is tried and so on until an "A" node is selected. Once an "A" node is chosen, the procedure has also a selected degree, suffix and service. + +NOTE 3: The remaining part of this procedure is not needed if the "B" node was already pre-selected outside the present procedure. + +Taking the degree\_sublist used to select the "A" node create a new sublist from only records with the same service, same protocol and suffix. Remove the "A" node records from that sublist. Sort this new sublist by increasing "snaptr\_output\_order" (see clause C.3). Using the records in that order try to connect to the "B" nodes with the service and protocol in the record. On a failure proceed with the next record. When that list is exhausted the procedure continues in next paragraph. + +NOTE 4: The suffix of the "A" node that was selected influences which "B" nodes are closest to it. We can't easily and simply reuse the above structure for that reason and it is easier to "reset" the procedure. + +A new candidate\_list\_A is created consisting only of the selected "A" node A and service\_and\_protocol. The procedure "topo\_matching" is run again giving a new paired\_sets\_list. The "A" node records are removed from the new paired\_sets\_list leaving only "B" nodes. Sort the records in paired\_sets\_list in decreasing order of degree and within degree in increasing "snaptr\_output\_order" (see clause C.3). Using the records in that order try to connect to the "B" nodes with the service in the record. On failure go to next record. + +NOTE 5: Failing to actually contact a node should result in the failing node(s) to be removed from consideration for a period of time. Such removal is not detailed above. Also a reasonable implementation would give up after some maximum number of failed attempts. + +# Annex D (Informative): SGSN examples + +## D.1 Introduction + +This annex includes examples of the DNS provisioning needed for an SGSN discovery and selection procedures. Examples are not exhaustive either in scope or in content but are intended to be sufficient to illustrate the general techniques and some of the more important use cases. + +## D.2 Preconditions + +Provisions of annex A.2 apply also here. + +## D.3 SGSN file + +A NAPTR record is required to be provisioned under the NRI-RAI FQDN (see clause 4.3.3.5 of this TS). The format of the NRI-RAI FQDN is nri-sgsn.rac.lac.rac as defined in clause 19.4.2.6 of 3GPP TS 23.003 [4]. + +The nri-sgsn.rac.lac.rac is also the natural place for the SGSN canonical node record set. For this example we place the SGSN canonical node records and the required record for the lookup at the same location both for simplicity and better DNS caching. + +For this example we have two SGSNs with NRI codes of 1 and 2 respectively and both in the same SGSN pool (LAC = 1000 hexadecimal and RAC = 0003 hexadecimal). + +``` +; +; This is the P-TMSI and RAI related record and the SGSN node record +; The operator has decided to use the 3GPP name as the canonical node name of the SGSN +; rather than having two records (the 3GPP one and an operator defined value) +; +nri-sgsn01.rac0003.lac1001.rac +; IN NAPTR order pref. flag service regexp replacement + + IN NAPTR 200 999 "a" "x-3gpp-sgsn:x-s4" "" topoff.eth1.nri-sgsn01.rac0003.lac1001.rac + IN NAPTR 200 999 "a" "x-3gpp-sgsn:x-s3" "" topoff.eth2.nri-sgsn01.rac0003.lac1001.rac + IN NAPTR 300 999 "a" "x-3gpp-sgsn:x-gn" "" topoff.eth3.nri-sgsn01.rac0003.lac1001.rac + +; +; Reminder: Canonical node name records must be complete. +; In most cases the interface type (S3 etc) is functionally determined so the NAPTR order is rarely +; used in this record set. The S3 is preferred over over Gn. +; +; Of course if the SGSN had multiple S3 interfaces +; the operator could provision more than one S3 record with different orders +; perhaps to select S3 IPv6 over S3 IPv4 + +; We have the same type of records for the other SGSN (same comments would apply) + +; +nri-sgsn02.rac0003.lac1001.rac +; IN NAPTR order pref. flag service regexp replacement + + IN NAPTR 200 999 "a" "x-3gpp-sgsn:x-s4" "" topoff.eth1.nri-sgsn02.rac0003.lac1001.rac + IN NAPTR 200 999 "a" "x-3gpp-sgsn:x-s3" "" topoff.eth2.nri-sgsn02.rac0003.lac1001.rac + IN NAPTR 300 999 "a" "x-3gpp-sgsn:x-gn" "" topoff.eth3.nri-sgsn02.rac0003.lac1001.rac + +; +; All SGSN IP addresses for both SGSNs +; +topoff.eth1.nri-sgsn01.rac0003.lac1001.rac IN A 192.0.2.11 + IN A 192.0.2.12 + IN AAAA 2001:db8:0:0:0:0:0:0 + IN AAAA 2001:db8:0:1:0:0:0:0 +``` + +``` + +topoff.eth2.nri-sgsn01.rac0003.lac1001.rac IN A 192.0.2.13 + IN A 192.0.2.14 + IN AAAA 2001:db8:0:2:0:0:0:0 + IN AAAA 2001:db8:0:3:0:0:0:0 +topoff.eth3.nri-sgsn01.rac0003.lac1001.rac IN A 192.0.2.15 + IN A 192.0.2.16 + IN AAAA 2001:db8:0:4:0:0:0:0 + IN AAAA 2001:db8:0:5:0:0:0:0 +topoff.eth1.nri-sgsn02.rac0003.lac1001.rac IN A 192.0.2.17 + IN A 192.0.2.18 + IN AAAA 2001:db8:0:6:0:0:0:0 + IN AAAA 2001:db8:0:7:0:0:0:0 +topoff.eth2.nri-sgsn02.rac0003.lac1001.rac IN A 192.0.2.19 + IN A 192.0.2.20 + IN AAAA 2001:db8:0:8:0:0:0:0 + IN AAAA 2001:db8:0:9:0:0:0:0 +topoff.eth3.nri-sgsn02.rac0003.lac1001.rac IN A 192.0.2.21 + IN A 192.0.2.22 + IN AAAA 2001:db8:0:10:0:0:0:0 + IN AAAA 2001:db8:0:11:0:0:0:0 + +; end of file + +``` + +The partially qualified SGSN host names are topoff.eth1.nri-sgsn01.rac0003.lac1001.rac and topoff.eth1.nri-sgsn02.rac0003.lac1001.rac, and similar. + +The fully qualified SGSN node names are the relatively long + +nri-sgsn01.rac0003.lac1001.rac.epc.mnc990.mcc311.3gppnetwork.org. + +and + +nri-sgsn02.rac0003.lac1001.rac.epc.mnc990.mcc311.3gppnetwork.org. + +which are obtained by appending the value of \$ORIGIN to the partially qualified SGSN node names. As stated before we will use the partially qualified names in this Annex to avoid this visual clutter and for typographical reasons. + +## D.4 Null-NRI/SGSN Group ID file for DCN + +A NAPTR record is required to be provisioned under the RAI FQDN (see clause 5.8.3). The format of the RAI FQDN is rac.lac.rac as defined in clause 19.4.2.5 of 3GPP TS 23.003 [4]. + +For this example we have two SGSN pools represented by SGSN Group ID (sgsngi=0001) and Null-NRI (null-nri=0005). Each pool has two SGSNs with NRI code of 1, 2 and 3, 4 respectively. + +``` + +; +rac0003.lac1001.rac +; IN NAPTR order pref. flag service regexp replacement + + IN NAPTR 100 999 "a" "x-3gpp-sgsn:x-gn+ue-1.10.20" "" topoff.eth1.nri- +sgsn0001.sgsngi0001.rac0003.lac1001.rac + IN NAPTR 200 999 "a" "x-3gpp-sgsn:x-s16+ue-1.10.20" "" topoff.eth3.nri- +sgsn0002.sgsngi0001.rac0003.lac1001.rac + IN NAPTR 100 999 "a" "x-3gpp-sgsn:x-gn+ue-2.5" "" topoff.eth1.nri-sgsn0003.null- +nri0005.rac0003.lac1001.rac + IN NAPTR 200 999 "a" "x-3gpp-sgsn:x-s16+ue-2.5" "" topoff.eth3.nri-sgsn0004.null- +nri0005.rac0003.lac1001.rac + +; +;From above records, Null-NRI and SGSN Group ID information can be retrieved when necessary. + +``` + +# --- Annex E (Informative): SGW/PGW selection examples using GTP-C load control + +## E.1 PGW selection using GTP-C load control at node level + +This example illustrates the principles of the SGW or PGW selection specified in clause 4A.2, with GTP-C load control supported and enabled at node level. + +The example assumes that the procedures specified in this document have 3 candidate PGWs with the same relative order, (e.g. with the same topological order) and assume that the following weights are received from the DNS and "Load Metric" reported via GTP-C signalling: + +PGW1: DNS-weight-factor = 20, Load-metric = 10% + +PGW2: DNS-weight-factor = 20, Load-metric = 20% + +PGW3: DNS-weight-factor = 60, Load-metric= 30% + +Based on the above, the selecting node calculates the effective available load for each candidate PGW: + +PGW1-effective-available-load = $(100 - 10)\% \times 20 = 18$ + +PGW2-effective-available-load = $(100 - 20)\% \times 20 = 16$ + +PGW3-effective-available-load = $(100 - 30)\% \times 60 = 42$ + +The selecting node then calculates the relative available load of each candidate PGW (rounding-off to nearest integer value): + +PGW1-relative-available-load = $18 / (18 + 16 + 42) \approx 24\%$ + +PGW2-relative-available-load = $16 / (18 + 16 + 42) \approx 21\%$ + +PGW3-relative-available-load = $42 / (18 + 16 + 42) \approx 55\%$ + +Out of the total new session requests, the node selects the PGW1, PGW2 and PGW3 for 24%, 21% and 55% respectively, e.g. per 100 new sessions requests, the PGW1 is selected for 24 sessions, PGW2 for 21 sessions and PGW3 for the remaining 55 new sessions. + +## --- E.2 PGW selection using GTP-C load control at APN level + +### E. 2.1 PGW selection when APN load control information is available for each candidate PGW + +This example illustrates the principles of the PGW selection specified in clause 4A.3, with GTP-C load control supported and enabled at node level and APN level. + +The example assumes that the procedures specified in this document have 3 candidate PGWs with the same relative order, (e.g. with the same topological order) and assume that the following weights are received from the DNS and APN load control information reported via GTP-C signalling: + +PGW1: DNS-weight-factor = 20, APN1-Load-metric = 60%, APN1-relative-capacity = 50% + +PGW2: DNS-weight-factor = 20, APN1-Load-metric = 50%, APN1-relative-capacity = 20% + +PGW3: DNS-weight-factor = 60, APN1-Load-metric= 50%, APN1-relative-capacity = 10% + +Based on the above, the APN1-effective-available-load is calculated as follows: + +PGW1-APN1-effective-available-load = (100 – 60)% X 50% X 20 = 4 + +PGW2-APN1-effective-available-load = (100 – 50)% X 20% X 20 = 2 + +PGW3-APN1-effective-available-load = (100 – 50)% X 10% X 60 = 3 + +Then the APN1-relative-available-load is calculated as below (by rounding-off to nearest integer value): + +PGW1-APN1-relative-available-load = 4 / (4 + 2 + 3) = ~ 45% + +PGW2-APN1-relative-available-load = 2 / (4 + 2 + 3) = ~ 22% + +PGW3-APN1-relative-available-load = 3 / (4 + 2 + 3) = ~ 33% + +Out of the total new session requests for APN1, the PGW1 is selected for 45%, PGW2 for 22% and PGW3 for 33%, e.g. per 100 new sessions requests for APN1, the PGW1 is selected for 45 sessions, PGW2 for 22 sessions and PGW3 for 33 sessions. + +### E.2.2 PGW selection when APN load control information is not available for each candidate PGW + +This example illustrates the principles of the PGW selection specified in clause 4A.3, with GTP-C load control supported and enabled at node level and APN level. + +The example assumes that the procedures specified in this document have 3 candidate PGWs with the same relative order, (e.g. with the same topological order) and assume that the following weights are received from the DNS and APN load control information reported via GTP-C signalling; it is assumed in particular that PGW3 did only report APN load control information for the APN2. + +PGW1: DNS-weight-factor = 20, APN1-Load-metric = 60%, APN1-relative-capacity = 50% + +PGW2: DNS-weight-factor = 20, APN1-Load-metric = 50%, APN1-relative-capacity = 20% + +PGW3: DNS-weight-factor = 60, APN2-Load-metric= 50%, APN2-relative-capacity = 30%, PGW3-Load-Metric 40% + +Based on the above, the APN1-effective-available-load for the PGW3 is calculated assuming the following: + +PGW3-APN1-relative-capacity = 100% – 30% = 70% + +PGW3-APN1-load-metric = {40% - (50% X 30%)} / {(100% – 30%)} = {40% - 15%} / {70%} = ~36% + +# Annex F (Informative): Examples for AMF Discovery by 5G AN + +## F.1 Introduction + +This annex provides examples of DNS provisioning for AMF Discovery by 5G AN. + +## F.2 Preconditions + +See annex A.2. + +## F.3 Example of an AMF Region with 2 AMF Sets + +### F.3.1 Master file + +The master file for this example has following content. + +``` +$ORIGIN 5gc.mnc990.mcc311.3gppnetwork.org. +; +$TTL 600 ; 10 minutes - this directive is defined in IETF RFC 2308 not IETF RFC 1035 +; +$INCLUDE SOA_DB.txt +; +$INCLUDE AMFSET_DB.txt +; +; End of file +``` + +### F.3.2 SOA and NS records + +See Annex A.3.3. + +### F.3.3 AMF Set file + +The file containing the AMF Set records for this example will be AMFSET\_DB.txt and has following NAPTR record content. + +In this example, we have two AMF Sets 1 and 2, in AMF Region 48 (hexadecimal), with 2 AMFs available in each AMF Set. + +``` +; AMF Set 1 of AMF Region 48 + +set001.region48.amfset +; IN NAPTR order pref. flag service regexp replacement + IN NAPTR 100 999 "a" "x-3gpp-amf:x-n2" "" topoff.amf11.amf + IN NAPTR 100 999 "a" "x-3gpp-amf:x-n2" "" topoff.amf12.amf + +; AMF Set 2 of AMF Region 48 +set002.region48.amfset +; IN NAPTR order pref. flag service regexp replacement + IN NAPTR 100 999 "a" "x-3gpp-amf:x-n2" "" topoff.amf21.amf + IN NAPTR 100 999 "a" "x-3gpp-amf:x-n2" "" topoff.amf22.amf + +; AMFs IP addresses +; +topoff.amf11.amf IN A 192.0.2.11 + IN A 192.0.2.12 + IN AAAA 2001:db8:0:0:0:0:0:0 + IN AAAA 2001:db8:0:1:0:0:0:0 +topoff.amf12.amf IN A 192.0.2.13 + IN A 192.0.2.14 + IN AAAA 2001:db8:0:2:0:0:0:0 + IN AAAA 2001:db8:0:3:0:0:0:0 +topoff.amf21.amf IN A 192.0.2.17 + IN A 192.0.2.18 + IN AAAA 2001:db8:0:6:0:0:0:0 + IN AAAA 2001:db8:0:7:0:0:0:0 +topoff.amf22.amf IN A 192.0.2.19 + IN A 192.0.2.110 + IN AAAA 2001:db8:0:8:0:0:0:0 + IN AAAA 2001:db8:0:9:0:0:0:0 + +; end of file +``` + +# Annex G (Informative): Examples for selecting an alternative PGW-C/SMF in a PGW-C/SMF Set + +## G.1 Introduction + +This annex provides examples of DNS provisioning for selecting an alternative PGW-C/SMF in a PGW-C/SMF Set by an MME or ePDG (see clause 5.1.4). + +## G.2 Preconditions + +See annex A.2. + +## G.3 Example of an PGW-C/SMF Set + +### G.3.1 Master file + +The master file in A.3.2 is appended with the following content. + +``` +$ORIGIN epc.mnc990.mcc311.3gppnetwork.org. +; +; $TTL 600 ; 10 minutes - this directive is defined in IETF RFC 2308 not IETF RFC 1035 +; +; $INCLUDE SOA_DB.txt +; +$INCLUDE PGWSET_DB.txt +; +; End of file +``` + +### G.3.2 SOA and NS records + +See Annex A.3.3. + +### G.3.3 PGW-C/SMF Set file + +The file containing the PGW-C/SMF Set records for this example will be PGWSET\_DB.txt and has following NAPTR record content. + +``` +; PGW Set 12 + +set12.pgwset +; IN NAPTR order pref. flag service regexp replacement + IN NAPTR 100 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp:x-s2b-gtp" "" topoff.vip1.gw01.nodes + IN NAPTR 200 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp:x-s2b-gtp" "" topoff.vip1.gw21.nodes + +; PGWs IP addresses +; +topoff.vip1.gw01.nodes IN A 192.0.2.11 + IN A 192.0.2.12 + IN AAAA 2001:db8:0:0:0:0:0:0 + IN AAAA 2001:db8:0:1:0:0:0:0 +topoff.vip1.gw21.nodes IN A 192.0.2.13 + IN A 192.0.2.14 + IN AAAA 2001:db8:0:2:0:0:0:0 + IN AAAA 2001:db8:0:3:0:0:0:0 + +; end of file +``` + diff --git a/marked/Rel-18/29_series/29332/raw.md b/marked/Rel-18/29_series/29332/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..183c5691420f1e2225f2c91dfbd41687021c6733 --- /dev/null +++ b/marked/Rel-18/29_series/29332/raw.md @@ -0,0 +1,3630 @@ + + +# 3GPP TS 29.332 V18.2.0 (2024-09) + +Technical Specification + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Media Gateway Control Function (MGCF) - IM Media Gateway; Mn Interface (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'P' has a red signal wave icon at its base, and a 'TM' trademark symbol is located to the top right of the 'P'. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTETM is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------------------------|----| +| Foreword ..... | 7 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations ..... | 10 | +| 3.1 Definitions..... | 10 | +| 3.2 Symbols..... | 11 | +| 3.3 Abbreviations ..... | 11 | +| 4 UMTS capability set ..... | 12 | +| 4.1 Capability set..... | 12 | +| 5 Naming conventions ..... | 12 | +| 5.1 MGCF/IM-MGW naming conventions..... | 12 | +| 5.2 Void..... | 12 | +| 6 Topology descriptor ..... | 12 | +| 7 Transaction timers..... | 12 | +| 8 Transport..... | 13 | +| 9 Multiple Virtual MG. .... | 13 | +| 10 Formats and codes..... | 13 | +| 10.1 Signalling Objects ..... | 13 | +| 10.2 Codec Parameters..... | 16 | +| 10.2.1 AMR and AMR-WB Codecs..... | 16 | +| 10.2.1A IVAS Codec..... | 17 | +| 10.2.1B EVS Codec ..... | 18 | +| 10.2.2 DTMF Payload Type..... | 18 | +| 10.2.3 Other Codecs ..... | 18 | +| 10.2.3.1 G.711 Codec ..... | 18 | +| 10.2.3.2 Clearmode..... | 18 | +| 10.2.3.3 Silence suppression and comfort noise..... | 18 | +| 10.2.3.4 VBD codec..... | 19 | +| 10.2.3.5 Real-Time Text Telephony Media..... | 19 | +| 10.2.3.6 T.38 FAX..... | 20 | +| 11 Mandatory Support of SDP and H.248 Annex C information elements..... | 20 | +| 12 General on packages and Transactions ..... | 20 | +| 12.1 Profile Details..... | 21 | +| 13 Void..... | 21 | +| 14 Call independent H.248 transactions ..... | 21 | +| 15 Transactions towards IM CN Subsystem..... | 21 | +| 15.2 IMS packages..... | 21 | +| 16 Transactions towards ISUP..... | 21 | +| 16.1 Procedures relating to a termination towards ISUP ..... | 21 | +| 16.2 ISUP packages..... | 21 | +| 17 Transactions towards BICC ..... | 21 | +| 17.1 Procedures related to a termination towards BICC..... | 21 | +| 17.2 BICC packages..... | 21 | + +| | | | +|-----------------------------|---------------------------------------------------------------|-----------| +| Annex A (normative): | Profile Description..... | 22 | +| A.1 | Profile Identification ..... | 22 | +| A.2 | Summary ..... | 22 | +| A.3 | Gateway Control Protocol Version ..... | 22 | +| A.4 | Connection Model..... | 23 | +| A.5 | Context Attributes ..... | 23 | +| A.6 | Terminations ..... | 23 | +| A.6.1 | Termination Names..... | 23 | +| A.6.1.1 | General ..... | 23 | +| A.6.1.2 | ASN.1 Encoding..... | 24 | +| A.6.1.2.1 | General Structure ..... | 24 | +| A.6.1.2.2 | Termination naming convention for TDM terminations ..... | 24 | +| A.6.1.3 | ABNF coding: ..... | 25 | +| A.6.1.3.0 | General Structure ..... | 25 | +| A.6.1.3.1 | Termination Naming Convention for TDM Terminations ..... | 25 | +| A.6.1.3.1.1 | Naming Structure ..... | 25 | +| A.6.1.3.1.2 | Syntactical Specification..... | 25 | +| A.6.1.3.1.3 | Wildcarding..... | 26 | +| A.6.1.3.1.4 | Heterogeneous TDM Port Configurations ..... | 26 | +| A.6.1.3.2 | Termination Naming Convention for Ephemeral Terminations..... | 27 | +| A.6.1.3.2.1 | Naming Structure ..... | 27 | +| A.6.1.3.2.2 | Syntactical Specification..... | 27 | +| A.6.2 | Multiplexed terminations ..... | 27 | +| A.7 | Descriptors ..... | 28 | +| A.7.1 | Stream Descriptor..... | 28 | +| A.7.1.1 | Local Control Descriptor ..... | 28 | +| A.7.2 | Events Descriptor..... | 28 | +| A.7.3 | EventBuffer Descriptor ..... | 30 | +| A.7.4 | Signals Descriptor ..... | 30 | +| A.7.5 | DigitMap Descriptor ..... | 31 | +| A.7.6 | Statistics Descriptor..... | 31 | +| A.7.7 | ObservedEvents Descriptor..... | 31 | +| A.7.8 | Topology Descriptor ..... | 32 | +| A.7.9 | Error Descriptor..... | 32 | +| A.7.10 | TerminationState Descriptor ..... | 32 | +| A.8 | Command API..... | 32 | +| A.8.1 | Add..... | 32 | +| A.8.2 | Modify..... | 33 | +| A.8.3 | Subtract..... | 33 | +| A.8.4 | Move..... | 34 | +| A.8.5 | Auditvalue ..... | 34 | +| A.8.6 | Auditcapability ..... | 35 | +| A.8.7 | Notify ..... | 35 | +| A.8.8 | Service Change..... | 35 | +| A.8.9 | Manipulating and auditing context attributes..... | 37 | +| A.9 | Generic command syntax and encoding ..... | 37 | +| A.10 | Transactions ..... | 37 | +| A.11 | Messages ..... | 38 | +| A.12 | Transport..... | 38 | +| A.13 | Security ..... | 39 | +| A.14 | Packages..... | 39 | +| A.14.1 | Generic Package..... | 42 | +| A.14.2 | Base Root Package..... | 43 | + +| | | | +|-----------|-----------------------------------------------------------------------------|----| +| A.14.3 | Basic DTMF Generator Package..... | 44 | +| A.14.4 | Basic DTMF Detection Package..... | 45 | +| A.14.5 | TDM Circuit Package..... | 45 | +| A.14.6 | MGW Congestion Package..... | 46 | +| A.14.7 | Continuity Package..... | 46 | +| A.14.8 | Announcement Package..... | 47 | +| A.14.9 | Bearer Characteristics Package..... | 47 | +| A.14.10 | Generic Bearer Connection Package..... | 49 | +| A.14.11 | Call Progress Tones Generator Package v1..... | 50 | +| A.14.12 | Basic Call Progress Tones Generator with Directionality..... | 50 | +| A.14.13 | Expanded Call Progress Tones Generator Package..... | 51 | +| A.14.14 | Basic Services Tones Generation Package..... | 52 | +| A.14.15 | Bearer Control Tunnelling Package..... | 52 | +| A.14.16 | Expanded Services Tones Generation Package..... | 53 | +| A.14.17 | Intrusion Tones Generation Package..... | 53 | +| A.14.18 | 3GUP Package..... | 54 | +| A.14.19 | Modification of Link Characteristics Bearer Capability..... | 55 | +| A.14.20 | Hanging Termination Detection Package..... | 55 | +| A.14.21 | TFO package..... | 56 | +| A.14.22 | Media Gateway Overload Control Package..... | 57 | +| A.14.23 | Inactivity Timer Package..... | 57 | +| A.14.24 | MGC Information Package..... | 58 | +| A.14.25 | RTP Package..... | 58 | +| A.14.26 | Tone Generator Package..... | 59 | +| A.14.27 | Tone Detection Package..... | 60 | +| A.14.28 | H324 Package..... | 61 | +| A.14.29 | H.245 Transport Package..... | 62 | +| A.14.30 | IP domain connection..... | 62 | +| A.14.31 | H.245 Transport Package for SPC use..... | 63 | +| A.14.32 | MONA preference package..... | 64 | +| A.14.33 | 3G Interface Type package..... | 66 | +| A.14.34 | RTCP Feedback Message package..... | 66 | +| A.14.35 | Explicit Congestion Notification for RTP-over-UDP Support (ecnrous)..... | 68 | +| A.14.36 | Differentiated Services (ds)..... | 69 | +| A.14.37 | MG Act-as STUN Server (mgastuns)..... | 70 | +| A.14.38 | Originate STUN Continuity Check (ostuncc)..... | 71 | +| A.14.39 | Enhanced Revised Offer/Answer SDP Support (eroas)..... | 72 | +| A.15 | Mandatory support of SDP and H.248 Annex C information elements..... | 73 | +| A.16 | Optional support of SDP and H.248 Annex C information elements..... | 76 | +| A.17 | Procedures..... | 76 | +| A.17.1 | Call Independent Procedures..... | 76 | +| A.17.1.2 | Profile registration..... | 77 | +| A.17.2 | IMS Terminations Procedures..... | 77 | +| A.17.2.1 | Summary of Procedures related to a termination towards IM CN Subsystem..... | 77 | +| A.17.2.2 | Reserve IMS Connection Point..... | 79 | +| A.17.2.3 | Configure IMS Resources..... | 81 | +| A.17.2.4 | Reserve IMS Connection Point and configure remote resources..... | 83 | +| A.17.2.5 | VOID..... | 85 | +| A.17.2.6 | Termination heartbeat indication..... | 85 | +| A.17.2.7 | Request RTCP-Interworking..... | 86 | +| A.17.2.8 | Notify RTCP-Interworking..... | 86 | +| A.17.2.9 | Signal H.245-Interworking..... | 87 | +| A.17.2.10 | ECN Failure Indication..... | 87 | +| A.17.2.11 | ICE Connectivity Check Result Notification..... | 88 | +| A.17.2.12 | ICE New Peer Reflexive Candidate Notification..... | 88 | +| A.17.3 | TDM Terminations Procedures..... | 89 | +| A.17.3.1 | Summary Procedures related to a termination towards ISUP..... | 89 | +| A.17.3.2 | Reserve TDM Circuit..... | 90 | +| A.17.3.3 | Release TDM Termination..... | 90 | +| A.17.3.4 | Termination heartbeat indication..... | 91 | + +| | | | +|-------------------------------|--------------------------------------------------------------------------------------|------------| +| A.17.4 | BICC Terminations Procedures ..... | 92 | +| A.17.4.1 | Procedures related to a termination towards BICC ..... | 92 | +| A.17.5 | Multiplex Termination Procedures..... | 93 | +| A.17.5.1 | Procedures related to a Multiplex termination ..... | 93 | +| A.17.5.2 | Add Multiplex Termination..... | 93 | +| A.17.5.3 | Configure Multiplex Termination ..... | 96 | +| A.17.5.4 | Signal H245 Message ..... | 96 | +| A.17.5.5 | Notify H.245 Message..... | 97 | +| A.17.5.6 | Notify MONA Preference Reception ..... | 97 | +| A.17.5.7 | Notify MONA Preference Completed..... | 98 | +| A.17.5.8 | Signal SPC ..... | 98 | +| A.17.5.9 | Notify SPC..... | 99 | +| A.17.5.10 | Notify MPC ..... | 99 | +| A.17.5.11 | Notify Detection of Legacy Interworking ..... | 100 | +| A.17.5.12 | Stop MPC ..... | 100 | +| A.17.5.13 | Stop SPC..... | 101 | +| A.17.5.14 | Stop MONA Negotiation..... | 102 | +| A.17.6 | SIP-I on Nc Terminations Procedures..... | 103 | +| A.17.6.1 | Summary of Procedures related to a termination towards SIP-I on Nc CN Subsystem..... | 103 | +| Annex B (normative): | Void..... | 105 | +| Annex C (normative): | Void..... | 106 | +| Annex D (informative): | Change history..... | 107 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document describes the protocol to be used on the Media Gateway Control Function (MGCF) – IM Media Gateway (IM-MGW) interface. This interface provides the Media Gateway Control for interworking between the IP Multimedia Subsystem (IMS) and CS domain (ISUP, BICC and SIP-I). The basis for this protocol is the H.248 protocol as specified in ITU-T. The IMS architecture is described in 3GPP TS 23.228 [1]. The interaction of the MGCF-IM MGW interface signalling procedures in relation to the SIP, and BICC/ISUP signalling at the MGCF are described in 3GPP TS 29.163[4]. + +The interaction of the MGCF-IM MGW interface signalling procedures in relation to the IMS SIP and SIP-I on Nc at the MGCF are described in 3GPP TS 29.235[47]. + +This specification describes the application of H.248 on the Mn interface. Required extensions use the H.248 standard extension mechanism. In addition certain aspects of the base protocol H.248 are not needed for this interface and thus excluded by this profile. + +In addition this profile provides support for PSTN/ISDN Emulation as required by ETSI TISPAN. + +The specification contains a normative Annex defining the H.248.1 Profile in accordance with ITU-T recommendations for H.248.1 applications. Where there exists any contradiction between the normative Annex A and the rest of the specification, the Normative Annex shall take precedence. The main body of the specification provides an introduction to the use of the profile for the Mn interface and introduces any specific functionality (e.g. new packages) associated to the Mn. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. + +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [2] 3GPP TS 29.007: "General requirements on interworking between the Public Land Mobile Network (PLMN) and the Integrated Services Digital Network (ISDN) or Public Switched Telephone Network (PSTN)". +- [3] 3GPP TS 29.205: "Application of Q.1900 series to Bearer Independent CS Network architecture; Stage 3". +- [4] 3GPP TS 29.163: "Interworking between the IM CN subsystem and CS networks – Stage 3". +- [5] 3GPP TS 29.232: "Media Gateway Controller (MGC); Media Gateway (MGW) interface; Stage 3". +- [6] 3GPP TS 26.226: "Cellular Text Telephone Modem; General Description". +- [7] 3GPP TS 26.103: "Speech codec list for GSM and UMTS". +- [8] Void +- [9] ITU-T Recommendation H.248.1 (05/2002): "Gateway Control Protocol: Version 2" including the Corrigendum1 for Version 2 (03/04). +- [10] ITU-T Recommendation H.248.8 (09/2005): "Error Codes and Service Change Reason Description". +- [11] ITU-T Recommendation H.248.2 (01/2005): "Facsimile, text conversation and call discrimination packages". +- [12] ITU-T Recommendation H.248.10 (07/2001): "Media Gateway Resource Congestion Handling Package". +- [13] Void +- [14] ITU-T Recommendation Q.1950 (12/2002): "Call Bearer Control Protocol". +- [15] IETF RFC 2960: "Stream Control Transmission Protocol". +- [16] IETF RFC 4867: "RTP Payload Format and File Storage Format for the Adaptive Multi-Rate (AMR) and Adaptive Multi-Rate Wideband (AMR-WB) Audio Codecs". +- [17] IETF RFC 4566: "SDP: Session Description Protocol". +- [18] IETF RFC 2833: "RTP Payload for DTMF Digits, Telephony Tones and Telephony Signals". +- [19] Void +- [20] Void +- [21] 3GPP TS 29.415: "Core Network Nb Interface User Plane Protocols". +- [22] 3GPP TS 23.153: "Out of band transcoder control". +- [23] IETF RFC 768: "User Datagram Protocol". +- [24] IETF RFC 3332: "Signaling System 7 (SS7) Message Transfer Part 3 (MTP3) - User Adaptation Layer (M3UA)". +- [25] 3GPP TS 29.202: "SS7 Signalling Transport in Core Network". +- [26] ITU-T Recommendation H.248.7 (03/2004): "Generic Announcement Package". +- [27] ITU-T Recommendation H.248.36 (09/2005): "Hanging Termination Detection Package". + +- [28] ITU-T Recommendation H.248.11 (11/2002): "Media gateway overload control package". +- [29] ITU-T Recommendation H.248.14 (03/2009): "Inactivity timer package". +- [30] ITU-T Recommendation H.248.45 (05/2006): "MGC Information Package". +- [31] Void +- [32] IETF RFC 3555: "MIME Type Registration of RTP Payload Formats". +- [33] IETF RFC 3551: "RTP Profile for Audio and Video Conferences with Minimal Control". +- [34] Void +- [35] IETF RFC 4040: "RTP Payload Format for a 64 kbit/s Transparent Call". +- [36] IETF RFC 3389: "Real-time Transport Protocol (RTP) Payload for Comfort Noise (CN)". +- [37] ITU-T Recommendation V.152 (01/2005): "Procedures for supporting voice-band data over IP networks" including Corrigendum 1. +- [38] ITU-T Recommendation H.248.4 (12/2009): "Gateway control protocol: Transport over Stream Control Transmission Protocol (SCTP)". +- [39] IETF RFC 3556: "Session Description Protocol (SDP) Bandwidth Modifiers for RTP Control Protocol (RTCP) Bandwidth". +- [40] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [41] ITU-T Recommendation H.248.12 (07/2001): "Gateway control protocol: H.248.1 packages for H.323 and H.324 interworking". +- [42] ITU-T Recommendation H.248.12 Amendment 2 (08/2007): "Gateway control protocol: H.248.1 packages for H.323 and H.324 interworking Amendment 2: Transport Mechanism". +- [43] IETF RFC 3309: "Stream Control Transmission Protocol (SCTP) Checksum Change". +- [44] ITU-T Recommendation H.248.41 (05/2006): "IP Domain Connection package". +- [45] Void +- [46] ITU-T Recommendation H.248.72 (12/2009): "Gateway control protocol: ITU-T H.248 support for media-oriented negotiation acceleration (MONA)". +- [47] 3GPP TS 29.235: "Interworking between SIP-I based circuit-switched core network and other networks". +- [48] 3GPP TS 23.231: "SIP-I based circuit-switched core network; Stage 2". +- [49] ITU-T Recommendation H.248.71 (02/2010): "Gateway Control Protocol: RTCP support packages". +- [50] IETF RFC 4103: "RTP Payload for Text Conversation". +- [51] ITU-T Recommendation T.140: "Text conversation presentation protocol". +- [52] IETF RFC 4102: "Registration of the text/red MIME Sub-Type". +- [53] IETF RFC 2198: "RTP Payload for Redundant Audio Data". +- [54] ITU-T Recommendation V.18 (11/00): "Operational and interworking requirements for DCEs operating in the text telephone mode" including V.18 (2000) Amendment 1 (11/02): "Harmonization with ANSI TIA/EIA-825 (2000) text phones". +- [55] ITU-T Recommendation G.168 (03/2009): "Digital network echo cancellers". +- [56] Void + +- [57] Void +- [58] Void +- [59] IETF RFC 4145: "TCP-Based Media Transport in the Session Description Protocol (SDP)". +- [60] IETF RFC 4585: "Extended RTP Profile for Real-time Transport Control Protocol (RTCP) - Based Feedback (RTP/AVPF)". +- [61] ITU-T Recommendation X.690: "ASN.1 encoding rules: Specification of Basic Encoding Rules (BER), Canonical Encoding Rules (CER) and Distinguished Encoding Rules (DER)". +- [62] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia Telephony; Media handling and interaction". +- [63] 3GPP TS 22.153: "Multimedia Priority Service". +- [64] ITU-T Recommendation H.248.52 (06/2008): "Gateway control protocol: QoS support packages". +- [65] ITU-T Recommendation T.38 (09/2010): "Procedures for real-time Group 3 facsimile communication over IP networks". +- [66] ITU-T Recommendation H.248.82 (03/2013): "Gateway control protocol: Explicit Congestion Notification Support". +- [67] ITU-T Recommendation H.248.50 (2010) Corrigendum 1 (02/12): "Gateway control protocol: NAT traversal toolkit packages". +- [68] Void. +- [69] 3GPP TS 24.229: "IP Multimedia Call Control Protocol based on SIP and SDP". +- [70] IETF RFC 5939: "Session Description Protocol (SDP) Capability Negotiation". +- [71] ITU-T Recommendation H.248.80 (01/2014): "Gateway control protocol: Usage of the revised SDP offer/answer model with ITU-T H.248". +- [72] IETF RFC 8445: "Interactive Connectivity Establishment (ICE): A Protocol for Network Address Translator (NAT) Traversal". +- [73] IETF RFC 8839: "Session Description Protocol (SDP) Offer/Answer Procedures for Interactive Connectivity Establishment (ICE)". +- [74] 3GPP TS 26.250: "Codec for Immersive Voice and Audio Services – General Overview". +- [75] 3GPP TS 26.253: "Codec for Immersive Voice and Audio Services – Detailed Algorithmic Description incl. RTP payload format and SDP parameter definitions". +- [76] 3GPP TS 26.441: "Codec for Enhanced Voice Services (EVS); General Overview". +- [77] 3GPP TS 26.445: "Codec for Enhanced Voice Services (EVS); Detailed Algorithmic Description". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the [following] terms and definitions [given in ... and the following] apply. + +**Context (H.248):** A context is an association between a number of Terminations. The context describes the topology (who hears/sees whom) and the media mixing and/or switching parameters if more than two terminations are involved in the association. + +**Package (H.248):** Different types of gateways may implement terminations which have differing characteristics. Variations in terminations are accommodated in the protocol by allowing terminations to have optional properties. Such options are grouped into packages, and a termination may realise a set of such packages. + +**Termination (H.248):** A termination is a logical entity on an MGW which is the source and/or sink of media and/or control streams. A termination is described by a number of characterising properties, which are grouped in a set of descriptors which are included in commands. Each termination has a unique identity (TerminationID). + +**Termination Property (H.248):** Termination properties are used to describe terminations. Related properties are grouped into descriptors. Each termination property has a unique identity (PropertyID). + +For the purposes of the present document, the following terms and definitions as defined in 3GPP TS 29.163 [4] apply: + +**ICE lite** + +**Full ICE.** + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +Mn                      Interface between the media gateway control function and the IMS media gateway. + +## 3.3 Abbreviations + +For the purposes of the present document, the following abbreviations given in TR 21.905 [40] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [40]. + +| | | +|--------|-----------------------------------------| +| AMR | Adaptive MultiRate | +| BICC | Bearer Independent Call Control | +| CN | Core Network | +| CS | Circuit-Switched | +| DTMF | Dual Tone Multi Frequency | +| CE | Congestion Experienced | +| ECN | Explicit Congestion Notification | +| EVS | Enhanced Voice Services | +| FFS | For further study | +| GSM | Global System for Mobile communications | +| ICE | Interactive Connectivity Establishment | +| IETF | Internet Engineering Task Force | +| IM | IP Multimedia | +| IM-MGW | IP Multimedia Media Gateway | +| IMS | IP Multimedia Subsystem | +| IP | Internet Protocol | +| ISDN | Integrated Services Digital Network | +| ISUP | ISDN User Part | +| IVAS | Immersive Voice and Audio Services | +| MG/MGW | Media GateWay | +| MGC | Media Gateway Controller | +| MGCF | Media Gateway Control Function | +| MIME | Multipurpose Internet Mail Extensions | +| MPS | Multimedia Priority Service | +| n.a. | not applicable | +| PDH | Plesiochronous Digital Hierarchy | +| PES | PSTN/ISDN Emulation Subsystem | +| PSTN | Public Switched Telephone Network | +| PT | Payload Type | +| R2 | (ETSI TISPAN NGN) Release 2 | + +| | | +|-----------|----------------------------------------------------------------------------------------------------| +| RFC | Request For Comment; this includes both discussion documents and specifications in the IETF domain | +| RTCP | RTP Control Protocol | +| RTP | Real-time Transport Protocol | +| SCTP | Stream Control Transmission Protocol | +| SDH | Synchronous Digital Hierarchy | +| SDP | Session Description Protocol | +| SDPCapNeg | SDP Capability Negotiation | +| SIP | Session Initiation Protocol | +| SONET | Synchronous Optical NETwork | +| SS | Silence Suppression | +| SS7 | Signalling System No. 7 | +| STUN | Session Traversal Utilities for NAT | +| TDM | Time Division Multiplexing | +| TISPAN | Telecommunications and Internet converged Services and Protocols for Advanced Networking | +| TMGW | Trunking MGW | +| TS | Technical Specification (3GPP, ETSI) | +| VBD | VoiceBand Data | + +# --- 4 UMTS capability set + +## 4.1 Capability set + +The support of the Mn interface capability set shall be identified by the Mn profile and support of this profile shall be indicated in ServiceChange procedure. + +The mandatory parts of this capability set shall be used in their entirety whenever it is used within the H.248 profile. Failure to do so will result in a non-standard implementation. + +ITU-T Recommendation H.248.1 (05/02) [9] is the basis for this Capability Set. The compatibility rules for packages, signals, events, properties and statistics and the H.248 protocol are defined in ITU-T Recommendation H.248.1 [9]. Their use or exclusion for this interface is clarified in clause 12. + +# --- 5 Naming conventions + +## 5.1 MGCF/IM-MGW naming conventions + +The MGCF shall be named according to the naming structure of the underlying transport protocol which carries the H.248 protocol. + +For further definition of the Termination Names see Annex A.6. + +## 5.2 Void + +# --- 6 Topology descriptor + +No special behaviour, for definition of use see Annex A. 5. + +# --- 7 Transaction timers + +No special behaviour, for definition of timers see Annex A.10. + +# --- 8 Transport + +Each implementation of the Mn interface should provide SCTP (as defined in IETF RFC2960 [15] and as updated by RFC3309 [43]), however other options are permitted within the profile. For further definition see Annex A12. + +# --- 9 Multiple Virtual MG. + +The support of multiple virtual MGW outlined in the subclause "Multiple virtual MGW" in ITU-T Recommendation H.248.1 [9] is optional. + +# --- 10 Formats and codes + +## 10.1 Signalling Objects + +Table 10.1 shows the parameters which are required. + +The coding rules applied in ITU-T Recommendation H.248.1 [9] for the applicable coding technique shall be followed for the UMTS capability set. + +Table 10.1: required parameters + +| Signalling Object | H.248 Descriptor | Coding | +|---------------------------------|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Additional Bandwidth Properties | Remote Descriptor | The "a=bw-info" SDP attribute defined in 3GPP TS 26.114 [62], see table A.15/1. | +| Allowed RTCP APP message types | Remote Descriptor | Handling of RTCP APP messages when transcoding between EVS and non EVS codecs, or between IVAS and non IVAS codecs:

The "a=3gpp_mtsi_app_adapt" SDP attribute defined in 3GPP TS 26.114 [62] containing the allowed RTCP APP message types shall be provided when the IM-MGW is allowed to send RTCP APP messages. | +| Bearer Service Characteristics | Local Descriptor or Remote Descriptor | As per Q.1950 [14]. For TMR, only values "3.1 kHz audio" or "speech" are required. | +| BNC Release | EventDescriptor | As for the EventsDescriptor in subclause E.1.2.1/H.248.1 "Cause" | +| BNC Release | ObservedEvent descriptor | As for the ObservedEventsDescriptor in subclause E.1.2.1/H.248.1 "Cause" | +| Codec List | Local Descriptor or Remote Descriptor | in a single SDP m-line.
For a static RTP payload type, the codec type should be implied by the RTP payload type, if not then each codec type shall be provided in a separate SDP "a=rtpmap"-line and possibly additional SDP "a=fmtp"-line(s). See clause 10.2.
For a dynamic RTP payload type, for each codec information on the codec type shall be provided in a separate SDP "a=rtpmap"-line and possibly additional SDP "a=fmtp"-line(s). See clause 10.2.
For T.38, additional SDP attributes listed in clause 10.2.3.6 may be provided. | +| Context ID | NA | Binary Encoding: As per ITU-T Recommendation H.248.1 [9] Annex A.
Textual Encoding: As per ITU-T Recommendation H.248.1 [9] Annex B. | +| Diffserv Code Point | Local Control | Defined according to the Differentiated Services Code Point property in ITU-T Recommendation H.248.52 [64]. | +| ECN Enabled | Local Descriptor or Remote Descriptor | Defined according to the "ECN Enabled" property in ITU-T Recommendation H.248.82 [66]. | +| ECN Failure | Events, Observed Events | Defined according to the "ECN Failure" Event in ITU-T Recommendation H.248.82 [66]. | +| ECN Failure Type | ObservedEvents Descriptor | As for the ObservedEventsDescriptor Parameter "Failure Type" in ITU-T Recommendation H.248.82 [66]. | +| ECN Initiation Method | Local Descriptor or Remote Descriptor | Defined according to "Initiation Method" property in ITU-T Recommendation H.248.82 [66]. | +| Forward media in MPC | Signal descriptor | As for the signal "Forward Media in Preconfigured Channel" in H.248.72 [46] subclause 7.3.2 | +| Highest Multiplex Level | Termination state | As for property "Highest multiplexing Level" in subclause 4.1.2/H.248.12 [41] | +| H245 message content | ObservedEvent descriptor | As for the ObservedEventDescriptor in subclause A.8.2.1.2/H.248.12a2 [42] "Contents of H.245 message". | +| ICE host candidate request | Local Descriptor | The "a=candidate" SDP attribute defined in IETF RFC 8839 [73] of type "host" with the transport, port and priority parameters with wildcard sign "\$" to request the allocation of a host candidate | +| ICE host candidate | Local Descriptor | The "a=candidate" SDP attribute defined in IETF RFC 8839 [73]. | +| ICE lite indication | Local Descriptor | The "a=ice-lite" SDP attribute defined in IETF RFC 8839 [73]. | +| ICE pacing | Local Descriptor | The "a=ice-pacing" SDP attribute defined in IETF RFC 8839 [73]. Only applicable for full ICE as specified in IETF RFC 8445 [72]. | +| ICE pacing request | Local Descriptor | The "a=ice-pacing" SDP attribute defined in IETF RFC 8839 [73] with wildcard sign "\$". Only applicable for full ICE as specified in IETF RFC 8445 [72]. | +| ICE password request | Local Descriptor | The "a=ice-pwd" SDP attribute defined in IETF RFC 8839 [73] with wildcard sign "\$". | +| ICE password | Local Descriptor | The "a=ice-pwd" SDP attribute defined in IETF RFC 8839 [73]. | +| ICE received candidate | Remote Descriptor | The "a=candidate" SDP attribute defined in IETF RFC 8839 [73]. | +| ICE received pacing | Remote Descriptor | The "a=ice-pacing" SDP attribute defined in IETF RFC 8839 [73]. Only applicable for full ICE as specified in IETF RFC 8445 [72]. | +| ICE received password | Remote Descriptor | The "a=ice-pwd" SDP attribute defined in IETF RFC 8839 [73]. | +| ICE received Ufrag | Remote Descriptor | The "a=ice-ufrag" SDP attribute defined in IETF RFC 8839 [73]. | +| ICE Ufrag request | Local Descriptor | The "a=ice-ufrag" SDP attribute defined in IETF RFC 8839 [73] with | + +| | | | +|----------------------------------------|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | wildcard sign "\$". | +| ICE Ufrag | Local Descriptor | The "a=ice-uf rag" SDP attribute defined in IETF RFC 8839 [73]. | +| ICE Connectivity Check Result | Events, Observed Events | Defined according to Connectivity Check Result event in ITU-T Recommendation H.248.50 [67]. | +| ICE Send Connectivity Check | Signals | Defined as the ostuncc/scc signal in ITU-T Recommendation H.248.50 [67]. | +| ICE New Peer Reflexive Candidate | Events, Observed Events | Defined according to New Peer Reflexive Candidate event in ITU-T Recommendation H.248.50 [67]. | +| ICE Send Additional Connectivity Check | Signals | Defined as the ostuncc/sacc signal in ITU-T Recommendation H.248.50 [67]. | +| Inactivity timeout | EventDescriptor | As for the EventsDescriptor in subclause 6.2/H.248.14 "Inactivity Timeout" | +| Inactivity timeout | ObservedEvent descriptor | As for the ObservedEventDescriptor in subclause 6.2/H.248.14 "Inactivity Timeout " | +| Incoming H245 message | Event descriptor | As for the EventDescriptor in subclause A.8.2.1/H.248.12a2 [42] "Incoming H.245 message" | +| Incoming Multiplex table | Local Control | As for property "Incoming Multiplex Table" in subclause 4.1.5/H.248.12 [41] | +| Interwork H.245-RTCP | Signal descriptor | As for the EventDescriptor parameter in subclause 8.2.1.1.1/H.248.71[49] "Feedback Message Type ". | +| IP Address | Local Descriptor or Remote Descriptor | in SDP "c-line" | +| IP interface | Local control | As for the property "IP interface type" in subclause 15.2.11.1 in 3GPP TS 29.232 [5] | +| IP realm identifier | Local control | As for the property "IP realm identifier " in subclause 5.1.1/H.248.41[44] | +| Legacy Interworking Detected | Event descriptor | As for the EventDescriptor in H.248. 72 [46] subclause 7.2.3 "Legacy Detected" | +| mediatype | Local Descriptor or Remote Descriptor | in sdp m-line
"audio" for voice service, "video" for video service and "image" for T.38 service. | +| Mona Preference Channel reception | Event descriptor | As for the EventDescriptor in H.248. 72 [46] subclause 7.2.4 "MPC reception" | +| MONA Preference completed | Event descriptor | As for the EventDescriptor in H.248.72 [46] subclause 7.2.2 "MONA Preference negotiation completed" | +| MONA preference message content | ObservedEvent descriptor | As for the ObservedEventDescriptor in H.248.72 [46] subclause 7.2.1.2.1 "Contents of MONA preference message ". | +| MONA Preference recv | Event descriptor | As for the EventDescriptor in H.248. 72 [46] subclause 7.2.2.1 "MONA Preference reception" | +| MPC MUX Code | Signal descriptor | As for the additional parameter of the signal "Forward Media in Preconfigure Channel" in H.248.72 [46] subclause 7.3.2.1 | +| Muxcode | ObservedEvent descriptor | As for the ObservedEventDescriptor in H.248. 72 [46] subclause 7.2.4.2.1 "Mux Code". | +| Muxdescriptor | Multiplex Descriptor | Binary Encoding: As per ITU-T Recommendation H.248.1 [9] Annex A.
Textual Encoding: As per ITU-T Recommendation H.248.1 [9] Annex B. | +| Outgoing H245 message | Signal descriptor | As for the signal "Outgoing H.245 Message " in subclause A.8.3.1/H.248.12a2 [42] | +| Outgoing H245 message content | Signal descriptor | As for the additional parameter of the signal "Outgoing H.245 Message " in subclause A.8.3.1.1/H.248.12a2 [42] | +| Outgoing MONA preference content | Signal descriptor | As for the additional parameter of the signal " Outgoing MONA preference message" in H.248. 72 [46] subclause 7.3.1.1.1 | +| Outgoing MONA preferences | Signal descriptor | As for the signal "Outgoing MONA preference message " in H.248. 72 [46] subclause 7.3.1 | +| Outgoing multiplex table | Local Control | As for property "Outgoing Multiplex Table" in subclause 4.1.6/H.248.12 [41] | +| Port | Local Descriptor or Remote Descriptor | in SDP m-line.
in SDP m-line shall be set to value "RTP/AVP" for voice or video service, and set to value "UDPTL" or "TCPTL"for T.38 service. | +| Priority Information | NA | Priority Indicator (subclause 6.1.1 of ITU-T Recommendation H.248.1 [9])
Binary Encoding: Encoding as per ITU-T Recommendation H.248.1 [9] Annex A "priority" context attribute
Textual Encoding: Encoding as per ITU-T Recommendation | + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | H.248.1 [9] Annex B "priority" context attribute | +| Remote H223 capability | Local Control | As for property "Remote H.223 capability" in subclause 4.1.4/H.248.12 [41] | +| Reserve_Value | Local Control | ITU-T Recommendation H.248.1 [9] Mode property.
Binary Encoding: Encoding as per ITU-T Recommendation H.248.1 Annex A "reserveValue"
Textual Encoding: Encoding as per ITU-T Recommendation H.248.1 Annex B "reservedValueMode". | +| RtcpbwRR | Local Descriptor or Remote Descriptor | in SDP "b:RR"-line as per IETF RFC 3556 [39]. | +| RtcpbwRS | Local Descriptor or Remote Descriptor | in SDP "b:RS"-lineas per IETF RFC 3556 [39]. | +| RTCP Filter | Event descriptor | As for the EventDescriptor parameter in subclause 8.2.1.1.1/H.248.71[49] "Feedback Message Type ". | +| RTPpayload | Local Descriptor or Remote Descriptor | in SDP m-line | +| SCP | Event descriptor | As for the EventDescriptor parameter in H.248. 72 [46] subclause 6.2.1. 1 "SCP". | +| SDPCapNeg configuration | Local Descriptor or Remote Descriptor | The SDP attributes for SDP capability negotiation according to IETF RFC 5939 [70]. | +| SDPCapNeg Supported Capabilities | Termination State | Defined according to SDPCapNeg Extensions property in ITU-T Recommendation H.248.80 [71]. | +| SPC In | Observed event descriptor | As for the ObservedEventDescriptor parameter in H.248. 72 [46] subclause 6.2.2.1 ""Incoming H.245 message" | +| SPC Out | Signal descriptor | As for the additional parameter of the signal "Outgoing H.245 Message " in H.248. 72 [46] subclause 6.3.1.1 | +| Stream ID | Stream Descriptor | Binary Encoding: As per ITU-T Recommendation H.248.1 [9] Annex A.
Textual Encoding: As per ITU-T Recommendation H.248.1 [9] Annex B. | +| Termination ID | NA | Binary Encoding: As per ITU-T Recommendation H.248.1 [9] Annex A.
Textual Encoding: As per ITU-T Recommendation H.248.1 [9] Annex B. | +| Transaction ID | NA | Binary Encoding: As per ITU-T Recommendation H.248.1 [9] Annex A.
Textual Encoding: As per ITU-T Recommendation H.248.1 [9] Annex B. | +| UpdatePicture_Event | ObservedEvent descriptor | As for the EventDescriptor parameter in subclause 8.2.1.2.1/H.248.71[49] "Update Picture ". | +| UpdatePicture_Signal | Signal descriptor | As for the SignalDescriptor parameter "Update Picture " in subclause 8.3.1.1.1/H.248.71[49]. | +| NOTE: For binary encoding, the SDP equivalents "SDP_V", "SDP_M", "SDP_C", "SDP_A", and SDP_B" in ITU-T Recommendation H.248.1 [9], Annex C.11, shall be used to encode the corresponding SDP lines. Other SDP equivalents may be used, for details see Annex A. The SDP equivalents shall be used in the order specified for the corresponding SDP lines in IETF RFC 2327 [17]. Rules for the usage of SDP in ITU-T Recommendation H.248.1 [9] shall also be applied to the SDP equivalents. SDP description types (v= , m=, a= etc.) are not encoded. CR/LF are not encoded. | | | + +## 10.2 Codec Parameters + +### 10.2.1 AMR and AMR-WB Codecs + +On IMS terminations, the AMR and AMR-WB codecs are transported according to the IETF AMR RTP profile, IETF RFC 4867 [16], 3GPP TS 26.114 [62] selects options applicable within 3GPP. + +IETF RFC 4867 [16] contains the MIME registration of the IETF AMR RTP profile with media type "audio" and media subtype of "AMR" and "AMR-WB". The AMR and AMR-WB codecs shall be signaled accordingly in the SDP "a=rtpmap"-line and a dynamic RTP payload type shall be used. + +The selected options are expressed as MIME parameters in SDP "a=fmtp"-line. The following MIME parameters shall be supported on the Mn interface: + +- "mode-set" + +- "mode-change-period" + +In addition the following MIME parameters may be supported on the Mn interface: + +- "octet-align" +- "mode-change-neighbor" (for IMS this parameter shall be included and set to 1) +- "maxptime" +- "ptime" + +For compatibility with GSM peers, the IM-MGW shall perform mode changes only in every second sent package. + +Example of encoding of AMR codec + +ABNF: + +``` +Local { + v=0 + c=IN IP4 $ + m=audio $ RTP/AVP 96 + a=rtpmap:96 AMR/8000 + a=fmtp:96 mode-set=0,2,5,7;mode-change-period=2;mode-change-neighbor=1 + a=maxptime:20 +} +``` + +ASN.1: + +``` +LocalDescriptor{ + PropertyParams{ + PkgdName=0x000B001 /*SDP_V */ + value= "0" + PkgdName=0x000B008 /*SDP_C */ + value= "IN IP4 $" + PkgdName=0x000B00F /*SDP_M */ + value= "audio $ RTP/AVP 96" + PkgdName=0x000B00C /*SDP_A */ + value= "rtpmap:96 AMR/8000" + PkgdName=0x000B00C /*SDP_A */ + value= "fmtp:96 mode-set=0,2,5,7;mode-change-period=2;mode-change-neighbor=1" + PkgdName=0x000B00C /*SDP_A */ + value= "maxptime:20" + }} +} +``` + +NOTE: The c-line may be provided after m-line. + +On RTP-CN (SIP-I) terminations speech codecs are supported according to 3GPP TS 29.232 [5] subclause 10.2.1. + +#### 10.2.1A IVAS Codec + +The Immersive Voice and Audio Services (IVAS) speech and audio codec is defined in 3GPP TS 26.250 [74]. Its RTP payload type is defined in 3GPP TS 26.253 [75], and procedures for its usage as IMS Multimedia Telephony speech codec are defined in 3GPP TS 26.114 [21] and 3GPP TS 29.163 [4]. + +On IMS terminations, the IVAS codec shall be signaled in the SDP "a=rtpmap"-line and a dynamic RTP payload type shall be used. + +The selected options are expressed as MIME parameters in SDP "a=fmtp"-line. + +### 10.2.1B EVS Codec + +The Enhanced Voice Services (EVS) speech codec is defined in 3GPP TS 26.441 [76]. Its RTP payload type is defined in 3GPP TS 26.445 [77], and procedures for its usage as IMS Multimedia Telephony speech codec are defined in 3GPP TS 26.114 [62]. + +On IMS terminations, the EVS codec shall be signaled in the SDP "a=rtpmap"-line and a dynamic RTP payload type shall be used. The selected options are expressed as MIME parameters in SDP "a=fmtp"-line. + +On RTP-CN (SIP-I) terminations, speech codecs are supported according to clause 10.2.1 of 3GPP TS 29.232 [5]. + +### 10.2.2 DTMF Payload Type + +On IMS and RTP-CN (SIP-I) terminations, DTMF is transported according to the IETF RFC 2833 [18] "telephone event" format. + +IETF RFC 2833[18] contains the MIME registration with media type "audio" and media subtype "telephone-event". DTMF shall be signaled accordingly in the SDP "a=rtpmap"-line and a dynamic RTP payload type shall be used. + +An IM-MGW supporting DTMF shall support the default options of the IETF RFC 2833 [18] "telephone event" format. Therefore, a support of optional MIME parameters of "telephone-event" is not required at the Mn interface. + +### 10.2.3 Other Codecs + +On IMS terminations, other codecs such as ITU-T codecs are transported according to the RTP payload formats in IETF RFC 3555[32]. 3GPP TS 29.163[4], clause B.2.5.4, specifies the options applicable within 3GPP. + +IETF RFC 3555[32] contains the MIME registration with media type "audio" and corresponding media subtype. + +For dynamic payload type being used the ITU-T codecs shall be signaled accordingly in the SDP "a=rtpmap"-line, where the selected options are expressed as MIME parameters in SDP "a=fmtp"-line. + +For static payloads type being used ITU-T codecs shall be allowed to be signaled accordingly in the SDP "a=rtpmap"-line, when the selected options are expressed as MIME parameters in SDP "a=fmtp"-line. Otherwise the codec type is implied by the RTP payload type. + +#### 10.2.3.1 G.711 Codec + +On IMS and RTP-CN (SIP-I) terminations, G.711 codec is transported according to IETF RFC 3551[33]. + +#### 10.2.3.2 Clearmode + +On IMS and RTP-CN (SIP-I) terminations, Clearmode codec is transported according to IETF RFC 4040[35]. + +When the MGC determines that a 64 kbit/s unrestricted bearer service is requested, the clearmode codec shall be used. A Dynamic Payload type with CLEARMODE as encoding name shall be included in both the local and remote descriptor. + +The behaviour of the MGW shall then conform to IETF RFC 4040[35]. All voice and signal processing functions such as silence suppression, comfort noise insertion and gain adjustment shall be automatically turned off. The MGW shall inherit the same QoS objectives as the ISDN bearer service. + +#### 10.2.3.3 Silence suppression and comfort noise + +On RTP-CN (SIP-I) terminations silence suppression and comfort noise are supported according to 3GPP TS 29.232 [5] subclause 10.2.3.4. For IMS terminations the following text applies. + +Silence Suppression (SS) mode is direction-independent and shall be supported call/bearer individually. Silence suppression mode must be explicitly enabled and disabled. Default shall be a disabled SS mode. + +If a codec has built-in support for silence suppression and comfort noise insertion, and an a= line has been defined in IETF RFC3551[33] or IETF RFC 3555 [32] to activate or de-activate these features, the activation or deactivation of + +these features shall be indicated using the a= line according to IETF RFC 3551[33] and IETF RFC 3555[32]. If the selected codec does not have built in support for silence suppression and comfort noise (CN) insertion, the CN payload code defined in RFC 3389[36] may be included in the media description. + +E.g (for ITU-T Recommendation G.711 A-law codec): + +``` +v=0 +c=IN
+m=audio RTP/AVP 8 13 +a=ptime: 10 +``` + +If the CN payload is included in the Local Descriptor, the MGW shall be prepared to receive CN packets during silence periods. This action corresponds to an implicit enabling of the SS mode in receiving direction. + +If the CN payload is included in the Remote Descriptor, the MGW shall send CN packets during silence periods. This action corresponds to an implicit enabling of the SS mode in sending direction. + +Comfort noise generation, voice activity detection and discontinuous transmission algorithms are outside the scope of the present document. + +#### 10.2.3.4 VBD codec + +Voiceband data refers to traffic from facsimile, modem or text telephony applications. + +On IMS terminations, voiceband data traffic is transported for facsimile /modem or data/ modem (but not text/modem, see sub clause 10.2.3.5) according to ITU-T Recommendation V.152 [37] and its Corrigendum 1. ITU-T Recommendation G.711 must be used as VBD codec. The RTP Payload Type (PT) codepoint, "0" or "8" or a value from the dynamic PT range , is used in the MG. + +NOTE 1: Use of "0" or "8" is indicating to the MG that only inband-based VBD stimuli must be detected. Both peering MGs are consequently not directly synchronized in their state transitions between "voice" and "VBD" modes. + +NOTE 2: Use of "a value from the dynamic PT range" is indicating a VBD RTP packet according to ITU-T Recommendation V.152 [37]. The MGW may offer then an enhanced VBD service. + +Upon detection of voiceband facsimile/modem or data/modem data traffic, the Media Gateway shall autonomously switch from Audio mode to VBD mode with VBD codec. + +Transitioning between Audio mode and VBD mode is possible in both directions. The procedures for transitioning between these two operation modes are described in ITU-T Recommendation V.152 clause 10/V.152 [37]. Any state transition requires the detection of a "VBD stimuli" (see ITU-T Recommendation V.152 clause 9/V.152 [37]). The IM-MGW shall be compliant with ITU-T Recommendation G.168 [55] on detecting VBD. + +For Real-Time Text Telephony support within IMS at the IMS termination see subclause 10.2.3.5. + +#### 10.2.3.5 Real-Time Text Telephony Media + +On IMS terminations, text is transported according to IETF RFC 4103 [50] "text/t140" conversation RTP payload format and coded according to ITU-T Recommendation T.140 [51]. + +If redundancy is used per IETF RFC 2198 [53], another payload type number needs to be provided for the redundancy format. + +IETF RFC 4103 [50] contains the MIME registration with media type "text" and media subtype "t140". IETF RFC 4102 [52] contains the MIME registration with media type "text" and media subtype "red" (for redundancy coding variant). + +RTP- Real-Time Text shall be signalled in a distinct SDP m-line accordingly in the SDP "a=rtpmap"-line and a dynamic RTP payload type shall be used. + +Example of SDP which describes RTP Real-Time Text transport on port 11000 without redundancy: + +``` +m=text 11000 RTP/AVP 98 +a=rtpmap:98 t140/1000 +``` + +Example of SDP which describes RTP Real-Time Text transport on port 11000, but also utilizes IETF RFC 2198 [53] to provide two levels of redundancy for the text packets: + +``` +m=text 11000 RTP/AVP 100 98 +a=rtpmap:98 t140/1000 +a=rtpmap:100 red/1000 +a=fmtp:100 98/98/98 +``` + +When Real-Time Text Telephony is configured at the IMS Termination in the IM-MGW and G.711 encoding is configured at peer CS side Termination and the terminations are through-connected the IM-MGW shall + +- monitor the CS side termination incoming PCM streams for text telephony in accordance with provisioned inband text telephony tone types at the CS side termination and, if multiple inband text telephony tone types are provisioned, in accordance with ITU-T Recommendation V.18 [54]; +- forward any detected incoming text telephony media at the CS side termination towards the IMS termination text stream; and +- multiplex any Real Time Text payload received from the IMS side to the CS side termination outgoing PCM streams for text telephony in accordance with provisioned inband text telephony tone type at the CS side termination in accordance with ITU-T Recommendation V.18 [54]. + +#### 10.2.3.6 T.38 FAX + +FAX according to ITU-T recommendation T.38 [65] may be supported at IMS terminations at an IM-MGW and at the MGCF according to the procedures in the present Clause. + +Version 2 or higher of T.38 is recommended. + +An IM-MGW supporting T.38 shall support the "UDPTL/UDP" and may support "TPKT/TCP" transport of FAX. + +To configure FAX terminations, the MGCF shall signal "udptl" or "tcp" in an SDP m-line and may signal the T.38 SDP attributes listed in Table 10.2.3.6.1 to the IM-MGW. + +**Table 10.2.3.6.1: Applicable T.38 SDP attributes at the Mn Interface.** + +| Attribute | Remarks | +|----------------------------|-------------------------------------------------------------------------------------------------------------------| +| T38FaxVersion | T.38 SDP attributes shall only be provisioned for Version 2 or higher. Version 0 applies if attribute is omitted. | +| T38MaxBitRate | | +| T38FaxMaxBuffer | | +| T38FaxMaxDatagram | | +| T38FaxMaxIFP | Only if T.38 version 4 is supported by the IM-MGW | +| T38FaxUdpEC | | +| T38FaxUdpECDepth | Only if T.38 version 4 is supported by the IM-MGW | +| T38FaxUdpFECMaxSpan | Only if T.38 version 4 is supported by the IM-MGW | +| T38ModemType | Only if T.38 version 4 is supported by the IM-MGW | + +# --- 11 Mandatory Support of SDP and H.248 Annex C information elements + +See Annex A.15. + +# --- 12 General on packages and Transactions + +The use of "Overspecified" (e.g. range of values) and "Underspecified" (e.g. "?") parameter specification shall not be permitted except where explicitly indicated in or referenced by the Mn interface specification. + +Commands on ROOT Termination shall only use the NULL Context. + +## 12.1 Profile Details + +VOID. + +NOTE: Profile now defined in normative Annex A. + +# --- 13 Void + +# 14 Call independent H.248 transactions + +See section A.17.1 + +# --- 15 Transactions towards IM CN Subsystem + +15.1 Procedures related to a termination towards IM CN SubsystemFor Transactions towards IM CN Subsystem see A.17.2. + +## 15.2 IMS packages + +None + +# --- 16 Transactions towards ISUP + +## 16.1 Procedures relating to a termination towards ISUP + +See section A.17.3. + +## 16.2 ISUP packages + +None + +# --- 17 Transactions towards BICC + +## 17.1 Procedures related to a termination towards BICC + +See section A.17.4 + +## 17.2 BICC packages + +This Clause is only applicable for terminations towards BICC Networks. The support of terminations towards BICC networks is optional. + +No new packages for terminations towards BICC Networks are defined in the present specification. See Clause 12.1.14 for reused packages from other specifications. + +If the Nb framing protocol (see 3GPP TS 29.415 [21]) is applied at the termination towards the BICC network, the following package shall be applied: + +3GUP package (see subclause 15.1.1 of 3GPP TS 29.232 [5]); To enable bearer modification at OoBTC capable networks on Nb interface (see 3GPP TS 23.153 [22]) at the termination towards the BICC network, the following package shall be applied: + +Modification of Link Characteristics Bearer Capability (see subclause 15.1.5 of 3GPP TS 29.232 [5]); + +# --- Annex A (normative): Profile Description + +## A.1 Profile Identification + +**Table A.1/1: Profile version** + +| | | +|----------------------|---------------| +| Profile name: | threegimscsiw | +| Version: | 7 | + +## --- A.2 Summary + +This Profile describes the minimum mandatory settings and procedures required to fulfil the Media Gateway control requirements for a) the interworking scenario between 3GPP IMS and 3GPP CS or PSTN/ISDN and b) the interworking scenario between NGN and PSTN/ISDN (i.e ETSI IMS-PSTN/ISDN, ETSI PES-PSTN/ISDN). + +In addition optional settings and procedures are described which fulfil optional features and where supported, the minimum mandatory settings within the optional procedures and packages are identified that must be supported in order to support that feature. + +"Optional" or "O" means that it is optional for either the sender or the receiver to implement an element. If the receiving entity receives an optional element that it has not implemented it should send an Error Code (e.g. 445 "Unsupported or Unknown Property", 501 "Not Implemented", etc.). "Mandatory" or "M" means that it is mandatory for the receiver to implement an element. Whether it is mandatory for the sender to implement depends on specific functions; detail of whether elements of the core protocol are mandatory to be sent are defined in the stage 2 procedures, stage 3 procedures and/or the descriptions of individual packages. + +The setting or modification of elements described in the profile under the heading "Used in Command" has the meaning that the property can be set/modified with that command. The property may be present in other commands (in order to preserve its value in accordance with ITU-T H.248.1[9]) when those commands are used for other procedures that affect the same descriptor. + +This profile supports Explicit Congestion Notification, Multimedia Priority Service and Rate Adaptation for Media Endpoints using Enhanced Bandwidth Negotiation. + +## --- A.3 Gateway Control Protocol Version + +ITU Recommendation H.248.1 Version 2 [9] shall be the version supported. + +## A.4 Connection Model + +**Table A.4/1: Connection Model** + +| | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| Maximum number of contexts: | No restriction | +| Maximum number of terminations per context: | 2 (NOTE 1)
32 (NOTE 2) | +| Allowed terminations type combinations in a Context | All (NOTE 3) | +| NOTE 1: Support of 2 terminations per context is required for TISPAN. Support of more than two terminations per context (e.g. for monitoring) is optional.
NOTE 2: Support of 32 termination per context is required for 3GPP
NOTE 3: For TISPAN NGN R2 only the following is required:
- Context[a](IMS, TDM),
- Context[b](TDM, TDM),
- Context [c] (TDM),
- Context [d] (IMS). | | + +## A.5 Context Attributes + +**Table A.5/1: Context attributes** + +| Context Attribute | Supported | Values Supported | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|-------------------------| +| Topology | Optional (NOTE 1) | All | +| Priority Indicator | Optional (NOTE 2) | 0-15 (NOTE 3) | +| Emergency Indicator | Yes | Not Applicable | +| NOTE 1: The "Topology" attribute is optional for example support of monitoring. If requested and not supported error code 444 shall be returned.
NOTE 2: This Context Attribute parameter is used for MPS as specified in 3GPP TS 22.153 [63].
NOTE 3: Priority values 11 – 15 of the Priority Indicator are reserved for MPS. | | | + +## A.6 Terminations + +### A.6.1 Termination Names + +#### A.6.1.1 General + +The Termination ID structure is provisioned in the MGC and MG and is known by the MG and the MGC at or before start up. + +With ephemeral ATM/AAL2 and IP endpoint bearer types the internal structure of Termination ID is irrelevant for MGW and MGC and therefore Termination ID is only a numeric identifier for the termination. When bearer type is a physical timeslot within TDM circuit the Termination ID structure shall follow the Termination naming convention for TDM circuit bearer. + +Ephemeral terminations are further denoted in the profile by the following: + +- BICC (meaning applies to terminations towards BICC) +- BICC ATM (meaning applies to terminations towards BICC with ATM transport) +- BICC IP (meaning applies to terminations towards BICC with IP transport) +- IMS (meaning applies to terminations toward IMS) +- Multiplex (meaning applies to terminations performing multiplexing) + +- RTP-CN (meaning applies to terminations towards SIP-I on Nc) + +#### A.6.1.2 ASN.1 Encoding + +##### A.6.1.2.1 General Structure + +The following general structure of TerminationID shall be used: + +4 octets shall be used for the termination ID. The following defines the general structure for the termination ID: + +| | | +|------------------|---| +| Termination type | X | +|------------------|---| + +Termination type: + +Length 3 bits + +Values: + +000 Reserved + +001 Ephemeral termination + +010 TDM termination + +011 - 110 Reserved + +111 Reserved for ROOT termination Id (ROOT Termination Id = 0xFFFFFFFF) + +X: + +Length 29 bits. + +Usage dependent on Termination type. TDM terminations specified below in subclause 5.2.2. Other usage unspecified. + +The use of wildcarding for the Termination Id shall be performed using 1 octet only. + +##### A.6.1.2.2 Termination naming convention for TDM terminations + +**Table C.6.1.2.2/1 ASN.1 coding** + +| | | | +|--------------------------|------------|------------| +| Termination type (=010 ) | PCM system | Individual | +|--------------------------|------------|------------| + +PCM system: + +Length 24 bits + +Usage unspecified. Uniquely identifies PCM interface in MGW + +Individual: + +Length: 5 bits + +Max. of 32 individuals (timeslots) per PCM system (max. 24 for a 24 channel system) + +#### A.6.1.3 ABNF coding: + +##### A.6.1.3.0 General Structure + +The following general structure of termination ID shall be used: + +TerminationID = "ROOT" / pathName / "\$" / "\*" ; according to ITU-T H.248.1 [9] Annex B. + +##### A.6.1.3.1 Termination Naming Convention for TDM Terminations + +###### A.6.1.3.1.1 Naming Structure + +A hierarchical naming structure is recommended for physical Terminations. + +The PCMsystem is recommended to follow the following physical and digital signal hierarchy: + +PCMsystem = \_/\_/... + +The identifies the particular hierarchy level. + +Some example values of are: + +"s", "su", "stm4", "stm1", "oc3", "ds3", "e3", "ds2", "e2", "ds1", "e1" where "s" indicates a slot number and "su" indicates a sub-unit within a slot. + +Leading zeroes MUST NOT be used in any of the numbers ("#") above. + +The is a decimal number which is used to reference a particular instance of a at that level of the hierarchy. Value ranges always starting with one. + +The number of levels and naming of those levels is based on the physical hierarchy within the Media Gateway. + +Here are some examples of the Termination structure: + +1. TDM Terminations at SDH STM-1 ports: + +tdm/s\_/stm1\_/e1\_/ + +e.g., tdm/s\_2/stm1\_3/e1\_17/25 + +2. TDM Terminations at PDH E1 ports (e.g., for "PCM system" only applications): + +tdm/s\_/e1\_/ + +e.g., tdm/s\_2/e1\_17/25 + +NOTE 1: This Termination naming convention may be used to align with ASN.1 TDM Termination names as defined in A.6.1.2.2. The alignment must take into account the numbering scheme of "" with the "PCM system" field, and the upper level(s) are regarded as prefix ("tdm/s-" versus "3-bit codepoint for 'TDM' "). + +NOTE 2: See also clause 3/H.248.33 concerning "PCM system" definition. + +3. TDM Terminations at SONET OC-3 ports: + +tdm/s\_/oc3\_/ds1\_/ + +e.g., tdm/s\_2/oc3\_3/ds1\_17/22 + +###### A.6.1.3.1.2 Syntactical Specification + +The syntax specification may be used for the population of valid TDM TerminationID structures for. + +ABNF (IETF RFC 4234) is used for the syntax specification. + +pathName = TDMToken SLASH (PCMsystem / "\*") + +TDMToken = "tdm" + PCMSystem = 0\*(HierarchyLevelHIGHToken SLASH) HierarchyLevelLOWToken + HierarchyLevelHIGHToken = (UnitTypeToken "\_" UnitNumber) + HierarchyLevelLOWToken = (UnitTypeToken "\_" Wildcard) / Channel / Wildcard + UnitTypeToken = "ChassisToken" / "SDHToken" / "SONETToken" / "PDHToken" + ChassisToken = "s" / "su" ; slot, sub-unit within slot + SDHToken = "stm4" / "stm1" ; relevant is capacity, but not +                               electrical or optical interface type + SONETToken = "oc12" / "oc3" + PDHToken = "ds3" / "e3" / "ds2" / "e2" / "ds1" / "e1" ; ANSI & ETSI + UnitNumber = 1\*DIGIT + Channel = %d0-31 / %d0-23 ; value range E1/T1 system + Wildcard = "\*" + +###### A.6.1.3.1.3 Wildcarding + +Wildcarding (CHOOSE, ALL) is allowed for number fields ("``"). + +Examples for wildcarding: + +1. TDM Terminations at SDH STM-1 ports: + +e.g., wildcarding on top level: `tdm/*` + e.g., wildcarding on slot level: `tdm/s_3/*` + e.g., wildcarding on STM-1 level: `tdm/s_3/stm1_4/*` + e.g., wildcarding on E1 level: `tdm/s_2/stm1_4/e1_49/*` + +2. TDM Terminations at PDH E1 ports: + +e.g., wildcarding on E1 level: `tdm/s_1/e1_2/*` + +###### A.6.1.3.1.4 Heterogeneous TDM Port Configurations + +An homogeneous TDM port configuration relates to a MGW with a single port type for physical Terminations. There is therefore a single TDM Termination name structure in use. + +Heterogeneous TDM configurations means different port types, either by different signal hierarchies, like SDH/STM-1 and SDH/STM-4, and/or a mix of SDH and PDH interfaces. The number of port types in use is determining the number of TDM Termination name structures. With heterogeneous configurations the TDM Termination name structure may be aligned, for instance, by using the "highest common digital signal hierarchy" as highest Termination name hierarchical level. There is consequently a single TDM Termination name structure with a "flattened" hierarchy. + +Example: + +MGW with SDH/STM-1 and PDH/E1 ports. Common denominator is "e1", a selected TDM Termination name might be therefore a common two-level structure with "`tdm/e1_/`". The unit types "s", "su" or "stm1" are not used here. + +NOTE: This concept is followed in A.6.1.2.2, ASN.1 for TDM Terminations. + +##### A.6.1.3.2 Termination Naming Convention for Ephemeral Terminations + +###### A.6.1.3.2.1 Naming Structure + +An alphanumeric pathname structure is recommended for Ephemeral terminations: + +ephemeral/ + +e.g., Ephemeral/1/0/40000 + +###### A.6.1.3.2.2 Syntactical Specification + +The syntax rules may be used for the population of valid ephemeral TerminationID structures for. ABNF (IETF RFC 4234) is used for the syntax specification. + +ABNF coding: + +pathName = EphToken SLASH EPHsystem + +EphToken = "Ephemeral" ; so called prefix + +; The maximum length of 'pathname' is defined in Annex B.2/H.248.1. + +EPHsystem = 0\*(HierarchyLevelHIGHToken SLASH) HierarchyLevelLOWToken + +HierarchyLevelHIGHToken = 1\*alphanum + +HierarchyLevelLOWToken = Individual / Wildcard + +alphanum = ALPHA / DIGIT + +Individual = 1\*DIGIT + +Wildcard = "\$" / "\*" + +### A.6.2 Multiplexed terminations + +**Table A.6.2/1: Multiplexed terminations** + +| | | +|-----------------------------------------------------------------------|------------| +| MultiplexTerminations Supported | Yes (NOTE) | +| NOTE : Yes for multimedia interworking and No for voice interworking. | | + +**Table A.6.2/2: Multiplex Types Supported** + +| | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| Multiplex types supported: | H.223 | +| Maximum number of terminations connected to multiplex: | TBD (NOTE) | +| NOTE: It is not clear what is the exact purpose of this parameter; further clarification within H.248.1 core protocol is required before this property shall be used. | | + +## A.7 Descriptors + +### A.7.1 Stream Descriptor + +**Table A.7.1/1: Stream descriptors** + +| | | +|----------------------------------------------------------------------------------------------------------------|----------| +| Maximum number of streams per termination type | 2 (NOTE) | +| NOTE : Value 2 for multimedia interworking and Real-Time Text interworking and value 1 for voice interworking. | | + +#### A.7.1.1 Local Control Descriptor + +**Table A.7.1.1/1: Local Control Descriptor** + +| | | Termination Type | Stream Type | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|------------------------------------|----------------| +| Reserve group used: | No | | | +| Reserve value used: | Yes (NOTE 1) | Terminations Toward IMS and RTP-CN | Not Applicable | +| NOTE 1: The "Reserve value" parameter is, inter alia, required for negotiation of multiple payload types, ie ITU-T Rec. G.711, comfort noise (according ITU-T Rec. G.711 Appendix II), DTMF tone relay (see RFC2833 [18]). | | | | + +**Table A.7.1.1/2: Allowed Stream Modes** + +| Termination Type | Stream Type | Allowed StreamMode Values | +|-------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|----------------------------------------| +| TDM | Not Applicable | SendOnly, RecvOnly, SendRecv, Inactive | +| IMS | Audio, Video, Text (NOTE 1) | SendOnly, RecvOnly, SendRecv, Inactive | +| BICC IP, RTP-CN | Not Applicable | SendOnly, RecvOnly, SendRecv, Inactive | +| BICC ATM | Not Applicable | SendOnly, RecvOnly, SendRecv, Inactive | +| Multiplex (NOTE 2) | Audio, Video | SendOnly, RecvOnly, SendRecv, Inactive | +| NOTE 1: Audio and Video for multimedia interworking, Audio and Text for Real-Time Text interworking, and Not applicable for voice interworking. | | | +| NOTE 2: Specific for multimedia interworking. | | | + +### A.7.2 Events Descriptor + +**Table A.7.2/1: Events Descriptor** + +| | | | | +|---------------------------------------------------------------|-------------------------------------------|-----------------------------------------------------|--------------------| +| Events settable on termination types and stream types: | Yes | | | +| | Event ID | Termination Type | Stream Type | +| | Detect_Digit(Digit) (d0 to dd, inclusive) | ALL except ROOT | Not Applicable | +| | BNC Established | Terminations towards BICC network | Not Applicable | +| | BNC Modification Failed | Terminations towards BICC network | Not Applicable | +| | BNC Modified | Terminations towards BICC network | Not Applicable | +| | Tunnel | Terminations towards BICC network with IP transport | Not Applicable | + +| | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|------------------------|---------------------------------------------------| +| | g/cause | ALL except ROOT | Not Applicable | +| | g/sc | ALL except ROOT | Not Applicable | +| | ct/cmp | TDM | Not Applicable | +| | chp/mgcon | ROOT | Not Applicable | +| | Hangterm/thb | ALL except ROOT | Not Applicable | +| | ocp/mg_overload | ROOT | Not Applicable | +| | it/ito | ROOT | Not Applicable | +| | Start tone detected
(tonedet/std) | RTP-CN, IMS, TDM, BICC | Only applicable to audio stream | +| | End Tone detected
(tonedet/etd) | IMS | RTP-CN, TDM, BICC Only applicable to audio stream | +| | Optimal Codec Event
(threegtoc/codecs_modify) | TDM, BICC, RTP-CN | Not Applicable | +| | Codec List Event
(threegtoc/distant codec_list) | TDM, BICC, RTP-CN | Not Applicable | +| | TFO Status Event
(threegtoc/TFO_status) | TDM, BICC, RTP-CN | Not Applicable | +| | Incoming H.245 message
(h245tp/h245msgin, 0x00 b4/0x0001) | Multiplex | Not Applicable | +| | MONA Preference reception
(monapref/monaprefmsgin, 0x00f8/0x0001) | Multiplex | Not Applicable | +| | MONA Preference negotiation completed
(monapref/monaprefcompl, 0x00f8/0x0002) | Multiplex | Not Applicable | +| | Legacy Detected
(monapref/Legdet, 0x00f8/0x0003) | Multiplex | Not Applicable | +| | MPC reception
(monapref/mpcrec, 0x00f8/0x0004) | Multiplex | Not Applicable | +| | RTCP Feedback Message Detection
(rtcpfb/det, 0x00f6/0x0001) | IP | Not Applicable | +| | ECN Failure(ecnrous/fail, 0x010b/0x0001) | IP | Audio, Video | +| | ICE New Peer Reflexive Candidate (ostuncc/nprc, 0x00c3/0x0002) – See subclause A.14.38 | IP | Only applicable for full ICE | +| | ICE Connectivity Check Result (ostuncc/ccr, 0x00c3/0x0001) – See subclause A.14.38 | IP | Only applicable for full ICE | +| NOTE: Events for Terminations towards BICC network dependent on option to support such interworking, e.g. not required for TISPAN NGN R2 TMGW. | | | | +| NOTE1: BNC Release event is defined in formats and codes table 10.1 and refers to the g/cause event. | | | | + +Table A.7.2/2: Event Buffer Control + +| | | +|-----------------------------------|----| +| Event Buffer Control used: | No | +|-----------------------------------|----| + +Table A.7.2/3: Keep active + +| | | +|----------------------------------------------------------------|----------------------| +| Keepactive used on events: | Conditional (NOTE 1) | +| NOTE 1: Required for 3GPP, not required by TISPAN NGN R2 TMGW. | | + +Table A.7.2/4: Embedded events + +| | | +|------------------------------------------------|----| +| Embedded events in an event descriptor: | No | +|------------------------------------------------|----| + +Table A.7.2/5: Embedded signals + +| | | +|-----------------------------------------------------------------------------------------|-----| +| Embedded signals in an event descriptor: | Yes | +| NOTE: Used if MONA procedures are supported in the Add Multiplex Termination procedure. | | + +### A.7.3 EventBuffer Descriptor + +Table A.7.3/1: Event Buffer Descriptor + +| | | +|--------------------------------------|----| +| Event Buffer descriptor used: | No | +|--------------------------------------|----| + +### A.7.4 Signals Descriptor + +Table A.7.4/1: Signals Descriptor + +| Signals settable dependant on termination or streams types: | | Yes
NOTE: "Yes" means any signal not listed below may be played on any termination or stream, except Signals on ROOT termination shall not be supported. | | +|--------------------------------------------------------------------|--------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| If yes | Signal ID | Termination Type | Stream Type / ID | +| | ct/* | TDM | Not Applicable | +| | gb/* | BICC | Not Applicable | +| | bt/* | BICC IP | Not Applicable | +| | cg/rt
cg/bt
cg/ct | TDM | Not Applicable | +| | an/apf | ALL except ROOT and Multiplex | Not Applicable | +| | Outgoing H.245 Message (h245tp/h245msgout, 0x00b4/0x0001) | Multiplex | Not Applicable | +| | Outgoing MONA preference message (monapref/monaprefmsgout, 0x00 f8/0x0001) | Multiplex | Not Applicable | +| | Forward Media in Preconfigured Channel (monapref/Preconfchannelmedia, 0x00f8/0x0002) | Multiplex | Not Applicable | +| | Feedback Message Sending (rtcpfb/fbmesssend, 0x00f6/0x0001) | IP | Not Applicable | +| | Send Additional Connectivity Check (ostuncc/sacc, 0x00c3/0x0002) | IP | Only applicable for full ICE | +| | Send Connectivity Check (ostuncc/scc, 0x00c3/0x0001) | IP | Only applicable for full ICE | + +Table A.7.4/2: Signal Lists + +| Signals Lists supported: | | Conditional (NOTE 1) | +|---------------------------------|-------------------------------------------|----------------------| +| If yes | Termination Type Supporting Lists: | ALL except ROOT | +| | Stream Type Supporting lists: | ALL | + +| | | | +|------------------------------------------------------------------------|----------------------------------------------------|--------------| +| | Maximum number of signals to a signal list: | FFS | +| | Intersignal delay parameter supported: | No | +| NOTE 1: Required for 3GPP, not required for TISPAN NGN R2 TMGW. | | | +| NOTE 2: This field requires at least version 3 of the H.248.1 protocol | | | + +**Table A.7.4/3: Overriding Signal type and duration** + +| | | +|--------------------------------------------|----------| +| Signal type and duration supported: | Optional | +| NOTE: Not required for TISPAN NGN R2 TMGW. | | + +**Table A.7.4/4: Notify completion** + +| | | | +|-----------------------------------------------------------------------|-----------------------------|-------------------------------------| +| Notify completion supported: | Yes | | +| If yes | SignalID | Type of completion supported | +| | All Tones and Announcements | TO, EV, SD and NC | +| RequestID Parameter Supported: | NO | | +| NOTE: This field requires at least version 3 of the H.248.1 protocol. | | | + +**Table A.7.4/5: Signals played simultaneously** + +| | | +|---------------------------------------|----| +| Signals played simultaneously: | No | +|---------------------------------------|----| + +**Table A.7.6/6: Keep active** + +| | | +|-----------------------------------------------------------------|----------------------| +| Keepactive used on signals: | Conditional (NOTE 1) | +| NOTE 1: Required for 3GPP, not required for TISPAN NGN R2 TMGW. | | + +### A.7.5 DigitMap Descriptor + +**Table A.7.5/1: DigitMap Descriptor** + +| | | +|------------------------------|----| +| Digit Maps supported: | No | +|------------------------------|----| + +### A.7.6 Statistics Descriptor + +**Table A.7.6/1: Statistics Descriptor** + +| | | +|-------------------------------------------------|----------------------------------------------| +| Statistics reported on subtract: | No (for TDM Terminations) | +| | Optional For Ephemeral Terminations (NOTE 1) | +| NOTE 1: This is required for TISPAN NGN R2 TMGW | | + +### A.7.7 ObservedEvents Descriptor + +**Table A.7.7/1: Observed Events Descriptor** + +| | | +|----------------------------------------|----| +| Event detection time supported: | No | +|----------------------------------------|----| + +### A.7.8 Topology Descriptor + +Table A.7.8/1: Topology Descriptor + +| | | +|-----------------------------------------------------------------|-----------------------------------------------------------------------------| +| Allowed triples: | Optional (NOTE 1) :
(T1, T2, isolate) (T1, T2, oneway) (T1, T2, bothway) | +| NOTE 1: If not supported then error code 444 shall be returned. | | + +### A.7.9 Error Descriptor + +Table A.7.9/1: Error Codes Sent by MGCF + +| | | +|---------------------------------------------------|-------------------------------------------------------------------| +| Supported H.248.8 Error Codes: | FFS < list of individual numbers> | +| Supported Error Codes defined in packages: | All error codes defined in supported packages shall be supported. | + +Table A.7.9/2: Error Codes Sent by MGW: + +| | | +|---------------------------------------------------|-------------------------------------------------------------------| +| Supported H.248.8 Error Codes: | FFS< list of individual numbers> | +| Supported Error Codes defined in packages: | All error codes defined in supported packages shall be supported. | + +### A.7.10 TerminationState Descriptor + +Table A.7.10/1: TerminationState Descriptor + +| | | +|----------------------------------------------|------------------------| +| TerminationState: ServiceStates: | InService/OutOfService | +| TerminationState: EventBufferControl: | OFF | + +## --- A.8 Command API + +### A.8.1 Add + +Table A.8.1/1: Descriptors used by Command Add Request + +| | | +|-----------------------------------------|----------------------------------------------------------------| +| Descriptors used by Add Request: | Events, Signals, Media (LocalControl, Local And Remote), Audit | +|-----------------------------------------|----------------------------------------------------------------| + +**Table A.8.1/2: Descriptors used by Command Add Reply** + +| | | +|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Descriptors used by Add Reply: |

Events, Signals, Media (LocalControl, Local And Remote), Error, Audit

When command request excludes an Audit Descriptor, the MGW response shall only include descriptors which contained underspecified or overspecified properties in the command request. Furthermore, only those properties that were underspecified or overspecified in the request shall be sent in the reply. Exceptions to this rule are:

  • - The Error Descriptor
  • - SDP properties returned in "Reserve IMS Connection Point" and "Reserve IMS Connection Point and Configure Remote Resources" procedures, as specified in A.17.2.2 and A.17.2.4
| +|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### A.8.2 Modify + +**Table A.8.2/1: Descriptors used by Command Modify Request** + +| | | +|--------------------------------------------|----------------------------------------------------------------| +| Descriptors used by Modify Request: | Events, Signals, Media (LocalControl, Local And Remote), Audit | +|--------------------------------------------|----------------------------------------------------------------| + +**Table A.8.2/2: Descriptors used by Command Modify Reply** + +| | | +|------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Descriptors used by Modify Reply: |

Events, Signals, Media (LocalControl, Local And Remote), Error, Audit

When command request excludes an Audit Descriptor, the MGW response shall only include descriptors which contained underspecified or overspecified properties in the command request. Furthermore, only those properties that were underspecified or overspecified in the request shall be sent in the reply. Exceptions to this rule are:

  • - The Error Descriptor
  • - SDP properties returned in "Configure IMS Resources" procedure as specified in A.17.2.3.
| +|------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### A.8.3 Subtract + +**Table A.8.3/1: Descriptor used by Command Subtract Request** + +| | | +|----------------------------------------------|-----------------------| +| Descriptors used by Subtract Request: | AUDIT (empty) or NONE | +|----------------------------------------------|-----------------------| + +**Table A.8.3/2: Descriptor used by Command Subtract Reply** + +| | | +|--------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Descriptors used by Subtract Reply: |

None or Statistics

When command request contains "Audit(empty)", then no statistics are returned. Otherwise, connection statistics are returned in the Subtract reply dependent on the supported packages (see clause A.14).

| +|--------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### A.8.4 Move + +**Table A.8.4/1: Command Move** + +| | | +|---------------------------------------------------------------|----------------| +| Move command used: | Optional(NOTE) | +| NOTE: If not supported then error code 443 shall be returned. | | + +**Table A.8.4/2: Descriptors used by Move Request** + +| | | +|------------------------------------------|----------------------------------------------------------------| +| Descriptors used by Move Request: | Events, Signals, Media (LocalControl, Local And Remote), Audit | +|------------------------------------------|----------------------------------------------------------------| + +**Table A.8.4/3: Descriptors used by Move Reply** + +| | | +|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Descriptors used by Move Reply | Events, Signals, Media (LocalControl, Local And Remote), Error, Audit.
When command request excludes an Audit Descriptor, the MGW response shall only include descriptors which contained underspecified or overspecified properties in the command request, with the exception of the Error Descriptor. Furthermore, only those properties that were underspecified or overspecified in the request shall be sent in the reply. | +|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### A.8.5 Auditvalue + +**Table A.8.5/1: Auditvalue** + +| Audited Properties: | Property Name and Identity | Descriptor | +|--------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| Termination ID | TerminationState:
- TDM: ALL (indicating 1 TDM group NOTE3), individual termination (NOTE 4)
- ATM/IP: individual termination
- Root (MGW Audit) | TerminationState Descriptor | +| Termination ID | MGC information (mgcinfo)
TDM: Individual Termination | LocalControl Descriptor | +| Termination ID | For Packages:
- Root
- TDM/ATM/IP: individual termination (NOTE1) | Packages Descriptor (NOTE2) | +| Termination ID | None (MGW Audit) :
- Root | Audit (empty) Descriptor | +| Termination ID | SDPCapNeg Extensions:
- sdpe/* | TerminationState Descriptor | +| Audited Statistics: | None | | +| Audited Signals: | None | | +| Audited Events: | None | | +| Packages Audit Possible | Yes | | + +NOTE1: The purpose to audit an individual Termination is to retrieve MGC Information if supported. +NOTE2: Support of this capability is optional. +NOTE3: TDM Group equates to an E1 or T1 PCM System. +NOTE 4: Auditing a single termination of a TDM group is an alternative to the wildcarded audit (TDM: ALL) to derive the service state of the TDM group. All the terminations of the TDM group share the same service state. + +### A.8.6 Auditcapability + +**Table A.8.6/1: Auditcapability** + +| Audited Properties: | Property Name and Identity | Descriptor | +|----------------------------------------------------------------------------|-----------------------------------|-------------------| +| | FFS | FFS | +| Audited Statistics: | None | | +| Audited Signals: | None | | +| Audited Events: | None | | +| NOTE: AuditCapability command is not supported by the ETSI TISPAN profile. | | | + +### A.8.7 Notify + +**Table A.8.7/1: Descriptors Used Notify** + +| | | +|------------------------------------------------------------------|-----------------------| +| Descriptors used by Notify Request or Reply: | ObservedEvents, Error | +| NOTE : The Error Descriptor shall not be used in Notify Request. | | + +### A.8.8 Service Change + +**Table A.8.8/1: Service Change Methods and Reasons Sent By MGCF** + +| ServiceChange Methods supported: | ServiceChange Reasons supported: | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------| +| Restart (NOTE1) | "901 Cold Boot" (Optional)
"902 Warm Boot" (Optional) | +| Handoff (NOTE1, NOTE 2) | "903 MGC Directed Change" (Mandatory) | +| Forced (NOTE1) | "905 Termination Taken Out Of Service" (Optional) | +| Graceful (NOTE1) | "905 Termination Taken Out Of Service" (Optional) | +| NOTE : When a Service Change command on the Root termination with a method other than Graceful is sent, the command shall always be sent as the only command in a message. The sending node shall always wait for the reply to a Service Change command on the Root termination with a method other than Graceful before sending further command requests. A Service Change command on the Root termination with method Graceful may be combined with other commands in a single message. | | +| NOTE 1: ROOT Only. | | +| NOTE 2: Not involving more than 1 MGCF. No support of handoff relates to a network deployment scenario with "primary H.248 systems only", which translates to no geographic redundancy of the MGCF. | | + +**Table A.8.8/2: Service Change Methods and Reasons Sent By MGW** + +| ServiceChange Methods supported: | ServiceChange Reasons supported: | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Restart | "900 Service Restored" (Mandatory)
"901 Cold Boot" (Mandatory) (NOTE1)
"902 Warm Boot" (Mandatory) (NOTE1)
"910 Media Capability Failure " ALL except ROOT (Optional)
"913 Signal Capability Failure " ALL except ROOT (Optional)
"914 Event Capability Failure " ALL except ROOT (Optional)"916 Packages Change (Optional)
"917 Capability Change (Optional) | +| Graceful | "904 Termination Malfunction" ,ALL except ROOT, (Mandatory)
"905 Termination Taken Out Of Service", (Mandatory)
"906 Loss Of Lower Layer Connectivity" , ALL except ROOT, (Mandatory)
"907 Transmission Failure" ALL except ROOT, (Mandatory)
"908 MG Impending Failure" ROOT only (Mandatory) | +| Forced | "904 Termination Malfunction" ,ALL except ROOT, (Mandatory)
"905 Termination Taken Out Of Service" (Mandatory)
"906 Loss Of Lower Layer Connectivity" ALL except ROOT, (Mandatory)
"907 Transmission Failure" ALL except ROOT, (Mandatory)
"908 MG Impending Failure" ROOT only (Mandatory) | +| Handoff (NOTE1, NOTE 2) | "903 MGC Directed Change" (Mandatory) | +| Disconnected (NOTE1) | "900 Service Restored" (Mandatory)
"916 Packages Change (Optional)
"917 Capability Change (Optional) | +| NOTE : When a Service Change command on the Root termination with a method other than Graceful is sent, the command shall always be sent as the only command in a message. The sending node shall always wait for the reply to a Service Change command on the Root termination with a method other than Graceful before sending further command requests. A Service Change command on the Root termination with method Graceful may be combined with other commands in a single message.
NOTE 1: ROOT Only.
NOTE 2: In response to a MGC Ordered Re-Register. | | + +**Table A.8.8/3: Service Change Address** + +| | | +|-----------------------------------|----| +| ServiceChangeAddress used: | No | +|-----------------------------------|----| + +**Table A.8.8/4: Service Change Delay** + +| | | +|---------------------------------|----| +| ServiceChangeDelay used: | No | +|---------------------------------|----| + +**Table A.8.8/5: Service Change Incomplete Flag** + +| | | +|-----------------------------------------------------------------------|----| +| ServiceChange Incomplete Flag used: | No | +| NOTE: This field requires at least version 3 of the H.248.1 protocol. | | + +**Table A.8.8/6: Service Change Version** + +| | | +|----------------------------------------------|---| +| Version used in ServiceChangeVersion: | 2 | +|----------------------------------------------|---| + +**Table A.8.8/6: Service Change Profile** + +| | | +|----------------------------------------|-----| +| ServiceChangeProfile mandatory: | Yes | +|----------------------------------------|-----| + +Table A.8.8/8: H.248.18 Profile negotiation + +| | | +|--------------------------------------|----| +| Profile negotiation as per H.248.18: | No | +|--------------------------------------|----| + +### A.8.9 Manipulating and auditing context attributes + +Table A.8.9/1: Manipulating and auditing context attributes + +| | | +|---------------------------------|---------------------------------------------------------------| +| Context Attributes Manipulated: | Topology (Optional) , Emergency Indicator, Priority Indicator | +| Context Attributes Audited: | None | + +## A.9 Generic command syntax and encoding + +Table A.9/1: Encodings + +| | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| +| Supported Encodings: | Binary (optional) (NOTE 1)
Text (optional) (NOTE 2) :
The receiver shall support:
Short Token Notation
Long Token Notation | +| If binary encoding, is indefinite length encoding supported: | Yes (NOTE3) | +| NOTE 1: For 3GPP Mn interface binary encoding is strongly recommended if only one encoding is selected to ensure interoperability.
NOTE 2: Text encoding is required by TISPAN NGN R2 TMGW. For implementations providing both 3GPP Mn and TISPAN functionality text encoding is required as a minimum.
NOTE3: The binary encoding rules which are applicable to the defined Abstract Syntaxes are the Basic Encoding Rules for Abstract Syntax Notation One, defined in ITU-T Recommendation X.690 [61]. Specifically in accordance with ITU-T Recommendation X.690 [61] section 7.3, alternative encodings based on the definite and indefinite form of length are permitted by the basic encoding rules as a sender's option. Receivers shall support both alternatives. | | + +## A.10 Transactions + +Table A.10/1: Transactions per Message + +| | | +|---------------------------------------------------------------------------------------------------------------|-------------------------| +| Maximum number of TransactionRequests / TransactionReplies / TransResponseAcks / Segment Replies per message: | 2(NOTE 1)
10(NOTE 2) | +| NOTE 1: Maximum required by TISPAN NGN R2
NOTE 2: Maximum required by 3GPP | | + +Table A.10/2: Commands per Transaction Requests + +| | | +|----------------------------------------------------------------------------|----------------------------------| +| Maximum number of commands per Transaction request: | 2(NOTE 1)
Unspecified(NOTE 2) | +| NOTE 1: Maximum required by TISPAN NGN R2
NOTE 2: Not specified by 3GPP | | + +**Table A.10/3: Commands per Transaction Reply** + +| | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| +| Maximum number of commands per Transaction reply: | 2 (NOTE 1)
Unspecified (NOTE 2) | +| NOTE 1: Maximum required by TISPAN NGN R2 | | +| NOTE 2: Not specified by 3GPP however for auditing with wildcarded requests (e.g TDM E1) then the reply may include up to 32 commands to indicate the termination state. | | + +**Table A.10/4: Commands for Wildcarded Responses** + +| | | +|---------------------------------------------------|------------------------------| +| Wildcarded responses may be requested for: | Modify, Subtract, AuditValue | +|---------------------------------------------------|------------------------------| + +**Table A.10/5: Procedures for Wildcarded Responses** + +| | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| +| Procedures that make use of wildcarded responses: | Release Bearer, Release Termination, Audit Value, Release IMS Termination, Release TDM Termination | +| NOTE: Used when multiple terminations are released with one command and in audit responses where multiple terminations are implied by the audit request. | | + +**Table A.10/6: Optional Commands** + +| | | +|-----------------------------------------------|-----| +| Commands able to be marked "Optional": | ALL | +|-----------------------------------------------|-----| + +**Table A.10/7: Transaction Timers** + +| Transaction Timer: | Value | +|---------------------------------|--------------| +| normalMGExecutionTime | Provisioned | +| normalMGExecutionTime | Provisioned | +| MGOriginatedPendingLimit | Provisioned | +| MGOriginatedPendingLimit | Provisioned | +| MGProvisionalResponseTimerValue | Provisioned | +| MGProvisionalResponseTimerValue | Provisioned | + +## A.11 Messages + +The MGC/MGW may be named according to the naming structure of the underlying transport protocol which carries the H.248 protocol. + +It is however recommended that MGC and MG names are in the form of fully qualified domain names. For example the domain name of the MGC may be of the form mgc1.whatever.net and the name of the MG may be of the form mg1.whatever.net. + +The "Message Identifier" in the H.248 messages may be used by the MGC and MG to identify the originator of the message. + +## A.12 Transport + +**Table A.12/1: Transport** + +| | | +|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Transports: | SCTP(recommended) (NOTE1).
SCTP/M3UA(optional) optional – as defined in IETF RFC 3332 [24] with options detailed in 3GPP TS 29.202 [25] (NOTE2).
UDP(optional). | +|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | +|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE: | If using SCTP as defined in IETF RFC 2960 [15] the MGW shall always be the node to perform the "Initiation". | +| NOTE1 | H.248 is "SCTP user" in this case of H.248/SCTP/IP based transport according ITU-T Rec. H.248.4 [38]. The number of used SCTP Streams for traffic of the H.248 Control Association must be defined, see § 8/H.248.4 [38]. A single SCTP Stream is the default assumption ("Single-Stream Mode") in this Profile. | +| NOTE2 | This is slightly different with regards to SCTP encapsulation. H.248 is "M3UA user" in this case of H.248/M3UA/SCTP/IP based transport. H.248 Messages are corresponding to M3UA user protocol data units. "SCTP multistreaming" may be also applied (see § 1.4.7/RFC 3332). If not then the complete M3UA traffic is mapped on a single SCTP Stream, i.e., the Single-Stream Mode. | +| NOTE3 | Checksum calculation for SCTP shall be supported as specified in RFC 3309 [43] instead of the method specified in RFC 2960 [15]. | + +Table A.12/2: Segmentation + +| | | +|-----------------------------------------------------------------------|----| +| Segmentation Supported: | No | +| NOTE: This field requires at least version 3 of the H.248.1 protocol. | | + +Table A.12/3: Support of Control Association Monitoring + +| | | +|----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Control Association Monitoring Supported: | Monitoring mechanism is dependent on used H.248 transport (see Table A.12/1):

SCTP: inherent capability of SCTP (NOTE 1)

SCTP/M3UA: inherent capability of SCTP

UDP:
  1. H.248.14 (MGW-driven monitoring)
  2. Empty AuditValue on ROOT (MGC-driven monitoring)
| +| NOTE 1: Use of H.248.14 [29] for this is FFS | | + +## A.13 Security + +Table A.13/1: Security + +| | | +|----------------------------|------| +| Supported Security: | None | +|----------------------------|------| + +## A.14 Packages + +Table A.14/1: Mandatory packages + +| Package Name | Package ID | Version | +|---------------------------------------------------------------------------------|-------------------|---------| +| Generic (see ITU-T Recommendation H.248.1 [9] Annex E.1); | g, (0x0001) | v1 | +| Base Root Package (see ITU-T Recommendation H.248.1 [9] Annex E.2); | root, (0x0002) | v2 | +| Basic Continuity Package (see ITU-T Recommendation H.248.1 [9] Annex E.10); | ct, (0x000a) | v1 | +| TDM Circuit Package (see ITU-T Recommendation H.248.1 [9] Annex E.13); | tdmc, (0x000d) | v1 | +| Hanging Termination Detection package (see ITU-T Recommendation H.248.36 [27]). | hangterm (0x0098) | v1 | + +Table A.14/2: Optional packages + +| Package Name | Package ID | Version | Support dependent on: | +|------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| Tone Detection Package (see ITU-T Recommendation H.248.1 [9] Annex E.4); | tonedet, (0x0004)
This package is "extension only". It must be supported if extended but shall not be published over the protocol. It is here for information only. | v1 | Mandatory for 3GPP | +| Basic DTMF Generator Package (see ITU-T Recommendation H.248.1 [9] Annex E.5); | dg, (0x0005) | v1 | Mandatory for 3GPP | +| DTMF Detection Package (see ITU-T Recommendation H.248.1 [9] Annex E.6); | dd, (0x0006) | v1 | Mandatory for 3GPP | +| Media Gateway Resource Congestion Handling Package (see ITU-T Recommendation H.248.10 [12]). | chp, (0x0029) | v1 | Mandatory for 3GPP | +| Generic Announcement Package (see ITU-T Recommendation H.248.7 [26]). Only Fixed Part is required. | an(0x001d) | v1 | 3GPP applications | +| Bearer Characteristics Package (see ITU-T Recommendation Q.1950 [14] annex A.3). | bcp (0x001e) | v2 | Terminations Towards BICC | +| Generic Bearer Connection Package (see ITU-T Recommendation Q.1950 [14] annex A.6). | Gb, (0x0021) | v1 | Interworking with BICC | +| Tone Generator Package (see ITU-T Recommendation H.248.1 [9] Annex E.3); | tongen, (0x0003) | v1 | This package is "extension only". It must be supported if extended but shall not be published over the protocol. It is here for information only. | +| Call Progress Tones Generator Package (see ITU-T Recommendation H.248.1 [9] annex E.7). | Cg, (0x0007) | v1 | | +| Basic Call Progress Tones Generator with Directionality, (see ITU-T Recommendation Q.1950 [14] annex A.8). | bcg, (0x0023) | v1 | Services provided by network | +| Expanded Call Progress tones Generator Package (see ITU-T Recommendation Q.1950 [14] annex A.9). | xcg, (0x0024) | v1 | Services provided by network | +| Basic Services Tones Generation Package, (see ITU-T Recommendation Q.1950 [14] annex A.10). | srvtn, (0x0025) | v1 | Services provided by network | +| Bearer Control Tunnelling Package (see ITU-T Recommendation Q.1950 [14] annex A.7). | Bt, (0x0022) | v1 | Interworking with BICC and IP transport | +| Expanded Services Tones Generation Package (see ITU-T Recommendation Q.1950 [14] annex A.11). | xsrvtn, (0x0026) | v1 | Services provided by network | +| Intrusion Tones Generation Package (see ITU-T Recommendation Q.1950 [14] annex A.12). | Int, (0x0027) | v1 | Services provided by network | +| 3GUP package (see subclause 15.1.1 of 3GPP TS 29.232 [5]) | threegup, (0x002f) | v1 | Interworking with BICN PLMN | +| Modification of Link Characteristics Bearer Capability (see subclause 15.1.5 of 3GPP TS 29.232 [5]) | threegmlc, (0x0046) | v1 | Interworking with BICN PLMN with Codec Modification | +| Inactivity timer package (see ITU-T Recommendation H.248.14 [29]) | it, (0x0045) | v1 | Only applicable for UDP transport. | +| TFO package (see subclause 15.2.2 of 3GPP TS 29.232 [5]) | threegtfoc, (0x0031) | v2 | | +| Media Gateway Overload Control Package (see ITU-T Recommendation H.248.11 [28]). | ocp, (0x0051) | v1 | | + +| | | | | +|----------------------------------------------------------------------------------------------------|---------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| MGC Information Package (see ITU-T Recommendation H.248.45 [30]) | mgcinfo, (0x00a0) | v1 | This package may be supported as an operator option. For this Profile the information string shall be limited to 32 octets in length. | +| RTP (ITU-T Recommendation H248.1 [9] Annex E.12) (NOTE 1) | rtp, (0x000c) | v1 | Used for connection statistics | +| H324 package (see ITU-T Recommendation H.248.12 [41]) | h324, (0x002c) | v1 | Multimedia calls | +| H.245 Transport Package (see ITU-T Recommendation H.248.12a2 [42]) | h245tp, (0x00b4) | v1 | Multimedia calls | +| IP Domain connection package (see ITU-T Recommendation H.248.41 [44]) | ipdc, (0x009d) | v1 | Multiple IP realms supported | +| H.245 Transport Package for SPC use (see ITU-T Recommendation H.248.72 [46] subclause 6) | h245tpspc, (0x00f7) | v1 | Multimedia calls with MONA | +| MONA preference package (see ITU-T Recommendation H.248.72 [46] subclause 7) | monapref, (0x00f8) | v1 | Multimedia calls with MONA | +| 3G Interface Type package (see subclause 15.2.11 of 3GPP TS 29.232 [5]) | threegint (0x00e3) | v1 | | +| RTCP Feedback Message package (see ITU-T Recommendation H.248.71 [49] subclause 8) | rtcpfb, (0x00f6) | v1 | Multimedia interworking between the H.245 messages in 3G-324M at the CS side and the corresponding RTCP messages used by MTSI terminals at the IMS side | +| Explicit Congestion Notification for RTP-over-UDP Support (see ITU-T Recommendation H.248.82 [66]) | ecnrous(0x010b) | v1 | Support of ECN feature | +| Diffserv (ITU-T Recommendation H.248.52 [64]) | ds, (0x008b) | v2 | Support of MPS | +| MG Act-as STUN Server (ITU-T Recommendation H.248.50 [67]) | mgastuns (0x00c2) | v1 | Support of incoming STUN connectivity checks. Applicable for ICE lite and full ICE | +| Originate STUN Continuity Check (see ITU-T Recommendation H.248.50 [67]) | ostuncc (0x00c3) | v1 | Support of originating STUN connectivity checks Only applicable for full ICE | +| Enhanced Revised Offer/Answer SDP Support ([ITU-T Recommendation H.248.80 [71]) | eroas, (0x0109) | v1 | Support of the SDP Capability Negotiation syntax | +| NOTE 1: support of RTP Package does not require support of Network Package. | | | | + +Table A.14/3: Package Provisioning Information + +| Package Name | Property, Parameter, Signal, Event ID | Provisioned Value: | +|--------------------------------------------------------------|---------------------------------------|--------------------| +| Generic Announcement (see ITU-T Recommendation H.248.7 [26]) | Fixed Announcement Play, AV | Provisioned | +| NOTE: This may not be required by TISPAN NGN R2 TMGW. | | | + +### A.14.1 Generic Package + +Table A.14.1/1: Package Usage Information For Generic Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|------------------------------------------|--------------------------------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| Cause (g/cause. 0x0001/0x0001) (NOTE) | M | ADD, MOD, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | Generalcause | M | "NR" Normal Release (0x0001)
"UR" Unavailable Resources (0x0002)
"FT" Failure, Temporary (0x0003)
"FP" Failure, Permanent (0x0004)
"IW" Interworking Error (0x0005)
"UN" Unsupported (0x0006) | Not Applicable | +| | Failure Cause (FailureCause, 0x0002) | O | Octet String | Not Applicable | +| Events | Mandatory/Optional | Used in command: | | | +| Signal Completion. (g/sc, 0x0001/0x0002) | M | ADD, MOD, MOVE, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | Signal Identity | M | pkgdName syntax | - | +| | Termination Method | M | "TO" (0x0001) Signal timed out or otherwise completed on its own
"EV" (0x0002) Interrupted by event
"SD" (0x0003) Halted by new Signals descriptor
"NC" (0x0004) Not completed, other cause | - | +| | Signal List Id | O | Integer | - | + +| Statistics | Mandatory/
Optional | Used in command: | Supported Values: | +|--------------------|----------------------------|------------------|-------------------| +| None | - | - | - | +| Error Codes | Mandatory/ Optional | | | +| - | - | | | + +NOTE: This event may also be used to report temporary errors in the MGW for both IMS, BICC and TDM connections where the termination is not out of service and thus sending a Service Change is inappropriate. On receipt of this event, the MGC is expected to release the connection in the MGW and force release the associated call. An example of such an error could be loss of RTP on an IMS termination. + +### A.14.2 Base Root Package + +Table A.14.2/1: Package Usage Information For Base Root Package + +| Properties | Mandatory/
Optional | Used in command: | Supported
Values: | Provisioned
Value: | | | +|---------------------------------------|-------------------------------------|--------------------------------|------------------------------------------------|--------------------------------------------|--|--| +| root/maxNumberOfContexts | O | AuditValue | 1 and up | Implementation on Specific | | | +| root/maxTerminationPerContext | O | AuditValue | See A.4 | Implementation on Specific | | | +| root/normalMGExecutionTime | O | MOD | Integer | Operator Defined | | | +| root/normalMGCExecutionTime | O | MOD | Integer | Operator Defined | | | +| root/MGProvisionalResponseTimerValue | O | MOD | Integer(NormalMGExecutionTime + networkdelay) | Operator Defined | | | +| root/MGCProvisionalResponseTimerValue | O | MOD | Integer(NormalMGCExecutionTime + networkdelay) | Operator Defined | | | +| root/MGCOriginatedPendingLimit | O | MOD | Integer | Operator Defined | | | +| root/MGOriginatedPendingLimit | O | MOD | Integer | Operator Defined | | | +| Signals | Mandatory/
Optional | Used in command: | | Duration
Provisioned
Value: | | | +| None | - | - | | - | | | +| | Signal
Parameters | Mandatory/
Optional | Supported
Values: | Duration
Provisioned
Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/
Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned
Value: | | | +| | - | - | - | - | | | +| | ObservedEvent
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned
Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/
Optional | Used in command: | | Supported
Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +NOTE : All transaction timers specified in H.248 shall be supported for 3GPP + +### A.14.3 Basic DTMF Generator Package + +Table A.14.3/1: Package Usage Information For Basic DTMF Generator Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-----------------------------------------------------------------------------------------------|--------------------------|--------------------|-------------------|-----------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| DTMF character 0
,d0 | M | ADD, MOD, MOVE | | | | | +| DTMF character 1
d1 | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| DTMF character 2
d2 | None | - | - | - | | | +| DTMF character 3
d3 | | | | | | | +| DTMF character 4
d4 | | | | | | | +| DTMF character 5
d5 | | | | | | | +| DTMF character 6
d6 | | | | | | | +| DTMF character 7
d7 | | | | | | | +| DTMF character 8
d8 | | | | | | | +| DTMF character 9
d9 | | | | | | | +| DTMF character *
ds | | | | | | | +| DTMF character #
do | | | | | | | +| DTMF character A
da | | | | | | | +| DTMF character B
db | | | | | | | +| DTMF character C
dc | | | | | | | +| DTMF character D
dd | | | | | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | +| NOTE: Only the DTMF Signal Ids shall be used, not the Tone Ids within the PlayTone Signal Id. | | | | | | | + +### A.14.4 Basic DTMF Detection Package + +Table A.14.4/1: Package Usage Information For Basic DTMF Generator Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|--------------------|-------------------|-----------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| d0, "0"
d1, "1"
d2, "2"
d3, "3"
d4, "4"
d5, "5"
d6, "6"
d7, "7"
d8, "8"
d9, "9"
ds, "*"
do, "#"
da, "A" or "a"
db, "B" or "b"
dc, "C" or "c"
dd, "D" or "d" | M | ADD, MOD, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | +| None | - | - | - | - | +| Error Codes | Mandatory/ Optional | | | | +| None | - | | | | + +### A.14.5 TDM Circuit Package + +Table A.14.5/1: Package Usage Information For TDM Circuit Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|----------------------------|--------------------------|--------------------|-------------------|-----------------------------| +| Echo Cancellation, tdmc/ec | M | ADD, MOD, MOVE | ALL | Default= Off (False) | +| Gain Control, tdmc/gc | Not Used | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| None | - | - | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | + +| Statistics | Mandatory/ Optional | Used in command: | Supported Values: | +|--------------------|----------------------------|------------------|-------------------| +| None | - | - | - | +| Error Codes | Mandatory/ Optional | | | +| None | - | | | + +### A.14.6 MGW Congestion Package + +Table A.14.6/1: Package Usage Information For Media Gateway Overload Control Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|----------------------------------|---------------------------------|----------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | - | - | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| MG Congestion, chp/mgcon(0x0001) | M/ | MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | Reduction (0x0001) | M | 0-100 | Not Applicable | | | +| Statistics | Mandatory/ Optional | Used in command: | Supported Values: | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.7 Continuity Package + +Table A.14.7.1: Package Usage Information For Basic Continuity Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | +|----------------------------|---------------------------------|----------------------------|--------------------------|------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | +| Continuity Test, ct/ct | M | ADD, MOD, MOVE | | Default | +| Respond, ct/rsp | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | +| | None | - | - | - | +| Events | Mandatory/ Optional | Used in command: | | | +| Completion, ct/cmp(0x0005) | M/ | ADD, MOD, MOVE, NOTIFY | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +| | result, res(0x0008) | M | success, failure | Not Applicable | + +| Statistics | Mandatory/ Optional | Used in command: | Supported Values: | +|--------------------|----------------------------|------------------|-------------------| +| None | - | - | - | +| Error Codes | Mandatory/ Optional | | | +| None | - | | | + +### A.14.8 Announcement Package + +Table A.14.8/1: Package Usage Information For Announcement Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|--------------------------------------|------------------------------------|----------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| Fixed Announcement Play, apf(0x0001) | M | ADD, MOD, MOVE | | | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | Announcement name, an(0x0001) | M | enumeration | | | | +| | Number Of Cycles, noc(0x0002) | M | Any Integer | - | | | +| | Announcement Variant, av(0x0003) | O | string | - | | | +| | Announcement Direction, di(0x0004) | M | Internal, External | - | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.9 Bearer Characteristics Package + +Table A.14.9/1: Package Usage Information For Bearer Characteristics Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | +|-----------------------------------------------|----------------------------|----------------------------|--------------------------|------------------------------------| +| BNC Characteristics (BCP/BNCChar,0x001e/0x01) | M | ADD | AAL type 2 / IP/RTP | Not Applicable | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | | - | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/ Optional | Used in command: | | | +| None | - | - | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | + +| | ObservedEvent
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | | | +|--------------------|--------------------------------|-------------------------|----------------------|--------------------------|--|--| +| | - | - | - | - | | | +| Statistics | Mandatory/
Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.10 Generic Bearer Connection Package + +Table A.14.10/1: Package Usage Information For Generic Bearer Connection Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|------------------------------------------|--------------------------------------|----------------------------|-----------------------------------------------------------------------------------------------------------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| Establish BNC
(GB/EstBNC,0x0021/0x01) | M | ADD, MOD | | Not Applicable | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | Not Applicable | - | - | Not Applicable | | | +| Modify BNC
(GB/ModBNC,0x0021/0x02) | O | MOD | | Not Applicable | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | Not Applicable | - | - | Not Applicable | | | +| Release BNC
(GB/RelBNC,0x0021/0x03) | M (NOTE 1) | MOD | | Not Applicable | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | General cause
(Generalcause,0x01) | O | Normal Release/
Unavailable Resources/
Failure Temporary/
Failure Permanent/
Interworking Error/
Unsupported | Not Applicable | | | +| | Failure Cause
(Failurecause,0x02) | O | OCTET STRING | Not Applicable | | | +| | Reset (Reset,0x03) | O | 0/ 1 | Not Applicable | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| BNC Change
(GB/BNCChange,0x0021/0x01) | M | ADD, MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | Type (Type ,0x01) | M | Bearer Established /
Bearer Modified/
Bearer Modification
Failure | Not Applicable | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | Type (Type,0x01) | M/ | Bearer Established /
Bearer Modified/
Bearer Modification
Failure | Not Applicable | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | | | | | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | | | | | | | + +NOTE 1: Mandatory for BICC ATM Terminations, not used otherwise + +### A.14.11 Call Progress Tones Generator Package v1 + +Table A.14.11/1: Package Usage Information For Call Progress Tones Generator Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|------------------------|---------------------------------|---------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| Ringing Tone, cg/rt | M | ADD, MOD, MOVE | | Not Applicable | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Busy Tone, cg/bt | O | ADD, MOD, MOVE | | Not Applicable | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Congestion Tone, cg/ct | O | ADD, MOD, MOVE | | Not Applicable | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +### A.14.12 Basic Call Progress Tones Generator with Directionality + +Table A.14.12/1: Package Usage Information For Basic Call Progress Tones Generator with Directionality Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|----------------------------------------------------|---------------------------|---------------------------|--------------------------|------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| Dial Tone (bcg/bdt, 0x0023/0x0040)
Ringing Tone | O | ADD, MOD, MOVE | | Value | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | + +| | | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|--------------------------------|------------------------------|---------------------------|--|--| +| (bcg/brt,0x0023/0x0041)
Busy Tone
(bcg/bbt,0x0023/0x0042)
Congestion Tone
(bcg/bct,0x0023/0x0043)
Special Information Tone
(bcg/bsit,0x0023/0x0044)
Warning Tone
(bcg/bwt,0x0023/0x0045)
Payphone Recognition Tone
(bcg/bpt,0x0023/0x0046)
Call Waiting Tone
(bcg/bcw,0x0023/0x0047)
Caller Waiting Tone
(bcg/bcr,0x0023/0x0048)
Pay Tone (bcg/bpy,0x0023/0x0049) | Tone Direction
(btd, 0x0001) | M | Internal / External | Default=External | | | +| Events | Mandatory/
Optional | Used in command: | | | | | +| None | - | - | - | - | | | +| | Event
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/
Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.13 Expanded Call Progress Tones Generator Package + +Table A.14.13/1: Package Usage Information For Expanded Call Progress Tones Generator Package + +| | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|--------------------------------|------------------------------|----------------------------------------| +| Properties | Mandatory/
Optional | Used in
command: | Supported
Values: | Provisioned Value: | +| None | - | - | - | - | +| Signals | Mandatory/
Optional | Used in command: | | Duration Provisioned
Value: | +| Comfort Tone
(xcg/cmft,0x0024/0x004a)
Off-hook warning Tone
(xcg/roh, 0x0024/0x004b)
Negative Acknowledgement
(xcg/nack,0x0024/0x004c)
Vacant Number Tone
(xcg/vac, 0x0024/0x004d)
Special Conditions Dial Tone
(xcg/spec,0x0024/0x004e) | O | ADD, MOD, MOVE | | Value | +| | Signal
Parameters | Mandatory/
Optional | Supported
Values: | Duration Provisioned
Value: | +| | Tone Direction
(btd, 0x0001) | M | Internal / External | Default=External | +| Events | Mandatory/
Optional | Used in command: | | | +| None | - | - | | | +| | Event
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | +| | - | - | - | - | +| | ObservedEvent
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | +| | - | - | - | - | + +| Statistics | Mandatory/Optional | Used in command: | Supported Values: | +|--------------------|----------------------------|------------------|-------------------| +| None | - | - | - | +| Error Codes | Mandatory/ Optional | | | +| None | - | | | + +### A.14.14 Basic Services Tones Generation Package + +Table A.14.14/1: Package Usage Information For Basic Services Tones Generation Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|---------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| Recall Dial Tone (srvtn/rdt,0x0025/0x004f)
Confirmation Tone (srvtn/conf,0x0025/0x0050)
Held Tone (srvtn/ht,0x0025/0x0051)
Message Waiting Tone (srvtn/mwt,0x0025/0x0052) | O | ADD, MOD, MOVE | | Value | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | Tone Direction (btd, 0x0001) | M | Internal / External | Default=External | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.15 Bearer Control Tunnelling Package + +Table A.14.15/1: Package Usage Information For Bearer Control Tunnelling Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|----------------------------------------------------|--------------------------------------|---------------------------|--------------------------|------------------------------------| +| Tunneling Options (BT/TunOpt, 0x0022/0x01) | M | ADD, MOD | 1 /2 | Not Applicable | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| Bearer Information Transport (BT/BIT, 0x0022/0x01) | M | ADD, MOD | | Not Applicable | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | Bearer Information Tunnel (BIT,0x01) | M | Octet String | Not Applicable | +| Events | Mandatory/Optional | Used in command: | | | +| Tunnel Indication (BT/TIND, 0x0022/0x01) | M | ADD, MOD, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | Not applicable | - | - | - | + +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +|--------------------|-----------------------------------------|-------------------------|-------------------|--------------------------|--|--| +| | Bearer Information transport (BIT,0x01) | M | Octet String | Not Applicable | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.16 Expanded Services Tones Generation Package + +Table A.14.16/1: Package Usage Information For Expanded Services Tones Generation Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|----------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| Call Transfer Dial Tone (xsrvt/xferdt,0x0026/0x0053)
Call Forward Tone (xsrvt/cft,0x0026/0x0054)
Credit Card service Tone (xsrvt/ccst,0x0026/0x0055)
Special Recall Dial Tone (xsrvt/srdt,0x0026/0x0056) | O | ADD, MOD, MOVE | | Value | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | Tone Direction (btd, 0x0001) | M | Internal / External | Default=External | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.17 Intrusion Tones Generation Package + +Table A.14.17/1: Package Usage Information For Intrusion Tones Generation Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | +|-------------------------------------------------------------------|----------------------------|----------------------------|--------------------------|------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | +| Intrusion Pending Tone (int/pend,0x0027/0x0057)
Intrusion Tone | O | ADD, MOD, MOVE | | Value | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | + +| | | | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|--------------------------------|------------------------------|---------------------------|--|--| +| (int/int,0x0027/0x0058)
Intrusion Reminder Tone
(int/rem,0x0027/0x0059)
Toll Break-In Tone
(int/tbi,0x0027/0x005a)
Intrusion Queue Tone
(int/intque,0x0027/0x005b)
Busy Verification Tone
(int/bv,0x0027/0x005c) | Tone Direction
(btd, 0x0001) | M | Internal / External | Default=External | | | +| Events | Mandatory/
Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/
Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/
Optional | | | | | | +| None | - | | | | | | + +#### A.14.183GUP Package + +Table A.14.18/1: Package Usage Information For 3GUP Package + +| Properties | Mandatory/
Optional | Used in command: | Supported Values: | Provisioned Value: | +|--------------------------------------------------------------------|--------------------------------|--------------------------------|------------------------------|------------------------------------| +| UP Mode of operation
(threegup/mode, 0x002f/0x0001) | M | ADD, MOD, MOVE | See 3GPP TS 29.232 | See 3GPP TS 29.232 | +| UP versions
(threegup/upversions, 0x002f/0x0002) | M | ADD, MOD, MOVE | See 3GPP TS 29.232 | See 3GPP TS 29.232 | +| Delivery of erroneous SDUs
(threegup/delerrsdus, 0x002f/0x0003) | M | ADD, MOD, MOVE | See 3GPP TS 29.232 | See 3GPP TS 29.232 | +| Interface
(threegup/interface, 0x002f/0x0004) | M | ADD, MOD, MOVE | See 3GPP TS 29.232 | See 3GPP TS 29.232 | +| Initialisation Direction
(threegup/initdir, 0x002f/0x0005) | M | ADD, MOD, MOVE | See 3GPP TS 29.232 | See 3GPP TS 29.232 | +| Signals | Mandatory/
Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | | - | +| | Signal Parameters | Mandatory/
Optional | Supported
Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/
Optional | Used in command: | | | +| None | - | - | | | +| | Event
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | +| | - | - | - | - | + +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +|--------------------|--------------------------|---------------------|-------------------|--------------------| +| | - | - | - | - | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | +| None | - | - | - | - | +| Error Codes | Mandatory/ Optional | | | | +| None | - | | | | + +### A.14.19 Modification of Link Characteristics Bearer Capability + +Table A.14.19/1: Package Usage Information For Modification of Link Characteristics Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | +|------------------------------------------------------------------------------|--------------------------|---------------------|-------------------|-----------------------------| +| None | - | - | - | - | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/ Optional | Used in command: | | | +| Bearer Modification Support Event.( threegmlc/ mod_link_supp, 0x0046/0x0001) | M | ADD, MOD, NOTIFY | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | +| None | - | - | - | - | +| Error Codes | Mandatory/ Optional | | | | +| None | - | | | | + +### A.14.20 Hanging Termination Detection Package + +Table A.14.20/1: Package Usage Information For Hanging Termination Detection Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | +|-----------------------|--------------------------|------------------------------------|-------------------|-----------------------------| +| None | - | - | - | - | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/ Optional | Used in command: | | | +| Termination Heartbeat | M | ADD, MOD, MOVE, AUDITVALUE, NOTIFY | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +| | Timer X | M | ALL | 0 (no heartbeat message) | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | + +| Statistics | Mandatory/Optional | Used in command: | Supported Values: | +|--------------------|----------------------------|------------------|-------------------| +| None | | | | +| Error Codes | Mandatory/ Optional | | | +| | | | | + +### A.14.21 TFO package + +Table A.14.21/1: Package Usage Information For TFO + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|--------------------------------------------------------------------|---------------------------------|---------------------------|--------------------------|------------------------------------|--|--| +| TFO Activity Control (threegtfc / tfoenable, (0x0031/0x0001)) | M | ADD, MOD, MOVE | See 3GPP TS 29.232 | See 3GPP TS 29.232 | | | +| TFO Codec List (threegtfc / codeclist, (0x0031/0x0002)) | M | ADD, MOD, MOVE | See 3GPP TS 29.232 | See 3GPP TS 29.232 | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | | | | | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | | | | | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| Optimal Codec Event (threegtfc / codec_modify, (0x0031/0x0010)) | O | ADD, MOD, MOVE, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | None | | | | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| Codec List Event (threegtfc / distant_codec_list, (0x0031/0x0012)) | O | ADD, MOD, MOVE, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | None | | | | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| TFO Status Event (threegtfc / TFO_status) (0x0031/0x0014) | O | ADD, MOD, MOVE, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | None | | | | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| Statistics | Mandatory/Optional | Used in command: | Supported Values: | | | | +| None | | | | | | | +| Error Codes | Mandatory/ Optional | | | | | | +| | | | | | | | + +### A.14.22 Media Gateway Overload Control Package + +Table A.14.22/1: Media Gateway Overload Control Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|--------------------------------|---------------------------------|---------------------------|--------------------------|------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| MG_Overload
ocp/mg_overload | M | MOD, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | +| None | - | - | - | - | +| Error Codes | Mandatory/Optional | | | | +| None | - | | | | + +### A.14.23 Inactivity Timer Package + +Table A.14.23/1: Inactivity Timer Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|-------------------------------|---------------------------------|---------------------------|--------------------------|-------------------------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| Inactivity Timeout,
it/ito | M | MOD, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | Maximum Inactivity Time,
mit | M | Any integer | Unspecified, if not sent a value must be provisioned. | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | +| None | - | - | - | - | +| Error Codes | Mandatory/Optional | | | | +| None | - | | | | + +### A.14.24 MGC Information Package + +Table A.14.24/1: MGC Information Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|------------------------|--------------------------|----------------------|---------------------------|-----------------------------|--|--| +| Data Block, MGCInfo/db | M | ADD, MOD, AUDITVALUE | A range of 0 to 32 octets | An empty string | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | - | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | - | - | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| Statistics | Mandatory/Optional | Used in command: | Supported Values: | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +### A.14.25 RTP Package + +Table A.14.25/1: RTP Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|---------------------------------|--------------------------|--------------------|-----------------------|-----------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| Payload Transition, rtp/pltrans | - | NA | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | rtppayload, rtpptype | - | A valid encoding name | - | + +| Statistics | Mandatory/Optional | Used in command: | Supported Values: | +|--------------------------|---------------------|------------------|-------------------| +| Packets Sent, rtp/ps | M | SUBTRACT REPLY | ALL | +| Packets Received, rtp/pr | M | SUBTRACT REPLY | ALL | +| Packet Loss, rtp/pl | M | SUBTRACT REPLY | ALL | +| Jitter, rtp/jit | M | SUBTRACT REPLY | ALL | +| Delay, rtp/delay | M | SUBTRACT REPLY | ALL | +| Error Codes | Mandatory/ Optional | | | +| None | - | | | + +### A.14.26 Tone Generator Package + +Table A.14.26/1: Package Usage Information For Tone Generator Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-----------------------------------------|--------------------------|--------------------|-------------------|-----------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| Play Tone
(tonegen/pt,0x0003/0x0001) | Not Used | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.27 Tone Detection Package + +Table C.14.27/1: Package Usage Information For Tone Detection Package + +| Properties | Mandatory/
Optional | Used in command: | Supported Values: | Provisioned Value: | +|--------------------------------------------------|---------------------------------|------------------------|-------------------|-----------------------------| +| None | - | - | - | - | +| Signals | Mandatory/
Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/
Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/
Optional | Used in command: | | | +| Start tone detected (tonedet/std, 0x0004/0x0001) | O | ADD, MOD, MOVE, NOTIFY | | | +| | Event Parameters | Mandatory/
Optional | Supported Values: | Provisioned Value: | +| | Tone ID List (tl, 0x0001) | M | wildcard | Not Applicable | +| | ObservedEvent Parameters | Mandatory/
Optional | Supported Values: | Provisioned Value: | +| | Tone ID (tid, 0x0003) | M | Value | Not Applicable | +| Events | Mandatory/
Optional | Used in command: | | | +| End Tone detected (tonedet/etd, 0x0004/0x0002) | M | ADD, MOD, MOVE, NOTIFY | | | +| | Event Parameters | Mandatory/
Optional | Supported Values: | Provisioned Value: | +| | Tone ID List (tl, 0x0001) | M | wildcard | Not Applicable | +| | ObservedEvent Parameters | Mandatory/
Optional | Supported Values: | Provisioned Value: | +| | Tone ID (tid, 0x0003) | M | Value | Not Applicable | +| | Duration (dur, 0x0002) | O | Value | Not Applicable | +| Events | Mandatory/
Optional | Used in command: | | | +| Long Tone detected (tonedet/ltd, 0x0004/0x0003) | Not Used | - | | | +| | Event Parameters | Mandatory/
Optional | Supported Values: | Provisioned Value: | + +| | | | | | | | +|--------------------|-------------------------------------|--------------------------------|------------------------------|---------------------------|--|--| +| | - | - | - | - | | | +| | ObservedEvent
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/
Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.28 H324 Package + +Table A.14.28/1: Package Usage Information For H324 Package + +| Properties | Mandatory/
Optional | Used in
command: | Supported
Values: | Provisioned Value: | | | +|-------------------------------------------------------------|-------------------------------------|--------------------------------|------------------------------|----------------------------------------|--|--| +| Communication mode
(h324/cmod,0x002c/0x0001) | Not used | - | - | - | | | +| Highest Multiplexing Level
(h324/muxlv,0x002c/0x0002) | Not Used | - | - | Based on capability
of IM-MGW | | | +| Demultiplex
(h324/demux,0x002c/0x0003) | Not used | - | - | - | | | +| Remote H.223 capability
(h324/h223capr,0x002c/0x0004) | M | MOD | OCTET STRING | Not Applicable | | | +| Incoming Multiplex Table
(h324/muxtbl_in,0x002c/0x0005) | M | MOD | OCTET STRING | Not Applicable | | | +| Outgoing Multiplex Table
(h324/muxtbl_out,0x002c/0x0006) | M | MOD | OCTET STRING | Not Applicable | | | +| Signals | Mandatory/
Optional | Used in command: | | Duration
Provisioned Value: | | | +| None | - | - | | - | | | +| | Signal
Parameters | Mandatory/
Optional | Supported
Values: | Duration
Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/
Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/
Optional | Used in command: | | Supported Values: | | | +| MUXPDU sent
(h324/muxsent,0x002c/0x0001) | Not used | - | | - | | | +| MUXPDU received
(h324/muxrec,0x002c/0x0002) | Not used | - | | - | | | +| MUXPDU error
(h324/muxerr,0x002c/0x0003) | Not used | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.29 H.245 Transport Package + +Table A.14.29/1: Package Usage Information For H.245 Transport Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-----------------------------------------------------------|--------------------------------------------|---------------------|-------------------|-----------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| Outgoing H.245 Message (h245tp/h245msgout, 0x00b4/0x0001) | M | MOD | | - | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | Contents of H.245 message (h245mc, 0x0001) | M | OCTET STRING | - | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| Incoming H.245 message (h245tp/h245msgin, 0x00b4/0x0001) | M | ADD, NOTIFY | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | Contents of H.245 message (h245mc, 0x0001) | M | OCTET STRING | Not Applicable | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.30 IP domain connection + +Table C.14.30: Package usage information for IP domain connection package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | +|---------------------------------------------------|---------------------|------------------|-------------------|-----------------------------| +| IP Realm Identifier (ipdc /realm, 0x009d /0x0001) | M | ADD | String | Operator Defined (NOTE1) | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | | - | + +| | Signal Parameters | Mandatory/
Optional | Supported Values: | Duration
Provisioned Value: | | | +|--------------------|-----------------------------|------------------------|----------------------|--------------------------------|--|--| +| | - | - | - | - | | | +| Events | Mandatory/
Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/
Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +NOTE1: A default IP realm may be configured such that if the MGW has not received the IP realm identifier and the MGW supports multiple IP realms then the default IP realm shall be used. + +### A.14.31 H.245 Transport Package for SPC use + +Table A.14.31/1: Package Usage Information For H.245 Transport Package for SPC use + +| Properties | Mandatory/
Optional | Used in
command: | Supported
Values: | Provisioned Value: | +|----------------|---------------------------------------------------------|------------------------|----------------------|--------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/
Optional | Used in command: | | Duration Provisioned
Value: | +| None (NOTE 1) | M | MOD | | - | +| | Signal
Parameters | Mandatory/
Optional | Supported
Values: | Duration
Provisioned Value: | +| | Signalling
Preconfigured
Channel (spc,
0x0002) | O | ON
OFF | OFF | +| | Repetition (rep,
0x0003) | O | ON
OFF | ON | +| Events | Mandatory/
Optional | Used in command: | | | + +| | | | | | | | +|--------------------|------------------------------------------------|--------------------------------|------------------------------|---------------------------|--|--| +| None (NOTE 2) | M | ADD, NOTIFY | | | | | +| | Event
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | | | +| | Signalling Preconfigured Channel (spc, 0x0001) | O | H245, SPC, Both | H245 | | | +| | ObservedEvent
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | | | +| | Signalling Preconfigured Channel (spc, 0x0002) | O | ON
OFF | OFF | | | +| Statistics | Mandatory/
Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +NOTE 1: The package does not define any new signal. The defined signal parameter can be used in the Outgoing H.245 Message signal (h245tpspc/h245msgout, 0x00f7/0x0001) defined in the base package (H.245 Transport package). + +NOTE 2: The package does not define any new event. The defined event and observed event parameters can be used in the Incoming H.245 Message event (h245tpspc/h245msgin, 0x00f7/0x0001) defined in the base package (H.245 Transport package). + +### A.14.32 MONA preference package + +Table A.14.32/1: Package Usage Information for MONA preference Package + +| Properties | Mandatory/
Optional | Used in
command: | Supported
Values: | Provisioned Value: | +|---------------------------------------------------------------------------------|--------------------------------|--------------------------------|------------------------------|----------------------------------------| +| MONA Class (monapref/class, 0x00f8/0x0001) | Not used | - | - | - | +| Supported Media Preconfigured Channels Receive (monapref/mpcrx, 0x00f8/0x0002) | Not used | - | - | - | +| Supported Media Preconfigured Channels Transmit (monapref/mpctx, 0x00f8/0x0003) | Not used | - | - | - | +| Signals | Mandatory/
Optional | Used in command: | | Duration
Provisioned Value: | +| Outgoing MONA preference message (monapref/monaprefmsgout, 0x00f8/0x0001) | M | MOD | | - | +| | Signal
Parameters | Mandatory/
Optional | Supported
Values: | Duration
Provisioned Value: | + +| | | | | | +|--------------------------------------------------------------------------------------|-------------------------------------------------------|---------------------------|--------------------------|------------------------------------| +| | Contents of MONA preference message (prefmsgc,0x0001) | M | OCTET STRING | - | +| Forward Media in Preconfigured Channel (monapref/Preconfchannelmedia, 0x00f8/0x0002) | O | MOD | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | Mux Code (muxcode,0x0003) | M | sub-list of OCTET STRING | - | +| Events | Mandatory/Optional | Used in command: | | | +| MONA Preference reception (monapref/monaprefmsgin, 0x00f8/0x0001) | M | ADD, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | Contents of MONA preference message (prefmsgc,0x0001) | M | OCTET STRING | Not Applicable | +| MONA Preference negotiation completed (monapref/monaprefcompl, 0x00f8/0x0002) | M | ADD, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| Legacy Detected (monapref/legdet, 0x00f8/0x0003) | M | ADD, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| MPC reception (monapref/mpcrec, 0x00f8/0x0004) | O | ADD, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | + +| | | | | | | | +|--------------------|--------------------------------|-------------------------|--------------|--------------------------|--|--| +| | Mux Code
(muxcode,0x0001) | M | OCTET STRING | Not Applicable | | | +| Statistics | Mandatory/
Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.33 G Interface Type package + +Table A.14.31/1: Package Usage Information For 3G Interface Type + +| Properties | Mandatory/
Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-------------------------------------------------------------|-------------------------------------|--------------------------------|--------------------------------------|----------------------------------------|--|--| +| IP Interface Type
(threegint /ipint,
(0x00e3/0x0001)) | M | ADD, MOD | "NboIP" (0x0001)
"MboIP" (0x0003) | None | | | +| Signals | Mandatory/
Optional | Used in command: | | Duration Provisioned
Value: | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/
Optional | Supported
Values: | Duration Provisioned
Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/
Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/
Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.34 RTCP Feedback Message package + +Table A.14.34/1: Package Usage Information for RTCP Feedback Message package + +| Properties | Mandatory/
Optional | Used in
command: | Supported
Values: | Provisioned Value: | +|----------------------------------------------------------------------|---------------------------------|--------------------------------|------------------------------|----------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/
Optional | Used in command: | | Duration Provisioned
Value: | +| Feedback Message
Sending
(rtcpfb/fbmesssend,
0x00f6/0x0001) | M | MOD | | - | +| | Signal
Parameters | Mandatory/
Optional | Supported
Values: | Duration
Provisioned Value: | +| | Update Picture
(upic,0x0001) | O | Enumeration | - | +| | Max Bitrate
(mbr,0x0002) | O | Unsigned Integer | - | + +| Events | Mandatory/
Optional | Used in command: | | | | | +|-------------------------------------------------------------|-------------------------------------|--------------------------------|------------------------------|---------------------------|--|--| +| RTCP Feedback Message Detection (rtcpfb/det, 0x00f6/0x0001) | M | MOD, NOTIFY | | | | | +| | Event
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | | | +| | Feedback Message Type (type,0x0001) | M | Sub-list of String | - | | | +| | ObservedEvent
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | | | +| | Update Picture (upic,0x0001) | O | Enumeration | - | | | +| | Max Bitrate (mbr,0x0002) | O | Unsigned Integer | - | | | +| Statistics | Mandatory/
Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.35 Explicit Congestion Notification for RTP-over-UDP Support (ecnrous) + +Table A.14.35.1: Explicit Congestion Notification for RTP-over-UDP Support package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|----------------------------------------------------------------|----------------------------------|---------------------|------------------|---------------------------------------------------------------------------------------------| +| ECN Enabled (ecnrous/ecnen, 0x010b/0x0001) | M | ADD, MODIFY | True, False | - | +| Congestion Response Method (ecnrous/crm, 0x010b/0x0002) | Not Signalled | - | - | "RDCC"(0x0002)
NOTE | +| Initiation Method (ecnrous/initmethod, 0x010b/0x0003) | M | ADD, MODIFY | "leap" | "leap" | +| ECN Mode (ecnrous/mode, 0x010b/0x0004) | Not Signalled | - | - | "setonly" (0x0001) in the Remote Descriptor and "readonly" (0x0002) in the Local Descriptor | +| ECT Marking (ecnrous/ectmark, 0x010b/0x0005) | Not Signalled | - | - | "0" (0x0002) | +| ECN Congestion Marking (ecnrous/congestmark, 0x010b/0x0006) | Not Signalled | - | - | "nomark" (0x0003) | +| ECN SDP Usage (ecnrous/ecnsdp, 0x010b/0x0007) | Not Signalled | - | - | "P" (0x0001) | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| ECN Failure (ecnrous/fail, 0x010b/0x0001) | M | ADD, MODIFY, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | Failure Type (type, 0x0001) | Mandatory | INIT, USE | - | +| | Media Sender SSRC (ssrc, 0x0002) | Not Supported | - | - | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | +| Source (ecnrous/ssrc, 0x010b/0x0001) | Not Supported | - | | - | +| CE Counter (ecnrous/cecount, 0x010b/0x0002) | Not Supported | - | | - | +| ECT0 Counter (ecnrous/ectzero, 0x010b/0x0003) | Not Supported | - | | - | +| ECT1 Counter (ecnrous/ectone, 0x010b/0x0004) | Not Supported | - | | - | +| Not-ECT Counter (ecnrous/notect, 0x010b/0x0005) | Not Supported | - | | - | +| Lost Packets Counter (ecnrous/lost, 0x010b/0x0006) | Not Supported | - | | - | +| Extended Highest Sequence number (ecnrous/ehsn, 0x010b/0x0007) | Not Supported | - | | - | +| Duplication Counter (ecnrous/dup, 0x010b/0x0008) | Not Supported | - | | - | +| Error Codes | Mandatory/Optional | | | | + +| | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------|---| +| None | - | +| NOTE: Application Specific Rate Adaptation shall be applied in accordance with 3GPP TS 26.114 [62]. For speech this requires support of CMR and TMMBR for video. | | + +### A.14.36 Differentiated Services (ds) + +Table A.14.36.1: Differentiated Services package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|-------------------------------------------------------------|--------------------------|--------------------|------------------|----------------------------| +| Differentiated Services Code Point (ds/dscp, 0x008b/0x0001) | M | ADD, MODIFY | ALL | Yes | +| Tagging Behaviour (ds/tb, 0x008b/0x0002) | Not signalled | - | - | "MARK" (0x0000) | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| None | - | - | - | - | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | +| None | - | - | - | - | +| Error Codes | Mandatory/Optional | | | | +| None | - | | | | + +### A.14.37 MG Act-as STUN Server (mgastuns) + +Table A.14.3.37.1: MG Act-as STUN Server + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|--------------------------------------------------------|--------------------------|--------------------|------------------|----------------------------|--|--| +| Act-as STUN Server
(mgastuns/astuns, 0x00c2/0x0001) | M | ADD, MODIFY | ALL | - | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | - | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | - | - | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +### A.14.38 Originate STUN Continuity Check (ostuncc) + +Table A.14.3.38.1: Originate STUN Continuity Check Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|------------------------------------------------------------------|----------------------------------------|---------------------------|-----------------------------|-----------------------------------|--|--| +| Host Candidate Realm (ostuncc/hcr, 0x00c3/0x0001) | O | ADD, MODIFY | ALL | Yes | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| Send Connectivity Check (ostuncc/scc, 0x00c3/0x0001) | M | ADD, MODIFY | | Not Applicable | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | Control (cntrl, 0x0001) | O | "controlling", "controlled" | Not Applicable | | | +| Send Additional Connectivity Check (ostuncc/sacc, 0x00c3/0x0002) | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| | M | MODIFY | | Not Applicable | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | Control (cntrl, 0x0001) | O | "controlling", "controlled" | Not Applicable | | | +| Events | Mandatory/Optional | Used in command | | | | | +| Connectivity Check Result (ostuncc/ccr, 0x00c3/0x0001) | M | ADD, MODIFY, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Candidate/Transport Pair (ctp, 0x0001) | M | ALL | Not applicable | | | +| New Peer Reflexive Candidate (ostuncc/nprc, 0x00c3/0x0002) | Mandatory/Optional | Used in command | | | | | +| | M | ADD, MODIFY, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Candidate (can, 0x0001) | M | ALL | Not applicable | | | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +### A.14.39 Enhanced Revised Offer/Answer SDP Support (eroas) + +Table A.14.39/1: Enhanced Revised Offer/Answer SDP Support package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|--------------------------------------------------------|-------------------------------------|---------------------------|-------------------------|---------------------------------------|--|--| +| SDPCapNeg Extensions
(eroas/sdpe,
0x0109/0x0001) | M | AuditValue | "cap-v0" | "cap-v0" | | | +| Signals | Mandatory/Optional | Used in command | | Duration
Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration
Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent
Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +## A.15 Mandatory support of SDP and H.248 Annex C information elements + +Table A.15/1: Supported Annex C and SDP information elements + +| Information Element | Annex C Support | SDP Support | +|---------------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| v-line | "SDP_V " | The value must always be equal to zero:
v=0. | +| m-line | "SDP_M " | and are required. Both static and dynamic payload types shall be supported.
The MGC may underspecify the subfield in place of a single dynamic payload type. In this case the mapping between the underspecified payload type and the / shall be provided in the rtpmap attribute.
For see table 5.15/2. | +| c-line | "SDP_C " | and are required
The network type shall be set to "IN".
The address type may be IPv4 or IPv6. The MGC may apply parameter underspecification to the
subfield. (NOTE 2) | + +| | | | +|--------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| a-line | "SDP_A " |

For a dynamic RTP payload type, for each codec information on the codec type shall be provided in a separate SDP "a=rtpmap "-line and possibly additional SDP "a=fmtp "-line(s). See Clause 10.2.

For AVPF transport, the "rtcp-fb" SDP attribute defined in IETF RFC 4585 [60] may be used to provide the feedback message types the MG is allowed to send and to indicate RTCP timing information. (NOTE 3)

For T.38, additional SDP attributes listed in subclause 10.2.3.6 may be provided.

ICE support

The attributes "a=candidate", "a=ice-pwd", "a=ice-ufrag" and "a=ice-pacing" (see IETF RFC 8839 [73]) may be provided for an SDP m-line in the local and remote descriptor if the IM-MGW supports ICE, see also 3GPP TS 24.229 [69]. In the local descriptor, the MGC shall provide "a=ice-pwd", and "a=ice-ufrag" with wildcard sign "\$" to request the allocation of a password and user name fragment, and the "a=candidate" of type "host" with the transport, port and priority parameters with wildcard sign "\$" to request the allocation of a host candidate, and "a=ice-pacing" with wildcard sign "\$" to request the desired pacing value for connectivity checks. The IM-MGW shall then reply with completed "a=ice-pwd", and "a=ice-ufrag", "a=candidate" attributes and "a=ice-pacing" in the local descriptor, and shall include "a=ice-lite" if it only supports ICE lite. In the remote descriptor, the MGC may provide the "a=candidate", "a=ice-pwd", "a=ice-ufrag" and "a=ice-pacing".

Rate adaptation for media endpoints:

If the IM-MGW performs media transcoding and if the rate adaptation for media endpoints using the enhanced bandwidth negotiation is supported by the IM-MGW, attribute(s) "a=bw-info" with direction "send" or "sendrecv" may be provided for an m-line and the selected IP payload type and applicable IP version in the remote descriptor.

The following bandwidth properties, as defined in 3GPP TS 26.114 [62], clause 19, may be included in "a=bw-info" line: <payload type> <dir> <MaxSupBw>, <MaxDesBw>, <MinDesBw>, <MinSupBw> and <IpVer>.

SDP Capability Negotiation:

The attributes of "a=acap", "a=tcap", "a=pcfg" and "a=acfg" (see IETF RFC 5939 [70]) may be provided in the local descriptor and/or remote descriptor.

Handling of RTCP APP messages when transcoding between EVS and non EVS codecs, or between IVAS and non IVAS codecs, if transcoding to/from EVS or IVAS is supported by the IM-MGW:

The attribute "a=3gpp_mtsi_app_adapt" (see 3GPP TS 26.114 [62]) containing the allowed RTCP APP message types shall be provided when the IM-MGW is allowed to send RTCP APP messages.

| +| b-line | "SDP_B " |

(NOTE1).

B:RS and b:RR bandwidth modifiers required

Bandwidth information shall be supplied by the MGC if the required bandwidth cannot be immediately derived from the information contained in the m= line. If the MGC is using parameter underspecification, the MG shall assume a reasonable default bandwidth value for well-known codecs and shall provide this value in the response sent to the MGC. The Modifier field shall be set to "AS". The Bandwidth Value field shall be set to the maximum bandwidth requirement of the media stream in kbit/s and shall take into account all headers down to the IP layer.

The MGC may also supply additional RTCP bandwidth modifiers (i.e. RR and RS, see IETF RFC 3556 [39]). If the RTCP modifiers are not supplied, the bandwidth value for the AS modifier shall take into account an extra 5% bandwidth for RTCP packets.

| + +| | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| o-line | "SDP_O" |

The origin line consists of 6 fields:
o= <user name> <session ID> <version> <network type> <address type> <address>.

The MGC is not required to supply this line but shall accept it.

The MG shall return the value received from the MGC or if there is no o-line sent by the MGC, the MG shall populate this line as follows:

  • - <user name> should contain an hyphen
  • - <session ID> and <version> should contain one or more digits as described in RFC 4566 [17]
  • - <network type> shall be set to IN
  • - <address type> shall be set to IP4 or IP6 The Address Type shall be set to "IP4" or "IP6" depending on the addressing scheme used by the network to which the MG is connected.
  • - <address> should contain the fully qualified domain name or IP address of the gateway.
| +| s-line | "SDP_S" |

The session name (s=) line contains a single field:
s= <session-name>.

The MGC is not required to supply a session name but shall accept one. This line may be used to convey correlation information for use in CDRs.

The MG shall return the value received from the MGC or if there is no s-line sent by the MGC, the MG shall populate this line as follows:
- "s="

| +| t-line | "SDP_T" |

The time (t=) line consists of two fields:
t= <start-time> <stop-time>.

The MGC is not required to supply a time description but shall accept one.

The MG shall return the value received from the MGC or if there is no t-line sent by the MGC, the MG shall populate this line as follows:
- "t=0 0"

| +| NOTE a: SDP or SDP_equivalents are only used for terminations towards the IM CN Subsystem.
NOTE b: For BICC terminations, mandatory support of SDP and Annex C information elements shall be in accordance with the subclause "Mandatory Support of SDP and H.248.1 annex C information elements" in ITU-T Recommendation Q.1950 [14]. For IP the IANA ICP IDI format of the NSAP addressing format as specified in X.213 [33] shall be used. For IPv4 networks the IPv4 format recommended by X.213 shall be adopted.
The BIR length shall be fixed at 4 Octets and the NSAP length shall be fixed at 20 Octets..
NOTE 1: b-line is optional in TISPAN NGN R2.
NOTE 2: The address type may be IPv4 or IPv6. The default IP version (i.e. IPv4 or IPv6) may be provisioned in the H.248 MG. The MGC may apply H.248 parameter underspecification. If the MGC does require a different IP version than the provisioned default, then the MGC applies complete H.248 parameter specification.
NOTE3: Support is optional and dependent on RTCP-fb support as described in 3GPP TS 26.114 [62]. The list of feedback types supported by the MG is preconfigured in the MGC. The "rtcp-fb" SDP attribute shall be sent from MGC when applicable. | | | + +Table A.15/2: Transport Protocol + +| | | +|-----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| Transport Protocol <proto> in m-line: | If the MG does not support the requested transport protocol, it shall reject the command with error code 449. | +| TCP | (NOTE 1, NOTE 2) | +| RTP/AVP | RTP profile according IETF RFC 3551 [33]. | +| RTP/AVPF | Extended RTP profile for RTCP-based Feedback (RTP/AVPF) according IETF RFC 4585 [60]. (NOTE 1). | +| udptl | (NOTE 1) | +| NOTE 1: support optional. | | +| NOTE 2: Upper case TCP is defined by IETF RFC 4145 [59] and registered by IANA. . | | + +## A.16 Optional support of SDP and H.248 Annex C information elements + +**Table A.16/1: Optional Supported Annex C and SDP information elements** + +| Information Element | Annex C Support | SDP Support | +|---------------------|-----------------|-------------| +| | | | + +## A.17 Procedures + +### A.17.1 Call Independent Procedures + +Table A.17.1/1 shows the relationship between each non call-related procedure in 3GPP TS 29.232 [5] and the corresponding procedure defined in 3GPP TS 29.163 [4]. + +For further description of error codes and service change reasons, refer to ITU-T Recommendation H.248.8 [10]. + +**Table A.17.1/1: Non call-related transaction reused from 3GPP TS 29.232 [5]** + +| Procedure defined in 3GPP TS 29.163 [4] | Procedure defined in 3GPP TS 29.232 [5] | Support | Comment | +|--------------------------------------------------|-----------------------------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IM-MGW Out of service | MGW Out of Service | Mandatory | | +| IM-MGW Communication Up | MGW Communication Up | Mandatory | | +| IM-MGW Restoration | MGW Restoration | Mandatory | | +| IM-MGW Register | MGW Register | Mandatory | | +| IM-MGW Re-register | MGW Re-register | Mandatory | | +| MGCF Ordered Re-register | (G)MSC Server Ordered Re-register | Mandatory | | +| MGCF Restoration | (G)MSC Server Restoration | Optional | | +| MGCF Out of Service | (G)MSC Server Out of Service | Optional | | +| Termination Out-of-Service | Termination Out-of-Service | Mandatory | | +| Termination Restoration | Termination Restoration | Mandatory | | +| Audit Value | Audit Value | Mandatory | Mandatory support only for audit of Termination Service State and for periodic audit of MGW (empty Audit descriptor).

Optional support for audit of Packages or to retrieve MGC Information. | +| Audit Capability | Audit Capability | Optional | | +| Command Rejected | Command Rejected | Mandatory | The "Command Rejected" procedure may be used in response both to call-related and non-call-related ITU-T Recommendation H.248 Commands | +| IM-MGW Capability Change | Capability Update | Optional | | +| IM-MGW Resource Congestion Handling - Activate | MGW Resource Congestion Handling - Activate | Mandatory | | +| IM-MGW Resource Congestion Handling - Indication | MGW Resource Congestion Handling - Indication | Mandatory | | +| Inactivity Timeout - Activate | Inactivity Timeout - Activate | Optional | | +| Inactivity Timeout - Indication | Inactivity Timeout - Indication | Optional | | + +#### A.17.1.2 Profile registration + +The following description is based on H.248.1 profile registration procedure with some clarifications. The reply to the ServiceChange Request containing the SCP parameter indicates if the MGCF supports the requested profile or if it does not support it and wants to propose an alternative profile. The profile (name and version) is only returned in the reply if the MGCF cannot support the specified profile in the ServiceChangeRequest. The returned reply shall indicate the profile and version supported. Upon reception of a profile in the reply, if the IM-MGW supports the indicated profile, it shall issue a new ServiceChange Request with the agreed profile to explicitly confirm the acceptance of the profile to the MGCF ; otherwise, if the IM-MGW does not support the indicated profile, it may continue the registration or re-registration procedure by issuing a new ServiceChange Request with an alternative profile ; until such procedure is successfully completed the IM-MGW shall remain out of service. If the profile is not returned the MGCF shall use the capabilities specified by the Profile indicated in the service change request. + +NOTE: It should be observed that the profile registration is not a "cold calling" negotiation; it is expected that the operator will have configured the network to support certain profiles and so the profile registration within the Mn interface permits network upgrade scenarios but otherwise is simply a means to confirm the connection of the profile to be used over the Mn interface between MGCF and IM-MGW. + +### A.17.2 IMS Terminations Procedures + +#### A.17.2.1 Summary of Procedures related to a termination towards IM CN Subsystem + +Table 1 shows the relationship between each call-related procedure in ITU-T Recommendation Q.1950 [14] (see 3GPP TS 29.205 [3]) or TS 29.232 [5] and the corresponding stage 2 procedure defined in 3GPP TS 29.163 [4]. + +**Table A.17.2.1/1: Correspondence between ITU-T Recommendation Q.1950 [14] or 29.232 [5] call-related transactions and 3GPP TS 29.163 [4] procedures** + +| Procedure defined in 3GPP TS 29.163 [4] | Transaction used in Q.1950 [14] | Transaction used in TS 29.232 [5] | Supported | Comment | +|-------------------------------------------------------------|---------------------------------|-----------------------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Reserve IMS Connection point | Not defined | Not Defined | Mandatory | See A.17.2. 2 | +| Configure IMS Resources | Not Defined | Not Defined | Mandatory | See A.17.2. 3 | +| Reserve IMS Connection Point and configure remote resources | Not defined | Not Defined | Mandatory | See A.17.2. 4 | +| Release IMS termination | n. a. for reuse | Release Termination | Mandatory | See A.17.2. 5 | +| Change IMS ThroughConnection | n. a. for reuse | Change Through Connection | Mandatory | only the Explicit (MGC Controlled Cut-Through) procedure is supported | +| Detect IMS RTP Tel Event | n. a. for reuse | Detect DTMF | Optional | Only applicable if termination towards IMS is connected with a termination towards a BICC network. | +| End IMS RTP Tel Event | n. a. for reuse | Stop Detect DTMF | Optional | Only applicable if termination towards IMS is connected with a termination towards a BICC network. | +| Notify IMS RTP Tel Event | n. a. for reuse | Report DTMF | Optional | Only applicable if termination towards IMS is connected with a termination towards a BICC network. | +| Send IMS RTP Tel Event | n. a. for reuse | Send DTMF | FFS | | +| Stop IMS RTP Tel Event | n. a. for reuse | Stop DTMF | FFS | | +| IMS Send Tone | n. a. for reuse | Send Tone | Optional | | +| IMS Stop Tone | n. a. for reuse | Stop Tone | Optional | | +| IMS Tone Completed | n. a. for reuse | Tone Completed | Optional | | +| Termination heartbeat Indication | Not defined | Termination heartbeat Indication | Mandatory | To allow detection of hanging contexts and terminations in the MGW that may result e.g. from a loss of communication between the MGCF and the IM-MGW. | +| IMS Bearer Released | n. a. for reuse. | Bearer Released | Mandatory | | +| Request RTCP-Interworking | Not defined | Not defined | Optional | Only applicable if RTCP AVPF message to feedback on the quality of the media distribution from the IMS side is required to be interworked with corresponding H.245 message towards the CS side. | +| Notify of RTCP-Interworking | Not defined | Not defined | Optional | Only applicable if RTCP AVPF message to feedback on the quality of the media distribution from the IMS side is required to be interworked with corresponding H.245 message towards the CS side. | +| Signal H.245-Interworking | Not defined | Not defined | Optional | Only applicable if H.245 message to feedback on the quality of the media distribution from the CS side is required to be interworked with corresponding RTCP AVPF message | + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|------------------------|----------|-----------------------------------------------------------| +| | | | | towards the IMS side. | +| ECN Failure Indication | Not defined | ECN Failure Indication | Optional | Only applicable if ECN capability is supported. | +| ICE Connectivity Check Result Notification | Not defined | Optional | Optional | See A.17.2.11
Only applicable if full ICE is supported | +| ICE New Peer Reflexive Candidate Notification | Not defined | Optional | Optional | See A.17.2.12
Only applicable if full ICE is supported | +| NOTE 1: A procedure defined in table 13.2.1 can be combined with another procedure in the same table. This means that they can share the same contextID and termination ID(s) and that they can be combined in the same H.248 command. | | | | | + +#### A.17.2.2 Reserve IMS Connection Point + +When the procedure "Reserve IMS Connection Point" is required the following procedure is initiated: + +The MGCF sends an Add.req command with the following information. + +- 1 Add.req (Reserve IMS Connection Point) MGCF to IM-MGW + +Table A.17.2.2/1: Reserve IMS Connection Point Request + +| Address Information | Control information | Bearer information | +|--------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Stream ID
Local Descriptor {
Port = ?
IP Address = ?
} | Transaction ID = z
Termination ID = ?
If Context Requested:
Context ID = ?
If Context Provided:
Context ID = c1
If MPS call/session:
Priority Indicator = x
If IP Interface Type:
IP interface = "IP interface type"
If Resources for multiple Codecs shall be reserved:
Reserve_Value
NotificationRequested (Event ID = x, "termination heartbeat")
If indication on Bearer Released requested:
NotificationRequested (Event ID = x, "BNC Release (Cause)") – as defined in ITU-T Recommendation Q.1950
If multiple IP realms: IP realm Identifier = required IP realm identifier

If ECN Endpoint support required
ECN Enable = "True"
Initiation Method = "ECN Initiation Method"

If notification of ECN Failure Report:
NotificationRequested (Event ID = x, "ECN Failure")

If diffserv required:
Diffserv Code Point

If ICE is applied:
STUN server request | Stream ID
Local Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR
If ICE is applied:
ICE host candidate request
ICE password request
ICE Ufrag request
ICE pacing request

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
} | + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +##### 2 Add.resp (Reserve IMS Connection Point Ack) + +Table A.17.2.2/2: Reserve IMS Connection Point Acknowledge + +| Address Information | Control information | Bearer information | +|------------------------------------------------------------|------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Stream ID
Local Descriptor {
Port
IP Address
} | Transaction ID
Termination ID
Context ID | Stream ID
Local Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR

If ICE is applied:
ICE host candidate
ICE password
ICE Ufrag
ICE pacing
If ICE lite implementation
ICE lite indication

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
} | + +#### A.17.2.3 Configure IMS Resources + +When the procedure "Configure IMS Resources" is required the following procedure is initiated: + +The MGCF sends a Mod.req command with the following information. + +- 1 Mod.req (Configure IMS Resources) MGCF to IM-MGW + +Table A.17.2.3/1: Configure IMS Resources Request + +| Address Information | Control information | Bearer information | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| If local resources are modified:
Stream ID
Local Descriptor {
Port
IP Address
}
If remote resources are modified:
Remote Descriptor {
Port
IP Address
} | Transaction ID
Termination ID
Context ID
If IP Interface Type:
IP interface = "IP interface type"(NOTE 1)
If Resources for multiple Codecs shall be reserved:
Reserve_Value
If ECN Endpoint support required
ECN Enable = "True"
Initiation Method = "ECN Initiation Method"
If notification of ECN Failure Report:
NotificationRequested (Event ID = x,"ECN Failure")
If full ICE is applied:
Send Connectivity Check ("Control")
If notification of ICE Connectivity Check Result Report:
NotificationRequested (Event ID= xx, "Connectivity Check Result")
If notification of New Peer Reflexive Candidate:
NotificationRequested (Event ID = xy," New Peer Reflexive Candidate ")
Send Additional Connectivity Check ("Control") | If local resources are modified:
Stream ID
Local Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR
}
If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
}
If remote resources are modified:
Remote Descriptor {
Codec List
RTP Payloads
If rate adaptation for media endpoints:
Additional Bandwidth Properties (NOTE 3)
RtcpbwRS
RtcpbwRR
}
If RTCP APP messages allowed
Allowed RTCP APP message types
If ICE is applied:
ICE received candidate
ICE received password
ICE received Ufrag (NOTE 2)
ICE received pacing (NOTE 4)
If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
} | +| NOTE 1: If this property is included within the "Reserve IMS Connection Point" procedure or the "Reserve IMS Connection Point and configure remote resource" procedure then it shall not be modified by this procedure.
NOTE 2: The support of ICE received candidate, ICE received password, ICE received Ufrag are optional for ICE lite, as specified in 3GPP TS 29.163 [4].
NOTE 3: The support of rate adaptation for media endpoints using the additional bandwidth properties is optional for the IM-MGW. If media transcoding is required the MGCF may provide for the selected payload type and the used IP version the additional bandwidth properties.
NOTE 4: The ICE received pacing is only applicable for full ICE, as specified in IETF RFC 8445 [72]. | | | + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +##### 2 Mod.resp (Configure IMS Resources Ack) + +Table A.17.2.3/2: Configure IMS Resources Acknowledge + +| Address Information | Control information | Bearer information | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| If local resources were provided in request:
Stream ID
Local Descriptor {
Port
IP Address
}
If remote resources were provided in request:
Remote Descriptor {
Port
IP Address
} | Transaction ID
Context ID
Termination ID | If local resources were provided in request:
Stream ID
Local Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR
}
If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
}
If remote resources were provided in request:
Remote Descriptor {
Codec List
RTP Payloads
If rate adaptation for media endpoints:
Additional Bandwidth
Properties
RtcpbwRS
RtcpbwRR
}
If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
} | + +#### A.17.2.4 Reserve IMS Connection Point and configure remote resources + +When the procedure "Reserve IMS Connection Point and configure remote resources" is required the following procedure is initiated: + +The MGCF sends an Add.req command with the following information. + +- 1 Add.req (Reserve IMS Connection Point and configure remote resources) MGCF to IM-MGW + +Table A.17.2.4/1: Reserve IMS Connection Point and configure remote resources Request + +| Address Information | Control information | Bearer information | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Stream ID
Local Descriptor {
Port = ?
IP Address = ?
}
Remote Descriptor {
Port
IP Address
} | Transaction ID
Termination ID = ?
If Context Requested:
Context ID = ?
If Context Provided:
Context ID = c1
If MPS call/session:
Priority Indicator = x
If IP Interface Type:
IP interface = "IP interface type"
If Resources for multiple Codecs shall be reserved:
Reserve_Value
NotificationRequested (Event ID = x, "termination heartbeat")
If indication on Bearer Released requested:
NotificationRequested (Event ID = x, "BNC Release (Cause)") – as defined in ITU-T Recommendation Q.1950
If multiple IP realms: IP realm Identifier = required IP realm identifier
If ECN Endpoint support required
ECN Enable = "True"
Initiation Method = "ECN Initiation Method"

If notification of ECN Failure Report:
NotificationRequested (Event ID = x, "ECN Failure")

If diffserv required:
Diffserv Code Point

If ICE is applied:
STUN server request
If full ICE is applied
Send Connectivity Check ("Control")
notification of ICE Connectivity Check Result Report:
NotificationRequested (Event ID = xx, "Connectivity Check Result")
If notification of New Peer Reflexive Candidate:
NotificationRequested (Event ID = xy, " New Peer Reflexive Candidate ") | Stream ID
Local Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR
If ICE is applied:
ICE host candidate request
ICE password request
ICE Ufrag request
ICE pacing request

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
}
Remote Descriptor {
Codec List
RTP Payloads
If rate adaptation for media endpoints:
Additional Bandwidth Properties (NOTE 2)
RtcpbwRS
RtcpbwRR

If RTCP APP messages allowed
Allowed RTCP APP message types

If ICE is applied:
ICE received candidate
ICE received password
ICE received Ufrag (NOTE 1)
ICE received pacing (NOTE 3)

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
} | +| NOTE 1: The support of ICE received candidate, ICE received password, ICE received Ufrag are optional for ICE lite, as specified in 3GPP TS 29.163 [4]. | | | +| NOTE 2: The support of rate adaptation for media endpoints using the additional bandwidth properties is optional for the IM-MGW. If media transcoding is required the MGCF may provide for the selected payload type and the used IP version the additional bandwidth properties. | | | +| NOTE 3: The ICE received pacing is only applicable for full ICE, as specified in IETF RFC 8445 [72]. | | | + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +##### 2 Add.resp (Reserve IMS Connection Point and configure remote resources Ack) + +**Table A.17.2.4/2: Reserve IMS Connection Point and configure remote resources Acknowledge** + +| Address Information | Control information | Bearer information | +|--------------------------------------------------------------------------------------------------------------|------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Stream ID
Local Descriptor {
Port
IP Address
}
Remote Descriptor {
Port
IP Address
} | Transaction ID
Termination ID
Context ID | Stream ID
Local Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR
If ICE is applied:
ICE host candidate
ICE password
ICE Ufrag
ICE pacing
If ICE lite implementation
ICE lite indication

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
}
Remote Descriptor {
Codec List
RTP Payloads
If rate adaptation for media endpoints:
Additional Bandwidth Properties
RtcpbwRS
RtcpbwRR

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
} | + +#### A.17.2.5 VOID + +#### A.17.2.6 Termination heartbeat indication + +When the procedure "Termination heartbeat indication" is required the following procedure is initiated: the MGW sends a NOT.req command with the following information. + +**Table A.17.2.6/1: NOT.req (Termination heartbeat) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

Event_ID (Event ID = x,
"termination heartbeat") | | + +When the processing of command is complete, the MGC initiates the following procedure. + +**Table A.17.2.6/2: NOT.resp (Termination heartbeat) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1 | | + +The heartbeat timer shall be configured to a value much greater than the mean call holding time. + +The MGCF is in charge of correcting any detected mismatch, by subtracting hanging terminations or clearing hanging contexts as specified for the hanging termination detection procedure in 3GPP TS 29.163 [4]. + +#### A.17.2.7 Request RTCP-Interworking + +When the procedure "Request RTCP-Interworking" is required the following procedure is initiated: + +the MGCF sends a Mod.req command with the following information. + +**Table A.17.2.7/1: Request RTCP-Interworking Request** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

NotificationRequested (Event ID = x, "Incoming RTCP Interworking (RTCP Filter)") | | + +When the processing of command is complete, the IM-MGW initiates the following procedure. + +**Table A.17.2.7/2: Request RTCP-Interworking Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1 | | + +#### A.17.2.8 Notify RTCP-Interworking + +When the procedure "Notify RTCP-Interworking" is required the following procedure is initiated: + +the IM-MGW sends a NOT.req command with the following information. + +**Table A.17.2.8/1: Notify RTCP-Interworking Request** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

if RTCP PLI message received and the interworking required:
Update Picture = UpdatePicture_Event

if RTCP TMMBR message received and the interworking required:
Max BitRate = MaxBitRate_Event | | + +When the processing of command is complete, the MGCF initiates the following procedure. + +**Table A.17.2.8/2: Notify RTCP-Interworking Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1 | | + +The MGCF is in charge of sending the corresponding H.245 message to the CS side to request for the media adaption. as specified for the "Interworking between RTCP messages and H.245 messages" in 3GPP TS 29.163 [4]. + +#### A.17.2.9 Signal H.245-Interworking + +When the procedure "Signal H.245-Interworking" is required the following procedure is initiated: + +the MGCF sends a Mod.req command with the following information. + +**Table A.17.2.9/1: Signal H.245-Interworking Request** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

if H.245 VideoFastUpdatePicture message received and the interworking required:
Interwork H.245-RTCP (UpdatePicture_Signal)

if H.245 Flow Control Command received and the interworking required:
Interwork H.245-RTCP (MaxBitRate_Signal) | | + +When the processing of command is complete, the IM-MGW initiates the following procedure. + +**Table A.17.2.9/2: Signal H.245-Interworking Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1 | | + +The IM-MGW is in charge of constructing and sending the corresponding RTCP message to the IMS side to request for the media adaption as specified for the "Interworking between RTCP messages and H.245 messages" in 3GPP TS 29.163 [4]. + +#### A.17.2.10 ECN Failure Indication + +The IM-MGW sends a NOTIFY request command as in Table A.17.2.10.1. + +**Table A.17.2.10.1: ECN Failure Indication** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x, "ECN Failure (ECN Failure Type ") | | + +The MGCF responds as in Table A.17.2.10.2 + +**Table A.17.2.10.2: ECN Failure Indication Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### A.17.2.11 ICE Connectivity Check Result Notification + +The IM-MGW sends a NOTIFY request command as defined in Table A.17.2.11.1. + +**Table A.17.2.11.1: ICE Connectivity Check Result Notification** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
" Connectivity Check Result
(Candidate/Transport Pair)") | | + +The MGCF responds as defined in Table A.17.2.11.2 + +**Table A.17.2.11.2: ICE Connectivity Check Result Notification Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### A.17.2.12 ICE New Peer Reflexive Candidate Notification + +The IM-MGW sends a NOTIFY request command as defined in Table A.17.2.12.1. + +**Table A.17.2.12.1: ICE New Peer Reflexive Candidate Notification** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
" New Peer Reflexive Candidate
(Candidate)") | | + +The MGCF responds as defined in Table 5.17.2.12.2 + +**Table A.17.2.12.2: ICE New Peer Reflexive Candidate Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +### A.17.3 TDM Terminations Procedures + +#### A.17.3.1 Summary Procedures related to a termination towards ISUP + +**Table A.17.3.1/1: Correspondence between ITU-T Recommendation Q.1950 [14] or 29.232 [5] call-related transactions and 3GPP TS 29.163 [4] procedures related to a termination towards an ISUP network** + +| Procedure defined in 3GPP TS 29.163 [4] | Transaction used in ITU-T Q.1950 [14] | Transaction used in TS 29.232 [5] | Support | Comment | +|-----------------------------------------|---------------------------------------|---------------------------------------|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Reserve TDM Circuit | n. a. for reuse | n. a. for reuse, (NOTE 2) | Optional (NOTE 4) | See Clause A.17.3.2 | +| Change TDM Through-connection | n. a. for reuse | Change Through-connection | Optional (NOTE 4) | only the Explicit (MGC Controlled Cut-Through) procedure is supported | +| Activate TDM voice-processing function | n. a. for reuse | Activate Voice Processing Function | Optional (NOTE 4) | | +| Send TDM Tone | n. a. for reuse | Send Tone | Optional (NOTE 4) | | +| Stop TDM Tone | n. a. for reuse | Stop Tone | Optional (NOTE 4) | | +| TDM Tone Completed | n. a. for reuse | Tone Completed | Optional (NOTE 4) | | +| Play TDM Announcement | n. a. for reuse | Play Announcement | Optional (NOTE 4) | | +| TDM Announcement Completed | n. a. for reuse | Announcement Completed | Optional (NOTE 4) | | +| Stop TDM Announcement | n. a. for reuse | Stop Announcement | Optional (NOTE 4) | | +| Continuity Check | Continuity Check Tone | n. a. for reuse | Optional (NOTE 4) | The addition to "Prepare BNC Notify" defined in Annex B.7.1.1 of Q.1950 [14] shall be applied instead to "Reserve TDM Circuit", as defined in Clause A.17.3.2 | +| Continuity Check Verify | Continuity Check Verify | Continuity Check Verify | Optional (NOTE 4) | | +| Continuity Check Response | Continuity Check Response | n. a. for reuse | Optional (NOTE 4) | The addition to "Prepare BNC Notify" defined in Annex B.7.1.2 of Q.1950 [14] shall be applied instead to "Reserve TDM Circuit", as defined in Clause A.17.3.2 | +| Release TDM Termination | n. a. for reuse | n. a. for reuse | Optional (NOTE 4) | See Clause A.17.3.3 | +| Termination heartbeat Event | Not defined | Termination heartbeat Indication | Optional | See Clause A.17.3.4 | +| Not defined | Not defined | TFO Activation | Optional | See Clause A.14.21 | +| Not defined | Not defined | Codec Modify | Optional | See Clause A.14.21 | +| Not defined | Not defined | Optimal Codec and Distant List Notify | Optional | See Clause A.14.21 | +| Not defined | Not defined | Distant Codec List | Optional | See Clause A.14.21 | +| Not defined | Not defined | TFO status Notify | Optional | See Clause A.14.21 | +| Not defined | Not defined | TFO status | Optional | See Clause A.14.21 | +| Bearer Released | n. a. for reuse. | Bearer Released | Optional (NOTE 4) | | + +NOTE 1: A procedure defined in table 13.2.2 can be combined with another procedure in the same table. This means that they can share the same contextID and termination ID(s) and that they can be combined in the same H.248 command. + +NOTE 2: The reserve circuit procedure of 29.232 is not to be used only a reduced set of the parameters is required for reserve TDM circuit. + +NOTE 3: VOID + +NOTE 4: Required for TDM terminations towards an ISUP based network + +#### A.17.3.2 Reserve TDM Circuit + +When the procedure "Reserve TDM Circuit" is required the following procedure is initiated: + +The MGCF sends an Add.req command with the following information. + +**Table A.17.3.2/1: Add.req (Reserve TDM Circuit) MGCF to IM-MGW** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| | Transaction ID
Termination ID
If Context Requested:
Context ID = ?
If Context Provided:
Context ID = c1
If detection of hanging termination is requested:
NotificationRequested (Event ID = x, "termination heartbeat")
If indication on Bearer Released requested:
NotificationRequested (Event ID = x, "BNC Release (Cause)") – as defined in ITU-T Recommendation Q.1950 | Bearer Service Characteristics | + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +**Table A.17.3.2/2: Add.resp (Reserve TDM Circuit) IM-MGW to MGCF** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------|--------------------| +| | Transaction ID
Termination ID
Context ID | | + +#### A.17.3.3 Release TDM Termination + +When the procedure "Release TDM Termination" is required the following procedure is initiated: + +The MGCF sends an Sub.req command with the following information. + +**Table A.17.3.3/1: Sub.req (Release TDM Termination) MGCF to IM-MGW** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------|--------------------| +| | Transaction ID
Termination ID
Context ID | | + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +**Table A.17.3.3/2: Sub.resp (Release TDM Termination) IM-MGW to MGCF** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------|--------------------| +| | Transaction ID
Termination ID
Context ID | | + +#### A.17.3.4 Termination heartbeat indication + +When the procedure "Termination heartbeat indication" is required the following procedure is initiated: the MGW sends a NOT.req command with the following information. + +**Table A.17.3.4/1: NOT.req (Termination heartbeat) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

Event_ID (Event ID = x,
"termination heartbeat") | | + +When the processing of command is complete, the MGC initiates the following procedure. + +**Table A.17.3.4/2: NOT.resp (Termination heartbeat) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1 | | + +The heartbeat timer shall be configured to a value much greater than the mean call holding time. + +The MGCF is in charge of correcting any detected mismatch, by subtracting hanging terminations or clearing hanging contexts as specified for the hanging termination detection procedure in 3GPP TS 29.163 [4]. + +### A.17.4 BICC Terminations Procedures + +#### A.17.4.1 Procedures related to a termination towards BICC + +**Table A.17.4.1/1: Correspondence between ITU-T Recommendation Q.1950 [14] or 3GPP TS 29.232 [5] call-related transactions and 3GPP TS 29.163 [4] procedures related to a termination towards a BICC network** + +| Procedure defined in 3GPP TS 29.163 [4] | Transaction used in Q.1950 [14] | Transaction used in TS 29.232 [5] | Support | Comment | +|-----------------------------------------|---------------------------------|-----------------------------------------|-------------------|-------------------------------------------------------------------------------------------------| +| Establish Bearer | Establish_BNC_Notify +(tunnel) | Establish Bearer (NOTE 1) | Optional (NOTE 5) | | +| Prepare Bearer | Prepare_BNC_Notify +(tunnel) | Prepare Bearer (NOTE 1), (NOTE 2) | Optional (NOTE 5) | | +| Change Through-Connection | n. a. for reuse | Change Through-Connection | Optional (NOTE 5) | only the Explicit (MGC Controlled Cut-Through) procedure is supported | +| Release Bearer | n. a. for reuse | Release Bearer | Optional (NOTE 5) | (NOTE 3) | +| Release Termination | n. a. for reuse | Release Termination | Optional (NOTE 5) | Includes Subtract in the transaction. Statistics about "Ctmbits" are not applicable in Sub.resp | +| Bearer Established | n. a. for reuse | Bearer Established | Optional (NOTE 5) | | +| Bearer Released | n. a. for reuse | Bearer Released | Optional (NOTE 5) | | +| Send Tone | n. a. for reuse | Send Tone | Optional (NOTE 5) | | +| Stop Tone | n. a. for reuse | Stop Tone | Optional (NOTE 5) | | +| Tone Completed | n. a. for reuse | Tone Completed | Optional (NOTE 5) | | +| Play Announcement | n. a. for reuse | Play Announcement | Optional (NOTE 5) | | +| Stop Announcement | n. a. for reuse | Stop Announcement | Optional (NOTE 5) | | +| Announcement Completed | n. a. for reuse | Announcement Completed n | Optional (NOTE 5) | | +| Bearer Modification Support | Not defined | Bearer Modification Support | Optional (NOTE 5) | | +| Confirm Char | Confirm_Char | Confirm Bearer Characteristics (NOTE 1) | Optional (NOTE 6) | | +| Modify Bearer Characteristics | Modify Char | Modify Bearer Characteristics (NOTE 1) | Optional (NOTE 6) | | +| Reserve Char | Reserve_Char_Notify | Reserve Bearer Characteristics (NOTE 1) | Optional (NOTE 6) | | +| Bearer Modified | BNC Modified | Bearer Modified | Optional (NOTE 6) | | +| Activate Voice Processing Function | n. a. for reuse | Activate Voice Processing Function | Optional (NOTE 5) | | +| Tunnel Information Down | Tunnel (MGC-MGW) | Tunnel Information Down | Optional (NOTE 7) | For IP Transport at BICC termination | +| Tunnel Information Up | Tunnel (MGW-MGC) | Tunnel Information Up | Optional (NOTE 7) | For IP Transport at BICC termination | +| Termination heartbeat | Not defined | Termination heartbeat indication | Mandatory | | +| Not defined | Not defined | TFO Activation | Optional | | +| Not defined | Not defined | Codec Modify | Optional | | +| Not defined | Not defined | Optimal Codec and Distant List_Notify | Optional | | +| Not defined | Not defined | Distant Codec List | Optional | | + +| | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|-------------------|----------|--| +| Not defined | Not defined | TFO status Notify | Optional | | +| Not defined | Not defined | TFO status | Optional | | +| NOTE 1: The procedure is only applicable if the Nb framing protocol is applied at the BICC termination. Only requesting of Observed events defined in the corresponding TS 29.232 and parameters defined in the "3GUP" package of TS 29.232 are applicable in addition the parameters of the corresponding Q.1950 procedure. Those parameters shall be applies as follows: UP mode = Supported mode; UP versions = 2; interface = CN; | | | | | +| NOTE 2: Parameters and Observed events defined for Cellular Text telephone Modem Text Transport in the corresponding procedure of TS 29.232 are not applicable. | | | | | +| NOTE 3: VOID | | | | | +| NOTE 4: VOID | | | | | +| NOTE 5: Necessary for optional terminations towards BICC | | | | | +| NOTE 6: Optional for optional terminations towards BICC | | | | | +| NOTE 7: Necessary for optional terminations towards BICC network with IP transport | | | | | + +### A.17.5 Multiplex Termination Procedures + +#### A.17.5.1 Procedures related to a Multiplex termination + +**Table A.17.5.1/1: Correspondence between ITU-T Recommendation Q.1950 [14] or 3GPP TS 29.232 [5] call-related transactions and 3GPP TS 29.163 [4] procedures related to a multiplex termination** + +| Procedure defined in 3GPP TS 29.163 [4] | Transaction used in Q.1950 [14] | Transaction used in TS 29.232 [5] | Support | Comment | +|--------------------------------------------------------|---------------------------------|-----------------------------------|-------------------|---------------| +| Add Multiplex Termination | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.2 | +| Configure Multiplex Termination | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.3 | +| Signal H245 Message | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.4 | +| Notify H245 message | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.5 | +| Notify MONA Preference Reception | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.6 | +| Notify MONA Preference Completed | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.7 | +| Signal SPC | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.8 | +| Notify SPC | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.9 | +| Notify MPC | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.10 | +| Notify Detection of Legacy Interworking | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.11 | +| Stop MPC | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.12 | +| Stop SPC | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.13 | +| Stop MONA Negotiation | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.14 | +| NOTE 1: Necessary for interworking of multimedia calls | | | | | + +#### A.17.5.2 Add Multiplex Termination + +When the procedure "Add Multiplex Termination" is required the following procedure is initiated: + +The MGCF sends an Add.req command with the following information. + +1 Add.req (Add Multiplex Termination) MGCF to IM-MGW + +Table A.17.5.2/1: Add Multiplex Termination Request + +| Address Information | Control information | Bearer information | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| |

Transaction ID = z
Context ID = c1
Termination ID = ?

Muxdescriptor

If MONA procedures not supported:
NotificationRequested (Event ID = x,
"Incoming H245 message")

If MONA procedures supported:
NotificationRequested (Event ID = x,
"Incoming H245 message
(SPC=Both)")

NotificationRequested (Event ID = x,
"termination heartbeat")

If indication on Bearer Released
requested:
NotificationRequested (Event ID = x,
"BNC Release (Cause)") – as
defined in ITU-T
Recommendation Q.1950

If MONA procedures supported:
Signal = Outgoing MONA
preferences
(Outgoing MONA preference
content) (NOTE)
NotificationRequested (Event ID
= x,
"MONA Preference recv")

NotificationRequested (Event ID
= x,
"MONA Preference completed")

NotificationRequested (Event ID
= x,
"Legacy Interworking Detected"
(Signal = Outgoing H245
message
(Outgoing H.245 message content)
) )

NotificationRequested (Event ID
= x,
"Mona Preference Channel
reception")

Signal = Forward media in MPC
(MPC MUX Code)

Incoming Multiplex Table

| | +| NOTE: The frequent retransmissions of MONA preference messages required by MONA procedures are to be performed by the IM-MGW autonomously to avoid unnecessary load at the Mn interface and the MGCF. | | | + +On receipt of this procedure, and the setting of the muxdescriptor, the IM-MGW shall initiate the H.324 negotiation, with connection mode H.324M and predefined Highest Multiplexing Level. + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +##### 2 Add.resp (Add Multiplex Termination Ack) + +**Table A.17.5.2/2: Add Multiplex Termination Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.3 Configure Multiplex Termination + +When the procedure "Configure Multiplex Termination" is required the following procedure is initiated: + +The MGCF sends an Mod.req command with the following information. + +##### 1 Mod.req (Configure Multiplex Termination) MGCF to IM-MGW + +**Table A.17.5.3/1: Configure Multiplex Termination Request** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1

If MONA completed or MONA not supported:
Remote H223 Capability
Incoming Multiplex table
Outgoing Multiplex table

If MONA MPC sending is requested:
Signal = Forward media in MPC
(MPC MUX Code) | | + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +##### 2 Mod.resp (Configure Multiplex Termination Ack) + +**Table A.17.5.3/2: Configure Multiplex Termination Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.4 Signal H245 Message + +When the procedure "Signal H245 Message" is required the following procedure is initiated: + +The MGCF sends an Mod.req command with the following information. + +##### 1 Mod.req (Signal H245 Message) MGCF to IM-MGW + +**Table A.17.5.4/1: Signal H245 Message Request** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1

Signal = Outgoing H245 message
(Outgoing H.245 message content) | | + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +##### 2 Mod.resp (Signal H245 Message Ack) + +**Table A.17.5.4/2: Signal H245 Message Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.5 Notify H.245 Message + +When the procedure "Notify H.245 message" is required the following procedure is initiated: the IM-MGW sends a NOT.req command with the following information. + +##### 1 Not.req (Notify H245 Message) IM-MGW to MGCF + +**Table A.17.5.5/1: Notify H245 Message Request** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1
Event_ID (Event ID = x,
"Incoming H245 message
(H245 message content)") | | + +When the processing of command is complete, the MGCF initiates the following procedure. + +##### 2 Not.resp (Notify H245 Message Ack) MGCF to IM-MGW + +**Table A.17.5.5/2: Notify H245 Message Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.6 Notify MONA Preference Reception + +When the procedure "Notify MONA Preference Reception" is required the following procedure is initiated: the IM-MGW sends a NOT.req command with the following information. + +##### 1 Not.req (Notify MONA Preference Reception) IM-MGW to MGCF + +**Table A.17.5.6/1: Notify MONA Preference Reception Request** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1
Event_ID (Event ID = x,
"MONA Preference recv
(MONA preference message
content)") | | + +When the processing of command is complete, the MGCF initiates the following procedure. + +- 2 Not.resp (Notify MONA Preference Reception) MGCF to IM-MGW + +**Table A.17.5.6/2: Notify MONA Preference Reception Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.7 Notify MONA Preference Completed + +When the procedure "Notify MONA Preference Completed" is required the following procedure is initiated: the IM-MGW sends a NOT.req command with the following information. + +- 1 Not.req (Notify MONA Preference Completed) IM-MGW to MGCF + +**Table A.17.5.7/1: Notify MONA Preference Completed Request** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1
Event_ID (Event ID = x,
"MONA Preference
completed ") | | + +When the processing of command is complete, the MGCF initiates the following procedure. + +- 2 Not.resp (Notify MONA Preference Completed) MGCF to IM-MGW + +**Table A.17.5.7/2: Notify MONA Preference Completed Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.8 Signal SPC + +When the procedure "Signal SPC" is required the following procedure is initiated: + +The MGCF sends an Mod.req command with the following information. + +- 1 Mod.req (Signal SPC) MGCF to IM-MGW + +**Table A.17.5.8/1: Signal SPC Request** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1

Signal = Outgoing H245 message
(Outgoing H.245 message content,
SPC Out=ON) | | + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +##### 2 Mod.resp (Signal SPC Ack) + +**Table A.17.5.8/2: Signal SPC Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.9 Notify SPC + +When the procedure "Notify SPC" is required the following procedure is initiated: the IM-MGW sends a NOT.req command with the following information. + +##### 1 Not.req (Notify SPC) IM-MGW to MGCF + +**Table A.17.5.9/1: Notify SPC Request** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1
Event_ID (Event ID = x,
"Incoming H245 message
(H245 message content, SPC
In=ON)") | | + +When the processing of command is complete, the MGCF initiates the following procedure. + +##### 2 Not.resp (Notify SPC Ack) MGCF to IM-MGW + +**Table A.17.5.9/2: Notify SPC Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.10 Notify MPC + +When the procedure "Notify MPC" is required the following procedure is initiated: the IM-MGW sends a NOT.req command with the following information. + +##### 1 Not.req (Notify MPC) IM-MGW to MGCF + +**Table A.17.5.10/1: Notify MPC Request** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1
Event_ID (Event ID = x,
"Mona Preference Channel
reception (Muxcode)") | | + +When the processing of command is complete, the MGCF initiates the following procedure. + +2 Not.resp (Notify MPC Ack) MGCF to IM-MGW + +**Table A.17.5.10/2: Notify MPC Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.11 Notify Detection of Legacy Interworking + +When the procedure "Notify Detection of Legacy Interworking " is required the following procedure is initiated: the IM-MGW sends a NOT.req command with the following information. + +1 Not.req (Notify Detection of Legacy Interworking) IM-MGW to MGCF + +**Table A.17.5.11/1: Notify Detection of Legacy Interworking Request** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1
Event_ID (Event ID = x,
"Legacy Interworking
Detected ") | | + +When the processing of command is complete, the MGCF initiates the following procedure. + +2 Not.resp (Notify Detection of Legacy Interworking ) MGCF to IM-MGW + +**Table A.17.5.11/2: Notify Detection of Legacy Interworking Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.12 Stop MPC + +When the procedure "Stop MPC" is required the following procedure is initiated: + +The MGCF sends an Mod.req command with the following information. + +1 Mod.req (Stop MPC) MGCF to IM-MGW + +**Table A.17.5.12/1: Stop MPC Request** + +| Address Information | Control information | Bearer information | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1

Signal = x, NOTE 1

NotificationRequested (Event ID = x, NOTE 2 ) | | +| NOTE 1: The signal descriptor shall not include the "Forward media in MPC" signal.
NOTE 2: The event descriptor shall not include the "Mona Preference Channel reception" event. | | | + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +##### 2 Mod.resp (Stop MPC Ack) + +**Table A.17.5.12/2: Stop MPC Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.13 Stop SPC + +When the procedure "Stop SPC" is required the following procedure is initiated: + +The MGCF sends a Mod.req command with the following information. + +##### 1 Mod.req (Stop SPC)MGCF to IM-MGW + +Table A.17.5.13/1: Stop SPC Request + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1

If legacy H.245 or accelerated H.245 required:
Signal = Outgoing H245 message
(Outgoing H.245 message content, SPC Out=OFF)

NotificationRequested (Event ID =
x, "Incoming H245 message (SPC=H245)") NOTE 3

If legacy H.245 or accelerated H.245 not required:
Signal = x, NOTE 1

NotificationRequested (Event ID =
x, NOTE 2 ) | | + +NOTE 1: The signal descriptor shall not include the "Outgoing H.245 message" signal. +NOTE 2: The event descriptor shall not include the "Incoming H.245 message" event. +NOTE 3: SPC parameter may be omitted, as SPC=H245 is the default value. + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +##### 2 Mod.resp (Stop SPC Ack) + +Table A.17.5.13/2: Stop SPC Acknowledge + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.14 Stop MONA Negotiation + +When the procedure "Stop MONA negotiation" is required the following procedure is initiated: + +The MGCF sends a Mod.req command with the following information. + +##### 1 Mod.req (Stop MONA Negotiation) MGCF to IM-MGW + +**Table A.17.5.14/1: Stop MONA Negotiation Request** + +| Address Information | Control information | Bearer information | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1

Signal = x, NOTE 1

NotificationRequested (Event ID = x, NOTE 2 )

If legacy H.245 or accelerated H.245 required:
Signal = Outgoing H245 message
(Outgoing H.245 message content, SPC Out=OFF)

NotificationRequested (Event ID =
x, "Incoming H245 message (SPC=H245)") NOTE 3 | | +| NOTE 1: The signal descriptor shall not include any of the signals "Outgoing MONA preferences" and "Forward media in MPC". If legacy H.245 or accelerated H.245 is not required the signal descriptor shall also not include the "Outgoing H.245 message" signal.
NOTE 2: The event descriptor shall not include any of the events "MONA Preference recv", "MONA Preference completed" and "Mona Preference Channel reception". If legacy H.245 or accelerated H.245 is not required the event descriptor shall also not include the "Incoming H.245 message" event.
NOTE 3: SPC parameter may be omitted, as SPC=H245 is the default value. | | | + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +##### 2 Mod.resp (Stop MONA Negotiation Ack) + +**Table A.17.5.14/2: Stop MONA Negotiation Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +### A.17.6 SIP-I on Nc Terminations Procedures + +#### A.17.6.1 Summary of Procedures related to a termination towards SIP-I on Nc CN Subsystem + +The interworking between IMS domain and SIP-I on Nc is specified by 3GPP TS 29.235 [47] which requires the procedures for SIP-I on Nc as specified in 3GPP TS 23.231 [48] Clause 15.2. + +Table A.17.6.1/1 shows the relationship between each call-related procedure in ITU-T Recommendation Q.1950 [14] (see 3GPP TS 29.205 [3]) or TS 29.232 [5] and the corresponding stage 2 procedure defined in 3GPP TS 23.231 [48]. + +**Table A.17.6.1/1: Correspondence between ITU-T Recommendation Q.1950 [14] or 29.232 [5] call-related transactions and 3GPP TS 23.231 [48] procedures** + +| Procedure defined in 3GPP TS 23.231 [48] | Transaction used in Q.1950 [14] | Transaction used in TS 29.232 [5] | Supported | Comment | +|--------------------------------------------|---------------------------------|-----------------------------------------------------|-------------------|-------------------------------------------------------------------------------------------------| +| Reserve RTP Connection Point | Not defined | Reserve RTP Connection Point (NOTE 2) | Optional (NOTE1) | See A.17.2. 2 | +| Configure RTP Connection Point | Not Defined | Configure RTP Connection Point (NOTE 2) | Optional (NOTE1) | See A.17.2. 3 | +| Reserve and Configure RTP Connection Point | Not defined | Reserve and Configure RTP Connection Point (NOTE 2) | Optional (NOTE1) | See A.17.2. 4 | +| Release Termination | n. a. for reuse | Release Termination | Mandatory | Includes Subtract in the transaction. Statistics about "Ctmbits" are not applicable in Sub.resp | +| Change Through-Connection | n. a. for reuse | Change Through-Connection | Optional (NOTE 1) | only the Explicit (MGC Controlled Cut-Through) procedure is supported | +| Bearer Released | n. a. for reuse | Bearer Released | Optional (NOTE 1) | | +| Send Tone | n. a. for reuse | Send Tone | Optional (NOTE 1) | | +| Stop Tone | n. a. for reuse | Stop Tone | Optional (NOTE 1) | | +| Tone Completed | n. a. for reuse | Tone Completed | Optional (NOTE 1) | | +| Play Announcement | n. a. for reuse | Play Announcement | Optional (NOTE 1) | | +| Stop Announcement | n. a. for reuse | Stop Announcement | Optional (NOTE 1) | | +| Announcement Completed | n. a. for reuse | Announcement Completed n | Optional (NOTE 1) | | +| Activate Voice Processing Function | n. a. for reuse | Activate Voice Processing Function | Optional (NOTE 1) | | +| Termination heartbeat | Not defined | Termination heartbeat indication | Mandatory | | +| Not defined | Not defined | TFO Activation | Optional | | +| Not defined | Not defined | Codec Modify | Optional | | +| Not defined | Not defined | Optimal Codec and Distant List_Notify | Optional | | +| Not defined | Not defined | Distant Codec List | Optional | | +| Not defined | Not defined | TFO status Notify | Optional | | +| Not defined | Not defined | TFO status | Optional | | + +NOTE 1: Mandatory for connections towards SIP-I on Nc. + +NOTE 2: The existing IMS Connection Point Procedures are functionally similar to these 29.232 procedures as they were derived from the IMS ones. + +# --- Annex B (normative): Void + +# --- Annex C (normative): Void \ No newline at end of file diff --git a/marked/Rel-18/29_series/29334/raw.md b/marked/Rel-18/29_series/29334/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..c75fd6e834120b4b5c57327d1160c740705c871d --- /dev/null +++ b/marked/Rel-18/29_series/29334/raw.md @@ -0,0 +1,3077 @@ + + +# 3GPP TS 29.334 V18.1.0 (2024-06) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; IMS Application Level Gateway (IMS-ALG) – IMS Access Gateway (IMS-AGW); Iq Interface; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a small red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +# --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|---------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 8 | +| 3 Definitions, symbols and abbreviations ..... | 12 | +| 3.1 Definitions..... | 12 | +| 3.2 Symbols..... | 13 | +| 3.3 Abbreviations ..... | 13 | +| 4 Applicability..... | 14 | +| 4.1 Architecture..... | 14 | +| 5 Profile Description ..... | 14 | +| 5.1 Profile Identification ..... | 14 | +| 5.2 Summary ..... | 14 | +| 5.3 Gateway Control Protocol Version ..... | 15 | +| 5.4 Connection model ..... | 15 | +| 5.5 Context attributes ..... | 15 | +| 5.6 Terminations..... | 15 | +| 5.6.1 Termination names ..... | 15 | +| 5.6.1.1 IP Termination ..... | 15 | +| 5.6.1.1.1 ABNF Coding Overview and prose specification..... | 15 | +| 5.6.1.1.2 ASN.1 Coding Overview and prose specification ..... | 16 | +| 5.6.2 Multiplexed terminations..... | 17 | +| 5.7 Descriptors ..... | 17 | +| 5.7.1 TerminationState Descriptor ..... | 17 | +| 5.7.2 Stream Descriptor..... | 18 | +| 5.7.2.0 General..... | 18 | +| 5.7.2.1 LocalControl Descriptor ..... | 18 | +| 5.7.3 Events descriptor ..... | 19 | +| 5.7.4 EventBuffer descriptor ..... | 21 | +| 5.7.5 Signals descriptor ..... | 21 | +| 5.7.6 DigitMap descriptor..... | 23 | +| 5.7.7 Statistics descriptor..... | 23 | +| 5.7.8 ObservedEvents descriptor ..... | 23 | +| 5.7.9 Topology descriptor..... | 23 | +| 5.7.10 Error descriptor..... | 24 | +| 5.8 Command API..... | 26 | +| 5.8.1 Add ..... | 26 | +| 5.8.2 Modify ..... | 26 | +| 5.8.3 Subtract..... | 27 | +| 5.8.4 Move..... | 27 | +| 5.8.5 AuditValue ..... | 27 | +| 5.8.6 AuditCapabilities ..... | 27 | +| 5.8.7 Notify..... | 28 | +| 5.8.8 ServiceChange..... | 28 | +| 5.8.9 Manipulating and auditing context attributes ..... | 30 | +| 5.9 Generic command syntax and encoding..... | 30 | +| 5.10 Transactions ..... | 30 | +| 5.11 Messages ..... | 31 | +| 5.12 Transport ..... | 31 | +| 5.13 Security..... | 32 | +| 5.14 Packages..... | 32 | +| 5.14.1 Mandatory Packages..... | 32 | +| 5.14.2 Optional Packages ..... | 34 | +| 5.14.3 Package usage information..... | 35 | +| 5.14.3.1 Generic (g) ..... | 35 | + +| | | | +|-----------|---------------------------------------------------------------------------|----| +| 5.14.3.2 | Base root (root) ..... | 36 | +| 5.14.3.3 | Differentiated Services (ds) ..... | 37 | +| 5.14.3.4 | Gate Management (gm) ..... | 37 | +| 5.14.3.5 | Traffic management (tman) ..... | 38 | +| 5.14.3.6 | Inactivity Timer (it) ..... | 39 | +| 5.14.3.7 | IP Domain Connection (ipdc) ..... | 39 | +| 5.14.3.8 | Media Gateway Overload Control Package (ocp) ..... | 40 | +| 5.14.3.9 | Hanging Termination Detection (hangterm) ..... | 40 | +| 5.14.3.10 | Media Gateway Resource Congestion handling Package (chp) ..... | 41 | +| 5.14.3.11 | IP Realm Availability (ipra) ..... | 41 | +| 5.14.3.12 | IP NAPT Traversal (ipnapt) ..... | 42 | +| 5.14.3.13 | RTCP Handling Package (rtcph) ..... | 42 | +| 5.14.3.14 | Application Data Inactivity Detection (adid) ..... | 43 | +| 5.14.3.15 | Explicit Congestion Notification for RTP-over-UDP Support (ecnrous) ..... | 43 | +| 5.14.3.16 | MG Act-as STUN Server (mgastuns) ..... | 45 | +| 5.14.3.17 | Originate STUN Continuity Check (ostuncc) ..... | 45 | +| 5.14.3.18 | TCP basic connection control (tcpbcc) ..... | 46 | +| 5.14.3.19 | TLS basic session control (tlsbsc) ..... | 47 | +| 5.14.3.20 | Stream endpoint interlinkage (seplink) ..... | 47 | +| 5.14.3.21 | MG located Bearer Level ALG (mgbalg) ..... | 48 | +| 5.14.3.22 | STUN Consent Freshness (stnconfres) ..... | 48 | +| 5.14.3.23 | Media Grouping (mgroup) ..... | 49 | +| 5.14.3.24 | SCTP basic connection control package (sctpbcc) ..... | 50 | +| 5.14.3.25 | SCTP Re-configuration Stream Reset (sctpreset) ..... | 51 | +| 5.15 | Mandatory support of SDP and Annex C information elements ..... | 53 | +| 5.16 | Optional support of SDP and Annex C information elements ..... | 55 | +| 5.17 | Procedures ..... | 59 | +| 5.17.1 | Formats and Codes ..... | 59 | +| 5.17.2 | Call Related Procedures ..... | 64 | +| 5.17.2.1 | General ..... | 64 | +| 5.17.2.2 | Reserve AGW Connection Point ..... | 65 | +| 5.17.2.3 | Configure AGW Connection Point ..... | 69 | +| 5.17.2.4 | Reserve and Configure AGW Connection Point ..... | 75 | +| 5.17.2.5 | Release AGW Termination ..... | 80 | +| 5.17.2.6 | Termination Heartbeat Indication ..... | 81 | +| 5.17.2.7 | IP Bearer Released ..... | 81 | +| 5.17.2.8 | Media Inactivity Notification ..... | 82 | +| 5.17.2.9 | Change Through Connection ..... | 82 | +| 5.17.2.10 | Change Flow Direction ..... | 82 | +| 5.17.2.11 | ECN Failure Indication ..... | 83 | +| 5.17.2.12 | ICE Connectivity Check Result Notification ..... | 83 | +| 5.17.2.13 | ICE New Peer Reflexive Candidate Notification ..... | 84 | +| 5.17.2.14 | Notify TCP connection establishment Failure Indication ..... | 84 | +| 5.17.2.15 | Notify (D)TLS session establishment Failure Indication ..... | 85 | +| 5.17.2.16 | STUN Consent Freshness Test Failure Notification ..... | 85 | +| 5.17.2.17 | Notify SCTP Stream Reset ..... | 86 | +| 5.17.2.18 | Notify SCTP Stream Reset Result ..... | 86 | +| 5.17.3 | Non-Call Related Procedures ..... | 86 | +| 5.17.3.1 | General ..... | 86 | +| 5.17.3.2 | IMS-AGW Out Of Service ..... | 87 | +| 5.17.3.3 | IMS-AGW Communication Up ..... | 88 | +| 5.17.3.4 | IMS-AGW Restoration ..... | 88 | +| 5.17.3.5 | IMS-AGW Register ..... | 89 | +| 5.17.3.6 | IMS-AGW Re-Register ..... | 89 | +| 5.17.3.7 | IMS-ALG Ordered Re-register ..... | 90 | +| 5.17.3.8 | IMS-ALG Restoration ..... | 90 | +| 5.17.3.9 | IMS-ALG Out of Service ..... | 91 | +| 5.17.3.10 | Audit Value ..... | 91 | +| 5.17.3.11 | Command Rejected ..... | 93 | +| 5.17.3.12 | AGW Capability Change ..... | 93 | +| 5.17.3.13 | IMS-AGW Resource Congestion Handling – Activate ..... | 93 | +| 5.17.3.14 | IMS-AGW Resource Congestion Handling – Indication ..... | 94 | + +5.17.3.15 Inactivity Timeout – Activation..... 94 +5.17.3.16 Inactivity Timeout – Indication ..... 95 +5.17.3.17 Realm Availability Change – Activation..... 95 +5.17.3.18 Realm Availability Change – Indication ..... 95 +5.17.3.19 Termination Out Of Service ..... 96 + +**Annex A (informative): Change history..... 97** + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# 1 Scope + +The present document describes the protocol to be used on the IMS Application Level Gateway (ALG) – IMS Access Gateway (IMS-AGW) interface. The basis for this protocol is the H.248 protocol as specified in ITU-T. The IMS architecture is described in 3GPP TS 23.228 [2]. The underlying reference model and stage 2 information is described in Annex G of 3GPP TS 23.228 [2] and in 3GPP TS 23.334 [23]. + +This specification describes the application of H.248 on the Iq interface (see Figure 1). Required extensions use the H.248 standard extension mechanism. In addition certain aspects of the base protocol H.248 are not needed for this interface and thus excluded by this profile. + +![Figure 1: Reference model for IMS access. The diagram shows a UE connected to an IP-CAN, which is connected to a P-CSCF via a Gm interface. The P-CSCF contains an IMS-ALG. The IMS-ALG is connected to an IMS Access Gateway via an Iq interface. The IMS Access Gateway contains a NAT. A dashed box labeled 'Scope of this specification.' is around the IMS-ALG and the Iq interface. Media flows from the IP-CAN through the IMS Access Gateway.](c9d8a18a6137ad054b841d7a614afb48_img.jpg) + +``` +graph TD + UE[UE] --- IP_CAN((IP-CAN)) + IP_CAN -.->|Gm| P_CSCF[P-CSCF] + P_CSCF --- IMS_ALG[IMS-ALG] + IMS_ALG ---|Iq| IMS_AGW[IMS Access Gateway] + IMS_AGW --- NAT[NAT] + IP_CAN ---|Media| IMS_AGW + subgraph Scope_of_this_specification [Scope of this specification.] + IMS_ALG + Iq + end +``` + +Figure 1: Reference model for IMS access. The diagram shows a UE connected to an IP-CAN, which is connected to a P-CSCF via a Gm interface. The P-CSCF contains an IMS-ALG. The IMS-ALG is connected to an IMS Access Gateway via an Iq interface. The IMS Access Gateway contains a NAT. A dashed box labeled 'Scope of this specification.' is around the IMS-ALG and the Iq interface. Media flows from the IP-CAN through the IMS Access Gateway. + +**Figure 1: Reference model for IMS access** + +The reference model for the IMS-ALG and the IMS-AGW supporting the ATCF/ATGW function is shown in Figure 1a below. + +![Figure 1a: Reference model for IMS-ALG/IMS-AGW with ATCF/ATGW function](d0abac95583b52a3b35f74a215567334_img.jpg) + +The diagram shows a UE with two access types: CS access and PS access. + - CS access connects to an MSC Server via the Mc interface. + - The MSC Server connects to a P-CSCF via the Mw/I2 interface. + - CS access also connects to a CS-MGW. + - PS access connects to the PS Access domain. + - A 'PS-to-CS Access Transfer' path is shown between PS access and the MSC Server. + - The P-CSCF contains an IMS-ALG (ATCF) and connects to the IMS (I/S-CSCF, SCC AS) via the Mw/Mx interface. + - The P-CSCF connects to an IMS-AGW (ATGW) via the Iq interface, which is labeled 'Scope of this specification.' + - The IMS-AGW (ATGW) contains a NAT and connects to the IM Core domain via the Mb interface. + - Media paths are shown from the CS-MGW and PS Access domain towards the IM Core domain via Mb interfaces. + +Figure 1a: Reference model for IMS-ALG/IMS-AGW with ATCF/ATGW function + +**Figure 1a: Reference model for IMS-ALG/IMS-AGW with ATCF/ATGW function** + +See 3GPP TS 23.237 [38] clause 5.2 for a comprehensive description of the reference model. + +The reference model for the P-CSCF enhanced for WebRTC (eP-CSCF) and the IMS-AGW enhanced for WebRTC (eIMS-AGW) to support WebRTC client access to IMS is shown in Figure 1b as below, see 3GPP TS 23.228 [2] Annex U for a comprehensive description of the reference model. + +![Figure 1b: Reference Architecture for eP-CSCF/eIMS-AGW supporting WebRTC access to IMS](07b17a620c75522d53916a11e12d1bff_img.jpg) + +The diagram shows a UE containing a WIC (WebRTC IMS Client). + - The WIC connects to a WWSF (WebRTC Web Server Function) via the W1 interface. + - The WWSF connects to a WAF (WebRTC Authorization Function) via the W4 interface. + - The WAF connects to an eP-CSCF via the W5 interface. + - The UE/WIC also connects through a NAT, IP-CAN, and PCEF (dashed boxes). + - The WIC connects to the eP-CSCF via the W2 interface. + - The eP-CSCF contains an IMS-ALG and connects to the I/S-CSCF via the Mw interface. + - The eP-CSCF connects to an eIMS-AGW via the Iq interface. + - The eP-CSCF connects to an H/V-PCRF via the Rx interface. + - The H/V-PCRF connects to the IP-CAN via the Gx interface. + - A media path (W3) is shown between the WIC and the eIMS-AGW. + +Figure 1b: Reference Architecture for eP-CSCF/eIMS-AGW supporting WebRTC access to IMS + +**Figure 1b: Reference Architecture for eP-CSCF/eIMS-AGW supporting WebRTC access to IMS** + +NOTE: The presence of dashed elements in the figure depends on the configuration. +PCC functional elements are present only for EPC access with QoS. +The corresponding PCC elements for fixed access are also optionally supported but not shown. +The NAT in figure 1b is meant for non-cellular access to IMS. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [3] ETSI TS 183 018 V3.5.1 (2009-07): "Telecommunications and Internet converged Services and Protocols for Advanced Networking (TISPAN); Resource and Admission Control: H.248 Profile Version 3 for controlling Border Gateway Functions (BGF) in the Resource and Admission Control Subsystem (RACS); Protocol specification". +- [4] ITU-T Recommendation H.248.37 (06/2008): "Gateway control protocol: IP NAT traversal package". +- [5] ITU-T Recommendation H.248.57 (10/2014): "Gateway control protocol: RTP Control Protocol Package". +- [6] ITU-T Recommendation H.248.43 (06/2008): "Gateway control protocol: Gate Management and Gate Control packages". +- [7] ITU-T Recommendation H.248.53 (03/2009): "Gateway control protocol: Traffic management packages". +- [8] ITU-T Recommendation H.248.41 Amendment 1 (06/2008): "Gateway control protocol: IP domain connection package: IP Realm Availability Package". +- [9] ITU-T Recommendation H.248.36 (09/2005): "Gateway control protocol: Hanging Termination Detection package". +- [10] ITU-T Recommendation H.248.1 (05/2002): "Gateway Control Protocol: Version 2" including the Corrigendum1 for Version 2 (03/04). +- [11] ITU-T Recommendation H.248.14 (03/2009): "Gateway control protocol: Inactivity timer package". +- [12] ITU-T Recommendation H.248.52 (06/2008): "Gateway control protocol: QoS support packages". +- [13] ITU-T Recommendation H.248.11 (11/2002): "Gateway control protocol: Media gateway overload control package". +Inclusive Corrigendum 1 (06/2008) to H.248.11 " Gateway control protocol: Media gateway overload control package: Clarifying MG-overload event relationship to ADD commands". +- [14] ITU-T Recommendation H.248.10 (07/2001): "Media gateway resource congestion handling package". +- [15] IETF RFC 5234 (2008): "Augmented BNF for Syntax Specifications: ABNF". +- [16] IETF RFC 4960 (2007): "Stream control transmission protocol". +- [17] IETF RFC 4566 (2006): "SDP: Session Description Protocol". +- [18] IETF RFC 4975 (2007): "The Message Session Relay Protocol (MSRP)". +- [19] IETF RFC 3551 (2003): "RTP Profile for Audio and Video Conferences with Minimal Control". +- [20] IETF RFC 4145 (2005): "TCP-Based Media Transport in the Session Description Protocol (SDP)". +- [21] IETF RFC 3605 (2003): "Real Time Control Protocol (RTCP) attribute in Session Description Protocol (SDP)". + +- [22] ITU-T Recommendation X.690 (11/2008): "ASN.1 encoding rules: Specification of Basic Encoding Rules (BER), Canonical Encoding Rules (CER) and Distinguished Encoding Rules (DER)". +- [23] 3GPP TS 23.334: "IMS Application Level Gateway (IMS-ALG) – IMS Access Gateway (IMS-AGW) interface: Procedures Descriptions". +- [24] ITU-T Recommendation H.248.40 (01/2007): "Gateway control protocol: Application Data Inactivity Detection package". +- [25] IETF RFC 4585 (2006): "Extended RTP Profile for Real-time Transport Control Protocol (RTCP) - Based Feedback (RTP/AVPF)". +- [26] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia telephony; Media handling and interaction". +- [27] 3GPP TS 33.210: "Technical Specification Group Services and System Aspects;3G Security; Network Domain Security; IP Network Layer Security". +- [28] IETF RFC 3556 (2003): "Session Description Protocol (SDP) Bandwidth Modifiers for RTP Control Protocol (RTCP) Bandwidth". +- [29] IETF RFC 4568 (2006): "Session Description Protocol (SDP) Security Descriptions for Media Streams". +- [30] IETF RFC 3711 (2004): "The Secure Real-time Transport Protocol (SRTP)". +- [31] IETF RFC 5124 (2008): "Extended Secure RTP Profile for Real-time Transport Control Protocol (RTCP)-Based Feedback (RTP/SAVPF)". +- [32] IETF RFC 2216 (1997): "Network Element Service Specification Template". +- [33] Supplement 7 to ITU-T H-series Recommendations H.Sup7 (05/2008):" Gateway control protocol: Establishment procedures for the H.248 MGC-MG control association". +- [34] 3GPP TS 33.328: "IMS Media Plane Security". +- [35] Void +- [36] Void +- [37] Void +- [38] 3GPP TS 23.237: "IP Multimedia subsystem (IMS) Service Continuity; Stage 2". +- [39] 3GPP TS 22.153: "Multimedia Priority Service". +- [40] ITU-T Recommendation H.248.82 (03/2013): "Gateway control protocol: Explicit Congestion Notification Support". +- [41] IETF RFC 5285 (2008): "A General Mechanism for RTP Header Extensions". +- [42] IETF RFC 6236: "Negotiation of Generic Image Attributes in the Session Description Protocol (SDP)". +- [43] ITU-T Recommendation H.248.50 (07/2016): "Gateway control protocol: NAT traversal toolkit packages". +- [44] Void +- [45] 3GPP TS 24.229: "IP Multimedia Call Control Protocol based on SIP and SDP". +- [46] ITU-T Recommendation H.248.84 (07/2012): "Gateway control protocol: NAT traversal for peer-to-peer services". +- [47] ITU-T Recommendation H.248.89 (10/2014): "Gateway control protocol: TCP support packages". + +- [48] ITU-T Recommendation H.248.90 (10/2014): "Gateway control protocol: ITU-T H.248 packages for control of transport security using transport layer security (TLS)". +- [49] ITU-T Recommendation H.248.92 (10/2014): "Gateway control protocol: Stream endpoint interlinkage package". +- [50] ITU-T Recommendation H.248.93 (10/2014): "Gateway control protocol: ITU-T H.248 support for control of transport security using the datagram transport layer security (DTLS) protocol". +- [51] IETF RFC 793: "Transmission Control Protocol – DARPA Internet Program – Protocol Specification". +- [52] IETF RFC 4582: "The Binary Floor Control Protocol (BFCP)". +- [53] Void" +- [54] Void +- [55] IETF RFC 8122: "Connection-Oriented Media Transport over the Transport Layer Security (TLS) Protocol in the Session Description Protocol (SDP)". +- [56] ITU-T Recommendation H.248.78 (11/2015): "Gateway control protocol: Bearer-level message backhauling and application level gateway". +- [57] IETF RFC 6714: "Connection Establishment for Media Anchoring (CEMA) for the Message Session Relay Protocol (MSRP)". +- [58] IETF RFC 7675: "Session Traversal Utilities for NAT (STUN) Usage for Consent Freshness". +- [59] IETF RFC 5761: "Multiplexing RTP Data and Control Packets on a Single Port". +- [60] IETF RFC 5763: "Framework for Establishing a Secure Real-time Transport Protocol (SRTP) Security Context Using Datagram Transport Layer Security (DTLS)". +- [61] IETF RFC 5764: "Datagram Transport Layer Security (DTLS) Extension to Establish Keys for the Secure Real-time Transport Protocol (SRTP)". +- [62] IETF RFC 4573: "MIME Type Registration for RTP Payload Format for H.224". +- [63] ITU-T Recommendation H.224 (01/2005): "A real time control protocol for simplex applications using the H.221 LSD/HSD/MLP channels". +- [64] ITU-T Recommendation H.281 (11/1994): "A far end camera control protocol for videoconferences using H.224". +- [65] ITU-T Recommendation H.248.96 (11/2015): "Gateway control protocol: H.248 support for control of SCTP bearer connections". +- [66] ITU-T Recommendation H.248.97 (11/2015): "Gateway control protocol: H.248 support for control of SCTP bearer connections". +- [67] ITU-T Recommendation H.248.94 (11/2015): "Gateway control protocol: Web-based real-time communication services – H.248 protocol support and profile guidelines". +- [68] IETF RFC 8841: "Session Description Protocol (SDP) Offer/Answer Procedures for Stream Control Transmission Protocol (SCTP) over Datagram Transport Layer Security (DTLS) Transport". +- [69] IETF RFC 8864: "Negotiation Data Channels Using the Session Description Protocol (SDP)". +- [70] IETF RFC 8873: "Message Session Relay Protocol (MSRP)". +- [71] ITU-T Recommendation H.248.88 (01/2014): "Gateway control protocol: RTP topology dependent RTCP handling by ITU-T H.248 media gateways with IP terminations". +- [72] IETF RFC 5939: "Session Description Protocol (SDP) Capability Negotiation". + +- [73] ITU-T Recommendation H.248.80 (01/2014): "Gateway control protocol: Usage of the revised SDP offer/answer model with ITU-T H.248". +- [74] IETF RFC 8858: "Indicating Exclusive Support of RTP and RTP Control Protocol (RTCP) Multiplexing Using the Session Description Protocol (SDP)". +- [75] ITU-T Recommendation T.140 (02/98): "Text conversation presentation protocol". +- [76] IETF RFC 4103: "RTP Payload for Text Conversation". +- [77] IETF RFC 8865: "T.140 Real-Time Text Conversation over WebRTC Data Channels". +- [78] IETF RFC 5104: "Codec Control Messages in the RTP Audio-Visual Profile with Feedback (AVPF)". +- [79] IETF RFC 7728: "RTP Stream Pause and Resume". +- [80] IETF RFC 8445: "Interactive Connectivity Establishment (ICE): A Protocol for Network Address Translator (NAT) Traversal". +- [81] IETF RFC 8839: "Session Description Protocol (SDP) Offer/Answer Procedures for Interactive Connectivity Establishment (ICE)". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions apply. + +**Address:** term used for "network address" (IP address) + +**End-to-access edge security:** media protection extending between an IMS UE and the first IMS core network node in the media path without being terminated by any intermediary node. + +**Port:** term used for "transport port" (L4 port). + +**Transcoding:** transcoding in general is the translation from one type of encoded media format to another different media format, e.g. G.711 A-law to $\mu$ -law or vice versa, G.729 to AMR with 4.75 rate. + +NOTE 1: The definition of "transcoding" is according clause 3.10 of ITU-T Recommendation V.152 [23]. + +NOTE 2: Transcoding belongs to the category of "media aware" IP-to-IP interworking. + +**Transparent Forwarding:** media gateway packet forwarding behaviour with the characteristic of Lx-PDU integrity. This is a unidirectional characteristic of an Lx-PDU flow. + +NOTE 3: The definition is according clause 3.2.10 of ITU-T Recommendation H.248.88 [71]. + +NOTE 4: The semantic covers both traffic directions when applied on H.248 Streams (due to their inherent characteristic of bidirectionality). + +**Transport Address:** term used for the combination of a *Network Address* and a *Transport Port*. + +For the purposes of the present document, the following terms and definitions as defined in 3GPP TS 23.334 [23] apply: + +**ICE lite** + +**Full ICE.** + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|----|----------------------------------------------------------------------------------------------------------| +| Iq | Interface between the IMS Application Level Gateway (ALG) (IMS-ALG) and the IMS Access Gateway (IMS-AGW) | +|----|----------------------------------------------------------------------------------------------------------| + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations defined in 3GPP TR 21.905 [1] apply, with the following additions. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-----------|------------------------------------------------------------------------------------------| +| ABNF | Augmented Backus-Naur Form | +| ATCF | Access Transfer Control Function | +| ATGW | Access Transfer Gateway | +| B-ALG | Bearer Level Application-Level Gateway | +| BFCP | Binary Floor Control Protocol | +| CCM | Codec Control Messages | +| CVO | Coordination of Video Orientation | +| DBI | Delay Budget Information | +| DSCP | Differentiated Service Code Point | +| e2ae | End-to-Access-Edge (security model) | +| ECN | Explicit Congestion Notification | +| eIMS-AGW | IMS Access Gateway enhanced for WebRTC | +| eP-CSCF | P-CSCF enhanced for WebRTC | +| EVS | Enhanced Voice Services | +| FECC | Far End Camera Control | +| FIR | Full Intra Request | +| GTT | Global Text Telephony | +| ICE | Interactive Connectivity Establishment | +| IMS-AGW | IMS Access Gateway | +| IMS-ALG | IMS Application Level Gateway | +| IP | Internet Protocol | +| IVAS | Immersive Voice and Audio Services | +| LD | Local Descriptor (H.248 protocol element) | +| MG | Media Gateway | +| MGC | Media Gateway Controller | +| MPS | Multimedia Priority Service | +| MSRP | Message Session Relay Protocol | +| MTSI | Multimedia Telephony Service for IMS | +| NA | Not Applicable | +| NAPT | Network Address and Port Translation | +| NAPT-PT | NAPT and Protocol Translation | +| NAT | Network Address Translation | +| RD | Remote Descriptor (H.248 protocol element) | +| ROI | Region of Interest | +| RTCP | RTP Control Protocol | +| SCTP | Stream Control Transport Protocol | +| SDP | Session Description Protocol | +| SDPCapNeg | SDP Capability Negotiation | +| SRVCC | Single Radio Voice Call Continuity | +| STUN | Session Traversal Utilities for NAT | +| TCP | Transmission Control Protocol | +| TLS | Transport Layer Security (protocol) | +| TMMBN | Temporary Maximum Media Stream Bit Rate Notification | +| TMMBR | Temporary Maximum Media Stream Bit Rate Request | +| ToS | Type-of-Service | +| TISPAN | Telecommunications and Internet converged Services and Protocols for Advanced Networking | +| WebRTC | Web Real Time Communication | +| WIC | WebRTC IMS Client | +| WWSF | WebRTC Web Server Function | + +# 4 Applicability + +The support of the Iq interface capability set shall be identified by the H.248 Iq profile and support of this profile shall be indicated in H.248 ServiceChange procedure (during the (re-)registration phase(s)). + +## 4.1 Architecture + +See Annex G and Annex U of 3GPP TS 23.228 [2]. + +# 5 Profile Description + +## 5.1 Profile Identification + +**Table 5.1.1: Profile Identification** + +| | | +|----------------------|------------------| +| Profile name: | threeeglq | +| Version: | 7 | + +## 5.2 Summary + +This Profile describes the minimum mandatory settings and procedures required to fulfil the requirements of the Iq interface (see 3GPP TS 23.334 [23]): + +- allocation and translation of IP addresses and port numbers (NA(P)T and NA(P)T-PT); +- opening and closing gates (i.e. packets filtering depending on "IP address / port"); +- remote NA(P)T traversal; +- policing of incoming traffic; +- QoS packet marking for outgoing traffic; +- IP realm/domain indication; +- Hanging termination detection; and +- RTCP handling; + +and when ATCF/ATGW is supported: + +- handover of bearer connections between PS and CS access networks; +- IP version interworking; and +- audio transcoding; + +and when WebRTC is supported: + +- interworking for WebRTC audio, video and optionally MSRP data between WebRTC clients and non-WebRTC user equipment; and +- optionally transparent forwarding of WebRTC bearer traffic in case of end-to-end WebRTC calls between WebRTC IMS clients. + +In addition, optional settings and procedures are described which fulfil optional features and where supported, the minimum mandatory settings within the optional procedures and packages are identified that must be supported in order to support that feature. + +"Optional" or "O" means that it is optional for either the sender or the receiver to implement an element. If the receiving entity receives an optional element that it has not implemented it should send an Error Code (e.g. 445 "Unsupported or Unknown Property", 501 "Not Implemented", etc.). "Mandatory" or "M" means that it is mandatory for the receiver to implement an element. Whether it is mandatory for the sender to implement depends on specific functions; detail of whether elements of the core protocol are mandatory to be sent are defined in the stage 2 procedures, stage 3 procedures and/or the descriptions of individual packages. + +The setting or modification of elements described in the profile under the heading "Used in Command" has the meaning that the property can be set/modified with that command. The property may be present in other commands (in order to preserve its value in accordance with ITU-T Recommendation H.248.1 [10]) when those commands are used for other procedures that affect the same descriptor. + +## 5.3 Gateway Control Protocol Version + +Version 2 (ITU-T Recommendation H.248.1 [10]) shall be used as minimum protocol version. + +## 5.4 Connection model + +**Table 5.4.1: Connection Model** + +| | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| Maximum number of contexts: | Provisioned | +| Maximum number of terminations per context: | 3 | +| Allowed terminations type combinations: | (IP,IP) ;
(IP,IP,IP) (NOTE) | +| NOTE: This is only a temporary context configuration, occurring during bearer access transfer phase (between PS to CS access networks or vice versa) or during the reservation of two sets of transport addresses/resources towards the access network to support the functionalities related to the Alternate Connectivity functionality (see 3GPP TS 23.334 [23]). | | + +## 5.5 Context attributes + +**Table 5.5.1: Context Attributes** + +| Context Attribute | Supported | Values Supported | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|-------------------------| +| Topology | Yes (NOTE 1) | See clause 5.7.9 | +| Priority Indicator | Optional (NOTE 2) | 0-15 (NOTE 3) | +| Emergency Indicator | Yes | YES/NO | +| IEPS Indicator | No | NA | +| ContextAttribute Descriptor | No | NA | +| ContextIdList Parameter | No | NA | +| AND/OR Context Attribute | No | NA | +| NOTE 1: Stream ID in Topology Descriptor shall not be supported (because only used for SRVCC service support, which is a monomedia type of call ("voice call"). | | | +| NOTE 2: This Context Attribute parameter is allowed in ETSI TISPAN Ia Profile version 3. It is also used for MPS as specified in 3GPP TS 22.153 [39]. | | | +| NOTE 3: Priority values 11 – 15 of the Priority Indicator are reserved for MPS. | | | + +## 5.6 Terminations + +### 5.6.1 Termination names + +#### 5.6.1.1 IP Termination + +##### 5.6.1.1.1 ABNF Coding Overview and prose specification + +The Termination ID structure shall follow the guidelines of H.248 and shall be based on four fields: + +- "ip///". + +The individual fields are described and defined in table 5.6.1.1.1.1. + +**Table 5.6.1.1.1.1: IP Termination Fields** + +| Name | Description | Values | CHOOSE Wildcard | ALL Wildcard | +|-----------|----------------------------------------------------------------------------------------------------------------------------|------------------------------------------|-----------------|--------------| +| ip | "ip" is a fixed prefix identifying the termination | "ip" | No | No | +| Group | Group of Interface and Id | Integer (0-65535) | Yes (NOTE 5) | Yes | +| Interface | Logical or physical interface to a network to/from which the termination will be sending/receiving media. (NOTE 1, NOTE 2) | String of max 51 alphanumeric characters | Yes (NOTE 4) | Yes | +| Id | Termination specific identifier (NOTE 3) | Non-zero 32 bit integer | Yes (NOTE 4) | Yes | + +NOTE 1: A specific may be used together with different groups. +NOTE 2: The generic field may relate specifically to an "IP interface", "protocol layer 2 interface" or others. +NOTE 3: The combination of Interface and Id is unique. +NOTE 4: The MGC shall always use CHOOSE in an ADD request command. If not, the MG shall reply with an error descriptor using error code #501 "Not Implemented". +NOTE 5: The CHOOSE wildcard on 'Group' is *not* allowed in ETSI TISPAN "Ia Profiles". + +NOTE: The IMS-ALG has the ability to choose the address space in which the IMS-AGW will allocate an IP address for the termination by using the *ipdc/realm* property defined in the ITU-T Recommendation H.248.41 IP domain connection package. + +H.248 wildcarding may be applied on IP Termination Identifiers. Wildcarding is limited according the two columns on the right hand side. + +The corresponding ABNF grammar is given below. + +ABNF (IETF RFC 5234 [15]) is used for the syntax specification. The ABNF for TerminationID and relation to pathNAME is defined in annex B.2/ ITU-T Recommendation H.248.1 [10]. + +``` + +pathNAME = EphToken SLASH EPHsystem +EphToken = "ip" ; prefix +EPHsystem = WildcardALL + / WildcardALL SLASH Interface + / Group SLASH WildcardALL + / (Group / WildcardCHOOSE) SLASH (Interface / WildcardCHOOSE) SLASH (Identifier + / WildcardALL / WildcardCHOOSE) +Group = %d0-65535 ; data type: INT16 +Interface = 1*51ALPHANUM +Identifier = %d1-4294967295 ; data type: INT32 +ALPHANUM = ALPHA / DIGIT +WildcardCHOOSE = "$" +WildcardALL = "*" + +``` + +##### 5.6.1.1.2 ASN.1 Coding Overview and prose specification + +The following general structure of termination ID shall be used: + +4 octets shall be used for the termination ID. The following defines the general structure for the termination ID: + +**Table 5.6.1.1.2.1: ASN.1 coding** + +| | | +|------------------|---| +| Termination type | X | +|------------------|---| + +Termination type: + +Length 3 bits + +Values: + +000 Reserved + +001 IP (Ephemeral) termination + +010 Reserved (in 3GPP Mc and Mn profile used for TDM termination) + +011 - 110 Reserved + +111 Reserved for ROOT termination Id (ROOT Termination ID = 0xFFFFFFFF) + +X: + +Length 29 bits. + +For IP termination, its usage is un-specified. + +### 5.6.2 Multiplexed terminations + +**Table 5.6.2.1: Multiplexed terminations** + +| | | +|------------------------------------------|----| +| Multiplex terminations supported? | No | +|------------------------------------------|----| + +*If yes, then:* + +**Table 5.6.2.2: Multiplex Types** + +| | | +|--------------------------------------------------------------|----| +| Multiplex types supported | NA | +| Maximum number of terminations connected to multiplex | NA | + +## 5.7 Descriptors + +### 5.7.1 TerminationState Descriptor + +**Table 5.7.1.1: ServiceState property** + +| | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------| +| ServiceState property used: | Yes (InService/OutOfService) NOTE 1, NOTE 2 | +| NOTE 1: This is restricted to the ROOT termination (for MGW audit). | | +| NOTE 2: Ephemeral H.248 Terminations have a ServiceState property according to ITU-T Recommendation H.248.1 [10], but explicit usage of the TerminationState Descriptor ServiceState property is not required by this Profile. ServiceState changes can still occur, however, and can be indicated in ServiceChange Commands (i.e. this means that the value of the ServiceState property may be implicitly changed by ServiceChange procedures). | | + +**Table 5.7.1.2: EventBufferControl property** + +| | | +|------------------------------------------|----| +| EventBufferControl property used: | No | +|------------------------------------------|----| + +**Table 5.7.1.3: Group semantics property** + +| | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| Group semantics property used: | Yes | +| NOTE: This is restricted to ephemeral H.248 Terminations used for WebRTC service support. The property is used in conjunction with the media grouping package, see clause 5.14.3.23. | | + +**Table 5.7.1.4: SDPCapNeg Extensions property** + +| | | +|------------------------------------------------------------------------------------------------------------------------------------|-----| +| SDPCapNeg Extensions property used: | Yes | +| NOTE: The property is used in conjunction with the Enhanced Revised Offer/Answer SDP Support package, see clause 5.14.3.x1. | | + +### 5.7.2 Stream Descriptor + +#### 5.7.2.0 General + +**Table 5.7.2.1: Stream descriptors** + +| Maximum number of streams per termination type | IP | Unspecified (NOTE 1, NOTE 2) | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|------------------------------| +| NOTE 1: At least one stream for each media component (e.g. video+audio = 2 streams). If only one stream is applicable, then the IMS-ALG may omit the Stream Descriptor and the IMS-AGW shall assume that StreamID = 1.
NOTE 2: An IP termination for WebRTC may carry additional H.248 (de-)aggregation streams besides the legacy H.248 component streams. | | | + +**Table 5.7.2.2: Stream configuration** + +| | | +|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Stream configuration: | ALL configurations are allowed.
IP terminations for WebRTC may apply H.248 stream grouping principles, which leads to relationships of associated H.248 streams within such stream group configurations. | +|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +#### 5.7.2.1 LocalControl Descriptor + +**Table 5.7.2.1.1: LocalControl Descriptor and Reserve properties** + +| | | Termination Type | Stream Type | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|------------------|-------------------------------| +| ReserveGroup used: | No | NA | NA | +| ReserveValue used: | Yes | IP | Audio, Video (NOTE 1, NOTE 2) | +| NOTE 1: The value of the H.248 Stream Type is given here by the SDP "m=" line element media type (in contrast to the SDP "m=" line element transport protocol in Table 5.7.2.1.2). Usage of ReserveValue implies thus media type aware Local and Remote Descriptors.
NOTE 2: Not used (at this profile version (see clause 5.1 for the version number)) for TCP transport (IETF RFC 793 [51]) and media types:
a) "Message" (for MSRP (IETF RFC 4975 [18]) and
b) "Application" (for BFCP (IETF RFC 4582 [52]) and ROI FECC (IETF RFC 4573 [62])) because the application control will not use them in context ReserveValue. | | | | + +Table 5.7.2.1.2: Allowed Stream Modes + +| Termination Type | Stream Type | Allowed StreamMode Values | +|------------------|-------------------------------|----------------------------------------| +| IP | RTP/AVP | SendOnly, RecvOnly, SendRecv, Inactive | +| | RTP/SAVP | SendOnly, RecvOnly, SendRecv, Inactive | +| | RTP/AVPF | SendOnly, RecvOnly, SendRecv, Inactive | +| | RTP/SAVPF | SendOnly, RecvOnly, SendRecv, Inactive | +| | TCP (NOTE 1) | SendRecv, Inactive | +| | TCP/MSRP (NOTE 1) | SendRecv, Inactive | +| | TCP/TLS (NOTE 1) | SendOnly, RecvOnly, SendRecv, Inactive | +| | TCP/TLS/MSRP (NOTE 1, NOTE 2) | SendOnly, RecvOnly, SendRecv, Inactive | +| | UDPTL | SendRecv, Inactive | +| | UDP | SendOnly, RecvOnly, SendRecv, Inactive | +| | UDP/DTLS | SendOnly, RecvOnly, SendRecv, Inactive | +| | UDP/DTLS/SCTP (NOTE 3) | SendOnly, RecvOnly, SendRecv, Inactive | + +NOTE 1: The H.248 StreamMode does not affect protocol control information at the bearer interface. See clause 7.1.7.1.1 in ITU-T Recommendation H.248.1 [10] and: +a) TCP: ITU-T Recommendation H.248.89 [47], clause 8.6.4.1, Table "*Impact of StreamMode on TCP bearer traffic at external MG interface*" +b) TLS: ITU-T Recommendation H.248.90 [48], clause 8.6.4.1, Table "*Impact of StreamMode on TLS bearer traffic at external MG interface*". + +NOTE 2: Conditional support, dependent on support of application-aware interworking. + +NOTE 3: Conditional support, dependent on WebRTC service with data application(s). + +Table 5.7.2.1.3: LocalControl Descriptor and other properties + +| | Termination Type | Stream Type | +|-----------------------------------------------------------------------------|------------------|---------------| +| Stream Aggregation used: | No | NA | +| Stream De-aggregation used: | Yes | IP for WebRTC | +| NOTE: Conditional, dependent on WebRTC calls with multiple data components. | | | + +### 5.7.3 Events descriptor + +Table 5.7.3.1: Events Descriptor + +| | | | | +|---------------------------------------------------------------|---------------------------------------------------------------------------|-------------------------|--------------------| +| Events settable on termination types and stream types: | Yes | | | +| If yes | EventID | Termination Type | Stream Type | +| | Cause (g/cause, 0x0001/0x0001) - See clause 5.14.3.1 | ALL except ROOT | ANY | +| | Inactivity Timeout (it/ito, 0x0045/0x0001) - See clause 5.14.3.6 | only ROOT | Not applicable | +| | MG_Overload (ocp/mg_overload, 0x0051/0x0001) - See clause 5.14.3.8 | only ROOT | Not applicable | +| | Termination Heartbeat (hangterm/thb, 0x0098/0x0001) - See clause 5.14.3.9 | ALL except ROOT | ANY | + +| | | | +|---------------------------------------------------------------------------------------------------|-----------------|-------------------------------------------------| +| MGCon (chp/mgcon, 0x0029/0x0001) – See clause 5.14.3.10 | only ROOT | Not Applicable | +| Available Realms Changed (ipra/arc, 0x00e0/0x0001) – See clause 5.14.3.11 | only ROOT | Not Applicable | +| IP Flow Stop Detection (adid/ipstop, 0x009c/0x0001) – See clause 5.14.3.14 | ALL except ROOT | Any | +| ECN Failure (ecnrous/fail, 0x010b/0x0001) see clause 5.14.3.15 | IP | RTP based | +| ICE New Peer Reflexive Candidate (ostuncc/nprc, 0x00c3/0x0002) – see clause 5.14.3.17 | IP | Any, only applicable for full ICE | +| ICE Connectivity Check Result (ostuncc/ccr, 0x00c3/0x0001) – see clause 5.14.3.17 | IP | Any, only applicable for full ICE | +| TCP connection state change ("BNC change") (tcpbcc/BNCChange, 0x0115/0x0001) see clause 5.14.3.18 | IP | TCP based | +| TLS session state change ("BNC change") (tlsbsc/BNCChange, 0x0117/0x0001) see clause 5.14.3.19 | IP | TLS or DTLS based | +| STUN Consent Request Failure (stnconfres/constate, 0x0120/0x0002) see clause 5.14.3.22 | IP | TLS or DTLS based, only applicable for full ICE | +| SCTP connection state change (sctpbcc/BNCChange, 0x0121/0x0001) see clause 5.14.3.24 | IP | SCTP based | +| Detect outgoing SCTP stream reset (sctpreset/detreset, 0x0122/0x0001) see clause 5.14.3.25 | IP | SCTP based | +| Outgoing SCTP stream reset result (sctpreset/result, 0x0122/0x0002) see clause 5.14.3.25 | IP | SCTP based | + +Table 5.7.3.2: Event Buffer Control + +| | | +|---------------------------|----| +| EventBuffer Control used: | No | +|---------------------------|----| + +Table 5.7.3.3: Keep active + +| | | +|----------------------------|----| +| KeepActive used on events: | No | +|----------------------------|----| + +Table 5.7.3.4: Embedded events and signals + +| | | +|-------------------------------------------|----| +| Embedded events in an Events Descriptor: | No | +| Embedded signals in an Events Descriptor: | No | + +Table 5.7.3.5: Regulated Embedded events + +| | | +|---------------------------------------------|------| +| Regulated Embedded events are triggered on: | None | +|---------------------------------------------|------| + +Table 5.7.3.6: ResetEventsDescriptor + +| | | +|-----------------------------------------|------| +| ResetEventsDescriptor used with events: | None | +|-----------------------------------------|------| + +Table 5.7.3.7: Notification Behaviour + +| | | +|------------------|------------| +| NotifyImmediate: | ALL Events | +| NotifyRegulated: | None | +| NeverNotify: | None | + +### 5.7.4 EventBuffer descriptor + +Table 5.7.4.1: Event Buffer Descriptor + +| | | | +|------------------------------|----------|---| +| EventBuffer Descriptor used: | No | | +| If yes | EventIDs | - | + +### 5.7.5 Signals descriptor + +Table 5.7.5.1: Signals Descriptor + +| | | | | +|----------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|-----------------------------------| +| The setting of signals is dependant on termination or streams types: | No
NOTE – "No" means that all signals can be played on any termination or stream. If "Yes", any signal not listed below may be played on any termination or stream, except Signals on ROOT termination shall not be supported. | | | +| If yes | SignalID | Termination Type | Stream Type / ID | +| | Latching (ipnapt/latch, 0x0099/0x0001) | ALL except ROOT | Any | +| | Send Additional Connectivity Check (ostuncc/sacc, 0x00c3/0x0002) | IP | Any, only applicable for full ICE | +| | Send Connectivity Check (ostuncc/scc, 0x00c3/0x0001) | IP | Any, only applicable for full ICE | +| | Establish BNC (tcpbcc/EstBNC, 0x0115/0x0001) see clause 5.14.3.18 | IP | TCP based | +| | Release BNC (tcpbcc/RelBNC, 0x0115/0x0002) see clause 5.14.3.18 | IP | TCP based | +| | Establish BNC (tlsbsc/EstBNC, 0x0117/0x0001) see clause 5.14.3.19 | IP | TLS or DTLS based | + +| | | | +|-----------------------------------------------------------------------------------------------------------|----|-------------------| +| Release BNC
(tlbsbc/RelBNC,
0x0117/0x0002) see
clause 5.14.3.19 | IP | TLS or DTLS based | +| Consent Test
(stnconfres/contst,
0x0120/0x0001) see
clause 5.14.3.22 | IP | TLS or DTLS based | +| Establish BNC
(scpbcc/EstBNC,
0x0121/0x0001) see
clause 5.14.3.24 | IP | SCTP based | +| Release BNC
(scpbcc/RelBNC,
0x0121/0x0002) see
clause 5.14.3.24 | IP | SCTP based | +| Initiate Outgoing SCTP
Stream Reset
(sctpreset/initreset,
0x0122/0x0001) see
clause 5.14.3.25 | IP | SCTP based | +| Outgoing SCTP Stream
Reset Response
(sctpreset/resetresp,
0x0122/0x0002) see
clause 5.14.3.25 | IP | SCTP based | + +Table 5.7.5.2: Signal Lists + +| | | | +|---------------------------------|----------------------------------------------------|---| +| Signals Lists supported: | No | | +| If yes | Termination Type Supporting Lists: | - | +| | Stream Type Supporting lists: | - | +| | Maximum number of signals to a signal list: | - | +| | Intersignal delay parameter supported: | - | + +Table 5.7.5.3: Overriding Signal type and duration + +| | | | +|--------------------------------------------|-----------------|----------------------------------| +| Signal type and duration supported: | No | | +| If yes | SignalID | Type or duration override | +| | - | - | + +Table 5.7.5.4: Signal Direction + +| | | | +|------------------------------------|----|--| +| Signal Direction supported: | No | | +|------------------------------------|----|--| + +Table 5.7.5.5: Notify completion + +| | | | +|------------------------------------|-----------------|-------------------------------------| +| NotifyCompletion supported: | No | | +| If yes | SignalID | Type of completion supported | +| | - | - | + +Table 5.7.5.6: RequestID Parameter + +| | | | +|---------------------------------------|----|--| +| RequestID Parameter supported: | No | | +|---------------------------------------|----|--| + +Table 5.7.5.7: Signals played simultaneously + +| | | | +|---------------------------------------|-----------------------------------------------------|--| +| Signals played simultaneously: | No | | +| If yes | SignalIDs that can be played simultaneously: | | + +Table 5.7.5.8: Keep active + +| | | +|------------------------------------|----| +| KeepActive used on signals: | No | +|------------------------------------|----| + +### 5.7.6 DigitMap descriptor + +Table 5.7.6.1: DigitMap Descriptor + +| | | | | +|-----------------------------|----------------------|------------------|---------------| +| DigitMaps supported: | No | | | +| If yes | DigitMap Name | Structure | Timers | +| | - | - | - | + +### 5.7.7 Statistics descriptor + +Table 5.7.7.1: Statistics Descriptor support + +| | | +|---------------------------------|---| +| Statistics supported on: | - | +|---------------------------------|---| + +Table 5.7.7.2: Statistics Report on Subtract + +| | | | +|-----------------------------------------|---------------------------------|---| +| Statistics reported on Subtract: | No | | +| If yes | StatisticalIDs reported: | - | + +### 5.7.8 ObservedEvents descriptor + +Table 5.7.8.1: ObservedEvents Descriptor + +| | | +|----------------------------------------|----| +| Event detection time supported: | No | +|----------------------------------------|----| + +### 5.7.9 Topology descriptor + +Table 5.7.9.1: Topology Descriptor + +| | | +|------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------| +| Allowed triples: | (T1, T2, isolate)
(T1, T2, bothway) | +| NOTE: The Topology Descriptor shall be supported by the MGW and MGC for handover only, when PS-to-CS access transfer is supported. | | + +### 5.7.10 Error descriptor + +**Table 5.7.10.1: Error Codes Sent by IMS-ALG** + +| | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported H.248.8 Error Codes: | #400 "Syntax error in message"
#401 "Protocol Error"
#402 "Unauthorized"
#403 "Syntax Error in TransactionRequest"
#406 "Version Not Supported"
#410 "Incorrect identifier"
#411 "The transaction refers to an unknown ContextID"
#413 "Number of transactions in message exceeds maximum"
#421 "Unknown action or illegal combination of actions"
#422 "Syntax Error in Action"
#430 "Unknown TerminationID"
#431 "No TerminationID matched a wildcard"
#442 "Syntax Error in Command"
#443 "Unsupported or Unknown Command"
#444 "Unsupported or Unknown Descriptor"
#445 "Unsupported or Unknown property"
#446 "Unsupported or Unknown Parameter"
#447 "Descriptor not legal in this command"
#448 "Descriptor appears twice in a command"
#449 "Unsupported parameter or property value"
#450 "No such property in this package"
#451 "No such event in this package"
#454 "No such parameter value in this package"
#455 "Property illegal in this Descriptor"
#456 "Property appears twice in this Descriptor"
#457 "Missing parameter in signal or event"
#458 "Unexpected Event/RequestID"
#501 "Not Implemented"
#502 "Not ready"
#505 "Transaction Request Received before a ServiceChange Reply has been received"
#506 "Number of TransactionPendings Exceeded"
#533 "Response exceeds maximum transport PDU size" | +| Supported Error Codes defined in packages: | All error codes defined in supported packages are supported. | +| NOTE: The error codes listed need not be supplied by the IMS-ALG to differentiate each and every error described by them. The IMS-AGW shall be able to receive the error codes listed. | | + +Table 5.7.10.2: Error Codes Sent by IMS-AGW: + +| | | +|---------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported H.248.8 Error Codes: | #400 "Syntax error in message"
#401 "Protocol Error"
#402 "Unauthorized"
#403 "Syntax Error in TransactionRequest"
#406 "Version Not Supported"
#410 "Incorrect identifier"
#411 "The transaction refers to an unknown ContextID"
#412 "No ContextIDs available"
#413 "Number of transactions in message exceeds maximum"
#421 "Unknown action or illegal combination of actions"
#422 "Syntax Error in Action"
#430 "Unknown TerminationID"
#431 "No TerminationID matched a wildcard"
#432 "Out of TerminationIDs or No TerminationID available"
#433 "TerminationID is already in a Context"
#434 "Max number of Terminations in a Context exceeded"
#435 "Termination ID is not in specified Context"
#440 "Unsupported or unknown Package"
#441 "Missing Remote or Local Descriptor"
#442 "Syntax Error in Command"
#443 "Unsupported or Unknown Command"
#444 "Unsupported or Unknown Descriptor"
#445 "Unsupported or Unknown property"
#446 "Unsupported or Unknown Parameter"
#447 "Descriptor not legal in this command"
#448 "Descriptor appears twice in a command"
#449 "Unsupported parameter or property value"
#450 "No such property in this package"
#451 "No such event in this package"
#452 "No such signal in this package"
#454 "No such parameter value in this package"
#455 "Property illegal in this Descriptor"
#456 "Property appears twice in this Descriptor"
#457 "Missing parameter in signal or event"
#471 "Implied Add for Multiplex failure"
#488 "Incorrect stream endpoint interlinkage"
#489 "Invalid aggregation and/or deaggregation"
#500 "Internal software Failure in MG or MGC"
#501 "Not Implemented"
#502 "Not ready"
#505 "Transaction Request Received before a ServiceChange Reply has been received"
#506 "Number of TransactionPendings Exceeded"
#510 "Insufficient resources"
#511 "Temporarily Busy"
#512 "Media Gateway unequipped to detect requested Event"
#513 "Media Gateway unequipped to generate requested Signals"
#515 "Unsupported Media Type"
#517 "Unsupported or invalid mode"
#522 "Functionality Requested in Topology Triple Not Supported"
#526 "Insufficient bandwidth"
#529 "Internal hardware failure in MG"
#530 "Temporary Network failure"
#531 "Permanent Network failure"
#532 "Audited Property, Statistic, Event or Signal does not exist"
#533 "Response exceeds maximum transport PDU size"
#534 "Illegal write of read only property"
#542 "Command is not allowed on this termination" | +| Supported Error Codes defined in packages: | All error codes defined in supported packages need to be supported. | + +NOTE: The error codes listed need not be supplied by the IMS-AGW to differentiate each and every error described by them. The IMS-ALG shall be able to receive the error codes listed. + +## 5.8 Command API + +### 5.8.1 Add + +**Table 5.8.1.1: Descriptors used by Command Add Request** + +| | | +|-----------------------------------------|-------------------------------------------------------------| +| Descriptors used by Add request: | Media (Stream(LocalControl, Local, Remote)), Event, Signals | +|-----------------------------------------|-------------------------------------------------------------| + +**Table 5.8.1.2: Descriptors used by Command Add Reply** + +| | | +|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Descriptors used by Add reply: |

Media (Stream (Local)), Error

When command request excludes an Audit Descriptor, the MGW response shall only include descriptors which contained underspecified or overspecified properties in the command request. Furthermore, only those properties that were underspecified or overspecified in the request shall be sent in the reply. Exceptions to this rule are:

  • - The Error Descriptor
  • - SDP properties returned in "Reserve AGW Connection Point" and "Reserve and Configure AGW Connection Point" procedures, as specified in 15.17.2.2 and 15.17.2.4.
| +|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### 5.8.2 Modify + +**Table 5.8.2.1: Descriptors used by Command Modify Request** + +| | | +|--------------------------------------------|--------------------------------------------------------------------------------| +| Descriptors used by Modify request: | Media (TerminationState, Stream (LocalControl, Local, Remote)), Signals, Event | +|--------------------------------------------|--------------------------------------------------------------------------------| + +**Table 5.8.2.2: Descriptors used by Command Modify Reply** + +| | | +|------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Descriptors used by Modify reply: |

Media (Stream(Local)), Error

When command request excludes an Audit Descriptor, the MGW response shall only include descriptors which contained underspecified or overspecified properties in the command request. Furthermore, only those properties that were underspecified or overspecified in the request shall be sent in the reply. Exceptions to this rule are:

  • - The Error Descriptor
  • - SDP properties returned in " Configure AGW Connection Point " procedure as specified in 15.17.2.3.
| +|------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### 5.8.3 Subtract + +**Table 5.8.3.1: Descriptor used by Command Subtract Request** + +| | | +|-----------------------------------------------------------|--------------------| +| Descriptors used by Subtract request: | None, Audit() NOTE | +| NOTE: This requests that no statistics are to be returned | | + +**Table 5.8.3.2: Descriptor used by Command Subtract Reply** + +| | | +|--------------------------------------------|-------------| +| Descriptors used by Subtract reply: | None, Error | +|--------------------------------------------|-------------| + +### 5.8.4 Move + +**Table 5.8.4.1: Command Move** + +| | | +|---------------------------|----| +| Move command used: | No | +|---------------------------|----| + +*If used:* + +**Table 5.8.4.2: Descriptor used by Move command** + +| | | +|------------------------------------------|---| +| Descriptors used by Move request: | - | +| Descriptors used by Move reply: | - | + +### 5.8.5 AuditValue + +**Table 5.8.5.1: Auditvalue** + +| Audited Properties: | Property Name and Identity | Descriptor | +|---------------------------------|--------------------------------------------|-----------------------------| +| | TerminationState:
- Root (MGW Audit) | TerminationState Descriptor | +| | For Packages:
Root | Packages Descriptor | +| | None (MGW Audit) :
- Root | Audit (empty) Descriptor | +| | IP Realm Availability :
- ipra/* (ROOT) | TerminationState Descriptor | +| | Base root properties:
- root/* (ROOT) | TerminationState Descriptor | +| | SDPCapNeg Extensions:
- sdpe/* | TerminationState Descriptor | +| Audited Statistics: | None | | +| Audited Signals: | None | | +| Audited Events: | None | | +| Packages Audit possible: | Yes | | + +### 5.8.6 AuditCapabilities + +**Table 5.8.6.1: Auditcapability** + +| Audited Properties: | Property Name and Identity | Descriptor | +|----------------------------|-----------------------------------|-------------------| +| | None | - | +| Audited Statistics: | None | | +| Audited Signals: | None | | +| Audited Events: | None | | + +**Table 5.8.6.2: Scoped Auditing** + +| | | +|-------------------------------------------------------------------------|------| +| Audited Properties / ContextAttributes used for a scoped audit : | None | +|-------------------------------------------------------------------------|------| + +### 5.8.7 Notify + +**Table 5.8.7.1: Descriptors Used by Notify Request** + +| | | +|-------------------------------------------|----------------| +| Descriptors used by Notify Request | ObservedEvents | +|-------------------------------------------|----------------| + +**Table 5.8.7.2: Descriptors Used by Notify Reply** + +| | | +|------------------------------------------|-------------| +| Descriptors used by Notify Reply: | None, Error | +|------------------------------------------|-------------| + +### 5.8.8 ServiceChange + +**Table 5.8.8.1: ServiceChangeMethods and ServiceChangeReasons sent by IMS-ALG:** + +| Service Change Methods Supported: | ServiceChange Reasons supported: | +|------------------------------------------|----------------------------------------------------------| +| Handoff (NOTE 2, NOTE 3) | "903 MGC Directed Change" (Optional, NOTE 4) | +| Restart (NOTE 2) | "901 Cold Boot" (Optional)
"902 Warm Boot" (Optional) | +| Forced (NOTE 2) | "905 Termination Taken Out Of Service" (Optional) | +| Graceful (NOTE 2) | "905 Termination Taken Out Of Service" (Optional) | + +NOTE 1: When a Service Change command on the Root termination with a method other than Graceful is sent, the command shall always be sent as the only command in a message. The sending node shall always wait for the reply to a Service Change command on the Root termination with a method other than Graceful before sending further command requests. A Service Change command on the Root termination with method Graceful may be combined with other commands in a single message. + +NOTE 2: ROOT Only. + +NOTE 3: Not involving more than 1 IMS-ALG. This does not preclude the use of the MGCId in a ServiceChange (Handoff) scenario, nor does it change the expected IMS-AGW behaviour upon receipt of such a message, as the IMS-AGW has actually no means to differentiate whether the ServiceChangeMgcId parameter that may be received in a ServiceChange (handoff) message relates to a logical IMS-ALG inside the same IMS-ALG server or is part of another IMS-ALG. + +NOTE 4: Support of this procedure is mandatory in the IMS-AGW. + +**Table 5.8.8.2: ServiceChangeMethods and ServiceChangeReasons sent by IMS-AGW:** + +| Service Change Methods Supported: | ServiceChange Reasons supported: | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Forced | "904 Termination Malfunction", ALL except ROOT (Optional, NOTE 4)
"905 Termination Taken Out Of Service" , ALL (Mandatory)
"906 Loss Of Lower Layer Connectivity" , ALL except ROOT (Optional, NOTE 4)
"907 Transmission Failure" , ALL except ROOT (Optional, NOTE 4)
"908 MG Impending Failure" ROOT only (Mandatory)
"910 Media Capability Failure" , ALL except ROOT (Optional, NOTE 4)
"915 State Loss" ROOT only (Optional, NOTE 4) | +| Graceful (NOTE 2) | "905 Termination Taken Out Of Service" , (Optional, NOTE 4)
"908 MG Impending Failure" (Optional, NOTE 4) | +| Disconnected (NOTE 2) | "900 Service Restored" (Mandatory)
"916 Packages Change" (Optional)
"917 Capability Change" (Optional) | +| Restart (NOTE 2) | "900 Service Restored" (Mandatory)
"901 Cold Boot" (Mandatory)
"902 Warm Boot" (Mandatory)
"916 Packages Change" (Optional)
"917 Capability Change "(Optional) | +| Handoff (NOTE 2, NOTE 3) | "903 MGC Directed Change" (Mandatory) | +| NOTE 1: When a Service Change command on the Root termination with a method other than Graceful is sent, the command shall always be sent as the only command in a message. The sending node shall always wait for the reply to a Service Change command on the Root termination with a method other than Graceful before sending further command requests. A Service Change command on the Root termination with method Graceful may be combined with other commands in a single message. | | +| NOTE 2: ROOT Only. | | +| NOTE 3: In response to a IMS-ALG Ordered Re-Register (clause 5.17.3.7). | | +| NOTE 4: Support of this procedure is mandatory in the IMS-ALG. | | + +**Table 5.8.8.3: Service Change Address** + +| | | +|-----------------------------------|----| +| ServiceChangeAddress used: | No | +|-----------------------------------|----| + +**Table 5.8.8.4: Service Change Delay** + +| | | +|---------------------------------|---------------------------| +| ServiceChangeDelay used: | No | +| If yes | Valid time period: | + +**Table 5.8.8.5: Service Change Incomplete Flag** + +| | | +|--------------------------------------------|----| +| ServiceChange Incomplete Flag used: | No | +|--------------------------------------------|----| + +**Table 5.8.8.6: Service Change Version** + +| | | +|-------------------------------------------------------------------------------------|--------| +| Version used in ServiceChangeVersion: | 2 or 3 | +| NOTE: Version 2 shall be supported as the minimum protocol version. See clause 5.3. | | + +**Table 5.8.8.7: ServiceChangeProfile** + +| | | +|-------------------------------------------------------------------------------------------------|-----| +| ServiceChangeProfile mandatory: | Yes | +| NOTE: The ServiceChangeProfile is mandatory in the AGW Register and AGW Re-Register procedures. | | + +**Table 5.8.8.8: Profile negotiation** + +| | | +|---------------------------------------------|----| +| Profile negotiation as per H.248.18: | No | +|---------------------------------------------|----| + +**Table 5.8.8.9: ServiceChangeMGCId** + +| | | +|---------------------------------|-----| +| ServiceChangeMGCId used: | Yes | +|---------------------------------|-----| + +### 5.8.9 Manipulating and auditing context attributes + +**Table 5.8.9.1: Manipulating and auditing context attributes** + +| | | +|----------------------------------------|---------------------------------------------------| +| Context Attributes Manipulated: | Emergency Indicator, Priority Indicator, Topology | +| Context Attributes Audited: | None | + +## 5.9 Generic command syntax and encoding + +**Table 5.9.1: Encodings** + +| | | +|---------------------------------------------------------------------------------------------------------------------------------------|----------------------------------| +| Supported Encodings: | Text (NOTE 1, NOTE 2) and Binary | +| NOTE 1: The receiver shall be capable of receiving both Short Token Notation and Long Token Notation on an H.248 control association. | | +| NOTE 2: The transmitter may select between long and short token forms per H.248 control association. | | +| NOTE 3: ETSI TISPAN "la Profile" [3] uses only text encoding. | | + +## 5.10 Transactions + +**Table 5.10.1: Transactions per Message** + +| | | +|----------------------------------------------------------------------------------------------------------------------|-----------| +| Maximum number of TransactionRequests / TransactionReplies / TransResponseAcks / Segment Replies per message: | 10 (NOTE) | +| NOTE: ETSI TISPAN "la Profile" [3] maximum is "1", this is foreseen to be the typical case. | | + +**Table 5.10.2: Commands per Transaction Requests** + +| | | +|---------------------------------------------------------------------------------------------|--------------------| +| Maximum number of commands per TransactionRequest: | Unspecified (NOTE) | +| NOTE: ETSI TISPAN "la Profile" [3] maximum is "2", this is foreseen to be the typical case. | | + +**Table 5.10.3: Commands per Transaction Reply** + +| | | +|---------------------------------------------------------------------------------------------|--------------------| +| Maximum number of commands per TransactionReply: | Unspecified (NOTE) | +| NOTE: ETSI TISPAN "la Profile" [3] maximum is "2", this is foreseen to be the typical case. | | + +**Table 5.10.4: Optional Commands** + +| | | +|-----------------------------------------------|--------------------------------------------------------------------------------------| +| Commands able to be marked "Optional": | | +|-----------------------------------------------|--------------------------------------------------------------------------------------| + +**Table 5.10.5: Commands marked for Wildcarded Responses** + +| | | +|---------------------------------------------------|----------| +| Wildcarded responses may be requested for: | Subtract | +|---------------------------------------------------|----------| + +**Table 5.10.6: Procedures for Wildcarded Responses** + +| | | +|----------------------------------------------------------|-------------------------| +| Procedures that make use of wildcarded responses: | Release AGW Termination | +|----------------------------------------------------------|-------------------------| + +**Table 5.10.7: Transaction Timers** + +| Transaction Timer: | Value | +|------------------------------------------|--------------| +| normalMGExecutionTime | Provisioned | +| normalMGCEExecutionTime | Provisioned | +| MGOriginatedPendingLimit | Provisioned | +| MGCOOriginatedPendingLimit | Provisioned | +| MGProvisionalResponseTimerValue | Provisioned | +| MGCPProvisionalResponseTimerValue | Provisioned | + +## 5.11 Messages + +It is recommended that IMS-AGW and IMS-ALG names are in the form of fully qualified domain name. For example the domain name of the IMS-ALG may be of the form: "ALG1.whatever.net." and the name of the IMS-AGW may be of the form: "mg1.whatever.net." + +The fully qualified domain name will be used by the IMS-AGW and IMS-ALG as part of the "Message Identifier" in the H.248 messages which identifies the originator of the message. + +The IMS-ALG domain name is provisioned in the IMS-AGW or retrieved from the DNS using SRV records. + +The use of a domain name provides the following benefits: + +- IMS-AGWs and IMS-ALGs are identified by their domain name, not their network addresses. Several addresses can be associated with a domain name. If a command cannot be forwarded to one of the network addresses, implementations shall retry the transmission using another address. + +NOTE: There are then e.g. multiple numerical address entries per single MGC entity in the "MG database of MGC entries"; see Table 5 in ITU-T H.Sup7 [29]. + +- IMS-AGWs and IMS-ALGs may move to another platform. The association between a logical name (domain name) and the actual platform are kept in the Domain Name Service (DNS). IMS-AGW and IMS-ALG shall keep track of the record's time-to-live read from the DNS. They shall query the DNS to refresh the information if the time-to-live has expired. + +The domain name may be used by IMS-ALG/IMS-AGW for authentication purposes. + +## 5.12 Transport + +Specifies what H.248 subseries transports are supported by the profile. + +Table 5.12.1: Transport + +| | | +|----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported transports: | 1. IPv4-based network control plane:
  • - SCTP/IPv4 (Recommended)
  • - UDP/IPv4 (Optional)
2. IPv6-based network control plane:
  • - SCTP/IPv6 (Recommended)
  • - UDP/IPv6 (Optional)
| +| NOTE 1: When using SCTP as defined in IETF RFC 4960 [16] the IMS-AGW shall always be the node to perform the "Initiation". | | + +Table 5.12.2: Segmentation + +| | | +|--------------------------------|----------------------------------------| +| Segmentation supported: | SCTP: Inherent in Transport
UDP: No | +|--------------------------------|----------------------------------------| + +Table 5.12.3: Control Association + +| | | +|--------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Control Association Monitoring supported: | Monitoring mechanism is dependent on used H.248 transport (see above table 5.12/1):
SCTP:
inherent capability of SCTP.
UDP:
H.248.14 (MG-driven monitoring).
Empty AuditValue on ROOT (MGC-driven monitoring). | +|--------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +## 5.13 Security + +Table 5.13.1: Security + +| | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| Supported Security: | None | +| NOTE: IPsec shall not be used by the IMS-ALG or IMS-AGW for the Iq interface. Normally the Iq interface lies within a single operator's secure domain. If this is not the case then a Za interface (Security Gateway deploying IPsec) may be required, however this is a separate logical function/entity and thus is not applicable to the Iq profile, the IMS-ALG or the IMS-AGW. For further details see 3GPP TS 33.210 [27]. | | + +## 5.14 Packages + +### 5.14.1 Mandatory Packages + +Table 5.14.1.1: Mandatory Packages + +| Mandatory Packages: | | | +|-------------------------------------------------------------------|--------------------|----------------| +| Package Name | PackageID | Version | +| IP NAPT traversal (ITU-T Recommendation H.248.37 [4]) | ipnapt, (0x0099) | 1 | +| Generic (ITU-T Recommendation H.248.1 [10], annex E.1) | g, (0x0001) | 1 | +| Base root (ITU-T Recommendation H.248.1 [10], annex E.2) | root, (0x0051) | 2 | +| Gate management (ITU-T Recommendation H.248.43 [6], Appendix I) | gm, (0x008c) | 2 | +| Traffic management (ITU-T Recommendation H.248.53 [7]) | tman, (0x008d) | 1 | +| IP Domain Connection (ITU-T Recommendation H.248.41 [8]) | ipdc, (0x009d) | 1 | +| Hanging Termination Detection (ITU-T Recommendation H.248.36 [9]) | hangterm, (0x0098) | 1 | +| Diffserv (ITU-T Recommendation H.248.52 [12]) | ds, (0x008b) | 2 | +| RTP Control Protocol (ITU-T Recommendation H.248.57 [5]) | rtpcph, (0x00b5) | 1 | + +### 5.14.2 Optional Packages + +**Table 5.14.2.1: Optional Packages** + +| Optional Packages: | | | | +|----------------------------------------------------------------------------------------------------|--------------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Package Name | PackageID | Version | Support dependent on: | +| Inactivity Timer (ITU-T Recommendation H.248.14 [11]) | it, (0x0045) | 1 | MGC polling by MG.
Only applicable for UDP transport. | +| Media Gateway Overload Control (ITU-T Recommendation H.248.11 [13]) | ocp, (0x0051) | 1 | Support of message throttling, based on rate limitation, from MGC towards MG. | +| Media Gateway Resource Congestion Handling Package (see ITU-T Recommendation H.248.10 [14]) | chp, (0x0029) | 1 | Support of message throttling, based on percentage limitation, from MGC towards MG. | +| IP realm availability (ITU-T Recommendation H.248.41 Amendment 1) [8] | ipra (0x00e0) | 1 | Support of mechanisms allowing the MGC to discover the IP realms that are available at the MG at a certain time and allowing the MG to inform the MGC about any changes in the availability of realms. | +| Application Data Inactivity Detection (ITU-T Recommendation H.248.40 [24]) | adid (0x009c) | 1 | MGC requires to be explicitly informed of a cessation of an application data flow. | +| Explicit Congestion Notification for RTP-over-UDP Support (see ITU-T Recommendation H.248.82 [40]) | ecnrous (0x010b) | 1 | Support of Transparent forwarding of ECN packets | +| MG Act-as STUN Server (ITU-T Recommendation H.248.50 [43]) | mgastuns (0x00c2) | 1 | Support of incoming STUN connectivity checks.
Applicable for ICE lite and full ICE | +| Originate STUN Continuity Check (see ITU-T Recommendation H.248.50 [43]) | ostuncc (0x00c3) | 1 | Support of originating STUN connectivity checks
Only applicable for full ICE | +| TCP basic connection control (ITU-T Recommendation H.248.89 [47]) | tcpbcc, (0x0115) | 1 | Support of state-aware TCP handling (TCP proxy mode) (NOTE). | +| TLS basic session control (ITU-T Recommendation H.248.90 [48]) | tlsbsc, (0x0117) | 1 | Support of
a) TCP-based media using TLS
b) UDP-based media using DTLS,
c) SCTP-based media using DTLS (WebRTC) | +| Stream endpoint interlinkage (ITU-T Recommendation H.248.92 [49]) | seplink, (0x011b) | 1 | Support of state-aware TCP handling (TCP proxy mode) and of Forward Incoming TCP Connection Establishment Requests Indicator. | +| MG located Bearer Level ALG (ITU-T Recommendation H.248.78 [56]) | mgbalg (0x011d) | 1 | Support of a bearer level application gateway (B-ALG) function for application-aware MSRP interworking. | +| STUN Consent Freshness (ITU-T Recommendation H.248.50 [43]) | stnconfres(0x0120) | 1 | Support of STUN usage for consent freshness procedures.
Applicable for full ICE. | +| Media Grouping (ITU-T Recommendation H.248.96 [65]) | mgroup (0x011f) | 1 | Support of WebRTC data channels | +| SCTP basic connection control package (ITU-T Recommendation H.248.97 [66]) | sctpbcc (0x0121) | 1 | Support of WebRTC data channels: control of establishment and release of SCTP associations, and the allocation of local SCTP stream identifiers | + +| | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---|-------------------------------------------------------------------------------------| +| SCTP Re-configuration Stream reset ([ITU-T Recommendation H.248.97 [66]]) | sctpreset, (0x0122) | 1 | Support of WebRTC data services: control of SCTP stream reset ("release") procedure | +| Enhanced Revised Offer/Answer SDP Support ([ITU-T Recommendation H.248.80 [73]]) | eroas, (0x0109) | 1 | Support of the SDP Capability Negotiation syntax | +| NOTE: Stateless TCP handling (i.e. TCP relay and TCP merge mode) are solely based on SDP indication (thus, package-less) according to ITU-T Recommendation H.248.84 [46], clause 13. | | | | + +### 5.14.3 Package usage information + +#### 5.14.3.1 Generic (g) + +Table 5.14.3.1.1: Generic package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|------------------------------------------|--------------------------------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| Cause (g/cause, 0x0001/0x0001) | M | ADD, MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | None | - | | | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | General cause (Generalcause, 0x0001) | M | "NR" (0x0001)
Normal Release
"UR" (0x0002)
Unavailable Resources
"FT" (0x0003) Failure, Temporary
"FP" (0x0004) Failure, Permanent
"IW" (0x0005) Interworking Error
"UN" (0x0006) Unsupported | Not Applicable | | | +| | Failure cause (Failurecause, 0x0002) | O | Octet String | Not Applicable | | | +| Events | Mandatory/Optional | Used in command | | | | | +| Signal Completion. (g/sc, 0x0001/0x0002) | Not Used | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.2 Base root (root) + +Table 5.14.3.2.1: Base root package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|--------------------------------------------------------------------------------------------|--------------------------|--------------------|------------------|----------------------------|--|--| +| MaxNrOfContexts
(root/maxNumberOfContexts, 0x0002/0x0001) | O | AUDITVALUE | ALL | YES | | | +| MaxTerminationsPerContext
(root/maxTerminationPerContext, 0x0002/0x0002) | O | AUDITVALUE | ALL | YES | | | +| normalMGExecutionTime
(root/normalMGExecutionTime, 0x0002/0x0003) | O | AUDITVALUE | ALL | YES | | | +| normalMGCEExecutionTime
(root/normalMGCEExecutionTime, 0x0002/0x0004) | O | AUDITVALUE | ALL | YES | | | +| MGProvisionalResponseTimerValue
(root/MGProvisionalResponseTimerValue, 0x0002/0x0005) | O | AUDITVALUE | ALL | YES | | | +| MGCProvisionalResponseTimerValue
(root/MGCProvisionalResponseTimerValue, 0x0002/0x0006) | O | AUDITVALUE | ALL | YES | | | +| MGCOriinatedPendingLimit
(root/MGCOriinatedPendingLimit, 0x0002/0x0007) | O | AUDITVALUE | ALL | YES | | | +| MGOrigiinatedPendingLimit
(root/MGOrigiinatedPendingLimit, 0x0002/0x0008) | O | AUDITVALUE | ALL | YES | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.3 Differentiated Services (ds) + +Table 5.14.3.3.1: Differentiated Services package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|-------------------------------------------------------------|--------------------------|--------------------|------------------|----------------------------|--|--| +| Differentiated Services Code Point (ds/dscp, 0x008b/0x0001) | M | ADD, MODIFY | ALL | Yes | | | +| Tagging Behaviour (ds/tb, 0x008b/0x0002) | O | ADD, MODIFY | ALL | Yes | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.4 Gate Management (gm) + +Table 5.14.3.4.1: Gate Management Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|----------------------------------------------------------|--------------------|--------------------|------------------|----------------------------| +| Remote Source Address Filtering (gm/saf, 0x008c/0x0001) | M | ADD, MODIFY | ALL | Not Applicable | +| Remote Source Address Mask (gm/sam, 0x008c/0x0002) | O | ADD, MODIFY | ALL | Not Applicable | +| Remote Source Port Filtering (gm/spf, 0x008c/0x0003) | M | ADD, MODIFY | ALL | Not Applicable | +| Remote Source Port (gm/spr, 0x008c/0x0004) | O | ADD, MODIFY | ALL | Not Applicable | +| Explicit Source Address Setting (gm/esas, 0x008c/0x0005) | Not Supported | NONE | - | Not Applicable | +| Local Source Address (gm/lsa, 0x008c/0x0006) | Not Supported | NONE | - | Not Applicable | +| Explicit Source Port Setting (gm/esps, 0x008c/0x0007) | Not Supported | NONE | - | Not Applicable | +| Local Source Port (gm/lsp, 0x008c/0x0008) | Not Supported | NONE | - | Not Applicable | +| Remote Source Port Range (gm/spr, 0x008c/0x000A) | O | ADD, MODIFY | ALL | Not Applicable | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | + +| Events | Mandatory/Optional | Used in command | | | | | +|--------------------|---------------------------------|---------------------------|-------------------------|--------------------------|--|--| +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| Discarded Packets | NOT USED | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.5 Traffic management (tman) + +**Table 5.14.3.5.1: Traffic Management Package** + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|-----------------------------------------------------|---------------------------------|---------------------------|-------------------------|-----------------------------------|--|--| +| Policing (tman/pol, 0x008d/0x0005) | M | ADD, MODIFY | ALL | Not Applicable | | | +| Peak Data Rate (tman/pdr, 0x008d/0x0001) | O | ADD, MODIFY | ALL | Not Applicable | | | +| Delay Variation Tolerance (tman/dvt, 0x008d/0x0004) | O | ADD, MODIFY | ALL | ALL | | | +| Sustainable Data Rate (tman/sdr, 0x008d/0x0002) | M | ADD, MODIFY | ALL | Not Applicable | | | +| Maximum burst size (tman/mbs, 0x008d/0x0003) | M | ADD, MODIFY | ALL | Not Applicable | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +NOTE: The data rate shall be calculated using the packet size from IP layer upwards. The Token Bucket method as described by ITU-T Recommendation H.248.53 [7] clause 9.4.3 (as per IETF RFC 2216 [32]) shall be followed where SDR = "r" and MBS = "b" (i.e. the additional "M" value does not apply). + +#### 5.14.3.6 Inactivity Timer (it) + +Table 5.14.3.6.1: Inactivity Timer Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|--------------------------------------------------|--------------------|-------------------------|--------------------------|-------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command | | Duration
Provisioned Value | | | +| None | - | - | - | - | | | +| Signal Parameters | Mandatory/Optional | Supported Values | Duration | Provisioned Value | | | +| - | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| Inactivity Timeout
(it/ito,
0x0045/0x0001) | M | MODIFY, NOTIFY | | | | | +| Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | | +| Maximum Inactivity
Time (mit, 0x0001) | O | ALL | Yes | | | | +| ObservedEvent
Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | | +| None | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.7 IP Domain Connection (ipdc) + +Table 5.14.3.7.1: IP domain connection package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|-------------------------------------------------------|--------------------|-------------------------|--------------------------|-------------------------------|--|--| +| IP Realm Identifier
(ipdc/realm,
0x009d/0x0001) | M | ADD,
MODIFY (NOTE 2) | ALL
(NOTE 1) | Yes | | | +| Signals | Mandatory/Optional | Used in command | | Duration
Provisioned Value | | | +| None | - | - | - | - | | | +| Signal Parameters | Mandatory/Optional | Supported Values | Duration | Provisioned Value | | | +| - | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | | +| - | - | - | - | | | | +| ObservedEvent
Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | | +| - | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| No | - | | | | | | + +NOTE 1: If the MGC uses an IP Realm Identifier (*ipdc/realm*) property exceeding the maximum length limitation defined in ITU-T Recommendation H.248.41 [8], the MG shall reply with an error descriptor using error code #410: "Incorrect identifier". + +NOTE 2: The MODIFY command is listed due to the fact that subsequent Streams may be "added" by MODIFY requests in case of multi-Stream-per-Termination structures. The subsequent Streams shall then carry the same IP Realm Identifier (*ipdc/realm*) property value as the very first Stream. + +#### 5.14.3.8 Media Gateway Overload Control Package (ocp) + +Table 5.14.3.8.1: Media Gateway Overload Control Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|----------------------------------------------------------------|---------------------------------|---------------------------|-------------------------|-----------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| MG_Overload
(ocp/mg_overload,
0x0051/0x0001)
(NOTE 1) | M | MODIFY, NOTIFY (NOTE 1) | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | None | - | - | - | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | +| None | - | - | - | - | +| Error Codes | Mandatory/Optional | | | | +| None | - | | | | + +NOTE 1: When the MG is overloaded, overload Events may be sent **either** only following the **first ADD.request** which creates a new Context, **or** following **all ADD.request** commands (see ITU-T Recommendation H.248.11 [13] Corrigendum 1). +These two options result in different normalisations of the overload event rate as an indicator of the level of MG overload. + +#### 5.14.3.9 Hanging Termination Detection (hangterm) + +Table 5.14.3.9.1: Hanging Termination Detection Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|-----------------------------------------------------------|---------------------------------|---------------------------|-------------------------|-----------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| Termination Heartbeat
(hangterm/thb,
0x0098/0x0001) | M | ADD, MODIFY, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | Timer X
(timerx,0x0001) | M | ALL (NOTE1) | YES | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | +| None | - | - | - | - | +| Error Codes | Mandatory/Optional | | | | +| None | - | | | | + +NOTE1: The heartbeat timer shall be configured to a value much greater than the mean call holding time. + +#### 5.14.3.10 Media Gateway Resource Congestion handling Package (chp) + +Table 5.14.3.10.1: Media Gateway Resource Congestion handling Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|----------------------------------------|---------------------------------|--------------------|------------------|----------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| MGCon
(chp/mgcon,
0x0029/0x0001) | M | MODIFY, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | Reduction
(reduction,0x0001) | M | 0-100 | Not Applicable | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | +| None | - | - | - | - | +| Error Codes | Mandatory/Optional | | | | +| None | - | | | | + +#### 5.14.3.11 IP Realm Availability (ipra) + +Table 5.14.3.11.1: IP Realm Availability Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|-----------------------------------------------------------|----------------------------------------------|--------------------|-------------------|----------------------------| +| Available Realms,
(ipra/ar,
0x00e0/0x0001) | M | AUDITVALUE | ALL | Not Applicable | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| Available Realms
Changed, (ipra/arc,
0x00e0/0x0001) | M | MODIFY, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | Newly Available
Realms (nar,
0x0001) | M | ALL | Not applicable | +| | Newly Unavailable
Realms (nur,
0x0002) | M | ALL | Not applicable | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | +| None | - | - | - | - | +| Error Codes | Mandatory/Optional | | | | +| None | - | | | | + +#### 5.14.3.12 IP NAPT Traversal (ipnapt) + +Table 5.14.3.12.1: IP NAPT Traversal Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|------------------------------------------|------------------------------------------|--------------------|------------------|----------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| Latching (ipnapt/latch)
0x0099/0x0001 | M | ADD, MODIFY | | Not Applicable | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | NAPT Traversal Processing (napt, 0x0001) | M | ALL | Not Applicable | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.13 RTCP Handling Package (rtcph) + +Table 5.14.3.13.1: RTCP Handling Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|---------------------------------------------------------------|---------------------------------|--------------------|------------------|----------------------------|--|--| +| RTCP Allocation Specific Behaviour (rtcph/rsb, 0x00b5/0x0009) | M | ADD, MODIFY | ALL | OFF | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.14 Application Data Inactivity Detection (adid) + +Table 5.14.3.14.1: Application Data Inactivity Detection package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|-----------------------------------------------------|--------------------|---------------------|----------------------------|----------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | - | - | | | +| Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | | +| - | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| IP Flow Stop Detection (adid/ipstop, 0x009c/0x0001) | M | ADD, MODIFY, NOTIFY | | | | | +| Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | | +| Detection time (dt, 0x0001) | M | ALL | Yes | | | | +| Direction (dir, 0x0002) | M | ALL | Yes | | | | +| ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | | +| None | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | | | | | | | + +#### 5.14.3.15 Explicit Congestion Notification for RTP-over-UDP Support (ecnrous) + +Table 5.14.3.15.1: Explicit Congestion Notification for RTP-over-UDP Support package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|-------------------------------------------------------------|--------------------|------------------|----------------------------|---------------------------------------------------------------------------------------------| +| ECN Enabled (ecnrous/ecnen, 0x010b/0x0001) | M | ADD, MODIFY | True, False | - | +| Congestion Response Method (ecnrous/crm, 0x010b/0x0002) | Not Signalled | - | - | "RDCC"(0x0002) (NOTE 1, NOTE 2) | +| Initiation Method (ecnrous/initmethod, 0x010b/0x0003) | M | ADD, MODIFY | "inactive", "leap" | "inactive" | +| ECN Mode (ecnrous/mode, 0x010b/0x0004) | Not Signalled | - | - | "setonly" (0x0001) in the Remote Descriptor and "readonly" (0x0002) in the Local Descriptor | +| ECT Marking (ecnrous/ectmark, 0x010b/0x0005) | Not Signalled | - | - | "0" (0x0002) (NOTE 2) | +| ECN Congestion Marking (ecnrous/congestmark, 0x010b/0x0006) | Not Signalled | - | - | "nomark" (0x0003) | +| ECN SDP Usage (ecnrous/ecnsdp, 0x010b/0x0007) | Not Signalled | - | - | "P" (0x0001) | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | - | - | +| Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | +| - | - | - | - | - | + +| Events | Mandatory/Optional | Used in command | | | | | +|----------------------------------------------------------------|----------------------------------|---------------------------|-------------------------|--------------------------|--|--| +| ECN Failure (ecnrous/fail, 0x010b/0x0001) | O (NOTE 2) | ADD, MODIFY, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Failure Type (type, 0x0001) | Mandatory | INIT, USE | | | | +| | Media Sender SSRC (ssrc, 0x0002) | Not Supported | | | | | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | | | +| Source (ecnrous/ssrc, 0x010b/0x0001) | Not Supported | - | | - | | | +| CE Counter (ecnrous/cecount, 0x010b/0x0002) | Not Supported | - | | - | | | +| ECT0 Counter (ecnrous/ectzero, 0x010b/0x0003) | Not Supported | - | | - | | | +| ECT1 Counter (ecnrous/ectone, 0x010b/0x0004) | Not Supported | - | | - | | | +| Not-ECT Counter (ecnrous/notect, 0x010b/0x0005) | Not Supported | - | | - | | | +| Lost Packets Counter (ecnrous/lost, 0x010b/0x0006) | Not Supported | - | | - | | | +| Extended Highest Sequence number (ecnrous/ehsn, 0x010b/0x0007) | Not Supported | - | | - | | | +| Duplication Counter (ecnrous/dup, 0x010b/0x0008) | Not Supported | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +NOTE 1: Application Specific Rate Adaptation shall be applied in accordance with 3GPP TS 26.114 [26]. For speech this requires support of CMR and TMMBR for video. + +NOTE 2: Not used for ECN transparent. Mandatory for ECN endpoint. + +#### 5.14.3.16 MG Act-as STUN Server (mgastuns) + +Table 5.14.3.16.1: MG Act-as STUN Server + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|-----------------------------------------------------|--------------------------|--------------------|------------------|----------------------------|--|--| +| Act-as STUN Server (mgastuns/astuns, 0x00c2/0x0001) | M | ADD, MODIFY | ALL | - | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | - | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | - | - | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.17 Originate STUN Continuity Check (ostuncc) + +Table 5.14.3.17.1: Originate STUN Continuity Check Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|------------------------------------------------------------------|----------------------------------------|---------------------|-----------------------------|----------------------------| +| Host Candidate Realm (ostuncc/hcr, 0x00c3/0x0001) | O | ADD, MODIFY | ALL | Yes | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| Send Connectivity Check (ostuncc/scc, 0x00c3/0x0001) | M | ADD, MODIFY | | Not Applicable | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | Control (cntrl, 0x0001) | O | "controlling", "controlled" | Not Applicable | +| Send Additional Connectivity Check (ostuncc/sacc, 0x00c3/0x0002) | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| | M | MODIFY | | Not Applicable | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | Control (cntrl, 0x0001) | O | "controlling", "controlled" | Not Applicable | +| Events | Mandatory/Optional | Used in command | | | +| Connectivity Check Result (ostuncc/ccr, 0x00c3/0x0001) | M | ADD, MODIFY, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | Candidate/Transport Pair (ctp, 0x0001) | M | ALL | Not applicable | +| New Peer Reflexive Candidate (ostuncc/nprc, | Mandatory/Optional | Used in command | | | +| | M | ADD, MODIFY, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | + +| | | | | | | | +|--------------------|---------------------------------|---------------------------|-------------------------|--------------------------|--|--| +| 0x00c3/0x0002) | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Candidate (can, 0x0001) | M | ALL | Not applicable | | | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.18 TCP basic connection control (tcpbcc) + +Table 5.14.3.18.1: TCP basic connection control package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|--------------------------------------------------------------------------------|-------------------------------------|---------------------------|-----------------------------------------------------------|-----------------------------------|--|--| +| Incoming bearer connection establishment blocking (tcpbcc/bceb, 0x0115/0x0001) | O (NOTE 1) | ADD, MODIFY | ALL | "Unblocked" | | | +| Oneway Release Indicator (tcpbcc/ori, 0x0115/0x0002) | not supported | - | - | "False" | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| Establish BNC (tcpbcc/EstBNC, 0x0115/0x0001) | M | ADD, MODIFY | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Release BNC (tcpbcc/RelBNC, 0x0115/0x0002) | O (NOTE 2) | ADD, MODIFY- | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| TCP connection state change (tcpbcc/BNCChange, 0x0115/0x0001) | O (NOTE 3) | ADD, MODIFY, NOTIFY- | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Type of state change (Type, 0x0001) | M | Est [0x01] Bearer Established, Rel [0x05] Bearer Released | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Type of state change (Type, 0x0001) | M | Est [0x01] Bearer Established, Rel [0x05] Bearer Released | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +NOTE 1: Shall be supported if delayed TCP bearer connection establishment is required. + +NOTE 2: When the IMS-ALG wants to explicitly trigger the TCP bearer connection release procedure (instead of the implicit trigger related to the removal of the H.248 stream (via a MODIFY.request or SUBtract.request command)). + +NOTE 3: When the IMS-ALG wants to monitor the execution of TCP bearer control procedures. + +#### 5.14.3.19 TLS basic session control (tlbsc) + +Table 5.14.3.19.1: TLS basic session control package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|------------------------------------------------------------------------------|-------------------------------------|---------------------------|-----------------------------------------------------------|-----------------------------------|--|--| +| Incoming security session establishment blocking (tlbsc/bceb, 0x0117/0x0001) | O (NOTE 1) | ADD, MODIFY | ALL | "Unblocked" | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| Establish BNC (tlbsc/EstBNC, 0x0117/0x0001) | M | ADD, MODIFY | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Release BNC (tlbsc/RelBNC, 0x0117/0x0002) | O (NOTE 2) | ADD, MODIFY- | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| TLS session state change (tlbsc/BNCChange, 0x0117/0x0001) | O (NOTE 3) | ADD, MODIFY, NOTIFY- | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Type of state change (Type, 0x0001) | M | Est [0x01] Bearer Established, Rel [0x05] Bearer Released | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Type of state change (Type, 0x0001) | M | Est [0x01] Bearer Established, Rel [0x05] Bearer Released | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +NOTE 1: When the IMS-ALG wants to block incoming (D)TLS bearer session establishment requests. +NOTE 2: When the IMS-ALG wants to explicitly trigger the (D)TLS bearer session release procedure (instead of the implicit trigger related to the removal of the H.248 stream (via a MODify.request or SUBtract.request command)). +NOTE 3: When the IMS-ALG wants to monitor the execution of (D)TLS bearer control procedures. + +#### 5.14.3.20 Stream endpoint interlinkage (seplink) + +Table 5.14.3.20.1: Stream endpoint interlinkage package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|---------------------------------------------------------|---------------------------|---------------------------|-------------------------|-----------------------------------| +| Interlinkage topology (seplink/linktopo, 0x011b/0x0001) | M | ADD, MODIFY | only TCP endpoints | empty list | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | + +| Events | Mandatory/Optional | Used in command | | | | | +|-------------|--------------------------|--------------------|------------------|-------------------|--|--| +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | | | +| None | Not Supported | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| #488 | M | | | | | | + +#### 5.14.3.21 MG located Bearer Level ALG (mgbalg) + +Table 5.14.3.21.1: MG located Bearer Level ALG package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|----------------------------------------------------------------------------------------|--------------------------|--------------------|------------------|----------------------------|--|--| +| Protocol type bearer level ALG (mgbalg/ptbalg, 0x011d/0x0001) | M | ADD, MODIFY | ALL | "OFF" | | | +| Upper layer protocol filter (mgbalg/ulpf, 0x011d/0x0002) | O (NOTE) | ADD, MODIFY | 0 | "0" | | | +| Source of replaced source address information part (mgbalg/sosai, 0x011d/0x0003) | O (NOTE) | ADD, MODIFY | ALL | "SD" | | | +| Source of replaced destination address information part (mgbalg/sodaip, 0x011d/0x0004) | O (NOTE) | ADD, MODIFY | ALL | "SD" | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +NOTE: When B-ALG service configuration is provisioned in IMS-AGW. + +#### 5.14.3.22 STUN Consent Freshness (stnconfres) + +Table 5.14.3.22.1: STUN Consent Freshness package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|------------|--------------------|-----------------|------------------|-------------------| +| None | - | - | - | - | + +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +|------------------------------------------------------------------------|--------------------------------------|---------------------------|-------------------------|-------------------------------------------|--|--| +| Consent Test
(stnconfres/const,
0x0120/0x0001) | M | ADD, MODIFY | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | tstint (0x0001) | O | Integer | 0.8N and 1.2N
Default N=5000
(NOTE) | | | +| Events | Mandatory/Optional | Used in command | | | | | +| Consent State
(stnconfres/constate,
0x0120/0x0001) | Not supported | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Request States
(reqstate, 0x0001) | Not supported | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | States (state, 0x0001) | Not supported | - | - | | | +| STUN Consent Request Failure
(stnconfres/confail,
0x0120/0x0002) | Mandatory/Optional | Used in command | | | | | +| | M | ADD, MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| | None | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +NOTE: The parameter "N" refers to the basic period of the consent check interval defined in IETF RFC 7675 [58]. + +#### 5.14.3.23 Media Grouping (mgroup) + +Table 5.14.3.23.1: Media Grouping package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|-------------------------------------------------------------|---------------------------------|---------------------------|-------------------------|-----------------------------------| +| Group Semantics
(mgroup/groupse,
0x011f/0x0001) | M | ADD, MODIFY | ALL (NOTE) | - | +| Stream Aggregation
(mgroup/stragg,
0x011f/0x0002) | Not supported | | | | +| Stream Deaggregation
(mgroup/strdeagg,
0x011f/0x0003) | M | ADD, MODIFY | ALL | - | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| None | - | - | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | | - | +| | - | - | | - | + +| Statistics | Mandatory/Optional | Used in command | Supported Values | +|--------------------|---------------------------|-----------------|------------------| +| None | - | - | - | +| Error Codes | Mandatory/Optional | | | +| #489 | M | | | + +NOTE: Only semantics "SCTP" is required (for WebRTC data channels). + +#### 5.14.3.24 SCTP basic connection control package (sctpbcc) + +**Table 5.14.3.24.1: SCTP basic connection control package** + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|---------------------------------------------------------------------------------|-------------------------------------|---------------------------|--------------------------------------------------------------|-----------------------------------| +| Incoming bearer connection establishment blocking (sctpbcc/bceb, 0x0121/0x0001) | Not supported | | | | +| SCTP StreamID (sctpbcc/sctpid, 0x0121/0x0002) | M | ADD, MODIFY | ALL | - | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| Establish BNC (sctpbcc/EstBNC, 0x0121/0x0001) | M | ADD, MODIFY | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Release BNC (sctpbcc/RelBNC, 0x0121/0x0002) | O (NOTE 1) | ADD, MODIFY | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| SCTP connection state change (sctpbcc/BNCChange, 0x0121/0x0001) | O (NOTE 2) | ADD, MODIFY, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | Type of state change (Type, 0x0001) | M | Est [0x01] Bearer Established,
Rel [0x05] Bearer Released | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | Type of state change (Type, 0x0001) | M | Est [0x01] Bearer Established,
Rel [0x05] Bearer Released | - | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | +| None | - | - | - | | +| Error Codes | Mandatory/Optional | | | | +| None | - | | | | + +NOTE 1: When the IMS-ALG wants to explicitly trigger the SCTP Association shutdown procedure (instead of the implicit trigger related to the removal of the H.248 Stream (via a MODify.request or SUBtract.request command)). + +NOTE 2: When the IMS-ALG wants to monitor the execution of SCTP bearer control procedures. + +#### 5.14.3.25 SCTP Re-configuration Stream Reset (sctpreset) + +Table 5.14.3.25.1: SCTP Re-configuration Stream Reset package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|--------------------------------------------------------------------------|---------------------------------|---------------------------|-------------------------|-----------------------------------|--|--| +| None. | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| Initiate Outgoing SCTP Stream Reset (sctpreset/initreset, 0x0122/0x0001) | M | ADD, MODIFY | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | sctpid (0x0001) | M | ALL | - | | | +| Outgoing SCTP Stream Reset Response (sctpreset/resetresp, 0x0122/0x0002) | O (NOTE) | ADD, MODIFY | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | sctpid (0x0001) | M | ALL | - | | | +| | action (0x0002) | M | ALL | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| Detect outgoing SCTP stream reset (sctpreset/detreset, 0x0122/0x0001) | M | ADD, MODIFY, NOTIFY- | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | outresp (0x0001) | O | ALL | "accept" | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | sctpid (0x0001) | M | ALL | - | | | +| Outgoing SCTP stream reset result (sctpreset/result, 0x0122/0x0002) | O | ADD, MODIFY, NOTIFY- | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | None. | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | sctpid (0x0001) | M | ALL | - | | | +| | result (0x0002) | M | ALL | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.26 Enhanced Revised Offer/Answer SDP Support (eroas) + +Table 5.14.3.26.1: Enhanced Revised Offer/Answer SDP Support package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|--------------------------------------------------|---------------------------------|---------------------------|-------------------------|-----------------------------------| +| SDPCapNeg Extensions (eroas/sdpe, 0x0109/0x0001) | M | AuditValue | "cap-v0" | "cap-v0" | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| None | - | - | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | + +| Statistics | Mandatory/Optional | Used in command | Supported Values | +|--------------------|---------------------------|-----------------|------------------| +| None | - | - | - | +| Error Codes | Mandatory/Optional | | | +| None | - | | | + +## 5.15 Mandatory support of SDP and Annex C information elements + +Table 5.15.1: Mandatory Annex C and SDP information elements + +| Information Element | Annex C Support | SDP Support | +|---------------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| v-line | "SDP_V " | The value must always be equal to zero: v=0 | +| c-line | "SDP_C " |

<nettype> <addrtype> and <connection address> are required.

The network type shall be set to "IN".

The address type may be IPv4 or IPv6.

The MGC may apply parameter underspecification to the <connection address> subfield.

| +| m-line | "SDP_M " |

There are four fields (or SDP values) <media>, <port>, <proto> and <fmt> in the "m=" line (see IETF RFC 4566 [17];NOTE 1).

The "m=" line may be omitted from SDP.

<media>, <port>, <proto> and <fmt-list> are required if the "m=" line is included.

Media type <media> :

The <media> field shall be set to "audio", "video", "message", "application", "text" or "-". When "-" is used for the media value then no media resources are required to be reserved at this stage (NOTE 1). If the MG does not support the requested media value it shall reject the command with error code 515.

Transport port <port>

The port value may be underspecified with CHOOSE wildcard.

Transport protocol <proto>

As in table 5.15.2.

Media format <fmt>

Various values may be used for media-format, dependent on the related <media> (NOTE 3).

"-" may be used for the format list value if no media reservation is required at this stage.

If the MG does not support the requested media format value the MG shall reject the command with error code 449.

| +| b-line | "SDP_B " |

Shall not be used without a "m=" line.

The modifier values shall be "AS", "RS" and "RR".

The AS modifier implies that the bandwidth-value represents the ""maximum bandwidth" (see clause 5.8/ IETF RFC 4566 [17]). The bandwidth-value relates therefore to the peak bitrate (NOTE 2).

The bandwidth-value value defines the IP layer bandwidth for the specific H.248 Stream.

For RTP flows, where RTCP resources are reserved together with the RTP resources using the "RTP Specific Behaviour" property of the Gate Management package (gm) property, the IMS-ALG may also supply additional RTCP bandwidth modifiers (i.e. RR and RS, see IETF RFC 3556 [28]). The AS bandwidth value will include the bandwidth used by RTP. In the absence of the RTCP bandwidth modifiers the IMS-AGW shall allow an additional 5% of the AS bandwidth value for the bandwidth for RTCP, in accordance with IETF RFC 3556 [28].

| + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| o-line | "SDP_O" |

The origin line consists of six fields:
(<username>, <sess-id>, <sess-version>, <nettype>, <addrtype> and <unicast-address>).

The MGC is not required to supply this line but shall accept it (see clause 7.1.8/ITU-T Recommendation H.248.1 [10]).

The MG shall return the value received from the MGC or if there is no o-line sent by the MGC, the MG shall populate this line as follows:

  • - <user name> should contain an hyphen
  • - <session ID> and <version> should contain one or more digits as described in IETF RFC 4566 [17]
  • - <network type> shall be set to IN
  • - <address type> shall be set to IP4 or IP6 The Address Type shall be set to "IP4" or "IP6" depending on the addressing scheme used by the network to which the MG is connected.
  • - <address> should contain the fully qualified domain name or IP address of the gateway.
| +| s-line | "SDP_S" |

The session name "s=" line contains a single field
s= <session name>.

The MGC is not required to supply this line but shall accept it (see clause 7.1.8/ITU-T Recommendation H.248.1 [10]).

The MG shall return the value received from the MGC or if there is no s-line sent by the MGC, the MG shall populate this line as follows:
- "s="

| +| t-line | "SDP_T" |

The time "t=" line consists of two fields
t= <start time> and <stop time>.

The MGC is not required to supply this line but shall accept it (see clause 7.1.8/ITU-T Recommendation H.248.1 [10]).

The MG shall return the value received from the MGC or if there is no t-line sent by the MGC, the MG shall populate this line as follows:
"t=0 0"

| +|

NOTE 1: IETF RFC 4566 [17] enables "-" as a valid character.

NOTE 2: The unit for the bandwidth-value (peak bitrate) is "kbit/s". The "b=" line is not providing any information about the traffic characteristic, i.e. whether the traffic flow has a Constant BitRate (CBR) or Variable BitRate (VBR). The bandwidth-value is thus independent of the traffic characteristic and relates to the peak bitrate for CBR and VBR traffic.

NOTE 3: In particular, WebRTC uses value "webrtc-datachannel" in case of WebRTC data applications.

| | | + +Table 5.15.2: Transport Protocol + +| | | +|----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Transport Protocol <proto> in m-line: | If the MG does not support the requested transport protocol, it shall reject the command with error code 449. | +| RTP/AVP | RTP profile according IETF RFC 3551 [19]. Allow only L4 protocol = UDP (see NOTE 1). | +| RTP/AVPF | Extended RTP profile for RTCP-based Feedback (RTP/AVPF) according IETF RFC 4585 [25]. See 3GPP TS 26.114 [26]. Allow only L4 protocol = UDP (see NOTE 1). | +| RTP/SAVP | SRTP profile according IETF RFC 3711 [30] (NOTE 3). Allow only L4 protocol = UDP (see NOTE 1). | +| RTP/SAVPF | Extended SRTP profile for RTCP-based Feedback (RTP/SAVPF) according IETF RFC 5124 [31] (NOTE 3). Allow only L4 protocol = UDP (see NOTE 1). | +| TCP | Allow only L4 protocol = TCP (NOTE 2) | +| TCP/MSRP | Message service using IETF RFC 4975 [18] (NOTE 6). | +| TCP/TLS | Application agnostic indication with L4 protocol = TCP (NOTE 4). | +| TCP/TLS/MSRP | Application-specific indication with L4 protocol = TCP and TLS-based transport security (SDP codepoint see IETF RFC 4975 [18]) (NOTE 6). | +| udptl | Allow only L4 protocol = UDP | + +| | | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| udp | Allow only L4 protocol = UDP (NOTE 1, NOTE 7). | +| UDP/DTLS | Application agnostic indication with L4 protocol = UDP and DTLS-based transport security (NOTE 5). | +| UDP/TLS/RTP/SAVP | Indication for end-to-access edge transport security using DTLS-SRTP, where DTLS is used to establish keys for SRTP according to IETF RFC 5763 [60] and IETF RFC 5764 [61]. | +| UDP/TLS/RTP/SAVPF | Indication for end-to-access edge transport security using DTLS-SRTP, where DTLS is used to establish keys for extended SRTP according to IETF RFC 5763 [60] and IETF RFC 5764 [61]. | +| UDP/DTLS/SCTP | See IETF RFC 8841 [68]. For WebRTC data channel support (for the indication of the protocol stack segment "SCTP-over-DTLS"). | +| NOTE 1: | Parameter "udp" is introduced by IETF RFC 4566 [17]. | +| NOTE 2: | Upper case TCP is defined by IETF RFC 4145 [20] and registered by IANA. | +| NOTE 3: | The IMS AGW does not need to reserve resources for end-to-access edge media (e2ae) security encryption/decryption at this stage if RTP profile identifiers "RTP/SAVP" or "RTP/SAVPF" are signalled without the "a=crypto" property for that stream. For e2e media security either "RTP/SAVP" is signalled at all terminations in a context, or "RTP/SAVPF" is signalled at all terminations in a context and no media attribute will be signalled; the IMS AGW shall then not terminate the SRTP / SRTCP protocol, but shall pass the encrypted media and control flows (as indicated with the rtcp/rsb property) transparently. | +| NOTE 4: | Parameter "TCP/TLS" is defined by IETF RFC 8122 [55] for the TLS protocol according to 3GPP TS 33.210 [27]. | +| NOTE 5: | Parameter "UDP/DTLS" is based on ITU-T Recommendation H.248.93 [50] and shall only be used on Iq interface. | +| NOTE 6: | Conditional support, dependent on application-aware interworking. | +| NOTE 7: | Codepoint used for e.g. "UDP payload transparent forwarding" (such as DTLS-encrypted end-to-end WebRTC bearer traffic). | + +## 5.16 Optional support of SDP and Annex C information elements + +*Specifies what SDP attributes and Annex C information elements may be supported.* + +Table 5.16.1: Optional Annex C and SDP information elements + +| Information Element | Annex C Support | SDP Support | +|---------------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| a-line | "SDP_A " |

1) Application "RTCP transport address control":

a) Default mode "without RTP/RTCP transport multiplexing":

The attribute "a=rtcp" line may either contain (a=rtcp: <port>) or (a=rtcp: <port> <network type> <address type> <connection address>) when the "a=" line is used for RTCP transport port and optionally network address transmission (see IETF RFC 3605 [21]). .

The MGC shall supply the "a=rtcp" line in the RD when non-default RTCP network address or transport port values are used by the peer media entity.

"RTCP transport address control" should be supported by MG (NOTE 2).

b) Optional extension mode "with RTP/RTCP transport multiplexing":

The attribute "a=rtcp-mux" (see IETF RFC 5761 [59]) is used for indicating RTP/RTCP transport multiplexing. Tables 4/1 to 4/5 in ITU-T Recommendation H.248.57 [5] define the appropriate RTCP port allocation rules.

2) Media related parameters in general:

The "a=" line provides the complementary information for the "m=" line with regards to a specified media type/format (e.g. an optional SDP „a=ptime" line for a particular media format).

For a dynamic RTP payload type, for each media information on the codec type shall be provided in a separate SDP "a=rtpmap" line and possibly additional SDP "a=fmtp"-line(s).

3) Application " Media interworking (transcoding)":

See "a=" line specification in (2). Media interworking is limited to audio transcoding only (NOTE 1).

4) IMS media plane security related parameters:

4.1) SRTP-specific security parameters:

The attribute "a=crypto" (see IETF RFC 4568 [29]) shall be provided for an m-line in the local and remote descriptor of an access network termination if the IMS-ALG wants that the corresponding media is encrypted, decrypted and/or integrity protected by the IMS-AGW (IMS end-to-access-edge media plane security). For each m-line, only a single "a=crypto" attribute shall be provisioned (i.e. only information related to a single crypto suite is provisioned to the IMS-AGW). The "a=crypto" attribute may contain several master keys. An IMS-AGW supporting end-to-access-edge media plane security shall support parameters within the "a=crypto" attribute in accordance with the profile in Annex of 3GPP TS 33.328 [34].

4.2) (D)TLS-specific security parameters:

The attribute(s) "a=fingerprint" (see IETF RFC 8122 [55]) shall be provided in accordance with ITU-T Recommendation H.248.90 [48] for an "m="-line in the local and remote descriptor of an access network termination if the IMS-ALG wants that the corresponding media is encrypted, decrypted and/or integrity protected by the IMS-AGW (IMS end-to-access-edge media plane security).

5) Coordination of Video Orientation

The attribute "a=extmap" (see IETF RFC 5285 [41]) may be provided for an m-line in the local and remote descriptor if the IMS-AGW supports the extended RTP header with Coordination of Video Orientation information, see also 3GPP TS 26.114 [26].

6) Generic Image Attribute

The attribute "a=imageattr" (see IETF RFC 6236 [42]) may be provided for an m-line in the local and remote descriptor if the IMS-AGW supports the generic image attributes, see also 3GPP TS 26.114 [26].

The local descriptor indicates the image sizes which the IMS-AGW supports in the receiving direction for the selected payload type and corresponds to the "recv" keyword (see IETF RFC 6236 [42]) in the "a=imageattr" that the IMS-ALG will send within the SDP body on the Mw/Mx interface. The remote descriptor indicates the image sizes

| + +| | | +|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| |

which the IMS-AGW supports in the sending direction for the selected payload type and corresponds to the "send" keyword (see IETF RFC 6236 [42]) in the "a=imageattr" that the IMS-ALG will send within the SDP body on the Mw/Mx interface.

7) ICE support
The attributes "a=candidate", "a=ice-pwd", "a=ice-ufrag" and "a=ice-pacing" (see IETF RFC 8839 [81]) may be provided for an SDP m-line in the local and remote descriptor if the IMS-AGW supports ICE, see also 3GPP TS 24.229 [45]. In the local descriptor, the IMS-ALG shall provide "a=ice-pwd", and "a=ice-ufrag" with wildcard sign "\$" to request the allocation of a password and user name fragment, and the "a=candidate" of type "host" with the transport, port and priority parameters with wildcard sign "\$" to request the allocation of a host candidate, and "a=ice-pacing" with wildcard sign "\$" to request the desired pacing value for connectivity checks. The IMS-AGW shall then reply with completed "a=ice-pwd", "a=ice-ufrag", "a=candidate" and "a=ice-pacing" attributes in the local descriptor, and shall include "a=ice-lite" if it only supports ICE lite. In the remote descriptor, the IMS-ALG may provide the "a=candidate", "a=ice-pwd", "a=ice-ufrag" and "a=ice-pacing".

8) state-agnostic and state-aware TCP handling:
The attribute "a=setup" (see IETF RFC 4145 [20]) shall be provided for TCP-based media, in accordance with ITU-T Recommendation H.248.84 [46], when triggering an end-to-end TCP simultaneous open (leading to a TCP merge mode in the IMS-AGW) or other TCP modes of operation.

9) Application-aware interworking for MSRP traffic:
The attribute "a=path" (see IETF RFC 4975 [11]) shall be provided, when enabling a bearer level application gateway (B-ALG) function for MSRP traffic, according to ITU-T Recommendation H.248.78 [56].

10) Handling of RTCP APP messages when transcoding between EVS and non EVS codecs, or between IVAS and non IVAS codecs:
The attribute "a=3gpp_mtsi_app_adapt" (see 3GPP TS 26.114 [26]) containing the allowed RTCP APP message types shall be provided when the IMS-AGW is allowed to send RTCP APP messages.

11) Pre-defined Video Region-of-Interest (ROI):
The attribute "a=rtcp-fb" with the "Predefined ROI" type expressed by the parameter "3gpp-roi-predefined" may be provided for an m-line in the local and remote descriptor if the IMS-AGW supports the Predefined ROI mode, see also 3GPP TS 26.114 [26]. In addition, the attribute "a=extmap" (see IETF RFC 5285 [41]) may be provided for an m-line in the local and remote descriptor if the IMS-AGW supports the extended RTP header for carriage of pre-defined video Region of Interest (ROI) information in the sent video, see also 3GPP TS 26.114 [26].

12) Arbitrary Video Region of Interest (ROI):
The attribute a=rtcp-fb" with the "Arbitrary ROI" type expressed by the parameter "3gpp-roi-arbitrary" may be provided for an m-line in the local and remote descriptor if the IMS-AGW supports the Arbitrary ROI mode, see also 3GPP TS 26.114 [26]. In addition, the attribute "a=extmap" (see IETF RFC 5285 [41]) may be provided for an m-line in the local and remote descriptor if the IMS-AGW supports the extended RTP header for carriage of arbitrary video Region of Interest (ROI) information in the sent video, see also 3GPP TS 26.114 [26]. .

13) WebRTC data channel:
The attributes "a=sctp-port" and "a=max-message-size" shall be provided in the remote descriptor (see IETF RFC 8841 [68]). In the local descriptor, the IMS-ALG shall provide "a=sctp-port" with omission sign "-" to indicate that the IMS-ALG shall use the same port as for UDP, and "a=max-message-size" with wildcard sign "\$". The IMS-AGW shall then reply with completed "a=sctp-port" and "a=max-message-

| +|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | |

size" attributes in the local descriptor, The attribute "a=dcmmap" shall be provided in the local and remote descriptor, with the parameter "subprotocol" either set to "-" (Application-agnostic data channel configuration) or with real value (Application-aware data channel configuration).

14) Application aware interworking of traffic within a WebRTC data channel:
The attribute "a=dcsa" may be provided in the local descriptor and/or remote descriptor (see IETF RFC 8864 [69], NOTE 3).
T.140 (see ITU-T Recommendation T.140 [75]) is used for Global Text Telephony (GTT). Application aware interworking between the transport according to IETF RFC 8865 [77] within WebRTC data channels and the transport according to IETF RFC 4103 [76] in the IMS core network should be applied for T.140 according to ITU-T Recommendation H.248.94 [67] Appendix 2. For application aware T.140 interworking, the "a= rtpmap" attribute shall be provided with "t140" payload type for the termination towards the IMS core network and "t140" value of the "subprotocol" parameter of the SDP "a=dcmmap" attribute shall be provided for the termination towards the served WIC.

15) SDP Capability Negotiation:
The attributes of "a=acap", "a=tcap", "a=pcfg" and "a=acfg" (see IETF RFC 5939 [72]) may be provided in the local descriptor and/or remote descriptor.

16) Rate adaptation for media endpoints:
If the IMS-AGW performs media transcoding and if the rate adaptation for media endpoints using the enhanced bandwidth negotiation is supported by the IMS-AGW, attribute(s) "a=bw-info" with direction "send" or "sendrecv" may be provided for an m-line and the selected IP payload type and applicable IP version in the remote descriptor.
The following bandwidth properties, as defined in 3GPP TS 26.114 [26], clause 19, may be included in "a=bw-info" line:
<payload type> <dir> <MaxSupBw>, <MaxDesBw>, <MinDesBw>, <MinSupBw> and <IpVer>.

17) "RTP-level pause and resume" signalling:
The "rtcp-fb" SDP attribute with the "ccm" feedback parameter and the "pause" ccm parameter as defined in IETF RFC 7728 [79] may be provided for an m-line in the local and remote descriptor to indicate that the IMS-AGW shall forward RTCP feedback "CCM PAUSE-RESUME" messages transparently.

18) "RTCP Codec Control Commands and Indications" signalling:
The "rtcp-fb" SDP attribute with the "ccm" feedback parameter and the "fir" and/or "tmmbr" ccm parameters as defined in IETF RFC 5104 [78] may be provided for an m-line in the local and remote descriptor to indicate that the IMS-AGW shall be prepared to receive and is allowed to send, respectively, the RTCP CCM feedback messages FIR, and/or TMMBR and TMMBN.

19) DBI signalling:
The "rtcp-fb" SDP attribute with the "3gpp-delay-budget" feedback parameter (as defined in 3GPP TS 26.114 [26] clause 6.2.8) may be provided for an m-line in the local and remote descriptor to indicate that the IMS-AGW shall forward RTCP feedback "DBI" messages (as defined in 3GPP TS 26.114 [26] clause 7.3.8) transparently.

| +| NOTE 1: Media Interworking is optional.
NOTE 2: Table 1 in ITU-T Recommendation H.248.57 [5] provides the correspondent RTCP port allocation rules.
NOTE 3: See IETF RFC 8873 [70] for WebRTC data application 'MSRP'. | | | + +Editor's Note: The support for video transcoding is required for vSRVCC but should be changed from Rel-11, separate CRs would be required for this change. + +## 5.17 Procedures + +### 5.17.1 Formats and Codes + +Table 5.17.1.1 shows the parameters which are required for the procedures defined in the following clauses. + +The coding rules applied in ITU-T Recommendation H.248.1 [10] for the applicable coding technique shall be followed for the UMTS capability set. + +The binary encoding rules which are applicable to the defined Abstract Syntaxes are the Basic Encoding Rules for Abstract Syntax Notation One, defined in ITU-T Recommendation X.690 [22]. Specifically in accordance with ITU-T Recommendation X.690 [22] clause 7.3, alternative encodings based on the definite and indefinite form of length are permitted by the basic encoding rules as a sender's option. Receivers shall support both alternatives. + +Unsupported values of parameters or properties may be reported by the IMS-AGW and shall be supported by the IMS-ALG as such by using H.248.1 error code #449 "Unsupported or Unknown Parameter or Property Value ". The unsupported or unknown value is included in the error text in the error descriptor. + +Table 5.17.1.1: Information Elements Used in Procedures + +| Signalling Object | H.248 Descriptor | Coding | +|------------------------------------------------------------------|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Additional Bandwidth Properties | Remote Descriptor | The "a=bw-info" SDP attribute defined in 3GPP TS 26.114 [26], see table 5.16.1. | +| Allowed RTCP APP message types | Remote Descriptor | The "a=3gpp_mtsi_app_adapt" SDP attribute defined in 3GPP TS 26.114 [26]. | +| Alternate MGC Id | ServiceChange | The MGCIIdToTry parameter in ITU-T Recommendation H.248.1 [10]. | +| Arbitrary ROI | Local Descriptor or Remote Descriptor | The "rtcp-fb" SDP attribute defined in IETF RFC 4585 [21] to indicate the "Arbitrary ROI" RTCP feedback message expressed by the "3gpp-roi-arbitrary" parameter, as described in 3GPP TS 26.114 [26]. | +| Available Realms | Termination State | According to Available Realms property in ITU-T Recommendation H.248.41 [8]. | +| Application-aware MSRP interworking request | LocalControl | This is the ptbalg property from ITU-T Recommendation H.248.78 [56] concerning the configuration of a B-ALG service (for MSRP traffic). | +| BNC Release | Events, ObservedEvents | As for the Events/ObservedEvents Descriptor in clause E.1.2.1/ ITU-T Recommendation H.248.1 [10] "Cause" | +| CCM BASE | Local Descriptor or Remote Descriptor | "rtcp-fb" SDP attribute (defined in IETF RFC 4585 [25]) with the "ccm" feedback parameter and the "fir" and/or "tmmbr" ccm parameters as defined in IETF RFC 5104 [78]. | +| CCM pause-resume | Local Descriptor or Remote Descriptor | "rtcp-fb" SDP attribute (defined in IETF RFC 4585 [25]) with the "ccm" feedback parameter (defined in IETF RFC 5104 [78]) and the "pause" ccm parameter as defined in IETF RFC 7728 [79]. | +| Cause | ObservedEvents | As for the ObservedEvent Parameter in clause E.1.2.1/ ITU-T Recommendation H.248.1 [10] "General cause" | +| Changed Realms | Observed Events | According to Observed Events Parameters for Available Realms Changed event in ITU-T Recommendation H.248.41 [8]. | +| Codec List | Local Descriptor or Remote Descriptor | in a single SDP m-line.
For a static RTP payload type, the codec type should be implied by the RTP payload type, if not then each codec type shall be provided in a separate SDP "a=rtpmap"-line and possibly additional SDP "a=fmtp"-line(s).
For a dynamic RTP payload type, for each codec information on the codec type shall be provided in a separate SDP "a=rtpmap"-line and possibly additional SDP "a=fmtp"-line(s). | +| Connectivity Mode | LocalControl | ITU-T Recommendation H.248.1 [10] Mode property.
Binary Encoding: Encoding as per ITU-T Recommendation H.248.1 Annex A [10] "streamMode"
Textual Encoding: Encoding as per ITU-T Recommendation H.248.1 Annex B [10] "streamMode". | +| Context ID | NA | Binary Encoding: As per ITU-T Recommendation H.248.1 [10] Annex A.
Textual Encoding: As per ITU-T Recommendation H.248.1 [10] Annex B. | +| Cryptographic SDES Attribute | Local Descriptor or Remote Descriptor | "crypto" attribute in SDP a-line as defined in IETF RFC 4568 [29], see 5.16 | +| Delay Variation Tolerance | LocalControl | This is the tman/dvt property from ITU-T Recommendation H.248.53 [7]. | +| Diffserv Code Point | LocalControl | Defined according to the Differentiated Services Code Point property in ITU-T Recommendation H.248.52 [12]. | +| Diffserv Tagging Behaviour | LocalControl | Defined according to the Tagging Behaviour property in ITU-T Recommendation H.248.52 [12]. | +| Discard Incoming TCP Connection Establishment Requests Indicator | LocalControl | Defined according to the Incoming bearer connection establishment blocking property ( tcpbcc/bceb ) in ITU-T Recommendation H.248.89 [47]. | +| ECN Enabled | Local Descriptor or Remote Descriptor | Defined according to the "ECN Enabled" property in ITU-T Recommendation H.248.82 [40]. | +| DBI | Local Descriptor or Remote Descriptor | "rtcp-fb" SDP attribute defined in IETF RFC 4585 [25] with the "3gpp-delay-budget" feedback parameter (as defined in 3GPP TS 26.114 [26] clause 6.2.8). | +| ECN Failure | Events, Observed Events | Defined according to the "ECN Failure" Event in ITU-T Recommendation H.248.82 [40]. | +| ECN Failure Type | ObservedEvents | As for the ObservedEventsDescriptor Parameter "Failure Type" in | + +| | | | +|------------------------------------------------------------------|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Descriptor | ITU-T Recommendation H.248.82 [40]. | +| ECN Initiation Method | Local Descriptor or Remote Descriptor | Defined according to "Initiation Method" property in ITU-T Recommendation H.248.82 [40]. | +| Emergency Call Indication | NA | ITU-T Recommendation H.248.1 [10] 6.1.1 Emergency Call Indicator Binary Encoding: Encoding as per ITU-T Recommendation H.248.1 [10] Annex A "Emergency" context attribute
Textual Encoding: Encoding as per ITU-T Recommendation H.248.1 [10] Annex B "EmergencyToken" context attribute | +| Establish (D)TLS session | Signals | Defined according to the Establish BNC signal ( tlsbsc/EstBNC ) in ITU-T Recommendation H.248.90 [48]. | +| Extended Header For CVO | Local Descriptor or Remote Descriptor | "extmap" attribute in SDP a-line as defined in IETF RFC 5285 [41], see 5.16 | +| Extended RTP Header for Sent ROI | Local Descriptor or Remote Descriptor | "extmap" attribute in SDP a-line to pass on the ROI extended RTP header as defined by IETF RFC 5285 [41] for carriage of predefined and/or arbitrary ROI information, see 5.16 | +| Forward Incoming TCP Connection Establishment Requests Indicator | LocalControl | Defined according to the Interlinkage topology property ( seplink/linktopo ) in ITU-T Recommendation H.248.93 [50]. | +| Generic Image Attribute | Local Descriptor or Remote Descriptor | "imageattr" attribute in SDP a-line as defined in IETF RFC 6236 [46], see table 5.16.1. | +| ICE host candidate request | Local Descriptor | The "a=candidate" SDP attribute defined in IETF RFC 8839 [81] of type "host" with the transport, port and priority parameters with wildcard sign "\$" to request the allocation of a host candidate | +| ICE host candidate | Local Descriptor | The "a=candidate" SDP attribute defined in IETF RFC 8839 [81]. | +| ICE lite indication | Local Descriptor | The "a=ice-lite" SDP attribute defined in IETF RFC 8839 [81]. | +| ICE pacing | Local Descriptor | The "a=ice-pacing" SDP attribute defined in IETF RFC 8839 [81]. Only applicable for full ICE as specified in IETF RFC 8445 [80]. | +| ICE pacing request | Local Descriptor | The "a=ice-pacing" SDP attribute defined in IETF RFC 8839 [81] with wildcard sign "\$".
Only applicable for full ICE as specified in IETF RFC 8445 [80]. | +| ICE password request | Local Descriptor | The "a=ice-pwd" SDP attribute defined in IETF RFC 8839 [81] with wildcard sign "\$". | +| ICE password | Local Descriptor | The "a=ice-pwd" SDP attribute defined in IETF RFC 8839 [81]. | +| ICE received candidate | Remote Descriptor | The "a=candidate" SDP attribute defined in IETF RFC 8839 [81]. | +| ICE received pacing | Remote Descriptor | The "a=ice-pacing" SDP attribute defined in IETF RFC 8839 [81]. Only applicable for full ICE as specified in IETF RFC 8445 [80]. | +| ICE received password | Remote Descriptor | The "a=ice-pwd" SDP attribute defined in IETF RFC 8839 [81]. | +| ICE received Ufrag | Remote Descriptor | The "a=ice-ufrag" SDP attribute defined in IETF RFC 8839 [81]. | +| ICE Ufrag request | Local Descriptor | The "a=ice-ufrag" SDP attribute defined in IETF RFC 8839 [81] with wildcard sign "\$". | +| ICE Ufrag | Local Descriptor | The "a=ice-ufrag" SDP attribute defined in IETF RFC 8839 [81]. | +| ICE Connectivity Check Result | Events, Observed Events | Defined according to Connectivity Check Result event in ITU-T Recommendation H.248.50 [43]. | +| ICE Send Connectivity Check | Signals | Defined as the ostuncc/scc signal in ITU-T Recommendation H.248.50 [43]. | +| ICE New Peer Reflexive Candidate | Events, Observed Events | Defined according to New Peer Reflexive Candidate event in ITU-T Recommendation H.248.50 [43], only applicable for full ICE. | +| ICE Send Additional Connectivity Check | Signals | Defined as the ostuncc/sacc signal in ITU-T Recommendation H.248.50 [43], only applicable for full ICE. | +| Consent freshness test request | Signals | Defined according to stnconfres/contest signal in ITU-T Recommendation H.248.50 [43]. | +| STUN consent freshness test failure | Events, Observed Events | Defined according to stnconfres/confail event in ITU-T Recommendation H.248.50 [43]. | +| Inactivity Timer | Events, Observed Events | Defined according to Inactivity Timeout event in ITU-T Recommendation H.248.14 [11]. | +| IP Address | Local Descriptor or Remote Descriptor | in SDP "c-line" | +| IP Realm | LocalControl | According to IP Realm Identifier property in ITU-T Recommendation H.248.41 [8]. | +| IP Version | Local Descriptor or Remote Descriptor |
in SDP "c-line", see 5.15 | +| Latching | Signals | This is the ipnapt/latch signal in ITU-T Recommendation H.248.37 [4]. | +| Local certificate fingerprint | Local Descriptor | "fingerprint" attribute in SDP "a=" line as defined in IETF RFC 8122 [55] see table 5.16.1. | + +| | | | +|---------------------------------------------------|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local certificate fingerprint Request | Local Descriptor | "fingerprint" attribute in SDP "a=" line as defined in IETF RFC 8122 [55] with wildcard choose "\$". | +| Local Dcmmap | Local Descriptor | The SDP attribute "a=dcmmap" (see IETF RFC 8864 [69]). | +| Local Dcsa | Local Descriptor | The SDP attribute "a=dcsa" (see IETF RFC 8864 [69]). | +| Local SCTP maximum message size Request | Local Descriptor | The SDP attribute "a= max-message-size" (see IETF RFC 8841 [68]) with wildcard sign "\$". | +| Local SCTP maximum message size | Local Descriptor | The SDP attribute "a= max-message-size" (see IETF RFC 8841 [68]) | +| Local SCTP Port Request | Local Descriptor | The SDP attribute "a= sctp-port" (see IETF RFC 8841 [68]) with omission sign "-" to indicate that the same port as for UDP shall be used. | +| Local SCTP Port | Local Descriptor | The SDP attribute "a= sctp-port" (see IETF RFC 8841 [68]) | +| Maximum Burst Size | LocalControl | This is the tman/mbs property from ITU-T Recommendation H.248.53 [7] | +| Media Inactivity Detection | Events, Observed Events | Defined according to ipstop event in ITU-T Recommendation H.248.40 [24]. | +| Media Inactivity Detection Time | Events | As for the Event Parameter in ITU-T Recommendation H.248.40 [24] "Detection Time" | +| Media Inactivity Detection Direction | Events | As for the Event Parameter in ITU-T Recommendation H.248.40 [24] "Direction" | +| Media Type | Local Descriptor or Remote Descriptor | in SDP m-line "audio" or "video" or "-" | +| MSRP Path | Remote Descriptor | The "a=path" SDP attribute defined in IETF RFC 4975 [18]. | +| Notify (D)TLS session establishment Failure Event | ObservedEvents | As for the ObservedEvent Parameter in clause E.1.2.1/ ITU-T Recommendation H.248.1 [10] "General cause" | +| Notify TCP Connection Establishment Failure Event | ObservedEvents | As for the ObservedEvent Parameter in clause E.1.2.1/ ITU-T Recommendation H.248.1 [10] "General cause" | +| Overload Notification | Events, ObservedEvents | This is the chp/mgcon event from ITU-T Recommendation H.248.10 [14] or the ocp/mg_overload event from ITU-T Recommendation H.248.11 [13]. | +| Peak Data Rate | LocalControl | This is the tman/pdr property from ITU-T Recommendation H.248.53 [7]. | +| Policing Required | LocalControl | This is the tman/pol property from ITU-T Recommendation H.248.53 [7]. | +| Port | Local Descriptor or Remote Descriptor | in SDP m-line. | +| Predefined ROI | Local Descriptor or Remote Descriptor | The "rtcp-fb" SDP attribute defined in IETF RFC 4585 [25] to indicate the "Predefined ROI" RTCP feedback message expressed by the "3gpp-roI-predefined" parameter, as described in 3GPP TS 26.114 [26]. | +| Priority Information | NA | Priority Indicator (clause 6.1.1 of ITU-T Recommendation H.248.1 [10])
Binary Encoding: Encoding as per ITU-T Recommendation H.248.1 [10] Annex A "priority" context attribute
Textual Encoding: Encoding as per ITU-T Recommendation H.248.1 [10] Annex B "priority" context attribute | +| Realm Availability Change | Events, Observed Events | According to Available Realms Changed event in ITU-T Recommendation H.248.41 [8]. | +| Received SCTP Stream Reset Request | Events, ObservedEvents | Defined according to the Detect outgoing SCTP Stream reset event ( sctpreset/detreset ) in ITU-T Recommendation H.248.97 [66]. | +| Received SCTP Stream Reset Response | Events, ObservedEvents | Defined according to the Outgoing SCTP Stream reset result event ( sctpreset/result ) in ITU-T Recommendation H.248.97 [66]. | +| Reduction | ObservedEvent Descriptor | As for the ObservedEventDescriptor in clause 4.2.1/ ITU-T Recommendation H.248.10 [14] "MGCongestion". | +| Release (D)TLS session | Signals | Defined according to the Release BNC signal ( tlsbsc/RelBNC ) in ITU-T Recommendation H.248.90 [48]. | +| Remote certificate fingerprint | Remote Descriptor | "fingerprint" attribute in SDP "a=" line as defined in IETF RFC 8122 [55], see table 5.16.1. | +| Remote Dcmmap | Remote Descriptor | The SDP attribute "a=dcmmap" (see IETF RFC 8864 [69]). | +| Remote Dcsa | Remote Descriptor | The SDP attribute "a=dcsa" (see IETF RFC 8864 [69]). | +| Remote SCTP maximum message size | RemoteDescriptor | The SDP attribute "a= max-message-size" (see IETF RFC 8841 [68]) | +| Remote SCTP Port | Remote Descriptor | The SDP attribute "a= sctp-port" (see IETF RFC 8841 [68]) | +| Remote Source Address | LocalControl | Defined according to Remote Source Address Filtering property in | + +| | | | +|--------------------------------------------------------|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Filtering | | ITU-T Recommendation H.248.43 [6]. | +| Remote Source Address Mask | LocalControl | Defined according to Remote Source Address Mask property in ITU-T Recommendation H.248.43 [6]. | +| Remote Source Port Filtering | LocalControl | Defined according to Remote Source Port Filtering property in ITU-T Recommendation H.248.43 [6]. | +| Remote Source Port | LocalControl | Defined according to Remote Source Port property in ITU-T Recommendation H.248.43 [6]. | +| Remote Source Port Range | LocalControl | Defined according to Remote Source Port Range property in ITU-T Recommendation H.248.43 [6]. | +| Reserve_Value | LocalControl | ITU-T Recommendation H.248.1 [10] Reserve property.
Binary Encoding: Encoding as per ITU-T Recommendation H.248.1 [10] Annex A "reserveValue "
Textual Encoding: Encoding as per ITU-T Recommendation H.248.1 [10] Annex B "reservedValueMode". | +| ROOT Properties | Termination State | The properties in clause E.2.1/ ITU-T Recommendation H.248.1 [10] | +| RTCP allocation ((NOTE 1) | Local Control | Defined according to RTCP Allocation Specific Behaviour property in ITU-T Recommendation H.248.57 [5]. | +| RTP/RTCP transport multiplexing | Local Descriptor or Remote Descriptor | The SDP attribute "a=rtcp-mux" according to IETF RFC 5761 [59]. (NOTE 2) | +| explicit RTCP transport address | Remote Descriptor | The SDP attribute "a=rtcp:" according to IETF RFC 3605 [21]. | +| RtcpbwRR | Local Descriptor or Remote Descriptor | in SDP "b:RR"-line. see 5.15 | +| RtcpbwRS | Local Descriptor or Remote Descriptor | in SDP "b:RS"-line. see 5.15 | +| Rtpbw | Local Descriptor or Remote Descriptor | in SDP "b:AS"-line. see 5.15 | +| RTPpayload | Local Descriptor or Remote Descriptor | in SDP m-line. This may be set to CHOOSE (\$) in a LD sent from the IMS-ALG toward the IMS-AGW. | +| SCTP Group Semantics | Termination State | Group Semantics (mgroup/groupse) defined in ITU-T Recommendation H.248.96 [65] with semantics "SCTP" defined in ITU-T Recommendation H.248.97 [66] | +| SCTP stream deaggregation | LocalControl | Stream Deaggregation (mgroup/strdeagg) related semantics "SCTP" defined in ITU-T Recommendation H.248.96 [65] | +| SCTP stream ID | LocalControl | SCTP StreamID (sctpbcc/sctpid) defined in ITU-T Recommendation H.248.97 [66] | +| SDPCapNeg configuration | Local Descriptor or Remote Descriptor | The SDP attributes for SDP capability negotiation as defined in IETF RFC 5939 [72]. | +| SDPCapNeg Supported Capabilities | Termination State | Defined according to SDPCapNeg Extensions property in ITU-T Recommendation H.248.80 [73]. | +| Send SCTP Association Establishment Requests Indicator | Signals | Defined according to the Establish BNC signal (sctpbcc/EstBNC) in ITU-T Recommendation H.248.97 [66]. | +| Send SCTP Stream Reset Requests Indicator | Signals | Defined according to the Initiate Outgoing SCTP Stream Reset signal (sctpres/Initreset) in ITU-T Recommendation H.248.97 [66]. | +| Send SCTP Stream Reset Response Indicator | Signals | Defined according to the Outgoing SCTP Stream Reset Response signal (sctpres/resetresp) in ITU-T Recommendation H.248.97 [66]. | +| Send TCP Connection Establishment Requests Indicator | Signals | Defined according to the Establish BNC signal (tcpbcc/EstBNC) in ITU-T Recommendation H.248.89 [47]. | +| Stream Number | Stream | Encoding as per ITU-T Recommendation H.248.1 [10] Annex B "Stream"/"ST".
For a single stream, this may be omitted by the IMS-ALG. | +| STUN server request | LocalControl | Encoding as per ITU-T Recommendation H.248.50 [43] "MG Act-as STUN Server" (mgastuns) package "Act-as STUN Server" (astuns, 0x0001) property. | +| Sustainable Data Rate | LocalControl | This is the tman/sdr property from ITU-T Recommendation H.248.53 [7]. | +| TCP State-aware Handling Indicator and Setup Direction | Local Descriptor or Remote Descriptor | The "a=setup" SDP attribute as per clause 13.5.1 of ITU-T Recommendation H.248.84 [46]. | +| Termination heartbeat | Events ObservedEvents | As per Termination Heartbeat defined in ITU-T Recommendation H.248.36 [9] Clause 5.2.1. | +| Termination ID | NA | Binary Encoding: As per ITU-T Recommendation H.248.1 [10] | + +| | | | +|----------------|------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Annex A.
Textual Encoding: As per ITU-T Recommendation H.248.1 [10]
Annex B. | +| Transaction ID | NA | Binary Encoding: As per ITU-T Recommendation H.248.1 [10]
Annex A.
Textual Encoding: As per ITU-T Recommendation H.248.1 [10]
Annex B. | +| Transport | Local Descriptor or
Remote Descriptor | in SDP m-line, see 5.15 | + +NOTE 1: Signalling element "RTCP allocation" corresponds to the stage 2 information element "RTCP handling". +NOTE 2: RTP/RTCP transport multiplexing can be agreed with the served UE using the SDP attribute(s) "a=rtcp-mux" and/or "a=rtcp-mux-only" (defined in IETF RFC 8858 [74]), see 3GPP TS 23.334 [23]. However, the SDP attribute "rtcp-mux-only" is not used on Iq interface. + +### 5.17.2 Call Related Procedures + +#### 5.17.2.1 General + +This clause describes the various call related procedures performed by the IMS-AGW, which are listed in table 5.17.2.1.1 + +**Table 5.17.2.1.1: IMS-AGW Call Related Procedures** + +| Transaction defined in
3GPP TS 23.334 [23] | Supported | Comment | +|--------------------------------------------------------|------------------|-------------------------------------------------------------------------------------------------| +| Reserve AGW Connection Point | Mandatory | See 5.17.2.2 | +| Configure AGW Connection Point | Mandatory | See 5.17.2.3 | +| Reserve and Configure AGW Connection Point | Mandatory | See 5.17.2.4 | +| Release AGW Termination | Mandatory | See 5.17.2.5 | +| Termination Heartbeat Indication | Mandatory | See 5.17.2.6 | +| IP Bearer Released | Mandatory | See 5.17.2.7 | +| Media Inactivity Notification | Optional | See 5.17.2.8 | +| Change Through Connection | Mandatory | See 5.17.2.9 | +| Change Flow Direction | Optional | See 5.17.2.10. | +| ECN Failure Indication | Optional | See 5.17.2.11
Only applicable if
ECN endpoint
capability is
supported | +| ICE Connectivity Check Result Notification | Optional | See 5.17.2.12
Only applicable if full
ICE is supported | +| ICE New Peer Reflexive Candidate Notification | Optional | See 5.17.2.13
Only applicable if full
ICE is supported | +| Notify TCP connection establishment Failure Indication | Optional | See 5.17.2.14
Only applicable if
state-aware TCP
handling (proxy
mode) is supported | +| Notify (D)TLS session establishment Failure Indication | Optional | See 5.17.2.15
Only applicable
if IMS media security
for TCP and/or UDP
is supported | +| Notify SCTP Stream Reset | Optional | See 5.17.2.17
Only applicable
if WebRTC data
channels are
supported | +| Notify SCTP Stream Reset Result | Optional | See 5.17.2.18
Only applicable
if WebRTC data
channels are
supported | + +#### 5.17.2.2 Reserve AGW Connection Point + +The IMS-ALG sends an ADD request command as in Table 5.17.2.2.1. + +Table 5.17.2.2.1: Reserve AGW Connection Point Request + +| Address Information | Control information | Bearer information | +|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local Descriptor {
Port = \$
IP Address = \$
IP Version = IPv4 or IPv6
} | Transaction ID = x
If Context Requested:
Context ID= \$
If Emergency Call:
Emergency Call Indication

If MPS call/session:
Priority Indicator = x

If Context Provided:
Context ID = c1

Termination ID = \$
If Stream Number specified:-
Stream Number
If Resources for multiple Codecs required:
Reserve_Value

If IP Interface Type:
IP interface = "IP interface type"

If indication on Bearer Released requested:
NotificationRequested (Event ID = x, "BNC Release")

If diffserv required:-
Diffserv Code Point
If tagging behaviour
Diffserv Tagging Behaviour

If Remote Source Address Filtering required:-
Remote Source Address Filtering
If Remote Source Address range required:
Remote Source Address Mask

If Remote Source Port Filtering required:-
Remote Source Port Filtering
If individual port:
Remote Source Port
If range of ports
Remote Source Port Range

NotificationRequested (Event ID = x, "termination heartbeat")

If IP Realm specified:-
IP Realm

If Latching Required:-
Latching

If Sustainable Data Rate Policing Required:-
Policing Required
Sustainable Data Rate
Maximum Burst Size

If Peak Data Rate Policing Required:
Policing Required | Local Descriptor {
If media is "audio" or "video":
Codec List = Codec List
RTP Payloads = RTP Payload
Rtpbw
If RTCP bandwidth
RtcpbwRS
RtcpbwRR
If RTCP handling required:
RTP/RTCP transport multiplexing (NOTE 5)
If IMS media plane security using SDES required:
Cryptographic SDES Attribute
If IMS media plane security using DTLS-SRTP required:
Local certificate fingerprint Request

If media is "video":
If CVO required:
Extended Header For CVO (NOTE3)
If imageattr negotiation:
Generic Image Attribute (NOTE 4)
If Predefined ROI required:
RTCP feedback for Predefined ROI
Extended Header for Sent ROI
If Arbitrary ROI required:
RTCP feedback for Arbitrary ROI
Extended Header for Sent ROI

If ICE is applied:
ICE host candidate request
ICE password request
ICE Ufrag request
ICE pacing request
If STUN consent freshness test required:
STUN consent freshness request
NotificationRequested(Event ID= x, "STUN consent freshness test failure")

If media is "message" or "application" or "-":
If IMS media plane security required:
Local certificate fingerprint Request
If TCP state-aware handling required:
TCP State-aware Handling Indicator and Setup Direction

If SCTP association for WebRTC data channels:
Local SCTP Port Request
Local SCTP maximum message size Request
Local Dcmmap
If application aware interworking | + +| | | | +|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------| +| |

Peak Data Rate

If Delay Variation Required

Delay Variation Tolerance

If Media Inactivity Detection Required:

NotificationRequested (Event ID = x, "Media Inactivity Detection( Media Inactivity Detection Time, Media Inactivity Detection Direction) ") (NOTE 1)

If RTCP handling required:

RTCP allocation

If ECN transparent support required:

ECN Enable = "True"

Initiation Method = "inactive"

If ECN Endpoint support required

ECN Enable = "True"

Initiation Method = "ECN Initiation Method" (NOTE 2)

If notification of ECN Failure Report:

NotificationRequested (Event ID = x, "ECN Failure")

If ICE is applied:

STUN server request

If Discard Incoming TCP connection establishment request required:

Discard Incoming TCP Connection Establishment Requests Indicator

If Forward Incoming TCP connection establishment request required:

Forward Incoming TCP Connection Establishment Requests Indicator

If indication on TCP connection establishment failure requested:

NotificationRequested (Event ID = x, "TCP connection establishment failure")

If (D)TLS session establishment required:

Establish (D)TLS session

If indication on (D)TLS session establishment failure requested:

NotificationRequested (Event ID = x, "(D)TLS session establishment failure")

If media is "message":

If B-ALG for MSRP required:

Application-aware MSRP interworking request

If SCTP association for WebRTC data channels:

SCTP Group Semantics

|

Local Dcsa

If SDPCapNeg is signalled to the gateway:

SDPCapNeg configuration

}

| +|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------| + +| | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|--| +| | SCTP stream deaggregation
SCTP stream ID
NotificationRequested
(Event ID = x,
"Received SCTP Stream Reset
Request") | | +| NOTE 1: The event parameters "Media Inactivity Detection Time" and "Media Inactivity Detection Direction" are optional.
NOTE 2: This shall be set to a value other than "inactive". See Table 5.14.3.15.1.
NOTE 3: If the IMS-AGW supports the extended RTP header with Coordination of Video Orientation information it shall pass any received extended RTP header with CVO bits on to outgoing RTP streams. If the IMS-AGW is transcoding between video payloads and it supports the extended RTP header with Coordination of Video Orientation information it shall convey received RTP header bytes on the outgoing RTP stream after transcoding associated packets as specified in 3GPP TS 26.114 [26], clause 7.4.5.
NOTE 4: The support of the generic image attributes is optional for the IMS-AGW. The list of image sizes per payload type supported by the IMS-AGW is preconfigured in the IMS-ALG. If none of the image sizes received within an SDP body on Mx/Mw interface is supported by the IMS-AGW then the IMS-ALG will not send the generic image attribute parameter to the IMS-AGW.
NOTE 5: This element is optional. The RTCP port allocation rules are specified in tables 4/1 to 4/5 in ITU-T Recommendation H.248.57 [5]. | | | + +On reserving the termination, the IMS-AGW responds as in Table 5.17.2.2.2. + +Table 5.17.2.2.2: Reserve AGW Connection Point Acknowledge + +| Address Information | Control information | Bearer information | +|-------------------------------------------------------------|-------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local Descriptor {
Port
IP Address
IP Version
} | Transaction ID = x
Context ID = C1
Termination ID = T1
Stream Number | Local Descriptor {
If media is "audio" or "video":

Codec List
RTP Payloads
Rtpbw
If RTCP bandwidth
RtcpbwRS
RtcpbwRR
If IMS media plane security using
SDES was provided in the request:
Cryptographic SDES Attribute
If Local certificate fingerprint for
IMS media plane security using
DTLS-SRTP was requested:
Local certificate fingerprint

If media is "video":
If CVO extension header provided
in the request:
Extended Header For CVO
If image attribute negotiation:
Generic Image Attribute
If Predefined ROI provided in the
request:
RTCP feedback for Predefined
ROI
Extended Header for Sent ROI
If Arbitrary ROI provided in the
request:
RTCP feedback for Arbitrary ROI
Extended Header for Sent ROI

If ICE is applied:
ICE host candidate
ICE password
ICE Ufrag
ICE pacing
If ICE lite implementation
ICE lite indication

If media is "message" or
"application" or "-":
If Local certificate fingerprint was
requested:
Local certificate fingerprint

If SCTP association for WebRTC
data channels:
Local SCTP Port
Local SCTP maximum message
size

If SDPCapNeg is signalled to the
gateway:
SDPCapNeg configuration

} | + +#### 5.17.2.3 Configure AGW Connection Point + +This procedure is used to configure the AGW connection point during session establishment or to reconfigure it during session establishment or after the session is established + +The IMS-ALG sends a MODIFY request command as in Table 5.17.2.3.1. + +Table 5.17.2.3.1: Configure AGW Connection Point Request + +| Address Information | Control information | Bearer information | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| If local resources are modified:
Local Descriptor {
Port
IP Address
IP Version
}
If remote resources are modified:
Remote Descriptor {
Port
IP Address
IP Version
} | Transaction ID = x
Context ID = C1
Termination ID = T1

If MPS priority is modified:
Priority Indicator = x (NOTE 4)

If Stream Number specified:
Stream Number

If Resources for multiple Codecs required:
Reserve_Value

If diffserv required:-
Diffserv Code Point
If tagging behaviour
Diffserv Tagging Behaviour

If Remote Source Address Filtering required:-
Remote Source Address Filtering
If Remote Source Address range required:
Remote Source Address Mask

If Remote Source Port Filtering required:-
Remote Source Port Filtering
If individual port:
Remote Source Port
If range of ports
Remote Source Port Range

NotificationRequested (Event ID = x, "termination heartbeat")

If IP Realm specified:-
IP Realm (NOTE 1)

If Latching Required:-
Latching

If Sustainable Data Rate Policing Required:-
Policing Required
Sustainable Data Rate
Maximum Burst Size

If Peak Data Rate Policing Required:
Policing Required
Peak Data Rate
If Delay Variation Required
Delay Variation Tolerance

If Media Inactivity Detection Required:
NotificationRequested (Event ID = x, "Media Inactivity Detection( Media Inactivity Detection Time, Media Inactivity Detection Direction)") (NOTE 2)

If RTCP handling required: | If local resources are modified:
Local Descriptor {
If media is "audio" or "video":
Codec List
RTP Payloads
Rtpbw
If RTCP bandwidth
RtcpbwRS
RtcpbwRR
If RTCP handling required:
RTP/RTCP transport multiplexing (NOTE 9)
If IMS media plane security using SDES required:
Cryptographic SDES Attribute
If RTP-level pause and resume:
CCM pause-resume
If RTCP Codec Control
Commands and Indications:
CCM BASE
If RTCP Delay Budget Information:
DBI

If media is "video":
If CVO required:
Extended Header For CVO (NOTE 5)
If imageattr negotiation:
Generic Image Attribute (NOTE 6)
If Predefined ROI required:
RTCP feedback for Predefined ROI
Extended Header for Sent ROI
If Arbitrary ROI required:
RTCP feedback for Arbitrary ROI
Extended Header for Sent ROI

If TCP state-aware handling required:
TCP State-aware Handling Indicator and Setup Direction

If SCTP association for WebRTC data channels:
Local Dcmap
If application aware interworking
Local Dcsa

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
}

If remote resources are modified:
Remote Descriptor {
If media is "audio" or "video":
Codec List
RTP Payloads
Rtpbw
If rate adaptation for media endpoints:
Additional Bandwidth Properties (NOTE 10) | + +| | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RTCP allocation | If RTCP bandwidth
RtcpbwRS
RtcpbwRR
If RTCP handling required:
RTP/RTCP transport multiplexing (NOTE 9)
If RTCP handling required:
explicit RTCP transport address (NOTE 8)
If IMS media plane security using SDES required:
Cryptographic SDES Attribute
If IMS media plane security using DTLS-SRTP required:
Remote certificate fingerprint | +| If ECN transparent support required:
ECN Enable = "True"
Initiation Method = "inactive" | | +| If ECN Endpoint support required
ECN Enable = "True"
Initiation Method = "ECN Initiation Method" (NOTE 3) | | +| If notification of ECN Failure Report:
NotificationRequested (Event ID = x, "ECN Failure") | | +| If full ICE is applied:
Send Connectivity Check ("Control")
If notification of ICE Connectivity Check Result Report:
NotificationRequested (Event ID= xx, "Connectivity Check Result")
If notification of New Peer Reflexive Candidate:
NotificationRequested (Event ID = xy, "New Peer Reflexive Candidate")
Send Additional Connectivity Check ("Control") | If RTP-level pause and resume:
CCM pause-resume
If RTCP APP messages allowed
Allowed RTCP APP message Types
If RTCP Codec Control Commands and Indications:
CCM BASE
If RTCP Delay Budget Information:
DBI | +| If Discard Incoming TCP connection establishment request required:
Discard Incoming TCP Connection Establishment Requests Indicator | If media is "message" or "application" or "-":
If IMS media plane security required:
Remote certificate fingerprint
If media is "video":
If CVO required:
Extended Header For CVO (NOTE 5)
If imageattr negotiation:
Generic Image Attribute (NOTE 6)
If Predefined ROI required:
RTCP feedback for Predefined ROI
Extended Header for Sent ROI
If Arbitrary ROI required:
RTCP feedback for Arbitrary ROI
Extended Header for Sent ROI | +| If Forward Incoming TCP connection establishment request required:
Forward Incoming TCP Connection Establishment Requests Indicator | If media is "message":
If B-ALG for MSRP required:
MSRP Path | +| If TCP connection establishment required:
Send TCP Connection Establishment Request Indicator | If ICE is applied:
ICE received candidate
ICE received password
ICE received Ufrag (NOTE 7)
ICE received pacing (NOTE 11)
If STUN consent freshness test required:
STUN consent freshness request
NotificationRequested(Event ID= x, "STUN consent freshness test failure") | +| If indication on TCP connection establishment failure requested:
NotificationRequested (Event ID = x, "TCP connection establishment failure") | If TCP state-aware handling required:
TCP State-aware Handling | +| If (D)TLS session establishment required:
Establish (D)TLS session | | +| If indication on (D)TLS session establishment failure requested:
NotificationRequested (Event ID = x, "(D)TLS session establishment failure") | | +| If (D)TLS session release required:
Release (D)TLS session | | + +| | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| |

If media is "message":
If B-ALG for MSRP required:
Application-aware MSRP interworking request

If SCTP association for WebRTC data channels:
SCTP Group Semantics
SCTP stream deaggregation
SCTP stream ID
NotificationRequested
(Event ID = x,
"Received SCTP Stream Reset Response")

If reset of SCTP Stream for WebRTC data channels:
Send SCTP Stream Reset Requests Indicator
If Notification of reset result desired:
NotificationRequested
(Event ID = x,
"Received SCTP Stream Reset Response")

|

Indicator and Setup Direction

If SCTP association for WebRTC data channels:
Remote SCTP Port
Remote SCTP maximum message size
Remote Dcmap
If application-aware interworking
Remote Dcsa

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration

}

| +|

NOTE 1: This can only be set to the same realm as at the reservation stage. If a different realm is specified, the IMS-AGW shall return error 501 "Not Implemented".

NOTE 2: The event parameters "Media Inactivity Detection Time" and "Media Inactivity Detection Direction" are optional.

NOTE 3: This shall be set to a value other than "inactive". See Table 5.14.3.15.1.

NOTE 4: The support of the modification of the Priority Indicator value is optional for the IMS-AGW and depends on implementation solution for Priority call/session authorisation (see 3GPP TS 23.334 [23]).

NOTE 5: If the IMS-AGW supports the extended RTP header with Coordination of Video Orientation information it shall pass any received extended RTP header with CVO bits on to outgoing RTP streams. If the IMS-AGW is transcoding between video payloads and it supports the extended RTP header with Coordination of Video Orientation information it shall convey received RTP header bytes on the outgoing RTP stream after transcoding associated packets as specified in 3GPP TS 26.114 [26], clause 7.4.5.

NOTE 6: The support of the generic image attributes is optional for the IMS-AGW. The list of image sizes per payload type supported by the IMS-AGW is preconfigured in the IMS-ALG. If none of the image sizes received within an SDP body on Mx/Mw interface is supported by the IMS-AGW then the IMS-ALG will not send the generic image attribute parameter to the IMS-AGW.

NOTE 7: The support of ICE received candidate, ICE received password, ICE received Ufrag are optional for ICE lite, as specified in 3GPP TS 23.334 [23].

NOTE 8: The basic RTCP port allocation rules are defined by table 1 in ITU-T Recommendation H.248.57 [5], which summarizes all rules, with and without the "explicit RTCP transport address" element.

NOTE 9: This element is optional. The RTCP port allocation rules are specified in tables 4/1 to 4/5 in ITU-T Recommendation H.248.57 [5].

NOTE 10: The support of rate adaptation for media endpoints using the additional bandwidth properties is optional for the IMS-AGW. If media transcoding is required the IMS-ALG may provide for the selected payload type and the used IP version the additional bandwidth properties.

NOTE 11: The ICE received pacing is only applicable for full ICE, as specified in IETF RFC 8445 [80].

| | | + +The IMS-AGW responds as in Table 5.17.2.3.2. + +Table 5.17.2.3.2: Configure AGW Connection Point Request Acknowledge + +| Address Information | Control information | Bearer information | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| If local resources were provided in request:
Local Descriptor {
Port
IP Address
IP Version
}
If remote resources are provided in request:
Remote Descriptor {
Port
IP Address
IP Version
} NOTE | Transaction ID = x
Context ID = C1
Termination ID = T1

If Stream Number Specified:
Stream Number | If local resources were provided in request:
Local Descriptor {
If media is "audio" or "video":
Codec List
RTP Payloads
Rtpbw
If RTCP bandwidth
RtcpbwRS
RtcpbwRR
If IMS media plane security using SDES was provided in request:
Cryptographic SDES Attribute
If RTP-level pause and resume:
CCM pause-resume
If RTCP Codec Control
Commands and Indications:
CCM BASE
If RTCP Delay Budget
Information:
DBI

If media is "video":
If CVO extension header provided in the request:
Extended Header For CVO
If image attribute negotiation:
Generic Image Attribute
If Predefined ROI provided in the request:
RTCP feedback for Predefined ROI
Extended Header for Sent ROI
If Arbitrary ROI provided in the request:
RTCP feedback for Arbitrary ROI
Extended Header for Sent ROI

}
If remote resources are provided in request:
Remote Descriptor {
If media is "audio" or "video":
Codec List
RTP Payloads
Rtpbw
If rate adaptation for media endpoints:
Additional Bandwidth Properties
If RTCP bandwidth
RtcpbwRS
RtcpbwRR
If IMS media plane security using SDES was provided in the request:
Cryptographic SDES Attribute
If RTP-level pause and resume:
CCM pause-resume
If RTCP Codec Control
Commands and Indications:
CCM BASE
If RTCP Delay Budget | + +| | | | +|-----------------------------------------------------|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Information:
DBI
If media is "video":
If CVO extension header provided in the request:
Extended Header For CVO
If image attribute negotiation:
Generic Image Attribute
If Predefined ROI provided in the request:
RTCP feedback for Predefined ROI
Extended Header for Sent ROI
If Arbitrary ROI provided in the request:
RTCP feedback for Arbitrary ROI
Extended Header for Sent ROI
} NOTE | +| NOTE: Sending of the Remote Descriptor is optional. | | | + +#### 5.17.2.4 Reserve and Configure AGW Connection Point + +The IMS-ALG sends an ADD request command as in Table 5.17.2.4.1. + +Table 5.17.2.4.1: Reserve and Configure AGW Connection Point Request + +| Address Information | Control information | Bearer information | +|------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local Descriptor {
Port = \$
IP Address = \$
IP Version = IPv4 or IPv6
}
Remote Descriptor {
Port
IP Address
IP Version
} | Transaction ID = x
If Context Requested:
Context ID = \$
If Emergency Call:
Emergency Call Indication

If MPS call/session:
Priority Indicator = x

If Context Provided:
Context ID = c1

Termination ID = \$

If Stream Number Specified:
Stream Number
If Resources for multiple Codecs
shall be reserved:
Reserve_Value

If IP Interface Type:
IP interface = "IP interface type"

If indication on Bearer Released
requested:
NotificationRequested (Event ID =
x, "BNC Release")

If diffserv required:-
Diffserv Code Point
If tagging behaviour
Diffserv Tagging Behaviour

If Remote Source Address Filtering
required:-
Remote Source Address Filtering
If Remote Source Address range
required:
Remote Source Address
Mask

If Remote Source Port Filtering
required:-
Remote Source Port Filtering
If individual port:
Remote Source Port
If range of ports
Remote Source Port Range

NotificationRequested (Event ID = x,
"termination heartbeat")

If IP Realm specified:-
IP Realm

If Latching Required:-
Latching

If Sustainable Data Rate Policing
Required:-
Policing Required
Sustainable Data Rate
Maximum Burst Size

If Peak Data Rate Policing Required: | Local Descriptor {
If media is "audio" or "video":
Codec List
RTP Payloads
Rtpbw
If RTCP bandwidth
RtcpbwRS
RtcpbwRR
If RTCP handling required:
RTP/RTCP transport multiplexing
(NOTE 7)
If IMS media plane security using
SDES required:
Cryptographic SDES Attribute
If IMS media plane security using
DTLS-SRTP required:
Local certificate fingerprint
Request

If RTP-level pause and resume:
CCM pause-resume
If RTCP Codec Control
Commands and Indications:
CCM BASE
If RTCP Delay Budget Information:
DBI

If media is "video":
If CVO required:
Extended Header For CVO
(NOTE 3)
If imageattr negotiation:
Generic Image Attribute
(NOTE 4) If Predefined ROI
required:
RTCP feedback for Predefined
ROI
Extended Header for Sent ROI
If Arbitrary ROI required:
RTCP feedback for Arbitrary ROI
Extended Header for Sent ROI

If ICE is applied:
ICE host candidate request
ICE password request
ICE Ufrag request
ICE pacing request

If media is "message" or
"application" or "-":
If IMS media plane security
required:
Local certificate fingerprint
Request

If TCP state-aware handling
required:
TCP State-aware Handling
Indicator and Setup Direction

If SCTP association for WebRTC
data channels:
Local SCTP Port Request
Local SCTP maximum message
size Request | + +| | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|

Policing Required
Peak Data Rate
If Delay Variation Required
Delay Variation Tolerance

If Media Inactivity Detection Required:
NotificationRequested (Event ID = x, "Media Inactivity Detection( Media Inactivity Detection Time, Media Inactivity Detection Direction)") (NOTE 1)

If RTCP handling required:
RTCP allocation

If ECN transparent support required:
ECN Enable = "True"
Initiation Method = "inactive"

If ECN Endpoint support required
ECN Enable = "True"
Initiation Method = "ECN Initiation Method" (NOTE 2)

If notification of ECN Failure Report:
NotificationRequested (Event ID = x, "ECN Failure")

If ICE is applied:
STUN server request
If full ICE is applied
Send Connectivity Check ("Control")
If notification of ICE Connectivity Check Result Report:
NotificationRequested (Event ID = xx, "Connectivity Check Result")
If notification of New Peer Reflexive Candidate:
NotificationRequested (Event ID = xy, "New Peer Reflexive Candidate")

If Discard Incoming TCP connection establishment request required:
Discard Incoming TCP Connection Establishment Requests Indicator

If Forward Incoming TCP connection establishment request required:
Forward Incoming TCP Connection Establishment Requests Indicator

If indication on TCP connection establishment failure requested:
NotificationRequested (Event ID = x, "TCP connection establishment failure")

If (D)TLS session establishment required:
Establish (D)TLS session

|

Local Dcmap
If application aware interworking
Local Dcsa

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration

}

Remote Descriptor {
If media is "audio" or "video":
Codec List
RTP Payloads
Rtpbw
If rate adaptation for media endpoints:
Additional Bandwidth Properties (NOTE 8)
If RTCP bandwidth
RtcpbwRS
RtcpbwRR
If RTCP handling required:
RTP/RTCP transport multiplexing (NOTE 7)
If RTCP handling required: explicit RTCP transport address (NOTE 6)
If IMS media plane security using SDES required:
Cryptographic SDES Attribute
If IMS media plane security using DTLS-SRTP required:
Remote certificate fingerprint

If RTP-level pause and resume:
CCM pause-resume
If RTCP APP messages allowed
Allowed RTCP APP message types
If RTCP Codec Control Commands and Indications:
CCM BASE
If RTCP Delay Budget Information:
DBI

If media is "video":
If CVO required:
Extended Header For CVO (NOTE 3)
If imageattr negotiation:
Generic Image Attribute (NOTE 4)
If Predefined ROI required:
RTCP feedback for Predefined ROI
Extended Header for Sent ROI
If Arbitrary ROI required:
RTCP feedback for Arbitrary ROI
Extended Header for Sent ROI

If media is "message":
If B-ALG for MSRP required:
MSRP Path

If ICE is applied:
ICE received candidate
ICE received password

| +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| |

If indication on (D)TLS session establishment failure requested:
NotificationRequested (Event ID = x, "(D)TLS session establishment failure")

If media is "message":
If B-ALG for MSRP required:
Application-aware MSRP interworking request

If SCTP association for WebRTC data channels:
SCTP Group Semantics
SCTP stream deaggregation
SCTP stream ID
NotificationRequested (Event ID = x, "Received SCTP Stream Reset Request")

|

ICE received Ufrag (NOTE 5)
ICE received pacing (NOTE 9)
If STUN consent freshness test required:
STUN consent freshness request
NotificationRequested(Event ID= x, "STUN consent freshness test failure")

If media is "message" or "application" or "-":
If IMS media plane security required:
Remote certificate fingerprint

If TCP state-aware handling required:
TCP State-aware Handling Indicator and Setup Direction

If SCTP association for WebRTC data channels:
Remote SCTP Port
Remote SCTP maximum message size
Remote Dmap
If application aware interworking
Remote Dcsa

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration

}

| +|

NOTE 1: The event parameters "Media Inactivity Detection Time" and "Media Inactivity Detection Direction" are optional.

NOTE 2: This shall be set to a value other than "inactive". See Table 5.14.3.15.1.

NOTE 3: If the IMS-AGW supports the extended RTP header with Coordination of Video Orientation information it shall pass any received extended RTP header with CVO bits on to outgoing RTP streams. If the IMS-AGW is transcoding between video payloads and it supports the extended RTP header with Coordination of Video Orientation information it shall convey received RTP header bytes on the outgoing RTP stream after transcoding associated packets as specified in 3GPP TS 26.114 [26], clause 7.4.5.

NOTE 4: The support of the generic image attributes is optional for the IMS-AGW. The list of image sizes per payload type supported by the IMS-AGW is preconfigured in the IMS-ALG. If none of the image sizes received within an SDP body on Mx/Mw interface is supported by the IMS-AGW then the IMS-ALG will not send the generic image attribute parameter to the IMS-AGW.

NOTE 5: The support of ICE received candidate, ICE received password, ICE received Ufrag are optional for ICE lite, as specified in 3GPP TS 23.334 [23].

NOTE 6: The basic RTCP port allocation rules are defined by table 1 in ITU-T Recommendation H.248.57 [5], which summarizes all rules, with and without the "explicit RTCP transport address" element.

NOTE 7: This element is optional. The RTCP port allocation rules are specified in tables 4/1 to 4/5 in ITU-T Recommendation H.248.57 [5].

NOTE 8: The support of rate adaptation for media endpoints using the additional bandwidth properties is optional for the IMS-AGW. If media transcoding is required the IMS-ALG may provide for the selected payload type and the used IP version the additional bandwidth properties.

NOTE 9: The ICE received pacing is only applicable for full ICE, as specified in IETF RFC 8445 [80].

| | | + +The IMS-AGW responds as in Table 5.17.2.4.2. + +Table 5.17.2.4.2: Reserve and Configure AGW Connection Point Request Acknowledge + +| Address Information | Control information | Bearer information | +|----------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local Descriptor {
Port
IP Address
IP Version
}
Remote Descriptor {
Port
IP Address
IP Version
} NOTE | Transaction ID = x
Context ID = C1
Termination ID = T1
Stream Number | Local Descriptor {
If media is "audio" or "video":
Codec List
RTP Payloads
Rtpbw
If RTCP bandwidth
RtcpbwRS
RtcpbwRR
If IMS media plane security
using SDES was provided in the
request:
Cryptographic SDES Attribute
If Local certificate fingerprint for
IMS media plane security using
DTLS-SRTP was requested:
Local certificate fingerprint
If RTP-level pause and resume:
CCM pause-resume
If RTCP Codec Control
Commands and Indications:
CCM BASE
If RTCP Delay Budget
Information:
DBI

If media is "video":
If CVO extension header provided
in the request:
Extended Header For CVO
If image attribute negotiation:
Generic Image Attribute
If Predefined ROI provided in the
request:
RTCP feedback for Predefined
ROI
Extended Header for Sent ROI
If Arbitrary ROI provided in the
request:
RTCP feedback for Arbitrary ROI
Extended Header for Sent ROI

If ICE is applied:
ICE host candidate
ICE password
ICE Ufrag
ICE pacing
If ICE lite implementation
ICE lite indication

If media is "message" or
"application" or "-":
If Local certificate fingerprint was
requested:
Local certificate fingerprint

If SCTP association for WebRTC
data channels:
Local SCTP Port
Local SCTP maximum message
size

If SDPCapNeg is signalled to the
gateway:
SDPCapNeg configuration | + +| | | | +|-----------------------------------------------------|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Remote Descriptor {
If media is "audio" or "video":
Codec List
RTP Payloads
Rtpbw
If rate adaptation for media endpoints:
Additional Bandwidth Properties
If RTCP bandwidth
RtcpbwRS
RtcpbwRR
If IMS media plane security using SDES was provided in the request:
Cryptographic SDES Attribute
If RTP-level pause and resume:
CCM pause-resume
If RTCP Codec Control
Commands and Indications:
CCM BASE
If RTCP Delay Budget
Information:
DBI

If media is "video":
If CVO extension header provided in the request:
Extended Header For CVO
If image attribute negotiation:
Generic Image Attribute
If Predefined ROI provided in the request:
RTCP feedback for Predefined ROI
Extended Header for Sent ROI
If Arbitrary ROI provided in the request:
RTCP feedback for Arbitrary ROI
Extended Header for Sent ROI

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
} NOTE | +| NOTE: Sending of the Remote Descriptor is optional. | | | + +#### 5.17.2.5 Release AGW Termination + +The IMS-ALG sends a SUBTRACT command as in Table 5.17.2.5.1. + +**Table 5.17.2.5.1: Release AGW Termination Request** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1/ALL
Termination ID = T1/ALL | | + +On releasing the termination, the IMS-AGW responds as in Table 5.17.2.5.2 + +**Table 5.17.2.5.2: Release AGW Termination Request Acknowledge** + +| Address Information | Control information | Bearer information | +|----------------------------|----------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = C1/ALL
Termination ID = T1/ALL | | + +#### 5.17.2.6 Termination Heartbeat Indication + +When the procedure "Termination heartbeat indication" is required the following procedure is initiated: the IMS-AGW sends a NOT.req command with the following information. + +##### 5.17.2.6.1 NOT.req (Termination heartbeat) + +| Address Information | Control information | Bearer information | +|----------------------------|----------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Event_ID (Event ID = x, "termination heartbeat") | | + +When the processing of command is complete, the IMS-ALG initiates the following procedure. + +##### 5.17.2.6.2 NOT.resp (Termination heartbeat) + +| Address Information | Control information | Bearer information | +|----------------------------|--------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +The IMS-ALG shall correct any detected mismatch, by subtracting hanging terminations or clearing hanging contexts. + +#### 5.17.2.7 IP Bearer Released + +When the procedure "IP Bearer Released" is required the following procedure is initiated: the IMS-AGW sends a NOT.req command with the following information. + +##### 5.17.2.7.1 NOT.req (IP Bearer Released) + +| Address Information | Control information | Bearer information | +|----------------------------|--------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Event_ID (Event ID = x, "BNC Release (Cause)") | | + +When the processing of command is complete, the IMS-ALG initiates the following procedure. + +##### 5.17.2.7.2 NOT.resp (IP Bearer Released) + +| Address Information | Control information | Bearer information | +|----------------------------|--------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.8 Media Inactivity Notification + +When the procedure "Media Inactivity Notification" is required the following procedure is initiated: the IMS-AGW sends a NOT.req command with the following information. + +##### 5.17.2.8.1 NOT.req (Media Inactivity) + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Event_ID (Event ID = x, "Media Inactivity Detection") | | + +When the processing of command is complete, the IMS-ALG initiates the following procedure. + +##### 5.17.2.8.2 NOT.resp (Media Inactivity) + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.9 Change Through Connection + +The IMS-ALG sends an ADD or a MODIFY request command as in Table 5.17.2.9.1. + +##### 5.17.2.9.1 Change Through Connection Request + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
If Context Requested:
Context ID = \$
If Context Provided:
Context ID = c1

If Termination Requested:
Termination ID = \$
If Termination Provided:
Termination ID = T1

Through-Connection = Connectivity Mode | | + +The IMS-AGW responds as in Table 5.17.2.9.2. + +##### 5.17.2.9.2 Change Through Connection Request Acknowledge + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.10 Change Flow Direction + +The IMS-ALG sends an ADD or a MODIFY request command as in Table 5.17.2.10.1. + +##### 5.17.2.10.1 Change Flow Direction + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
If Context Requested:
Context ID = \$
If Context Provided:
Context ID = c1

If Termination Requested:
Termination ID = \$
If Termination Provided:
Termination ID = T1

Connection Configuration =
(TerminationID= x1,
TerminationID=x2,
[type = x]),... | | + +The IMS-AGW responds as in Table 5.17.2.10.2. + +##### 5.17.2.10.2 Change Flow Direction Acknowledge + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.11 ECN Failure Indication + +The IMS-AGW sends a NOTIFY request command as in Table 5.17.2.11.1. + +**Table 5.17.2.11.1: ECN Failure Indication** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
" ECN Failure (ECN Failure Type)") | | + +The IMS-ALG responds as in Table 5.17.2.11.2 + +**Table 5.17.2.11.2: ECN Failure Indication Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.12 ICE Connectivity Check Result Notification + +The IMS-AGW sends a NOTIFY request command as defined in Table 5.17.2.12.1. + +**Table 5.17.2.12.1: ICE Connectivity Check Result Notification** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
"Connectivity Check Result
(Candidate/Transport Pair)") | | + +The IMS-ALG responds as defined in Table 5.17.2.12.2 + +**Table 5.17.2.12.2: ICE Connectivity Check Result Notification Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.13 ICE New Peer Reflexive Candidate Notification + +The IMS-AGW sends a NOTIFY request command as defined in Table 5.17.2.13.1. + +**Table 5.17.2.13.1: ICE New Peer Reflexive Candidate Notification** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
"New Peer Reflexive Candidate
(Candidate)") | | + +The IMS-ALG responds as defined in Table 5.17.2.13.2 + +**Table 5.17.2.13.2: ICE New Peer Reflexive Candidate Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.14 Notify TCP connection establishment Failure Indication + +When the procedure "Notify TCP connection establishment Failure Indication" is required the following procedure is initiated: the IMS-AGW sends a NOT.req command with the following information. + +**5.17.2.14.1 NOT.req (TCP connection establishment Failure)** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Event_ID (Event ID = y,
"TCP connection establishment
Error Indication") | | + +When the processing of command is complete, the IMS-ALG initiates the following procedure. + +##### 5.17.2.14.2 NOT.resp (TCP connection establishment Failure) + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.15 Notify (D)TLS session establishment Failure Indication + +When the procedure "Notify (D)TLS session establishment Failure Indication" is required the following procedure is initiated: the IMS-AGW sends a NOT.req command with the following information. + +##### 5.17.2.15.1 NOT.req ((D)TLS session establishment Failure) + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Event_ID (Event ID = y,
"(D)TLS session establishment
Error Indication") | | + +When the processing of command is complete, the IMS-ALG initiates the following procedure. + +##### 5.17.2.15.2 NOT.resp ((D)TLS session establishment Failure) + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.16 STUN Consent Freshness Test Failure Notification + +The eIMS-AGW sends a NOTIFY request command as defined in Table 5.17.2.16.1. + +**Table 5.17.2.16.1: STUN Consent Freshness Test Failure Notification** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
"STUN Consent Freshness Test
Failure (STUN Consent
Freshness Test Failure Type)") | | + +The eP-CSCF responds as defined in Table 5.17.2.16.2 + +**Table 5.17.2.16.2: STUN Consent Freshness Test Failure Notification Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.17 Notify SCTP Stream Reset + +The IMS-AGW sends a NOTIFY request command as defined in Table 5.17.2.17.1. + +**Table 5.17.2.17.1: Notify SCTP Stream Reset** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
" Received SCTP Stream Reset
Request (SCTP Stream ID)") | | + +The IMS-ALG responds as defined in Table 5.17.2.17.2 + +**Table 5.17.2.17.2: Notify SCTP Stream Reset Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.18 Notify SCTP Stream Reset Result + +The IMS-AGW sends a NOTIFY request command as defined in Table 5.17.2.18.1. + +**Table 5.17.2.18.1: Notify SCTP Stream Reset Result** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
" Received SCTP Stream Reset
Result (SCTP Stream ID,
result)") | | + +The IMS-ALG responds as defined in Table 5.17.2.18.2 + +**Table 5.17.2.18.2: Notify SCTP Stream Reset Result Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +### 5.17.3 Non-Call Related Procedures + +#### 5.17.3.1 General + +This clause describes the various non-call related procedures which are listed in Table 5.17.3.1.1 + +**Table 5.17.3.1.1: IMS-AGW Non-Call Related Procedures** + +| Transaction in 3GPP TS 23.334 [23] | Support | Comment | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| IMS-AGW Out of service | Mandatory | 5.17.3.2 | +| IMS-AGW Communication Up | Mandatory | 5.17.3.3 | +| IMS-AGW Restoration | Mandatory | 5.17.3.4 | +| IMS-AGW Register | Mandatory | 5.17.3.5 | +| IMS-AGW Re-register | Optional
(NOTE 3) | 5.17.3.6 | +| IMS-ALG Ordered Re-register | Optional
(NOTE 3) | 5.17.3.7 | +| IMS-ALG Restoration | Optional | 5.17.3.8 | +| IMS-ALG Out of Service | Optional | 5.17.3.9 | +| Audit Value | Optional
(NOTE 3) | 5.17.3.10 | +| Command Rejected | Mandatory | The "Command Rejected" procedure may be used in response both to call-related and non-call-related ITU-T Recommendation H.248 Commands – 5.17.3.11 | +| Capability Update | Optional | 5.17.3.12 | +| IMS-AGW Resource Congestion Handling – Activate | Optional | 5.17.3.13 | +| IMS-AGW Resource Congestion Handling – Indication | Optional | 5.17.3.14 | +| Inactivity timeout activation | Optional
(NOTE 4) | 5.17.3.15 | +| Inactivity timeout indication | Optional
(NOTE 4) | 5.17.3.16 | +| Realm Availability Change activation | Optional | 5.17.3.17 | +| Realm Availability Change indication | Optional | 5.17.3.18 | +| Termination Out of Service | Optional
(NOTE 1) | 5.17.3.19 (NOTE 2) | +| NOTE 1: Support of this procedure is mandatory in the IMS-ALG.
NOTE 2: The "Termination Out-of-Service procedure" is also used as a call-related H.248 command
NOTE 3: Support of this procedure is mandatory in the IMS-AGW.
NOTE 4: Support of this procedure is mandatory in the IMS-AGW if UDP transport is supported. | | | + +#### 5.17.3.2 IMS-AGW Out Of Service + +The IMS-AGW sends a SERVICE CHANGE request command as in Table 5.17.3.2.1. + +**Table 5.17.3.2.1: IMS-AGW Out Of Service Request** + +| Address Information | Control information | Bearer information | +|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = FORCED or GRACEFUL
SC Reason = 905 Termination
Taken OOS or 908, MG Impending Failure, or 915 State Loss | | + +The IMS-ALG responds as in Table 5.17.3.2.2. + +**Table 5.17.3.2.2: IMS-AGW Out Of Service Request Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.3 IMS-AGW Communication Up + +The IMS-AGW sends a SERVICE CHANGE request command as in Table 5.17.3.3.1 to the IMS-ALG address to which the control link association was previously established. + +**Table 5.17.3.3.1: IMS-AGW Communication Up** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = DISCONNECTED
SC Reason = 900 , Service Restored | | + +The IMS-ALG may respond as in table 5.17.3.3.2. If a response is received, the control link association is re-established and the inactivity timer would be restarted. + +**Table 5.17.3.3.2: IMS-AGW Communication Up Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT
If required to register to a new IMS-ALG:
Alternate MGC Id | | + +#### 5.17.3.4 IMS-AGW Restoration + +When the IMS-AGW has recovered, the IMS-AGW sends a SERVICE CHANGE as in Table 5.17.3.4.1, + +**Table 5.17.3.4.1: IMS-AGW Restoration** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = RESTART
SC Reason = 900, Service Restored | | + +The IMS-ALG responds as in Table 5.17.3.4.2. + +**Table 5.17.3.4.2: IMS-AGW Restoration Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT
If required to register to a new IMS-ALG:
Alternate MGC Id | | + +#### 5.17.3.5 IMS-AGW Register + +The IMS-AGW sends a SERVICE CHANGE request command as in Table 5.17.3.5.1. + +**Table 5.17.3.5.1: IMS-AGW Register** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = RESTART
SC Reason =901, Cold Boot or 902, Warm Boot
H248 Profile Identity
H248 Protocol Version | | + +The IMS-ALG responds as in Table 5.17.3.5.2. + +**Table 5.17.3.5.2: IMS-AGW Register Ack** + +| Address Information | Control information | Bearer information | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT
If applicable (NOTE):
H248 Protocol Version
If applicable:-
H248 Profile Identity
If required to register to a new IMS-ALG:
Alternate MGC Id | | +| NOTE: The IMS-ALG shall include the H.248 Protocol Version if the protocol version it supports or offers is lower than that proposed by the IMS-AGW. The IMS-ALG may include the H.248 Protocol Version if the protocol version it supports or offers is the protocol version proposed by the IMS-AGW. | | | + +#### 5.17.3.6 IMS-AGW Re-Register + +The IMS-AGW sends a SERVICE CHANGE request command as in Table 5.17.3.6.1. + +**Table 5.17.3.6.1: IMS-AGW Re-Registration** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = Handoff
SC Reason = 903, MGC Directed Change
H248 Profile Identity
H248 Protocol Version | | + +The IMS-ALG responds as in Table 5.17.3.6.2. + +**Table 5.17.3.6.2: IMS-AGW Re-Registration Ack** + +| Address Information | Control information | Bearer information | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT
If applicable (NOTE):
H248 Protocol Version
If applicable:-
H248 Profile Identity
If required to register to a new IMS-ALG:
Alternate MGC Id | | +| NOTE: The IMS-ALG shall include the H.248 Protocol Version if the protocol version it supports or offers is lower than that proposed by the IMS-AGW. The IMS-ALG may include the H.248 Protocol Version if the protocol version it supports or offers is the protocol version proposed by the IMS-AGW. | | | + +#### 5.17.3.7 IMS-ALG Ordered Re-register + +The IMS-ALG sends a SERVICE CHANGE request command as in Table 5.17.3.7.1. + +**Table 5.17.3.7.1: IMS-ALG Ordered Re-Register** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = HANDOFF
SC Reason = 903, MGC Directed Change
Alternate MGC Id | | + +The IMS-AGW responds as in Table 5.17.3.7.2. + +**Table 5.17.3.7.2: IMS-ALG Ordered Re-Register Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +The IMS-AGW then performs an IMS-AGW Re-Register procedure according to Clause 5.17.3.6. + +#### 5.17.3.8 IMS-ALG Restoration + +When the IMS-ALG has recovered, the IMS-ALG sends a SERVICE CHANGE as in Table 5.17.3.8.1, + +**Table 5.17.3.8.1: IMS-ALG Restoration** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = RESTART
SC Reason = 901, Cold Boot OR
902, Warm Boot | | + +The IMS-AGW responds as in Table 5.17.3.8.2. + +**Table 5.17.3.8.2: IMS-ALG Restoration Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.9 IMS-ALG Out of Service + +The IMS-ALG sends a SERVICE CHANGE request command as in Table 5.17.3.9.1. + +**Table 5.17.3.9.1: IMS-ALG Out Of Service** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = FORCED or
GRACEFUL
SC Reason = 905, Termination
Taken OOS | | + +The IMS-AGW responds as in Table 5.17.3.9.2. + +**Table 5.17.3.9.2: IMS-ALG Out Of Service Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.10 Audit Value + +The IMS-ALG sends an AUDIT VALUE request command as in Table 5.17.3.10.1. + +**Table 5.17.3.10.1: Audit Value** + +| Address Information | Control information | Bearer information | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -/ALL/C1
Termination ID =
ROOT/ALL/T1/PartialWildcard
(NOTE 4, NOTE 5)

Audit Packages (NOTE 1)

Audit Descriptor =
IndAuditParameter:=
IndAudMediaDescriptor:=
IndAudTerminationStateDescriptor:=
serviceState
Audit Descriptor = Empty (NOTE 2)

Audit Descriptor =
IndAuditParameter:=
IndAudMediaDescriptor:=
IndAudTerminationStateDescriptor:=
Available Realms (NOTE 3)

Audit Descriptor =
IndAuditParameter:=
IndAudMediaDescriptor:=
IndAudTerminationStateDescriptor:=
ROOT properties (NOTE 6)

Audit Descriptor =
IndAuditParameter:=
IndAudMediaDescriptor:=
IndAudTerminationStateDescriptor:=
SDPCapNeg Supported Capabilities
(NOTE 7) | | +| NOTE 1: Packages is for Null/Root Combination.
NOTE 2: Used for control association monitoring.
NOTE 3: Used for auditing available IP realms
NOTE 4: The partial wildcard termination is used for the context audit (see table 5.17.3.10.3) and specifies the "group" part of the termination identity (e.g. "ip/5/*").
NOTE 5: Partial wildcard shall only be used when text encoding is used on the H.248 interface.
NOTE 6: Used for auditing ROOT properties.
NOTE 7: Used for auditing SDPCapNeg Extensions when SDPCapNeg signalling to the gateway is supported. | | | + +The IMS-AGW responds as in Table 5.17.3.10.2. + +**Table 5.17.3.10.2: Audit Value Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -/C1
Termination ID = ROOT/T1
Packages List
serviceState
Available Realms
ROOT Properties
SDPCapNeg Extensions | | + +Upon reception of the command in the IMS-AGW: + +- The Service State returns the current Service State +- When Packages are requested, the Package Names and Versions are returned +- When realm availability is audited, the list of available realms is returned. + +- When root properties are audited, the values of root properties are returned. + +The following table illustrates the allowed combinations that can be obtained with the AuditValue Command: + +**Table 5.17.3.10.3: Combinations of AuditValue Command** + +| ContextID | TerminationID | Information Obtained | +|----------------------------------------------------------------------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------| +| Specific | Wildcard | Audit of matching Terminations in a Context | +| Specific | Specific | Audit of a single Termination in a Context | +| Null | Root | Audit of Media Gateway state and/or control association or available realms, or supported packages or ROOT properties. | +| All | Specific | (Non-null) ContextID in which the Termination currently exists | +| All | Partial Wildcard | (Non-null) ContextIDs in which the Terminations currently exist | +| NOTE: Partial wildcard shall only be used when text encoding is used on the H.248 interface. | | | + +#### 5.17.3.11 Command Rejected + +When the procedure "Command Reject" is required the following procedure is initiated: + +The IMS-AGW / IMS-ALG sends a response to any command.req with the following information. + +**Table 5.17.3.11.1: ANYcommand.resp (command reject ) IMS-AGW / IMS-ALG to IMS-ALG/ IMS-AGW** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1 or no context
Termination ID = T1 or no termination ID

Reason=Error | | + +#### 5.17.3.12 AGW Capability Change + +The IMS-AGW sends a SERVICE CHANGE request command as in Table 5.17.3.12.1. + +**Table 5.17.3.12.1: AGW Capability Update** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = RESTART or DISCONNECTED
SC Reason = 916, Packages Change or 917, Capability Change | | + +The IMS-ALG responds as in table 5.17.3.12.2. + +**Table 5.17.3.12.2 AGW Capability Update Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.13 IMS-AGW Resource Congestion Handling – Activate + +The IMS-ALG sends a MODIFY request command as in Table 5.17.3.13.1 + +**Table 5.17.3.13.1: IMS-AGW Resource Congestion Handling – Activate** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT

NotificationRequested (Event ID = x, "Overload Notification") | | + +The IMS-AGW responds as in Table 5.17.3.13.2. + +**Table 5.17.3.13.2: IMS-AGW Resource Congestion Handling – Activate Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.14 IMS-AGW Resource Congestion Handling – Indication + +The IMS-AGW sends a NOTIFY request command as in Table 5.17.3.14.1 + +**Table 5.17.3.14.1: IMS-AGW Resource Congestion Handling – Indication** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT

If H.248.11 used:
Event_ID (Event ID = x, "Overload Notification")

If H.248.10 used:
Event_ID (Event ID = x, "Overload Notification (Reduction)") | | + +The IMS-ALG responds as in Table 5.17.3.14.2 + +**Table 5.17.3.14.2: IMS-AGW Resource Congestion Handling – Indication Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.15 Inactivity Timeout – Activation + +The IMS-ALG sends a MODIFY request command as in Table 5.17.3.15.1 + +**Table 5.17.3.15.1: Inactivity Timeout – Activation** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= NULL
Termination ID = ROOT

NotificationRequested (Event ID = x, "Inactivity Timeout") | | + +The IMS-AGW responds as in Table 5.17.3.15.2. + +**Table 5.17.3.15.2: Inactivity Timeout – Activation Ack** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = NULL
Termination ID = ROOT | | + +#### 5.17.3.16 Inactivity Timeout – Indication + +The IMS-AGW sends a NOTIFY request command as in Table 5.17.3.16.1. + +**Table 5.17.3.16.1: Inactivity Timeout – Indication** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= NULL
Termination ID = ROOT
Event_ID (Event ID = x, "Inactivity Timeout") | | + +The IMS-ALG responds as in Table 5.17.3.16.2 + +**Table 5.17.3.16.2: Inactivity Timeout – Indication Ack** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = NULL
Termination ID = ROOT | | + +#### 5.17.3.17 Realm Availability Change – Activation + +The IMS-ALG sends a MODIFY request command as in Table 5.17.3.17.1. + +**Table 5.17.3.17.1: Realm Availability Change – Activation** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT

NotificationRequested (Event ID = x, "Realm Availability Change") | | + +The IMS-AGW responds as in Table 5.17.3.17.2. + +**Table 5.17.3.17.2: Realm Availability Change – Activation Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.18 Realm Availability Change – Indication + +The IMS-AGW sends a NOTIFY request command as in Table 5.17.3.18.1. + +**Table 5.17.3.18.1: Realm Availability Change – Indication** + +| Address Information | Control information | Bearer information | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT

Event_ID (Event ID = x,
"Realm Availability Change
(Changed Realms)") | | +| NOTE: The ObservedEvent Parameters returned within the Changed Realms are defined as mandatory since it shall contain at minimum 1 parameter but may contain both Newly Available Realms and Newly Unavailable Realms. | | | + +The IMS-ALG responds as in Table 5.17.3.18.2 + +**Table 5.17.3.18.2: Realm Availability Change – Indication Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.19 Termination Out Of Service + +This procedure only applies when text encoding is used on the H.248 interface. + +The IMS-AGW sends a SERVICE CHANGE request command as in Table 5.17.3.19.1. + +**Table 5.17.3.19.1: Termination Out Of Service Request** + +| Address Information | Control information | Bearer information | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1/ALL
Termination ID = T1 or Wildcarded Termination (NOTE)
SC Method = FORCED
SC Reason = 904 ("Termination Malfunction") or 905 ("Termination Taken OOS") or 906 ("Loss of Lower Layer Connectivity"), or 907 ("Transmission Failure") or 910 ("Media Capability Failure") | | +| NOTE: This is set to a specific termination identity or a partially wildcarded identity (i.e. specifying the "interface" part of the termination ID and wildcarding the "group" and "Id" parts) or a wholly wildcarded identity (i.e. ip/*). | | | + +The IMS-ALG responds as in Table 5.17.3.19.2. + +**Table 5.17.3.19.2: Termination Out Of Service Request Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1/ALL
Termination ID = As received | | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29335/raw.md b/marked/Rel-18/29_series/29335/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..8613b0e2d705295d9d711eb7212e077d65a69b0b --- /dev/null +++ b/marked/Rel-18/29_series/29335/raw.md @@ -0,0 +1,719 @@ + + +# 3GPP TS 29.335 V18.0.0 (2024-03) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; User Data Convergence (UDC); User Data Repository Access Protocol over the Ud interface; Stage 3 (Release 18)** + +![LTE Advanced Pro logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for LTE Advanced Pro. It features the word "lte" in a bold, lowercase font. Above the "e" is the text "Advanced Pro" in a smaller font. To the right of the "e" is a green signal icon consisting of three curved lines. A small "TM" symbol is located at the bottom right of the "e". + +LTE Advanced Pro logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo. It features the letters "3GPP" in a stylized, bold font. The "3" and "G" are connected at the top. Below the "P" is a red signal icon consisting of three curved lines. Below the logo, the text "A GLOBAL INITIATIVE" is written in a smaller, all-caps font. A small "TM" symbol is located at the bottom right of the "P". + +3GPP logo + + + +## --- **Keywords** + +GSM, UMTS, network, IP, Multimedia MAP, IN + +### **3GPP** + +### --- **Postal address** + +### --- **3GPP support office address** + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +### --- **Internet** + + + +## --- **Copyright Notification** + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# --- Contents + +| | | +|-------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 9 | +| 4 Protocol Stack ..... | 9 | +| 4.1 General ..... | 9 | +| 4.2 Protocol Stack for Ud Data Access Messages ..... | 9 | +| 4.3 Protocol Stack for Ud Subscriptions/Notifications ..... | 9 | +| 5 General Messages ..... | 10 | +| 5.1 General ..... | 10 | +| 5.2 Open Link for a LDAP Session..... | 10 | +| 5.3 Close Link for a LDAP Session ..... | 10 | +| 5.4 Transactions ..... | 10 | +| 5.5 SOAP Authentication..... | 11 | +| 6 User Data Convergence Messages..... | 11 | +| 6.1 General ..... | 11 | +| 6.2 Query..... | 11 | +| 6.3 Create ..... | 11 | +| 6.4 Delete ..... | 11 | +| 6.5 Update ..... | 11 | +| 6.6 Subscribe..... | 12 | +| 6.7 Notify ..... | 12 | +| 6.8 Abandon operation ..... | 13 | +| 7 Information Elements..... | 13 | +| 7.1 Information Element Types with LDAP ..... | 13 | +| 7.2 Information Elements for Subscriptions and Notifications..... | 14 | + +| | | | +|-------------------------------|---------------------------------------------------------------|-----------| +| 8 | Security ..... | 14 | +| Annex A (normative): | SOAP Subscription and Notification..... | 15 | +| A.1 | XML schema for Subscribe Request ..... | 15 | +| A.2 | XML schema for Subscribe Response..... | 15 | +| A.3 | XML schema for Notify Request..... | 16 | +| A.4 | XML schema for Notify Response ..... | 17 | +| Annex B (informative): | LDAP Message flows and Transaction flows for UDC ..... | 18 | +| B.1 | General LDAP Message flow for UDC ..... | 18 | +| B.2 | LDAP Transaction flows for UDC ..... | 18 | +| Annex C (informative): | Messages Based on SOAP..... | 20 | +| C.1 | General..... | 20 | +| C.2 | Protocol Stack for Messages Based on SOAP ..... | 20 | +| C.3 | SOAP Based Query..... | 21 | +| C.4 | SOAP Based Create ..... | 21 | +| C.5 | SOAP Based Delete ..... | 21 | +| C.6 | SOAP Based Update ..... | 21 | +| C.7 | SOAP Based Abandon ..... | 22 | +| Annex D (informative): | Change history..... | 23 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document specifies the stage 3 of the Ud interface between the Front-Ends (FEs) and the User Data Repository (UDR) in the User Data Convergence (UDC architecture). + +This 3GPP Technical Specification (TS) specifies the protocol and interactions between the FE and the UDR for Ud reference point, in particular: + +- The details of the LDAP protocol that are to be considered +- The details of the SOAP envelope that provide support for subscriptions to notifications and notifications about data changes service (S/N operations). + +The User Data Convergence Stage 2 description (architecture and information flows) is specified in 3GPP TS 23.335 [10]. + +The UDR data model used with LDAP (i.e. attributes, object classes and directory information tree) is implementation specific and is left outside the scope of 3GPP specifications. For multivendor interoperability between FEs and UDR specific integration projects are needed. Some examples of Ud data models are described in 3GPP TR 29.935 [19]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TR 41.001: "GSM Release specifications". +- [3] 3GPP TR 21 912 (V3.1.0): "Example 2, using fixed text". +- [4] IETF RFC 4510: "Lightweight Directory Access Protocol (v3)". +- [5] IETF RFC 5805: "Lightweight Directory Access Protocol (LDAP) Transactions". +- [6] W3C Recommendation "Simple Object Access Protocol (SOAP) 1.2" (27 April 2007). . +- [7] Void. +- [8] IETF RFC 4511: "Lightweight Directory Access Protocol (LDAP): The Protocol". +- [9] IETF RFC 4528: "Lightweight Directory Access Protocol (LDAP) Assertion Control". +- [10] 3GPP TS 23.335: "User Data Convergence (UDC); Technical realization and information flows". +- [11] IETF RFC 4512: "Lightweight Directory Access Protocol (LDAP): Directory Information Models". +- [12] 3GPP TS 32.182: "Telecommunication management; User Data Convergence (UDC); Common Baseline Information Model". +- [13] Void + +- [14] Void +- [15] 3GPP TS 33.210: "3G Security; Network Domain Security; IP network layer security". +- [16] IETF RFC 4513: "Lightweight Directory Access Protocol (LDAP): Authentication Methods and Security Mechanisms". +- [17] National Institute of Standards and Technology, FIPS Pub 197: Advanced Encryption Standard (AES), 26 November 2001. . +- [18] OASIS "Directory Services Markup Language v2.0" (30 April 2002) . +- [19] 3GPP TR 29.935: "Study on UDC Data Model". +- [20] OASIS: " Web Services Security: SOAP Message Security 1.1 OASIS Standard Specification, 1 February 2006", . +- [21] OASIS: "Web Services Security: "UsernameToken Profile 1.1 OASIS Standard Specification, 1 February 2006", . + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**LDAP Session:** starts with LDAP Bind Operation and ends with LDAP Unbind Operation or Notice of Disconnection. + +**Front End:** a core network functional entity or service layer entity or provisioning entity that can access user data stored in a unique repository. + +**Front End Identifier:** A name that uniquely identifies an FE within the set of all FEs accessing an UDR. + +**Front End Cluster:** FEs handling the same application may be grouped in clusters to differentiate between them e.g. with regard to geographical location, feature support, vendor, or other characteristics. All FEs within a cluster are treated equally for required purposes (e.g. authorization, notifications, etc.). + +**Application type:** The application handled by a FE (e.g. HLR) determines the application type of the FE. The application type is derived from the name indicated by a FE. + +**Front End Cluster Identifier:** A name that identifies a cluster grouped with FEs supporting the same application. + +**User Data Repository:** facility where user data can be accessed stored and managed in a common way. + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +Ud reference point between a FE and the UDR + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-----|-------------------------| +| FE | Front End | +| UDR | User Data Repository | +| NDS | Network Domain Security | + +# 4 Protocol Stack + +## 4.1 General + +Data access messages on the Ud interface shall make use of IETF RFC 4510 [4] and IETF RFC 4511 [8]. See clause 4.2 for details. + +Subscription messages and Notification messages on the Ud interface shall make use of SOAP [6]. See clause 4.3 for details. + +## 4.2 Protocol Stack for Ud Data Access Messages + +Figure 4.2-1 shows the protocol layering used for UDR data access. + +![Diagram showing the protocol layering for Data Access on the Ud interface between FE and UDR.](2ba086df3506f81bae3a9b53725dcfea_img.jpg) + +The diagram illustrates the protocol stack for data access on the Ud interface. It consists of two vertical columns of protocol layers, labeled 'FE' (Front End) on the left and 'UDR' (User Data Repository) on the right, with the 'Ud' interface between them. Both columns contain five identical layers, stacked from top to bottom: LDAP, TCP, IP, L2, and L1. Horizontal lines connect corresponding layers in the FE and UDR columns across the Ud interface. + +| | | | +|------|----|------| +| LDAP | | LDAP | +| TCP | | TCP | +| IP | | IP | +| L2 | | L2 | +| L1 | | L1 | +| FE | Ud | UDR | + +Diagram showing the protocol layering for Data Access on the Ud interface between FE and UDR. + +Figure 4.2-1 Protocol Layering for Data Access + +## 4.3 Protocol Stack for Ud Subscriptions/Notifications + +Figure 4.3-1 shows the protocol layering used for Ud Subscription/Notification. + +![Figure 4.3-1: Protocol Layering for Subscription/Notification. The diagram shows two protocol stacks, FE (Front-End) on the left and UDR (User Data Repository) on the right, connected by a vertical line labeled 'Ud'. Both stacks have five layers: SOAP, HTTP / HTTPS, TCP/IP, L2, and L1. The layers are aligned horizontally across the Ud interface.](e6df2733626a85205c1db682e6259c46_img.jpg) + +| | | | +|--------------|----|--------------| +| SOAP | | SOAP | +| HTTP / HTTPS | | HTTP / HTTPS | +| TCP/IP | | TCP/IP | +| L2 | | L2 | +| L1 | | L1 | +| FE | Ud | UDR | + +Figure 4.3-1: Protocol Layering for Subscription/Notification. The diagram shows two protocol stacks, FE (Front-End) on the left and UDR (User Data Repository) on the right, connected by a vertical line labeled 'Ud'. Both stacks have five layers: SOAP, HTTP / HTTPS, TCP/IP, L2, and L1. The layers are aligned horizontally across the Ud interface. + +Figure 4.3-1 Protocol Layering for Subscription/Notification + +# 5 General Messages + +## 5.1 General + +This clause describes common messages for UDC to establish sessions and administrate transactions. For an existing session, UDC messages are exchanged between the FE and the UDR. See figure B.1-1 in Annex B for general LDAP message flows. + +## 5.2 Open Link for a LDAP Session + +To initiate a LDAP session, a Front-End shall first establish a transport connection with the UDR. The transport connection shall be a TCP connection. The IP Layer may be secured according to clause 8. When IPsec is used, an IPsec connection may support several TCP connections, each supporting a LDAP session. + +After establishment of the transport connection, the FE shall initiate a LDAP session by sending a LDAP BindRequest message. The establishment of the LDAP session shall comply with IETF RFC 4511 [8]. It shall be done before sending any other LDAP message. FE Identifier or FE Cluster Identifier shall be included in the BindRequest message. + +The UDR shall support the "unauthenticated authentication mechanism of simple Bind" and the "name/password authentication mechanism of simple Bind" in the "simple authentication method" specified in IETF RFC 4513 [16]. + +The UDR derives the application type from the FE Identifier or the FE Cluster Identifier. If the FE provided the Front End Identifier the UDR may also derive the Front End Cluster Identifier. + +NOTE: As security is handled at IP Layer (see clause 8), optional security mechanisms (TLS, SASL) described in IETF RFC 4513 [16] specification are not required for Ud. + +## 5.3 Close Link for a LDAP Session + +Termination of the LDAP session may be initiated by the FE by sending an UnbindRequest message or by the UDR by sending a Notice of Disconnection message. The termination of the LDAP session shall comply with IETF RFC 4511 [8]. + +## 5.4 Transactions + +In order to allow FEs to relate a number of update operations, such as Create (see 6.3), Delete (see 6.4), and Update (see 6.5), and have them performed in one unit of interaction, the transaction concept in IETF RFC 5805 "Lightweight + +Directory Access Protocol (LDAP) Transactions" [5] shall be supported. See figure B.2-1 in Annex B for LDAP Transaction flow. + +If used, they shall only be used for a single subscriber in order to decrease the complexity of transactions. + +LDAP server shall terminate the transaction if the timer is expired. + +## 5.5 SOAP Authentication + +The UDR may support the SOAP WS-Security extension [20] and "UsernameToken" authentication as specified by the Oasis Web Services Security [21]. + +The WS-Security Username field may be set to a value that is correlated with the username of the LDAP BindRequest (see clause 5.2). + +NOTE: As security is handled at the IP Layer (see clause 8), optional security mechanisms (i.e. signature, encryption and passwordDigest) as described in the Oasis Web Services Security specifications [20][21] are not required for the Ud interface. + +# --- 6 User Data Convergence Messages + +## 6.1 General + +The Query, Create, Delete and Update messages for UDC shall comply with IETF RFC 4511[8]. + +## 6.2 Query + +Query request messages shall be coded as LDAP SearchRequest messages. + +Query result messages shall be coded as LDAP SearchResultEntry, SearchResultReference, and SearchResultDone messages. + +## 6.3 Create + +Create request messages shall be coded as LDAP AddRequest messages or as LDAP ModifyRequest messages with the "operation" field set to "add", depending on the data to be created. + +Create result messages shall be coded as LDAP AddResponse messages or as LDAP ModifyResponse messages, depending on the used LDAP request message. + +## 6.4 Delete + +Delete request messages shall be coded as LDAP DelRequest messages or as LDAP ModifyRequest messages with the "operation" field set to "delete", depending on the data to be deleted. + +Delete result messages shall be coded as LDAP DelResponse messages or as LDAP ModifyResponse messages, depending on the used LDAP request message. + +The LDAP assertion control as specified in IETF RFC 4528 [9] may be used for conditional delete operation if the FE knows that the UDR supports the corresponding control. + +## 6.5 Update + +Update request messages shall be coded as LDAP ModifyRequest messages with "operation" field set to "replace". + +Update result messages shall be coded as LDAP ModifyResponse messages. + +The LDAP assertion control as specified in IETF RFC 4528 [9] may be used for conditional update operation if the FE knows that the UDR supports the corresponding control. + +## 6.6 Subscribe + +Subscribe request messages shall make use of the HTTP Post method and contain a SOAP message envelope. + +Subscribe response messages shall be coded as HTTP response message and shall contain a SOAP envelope. + +Subscribe request and response messages shall contain a SOAP message envelope header with a header block containing the following elements: + +- msgId +This element uniquely identifies the Subscribe message request – response pair within a connection. The msgId is of type integer. The FE shall allocate the value and use it together with the connId (if any) to correlate a received subscribe response with a sent subscribe request. +- connId +This optional element identifies the connection between FE and UDR. The connId is of type integer. If used, the value is allocated by the FE and is used together with the msgId to correlate a subscribe response with a subscribe request. + +Optionally, the Subscribe request SOAP message envelope may contain an authentication ws-security header block and a UsernameToken element containing the following elements: + +- Username +- Password + +An example of a SOAP envelope header for a Subscribe request message is given below: + +``` + + + + http://udfe.example.org:8080/UDRNotificationService + + password + + + + 25409 + 2 + + +``` + +The UDR shall copy the SOAP Envelope CorrelationHeader received in the Subscribe request and send it unmodified in the Subscribe response. + +Subscribe request messages shall contain a SOAP message envelope body formatted according to the XML schema defined in Annex A. + +Subscribe response messages shall contain an empty SOAP message envelope body, unless SOAP Fault element is included to indicate detailed error information. The HTTP status code in the Subscribe response message is used to indicate success or failure. + +A Subscribe request containing several subscriptions shall be managed in an atomic manner. In the event where at least one requestedData elements among several within a Subscribe request is rejected, the Subscribe response shall report a failure and none of the requestedData elements within this Subscribe request shall be accepted by the UDR. A SOAP Fault element may be included to indicate detailed error information relevant to the first error encountered. + +## 6.7 Notify + +Notify request messages shall make use of the HTTP Post method and contain a SOAP message envelope. + +Notify response messages shall be coded as HTTP response message and shall contain a SOAP message envelope. + +Notify request and response messages shall contain a SOAP message envelope header with a header block containing the following elements: + +- **serviceName** +This optional element identifies a service in the Front End. The value is copied from the Subscribe message or pre-configured in the UDR. The **serviceName** is of type string with up to 20 characters. +- **msgId** +This element uniquely identifies the Notify message request – response pair within a connection. The **msgId** is of type integer. The UDR shall allocate the value and use it together with the **connId** (if any) to correlate a received notify response with a sent notify request. +- **connId** +This optional element identifies the connection between the UDR and the FE. The **connId** is of type integer. If used, the value is allocated by the UDR and is used together with the **msgId** to correlate a notify response with a notify request. + +An example of a SOAP envelope header for a Notify request message is given below: + +``` + + + HLR-FE + 787627350 + 1 + + +``` + +Application Front Ends shall copy the SOAP Envelope Header received in the Notify request and send it unmodified in the Notify response. + +Notify request messages shall contain a SOAP message envelope body formatted according to the XML schema defined in Annex A. + +Notify response messages shall contain an empty SOAP message envelope body, unless SOAP Fault element is included to indicate detailed error information. The HTTP status code in the Notify response message is used to indicate success or failure. + +## 6.8 Abandon operation + +When a FE wishes to abandon an uncompleted operation towards the UDR, it shall send a LDAP AbandonRequest message. + +# --- 7 Information Elements + +## 7.1 Information Element Types with LDAP + +Information elements and their type to be used in the messages on a given Ud interface for the LDAP Search, Add, Delete and Modify operations are dependent of the application type of the Ud interface. They are described in a LDAP Directory Schema associated to this application type. The general content and structure of a LDAP Directory Schema is described in IETF RFC 4512 [11]. + +NOTE: The LDAP Directory Schema associated to an application type relates to the application data view mentioned in 3GPP TS 23.335 [10]. + +When Information elements that are used on a given Ud interface are addressed in 3GPP TS 32.182 [12], their description in the LDAP Directory Schema associated to the application type of this Ud interface shall comply with 3GPP TS 32.182 [12]. + +## 7.2 Information Elements for Subscriptions and Notifications + +Information elements and their type to be used for subscriptions and notifications about data changes shall also follow the rules specified above in 7.1 and according to the formats/schemas defined in Annex A. + +# --- 8 Security + +Ud interface shall provide security with the methods specified in 3GPP TS 33.210 [15] + +Application sensitive data (e.g. permanent authentication keys K/Ki) shall be stored encrypted in the UDR and transferred encrypted over Ud. All FEs (e.g. HLR/HSS/AuC) handling sensitive data, accessing the same UDR and handling the same users (e.g. belonging to the same cluster) shall use the same mechanism and key for decrypting these data. The Application FEs shall support at least AES [17] as a common algorithm, and may support additional algorithms. The key for encryption/decryption is not subscriber-specific. + +Editor's note: details of AES (modes of operation, key lengths, data formats, etc.) are to be completed. + +Editor's note: statement above must be reviewed and confirmed by SA3 + +# Annex A (normative): SOAP Subscription and Notification + +## A.1 XML schema for Subscribe Request + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +The `serviceName` element is optional and, when present, identifies a service in the Front End. The `serviceName` is stored in the UDR and is used when the Notify message is sent. The `serviceName` is of type string with up to 20 characters. + +## A.2 XML schema for Subscribe Response + +The SOAP message envelope body shall be empty. + +## A.3 XML schema for Notify Request + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +## A.4 XML schema for Notify Response + +The SOAP message envelope body shall be empty. + +# Annex B (informative): LDAP Message flows and Transaction flows for UDC + +## B.1 General LDAP Message flow for UDC + +![Sequence diagram showing the general LDAP message flow between FE and UDR. The flow starts with an LDAP Bind Request from FE to UDR, followed by an LDAP Bind Response from UDR to FE. This is followed by an LDAP XXX Request from FE to UDR, an LDAP XXX Response from UDR to FE, and an LDAP Unbind Request from FE to UDR. The UDR then sends an LDAP Unbind Response from UDR to FE. Alternatively, the UDR can send an LDAP Notice of Disconnection from UDR to FE. The messages from the Bind Request to the Unbind Request are grouped as an 'LDAP Session'.](33a8f3f01dfa8bce75d23017855a13c5_img.jpg) + +``` +sequenceDiagram + participant FE + participant UDR + Note right of UDR: LDAP Session + FE->>UDR: LDAP Bind Request + UDR-->>FE: LDAP Bind Response + Note right of UDR: ..... + FE->>UDR: LDAP XXX Request + UDR-->>FE: LDAP XXX Response + Note right of UDR: ..... + FE->>UDR: LDAP Unbind Request + UDR-->>FE: LDAP Unbind Response + Note right of UDR: OR + UDR-->>FE: LDAP Notice of Disconnection +``` + +Sequence diagram showing the general LDAP message flow between FE and UDR. The flow starts with an LDAP Bind Request from FE to UDR, followed by an LDAP Bind Response from UDR to FE. This is followed by an LDAP XXX Request from FE to UDR, an LDAP XXX Response from UDR to FE, and an LDAP Unbind Request from FE to UDR. The UDR then sends an LDAP Unbind Response from UDR to FE. Alternatively, the UDR can send an LDAP Notice of Disconnection from UDR to FE. The messages from the Bind Request to the Unbind Request are grouped as an 'LDAP Session'. + +Figure B.1-1. General LDAP Message flow + +Figure B.1-1 illustrates the general LDAP message flow associated to a LDAP session for UDC, in compliance with IETF RFC 4511[8]. + +## B.2 LDAP Transaction flows for UDC + +Figure B.2-1 illustrates the LDAP transaction flow for UDC. The procedures described in IETF RFC 5805 "Lightweight Directory Access Protocol (LDAP) Transactions" [5] are applied. + +![Sequence diagram of LDAP Transaction flow between FE and UDR.](4356776ca004ecba5d599667a155d7d4_img.jpg) + +``` +sequenceDiagram + participant FE + participant UDR + Note right of UDR: One Transaction + FE->>UDR: 1. Start Transaction Request + UDR-->>FE: 2. Start Transaction Response (Transaction ID) + FE->>UDR: 3. LDAP XXX Request/Response (Transaction ID) + Note left of FE: ..... + FE->>UDR: 4. LDAP XXX Request/Response (Transaction ID) + FE->>UDR: 5. End Transaction Request (Transaction ID) + UDR-->>FE: 6. End Transaction Response +``` + +The diagram illustrates the LDAP Transaction flow between a Front End (FE) and a User Data Repository (UDR). The sequence of messages is as follows: 1. FE sends a Start Transaction Request to UDR; 2. UDR responds with a Start Transaction Response containing a Transaction ID; 3. FE sends an LDAP XXX Request/Response with the Transaction ID; 4. UDR responds with an LDAP XXX Request/Response with the Transaction ID (indicated by a '.....' placeholder); 5. FE sends an End Transaction Request with the Transaction ID; 6. UDR responds with an End Transaction Response. A bracket on the right side of the UDR lifeline, spanning from step 2 to step 6, is labeled 'One Transaction'. + +Sequence diagram of LDAP Transaction flow between FE and UDR. + +**Figure B.2-1. LDAP Transaction flow** + +1. When the FE needs to bind more than one operation to the UDR in one FE session, the FE issues a Start Transaction Request to UDR to begin a transaction. +2. When receiving a Start Transaction Request, the UDR checks whether the transaction is allowed, e.g. check whether the number of the concurrent transaction exceeds the limit. If the transaction is allowed, the UDR returns a Start Transaction Response with an identity of the transaction assigned by the UDR to the FE and store the transaction identity temporarily until the transaction ends or expires. Otherwise, a Start Transaction Response with the failure code is returned. +- 3-4. If the result code indicates failure, the following steps are skipped and the procedure terminates. Otherwise, the FE issues the operations to the UDR with the transaction identity received in the Start Transaction Response message from the UDR. The operations with the same transaction identity are in the same transaction. +5. After all or some of the operations are performed, the FE sends an End Transaction Request with the transaction identity to the UDR to commit or rollback the transaction according to the application logic of the FE. +6. When commitment is indicated in the End Transaction Request, the UDR commits all the updates made. If all the updates are committed successfully, a success response is indicated in the End Transaction Response. Otherwise, all the updates are rolled back and the data remains as it was before the transaction and failure is indicated in the End Transaction Response. When rollback is indicated in the End Transaction Request, the UDR cancels all the updates made and return the End Transaction Response with the cancel result to the FE. + +# Annex C (informative): Messages Based on SOAP + +## C.1 General + +Some Front Ends which do not have high real time performance requirements would prefer to interact with the UDR on the basis of a SOAP protocol for data access (CRUD) as well as for Subscriptions and Notifications (S/N). A way to accomplish this is by means of a protocol converter that converts SOAP based data access messages into LDAP based data access messages. SOAP based Subscription and Notification messages need not be converted. The architectural options are shown in figure C.1/1: + +![Figure C.1/1: Data access options based on SOAP. The diagram shows four Front End (FE) blocks at the top connected to a single UDR block at the bottom. The first FE (HLR/HSS FE) connects directly to the UDR using LDAP (CRUD) and SOAP (S/N) messages. The second FE (no high real time requirements) connects to the UDR via an internal Protocol Converter that converts SOAP (CRUD) to LDAP (CRUD), while SOAP (S/N) messages pass through. The third FE (no high real time requirements) connects to the UDR via an external Protocol Converter that converts SOAP (CRUD) to LDAP (CRUD), while SOAP (S/N) messages pass through. The fourth FE (no high real time requirements) connects to the UDR via a Protocol Converter integrated into the UDR that converts SOAP (CRUD) to LDAP (CRUD), while SOAP (S/N) messages pass through.](a734898ce18e972938949637c32a34f4_img.jpg) + +Figure C.1/1: Data access options based on SOAP. The diagram shows four Front End (FE) blocks at the top connected to a single UDR block at the bottom. The first FE (HLR/HSS FE) connects directly to the UDR using LDAP (CRUD) and SOAP (S/N) messages. The second FE (no high real time requirements) connects to the UDR via an internal Protocol Converter that converts SOAP (CRUD) to LDAP (CRUD), while SOAP (S/N) messages pass through. The third FE (no high real time requirements) connects to the UDR via an external Protocol Converter that converts SOAP (CRUD) to LDAP (CRUD), while SOAP (S/N) messages pass through. The fourth FE (no high real time requirements) connects to the UDR via a Protocol Converter integrated into the UDR that converts SOAP (CRUD) to LDAP (CRUD), while SOAP (S/N) messages pass through. + +**Figure C.1/1: Data access options based on SOAP** + +As shown in the Figure C.1/1, the Protocol Converter that converts SOAP based data access messages to LDAP based data access messages can be stand alone, be integrated into the FE or be integrated into the UDR. LDAP based data access (CRUD) messages and SOAP based Subscription and Notification (S/N) messages are specified in the normative part of this specification. A description of SOAP based data access messages which are exchanged between FEs without high realtime performance requirements and the Protocol Converter is given in this informative annex. + +**NOTE:** An application that does not have high real time requirements implies that it does not demand neither high values of traffic throughput nor small request/response latency values nor high demanding processing needs. + +## C.2 Protocol Stack for Messages Based on SOAP + +The protocol layering used for messages based on SOAP described in this informative annex is the same as shown in Figure 4.3-1 in the normative part of this specification. + +## --- C.3 SOAP Based Query + +SOAP Based Query request messages make use of the HTTP Post method and contain a SOAP message envelope. + +SOAP Based Query response messages are coded as HTTP response message and contain a SOAP envelope. + +Query request messages contain a SOAP message envelope body formatted according to the XML schema defined in OASIS DSML [18] related to SearchRequest. + +Query response messages contain a SOAP message envelope body formatted according to the XML schema defined in OASIS DSML [18] related to SearchResultEntry, SearchResultReference, and SearchResultDone. The HTTP status code in the Query response message is used to indicate success or failure. + +## --- C.4 SOAP Based Create + +SOAP Based Create request messages make use of the HTTP Post method and contain a SOAP message envelope. + +SOAP Based Create response messages are coded as HTTP response message and contain a SOAP envelope. + +Create request messages contain a SOAP message envelope body formatted according to the XML schema defined in OASIS DSML [18] related to AddRequest or ModifyRequest with the "operation" field set to "add". + +Create response messages contain a SOAP message envelope body formatted according to the XML schema defined in OASIS DSML [18] related to AddResponse or ModifyResponse depending on the used request message. The HTTP status code in the Create response message is used to indicate success or failure. + +## --- C.5 SOAP Based Delete + +SOAP Based Delete request messages make use of the HTTP Post method and contain a SOAP message envelope. + +SOAP Based Delete response messages are coded as HTTP response message and contain a SOAP envelope. + +Delete request messages contain a SOAP message envelope body formatted according to the XML schema defined in OASIS DSML [20] related to DelRequest or ModifyRequest with the "operation" field set to "delete". + +Delete response messages contain a SOAP message envelope body formatted according to the XML schema defined in OASIS DSML [20] related to DelResponse or ModifyResponse depending on the used request message. The HTTP status code in the Delete response message is used to indicate success or failure. + +## --- C.6 SOAP Based Update + +SOAP Based Update request messages make use of the HTTP Post method and contain a SOAP message envelope. + +SOAP Based Update response messages are coded as HTTP response message and contain a SOAP envelope. + +Update request messages contain a SOAP message envelope body formatted according to the XML schema defined in OASIS DSML [18] related to ModifyRequest with the "operation" field set to "replace". + +Update response messages contain a SOAP message envelope body formatted according to the XML schema defined in OASIS DSML [18] related to ModifyResponse. The HTTP status code in the Update response message is used to indicate success or failure. + +## --- C.7 SOAP Based Abandon + +SOAP Based Abandon request messages make use of the HTTP Post method and contain a SOAP message envelope. Abandon request messages contain a SOAP message envelope body formatted according to the XML schema defined in OASIS DSML [18] related to AbandonRequest. + +# Annex D (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +|---------|--------|-----------|------|-----|-----|---------------------------------------------------------------------------|--------| +| 2010-03 | CT#47 | CP-100052 | | | | 3GPP TS presented for information and approval. | 9.0.0 | +| 2010-06 | CT#48 | CP-100282 | 0001 | 1 | | Removal of not used references | 9.1.0 | +| | | | 0002 | 1 | | Reference to draft removed | | +| | | | 0003 | 2 | | Removal of security editor's note | | +| 2010-09 | CT#49 | CP-100459 | 0004 | 4 | | Subscription and Notification Messages | 9.2.0 | +| 2011-03 | CT#51 | CP-110055 | 0007 | 4 | | Messages Based on SOAP | 10.0.0 | +| 2011-06 | CT#52 | CP-110267 | 0010 | 1 | | UDC Notifications and Service Name | 10.1.0 | +| | | | 0012 | 1 | | UDC Notifications and original entity | | +| 2012-09 | CT#57 | CP-120469 | 0013 | 1 | | UDC Data Model in TS 29.335 | 11.0.0 | +| 2012-12 | CT#58 | CP-120721 | 0017 | - | | SOAP Fault in Subscribe and Notify Response messages | 11.1.0 | +| 2014-09 | - | - | - | - | | Update to Rel-12 version (MCC) | 12.0.0 | +| 2015-12 | - | - | - | - | | Update to Rel-13 version (MCC) | 13.0.0 | +| 2016-06 | CT#72 | CP-160235 | 0019 | 1 | | Authentication on the Ud SOAP Interface | 13.1.0 | +| 2016-06 | CT#72 | CP-160235 | 0020 | 1 | | SOAP Subscription Request containing several subscriptions error handling | 13.1.0 | +| 2016-06 | | | | | | References [20] and [21] corrected | 13.1.1 | +| 2017-03 | CT#75 | - | - | - | | Update to Rel-14 version (MCC) | 14.0.0 | +| 2018-06 | CT#80 | - | - | - | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | CT#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | +| 2021-12 | CT#94e | CP-213104 | 0021 | - | F | Reference update: removal of RFC 2616 | 17.0.0 | +| 2024-03 | - | - | - | - | | Update to Rel-18 version (MCC) | 18.0.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29368/raw.md b/marked/Rel-18/29_series/29368/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..372ed731913b661c74924b0b4b51655a4ec31d40 --- /dev/null +++ b/marked/Rel-18/29_series/29368/raw.md @@ -0,0 +1,1296 @@ + + +# 3GPP TS 29.368 V18.0.0 (2024-03) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Tsp interface protocol between the MTC Interworking Function (MTC-IWF) and Service Capability Server (SCS) (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +## --- **Keywords** + +--- + +UMTS, LTE, QoS, Charging, Policy + +## **3GPP** + +## --- **Postal address** + +### --- **3GPP support office address** + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## --- **Internet** + +--- + + + +## --- **Copyright Notification** + +--- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions, symbols and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Symbols..... | 6 | +| 3.3 Abbreviations ..... | 6 | +| 4 Tsp reference point..... | 7 | +| 4.1 Tsp Reference model..... | 7 | +| 4.2 Functional elements..... | 7 | +| 4.2.1 SCS..... | 7 | +| 4.2.2 MTC-IWF..... | 7 | +| 5 Procedures over Tsp reference point..... | 8 | +| 5.1 General ..... | 8 | +| 5.2 Reference number handling ..... | 8 | +| 5.3 MTC-IWF selection ..... | 8 | +| 5.4 MTC-IWF load control ..... | 9 | +| 5.5 Request and confirmation of a device trigger ..... | 9 | +| 5.6 Notification of Device trigger ..... | 10 | +| 5.7 Request and confirmation of a device trigger recall request ..... | 10 | +| 5.8 Request and confirmation of a device trigger replace request ..... | 11 | +| 5.9 Delivery of a MSISDN-less MO-SMS..... | 11 | +| 6 Tsp protocol ..... | 12 | +| 6.1 Protocol support ..... | 12 | +| 6.1.1 Use of Diameter base protocol ..... | 12 | +| 6.1.2 Transport protocol ..... | 12 | +| 6.1.3 Advertising Application Support..... | 12 | +| 6.2 Initialization and maintenance of connection and session ..... | 13 | +| 6.3 Security on the Tsp interface..... | 13 | +| 6.3.1 General ..... | 13 | +| 6.3.2 Mutual authentication..... | 13 | +| 6.3.3 Security profiles..... | 14 | +| 6.4 Tsp specific AVPs..... | 14 | +| 6.4.1 General ..... | 14 | +| 6.4.2 Device-Action AVP..... | 15 | +| 6.4.3 Device-Notification AVP ..... | 15 | +| 6.4.4 Trigger-Data AVP ..... | 16 | +| 6.4.5 Payload AVP ..... | 16 | +| 6.4.6 Action-Type AVP..... | 16 | +| 6.4.7 Priority-Indication AVP ..... | 16 | +| 6.4.8 Reference-Number AVP ..... | 17 | +| 6.4.9 Request-Status AVP ..... | 17 | +| 6.4.10 Delivery-Outcome AVP ..... | 18 | +| 6.4.11 Application-Port-Identifier AVP ..... | 19 | +| 6.4.12 Old-Reference-Number AVP ..... | 19 | +| 6.4.13 Feature-Supported-In-Final-Target AVP ..... | 19 | +| 6.5 Tsp re-used AVPs..... | 19 | +| 6.5.1 General ..... | 19 | +| 6.5.2 Supported-Feature-List AVP..... | 20 | +| 6.5.2.1 Use of the Supported-Features AVP..... | 20 | +| 6.5.2.2 Supported-Feature-List AVP for the Tsp application..... | 20 | +| 6.6 Tsp Messages ..... | 21 | +| 6.6.1 Command-Code Values..... | 21 | + +| | | | +|-------------------------------|-------------------------------------------------|-----------| +| 6.6.2 | Device-Action-Request (DAR) command ..... | 21 | +| 6.6.3 | Device-Action-Answer (DAA) command..... | 22 | +| 6.6.4 | Device-Notification-Request (DNR) command ..... | 22 | +| 6.6.5 | Device-Notification-Answer (DNA) command ..... | 22 | +| Annex A (informative): | Tsp Message Flows..... | 24 | +| A.1 | General..... | 24 | +| A.2 | Tsp Submission, T4 Delivery..... | 24 | +| A.3 | Tsp failed Submission..... | 25 | +| A.4 | Tsp Submission, Failed T4 Delivery..... | 26 | +| A.5 | Tsp Recall Submission, Recall Success..... | 27 | +| A.6 | Tsp Recall Submission, Recall Failure ..... | 28 | +| A.7 | Tsp Replace Submission, Replace Success..... | 28 | +| A.8 | Tsp Replace Submission, Replace Failure ..... | 29 | +| A.9 | Delivery of a MSISDN-less MO-SMS ..... | 31 | +| B.1 | General ..... | 32 | +| B.2 | SCS behaviour..... | 32 | +| B.3 | MTC-IWF behaviour..... | 32 | +| Annex C (informative): | Change history..... | 33 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document provides the stage 3 specification of the Tsp reference point for the present release. The functional requirements and the stage 2 specifications of the Tsp reference point are contained in TS 23.682 [2]. The Tsp reference point lies between the Service Capability Server (SCS) and the Machine Type Communication Inter Working Function (MTC-IWF). + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications". +- [3] 3GPP TS 29.329: "Sh Interface based on the Diameter protocol". +- [4] IETF RFC 791: "Transmission Control Protocol". +- [5] IETF RFC 2234: "Augmented BNF for syntax specifications". +- [6] IETF RFC 3588: "Diameter Base Protocol". +- [7] IETF RFC 4006: "Diameter Credit Control Application". + +- [8] IETF RFC 4960: "Stream Control Transmission Protocol". +- [9] IETF RFC 5719: "Updated IANA Considerations for Diameter Command Code Allocations". +- [10] 3GPP TS 33.210: "Network Domain Security (NDS); IP network layer security". +- [11] 3GPP TS 33.310: "Network Domain Security (NDS); Authentication Framework (AF)". +- [12] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications". +- [13] 3GPP TS 29.303: "Domain Name System Procedures; Stage 3". +- [14] 3GPP TS 23.003: "Numbering, addressing and identification". +- [15] 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS)". +- [16] 3GPP TS 29.229: "Cx and Dx interfaces based on the Diameter protocol". +- [17] 3GPP TS 29.337: "Diameter-based T4 interface for communications with packet data networks and applications". +- [18] IETF RFC 6733: "Diameter Base Protocol". +- [19] IETF RFC 8583: "Diameter Load Information Conveyance". +- [20] 3GPP TS 29.338: "Diameter based protocols to support SMS capable MMEs". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +## 3.2 Symbols + +For the purposes of the present document, no symbols are defined. + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|-----|--------------------------------| +| AVP | Attribute Value Pair | +| CEA | Capabilities-Exchange-Answer | +| CER | Capabilities-Exchange-Request | +| DAA | Device-Action-Answer | +| DAR | Device-Action-Request | +| DNA | Device-Notification-Answer | +| DNR | Device-Notification-Request | +| DNS | Domain Name System | +| ESP | Encapsulating Security Payload | +| IKE | Internet Key Exchange | +| IWF | Inter Working Function | +| MTC | Machine Type Communication | +| PKI | Public key infrastructure | +| SCS | Service Capability Server | +| TLS | Transport Layer Security | + +# 4 Tsp reference point + +## 4.1 Tsp Reference model + +The Tsp reference point is defined between the Service Capability Server (SCS) and the Machine Type Communication Inter Working Function (MTC-IWF). The relationships between the different functional entities involved are depicted in figure 4.1.1. + +![Figure 4.1.1: Tsp reference point at 3GPP Architecture for Machine-Type Communication. The diagram shows a UE (MTC UE Application) connected to a RAN, which is connected to an SGSN/MME/MSC. The SGSN/MME/MSC is connected to an HSS, an SMS-SC/GMSC/IWMSC, and an MTC-IWF. The MTC-IWF is connected to a CDF/CGF and a Services Capability Server (SCS). The SCS is connected to an Application Server (AS). The Tsp reference point is indicated between the MTC-IWF and the SCS. The legend indicates that dashed lines represent the control plane and solid lines represent the user plane. The RAN is connected to the UE via Um/Uu/LTE-Uu interfaces. The SGSN/MME/MSC is connected to the HSS via S6m. The SMS-SC/GMSC/IWMSC is connected to the HSS via T4. The MTC-IWF is connected to the CDF/CGF via Rf/Ga.](0236eff05bcb8f3a343ea7933aaa306b_img.jpg) + +Figure 4.1.1: Tsp reference point at 3GPP Architecture for Machine-Type Communication. The diagram shows a UE (MTC UE Application) connected to a RAN, which is connected to an SGSN/MME/MSC. The SGSN/MME/MSC is connected to an HSS, an SMS-SC/GMSC/IWMSC, and an MTC-IWF. The MTC-IWF is connected to a CDF/CGF and a Services Capability Server (SCS). The SCS is connected to an Application Server (AS). The Tsp reference point is indicated between the MTC-IWF and the SCS. The legend indicates that dashed lines represent the control plane and solid lines represent the user plane. The RAN is connected to the UE via Um/Uu/LTE-Uu interfaces. The SGSN/MME/MSC is connected to the HSS via S6m. The SMS-SC/GMSC/IWMSC is connected to the HSS via T4. The MTC-IWF is connected to the CDF/CGF via Rf/Ga. + +Figure 4.1.1: Tsp reference point at 3GPP Architecture for Machine -Type Communication + +## 4.2 Functional elements + +### 4.2.1 SCS + +The SCS is the entity which connects MTC application servers to the 3GPP network to enable them to communicate through specific 3GPP defined services with UEs used for MTC and with the MTC-IWF in the HPLMN. The SCS offers capabilities for use by one or multiple MTC application servers. + +An SCS can be connected to one or more MTC-IWFs. + +The SCS is controlled by the operator of the HPLMN or by a MTC Service Provider. + +### 4.2.2 MTC-IWF + +The MTC-IWF resides in the HPLMN. An MTC-IWF could be a standalone entity or a functional entity of another network element. The MTC-IWF hides the internal PLMN topology and relays or translates information sent over Tsp to invoke specific functionality in the PLMN. + +An MTC-IWF can be connected to one or more SCSs. + +The functionality of the MTC-IWF includes the following: + +- terminates the Tsp, S6m, T4 and Rf/Ga reference points; +- supports ability to authorize the SCS before communication establishment with the 3GPP network; + +- supports ability to authorize control plane requests from an SCS; +- supports the following device trigger functionality: + - reception of a device trigger request from SCS; + - reception of a device trigger recall/replace request from SCS; + - reporting to the SCS the acceptance or non-acceptance of the device trigger request; + - reporting to the SCS the acceptance or non-acceptance of the device trigger recall/replace request; +- reports to the SCS the success, failure or unconfirmed outcome of a device trigger delivery; +- reports to the SCS the success, failure or unconfirmed outcome of the device trigger recall/replace request; +- provides load control information to SCS as part of the response to trigger requests; +- for MSISDN-less MO-SMS, delivers a payload and application port ID and the external ID of the UE to the SCS; +- supports ability for secure communication between the 3GPP network and the SCS. + +The architecture allows the use of multiple MTC-IWFs within a HPLMN. + +# --- 5 Procedures over Tsp reference point + +## 5.1 General + +The following procedures apply over the Tsp reference point: + +- Request and confirmation of a device trigger +- Notification of a device trigger +- Recalling or replacing of an already submitted device trigger +- Delivery of a MSISDN-less MO-SMS + +## 5.2 Reference number handling + +The reference number shall be assigned by the SCS. The reference number shall be provided by the SCS to the MTC-IWF in the first procedure initiated for a specific target of a specific action request (e.g. for a device trigger request towards a specific MTC device). The MTC-IWF and SCS shall use this reference number for all consecutive related procedures (e.g. for a confirmation of device trigger and notification of device trigger). + +The reference number shall be kept in MTC-IWF and in SCS until all related procedures for a specific target of a specific action request initiated by the SCS are completed (e.g. until the notification of device trigger is completed). + +For each new specific action request other than Device Trigger Recall Request, the SCS shall assign a reference number, which is different from any other reference number it has previously assigned to any other another action request with not yet completed related procedures. + +## 5.3 MTC-IWF selection + +To discover the MTC-IWF with which to establish the Tsp session, the SCS may use: + +- a pre-configured MTC-IWF identity +- DNS + +- Diameter routing + +For DNS, the Domain Name System procedures as specified in TS 29.303 [13] may be used by the SCS for MTC-IWF selection. The External Identifier is defined in TS 23.003 [14] and is composed of Domain Identifier and Local Identifier. The DNS query can be performed deriving the domain name to be resolved from the Domain Identifier part of the External Identifier. + +For Diameter Routing, the Destination Realm should be derived from the Domain Identifier part of the External Identifier. + +## 5.4 MTC-IWF load control + +Upon receiving a device action request from the SCS: + +- if the MTC-IWF determines that the SCS has reached or exceeded the quota of Tsp requests that it is allowed to send, the MTC-IWF may respond to the SCS with a Device-Action-Answer command containing the Request-Status AVP with the value set to QUOTAEXCEEDED. +- if the MTC-IWF determines that the SCS has exceeded its rate of initiating Tsp requests, the MTC-IWF may respond to the SCS with a Device-Action-Answer command containing the Request-Status AVP with a value set to RATEEXCEEDED. +- if the MTC-IWF is in an overload condition, the MTC-IWF may respond to the SCS with a Device-Action-Answer command containing the Result-Code AVP with the value set to DIAMETER\_TOO\_BUSY, see IETF RFC 6733 [18]. + +For the above cases, the SCS on receiving the response from MTC-IWF, may provide an indication of the failed request to the application requesting services to the SCS. + +Alternatively, for RATEEXCEEDED and DIAMETER\_TOO\_BUSY, the SCS may implement a backoff timer which when running the SCS does not initiate Tsp requests to the MTC-IWF. Once the timer expires, the SCS may attempt to use the MTC-IWF which was formerly in an overload condition or for which SCS had exceeded the rate of Tsp requests. The algorithm the SCS uses for the backoff timer is out of scope of the 3GPP specification. + +## 5.5 Request and confirmation of a device trigger + +In order to request the MTC-IWF to perform a device trigger, the SCS shall send a Device-Action-Request command with the following AVP values within the Device-Action AVP: + +- Action-Type AVP set to the value Device Trigger Request (1). +- Either MSISDN AVP or External-Id AVP set to the identifier of the MTC device to be triggered. +- SCS-Identity AVP, containing the identity of the SCS that is requesting a device trigger to the UE. +- Reference-Number AVP, containing a newly assigned reference number the SCS has assigned to the specific action request. +- Trigger-Data AVP containing data to be sent to the MTC device with the trigger by the MTC-IWF in the Payload AVP, priority of the trigger in the Priority-Indication AVP and the triggering application addressed in the device indicated in the Application-Port-Identifier AVP. +- Validity-Time AVP, indicating the validity time of the device trigger request since the time the device action request has been received by the MTC-IWF. + +After the MTC-IWF has received from the SCS a Device-Action-Request command with device action set to Device Trigger Request (1), after receiving the Device-Trigger-Answer from SMS-SC, the MTC-IWF shall confirm the status of a device trigger request to the SCS by sending a Device-Action-Answer command and shall include the following AVP values within the Device-Notification AVP: + +- Action-Type AVP set to the value Device Trigger Request (1). +- Reference-Number AVP, containing the reference number received from the SCS for the specific action request. + +- c) Request-Status AVP set to value indicating the status of the device trigger request requested by the SCS. + +The MTC-IWF may also include the following AVP within the Device-Notification AVP: + +- a) Either MSISDN AVP or External-Id AVP set to the identifier of the MTC device to be triggered. +- b) SCS-Identity AVP, containing the identity of the SCS that requested a device trigger to the UE. + +If the MTC-IWF concludes that it needs to abort the device trigger, it shall indicate the unsuccessful outcome with the Request-Status AVP and may release the reference number received from the SCS for the specific action request. + +## 5.6 Notification of Device trigger + +The MTC-IWF shall notify the SCS of the outcome of a device trigger request by sending a Device-Notification-Request command to the SCS with the following AVP values set in the Device-Notification AVP: + +- a) Action-Type AVP set to the value Delivery Report (2). +- b) Either MSISDN AVP or External-Id AVP set to the identifier of the MTC device triggered. +- c) SCS-Identity AVP, containing the identity of the SCS that requested a device trigger to the UE. +- d) Reference-Number AVP as received in the corresponding Device-Action-Request command by the SCS. +- e) Delivery-Outcome AVP set to the proper value, depending on success, failure or unconfirmed outcome of the delivery of the trigger request by the MTC-IWF to the MTC device. + +The SCS shall acknowledge the receipt of the Device-Notification-Request command by sending to the MTC-IWF a Device-Notification-Answer command. + +When the procedure is completed in the MTC-IWF and the SCS the reference number shall be released. + +## 5.7 Request and confirmation of a device trigger recall request + +In order to request the MTC-IWF to perform a device trigger recall, the SCS shall send a Device-Action-Request command with the following AVP values within the Device-Action AVP: + +- a) Action-Type AVP set to the value Device Trigger Recall (3). +- b) Either MSISDN AVP or External-Id AVP set to the identifier of the MTC device to be triggered. +- c) SCS-Identity AVP, containing the identity of the SCS that is requesting a device trigger to the UE. +- d) Reference-Number AVP, containing the assigned reference number the SCS has assigned to the trigger message to be recalled. + +After the MTC-IWF has received from the SCS a Device-Action-Request command with device action set to Device Trigger Recall (3), after receiving the Device-Trigger-Answer from SMS-SC the MTC-IWF shall confirm the status of a device trigger recall request to the SCS by sending a Device-Action-Answer command and shall include the following AVP values within the Device-Notification AVP: + +- a) Action-Type AVP set to the value Device Trigger Recall (3). +- b) Reference-Number AVP, containing the reference number of the recalled trigger message from the SCS. +- c) Request-Status AVP set to value indicating the status of the device trigger recall. + +If the MTC-IWF concludes that it needs to abort the device trigger recall, it shall indicate the unsuccessful outcome with the Request-Status AVP. + +The MTC-IWF may release the reference number received from the SCS if the trigger to be recalled is indicated as successfully recalled. + +## 5.8 Request and confirmation of a device trigger replace request + +In order to request the MTC-IWF to perform a device trigger replace, the SCS shall send a Device-Action-Request command with the following AVP values within the Device-Action AVP: + +- a) Action-Type AVP set to the value Device Trigger Replace (4). +- b) Either MSISDN AVP or External-Id AVP set to the identifier of the MTC device to be triggered. +- c) SCS-Identity AVP, containing the identity of the SCS that is requesting a device trigger to the UE +- d) Reference-Number AVP, containing a newly assigned reference number the SCS has assigned to the specific action request. +- e) Old-Reference-Number AVP, containing the assigned reference number by the SCS for the trigger to be replaced. +- f) Trigger-Data AVP containing data to be sent to the MTC device with the trigger by the MTC-IWF in the Payload AVP, priority of the trigger in the Priority-Indication AVP and the triggering application addressed in the device indicated in the Application-Port-Identifier AVP. +- g) Validity-Time AVP, indicating the validity time of the device trigger request since the time the device action request has been received by the MTC-IWF. + +After the MTC-IWF has received from the SCS a Device-Action-Request command with device action set to Device Trigger Replace (4), after receiving the Device-Trigger-Answer from SMS-SC the MTC-IWF shall confirm the status of a Device Trigger Replace Request to the SCS by sending a Device-Action-Answer command and shall include the following AVP values within the Device-Notification AVP: + +- a) Action-Type AVP set to the value Device Trigger Replace (4). +- b) Reference-Number AVP, containing the reference number received from the SCS for the specific action request. +- c) Old-Reference-Number AVP, containing the reference number previously received from the SCS for the trigger to be replaced. +- d) Request-Status AVP set to value indicating the status of the device trigger replace requested by the SCS. + +The MTC-IWF may also include the following AVP within the Device-Notification AVP: + +- a) Either MSISDN AVP or External-Id AVP set to the identifier of the MTC device to be triggered. +- b) SCS-Identity AVP, containing the identity of the SCS that requested a device trigger replace to the UE. + +The MTC-IWF may then release the "old" reference number previously received from the SCS if the trigger to be replaced is indicated as successfully replaced. + +If the MTC-IWF concludes that it needs to abort the device trigger replace, it shall indicate the unsuccessful outcome with the Request-Status AVP and may release the reference number received from the SCS for the requested trigger replace action, except for the status codes: ORIGINALMESSAGESENT. + +If the Request-Status indicates either " REPLACEFAIL " or " ORIGINALMESSAGESENT " and MTC error diagnostic is provided by the SMS-SC to the MTC-IWF, the MTC-IWF shall forward the MTC error diagnostic to the SCS. + +## 5.9 Delivery of a MSISDN-less MO-SMS + +If the MTC-IWF supports the "MSISDN-less MO-SMS Delivery" feature and receives an MSISDN-less MO-SMS via T4, the MTC-IWF will use the IMSI of the UE and application port ID received over T4 to query the HSS/HLR for an external ID, and the MTC-IWF shall then notify the SCS identified with the destination SME address (long/short code of the SCS/AS) received on the T4 interface by sending a Device-Notification-Request command to the SCS with the following AVPs in the Device-Notification AVP: + +- a) Action-Type AVP set to the value "MSISDN-less MO-SMS Delivery (5)". +- b) SM-RP-UI AVP containing the short message transfer protocol data unit as received on the T4 interface. +- c) Application-Port-Identifier AVP containing the Application Port as received on the T4 interface, and +- d) External-Id AVP set to the identifier of the UE that send the SMS, as received from the HSS/HLR. + +The SCS shall acknowledge the receipt of the Device-Notification-Request command by sending to the MTC-IWF a Device-Notification-Answer command. + +# --- 6 Tsp protocol + +## 6.1 Protocol support + +### 6.1.1 Use of Diameter base protocol + +The Diameter Base Protocol as specified in IETF RFC 6733 [18] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures specified in IETF RFC 6733 [18] (including error handling and unrecognised information handling) shall be used unmodified. Only commands related to peer-to-peer connection are re-used from the Diameter Base Protocol, i.e. Capabilities-Exchange-Request (CER), Capabilities-Exchange-Answer (CEA), Disconnect-Peer-Request (DPR), Disconnect-Peer-Answer (DPA), Device-Watchdog-Request (DWR) and Device-Watchdog-Answer (DWA). + +With regards to the Diameter protocol defined over the Tsp interface, the MTC-IWF acts as the Diameter server, in the sense that it is the network element that handles action requests and sends notifications for a particular realm. The SCS acts as the Diameter client, in the sense that it is the network element requesting actions and handles notification from the MTC-IWF. + +A Diameter routing table entry can have a different destination based on the application identifier of the command. The application identifier stored in the command header must match the value of any application identifier AVPs in the command body. Diameter agents (relay, proxy, redirection, translation agents) should use the application identifier in the command header to route to a suitable destination. + +### 6.1.2 Transport protocol + +Diameter messages over the Tsp interface shall make use of SCTP IETF RFC 4960 [8] or TCP IETF RFC 791 [4]. + +### 6.1.3 Advertising Application Support + +The Diameter application identifier assigned to the Tsp interface application is 16777309. + +The SCS and MTC-IWF shall advertise support of the Diameter Tsp application by including the value of the Tsp application identifier in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the CER and CEA commands. + +The vendor identifier value of 3GPP (10415) shall be included in the Supported-Vendor-Id AVP of the CER and CEA commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the CER and CEA commands. + +The Vendor-Id AVP included in CER and CEA commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [18]. + +## 6.2 Initialization and maintenance of connection and session + +A Tsp peer-to-peer connection is a connection between SCS and MTC-IWF. It has no associated meaning beyond this link - i.e. it has no meaning between communication endpoints such as MTC applications and the UEs. A Tsp peer-to-peer connection may carry commands associated with multiple MTC applications and/or multiple UEs. + +A Tsp Diameter session shall consist of a single request and answer pair. The Tsp Diameter session is terminated after each request and answer pair interaction, i.e. the Tsp Diameter session shall not keep the session state. In order to indicate that the session state is not to be maintained, the Diameter client and server shall include the Auth-Session-State AVP with the value set to NO\_STATE\_MAINTAINED (1), in the request and in the answer messages (see IETF RFC 6733 [18]). + +Communications between UE and MTC application may span multiple Tsp Diameter sessions. + +## 6.3 Security on the Tsp interface + +### 6.3.1 General + +The Diameter security mechanisms as specified in IETF RFC 6733 [18] shall apply to the Tsp reference point unless explicitly stated otherwise. + +NOTE: The use of Diameter is based on IETF RFC 3588 [6] in pre Release-14. Nevertheless, the security mechanism defined for the Tsp reference point rather aligns with the security mechanism in IETF RFC 6733 [18]. The only difference to the security in IETF RFC 6733 [18] is that the support for DTLS is made conditional on the support of SCTP. + +### 6.3.2 Mutual authentication + +The present document covers only Tsp interface security procedures for deployments where a DIAMETER message on the Tsp interface between MTC-IWF and SCS shall pass through at most one DIAMETER agent in the security domain, in which the MTC-IWF resides (called 'MTC-IWF-side agent' in the sequel), and one DIAMETER agent in the security domain, in which the SCS resides (called 'SCS-side agent' in the sequel). + +NOTE 1: Other deployments are possible, but they are not recommended for the purposes of the Tsp interface. + +Mutual authentication between a node in the security domain, in which the MTC-IWF resides, and a node in the security domain, in which the SCS resides, shall be performed using TLS or IPsec as specified in IETF RFC 6733 [18], with the exception that the security profiles specified in clause 6.3.3 of the present document shall apply. + +The following rules shall apply: + +- There shall be no intermediate DIAMETER agent in a third security domain between the security domain of the MTC-IWF and the security domain of the SCS. +- In the security domain of the MTC-IWF, the node performing the Tsp-related mutual authentication shall be the MTC-IWF-side agent, if present, and the MTC-IWF otherwise. +- In the security domain of the SCS, the node performing the Tsp-related mutual authentication shall be the SCS-side agent, if present, and the SCS otherwise. +- The peers shall verify the peer identity received in CER/CEA messages against the identity (e.g. name in the certificate) authenticated by means of TLS or IPsec. +- Domain authorization check: a suitable node in the security domain receiving a Tsp-related DIAMETER message shall check that the originator of this message, i.e the SCS (or MTC-IWF respectively), as identified at the application layer, is indeed authorized to send this message via the peer whose identity was verified in the previous step. This check may be performed through suitable local tables associating SCSs (or MTC-IWFs respectively) with nodes in the originating security domain whose identities can be verified by the receiving domain. The node performing this domain authorization check shall be either the MTC-IWF or the MTC-IWF-side agent for messages destined to the MTC-IWF and either the SCS or the SCS-side agent for messages destined to the SCS. + +NOTE 2: The MTC-IWF can perform the domain authorization check even in the presence of an MTC-IWF-side agent as the latter includes the verified peer identity in the Route-Record AVP. (Analogously for the SCS -side) The concept of domain authorization check is defined by the bullet above and not taken from another normative document. + +- The MTC-IWF-side agent (the SCS-side agent respectively) shall perform egress filtering in that it only forwards (Tsp-related) DIAMETER messages originating from MTC-IWFs (SCSs respectively) in its own security domain. + +### 6.3.3 Security profiles + +The support of TLS on Tsp is mandatory. The support of IKE/IPsec is optional. If SCTP is supported, then DTLS shall be supported. + +Security profiles for IKE, IPsec, and TLS shall be according to the following provisions: + +- The profile for TLS implementation and usage shall follow the provisions given in TS 33.310 [11], Annex E. The mutual authentication shall be based on certificates according to the profiles given in TS 33.310 [11], clauses 6.1.3a and 6.1.4a. The structure of the PKI used for these certificates is out of scope of the present document, thus the provisions in these clauses on issuers of the certificates do not apply. +- If IKE/IPsec is supported then the implementation of IKEv2 is mandatory with mutual authentication based on certificates according to the profile given in TS 33.310 [11]. The certificate profiles shall follow TS 33.310 [11], clauses 6.1.3 and 6.1.4. The structure of the PKI used for these certificates is out of scope of the present document, thus the provisions in these clauses on issuers of the certificates do not apply. +- If IKE/IPsec is supported then IPsec ESP shall be implemented according to the profile in TS 33.210 [10]. Tunnel mode is mandatory to support. Transport mode is optional to support. + +The security profile for DTLS is defined in TS 33.310 [11], Annex E. + +## 6.4 Tsp specific AVPs + +### 6.4.1 General + +Table 6.4.1.1 describes the Diameter AVPs defined for the Tsp reference point, their AVP Code values, types and possible flag values. The Vendor-Id header of all AVPs defined in the present document shall be set to 3GPP (10415). For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x0001 should be used. + +Table 6.4.1.1: Tsp specific Diameter AVPs + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules (Note 1) | | | | Applicability (Note 2) | +|---------------------------------------|----------|----------------|-------------|-------------------------|-----|------------|----------|-------------------------------| +| | | | | Must | May | Should not | Must not | | +| Device-Action | 3001 | 6.4.2 | Grouped | M,V | P | | | | +| Device-Notification | 3002 | 6.4.3 | Grouped | M,V | P | | | | +| Trigger-Data | 3003 | 6.4.4 | Grouped | M,V | P | | | | +| Payload | 3004 | 6.4.5 | OctetString | M,V | P | | | | +| Action-Type | 3005 | 6.4.6 | Enumerated | M,V | P | | | | +| Priority-Indication | 3006 | 6.4.7 | Enumerated | M,V | P | | | | +| Reference-Number | 3007 | 6.4.8 | Unsigned32 | M,V | P | | | | +| Request-Status | 3008 | 6.4.9 | Enumerated | M,V | P | | | | +| Delivery-Outcome | 3009 | 6.4.10 | Enumerated | M,V | P | | | | +| Application-Port-Identifier | 3010 | 6.4.11 | Unsigned32 | M,V | P | | | | +| Old-Reference-Number | 3011 | 6.4.12 | Unsigned32 | V | P | | M | Device-Trigger-Recall-Replace | +| Feature-Supported-In-Final-Target AVP | 3012 | 6.4.13 | Unsigned32 | V | P | | M | Device-Trigger-Recall-Replace | + +NOTE 1: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [18]. + +NOTE 2: AVPs marked with a supported feature (e.g. "Device-Trigger-Recall-Replace") are applicable as described in clause 6.4.12. + +### 6.4.2 Device-Action AVP + +The Device-Action AVP (AVP code 3001) is of type Grouped. It is used by the SCS to request a specific action for a device. + +AVP Format: + +``` +Device-Action ::= < AVP Header: 3001 > + [ External-Id ] + [ MSISDN ] + [ SCS-Identity ] + { Reference-Number } + [ Old-Reference-Number ] + { Action-Type } + [ Trigger-Data ] + [ Validity-Time ] + *[ AVP ] +``` + +### 6.4.3 Device-Notification AVP + +The Device-Notification AVP (AVP code 3002) is of type Grouped. It is used by the MTC-IWF to report any action requested by the SCS. + +AVP Format: + +``` +Device-Notification ::= < AVP Header: 3002 > + [ External-Id ] + [ MSISDN ] + [ SCS-Identity ] + { Reference-Number } + { Action-Type } + [ Request-Status ] + [ MTC-Error-Diagnostic ] + [ Delivery-Outcome ] + [ SM-RP-UI ] + [ Application-Port-Identifier ] + *[ AVP ] +``` + +### 6.4.4 Trigger-Data AVP + +The Trigger-Data AVP (AVP code 3003) is of type Grouped. It is used by the SCS to supply all data required for a device trigger request. + +AVP Format: + +``` +Trigger-Data ::= < AVP Header: 3003 > + { Payload } + [ Priority-Indication ] + [ Application-Port-Identifier ] + *[ AVP ] +``` + +### 6.4.5 Payload AVP + +The Payload AVP (AVP code 3004) is of type OctetString, and contains the payload to be transferred to the addressed device. + +### 6.4.6 Action-Type AVP + +The Action-Type AVP (AVP code 3005) is of type Enumerated, and informs the MTC-IWF of what action type is required in the request and also informs the SCS of what action type is reported. + +The following values are defined: + +#### Device Trigger Request (1) + +This value indicates a device trigger request and is used: + +- in the Device-Action AVP of the Device-Action-Request command; +- in the Device-Notification AVP of the Device-Action-Answer command. + +#### Delivery Report (2) + +This value indicates a delivery report sent from MTC-IWF to the SCS and is used: + +- in the Device-Notification AVP of the Device-Notification-Request command. + +#### Device Trigger Recall (3) + +This value indicates a device trigger recall request and is used: + +- in the Device-Action AVP of the Device-Action-Request command; +- in the Device-Notification AVP of the Device-Action-Answer command. + +#### Device Trigger Replace (4) + +This value indicates a device trigger replace request and is used: + +- in the Device-Action AVP of the Device-Action-Request command; +- in the Device-Notification AVP of the Device-Action-Answer command. + +#### MSISDN-less MO-SMS Delivery (5) + +This value indicates the delivery of an MSISDN-less MO-SMS and is used in the Device-Notification AVP of the Device-Notification-Request command. + +### 6.4.7 Priority-Indication AVP + +The Priority-Indication (AVP code 3006) is of type Enumerated, and identifies priority of the device trigger. + +The following values are defined: + +Non-Priority (0) + +This value indicates that the device trigger has non-priority. + +Priority (1) + +This value indicates that the device trigger has priority. + +### 6.4.8 Reference-Number AVP + +Reference-Number AVP (AVP code 3007) is of type Unsigned32, and is used to uniquely identify a transaction. The reference number is allocated by the initiator of a transaction and is used in all subsequent messages related to that transaction. + +### 6.4.9 Request-Status AVP + +The Request-Status AVP (AVP code 3008) is of type Enumerated, and informs the SCS of the status of a device action request. It can include the result of MTC-IWF checks, the HSS/HLR interrogation and the SMS-SC submission trigger. The Request-Status AVP can be included in the Device-Action-Answer command. + +The following values are defined: + +SUCCESS (0) + +This value indicates that device action requested is confirmed. + +TEMPORARYERROR (201) + +This value indicates any unspecified temporary errors. + +INVPAYLOAD (101) + +This value indicates an error with the payload, where the payload is valid according to Diameter AVP definition but an implementation limit such as maximum accepted length is exceeded. + +INVENTID (102) + +This value indicates an error with the External Identifier, where the identifier is valid according to Diameter AVP definition but the value is rejected by the 3GPP network for example because it is an unknown subscription. The result code specified in TS 29.336 [12], clause 6.3.3.1 shall be mapped to this value. + +INVSCSID (103) + +This value indicates an error with the SCS identity, where the identity is valid according to Diameter AVP definition but the value is rejected by the 3GPP network for example because it is an unexpected value for this SCS. + +INVPERIOD (104) + +This value indicates an error with the validity period, where the validity period is valid according to Diameter AVP definition but the value is rejected by the 3GPP network for example because a maximum allowed validity period is exceeded. + +NOTAUTHORIZED (105) + +This value indicates that the SCS is not authorized to perform the action requested for this UE. The result code specified in TS 29.336 [12], clause 6.3.3.2 shall be mapped to this value. + +SERVICEUNAVAILABLE (106) + +This value indicates that the trigger service is not available for this UE. The result code specified in TS 29.336 [12], clause 6.3.3.3 shall be mapped to this value. + +PERMANENTERROR (107) + +This value indicates a permanent error. Any result code specified in TS 29.337 [17], clause 7.3 shall be mapped to this value unless otherwise specified in this specification. + +#### QUOTAEXCEEDED (108) + +This value indicates that the SCS has exceeded allocated quota. + +#### RATEEXCEEDED (109) + +This value indicates that the rate at which the SCS is initiating Tsp requests has been exceeded. + +#### REPLACEFAIL (110) + +This value indicates that the device trigger replace request has failed to replace the device trigger indicated by the Old-Reference-Number in the SMS-SC for other reasons than ORIGINALMESSAGESSENT i.e. message could not be replaced and new message could not be stored as a new message. The result code DIAMETER\_ERROR\_TRIGGER\_REPLACE\_FAILURE specified in TS 29.337 [17], clause 7.3.5 shall be mapped to this value. + +#### RECALLFAIL (111) + +This value indicates that the device trigger recall request has failed for other reasons than ORIGINALMESSAGESSENT. The result code DIAMETER\_TRIGGER\_RECALL\_FAILURE specified in TS 29.337 [17], clause 7.3.6 shall be mapped to this value. + +#### ORIGINALMESSAGESSENT (112) + +This value indicates that the message which was intended to be recalled or replaced has already been sent. The result code DIAMETER\_ERROR\_ORIGINAL\_MESSAGE\_NOT\_PENDING specified in TS 29.337 [17], clause 7.3.7 shall be mapped to this value. + +### 6.4.10 Delivery-Outcome AVP + +The Delivery-Outcome AVP (AVP code 3009) is of type Enumerated, and informs the SCS of the outcome of the device action request. The Delivery-Outcome AVP can be included in Device-Notification-Request command. + +The following values are defined: + +#### SUCCESS (0) + +This value indicates that the device action request was successfully completed. The value SUCCESSFUL\_TRANSFER specified in TS 29.337 [17], clause 6.3.1 shall be mapped to this value. + +#### EXPIRED (1) + +This value indicates that the validity period expired before the trigger could be delivered. The value VALIDITY\_TIME\_EXPIRED specified in TS 29.337 [17], clause 6.3.1 shall be mapped to this value. (Temporary error) + +#### TEMPORARYERROR (2) + +This value indicates that this trigger encountered a temporary network error. + +#### UNDELIVERABLE (3) + +This value indicates that this trigger encountered a delivery error and is deemed permanently undeliverable. The values ABSENT\_SUBSCRIBER and UE\_MEMORY\_CAPACITY\_EXCEEDED specified in TS 29.337 [17], clause 6.3.1 shall be mapped to this value. + +#### UNCONFIRMED (4) + +This value indicates that the delivery of the device action request is not confirmed. + +NOTE: The Absent-Subscriber-Diagnostic-T4 AVP specified in TS 29.337 [17], clause 6.3.2 is connected with the ABSENT\_SUBSCRIBER value in the SM-Delivery-Outcome-T4 AVP. The Absent-Subscriber-Diagnostic-T4 AVP values will not be forwarded via the Tsp interface. + +### 6.4.11 Application-Port-Identifier AVP + +The Application-Port-Identifier AVP (AVP code 3010) is of type Unsigned32 and is used to uniquely identify the triggering application addressed in the device, see clause 9.2.3.24.4 in TS 23.040 [15] for further details. + +### 6.4.12 Old-Reference-Number AVP + +Old-Reference-Number AVP (AVP code 3011) is of type Unsigned32, and is used to uniquely identify a transaction which is intended to be replaced. + +### 6.4.13 Feature-Supported-In-Final-Target AVP + +Feature-Supported-In-Final-Target AVP (AVP code 3012) is of type Unsigned32 and contains a bitmask, and is used to indicate the features supported in target node. This AVP shall be present if any of the features are supported. + +**Table 6.4.13.1: Features supported by final target node** + +| Feature bit
(Note 1) | Remote target Feature
(Note 2) | Description
(Note 3) | Applicability
(Note 4) | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| +| 0 | Device-Trigger-Recall-Replace supported in SMS-SC | This Feature indicates the support of the applicability to support the functionality for device trigger recall and device trigger replace by the SMS-SC
This Feature is applicable for the DAA command.
If an SMS-SC does not indicate the support of the feature the SCS shall not send device trigger recall requests to an MTC-IWF and SCS shall treat the device trigger replace as a new device trigger. | Device-Trigger-Recall-Replace | +| Note 1: Feature bit: The order number of the bit within the Feature-Supported-In-Final-Target AVP, e.g. "1". | | | | +| Note 2: Remote target feature: A short name that can be used to refer to the bit and to the feature in the target node, e.g. "Device-Trigger-Recall-Replace". | | | | +| Note 3: Description: A clear textual description of the feature. | | | | +| Note 4: Applicability: Bits marked with a supported feature (e.g. "Device-Trigger-Recall-Replace") are applicable as described in clause 6.4.12. | | | | + +## 6.5 Tsp re-used AVPs + +### 6.5.1 General + +Table 6.5.1.1 lists the Diameter AVPs re-used by the Tsp reference point from existing Diameter Applications, reference to their respective specifications and a short description of their usage within the Tsp reference point. Other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol, do not need to be supported. The AVPs from Diameter base protocol are not included in table 6.5.1.1, but they are re-used for the Tsp reference point. Unless otherwise stated, re-used AVPs shall maintain their 'M', 'P' and 'V' flag settings. For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x0001 should be used. + +Table 6.5.1.1: Tsp re-used Diameter AVPs + +| Attribute Name | Reference | Description | Applicability (Note 1) | +|----------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| MSISDN | TS 29.329 [3] | MSISDN of the device. | | +| External-Id | TS 29.336 [12] | External identifier has the form username@realm. | | +| SCS-Identity | TS 29.336 [12] | This Information Element shall contain the identity of the Service Capability Server that is requesting a device trigger to the UE. | | +| Validity-Time | IETF RFC 4006 [7] | The validity time in seconds for the specific action requested. | | +| Supported-Features | TS 29.229 [16] | If present, this AVP informs the destination host about the features that the origin host requires to successfully complete this command exchange. | | +| MTC-Error-Diagnostic | TS 29.337 [17] | If present, this AVP provides additional information about the failure occurred in the SMS-SC. | | +| Load | IETF RFC 8583 [19] | The AVP used to convey load information between Diameter nodes. This AVP and all AVPs within this grouped AVP shall have the 'M' bit cleared. | | +| SM-RP-UI | TS 29.338 [20] | This information element shall contain the short message transfer protocol data unit. | MSISDN-less MO-SMS Delivery | + +NOTE 1: AVPs marked with a supported feature are applicable as described in clause 6.4.12. + +### 6.5.2 Supported-Feature-List AVP + +#### 6.5.2.1 Use of the Supported-Features AVP + +When new functionality is introduced on the Tsp reference point, it should be defined as optional. If backwards incompatible changes cannot be avoided, the new functionality shall be introduced as a new feature and support advertised with the Supported-Features AVP. Unless otherwise stated, the use of the Supported-Features AVP on the Tsp reference point shall be compliant to the usage of the Supported-Features AVP on the Cx reference point and consistent with the procedures for the dynamic discovery of supported features as defined in clause 7.2 of TS 29.229 [16]. + +When extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in TS 29.229 [16], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the all reference points as specified in this specification, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +The Supported-Features AVP shall be included in every DAR and DAA command if supported by the SCS and MTC-IWF respectively. + +If the SCS supports post-Rel-12 Tsp functionality, the DAR shall include the features supported by the SCS within Supported-Features AVP(s) with the 'M' bit cleared. + +The Table 6.5.2.2/1 defines the features applicable to the Tsp reference point for the feature list with a Feature-List-ID of 1. + +#### 6.5.2.2 Supported-Feature-List AVP for the Tsp application + +The syntax of this AVP is defined in TS 29.229 [16]. + +For the Tsp application, the meaning of the bits shall be as defined in table 6.5.2.2/1 for the Supported-Feature-List-ID of 1. + +**Table 6.5.2.2/1: Features of Feature-List-ID 1 used in Tsp** + +| Feature bit | Feature | M/O | Description | +|-------------|-------------------------------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Device-Trigger-Recall-Replace | O | This Feature indicates the support of the applicability to support the functionality for device trigger recall and device trigger replace.
This Feature is applicable for the DAR/DAA command pair.
If an MTC-IWF or SCS does not indicate the support of the feature the SCS shall not send device trigger recall requests to an MTC-IWF and SCS shall treat the device trigger replace as a new device trigger. | +| 1 | MSISDN-less MO-SMS Delivery | O | This Feature indicates the support of the functionality for the delivery of a MSISDN-less MO-SMS.
This Feature is applicable for the DNR/DNA command pair. | + +Feature bit: The order number of the bit within the Supported-Features AVP, e.g. "1". +Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Device-Trigger-Recall-Replace". +M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O"). +Description: A clear textual description of the feature. + +## 6.6 Tsp Messages + +### 6.6.1 Command-Code Values + +This clause defines the Command-Code values for the Tsp interface application as allocated by IANA from the vendor-specific namespace defined in IETF RFC 5719 [9]. Every command is defined by means of the ABNF syntax IETF RFC 2234 [5], according to the rules in IETF RFC 6733 [18]. + +The following Command Codes are defined in this specification: + +**Table 6.6.1.1: Command-Code values for Tsp** + +| Command-Name | Abbreviation | Code | Section | +|-----------------------------|--------------|---------|---------| +| Device-Action-Request | DAR | 8388639 | 6.6.2 | +| Device-Action-Answer | DAA | 8388639 | 6.6.3 | +| Device-Notification-Request | DNR | 8388640 | 6.6.4 | +| Device-Notification-Answer | DNA | 8388640 | 6.6.5 | + +For the commands defined in this specification and reused commands, the Application-ID field shall be set to 16777309. + +### 6.6.2 Device-Action-Request (DAR) command + +The DAR command, indicated by the Command-Code field set to 8388639 and the 'R' bit set in the Command Flags field, is sent by the SCS to the MTC-IWF as part of the device action request procedure. + +Message Format: + +``` + ::= + < Session-Id > + { Auth-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + [ Origin-State-Id ] + [ Device-Action ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ Supported-Features ] + *[ AVP ] +``` + +### 6.6.3 Device-Action-Answer (DAA) command + +The DAA command, indicated by the Command-Code field set to 8388639 and the 'R' bit cleared in the Command Flags field, is sent by the MTC-IWF to the SCS as part of the device action request procedure. + +Message Format: + +``` + ::= < Diameter Header: 8388639, PXY > + < Session-Id > + { Auth-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + [ Origin-State-Id ] + { Device-Notification } + *[ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + *[ Proxy-Info ] + *[ Supported-Features ] + [ Feature-Supported-In-Final-Target ] + *[ Load ] + *[ AVP ] +``` + +### 6.6.4 Device-Notification-Request (DNR) command + +The DNR command, indicated by the Command-Code field set to 8388640 and the 'R' bit set in the Command Flags field, is sent by the MTC-IWF to the SCS as part of the device notification report procedure. + +Message Format: + +``` + ::= < Diameter Header: 8388640, REQ, PXY > + < Session-Id > + { Auth-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Destination-Host } + [ Origin-State-Id ] + [ Device-Notification ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ AVP ] +``` + +### 6.6.5 Device-Notification-Answer (DNA) command + +The DNA command, indicated by the Command-Code field set to 8388640 and the 'R' bit cleared in the Command Flags field, is sent by the SCS to the MTC-IWF as part of the device notification report procedure. + +Message Format: + +``` + ::= < Diameter Header: 8388640, PXY > + < Session-Id > + { Auth-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ Origin-State-Id ] + [ Error-Message ] + [ Error-Reporting-Host ] + *[ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + [ Failed-AVP ] + *[ Proxy-Info ] +``` + +\*[ AVP ] + +# Annex A (informative): Tsp Message Flows + +## A.1 General + +This Annex illustrates Tsp Message Flows. + +## A.2 Tsp Submission, T4 Delivery + +This clause illustrates the Tsp Message Sequence Diagram for trigger submissions over Tsp with subsequent trigger delivery over T4. + +![Sequence diagram for Tsp Submission, T4 Delivery](19a5f0db57a21a0e82a7f326083e96fd_img.jpg) + +``` +sequenceDiagram + participant SCS + participant MTC-IWF + participant SMS-SC + participant UE + + Note right of SCS: 1. DAR + SCS->>MTC-IWF: 1. DAR + Note left of MTC-IWF: 2. T4 submission + MTC-IWF->>SMS-SC: 2. T4 submission + Note left of SMS-SC: 4. Delivery to UE + SMS-SC->>UE: 4. Delivery to UE + Note right of SMS-SC: 5. T4 Report + SMS-SC->>MTC-IWF: 5. T4 Report + Note right of MTC-IWF: 3. DAA + MTC-IWF->>SCS: 3. DAA + Note right of MTC-IWF: 6. DNR + MTC-IWF->>SCS: 6. DNR + Note right of SCS: 7. DNA + SCS->>MTC-IWF: 7. DNA + Note left of MTC-IWF: 8. T4 Report Confirm + MTC-IWF->>SMS-SC: 8. T4 Report Confirm +``` + +The sequence diagram illustrates the interaction between four entities: UE, SMS-SC, MTC-IWF, and SCS. The sequence of messages is as follows: 1. SCS sends a DAR (Device-Action-Request) to MTC-IWF. 2. MTC-IWF sends a T4 submission to SMS-SC. 3. MTC-IWF sends a DAA (Device-Action-Answer) to SCS. 4. SMS-SC performs a 'Delivery to UE' and sends a T4 Report to MTC-IWF. 5. MTC-IWF sends a DNR (Device-Notification-Request) to SCS. 6. SCS sends a DNA (Device-Notification-Answer) to MTC-IWF. 7. MTC-IWF sends a T4 Report Confirm to SMS-SC. + +Sequence diagram for Tsp Submission, T4 Delivery + +**Figure A.2.1: Tsp Submission, T4 Delivery** + +The flow consists of the following operations: + +1. The SCS sends a Device-Action-Request command to the MTC-IWF with the Action-Type AVP set to the Value Device Trigger Request (1) and other AVPs as further specified in sub clause 5.5. + +2. The MTC-IWF selects T4 for delivery performs the T4 submission procedures and is informed of the submission outcome. +3. The MTC-IWF confirms the status of the device trigger request to the SCS by sending a Device-Action-Answer command with the Action-Type AVP set to the Value Device Trigger Request (1) and the Request-Status AVP set to value indicating the status of the device trigger request. Other AVPs as further specified in sub clause 5.5. +4. - 5. The SMS-SC performs delivery procedures and reports the outcome to the MTC-IWF. +6. The MTC-IWF notifies the SCS of the outcome of the device trigger request by sending a Device-Notification-Request command with Action-Type AVP set to the value Delivery Report (2), the Delivery-Outcome AVP set to the proper value. +7. The SCS acknowledges to the MTC-IWF that is has successfully received the out come of the device trigger request by sending a Device-Notification-Answer command. +8. The MTC-IWF responds back to the SMS-SC that is has successfully transferred the report. + +NOTE: A SMS-SC will repeat the procedure from steps 5 to ensure the Deliver Report is received if a negative confirmation is received. + +## A.3 Tsp failed Submission + +This sub clause illustrates the Tsp Message Sequence Diagram for trigger submissions over Tsp with the trigger submission is rejected. + +![Sequence diagram for Tsp failed submission](8d325fc12b494e42c9ea7ed2a7f327a6_img.jpg) + +``` +sequenceDiagram + participant SCS + participant MTC-IWF + participant SMS-SC + Note right of MTC-IWF: 2. Trigger submission rejected + SCS->>MTC-IWF: 1. DAR + MTC-IWF->>SCS: 3. DAA +``` + +The diagram shows a sequence of interactions between three entities: SMS-SC, MTC-IWF, and SCS. The sequence starts with the SCS sending a '1. DAR' (Device-Action-Request) message to the MTC-IWF. The MTC-IWF then performs an internal operation, represented by a dashed box labeled '2. Trigger submission rejected'. Finally, the MTC-IWF sends a '3. DAA' (Device-Action-Answer) message back to the SCS. + +Sequence diagram for Tsp failed submission + +Figure A.3.1: Tsp Submission, T4 Delivery + +The flow consists of the following operations: + +1. The SCS sends a Device-Action-Request command to the MTC-IWF with the Action-Type AVP set to the Value Device Trigger Request (1) and other AVPs as further specified in sub clause 5.5. +2. The MTC-IWF rejects the trigger request or it is informed as part of the T4 submission procedure that the trigger is rejected. Example reject reasons: Unknown subscription, SCS not authorized, Service not authorized for UE, Insufficient resources, QOS exceeded, Insufficient resources. Reject reasons may be temporary or permanent nature. + +3. The MTC-IWF informs the SCS of the device trigger request outcome by sending a Device-Action-Answer command with the Action-Type AVP set to the Value Device Trigger Request (1) and the Request-Status AVP set to an appropriate error value indicating the rejection of the device trigger request. Other AVPs as further specified in sub clause 5.5. The device trigger request has reached a final status at this point and the procedure ends here. + +## A.4 Tsp Submission, Failed T4 Delivery + +This sub clause illustrates the Tsp Message Sequence Diagram for trigger submissions over Tsp with subsequent a failed trigger delivery over T4. + +![Sequence diagram for Tsp Submission, Failed T4 Delivery](392a79ccd95e682ccd08f35ab2e64144_img.jpg) + +``` +sequenceDiagram + participant SCS + participant MTC-IWF + participant SMS-SC + participant UE + + Note right of SCS: 1. DAR + SCS->>MTC-IWF: 1. DAR + Note left of MTC-IWF: 2. T4 submission + MTC-IWF->>SMS-SC: 2. T4 submission + Note right of MTC-IWF: 3. DAA + MTC-IWF->>SCS: 3. DAA + Note left of UE: 4. Delivery to UE failed + Note right of SMS-SC: 5. T4 Report + SMS-SC->>MTC-IWF: 5. T4 Report + Note right of MTC-IWF: 6. DNR + MTC-IWF->>SCS: 6. DNR + Note right of SCS: 7. DNA + SCS->>MTC-IWF: 7. DNA + Note left of MTC-IWF: 8. T4 Report Confirm + MTC-IWF->>SMS-SC: 8. T4 Report Confirm +``` + +The sequence diagram illustrates the interaction between four entities: UE, SMS-SC, MTC-IWF, and SCS. The sequence of messages is as follows: 1. The SCS sends a Device-Action-Request (DAR) to the MTC-IWF. 2. The MTC-IWF performs a T4 submission to the SMS-SC. 3. The MTC-IWF sends a Device-Action-Answer (DAA) to the SCS. 4. A dashed box indicates that the delivery to the UE failed. 5. The SMS-SC sends a T4 Report to the MTC-IWF. 6. The MTC-IWF sends a Device-Notification-Request (DNR) to the SCS. 7. The SCS sends a Device-Notification-Answer (DNA) to the MTC-IWF. 8. The MTC-IWF sends a T4 Report Confirm to the SMS-SC. + +Sequence diagram for Tsp Submission, Failed T4 Delivery + +Figure A.4.1: Tsp Submission, T4 Delivery + +The flow consists of the following operations: + +1. The SCS sends a Device-Action-Request command to the MTC-IWF with the Action-Type AVP set to the Value Device Trigger Request (1) and other AVPs as further specified in sub clause 5.5. +2. The MTC-IWF selects T4 for delivery performs the T4 submission procedures and is informed of a positive submission outcome. +3. The MTC-IWF confirms the status of the device trigger request to the SCS by sending a Device-Action-Answer command with the Action-Type AVP set to the Value Device Trigger Request (1) and the Request-Status AVP + +set to value indicating the SUCCESS status of the device trigger request. Other AVPs as further specified in sub clause 5.5. + +- 4 - 5. The SMS-SC concludes after one or more retries that the trigger is not deliverable to the UE (i.e trigger validity period exceeded, persistent error received from HSS, UE or network) and reports the outcome to the MTC-IWF. +6. The MTC-IWF notifies the SCS of the negative outcome of the device trigger request by sending a Device-Notification-Request command with Action-Type AVP set to the value Delivery Report (2), the Delivery-Outcome AVP set to the appropriate error value. Delivery errors may be of temporary or permanent nature. +7. The SCS acknowledges to the MTC-IWF that it has received the outcome of the device trigger request by sending a Device-Notification-Answer command. +8. The MTC-IWF responds back to the SMS-SC that it has successfully transferred the report. + +NOTE: A SMS-SC will repeat the procedure from steps 5 to ensure the Deliver Report is received if a negative confirmation is received. + +## A.5 Tsp Recall Submission, Recall Success + +This clause illustrates the message signalling flow for trigger recall submissions over Tsp with recall success over T4. + +![Sequence diagram for Tsp Recall Submission, Recall Success](356eb99ab9489bbd647223390a913903_img.jpg) + +``` +sequenceDiagram + participant SCS + participant MTC-IWF + participant SMS-SC + participant UE + + Note right of MTC-IWF: 1. Device-Action-Request +Action Type = Device trigger recall + MTC-IWF->>SMS-SC: 1. Device-Action-Request + Note left of SMS-SC: 2. T4 recall success + SMS-SC->>MTC-IWF: 2. T4 recall success + Note right of MTC-IWF: 3. Device-Action-Answer +Request Status = RECALLSUCCESS + MTC-IWF->>SCS: 3. Device-Action-Answer +``` + +The diagram is a sequence diagram showing the interaction between four entities: UE, SMS-SC, MTC-IWF, and SCS. The sequence of messages is as follows: 1. A 'Device-Action-Request' is sent from the SCS to the MTC-IWF. A note indicates that the Action Type is 'Device trigger recall'. 2. The MTC-IWF sends a 'T4 recall success' message to the SMS-SC. A note indicates this is step 2. 3. The MTC-IWF sends a 'Device-Action-Answer' to the SCS. A note indicates that the Request Status is 'RECALLSUCCESS'. + +Sequence diagram for Tsp Recall Submission, Recall Success + +Figure A.5.1: Tsp Recall Submission, T4 Recall Success + +The signalling flow consists of the following operations: + +1. The SCS sends a Device-Action-Request command to the MTC-IWF with the Action-Type AVP set to the Value Device Trigger Recall Request (3) and reference-number for the trigger to be recalled and other AVPs as further specified in clause 5.7. +2. The MTC-IWF selects T4 for trigger recall and performs the T4 recall procedures and is informed of the trigger recall outcome. +3. MTC-IWF sends Device-Action-Answer command to SCS with the Action-Type AVP set to the Value Device Trigger Recall Request (3) and the Request-Status AVP set to value indicating SUCCESS. Other AVPs as further specified in clause 5.7. + +## A.6 Tsp Recall Submission, Recall Failure + +This clause illustrates the message signalling flow for trigger recall submissions over Tsp with recall failure over T4. + +![Sequence diagram for Tsp Recall Submission, Recall Failure](759c7d62402f0b4651ddce292be5bdef_img.jpg) + +``` +sequenceDiagram + participant SCS + participant MTC-IWF + participant SMS-SC + participant UE + + Note right of SCS: 1. Device-Action-Request +Action Type = Device trigger recall + SCS->>MTC-IWF: 1. Device-Action-Request + Note right of MTC-IWF: 2. T4 recall failure + MTC-IWF-->>SMS-SC: 2. T4 recall failure + Note right of MTC-IWF: 3. Device-Action-Answer + MTC-IWF->>SCS: 3. Device-Action-Answer + Note right of SMS-SC: Delivery of old trigger + SMS-SC->>UE: Delivery of old trigger + Note right of SMS-SC: 4. Delivery report for old trigger + SMS-SC->>MTC-IWF: 4. Delivery report for old trigger +``` + +The diagram illustrates the message signalling flow for Tsp Recall Submission with a T4 Recall Failure. It involves four main entities: UE, SMS-SC, MTC-IWF, and SCS. The sequence of messages is as follows: 1. The SCS sends a Device-Action-Request command to the MTC-IWF with the Action-Type AVP set to the Value Device Trigger Recall Request (3) and reference-number for the trigger to be recalled and other AVPs as further specified in clause 5.7. 2. The MTC-IWF rejects the trigger recall request or it is informed as a part of the T4 recall procedure that the trigger recall is rejected. This is shown as a dashed box labeled '2. T4 recall failure' between the MTC-IWF and SMS-SC. 3. The MTC-IWF sends Device-Action-Answer command to the SCS with the Action-Type AVP set to the Value Device Trigger Recall Request (3) and the Request-Status AVP set to value indicating applicable reason for the recall failure, see clause 6.4.9. Other AVPs as further specified in clause 5.7. 4. The SMS-SC reports the delivery outcome for the original trigger message to the MTC-IWF according to A.2, step 5 to 8 for successful case and A.4, step 5 to 8 for unsuccessful case. This is shown as a dashed box labeled '4. Delivery report for old trigger' between the SMS-SC and MTC-IWF. Additionally, a box labeled 'Delivery of old trigger' is shown between the SMS-SC and UE. + +Sequence diagram for Tsp Recall Submission, Recall Failure + +Figure A.6.1: Tsp Recall Submission, T4 Recall Failure + +The signalling flow consists of the following operations: + +1. The SCS sends a Device-Action-Request command to the MTC-IWF with the Action-Type AVP set to the Value Device Trigger Recall Request (3) and reference-number for the trigger to be recalled and other AVPs as further specified in clause 5.7. +2. The MTC-IWF rejects the trigger recall request or it is informed as a part of the T4 recall procedure that the trigger recall is rejected. +3. The MTC-IWF sends Device-Action-Answer command to the SCS with the Action-Type AVP set to the Value Device Trigger Recall Request (3) and the Request-Status AVP set to value indicating applicable reason for the recall failure, see clause 6.4.9. Other AVPs as further specified in clause 5.7. +4. The SMS-SC reports the delivery outcome for the original trigger message to the MTC-IWF according to A.2, step 5 to 8 for successful case and A.4, step 5 to 8 for unsuccessful case. + +## A.7 Tsp Replace Submission, Replace Success + +This clause illustrates the message signalling flow for trigger replace submissions over Tsp with replace success over T4. + +![Sequence diagram for Tsp Replace Submission, T4 Replace Success](28d75f39a24203712ee907b32cf0bbe5_img.jpg) + +``` + +sequenceDiagram + participant UE + participant SMS-SC + participant MTC-IWF + participant SCS + SCS->>MTC-IWF: 1. Device-Action-Request + Note over SCS,MTC-IWF: Action Type = Device trigger replace + rect rgb(255, 255, 255) + Note over SMS-SC,MTC-IWF: 2. T4 replace success + end + MTC-IWF->>SCS: 3. Device-Action-Answer + Note over MTC-IWF,SCS: Request Status = REPLACESUCCESS + rect rgb(255, 255, 255) + Note over UE,SMS-SC: 4. Delivery of new trigger to the UE + end + rect rgb(255, 255, 255) + Note over SMS-SC,SCS: 5. Delivery report for new trigger + end + +``` + +The diagram illustrates the signalling flow for Tsp Replace Submission with T4 Replace Success. It involves four participants: UE, SMS-SC, MTC-IWF, and SCS. The sequence of operations is as follows: 1. The SCS sends a Device-Action-Request command to the MTC-IWF. 2. The MTC-IWF performs T4 replace procedures. 3. The MTC-IWF sends a Device-Action-Answer to the SCS. 4. The SMS-SC delivers the new trigger to the UE. 5. The SMS-SC reports the delivery outcome to the MTC-IWF. + +Sequence diagram for Tsp Replace Submission, T4 Replace Success + +**Figure A.7.1: Tsp Replace Submission, T4 Replace Success** + +The signalling flow consists of the following operations: + +1. The SCS sends a Device-Action-Request command to the MTC-IWF with the Action-Type AVP set to the Value Device Trigger Replace Request (4) and old-reference-number for the trigger to be replaced. The new trigger reference number is assigned by the SCS to the newly submitted trigger message. Other AVPs as further specified in clause 5.8. +2. The MTC-IWF selects T4 for trigger replace and performs the T4 replace procedures and is informed of the trigger replace outcome. +3. MTC-IWF sends Device-Action-Answer command to SCS with the Action-Type AVP set to the Value Device Trigger Replace Request (4) and the Request-Status AVP set to value indicating SUCCESS. Other AVPs as further specified in clause 5.8. +4. The SMS-SC will attempt to deliver the new trigger. This step can happen anytime after step 2. +5. The SMS-SC reports the delivery outcome for the new trigger message to the MTC-IWF according to A.2, step 5 to 8 for successful case and A.4, step 5 to 8 for unsuccessful case. + +## A.8 Tsp Replace Submission, Replace Failure + +This clause illustrates the message signalling flow for trigger replace submissions over Tsp with replace failure over T4. + +![Sequence diagram for Tsp Replace Submission, T4 Replace Failure. Lifelines: UE, SMS-SC, MTC-IWF, SCS. The sequence shows a failed trigger replacement where the MTC-IWF rejects the new trigger due to a T4 failure, but the SMS-SC still attempts to deliver the original trigger.](dd5771673aececa53d42ece89218299d_img.jpg) + +``` + +sequenceDiagram + participant SCS + participant MTC-IWF + participant SMS-SC + participant UE + + Note right of SCS: 1. Device-Action-Request +Action Type = Device trigger replace + SCS->>MTC-IWF: 1. Device-Action-Request + Note right of MTC-IWF: 2. T4 replace failure + MTC-IWF-->>SCS: 3. Device-Action-Answer + Note right of MTC-IWF: 4. Delivery report for old trigger + MTC-IWF-->>SMS-SC: 4. Delivery report for old trigger + Note right of SMS-SC: 5. Delivery of new trigger + SMS-SC->>UE: 5. Delivery of new trigger + Note right of SMS-SC: 6. Delivery report for new trigger + SMS-SC-->>MTC-IWF: 6. Delivery report for new trigger + +``` + +Sequence diagram for Tsp Replace Submission, T4 Replace Failure. Lifelines: UE, SMS-SC, MTC-IWF, SCS. The sequence shows a failed trigger replacement where the MTC-IWF rejects the new trigger due to a T4 failure, but the SMS-SC still attempts to deliver the original trigger. + +**Figure A.8.1: Tsp Replace Submission, T4 Replace Failure** + +The signalling flow consists of the following operations: + +1. The SCS sends a Device-Action-Request command to the MTC-IWF with the Action-Type AVP set to the Value Device Trigger Replace Request (4) and old-reference-number for the trigger to be replaced. Other AVPs as further specified in clause 5.8. +2. The MTC-IWF rejects the trigger replace request or it is informed as a part of the T4 replace procedure that the trigger replace is rejected. 3. MTC-IWF sends Device-Action-Answer command to SCS with the Action-Type AVP set to the Value Device Trigger Replace Request (4) and the Request-Status AVP set to value indicating applicable reason for the replace failure, see clause 6.4.9 . Other AVPs as further specified in clause 5.8. +4. The SMS-SC reports the delivery outcome for the original trigger message to the MTC-IWF according to A.2, step 5 to 8 for successful case and A.4, step 5 to 8 for unsuccessful case. Procedures ends if the Request-Status AVP value in step 3 was different from ORIGINALMESSAGESENT (112). +5. If the Request-Status AVP value in step 3 was ORIGINALMESSAGESENT (112), the SMS-SC will attempt to deliver the new trigger. This step can happen anytime after step 2. +6. The SMS-SC reports the delivery outcome for the new trigger message to the MTC-IWF according to A.2, step 5 to 8 for successful case and A.4, step 5 to 8 for unsuccessful case. + +## A.9 Delivery of a MSISDN-less MO-SMS + +This sub clause illustrates the Tsp Message Sequence Diagram for delivery of an MSISDN-less MO-SMS upon reception of such an SMS over T4. + +![Sequence diagram for the delivery of a MSISDN-less MO-SMS. The diagram shows four lifelines: UE, SMS-SC, MTC-IWF, and SCS. The sequence of messages is: 1. UE sends an MSISDN-less SMS to the SMS-SC; 2. The SMS-SC sends an MO payload delivery Request to the MTC-IWF; 3. The MTC-IWF performs an HSS/HLR interaction; 4. The MTC-IWF sends a DNR (Device-Notification-Request) to the SCS; 5. The SCS sends a DNA (Device-Notification-Answer) back to the MTC-IWF; 6. The MTC-IWF sends an MO payload delivery Response back to the SMS-SC.](3cc095fb84e92690c9d49d3e17c0f1dc_img.jpg) + +``` +sequenceDiagram + participant UE + participant SMS-SC + participant MTC-IWF + participant SCS + Note left of SMS-SC: 1. UE send MSISDN-less SMS + SMS-SC->>MTC-IWF: 2. MO payload delivery Request + Note right of MTC-IWF: 3. HSS/HLR interaction + MTC-IWF->>SCS: 4. DNR + SCS->>MTC-IWF: 5. DNA + MTC-IWF->>SMS-SC: 6. MO payload delivery Response +``` + +Sequence diagram for the delivery of a MSISDN-less MO-SMS. The diagram shows four lifelines: UE, SMS-SC, MTC-IWF, and SCS. The sequence of messages is: 1. UE sends an MSISDN-less SMS to the SMS-SC; 2. The SMS-SC sends an MO payload delivery Request to the MTC-IWF; 3. The MTC-IWF performs an HSS/HLR interaction; 4. The MTC-IWF sends a DNR (Device-Notification-Request) to the SCS; 5. The SCS sends a DNA (Device-Notification-Answer) back to the MTC-IWF; 6. The MTC-IWF sends an MO payload delivery Response back to the SMS-SC. + +**Figure A.9.1: Delivery of a MSISDN-less MO-SMS** + +The flow consists of the following operations: + +1. For small data delivery, an UE without MSISDN sends an SMS that is forwarded to the SMS-SC. +2. The SMS-SC extracts the SMS payload, Application port ID, and IMSI of the UE and delivers them to MTC-IWF via T4 along with the destination SME address. +3. The MTC-IWF uses the IMSI of the UE and application port ID to query the HSS/HLR for external ID. +4. The MTC-IWF notifies the SCS of the received SMS by sending a Device-Notification-Request command with Action-Type AVP set to the value "MSISDN-less MO-SMS Delivery (5)", SM-RP-UI AVP, Application-Port-Identifier AVP, and External-Id AVP s. +5. The SCS acknowledges to the MTC-IWF that is has successfully received the outcome of the device trigger request by sending a Device-Notification-Answer command. +6. The MTC-IWF responds back to the SMS-SC that is has successfully transferred the SMS. + +# --- Annex B (normative): Diameter load control mechanism + +## B.1 General + +IETF RFC 8583 [19] specifies the Diameter load control mechanism. This includes the definition of Diameter Load AVP and the Diameter load related behaviour. + +The Diameter load control mechanism on the Tsp interface is optional to support for the SCS and the MTC-IWF. + +NOTE: The Diameter Load AVP will simply be ignored by peers not supporting Diameter load control. + +If the SCS and the MTC-IWF support the Diameter load control mechanism, they shall apply the procedures in the present Annex. + +## --- B.2 SCS behaviour + +The SCS shall act as a reacting node as defined in IETF RFC 8583 [19] and may use the load information in an implementation dependent manner, e.g. when deciding where to route requests for new Diameter sessions. + +## --- B.3 MTC-IWF behaviour + +The MTC-IWF shall act as endpoint reporting node as defined IETF RFC 8583 [19]. The MTC-IWF shall include load information in the the Load AVP within the Device-Action-Answer messages. + +When and in which frequency to include the Load AVP is implementation dependent and based on operator policy. + +How the MTC-IWF determines the specific contents of the Load-Value AVP within the Load AVP is implementation dependent and based on operator policy. + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|--------|-----------|------|-----|----------------------------------------------------------------------------------|--------------------------------------------------------------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2014-03 | CP#63 | CP-140092 | 0010 | 3 | Protocol enhancements for the support of device recall and replace procedure | 11.4.0 | 12.0.0 | +| 2014-03 | CP#63 | CP-140092 | 0011 | 2 | Introduction of device trigger recall/replace functions | 11.4.0 | 12.0.0 | +| 06/2014 | TSG#64 | CP-140392 | 0014 | - | Clarification on bitmask | 12.0.0 | 12.1.0 | +| 06/2014 | TSG#64 | CP-140392 | 0012 | 3 | Corrections to trigger recall and replace procedures | 12.0.0 | 12.1.0 | +| 09/2014 | CT-65 | CP-140540 | 0015 | - | Error handling, MTC error diagnostic | 12.1.0 | 12.2.0 | +| 12/2014 | CT-66 | CP-140897 | 0017 | - | Adding missing security profile for DTLS | 12.2.0 | 12.3.0 | +| 03/2015 | CT-67 | CP-150115 | 0018 | | Protocol enhancements to indicate support of device recall and replace by SMS-SC | 12.3.0 | 12.4.0 | +| 06/2015 | CT-68 | CP-150343 | 0020 | 1 | SCS-Identity AVP | 12.4.0 | 12.5.0 | +| 06/2015 | CT-68 | CP-150363 | 0021 | 1 | Correction of Route-Record AVP name | 12.5.0 | 13.0.0 | +| 09/2015 | CT-69 | CP-150467 | 0024 | 1 | Usage of Delivery-Outcome AVP on Tsp interface | 13.0.0 | 13.1.0 | +| 09/2015 | CT-69 | CP-150467 | 0027 | 2 | Usage of Request-Status AVP on Tsp interface | 13.0.0 | 13.1.0 | +| Change history | | | | | | | | +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +| 2016-12 | CT#74 | CP-160615 | 0028 | 1 | F | Correction to DNA messages in informative callflows | 14.0.0 | +| 2016-12 | CT#74 | CP-160615 | 0029 | 1 | B | Small Data delivery using MO SMS over Tsp | 14.0.0 | +| 2016-12 | CT#74 | CP-160615 | 0030 | 2 | F | Diameter base protocol specification update | 14.0.0 | +| 2016-12 | CT#74 | CP-160615 | 0031 | 1 | B | Diameter Load Control Mechanism | 14.0.0 | +| 2017-03 | CT#74 | CP-170076 | 0032 | - | F | Update instance number for the Failed-AVP in answer commands | 14.1.0 | +| 2017-06 | CT#76 | CP-171119 | 0034 | 2 | F | Reference update for draft-ietf-dime-load | 14.2.0 | +| 2017-12 | CT#76 | CP-173097 | 0035 | - | F | Correction for Feature-Supported-In-Final-Target AVP | 14.3.0 | +| 2018-06 | SA#80 | - | - | - | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2019-09 | CT#85 | CP-192154 | 0037 | 1 | A | draft-ietf-dime-load published as RFC 8583 | 15.1.0 | +| 2020-07 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | +| 2022-03 | SA#95e | - | - | - | | Update to Rel-17 version (MCC) | 17.0.0 | +| 2024-03 | SA#103 | - | - | - | | Update to Rel-18 version (MCC) | 18.0.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29501/raw.md b/marked/Rel-18/29_series/29501/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e95a240a408f514d60ac6e20678316a94b90456a --- /dev/null +++ b/marked/Rel-18/29_series/29501/raw.md @@ -0,0 +1,3804 @@ + + +# 3GPP TS 29.501 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Principles and Guidelines for Services Definition; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 9 | +| 3.3 Special characters, operators and delimiters ..... | 9 | +| 3.3.1 General ..... | 9 | +| 3.3.2 ABNF operators..... | 9 | +| 3.3.3 URI reserved and special characters..... | 9 | +| 3.3.4 SBI specific usage of delimiters..... | 10 | +| 4 Design Principles for 5GC SBI APIs..... | 10 | +| 4.1 General Principles ..... | 10 | +| 4.2 API Design Style and REST Implementation Levels ..... | 11 | +| 4.2.1 General ..... | 11 | +| 4.2.2 API Design Principles for Query Operation..... | 11 | +| 4.2.3 API Design Principles for Delete Operation ..... | 11 | +| 4.3 Version Control..... | 12 | +| 4.3.0 General ..... | 12 | +| 4.3.1 Structure of API version numbers ..... | 12 | +| 4.3.1.1 API version number format ..... | 12 | +| 4.3.1.2 Rules for incrementing field values ..... | 12 | +| 4.3.1.3 Visibility of the API version number fields..... | 16 | +| 4.3.1.4 Relation to the Technical Specification version number..... | 16 | +| 4.3.1.5 Discovery of the supported versions..... | 16 | +| 4.3.1.6 Withdrawing API versions..... | 17 | +| 4.4 URI Structure ..... | 17 | +| 4.4.1 Resource URI structure ..... | 17 | +| 4.4.2 Custom operations URI structure ..... | 18 | +| 4.4.3 Callback URI structure ..... | 18 | +| 4.5.1 Resource Representation ..... | 18 | +| 4.5.2 Content Format Negotiation ..... | 19 | +| 4.6 Use of HTTP Methods ..... | 19 | +| 4.6.1 Use of Request/Response Communication ..... | 19 | +| 4.6.1.1 CRUD ..... | 19 | +| 4.6.1.1.1 Creating a Resource ..... | 19 | +| 4.6.1.1.2 Reading a Resource..... | 21 | +| 4.6.1.1.3 Updating a Resource ..... | 22 | +| 4.6.1.1.4 Deleting a Resource ..... | 24 | +| 4.6.1.1.5 Query Parameters ..... | 24 | +| 4.6.1.2 Custom Operations ..... | 25 | +| 4.6.1.3 Use of Asynchronous Operations ..... | 26 | +| 4.6.1.4 Special provisions to support the seamless change of AMF as NF service producer ..... | 27 | +| 4.6.2 Use of Subscribe/Notify Communication ..... | 27 | +| 4.6.2.1 General..... | 27 | +| 4.6.2.2 Management of Subscriptions ..... | 28 | +| 4.6.2.2.1 General ..... | 28 | +| 4.6.2.2.2 Creation of a Subscription..... | 28 | +| 4.6.2.2.3 Modify a subscription..... | 29 | +| 4.6.2.2.4 Delete a subscription ..... | 30 | +| 4.6.2.3 Notifications..... | 31 | +| 4.6.2.4 Special provisions to support the seamless change of AMF as NF service consumer ..... | 32 | +| 4.7 HATEOAS ..... | 32 | +| 4.7.1 General ..... | 32 | +| 4.7.2 3GPP hypermedia format ..... | 32 | + +| | | | +|---------|----------------------------------------------------------------------------------|----| +| 4.7.2.1 | Basic 3GPP hypermedia format..... | 32 | +| 4.7.2.2 | Extended 3GPP hypermedia format ..... | 33 | +| 4.7.3 | Advertising legitimate application state transitions..... | 34 | +| 4.7.4 | Inferring link relation semantic ..... | 34 | +| 4.7.5 | Common Relation Types..... | 34 | +| 4.7.5.1 | Introduction..... | 34 | +| 4.7.5.2 | Registered relation types..... | 34 | +| 4.7.5.3 | Extension relation types..... | 35 | +| 4.7.6 | Negotiating the support of optional HATEOAS features..... | 35 | +| 4.8 | Error Responses..... | 35 | +| 4.8.1 | Error Response Status Code ..... | 35 | +| 4.8.2 | Error Response Body..... | 35 | +| 4.8.3 | Extending ProblemDetails for API Backward Compatibility ..... | 36 | +| 4.9 | Transferring multiple resources to a NF Service Consumer ..... | 37 | +| 4.9.1 | General ..... | 37 | +| 4.9.2 | Direct Delivery ..... | 37 | +| 4.9.3 | Direct Delivery with Iterations ..... | 37 | +| 4.9.4 | Indirect Delivery..... | 39 | +| 4.9.5 | Indirect Delivery with HTTP/2 Server Push ..... | 39 | +| 4.9.6 | Criteria for choosing the transfer method..... | 41 | +| 4.10 | Scopes definition for OAuth2.0 access token ..... | 41 | +| 5 | Documenting 5GC SBI APIs ..... | 42 | +| 5.1 | Naming Conventions..... | 42 | +| 5.1.1 | Case Conventions ..... | 42 | +| 5.1.2 | API Naming Conventions..... | 43 | +| 5.1.3 | Conventions for URI Parts ..... | 43 | +| 5.1.3.1 | Introduction..... | 43 | +| 5.1.3.2 | URI Path Segment Naming Conventions ..... | 44 | +| 5.1.3.3 | URI Query Naming Conventions ..... | 44 | +| 5.1.4 | Conventions for Names in Data Structures ..... | 45 | +| 5.2 | API Definition ..... | 45 | +| 5.2.1 | Resource Structure..... | 45 | +| 5.2.2 | Resources and HTTP Methods ..... | 47 | +| 5.2.3 | Representing RPC as Custom Operations on Resources..... | 49 | +| 5.2.3A | Notifications ..... | 50 | +| 5.2.4 | Data Models..... | 52 | +| 5.2.4.1 | General..... | 52 | +| 5.2.4.2 | Structured data types..... | 53 | +| 5.2.4.3 | Simple data types and enumerations..... | 54 | +| 5.2.4.4 | Binary Data ..... | 55 | +| 5.2.4.5 | Data types describing alternative data types or combinations of data types ..... | 55 | +| 5.2.5 | Void..... | 56 | +| 5.2.6 | 3GPP Custom HTTP Headers ..... | 56 | +| 5.3 | OpenAPI specification files ..... | 56 | +| 5.3.1 | General ..... | 56 | +| 5.3.2 | Formatting of OpenAPI specification files..... | 57 | +| 5.3.3 | Info ..... | 57 | +| 5.3.4 | externalDocs ..... | 57 | +| 5.3.5 | Servers ..... | 58 | +| 5.3.6 | References to other 3GPP-defined OpenAPI specification files ..... | 58 | +| 5.3.7 | Server-initiated communication ..... | 59 | +| 5.3.8 | Describing the body of HTTP PATCH requests ..... | 60 | +| 5.3.8.1 | General..... | 60 | +| 5.3.8.2 | JSON Merge Patch..... | 60 | +| 5.3.8.3 | JSON PATCH..... | 61 | +| 5.3.9 | Structured data types ..... | 61 | +| 5.3.10 | Data types describing alternative data types or combinations of data types ..... | 63 | +| 5.3.11 | Error Responses..... | 65 | +| 5.3.12 | Enumerations..... | 66 | +| 5.3.13 | Formatting of structured data types in query parameters ..... | 67 | +| 5.3.14 | Attribute Presence Conditions..... | 67 | + +| | | | +|-------------------------------|-----------------------------------------------------------------|-----------| +| 5.3.15 | Usage of the "tags" field..... | 69 | +| 5.3.16 | Security ..... | 70 | +| 5.3.17 | Reuse of Structured Data Types ..... | 72 | +| 5.3.18 | Operation identifiers ..... | 72 | +| 5.3.19 | Formatting of description fields ..... | 73 | +| 6 | Requirements for secure API design..... | 73 | +| 6.1 | Introduction ..... | 73 | +| 6.2 | General ..... | 73 | +| 6.3 | SBA-specific requirements ..... | 74 | +| Annex A (informative): | TS Skeleton Template ..... | 75 | +| Annex B (informative): | Backward Incompatible Changes ..... | 75 | +| Annex C (Informative): | Resource modelling ..... | 76 | +| C.0 | General..... | 76 | +| C.1 | Document..... | 76 | +| C.2 | Collection..... | 76 | +| C.3 | Store ..... | 77 | +| C.4 | Custom operation ..... | 77 | +| Annex D (informative): | Example of an OpenAPI specification file for Patch ..... | 78 | +| Annex E (Informative): | Considerations for handling of JSON arrays ..... | 80 | +| Annex F (informative): | Change history..... | 83 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document defines design principles and documentation guidelines for 5GC SBI APIs. These principles and guidelines should be followed when drafting the 5G System SBI Stage 3 specifications. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [3] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [4] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [5] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [6] IETF RFC 7231: "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content". +- [7] IETF RFC 7396: "JSON Merge Patch". +- [8] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". +- [9] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". +- [10] IETF RFC 5789: "PATCH Method for HTTP". +- [11] IETF RFC 8288: "Web Linking". +- [12] IANA: "HTTP Status Code Registry at IANA", . +- [13] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [14] Fielding, Roy Thomas. Architectural Styles and the Design of Network-based Software Architectures. Doctoral dissertation, University of California, Irvine, 2000. +- [15] Erik Wilde, Cesare Pautasso, REST: From Research to Practice, Springer. +- [16] YAML 1.2: "YAML Ain't Markup Language", . + +- [17] Semantic Versioning Specification: . +- [18] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [19] IETF RFC 9457: "Problem Details for HTTP APIs". +- [20] 3GPP TS 29.502: "5G System; Session Management Services; Stage 3". +- [21] 3GPP TS 29.509: "5G System; Authentication Server Services; Stage 3". +- [22] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [23] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [24] 3GPP TS 29.573: "5G System; Public Land Mobile Network (PLMN) Interconnection; Stage 3". +- [25] 3GPP TR 21.900: "Technical Specification Group working methods". +- [26] IETF RFC 5234: "Augmented BNF for Syntax Specifications: ABNF". +- [27] 3GPP TS 23.003: "Numbering, addressing and identification". +- [28] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**Absolute URI:** Absolute URI follows generic URI syntax and consists of a hierarchical sequence of the following components: the "scheme", "authority", "path" and "query", i.e. excluding the "fragment" component. See clause 4.3 in IETF RFC 3986 [9]. + +**apiRoot:** apiRoot follows an absolute URI syntax, but excludes the following absolute URI identifiers: the "query" and "fragment" components. The API root contains the "scheme" and the "authority" components and may also contain an API prefix subcomponent. See clause 4.4.1. In 3GPP APIs, the default apiRoot value is "https://example.com" (see e.g. Annex A.2 in 3GPP TS 29.502 [20]), where "example.com" is replaced by the operator specific FQDN (for FQDN examples see clause 28.3.2 in 3GPP TS 23.003 [27]). + +**API Prefix:** API prefix is an optional, deployment-specific string, which is a subcomponent of the "apiRoot". API prefix format follows "path-absolute" syntax and that starts with a "/" reserved character (see clause 4.4.1 and also clause 3.3 in IETF RFC 3986 [9]). In 3GPP APIs, the default apiRoot does not contain API Prefix (see e.g. Annex A.2 in 3GPP TS 29.502 [20]). + +**API URI:** API URI has the following format: "{apiRoot}//". For more details see clause 4.4.1. As an example, for the Nudm\_SDM API defined in 3GPP TS 29.503 [28], the API URI is: "{apiRoot}/nudm-sdm/v2". + +**Base URI:** Base URI is used as a reference against which the relative URI reference is applied. See clause 4.6.1.1.1.2 and also clause 5.1 in IETF RFC 3986 [9]. As an example, for the resource URI of the SM contexts collection that is defined in Nsmf\_PDUSession API (see 3GPP TS 29.502 [20]), the base URI is "{apiRoot}/nsmf-pdusession/". + +**Callback URI:** Callback URI follows an absolute URI syntax, but excludes the following absolute URI identifiers: "userinfo" subcomponent of the "authority" component and also the "query" component ("fragment" component is already excluded from the absolute URI). Therefore, callback URI contains the "scheme", "authority" (excluding "userinfo" subcomponent) and the "path" components. See clause 4.4.3. As an example, for the Nsmf\_PDUSession API defined in 3GPP TS 29.502 [20], "smContextStatusUri" is one of the callback references that can be provided by the NF Service Consumer. A complete callback URI for the "smContextStatusUri" has the following structure + +//smContextStatus>, where "consumer-host" is either an FQDN or an IP address (see clause 4.4.3). + +**Relative path after API URI:** Refers to the sequence of path segments of a resource URI that are below the API URI (see the definition of the "Paths Object" in OpenAPI specification [4]). When appended to the API URI of the concerned API, it constitutes the resource URI. As an example, for the Nudm\_SDM API defined in 3GPP TS 29.503 [28] for which the API URI is "{apiRoot}/nudm-sdm/v2", the "relative path after API URI" for the "AccessAndMobilitySubscriptionData" resource is:("/{supi}/am-data". + +**Relative URI:** Relative URI is deprecated and shall not be used in SBI specifications. See clause 1.2.3 in IETF RFC 3986 [9]. + +**Resource URI:** Resource URI identifies an abstract or a physical resource. See the Abstract of the IETF RFC 3986 [9]. In this specification this generally means "an URI of a resource". Resource URI structure is defined in clause 4.4.1. As an example, for the resource URI of the SM contexts collection that is defined in Nsmf\_PDUSession API (see 3GPP TS 29.502 [20]), the resource URI is "{apiRoot}/nsmf-pdusession//sm-contexts". + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|---------|-----------------------------------------------| +| 5GC | 5G Core Network | +| CNF | Conjunctive Normal Form | +| CRUD | Create, Read, Update, Delete | +| DNF | Disjunctive Normal Form | +| HAL | Hypertext Application Language | +| HATEOAS | Hypermedia as the Engine of Application State | +| REST | REpresentational State Transfer | +| RPC | Remote-Procedure-Call | +| SBI | Service Based Interface | +| YAML | YAML Ain't Markup Language | + +## 3.3 Special characters, operators and delimiters + +### 3.3.1 General + +A number of characters have special meaning and are used as delimiters in this document and also in other stage 3 SBI specifications. Below clauses specify the usage of a selected set of the special characters. Full set of these special characters are specified in the respective IETF specifications. + +### 3.3.2 ABNF operators + +Special characters that are used as delimiters in ABNF syntax have somewhat different purpose from the same characters when used by URI syntax. See clause 3.3.2 in 3GPP TS 29.500 [2]. + +### 3.3.3 URI reserved and special characters + +| | | +|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| / | Reserved character. The forward slash character is a delimiter, which precedes an URI path component and also separates a sequence of path segments. See clauses 2.2 and 3.3 in IETF RFC 3986 [9]. | +| # | Reserved character. The number sign (hash) character is a delimiter, which terminates either an URI path component, or an authority component, or a query component and starts a fragment component. See clauses 2.2, 3.2, 3.3 and 3.5 in IETF RFC 3986 [9]. | +| ? | Reserved character. The question mark character is a delimiter, which terminates either an URI path component, or an authority component and starts a query component/parameter. See clauses 2.2, 3.2, 3.3 and 3.4 in IETF RFC 3986 [9]. | +| = | Reserved character. The equal sign character is a delimiter, which separates a parameter name and its value, e.g. in an URI query. See clauses 1.2.3 and 3.3 in IETF RFC 3986 [9]. | + +| | | +|-----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [ ] | Reserved character. The square bracket characters enclose an IPv6 literal address. This is the only place where square bracket characters are allowed in the URI syntax. See clause 3.2.2 in IETF RFC 3986 [9]. | +| < > | Special characters. The angle bracket characters are delimiters and enclose a complete URI or an URI component or a subcomponent. See Appendix C in IETF RFC 3986 [9]. | +| ; | Reserved character. The semicolon character is a delimiter, which is often used to separates a parameter name and its value in a path segment. See clause 3.3 in IETF RFC 3986 [9]. | +| : | Reserved character. The colon character is a delimiter, which either terminates an URI scheme component, or userinfo subcomponent, or separates host subcomponent from the port subcomponent, an authority component, or a query component and starts a fragment component. See clauses 2.2, and 3.2 in IETF RFC 3986 [9]. | + +NOTE: The same characters, like "/", "#", etc. lead to different processing in ABNF and URI grammars. For instance, in URI syntax, ";" character separates parameter and its value, while in ABNF ";" starts a comment. + +### 3.3.4 SBI specific usage of delimiters + +The braces (curly brackets) are used as delimiters across the SBI specifications, but have somewhat different purpose as specified below. + +| | | +|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| { } | Delimiters. The braces (curly brackets) characters enclose a name of a variable in an URI path segment (see clause 5.1.3.2). Example: .../subscriber-data/{supi}. | +| { } | Delimiters. The braces (curly brackets) characters enclose a parameter value in a query (see clause 5.1.3.3). Example: ?nf-id={chooseAValue} | + +NOTE: In SBI specifications, "<>" is a generic placeholder, while "{ }" enclose specifically a variable. + +# 4 Design Principles for 5GC SBI APIs + +## 4.1 General Principles + +Each 5GC SBI API specification should include the following information for each specified service: + +- Purpose of the API; +- URIs of resources; +- Supported HTTP methods for a given resource; +- Supported representations (e.g. JSON, see IETF RFC 8259 [3]); +- Request body schema(s) (where applicable); +- Response body schema(s) (where applicable); +- Supported response status codes; +- Relation types supported if HATEOAS is implemented by the API; +- A reference in the resource description clause to one of the archetypes defined in Annex C if the resource design matches one of them; and +- A list defining identifiers of optional features (see clause 6.6 of 3GPP TS 29.500 [2] for related procedures). + +For each specified service a clause to a normative Annex should be provided containing the OpenAPI definitions according to OpenAPI Specification [4] for the service. The specifications should state that content of this normative annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods. + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +The TS Skeleton Template as provided in Annex A should be used as a starting point when drafting 5GC SBI API specifications. + +Common procedures, HTTP extensions and error handling applicable to several 5GC SBI API specifications should be defined in 3GPP TS 29.500 [2] and should be referenced from individual 5GC SBI API specifications. + +Common data types applicable to several 5GC SBI API specifications should be defined in 3GPP TS 29.571 [5] and should be referenced from individual 5GC SBI API specifications. + +## 4.2 API Design Style and REST Implementation Levels + +### 4.2.1 General + +5GC SBI API specifications should apply a protocol design framework as follows: + +- a) REST-style service operations should implement the Level 2 of the Richardson maturity model, with standard HTTP methods, whenever it is a good match for the style of interaction to model, e.g. service operations that can naturally map to one of the standard methods (CRUD operations), this should be the preferred modelling attempt; +- b) service operations may use custom API operations (RPC-style interaction), when it is seen a better fit for the style of interaction to model, e.g. non-CRUD service operations; +- c) it is possible to mix REST-style operations and RPC-style operations in the same API. + +NOTE: Level 3 (HATEOAS) of the Richardson maturity model in the 5G Service-Based Architecture can be implemented by an API but is optional. Hypermedia usage guidelines are provided in clause 4.7 of the present specification. + +### 4.2.2 API Design Principles for Query Operation + +When designing a query operation API, i.e. the NF service consumer invokes the API aiming to retrieve certain information from the NF service producer, the following principles should be applied: + +- a) if the query operation does not require any input parameter for the NF service producer, then the REST-style service operation with standard HTTP GET method should be used (see clause 4.6.1.1.2); +- b) if + - the query operation requires input parameter(s) for the NF service producer; and + - all the required input parameter(s) are used to identify a particular resource and/or control the content of the result of the query operation; + +then the REST-style service operation with standard HTTP GET method should be used (see clause 4.6.1.1.2); + +- c) standard HTTP GET method shall not be used for non-safe operations and non-idempotent operations. + +### 4.2.3 API Design Principles for Delete Operation + +When designing a delete operation API, i.e. the NF service consumer invokes the API aiming to delete certain resource on the NF service producer, the following principles should be applied: + +- a) if the delete operation does not require any input parameter for the NF service producer, then the REST-style service operation with standard HTTP DELETE method should be used (see clause 4.6.1.1.4); +- b) if + +- the delete operation requires input parameter(s) for the NF service producer; and +- all the required input parameter(s) are used to identify a particular resource and/or control the content of the result of the delete operation; + +then the REST-style service operation with standard HTTP DELETE method should be used (see clause 4.6.1.1.4); + +- c) standard HTTP DELETE method shall not be used for non-idempotent operations. + +## 4.3 Version Control + +### 4.3.0 General + +The version control mechanism in the present clause allows the management of changes to an API and provides a version number that is incremented whenever changes to the API are applied. + +NOTE: The version number does not reflect the usage of optional features. A mechanism to negotiate the usage of optional features is defined in clause 6.6 of 3GPP TS 29.500 [2]. + +### 4.3.1 Structure of API version numbers + +#### 4.3.1.1 API version number format + +API version numbers shall consist of at least 3 fields, following a MAJOR.MINOR.PATCH pattern according to the Semantic Versioning Specification [17]. + +The 1st Field (MAJOR), the 2nd Field (MINOR), and the 3rd Field (PATCH) shall contain unsigned integer numbers, and they shall not contain leading zeroes. + +An additional field (called "pre-release version" in Semantic Versioning Specification [17]) is added to denote an OpenAPI version under development, i.e. prior to the freeze of the corresponding OpenAPI description for a given 3GPP Release. This additional field is appended after the 3 first version fields using the hyphen "-" character and shall have the format "alpha.n", where "n" is an unsigned integer number without leading zeroes. + +NOTE: An OpenAPI is referred to as "non-frozen", if for a given 3GPP Release the OpenAPI freeze milestone was not reached. Otherwise, an OpenAPI is referred to as "frozen". + +After the freeze of a 3GPP Release, additional fields (called "build metadata" in Semantic Versioning Specification [17]), containing operator-specific version information, may be appended after the 3 first version fields using the plus sign "+" character and they shall consist of a list of dot-separated identifiers, where each identifier may contain only alphanumeric characters and hyphens ([0-9A-Za-z-]). + +NOTE: Operator-specific version information are ignored when determining version precedence. Thus, two versions that differ only in the operator-specific version information, have the same precedence. + +##### EXAMPLES: + +"1.0.0-alpha.1" + +"3.0.1+orange.2020-09" + +#### 4.3.1.2 Rules for incrementing field values + +The first version of a new API under development shall obtain the version number "1.0.0-alpha.1". At the first publication of the 3GPP Technical Specification defining the API after the OpenAPI freeze of the first 3GPP Release that contains the API, the version number of the API shall be set to "1.0.0". + +When a new version of the 3GPP TS containing OpenAPI file(s) is published, the fields of the corresponding API version number(s) shall be incremented according to the following rules: + +- The 1st Field (MAJOR) shall be incremented only if the applied change is backward incompatible relative to the earlier, i.e. frozen version of the given OpenAPI (see the details below). For a non-frozen OpenAPI, the first backwards incompatible change relative to the latest frozen version triggers incrementing the 1st Field (MAJOR), while subsequent backwards incompatible changes do not increment the value, until the OpenAPI stays non-frozen. When the 1st Field (MAJOR) is incremented, this impacts the lower level fields as follows: + - The 2nd Field (MINOR) shall be reset to "0"; + - The 3rd Field (PATCH) shall be reset to "0"; + - The 4th Field (NON-FROZEN), if present shall be reset to "alpha.1" (this field is removed when the OpenAPI freezes). + +The 2nd Field (MINOR) shall be incremented only if the applied change is a backward compatible new feature relative to the earlier, i.e. frozen version of the given OpenAPI (see the details below). For a non-frozen OpenAPI, the first backwards compatible change relative to the latest frozen version triggers incrementing the 2nd Field (MINOR), while subsequent backwards incompatible changes do not increment the value, until the OpenAPI stays non-frozen. When the 2nd Field (MINOR) is incremented, this impacts the lower level fields as follows: + +- The 3rd Field (PATCH) shall be reset to "0"; +- The 4th Field (NON-FROZEN), if present shall be reset to "alpha.1" (this field is removed when the OpenAPI freezes). + +The 3rd Field (PATCH) shall be incremented only if the applied change is a backward compatible correction relative to the earlier, i.e. frozen version of the given OpenAPI (see the details below). For a non-frozen OpenAPI, the first backwards compatible change relative to the latest frozen version triggers incrementing the 3rd Field (PATCH), while subsequent backwards incompatible changes do not increment the value, until the OpenAPI stays non-frozen. When the 3rd Field (PATCH) is incremented, this impacts the lower level field as follows: + +- The 4th Field (NON-FROZEN), if present shall be reset to "alpha.1" (this field is removed when the OpenAPI freezes). +- The 4th Field (NON-FROZEN), if present shall be incremented in a non-frozen OpenAPI every time any kind of changes are applied the given non-frozen OpenAPI (see the details below). This field is removed when the OpenAPI freezes. + +##### 1st Field (MAJOR): + +- This numerical field shall be incremented when: + - a) there are one or more backward incompatible changes to the API after the OpenAPI freeze for a given 3GPP Release; and + - b) there are the first backward incompatible change(s) to the existing API with respect to the latest version in the previous 3GPP Release while a 3GPP Release is under development (i.e. prior to the OpenAPI freeze for a given 3GPP Release). + +EXAMPLE 1: Assuming that 3GPP Rel-16 under development contains API version "1.1.0-alpha.2", and a backward incompatible change with respect to the latest version in the previous 3GPP Release is applied to that API before the OpenAPI freeze, the new Rel-16 API version is "2.0.0-alpha.1". + +NOTE 1: Subsequent changes in a given 3GPP Release under development do not lead to increment of the 1st field (MAJOR) and 2nd field (MINOR). + +NOTE 2: Rules for determining backward incompatible changes are provided in Annex B. + +NOTE 3: It is recommended to avoid backward incompatible change to the API after the OpenAPI freeze whenever possible, especially after OpenAPI freeze of a succeeding Release. It is preferable to introduce such changes only in the 3GPP Release under development. + +- If a backward incompatible change needs to be applied to several 3GPP Releases the following applies: + +- a) If the 3GPP Releases contain different MAJOR versions of the same API, a new MAJOR API version shall be assigned to each 3GPP Release in the order of those 3GPP Releases in such a manner that the lowest of those 3GPP Releases shall obtain the first unassigned MAJOR version value. + +EXAMPLE 2: Assuming that 3GPP Rel-15 contains API version "1.0.0", and Rel-16 contains API version "2.0.0", and that the same backward incompatible change is applied to that API in both Releases, the new Rel-15 API version is "3.0.0" and the new Rel-16 API version is "4.0.0". + +- b) If the 3GPP Releases contain the same MAJOR version but different MINOR versions of the same API, a single new MAJOR API version value shall be assigned for all those 3GPP Releases, unless other backward incompatible changes only applied to some of those Releases require the creation of separate MAJOR versions. + +NOTE 4: For each such Release a new MINOR version is assigned. + +EXAMPLE 3: Assuming that 3GPP Rel-15 and Rel-16 contain API version "1.0.0", and Rel-17 contains API version "1.2.0", and that the same backward incompatible change is applied to that API in all 3GPP Releases, the new 3GPP Rel-15 and Rel-16 API version is "2.0.0" and the new 3GPP Rel-17 API version is "2.2.0". + +- c) If the 3GPP Releases contain the same API versions, a single new API version shall be assigned for all those 3GPP Releases, unless other changes only applied to some of those Releases require the creation of separate versions. + +EXAMPLE 4: Assuming that 3GPP Rel-15 and 3GPP Rel-16 contain API version "1.0.0", and that only the same backward incompatible change is applied to that API in both 3GPP Releases, the new 3GPP Rel-15 and Rel-16 API version is "2.0.0". + +EXAMPLE 5: Assuming that 3GPP Rel-15 and Rel-16 contain API version "1.0.0", and that the same backward incompatible change is applied to that API in both Releases and an additional backward compatible change is applied in 3GPP Rel-16, the new 3GPP Rel-15 API version is "2.0.0", and the 3GPP Rel-16 API version is "2.1.0". + +EXAMPLE 6: Assuming that 3GPP Rel-15 and Rel-16 contain API version "1.0.0", and that the same backward incompatible change is applied to that API in both Releases and an additional backward incompatible change is applied in 3GPP Rel-16, the new 3GPP Rel-15 API version is "2.0.0", and the 3GPP Rel-16 API version is "3.0.0". + +##### 2nd Field (MINOR): + +- This numerical field shall be incremented when: + +- a) there are the first one or more backward compatible changes not corresponding to changes to earlier 3GPP Releases (i.e. changes introduced by 3GPP CR with other categories than "mirror") to the same API in a given 3GPP Release without any prior backward incompatible changes in that Release. If the same 1st field (MAJOR) and the 2nd field (MINOR) are assigned to $n$ previous 3GPP Releases, a MINOR version number shall be reserved for each intermediate 3GPP Release for possible subsequent changes in that Release and the MINOR version number shall be incremented by $n$ ; and + +EXAMPLE 7: Assuming that 3GPP Rel-15 and Rel-16 contain API version "1.0.0" (because there were no changes to the API in Rel-16), and in Rel-17 the first backward compatible new feature is added before the OpenAPI freeze, the API version "1.2.0-alpha.1" is assigned to Rel-17. + +- b) there are one or more subsequent backward compatible additions of features not corresponding to changes to previous 3GPP Releases to the API in a frozen 3GPP Release before a higher MINOR number has been allocated for the same MAJOR version (for a subsequent Release). + +- This field shall be reset to "0" if the 1st field (MAJOR) is changed, unless a backward incompatible change needs to be applied to several 3GPP Releases that already contain the same MAJOR but different MINOR API versions. In that case a single new major API version is assigned, and for each such 3GPP Release with an own MINOR version, a new MINOR version shall be assigned, starting with MINOR version "0" for the lowest such Release, and reserving a MINOR version number for each intermediate Release without an own MINOR version. (see Example 3) + +NOTE 5: In most cases the MINOR version is incremented when new backward compatible features are added in a 3GPP Release. In rare cases, where only backward compatible changes not corresponding to changes to previous 3GPP Releases are applied to a 3GPP Release, the MINOR version is also incremented. It is recommended to avoid such changes in 3GPP Releases without added functionality whenever possible. + +NOTE 6: Subsequent backward compatible changes in a given 3GPP Release before OpenAPI freeze do not lead to an increment of the 2nd field (MINOR). + +NOTE 7: Changes corresponding to changes in previous 3GPP Releases do not lead to an increment of the 2nd field (MINOR). + +NOTE 8: If two 3GPP Releases are under parallel development (because the work on Rel-*X+1* has commenced before the OpenAPI freeze of Rel-*X*), the corresponding APIs will obtain distinct values of the 1st field (MAJOR) or 2nd field (MINOR). + +EXAMPLE 8: Assuming that an API was introduced with version "1.0.0" in Rel-15, and that the Rel-16 version is "1.1.0-alpha.5" because the OpenAPI is not yet frozen in Rel-16, and that a new backward compatible Rel-17 feature is added, the Rel-17 API version is "1.2.0-alpha.1". + +##### 3rd Field (PATCH): + +- This numerical field shall be incremented: + - a) if the changes are only one or more backward-compatible corrections (but no changes requiring an update of the 1st field (MAJOR) or of the 2nd field (MINOR) are made to the API after the OpenAPI freeze of a 3GPP Release; and + - b) if one or more backward compatible additions of features, but no changes requiring an update of the 1st field (MAJOR) or of the 2nd field (MINOR), are made to the API after the OpenAPI freeze of a 3GPP Release and after the assignment of a MINOR version to a higher 3GPP Release. +- This field shall be reset to "0" if the 1st field (MAJOR) or 2nd field (MINOR) is changed. + +NOTE 9: Before the OpenAPI freeze for a given 3GPP Release, the 3rd field (PATCH) will not be incremented. + +NOTE 10: If the 1st field (MAJOR) and 2nd field (MINOR) were not incremented between 3GPP Releases (because there were no added features and no backward incompatible changes), and the same backward compatible changes are then applied to those 3GPP Releases, the API files in those 3GPP Releases are identical and will obtain the same API version number. + +NOTE 11: In rare cases for which a new backward compatible functionality needs to be added in an older 3GPP Release after the OpenAPI freeze and work on that API already started in a later Release, the new functionality is exceptionally introduced as a PATCH correction and a new supported feature could be defined accordingly. + +##### The 4th Field (NON-FROZEN and/or OPERATOR-SPECIFIC): + +- The 4th Field may or may not be present, based on the following conditions. +- NON-FROZEN type. The presence of this field type depends on the OpenAPI status, as follows: + - The 4th Field (NON-FROZEN) shall be present before the OpenAPI freeze of a 3GPP Release. An additional field (separated from the 3 first version fields by a hyphen "-" character) shall be supplied as follows: + - a) When the 1st field (MAJOR) or 2nd field (MINOR) is incremented before the OpenAPI freeze of a 3GPP Release, this field shall obtain the value "alpha.1". + - b) The numerical value "*n*" within the field value "alpha.*n*" shall be incremented if one or more subsequent changes (either backward incompatible, or backward compatible) are made to the given non-frozen OpenAPI. + - The 4th Field (NON-FROZEN) shall not be present after the OpenAPI freeze of a 3GPP Release., this additional field (including the hyphen "-" character) containing pre-release version info is removed from the API version. + +- OPERATOR-SPECIFIC type that represents operator-specific version field(s). The presence of these fields depends on the OpenAPI status, and the operator preferences: + - The 4th Field (OPERATOR-SPECIFIC) shall be present after the OpenAPI freeze of a 3GPP Release. Additional fields may be supplied based on operator policy after the 3 first version fields and separated by a plus sign "+" character. The rules for setting, or incrementing, such fields are out of the scope of 3GPP, but they shall comply with the rules described in the Semantic Versioning Specification [17], and contain a list of dot-separated labels within the allowed character set ([0-9A-Za-z-]). + +If no change is applied to an API in a new published TS version, the API version number shall not be incremented unless the additional field ("-alpha.n") needs to be removed at OpenAPI freeze. This also applies if the TS is published in a new 3GPP Release. + +NOTE 12: OpenAPI files can contain references to other OpenAPI files. Changes to referenced parts of such other OpenAPI files need to be considered when determining if and how to update an API version. + +NOTE 13: The API version number of those version fields managed by 3GPP is incremented using 3GPP change requests. + +#### 4.3.1.3 Visibility of the API version number fields + +The API version shall be indicated in the resource URI of every API, as described in clause 4.4.1. + +The API version shall be indicated as the concatenation of the letter "v" and the 1st field (MAJOR) of the API version number. + +The other fields shall not be included in the resource URI. + +NOTE: Including these digits in the URI would force the NF service consumer to select a specific sub-version, at the risk of seeing the request rejected if the NF service provider does not support it, while the request could have been served by ignoring unknown elements. + +The full API version number (i.e., containing all the fields) shall be visible in the OpenAPI specifications, in the "version" subfield of the "info" field, as described in clause 5.3.3. + +#### 4.3.1.4 Relation to the Technical Specification version number + +There is no one-to-one mapping between an API version number and the version number of the 3GPP Technical Specification defining this API. + +A 3GPP Technical Specification specifies one or more APIs, which may have different versions. + +A change in the 3rd field (PATCH) of a 3GPP TS version number (i.e. an editorial change) should not lead to a change in the version number of the APIs specified in the 3GPP TS. + +A change in the 1st field (MAJOR) and 2nd fields (MINOR) of the 3GPP TS version number is likely to lead to at least a change in the minor version number of the APIs specified in the 3GPP TS. + +EXAMPLE: If version 15.4.1 of a 3GPP TS contains version "1.1.1" of API A, B and C, and a version 16.0.0 of this 3GPP TS is derived from version 15.4.1, TS version 16.0.0 can contain version "1.2.0.alpha-1" of API A (if all changes made are backward compatible), version "2.0.0.alpha-1" of API B (if some changes are no backward compatible) and version "1.1.1" of API C (if no changes were made). + +The 3GPP TS defining the API is indicated in the OpenAPI specification of the API, as described in clause 5.3.4. + +#### 4.3.1.5 Discovery of the supported versions + +The NF service consumer may discover the API version(s) supported by an NF service producer using the following mechanisms: + +- NRF query: The NF service consumer may retrieve from the NRF the NF profile of a given NF Instance. This NF profile contains the full version number(s) of the API(s) supported by an NF Service Instance, as described in the clause 6.2.6.2.4 of 3GPP TS 29.510 [18] and the planned retirement date. + +- NF profile change notifications: The NF service consumer may subscribe for NF status change notifications with the NRF as specified in clause 5.2.2.5 of 3GPP TS 29.510 [18]. The NRF shall notify as specified in clause 5.2.2.6 of 3GPP TS 29.510 [18], any change to the NF profile which may include updated NF service profile containing the current list of NF services and their versions supported by the NF. + +When a new major version is created, the NF service producer shall continue supporting at least the previous major version until a retirement date unless all API versions (except for draft API versions published prior to the OpenAPI freeze) with that previous major version are withdrawn (see clause 4.3.1.6); this enables NF service consumers to migrate to the new version. After expiration of the retirement date, the old major version should be deprecated. The retirement date of an old major version supported by a NF service instance may be updated in the NF profile in the NRF. + +#### 4.3.1.6 Withdrawing API versions + +If it is discovered that one or several previous API versions are not providing the basic mandatory functionality of an API due to severe functional or encoding deficits (for instance, there is no or very limited interoperability between the NF service consumer and NF service producer when such an API version is used, or the API is hardly implementable because of severe deficits in the OpenAPI file that cannot easily be fixed by implementers in an interoperable manner), those API versions shall be listed as withdrawn in subsequent versions of the TS defining the corresponding API; any withdrawn API versions from the same or previous 3GPP releases shall be listed. API versions published before the OpenAPI freeze of the corresponding 3GPP Release, i.e. with a 4th Field (NON-FROZEN and/or OPERATOR-SPECIFIC) as part of the version number, shall not be withdrawn. + +NOTE 1: It is recommended to avoid withdrawing API versions whenever possible. It is expected that a need to withdraw API versions is most likely detected when discussing corrections soon after the OpenAPI freeze of a new API. + +NOTE 2: Corrections to optional or minor parts of the API functionality do not lead to the withdrawal of API versions. However, if severe functional or encoding deficits of the functionality related to an optional functionality with a corresponding supported feature (see 3GPP TS 29.500 [2] clause 6.6.2) are discovered, a new supported feature can be introduced to enable a negotiation of the support of the correction, and the old corresponding supported feature can be marked as "withdrawn" in the table defining the supported features of an API. + +Withdrawn API versions should not be deployed. + +## 4.4 URI Structure + +### 4.4.1 Resource URI structure + +Resources are either individual resources, or structured resources that can contain child resources. It is recommended to design each resource following one of the archetypes provided in the Annex C. + +A URI uniquely identifies a resource. In the 5GC SBI APIs, when a resource URI is an absolute URI, its structure shall be specified as follows: + +**{apiRoot}** + +"apiRoot" shall be a concatenation of the following parts: + +- scheme ("http" or "https") + +NOTE: In this release of the specification both http and https scheme URIs are allowed. See clause 13.1 of 3GPP TS 33.501[22] for further details on security of Service Based Interfaces. + +- the fixed string "://" +- authority (host and optional port) as defined in IETF RFC 3986 [9]. The host should be represented by the operator specific FQDN (for FQDN examples see clause 28.3.2 in 3GPP TS 23.003 [27]). +- an optional deployment-specific string (API prefix) that starts with a "/" character. + +"apiName" shall define the name of the API. For example, 'nsmf-pdusession'. + +"apiVersion" shall indicate the MAJOR version of the API. The format is specified in clause 4.3.1.3. For example, 'v1'. + +While "apiRoot", "apiName" and "apiVersion" together define the API URI of the corresponding API, each "apiSpecificResourceUriPart" defines a resource URI of the API relative to the API URI. + +An API URI should not contain a trailing slash as defined in clause 3.1, and if it contains one, then it should be ignored/removed. + +Example of an API URI from 3GPP TS 29.502 [20]: + +- url: '{apiRoot}/nsmf-pdusession/v1' + +### 4.4.2 Custom operations URI structure + +The custom operation definition is in Annex C. + +The URI of a custom operation which is associated with a resource shall have the following structure: + +**{apiRoot}** + +Custom operations can also be associated with the service instead of a resource. The URI of a custom operation which is not associated with a resource shall have the following structure: + +**{apiRoot}** + +In the above URI structures, "apiRoot", "apiName", "apiVersion" and "apiSpecificResourceUriPart" are as defined in clause 4.4.1 and "custOpName" represents the name of the custom operation as defined in clause 5.1.3.2. + +### 4.4.3 Callback URI structure + +The purpose of the callback URI is to enable NF service consumer to provide the URI to be used by an NF Service Producer to send notification or callback requests. + +The callback URI shall be in the form of an absolute URI as defined in clause 4.3 of IETF RFC 3986 [9], including an authority, and excluding any query component, any fragment component and any userinfo subcomponent. + +Therefore, callback URI consists of the following components, specified with ABNF syntax (see IETF RFC 5234 [26]): + +URI = scheme ":" "/" host [ ":" port ] [ prefix ] "/" + +Where: + +- scheme is either "http" or "https"; + +NOTE: In this release of the specification both http and https scheme URIs are allowed. See clause 13.1 of 3GPP TS 33.501[22] for further details on security of Service Based Interfaces. + +- 'host' is either an FQDN or an IP address; + - the URI may contain an optional port; + - the URI may contain an optional deployment-specific string (prefix) that starts with a "/" character; + - the "callbackUriPart" is the part of the callback URI, after the prefix (if any), of the path to an HTTP resource on the consumer, which is implementation specific; and + - the path of the callback URI comprises the prefix (if any) and the "callbackUriPart". +- 4.5 Resource Representation and Content Format Negotiation + +### 4.5.1 Resource Representation + +A resource representation is a serialization of the resource state in a particular content format. It's included in the data frame of an HTTP/2 request or response. Representation header fields provide metadata about the representation. When a message includes a data frame, the representation data enclosed in the data frame. HTTP/2 reuses the definition of Representation header as HTTP 1.1 in IETF RFC 7231 [6]. Content-type field in HTTP/2 header performs as + +representation header fields and describes the representation data that would have been enclosed in the data frame, e.g. if content-type is application/json, resource representation in data frame is serialized in JSON format. + +Server supports the content format of the representation received in the data frame of the request and returns the "200 OK" response code. + +### 4.5.2 Content Format Negotiation + +IETF RFC 7231 [6] provides a mechanism to negotiate the content format of a representation. + +In HTTP/2 requests and responses, the "Content-Type" HTTP/2 header field is used to signal the format of the actual representation included in the data frame. If the format of the representation in an HTTP/2 request is not supported by the server, it responds with the "415 Unsupported Media Type" response code. + +For GET method, the "Accept" HTTP header of the HTTP/2 request signals the content formats that a client supports. If the server cannot provide any of the accepted formats, it returns the "406 Not Acceptable" response code. + +## 4.6 Use of HTTP Methods + +### 4.6.1 Use of Request/Response Communication + +#### 4.6.1.1 CRUD + +##### 4.6.1.1.1 Creating a Resource + +###### 4.6.1.1.1.1 General + +Procedures that allow an NF service consumer to create a new resource at the NF service producer shall be specified to either use the HTTP POST method with procedures according to clause 4.6.1.1.1.2 or the HTTP PUT method with procedures according to clause 4.6.1.1.1.3. + +###### 4.6.1.1.1.2 Creating a Resource using POST + +The HTTP POST method (see IETF RFC 7231 [6]) allows an NF service consumer to create a new child resource at the NF service producer in such a manner that the NF service producer selects the child resource identifier and the URI for the child resource. + +Figure 4.6.1.1.1.2-1 illustrates creating a resource using POST. + +![Sequence diagram illustrating the interaction between an NF service consumer and an NF service producer for creating a resource using POST.](bed6d614aeb513fab7c7299bff6c0523_img.jpg) + +``` +sequenceDiagram + participant Consumer as NF service consumer + participant Producer as NF service producer + Note left of Consumer: + Consumer->>Producer: 1. POST ../parent-resource (ResourceRepresentation) + Note right of Producer: + Producer-->>Consumer: 2. 201 Created (ResourceRepresentation) + Note left of Consumer: +``` + +The diagram shows a sequence of two messages between an NF service consumer and an NF service producer. The consumer sends a POST request to the producer, and the producer responds with a 201 Created status. The messages are labeled with their respective HTTP methods and status codes, along with the resource representation. + +Sequence diagram illustrating the interaction between an NF service consumer and an NF service producer for creating a resource using POST. + +**Figure 4.6.1.1.1.2-1: Creating a resource using POST** + +1. The parent resource of which the new resource is to be created as a child is identified by the request URI. The payload body of the POST request shall contain a representation of the resource to be created without a child resource identifier. For forward compatibility, the NF service producer ignores unknown attributes in the received resource representation unless specified otherwise by the particular application. + +2. The NF service producer generates a child resource identifier and constructs the URI for the created resource by appending that child resource identifier to the parent resource URI received as request URI of the POST request (e.g. ".../parent-resource/childresource1"). + +On success, "201 Created" shall be returned, the payload body of the POST response should contain a representation of the created resource, and the "Location" header shall be present and shall contain the URI of the created resource. The created resource shall be served by the same NF (service) instance that received the service request, unless the 5GC SBI API specifications explicitly specified that in specific use cases the created resource may be served by another NF (service) instance. If in such specific use cases the resource is created in a different NF (service) instance, the identifier of the serving NF (service) instance shall be included in the response message. + +If the HTTP scheme used in the returned URI is "https", then the authority of the URI included in the Location header shall be an FQDN, and not an IP address. + +The URI included in the "Location" header may be an absolute URI or a relative URI reference (see IETF RFC 3986 [9]); when the URI is in relative form, the base URI used to resolve the URI reference is the target URI included in the received POST request. + +NOTE: The representations of the resource in the request and response can differ, e.g. the representation of the resource in the response can be empty or can contain a subset of the representation as received in the request possibly with modified attributes, and in addition can contain additional attributes. Exact details will be specified by the application. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body (see clause 4.8). + +A collection may be used to model a resource that serves as a directory of resources that may be distributed on different processing instances or hosts. If so: + +- the authority and/or deployment-specific string of the apiRoot of the created resource URI returned by the NF Service Producer in the "Location" header may differ from the authority and/or deployment-specific string of the apiRoot of the request URI received in the POST request. +- the NF Service Consumer shall be capable to receive and process an authority and/or deployment-specific string in the apiRoot of the created resource URI that differs from the authority and/or deployment-specific string of the apiRoot of the Request URI. + +It needs to be clearly stated in the 5GC SBI API specifications when a NF Service Producer may return a different authority and/or deployment-specific string in the apiRoot of the created resource URI for a collection resource. + +###### 4.6.1.1.1.3 Creating a Resource using PUT + +The HTTP PUT method (see IETF RFC 7231 [6]) allows an NF service consumer to create a new resource at the NF service producer in such a manner that the NF service consumer selects the resource identifier and the URI for the resource. + +Figure 4.6.1.1.1.3-1 illustrates creating a resource using HTTP PUT. + +![Sequence diagram illustrating the interaction between an NF service consumer and an NF service producer for creating a resource using HTTP PUT. The consumer sends a PUT request to the producer, and the producer responds with a 201 Created status and a resource representation.](37819f1170c36655c57129b6bd8a5ceb_img.jpg) + +``` +sequenceDiagram + participant Consumer as NF service consumer + participant Producer as NF service producer + Note left of Consumer: + Consumer->>Producer: 1. PUT .../resource (ResourceRepresentation) + Note right of Producer: + Producer-->>Consumer: 2. 201 Created (ResourceRepresentation) + Note left of Consumer: +``` + +Sequence diagram illustrating the interaction between an NF service consumer and an NF service producer for creating a resource using HTTP PUT. The consumer sends a PUT request to the producer, and the producer responds with a 201 Created status and a resource representation. + +Figure 4.6.1.1.1.3-1: Creating a Resource using HTTP PUT + +1. The NF service consumer selects a resource identifier and constructs the URI for the resource to be created by appending that resource identifier to the parent resource URI. The resource that is to be created is identified by that URI as request URI. The payload body of the PUT request shall contain a representation of the resource to be created. For forward compatibility, the NF service producer ignores unknown attributes in the received resource representation unless specified otherwise by the particular application. +2. On success, "201 Created" shall be returned, the payload body of the PUT response should contain the representation of the created resource, and the "Location" header shall be present and shall contain the URI of the created resource. The created resource shall be served by the same NF (service) instance that received the service request, unless the 5GC SBI API specifications explicitly specified that in specific use cases the created resource may be served by another NF (service) instance. If in such specific use cases the resource is created in a different NF (service) instance, the identifier of the serving NF (service) instance shall be included in the response message. + +If the HTTP scheme used in the returned URI is "https", then the authority of the URI included in the Location header shall be an FQDN, and not an IP address. + +NOTE: The representations of the resource in the request and response can differ, e.g. the representation of the resource in the response can be empty or can contain a subset of the representation as received in the request possibly with modified attributes, and in addition can contain additional attributes. Exact details will be specified by the application. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body (see clause 4.8). + +If the resource that is to be created already exists at the NF service producer, the following applies: + +- 1) If the update of that resource by PUT is supported, the existing representation of the resource is replaced with the representation received in the PUT request body; see clause 4.6.1.1.3.1. +- 2) If the update of that resource by PUT is not supported, the "403 Forbidden" HTTP status code shall be returned and appropriate additional error information should be returned in the PUT response body (see clause 4.8). + +##### 4.6.1.1.2 Reading a Resource + +###### 4.6.1.1.2.1 Reading a Single Resource + +Procedures that allow a service consumer NF (client) to read information from the server shall be specified to use the HTTP GET method (see IETF RFC 7231 [6]) to obtain the current representation of a resource. + +Figure 4.6.1.1.2.1-1 illustrates reading a resource. + +![Sequence diagram illustrating the interaction for reading a resource. An NF service consumer sends a GET request to an NF service producer, and the producer responds with a 200 OK status and the resource representation.](c0e369274e53b2e5364666be6f786c7a_img.jpg) + +``` +sequenceDiagram + participant Consumer as NF service consumer + participant Producer as NF service producer + Note left of Consumer: + Consumer->>Producer: 1. GET .../resource?query-parameter=value () + Note right of Producer: + Producer-->>Consumer: 2. 200 OK (ResourceRepresentation) + Note left of Consumer: +``` + +Sequence diagram illustrating the interaction for reading a resource. An NF service consumer sends a GET request to an NF service producer, and the producer responds with a 200 OK status and the resource representation. + +Figure 4.6.1.1.2.1-1: Reading a resource + +1. The resource of which a representation is to be obtained is identified by the request URI. Query parameters may be used to control the content of the result. + +The payload body of the GET request shall be empty. + +2. On success, "200 OK" shall be returned and the payload body of the GET response shall contain the obtained resource representation. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body (see clause 4.8). + +###### 4.6.1.1.2.2 Querying a Set of Resources + +Procedures that allow a service consumer NF (client) to querying a set of resources from the server shall be specified to use HTTP GET method towards a resource modelled as Collection or Store archetype. + +Query parameters (see clause 4.6.1.1.5) may be provided when querying a set of resources. The query component contains non-hierarchical data that, along with data in the path component, to filter the resources identified within the scope of the URI's scheme to a subset of the resources matching the query parameters. The query component is indicated by the first question mark ("?") character and terminated by a number sign ("#") character or by the end of the URI. + +![Sequence diagram showing a client sending a GET request to a server and receiving a 200 OK or 404 Not Found response.](90ddf538ef276510e2b631f7b96654e6_img.jpg) + +``` +sequenceDiagram + participant client + participant server + Note left of client: client + Note right of server: server + client->>server: 1. GET .../resource?query-parameters + server-->>client: 2. 200 OK (ResourceRepresentation) + Note right of server: or + Note right of server: 404 Not Found +``` + +The diagram illustrates a sequence of interactions between a client and a server. The client sends a GET request to a resource with query parameters. The server responds with either a 200 OK status containing a resource representation, or a 404 Not Found status. + +Sequence diagram showing a client sending a GET request to a server and receiving a 200 OK or 404 Not Found response. + +**Figure 4.6.1.1.2.2-1: Query of a collection of resources by using query parameters.** + +Step 1. The client shall send a HTTP GET request using the URI of a resource modelled as Collection or Store archetype, optionally with query parameters, to the server. + +Step 2. On success, the server shall return a set of sub-resources that includes only those entries filtered by the query parameters. If no sub-resource is matched for the querying service operation, the server shall return "200 OK" with an empty array (e.g. "[ ]" in JSON) in response body. If the resource in the URI doesn't exist on the server, the server shall return "404 Not Found" with optionally the cause information in response body. + +NOTE: The result array/empty array can be defined as an attribute of an object, if the service operation returns an object in the response payload for extensibility consideration. + +Clause 4.9 specifies some possible options for an NF Service Producer to return the representations of multiple resources to a NF Service Consumer. + +##### 4.6.1.1.3 Updating a Resource + +###### 4.6.1.1.3.1 Usage of HTTP PUT + +Procedures that allow a service consumer NF (client) to update information stored at the server by means of a complete replacement shall be specified to use the HTTP PUT method to replace the current representation of a resource with a new representation. + +Figure 4.6.1.1.3.1-1 illustrates updating a resource using HTTP PUT. + +![Sequence diagram showing the interaction between an NF service consumer and an NF service producer for updating a resource using HTTP PUT. The consumer sends a PUT request to a resource, and the producer responds with either a 204 No Content or a 200 OK status code.](eb03559a4d92ea9ebd63ea9be663c50a_img.jpg) + +``` +sequenceDiagram + participant Consumer as NF service consumer + participant Producer as NF service producer + Note left of Consumer: + Consumer->>Producer: 1. PUT .../resource (ResourceRepresentation) + Note right of Producer: + Producer-->>Consumer: 2. 204 No Content () +or 200 OK +``` + +Sequence diagram showing the interaction between an NF service consumer and an NF service producer for updating a resource using HTTP PUT. The consumer sends a PUT request to a resource, and the producer responds with either a 204 No Content or a 200 OK status code. + +**Figure 4.6.1.1.3.1-1: Updating a Resource using HTTP PUT** + +1. The resource that is to be updated is identified by the request URI. The payload body of the PUT request shall contain the new representation of the resource. For forward compatibility, the NF service producer ignores unknown attributes in the received resource representation unless specified otherwise by the particular application. +2. On success, "204 No Content" or "200 OK" shall be returned. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body (see clause 4.8). + +If the resource that is to be updated does not exist at the NF service producer, the following applies: + +1. If the creation of that resource by PUT is supported, the resource is created according to the procedure in clause 4.6.1.1.1.3. +2. If the creation of that resource by PUT is not supported, the "403 Forbidden" HTTP status code shall be returned and appropriate additional error information should be returned in the PUT response body (see clause 4.8). + +###### 4.6.1.1.3.2 Usage of HTTP PATCH + +Procedures that allow a service consumer NF (client) to update information stored at the server by means of a partial replacement shall be specified to use the HTTP PATCH method (see IETF RFC 5789 [10]) to modify the current representation of a resource according to given modification instructions. The format of the PATCH message body shall be specified for each resource where the PATCH method is supported using one or several of the following encodings: + +- If no modification of individual elements within an array needs to be supported, the "JSON Merge Patch" encoding of changes defined in IETF RFC 7396 [7] should be used. +- If a modification of individual elements within an array needs to be supported, the "JSON Patch" encoding of changes defined in IETF RFC 6902 [8] shall be used. + +A single of the above encodings shall be specified for each resource where the PATCH method is supported unless backward compatibility considerations necessitate the support of both encodings. + +NOTE 1: In Rel-15 a single encoding will be selected for each resource as backward compatibility considerations do not yet apply. + +NOTE 2: "JSON Merge Patch" does not support the modification of individual elements within an array. However, it supports the modification of individual elements within maps (see clause 5.2.4.2). Collections of elements can be modelled as maps, instead of arrays, if a partial modification using PATCH is desired. + +NOTE 3: The Open API description of the body of HTTP PATCH requests is specified in clause 5.3.8. + +Figure 4.6.1.1.3.2-1 illustrates updating a resource using HTTP PATCH. + +![Sequence diagram showing the interaction between an NF service consumer and an NF service producer for updating a resource using HTTP PATCH. The consumer sends a PATCH request to a resource with modification instructions. The producer responds with either a 204 No Content or a 200 OK status.](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +``` +sequenceDiagram + participant Consumer as NF service consumer + participant Producer as NF service producer + Note left of Consumer: 1. PATCH .../resource (ModificationInstructions) + Consumer->>Producer: Request + Note right of Producer: 2. 204 No Content () or 200 OK + Producer-->>Consumer: Response +``` + +Sequence diagram showing the interaction between an NF service consumer and an NF service producer for updating a resource using HTTP PATCH. The consumer sends a PATCH request to a resource with modification instructions. The producer responds with either a 204 No Content or a 200 OK status. + +**Figure 4.6.1.1.3.2-1: Updating a Resource using HTTP PATCH** + +1. The resource that is to be updated is identified by the request URI. The payload body of the PATCH request shall contain a description of the requested modifications of the resource. For the "JSON Merge Patch" encoding defined in IETF RFC 7396 [7] and the "Content-Type" header shall be set to "application/merge-patch+json". For the "JSON Patch" encoding of changes defined in IETF RFC 6902 [8] the "Content-Type" header shall be set to "application/json-patch+json". For forward compatibility, the NF service producer shall ignore received modification instructions of unknown attributes in the resource unless specified otherwise by the particular application. +2. On success, "204 No Content" or "200 OK" shall be returned. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body (see clause 4.8). + +##### 4.6.1.1.4 Deleting a Resource + +Procedures that allow a service consumer NF (client) to delete a resource from the server shall be specified to use the HTTP DELETE method (see IETF RFC 7231 [6]). + +Figure 4.6.1.1.4-1 illustrates deleting a resource. + +![Sequence diagram showing the interaction between an NF service consumer and an NF service producer for deleting a resource using HTTP DELETE. The consumer sends a DELETE request to a resource. The producer responds with a 204 No Content status.](d3b5eac55166fc428a223bba5c46961b_img.jpg) + +``` +sequenceDiagram + participant Consumer as NF service consumer + participant Producer as NF service producer + Note left of Consumer: 1. DELETE .../resource () + Consumer->>Producer: Request + Note right of Producer: 2. 204 No Content () + Producer-->>Consumer: Response +``` + +Sequence diagram showing the interaction between an NF service consumer and an NF service producer for deleting a resource using HTTP DELETE. The consumer sends a DELETE request to a resource. The producer responds with a 204 No Content status. + +**Figure 4.6.1.1.4-1: Deleting a resource** + +The resource that is to be deleted is identified by the request URI. + +The payload body of the DELETE request shall be empty. + +On success, "204 No Content" should be returned and then the payload body of the DELETE response shall be empty. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body (see clause 4.8). + +##### 4.6.1.1.5 Query Parameters + +###### 4.6.1.1.5.1 General + +The query component in the URI contains non-hierarchical data that, along with data in the path component, to filter the resources identified within the scope of the URI's scheme to a subset of the resources matching the query parameters. + +The query component is indicated by the first question mark ("?") character and terminated by a number sign ("#") character or by the end of the URI. The syntax of the query component is specified in IETF RFC 3986 [9]. + +When a server receives a request with a query component, it shall parse the query string in order to identify filters. The first question mark is used to be a separator and is not part of the query string. A query string is composed of a series of "key=value" pairs, separated by "&". If one query parameter contains more than one value, i.e. an array of data elements, different values shall be separated by comma (","). + +The behaviour of the server, when receiving an HTTP/2 method with a query parameter which is of type array and only some of the members in the array can be matched, depends on each API and the behaviour shall be clearly described. + +If multiple query parameters are defined for a method on the resource, the logical 'AND' represents the default logical relationship between the query parameters for this resource. If a logical relationship between multiple query parameters is specified in an API, then this overrides the default relationship. If multiple query parameters are defined for a method on the resource in an API, but there is no need to specify any logical relationship between these query parameters, the API shall explicitly state this. + +###### 4.6.1.1.5.2 Complex query expression + +The complex query expression is used when there are multiple query parameters in the URI and the query condition needs to be expressed by a logical combination of multiple query parameters which overrides the default logical relationship of the query parameters. The complex query expression is either a Conjunctive Normal Form (CNF) or a Disjunctive Normal Form (DNF) which is equivalent to the logical combination of query parameters reflecting the query condition. + +The "complex-query" query parameter may be used when a complex query expression is needed to express a query condition. The value of the "complex-query" query parameter is of type "ComplexQuery" which is a JSON object, the corresponding CNF or DNF is encoded into that JSON object (see 3GPP TS 29.571 [5] for the details of the data type "ComplexQuery"). The use of "complex-query" shall be negotiated using the feature negotiation procedure as defined in 3GPP TS 29.500 [2]. + +If a query parameter is included in the "complexQuery" then the same query parameter shall not be included outside the "complexQuery" in the same request message. + +NOTE 1: It is not assumed that all APIs support "complex-query", the API supports this feature only when it is described in the corresponding specification. + +NOTE 2: The logical relationship between "complex-query" and the other query parameters defined for a particular API is described in the corresponding specification of that API. + +NOTE 3: The "complex-query" is not an additional explanation of the other query parameters, the condition expressed in the "complex-query" is evaluated along with the other queries. + +#### 4.6.1.2 Custom Operations + +Custom Operations provide procedures that allow a service consumer NF (client) to interact with an NF service producer in other ways than what is supported by the CRUD methods described in clause 4.6.1.1. + +Custom Operation can be related to a resource or can be related to an entire service and be independent of a resource. + +Figure 4.6.1.2-1 illustrates the use of a custom operation related to a resource. + +![Sequence diagram for Figure 4.6.1.2-1: Custom Operation on a Resource using HTTP POST. It shows an NF service consumer sending a POST request to an NF service producer and receiving a 200 OK or 204 No Content response.](90ddb84c323b956e2d50a54d3f870566_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NF service producer + Note left of NF service consumer: 1. POST .../resource/custom-operation-name (Custom Operation Parameters) + NF service consumer->>NF service producer: Request + Note right of NF service producer: 2. 200 OK (Data related to Custom Operation) or 204 No Content() + NF service producer-->>NF service consumer: Response +``` + +Sequence diagram for Figure 4.6.1.2-1: Custom Operation on a Resource using HTTP POST. It shows an NF service consumer sending a POST request to an NF service producer and receiving a 200 OK or 204 No Content response. + +**Figure 4.6.1.2-1: Custom Operation on a Resource using HTTP POST** + +1. The request URI identifies the custom operation to be executed and the resource the custom operation relates to and is constructed by adding a verb as name for the custom operation at the end of the resource URI (see clauses 4.4.2 and 5.1.3.2). Parameters for the custom operation are included in the request body. +2. On success, "204 No Content" or "200 OK" shall be returned. "200 OK" shall contain a body with data related to the custom operation. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body (see clause 4.8). + +Figure 4.6.1.2-2 illustrates the use of a custom operation related to a service. + +![Sequence diagram for Figure 4.6.1.2-2: Custom Operation related to Service using HTTP POST. It shows an NF service consumer sending a POST request to an NF service producer and receiving a 200 OK or 204 No Content response.](9b686adccf125267a013fa25721231a3_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NF service producer + Note left of NF service consumer: 1. POST .../custom-operation-name (Custom Operation Parameters) + NF service consumer->>NF service producer: Request + Note right of NF service producer: 2. 200 OK (Data related to Custom Operation) or 204 No Content() + NF service producer-->>NF service consumer: Response +``` + +Sequence diagram for Figure 4.6.1.2-2: Custom Operation related to Service using HTTP POST. It shows an NF service consumer sending a POST request to an NF service producer and receiving a 200 OK or 204 No Content response. + +**Figure 4.6.1.2-2: Custom Operation related to Service using HTTP POST** + +1. The request URI identifies the custom operation to be executed and is constructed by adding a verb as name for the custom operation at the end of the service URI (see clauses 4.4.2 and 5.1.3.2). Parameters for the custom operation are included in the request body. +2. On success, "204 No Content" or "200 OK" shall be returned. "200 OK" shall contain a body with data related to the custom operation. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body (see clause 4.8). + +#### 4.6.1.3 Use of Asynchronous Operations + +Certain service operations may be designed to allow the invocation of a request so that the response can be received asynchronously: if the NF service consumer when sending a request cannot expect to receive an immediate final response, the service consumer may provide a callback reference for final result notification. The service provider, + +when receiving a request that contains a callback reference for final result notification, may then return an immediate "202 Accepted", and notify the service consumer about the final result using the received callback reference at a later point in time. + +#### 4.6.1.4 Special provisions to support the seamless change of AMF as NF service producer + +Services provided by the AMF can be transferred seamlessly to a new AMF when the corresponding UE context is transferred to that AMF. + +To support a seamless change of the AMF as NF service producer, the procedures in clause 4.6.1 are applied with the following special provisions: + +1. When becoming aware that a new AMF is serving the resource, the NF service consumer shall exchange the authority part of resource URIs with the address of a new NF service producer and shall use that URI in subsequent communication. + +NOTE: An NF service consumer can become aware of an AMF change via Namf\_Communication service AMFStatusChange Notifications, via Error response from old AMF, via link level failures (e.g. no response from the AMF), or via a notification from the NRF that the AMF has deregistered and can then determine the new AMF either via information received within those services or by selecting an AMF from an earlier received AMF set or the backup AMF. + +2. Each AMF within a set of AMFs supporting seamless changes shall be prepared to receive updates for resource URIs constructed according to bullet 1 with the own IP address as authority part from the NF service consumer, by either handling the updates, or by replying with an HTTP "307 temporary redirect" error response pointing to new NF service producer, or by replying with another HTTP error such as an "404 Not found". +3. For a service that includes notifications from the AMF, the NF service consumer shall be prepared to receive notifications for the that service from any NF service producer within a set of NF service producers supporting seamless changes. + +### 4.6.2 Use of Subscribe/Notify Communication + +#### 4.6.2.1 General + +Subscribe/Notify communication between 5GC NFs can be used to keep involved NFs (consumers of a service) informed of data changes or events that occur at another NF (producer of the service). A notification is a message that contains information about the event. + +Service consumer NFs (clients) need to subscribe to notifications at the service provider NF (server). This either happens explicitly by means of creating a new subscription resource (see clause 4.6.2.2), or implicitly by updating a relevant resource. + +Service consumer NFs can in principle explicitly or implicitly subscribe to be notified about data change to any type of resource of any resource archetype (Document, Store or Collection). It is up to the API to define the resources that support subscriptions. + +When the change/event occurs at the service producer NF, notifications (see clause 4.6.2.3) are sent from the service producer NF to the service consumer NFs. This communication initiated by the service producer to the service consumers requires that the service consumer NF (client) takes the role of an HTTP server and the service producer NF (server) takes the role of an HTTP client. + +During the explicit subscription the service consumer NF (client) provides a callback URI and possibly additional filter criteria to the service producer NF (server). When the data-change/event occurs that matches the filter criteria in the subscription, the service producer NF (taking the role of an HTTP client) uses the provided callback URI to notify the service consumer NF (taking the role of an HTTP server) about the change. + +#### 4.6.2.2 Management of Subscriptions + +##### 4.6.2.2.1 General + +The HTTP method to create a subscription shall be POST. The HTTP method to modify a subscription shall be PUT or PATCH. The HTTP method to delete a subscription (i.e. to unsubscribe) shall be DELETE (see IETF RFC 7231 [6]). + +Subscriptions may be implicit, i.e. exist without being explicitly created by a dedicated subscribe operation. + +Two types of implicit subscriptions exist: + +1. The subscription is implied by an explicit operation different from the subscribe operation, which does not use the GET method. The subscription implied by the explicit operation and the corresponding notification shall be part of the same service. +2. The subscription exists without any explicit operation. + +As an example for the first type, at the UDM the registered AMF (as long as it is registered) is implicitly subscribed to notification about de-registration and (possibly) P-CSCF restoration as side effect of the registration. + +As another example for the first type, at the SMF, the AMF that created a SM Context for a PDU session is implicitly subscribed for SM Context Status notification. At AMF change the new AMF updates the SMF with its callback URI for receiving subsequent SM Context Status notification. + +As an example for the second type, at the UDR any available UDM is implicitly subscribed to notification about changes of provisioned subscriber data. When provisioned subscriber data are modified at the UDR by means of provisioning, the UDR selects one of the available UDMs (i.e. one of the implicitly subscribed UDMs) and notifies it about the subscriber data change. + +In the OpenAPI specification file, notifications for the second type of implicit subscriptions shall be specified as part of an explicit subscription. + +##### 4.6.2.2.2 Creation of a Subscription + +Figure 4.6.2.2.2-1 illustrates explicit creation of a subscription. + +![Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to an NF service producer, and the producer responds with a 201 Created status.](d5918cee231b536f20789a18d861fae3_img.jpg) + +``` +sequenceDiagram + participant Consumer as NF service consumer + participant Producer as NF service producer + Note left of Consumer: + Consumer->>Producer: 1. POST .../xyz-subscriptions (XyzSubscription) + Note right of Producer: + Producer-->>Consumer: 2. 201 Created (XyzSubscription) + Note left of Consumer: +``` + +Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to an NF service producer, and the producer responds with a 201 Created status. + +**Figure 4.6.2.2.2-1: Creation of a subscription** + +The parent resource (collection of subscriptions) is identified by the request URI. + +The data structure in the payload body of the POST request shall contain a callback URI, and may contain additional criteria to filter the set of events that trigger a notification. The request may contain an expiry time, suggested by the NF Service Consumer as a hint, representing the time up to which the subscription is desired to be kept active and the time after which the subscribed event shall stop generating notifications. + +On success, "201 Created" shall be returned, the payload body of the POST response shall contain a representation of the created subscription, and the "Location" header shall contain the URI of the created resource. The created resource shall be served by the same NF (service) instance that received the service request, unless the 5GC SBI API specifications explicitly specified that in specific use cases the created resource may be served by another NF (service) instance. If in such specific use cases the resource is created in a different NF (service) instance, the identifier of the serving NF (service) instance shall be included in the response message. + +If the HTTP scheme used in the returned URI is "https", then the authority of the URI included in the Location header shall be an FQDN, and not an IP address. + +The response based on operator policies and taking into account the expiry time included in the request, may contain an expiry time (i.e. a future timestamp), as determined by the NF Service Producer, after which the subscription becomes invalid. If an expiry time was included in the request, then the expiry time returned in the response should be less than or equal to that value. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the NF Service Producer. The NF Service Producer shall not provide the same expiry time (i.e. a future timestamp) for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. If the expiry time is not included in the response, the NF Service Consumer shall consider the subscription to be valid without an expiry time. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body (see clause 4.9). + +##### 4.6.2.2.3 Modify a subscription + +###### 4.6.2.2.3.1 Modification of a Subscription Using HTTP PUT + +Procedures that allow a NF service consumer to update the subscription at the server by means of a complete replacement shall use the HTTP PUT method to replace the current subscription with a new representation. + +Figure 4.6.2.2.3.1-1 illustrates modification a subscription using HTTP PUT. + +![Sequence diagram showing the modification of a subscription using HTTP PUT. The NF service consumer sends a PUT request to the NF service producer, and the producer responds with either a 204 No Content or a 200 OK status.](84e5b251aa38db522f76f5cc3afcb853_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NF service producer + Note left of NF service consumer: + NF service consumer->>NF service producer: 1. PUT ...{subscriptionId} (XyzSubscription) + Note right of NF service producer: + NF service producer-->>NF service consumer: 2. 204 No Content () +or 200 OK(XyzSubscription) +``` + +Sequence diagram showing the modification of a subscription using HTTP PUT. The NF service consumer sends a PUT request to the NF service producer, and the producer responds with either a 204 No Content or a 200 OK status. + +**Figure 4.6.2.2.3.1-1: Modification a subscription using HTTP PUT** + +1. The NF Service Consumer shall send a PUT request to the resource URI representing the individual subscription. The payload body of the PUT request shall contain the subscription information to be replaced including the criteria to filter the set of events that trigger a notification. The request may contain an updated expiry time, suggested by the NF Service Consumer as a hint, to extend the subscription lifetime, representing the time upto which the subscription is desired to be kept active and the time after which the subscribed event shall stop generating notifications. If the request does not contain an expiry time, the NF Service Producer shall consider that the NF Service Consumer requests for an extension of the existing subscription lifetime without indicating any specific expiration time; still, the NF Service Producer shall be authoritative to set the expiry time in the subscription response according to its own policies. +2. On success, "204 No Content" without any response body or "200 OK" with a response body providing current resource representation shall be returned. + +When "200 OK" is returned, the response based on operator policies and taking into account the expiry time included in the request, may contain an expiry time (i.e. a future timestamp), as determined by the NF Service Producer, after which the subscription becomes invalid. If an expiry time was included in the request, then the expiry time returned in the response should be less than or equal to that value. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the NF Service Producer, as specified in clause 4.6.2.2.2. The NF Service Producer shall not provide the same expiry time (i.e. a future timestamp) for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. If the expiry time is not included in the response, the NF Service Consumer shall consider the subscription to be valid without an expiry time. + +When "204 No Content" is returned, it shall be interpreted that the NF Service Producer accepted entirely the resource representation provided by the NF Service Consumer in the request; e.g., if the request contained a + +proposed expiry time, a 204 response shall be interpreted as if such timestamp is accepted by the NF Service Producer as the expiration time for the subscription and, similarly, if the request did not contain a proposed expiry time, a 204 response shall be interpreted as if no expiration time is set by the NF Service Producer for the subscription. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body (see clause 4.8). + +If the NF Service Consumer is not allowed to update the subscription information, the "403 Forbidden" HTTP status code shall be returned and appropriate additional error information should be returned in the PUT response body (see clause 4.8). + +If the resource that is to be updated does not exist at the NF service producer, the "404 Not Found" HTTP status code shall be returned. + +###### 4.6.2.2.3.2 Modification of a Subscription Using HTTP PATCH + +Procedures that allow a NF service consumer to update subscription at the server by means of a partial replacement shall use the HTTP PATCH method (see IETF RFC 5789 [10]) to modify the current subscription according to given modification instructions. + +Figure 4.6.2.2.3.2-1 illustrates updating a resource using HTTP PATCH. + +![Sequence diagram illustrating the modification of a subscription using HTTP PATCH. The diagram shows two participants: NF service consumer and NF service producer. The consumer sends a PATCH request to the producer. The producer responds with either a 204 No Content or a 200 OK with a response body.](17a1ba23b641c01871b08f0a4f08ef48_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NF service producer + Note left of NF service consumer: + Note right of NF service producer: + NF service consumer->>NF service producer: 1. PATCH .../{subscriptionId}(ModificationXyzSubscription) + NF service producer-->>NF service consumer: 2. 204 No Content () +or 200 OK(ModifiedXyzSubscription) +``` + +Sequence diagram illustrating the modification of a subscription using HTTP PATCH. The diagram shows two participants: NF service consumer and NF service producer. The consumer sends a PATCH request to the producer. The producer responds with either a 204 No Content or a 200 OK with a response body. + +**Figure 4.6.2.2.3.2-1: Modification a subscription using HTTP PATCH** + +1. The NF Service Consumer shall send a PATCH request to the resource URI representing the individual subscription. The payload body of the PATCH request shall contain the modification instructions. The request may contain an expiry time (i.e. a future timestamp), requested by the NF Service Consumer, representing the time upto which the subscription is desired to be kept active and the time after which the subscribed event shall stop generating notifications. +2. On success, "204 No Content" without any response body or "200 OK" with a response body containing the modified subscription information shall be returned. When "204 No Content" is returned and if the request included an expiry time, then the requested expiry time shall be accepted by the NF Service Producer. When "200 OK" is returned and if the request included an expiry time then the response based on operator policies and taking into account the expiry time included in the request, shall contain an expiry time (i.e. a future timestamp), as determined by the NF Service Producer, after which the subscription becomes invalid. If an expiry time was included in the request, then the expiry time returned in the response should be less than or equal to that value. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the NF Service Producer, as specified in clause 4.6.2.2.2. The NF Service Producer shall not provide the same expiry time (i.e. a future timestamp) for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body (see clause 4.8). + +##### 4.6.2.2.4 Delete a subscription + +Figure 4.6.2.2.4-1 illustrates explicit deletion of a subscription. + +![Sequence diagram for Figure 4.6.2.2.4-1: Deletion of a subscription. It shows an NF service consumer sending a DELETE request to an NF service producer, which responds with a 204 No Content.](00504fc688ebcf131ccbeff94dfc9939_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NF service producer + Note left of NF service consumer: 1. DELETE ...{subscriptionId} () + NF service consumer->>NF service producer: 1. DELETE ...{subscriptionId} () + Note right of NF service producer: 2. 204 No Content () + NF service producer-->>NF service consumer: 2. 204 No Content () + +``` + +Sequence diagram for Figure 4.6.2.2.4-1: Deletion of a subscription. It shows an NF service consumer sending a DELETE request to an NF service producer, which responds with a 204 No Content. + +**Figure 4.6.2.2.4-1: Deletion of a subscription** + +1. The NF Service Consumer shall send a DELETE request to the resource URI representing the individual subscription. The request body shall be empty. +2. On success, "204 No Content" shall be returned. The response body shall be empty. + +On failure, the appropriate HTTP status code indicating the error shall be returned in the DELETE response body (see clause 4.8). + +#### 4.6.2.3 Notifications + +The HTTP method for the notification that corresponds to an explicit subscription shall be POST (see IETF RFC 7231 [6]). + +NOTE: Clause 5.3.7 describes how to encode Notifications in OpenAPI specification files. + +Figure 4.6.2.3-1 illustrates a notification. + +![Sequence diagram for Figure 4.6.2.3-1: Notification. It shows an NF service consumer (acting as an HTTP server) receiving a POST request from an NF service producer (acting as an HTTP client) and responding with 200 OK or 204 No Content.](ca5dc5fde2061d0ca2051ef7840fc842_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer (taking the role of a HTTP server) + participant NF service producer (taking the role of a HTTP client) + Note left of NF service producer: 1. POST {callback_ref} (Notification) + NF service producer->>NF service consumer: 1. POST {callback_ref} (Notification) + Note right of NF service consumer: 2. 200 OK or 204 No Content + NF service consumer-->>NF service producer: 2. 200 OK or 204 No Content + +``` + +Sequence diagram for Figure 4.6.2.3-1: Notification. It shows an NF service consumer (acting as an HTTP server) receiving a POST request from an NF service producer (acting as an HTTP client) and responding with 200 OK or 204 No Content. + +**Figure 4.6.2.3-1: Notification** + +1. The callback reference provided during creation of the subscription resource, or otherwise known from implicit subscription, is used as the request URI. The callback reference for implicit subscriptions are obtained from the NRF. When an NF / NF service registers with the NRF, the default notification subscriptions along with the callback URI for receiving those notifications may be provided (see clause 6.1.6.2.3 of 3GPP TS 29.510 [18]). + +The payload body of the POST request shall contain the notification payload. + +The payload body of the notification should follow the resource definition of the subscribed resource and can for example be based on the resource definition of the GET operation, but it is up to the API to define the notification resource definition. + +Each API that supports subscription to collection/store archetype resources, should specify in their semantics whether notifications should be sent by changes on the collection/store resource ONLY (i.e. creation/deletion of the main top-level resource itself, and creation/deletion of its children), or if in addition the consumer can expect to get notifications from changes on the resource representation. + +2. On success, "200 OK" shall be returned if any information needs to be included in the payload body of the POST response; otherwise, "204 No Content" shall be returned and the payload body of the POST response shall be empty. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body (see clause 4.8). + +#### 4.6.2.4 Special provisions to support the seamless change of AMF as NF service consumer + +Services consumed by an AMF can be transferred seamlessly to a new AMF when the corresponding UE context is transferred to that AMF. + +To support a seamless change of AMF as NF service consumer, the procedures in clause 4.6.2 are applied with the following special provisions: + +1. When becoming aware that a new AMF is requiring notifications related to a subscription resource, the NF service producer shall exchange the authority part of the corresponding Notification URI with the address of that new NF service consumer and shall use that URI in subsequent communication. + +NOTE: An NF service producer can become aware of an AMF change via Namf Communication service AMFStatusChange Notifications, via Error response from old AMF, via link level failures (e.g. no response from the AMF), or via a notification from the NRF that the AMF has deregistered and can then determine the new AMF either via information received within those services or selecting an AMF from an earlier received AMF set or the backup AMF. + +2. Each AMF within a set of AMFs supporting seamless changes shall be prepared to receive notifications at the Notification URI constructed according to bullet 1 with the own IP address as authority part from the NF service producer, by either handling the notifications, or by replying with an HTTP "307 temporary redirect" error response pointing to new NF service consumer, or by replying with another HTTP error such as an "404 Not found". + +## 4.7 HATEOAS + +### 4.7.1 General + +As defined in [14], HATEOAS stands for Hypermedia As The Engine Of Application State. It means that the hypermedia models application state transitions and describe application protocols. + +As defined in [15] clause 3 RESTful Domain Application Protocols, an application is a software implementation defined to achieve a particular goal. It consists of a set of constrained interactions between NF Service Consumer and Producer performed at run-time that are guided by an application specific set of rules. The application transits across some intermediate states until the application's goal is achieved. The application has then reached its final state. + +An application state is a snapshot of an application instance. + +On each interaction, the NF Service Consumer and Producer exchange representations of resource state. According to [14], "REST concentrates all of the control state into the representations received in response to interactions." and "The model application is therefore an engine that moves from one state to the next by examining and choosing from among the alternative state transitions in the current set of representations." After each interaction the NF Service Consumer is then presented with control state options to interact with additional resources. These control states are in the form of hypermedia markups embedded in the returned resource representation. The application state changes when an NF Service Consumer examines and chooses which control to operate and subsequently interacts with the resources identified in the selected control state. + +HATEOAS support is optional. If HATEOAS is supported, the procedure in the present clause 4.7 shall apply. + +### 4.7.2 3GPP hypermedia format + +#### 4.7.2.1 Basic 3GPP hypermedia format + +NOTE 1: Basic 3GPP hypermedia format is derived from Hypertext Application Language (HAL). HAL is specified in an expired internet draft available at "". + +Basic 3GPP hypermedia format specifies the following optional reserved properties (see 3GPP TS 29.571 [5] for the complete list and definition of objects and object members): + +- "\_links": contains links to other resources and expresses valid state transitions. + +A NF service producer shall construct a basic 3GPP hypermedia document by taking a 3GPP defined JSON object attribute list and then adding a "\_links" attribute. + +**Table 4.7.2.1-1: \_links attribute** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------------|---|-------------|-------------------------------------------------------------------------| +| _links | map(LinksValueSchema) | C | 0..N | _links attribute to be added into the JSON hypermedia object definition | + +The LinksValueSchema data type shall be added to the list of re-used data types of the hypermedia enabled API (see 3GPP TS 29.509 [21] for an example of implementation of a hypermedia API). + +NOTE 2: Depending of the applicable situation, the presence condition and the cardinality can be changed in accordance. LinksValueSchema data type is defined in 3GPP TS 29.571 [5]. + +The "\_links" member names are link relation types (as defined by IETF RFC 8288 [11]) and values are either a "link" object or an array of "link" objects. + +Basic 3GPP hypermedia format specifies the following "link" attribute: + +- "href": contains the URI of the linked resource. + +A NF service producer shall set the Content-Type HTTP header to "application/3gppHal+json" when returning an HTTP payload with a basic 3GPP hypermedia enabled document. + +A NF service consumer supporting HATEOAS shall advertise it by adding an "Accept" HTTP header with "application/3gppHal+json" as media type. + +NOTE 3: The HATEOAS principle relies on NF Service Producer providing control state options (\_links objects) embedded in the returned resource representation to the NF Service Consumer. An NF Service Consumer may decide to use the format of the \_links attribute in HTTP requests to transfer URIs. This is beyond the scope of HATEOAS and another content type than "3gppHal+json" such as "application/json" can be used. + +#### 4.7.2.2 Extended 3GPP hypermedia format + +NOTE 1: Extended 3GPP hypermedia format is derived from HAL-FORMS media type, see "https://rwcbook.github.io/hal-forms/". + +Extended 3GPP hypermedia format specifies the following optional reserved properties (see 3GPP TS 29.571 [5] for the complete list and definition of objects and object members): + +- "\_links": contains links to other resources and expresses valid state transitions; +- "\_templates": contains the HAL templates corresponding to the \_links attribute. + +A NF service producer shall construct a extended 3GPP hypermedia document by taking a 3GPP defined JSON object attribute list and then adding "\_links" attribute and "\_templates" attribute. + +**Table 4.7.2.2-1: \_halForms attribute** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|-----------------------------------------------------------------------------------------------------| +| links | map(Link) | C | 1..N | The key is the name of the link relation type. | +| _templates | map(HalTemplate) | C | 1..N | The key is the name of the corresponding link relation type to which the template is to be applied. | + +The Link data type and HalTemplate data type shall be added to the list of re-used data types of the hypermedia enabled API. + +NOTE 2: Depending of the applicable situation, the presence condition can be changed in accordance. Link and HalTemplate data types are defined in 3GPP TS 29.571 [5]. A NF service producer shall set the Content-Type HTTP header to "application/3gppHalForms+json" when returning an HTTP payload with Extended 3GPP hypermedia enabled document. + +A NF service consumer supporting HATEOAS and extended 3GPP hypermedia shall advertise it by adding an "Accept" HTTP header with "application/3gppHalForms+json" as media type. + +### 4.7.3 Advertising legitimate application state transitions + +When a NF service producer responds to a NF service consumer and there is one or more application state transition possible, the NF service producer shall advertise them by adding a "\_links" property in the returned resource representation. When there are multiple state transitions with different relation types, then one member per relation type shall be added to the "\_links" object which name is equal to the relation type. If there is only one state transition for a given relation type then the value of the member is a "link" object otherwise it is an array of "link" objects. + +A NF service producer shall include a link into the returned resource representation with a registered relation type "self" when it is expected further actions upon it (for instance reading it again or replacing the resource state). + +NOTE 1: For a hypermedia application, a returned representation without any link denotes for the NF service consumers the end of the interaction with the NF service producer. 3GPP APIs does not fulfil this rule. + +### 4.7.4 Inferring link relation semantic + +When a NF service consumer receives a response with linked resources then it shall infer the link relation semantic from the relation type. It shall not infer it from the linked resource URI format. + +In 3GPP hypermedia, relation types are the name of "\_links" object members. + +### 4.7.5 Common Relation Types + +#### 4.7.5.1 Introduction + +This clause contains the list of relation types supported in 3GPP Service Based Interface APIs. + +As defined in IETF RFC 8288 [11] clause 2.1, a link relation type identifies the semantics of a link. It describes how resources are related to each other. It may also be used to indicate that the target resource of a link has particular attributes, or exhibits particular behaviours. Relation types shall not be confused with media types. It does not identify the format of the representation that results when the link is dereferenced. + +There are two kinds of relation types: + +- Registered relation types; +- Extension relation types. + +Registered relation types are identified by a token (for instance "self") and can be reused by other applications such as 3GPP SBI APIs. They are registered by IANA. Registered relation types shall be preferred against extension relation types when expressing the link relation between two resources. + +If there is a need to define a relation type that does not correspond to a registered one but it is not wanted to register it then an extension relation type shall be used instead. + +#### 4.7.5.2 Registered relation types + +The "Link Relations" registry is located at: . + +Table 4.7.5.2-1 specifies the list of registered relation types supported by all hypermedia enabled 3GPP APIs. + +Table 4.7.5.2-2 specifies the list of registered relation types that can be used by some hypermedia enabled 3GPP APIs, depending on the API design. + +**Table 4.7.5.2-1: mandatory registered relation types** + +| Relation name | +|---------------| +| self | + +**Table 4.7.5.2-2: optional registered relation types** + +| Relation name | +|---------------| +| next | +| first | +| previous | +| last | +| item | + +#### 4.7.5.3 Extension relation types + +When no registered relation exists to express the relation between two resources, an extension relation type shall be used instead. It may be defined as a string token or as a URI as defined in IETF RFC 8288 [11]. + +An API specification using extension relation types shall contain a clause "Relation types" in the clause "Simple data types and enumerations" (see 3GPP TS 29.509 [21] for an example of implementation of a hypermedia API). The clause shall contain a table listing the token or the URI of the created relation types. It shall also contain a detailed specification of the semantic of the relation types defining the conditions that the NF Service Consumer shall match to follow a link. + +### 4.7.6 Negotiating the support of optional HATEOAS features + +The supported feature mechanism in clause 6.6.2 of 3GPP TS 29.500 [2] should be used to negotiate the usage of optional HATEOAS features in addition to negotiating the content type "3gppHal+json" and "3gppHalForms+json". Separate supported features can be defined for link relation types related to different use cases. + +## 4.8 Error Responses + +### 4.8.1 Error Response Status Code + +When an error occurs that prevents the NF/NF service acting as an HTTP server from successfully fulfilling the HTTP request, the NF/NF service shall map an application error to the most similar 4xx/5xx HTTP status code as defined in clause 5.2.7 of 3GPP TS 29.500 [2]. + +### 4.8.2 Error Response Body + +When the HTTP status code is not enough for the NF/NF service acting as an HTTP client to determine the cause of the error, the NF/NF service acting as an HTTP server should provide additional application related error information, by including in the response body a representation of a "ProblemDetails" data structure according to IETF RFC 9457 [19] that provides additional details of the error. + +NOTE 1: The response body with the "ProblemDetails" data structure does not need to be sent on a 3GPP 5GC API for a particular HTTP status code if that HTTP status code itself provides enough information of the error, or if there are security concerns disclosing detailed error information. + +The definition of the general "ProblemDetails" data structure from IETF RFC 9457 [19] is specified in clause 5.2.4.1 of 3GPP TS 29.571 [5]. The "ProblemDetails" data structure is a JSON object, as defined in IETF RFC 9457 [19], and contains the following attributes: + +- a) "type" - a URI reference according to IETF RFC 3986 [9] that identifies the problem type; + +- b) "title" - a short, human-readable summary of the problem type that should not change from occurrence to occurrence of the problem; +- c) "status" - the HTTP status code for this occurrence of the problem; +- d) "detail" - a human-readable explanation specific to this occurrence of the problem; and +- e) "instance" - a URI reference that identifies the specific occurrence of the problem. + +A particular API may define additional attributes that provide more information about the error. + +NOTE 2: IETF RFC 9457 [19] allows adding of new properties in the "ProblemDetails" object. + +The following additional attributes are generic extensions defined for the 3GPP 5GC APIs: + +- a) "cause"- a machine-readable application error cause specific to this occurrence of the problem; and +- b) "invalidParams" - invalid parameters causing a request to be rejected. + +The "cause" attribute should be included and provide application-related error information, if available. Application error causes should be defined in 5GC SBI APIs specifications, using the UPPER\_WITH\_UNDERSCORE case convention specified in clause 5.1.1. + +EXAMPLE 1: "OUT\_OF\_LADN\_SA". + +The "invalidParams" attribute should be used to report invalid parameters when a request is rejected due to invalid parameters. + +All the application error causes supported by an API should be defined in a specific clause "Application Errors" under the "Error Handling" clause specified for the API. The application error causes that a specific service operation may respond should be further listed in the table defining the data structure supported by the response body, with the associated HTTP error status code. + +To enable a SEPP or an SCP for Indirect Communications to provide error details in error responses they originate, all service operations should support returning error responses including a representation of a "ProblemDetails" data structure. If additional application specific information is required in the error responses, the API should support returning the additional application information as specified in clause 4.8.3. The NF/NF service that generates the HTTP response shall include in the HTTP response a "Content-Type" header field set to: + +- "application/problem+json", if the response includes a payload body containing the "ProblemDetails" (or extended ProblemDetails, see clause 4.8.3) data structure; or +- "application/json", if the response includes a payload body containing an application-specific data structure. + +NOTE 3: Designing an error response payload body containing an application-specific data structure is discouraged for new APIs or service operations as this prevents a SEPP or an SCP when using indirect communications to include error details for errors they originate. If an API is defined with an application-specific error response body, the API also needs to support an error response body encoding a ProblemDetails object. + +### 4.8.3 Extending ProblemDetails for API Backward Compatibility + +For a service operation that returns "ProblemDetails" in error responses in a given release, if in a later release it is required to provide additional application specific information in the error responses, the API should be modified to return an Extended-ProblemDetails data type by reusing the "ProblemDetails" common data type, as specified in clause 5.3.17, to keep the API backward compatibility. + +The "Content-Type" header shall be set to "application/problem+json" for the error response with the payload body containing the Extended-ProblemDetails data type defined above. + +EXAMPLE: + +- an "AdditionInfo" structured data type containing the additional information to be returned, as specified in clause 5.2.4.2; + +**Table 4.8.3-1 Definition of type AdditionInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------------------|------------------------------------------------------------|-----------------|-----------------------|----------------------|---------------| +| | "" or "array()" or "map()" or "Any Type" | "M", "C" or "O" | "0..1", "1" or "M..N" | | | + +- a "ProblemDetails" data type as combination of "ProblemDetails" common data type and "AdditionInfo" data type define above, as specified in clause 5.2.4.5: + +**Table 4.8.3-2 Definition of type ProblemDetails as a list of to be combined data types** + +| Data type | Cardinality | Description | Applicability | +|--------------------------------|-------------|----------------------|---------------| +| ProblemDetails | 1 | | | +| AdditionInfo | 1 | | | + +Example OpenAPI specification of ProblemDetails data type, as specified in clause 5.3.10: + +``` +components: + schemas: + ProblemDetails: + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/AdditionInfo' +``` + +Example OpenAPI specification of an error response returning ProblemDetails data type: + +``` +responses: + '504': + description: Gateway Timeout + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +``` + +## 4.9 Transferring multiple resources to a NF Service Consumer + +### 4.9.1 General + +This clause describes some possible options that an API may implement when a NF Service Producer needs to return the representations of multiple resources to a NF Service Consumer, e.g. during the query of a large collection of resources (see clause 4.6.1.1.2.2). + +Which options an API may support is defined in the respective stage 3 specification of the API. + +### 4.9.2 Direct Delivery + +A NF Service Producer may return the representations of the resources directly in the response body, i.e. the response body contains an array of the resource representations. + +### 4.9.3 Direct Delivery with Iterations + +If a large number of resource representations need to be returned, the NF Service Producer may return a representation containing a partial list of the requested resources in the response body, with link(s) containing URI(s) allowing the client to retrieve the remaining part(s) of the resources. + +The returned representation containing a partial list of the requested resource is a "3gppHal+json" document. The document is a JSON object with two members whose names are below. + +- \_links. +- child: contains the resources of the partial list. + +The member whose name is "\_links" shall contain a member whose name is "self" and whose value is a "link" object that contains the URI of the returned representation. It shall also contain a member whose name is "next" and whose value is a "link" object that contains the URI of the next partial list of the collection if the returned partial list is not the last one. + +The member whose name is "\_links" should also contain members whose names are "first", "previous" and "last" and whose values contain a "link" object that contains the URIs of the first, previous and last partial lists of the collection if such lists exist. + +The returned representation shall have a member whose name is "child" and whose value is an array of objects. Each of the individual resource representations returned in the partial list shall be embedded in an object of that array. Each object shall also have a member whose name is "\_links". The later shall contain a member whose name is "self" and whose value is a "link" object that contains the URI of the embedded representation. + +The table below provides a template to be added in the clause describing the GET operation of a 3GPP API using the direct delivery with iteration mechanism. + +**Table 4.9.3-1: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------| +| PartialList | M | 1 | 200 OK | This case represents a successful return of a partial list for the corresponding request with direct delivery with iteration. | + +The following data types shall be added to the list of specific data types and described as below in the structured data type clause. + +**Table 4.7.2-1: PartialList** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| _links | map(LinksValueSchema) | M | 1..N | contains the pagination links | +| child | array(ApiSpecificHypermediaEnabledIndividualResource) | M | 1..N | contains the individual resources with a self link.
The data type in the array is specific to the API and is a hypermedia enabled version of the individual resource data type. | + +**Table 4.7.2-1: ApiSpecificHypermediaEnabledIndividualResource** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-----------------------------| +| attribute1 | | | | | +| attribute2 | | | | | +| ... | | | | | +| attribute N | | | | | +| _links | selfLink | M | 1 | contains the link to itself | + +NOTE 1: attributes 1 to N are the attributes of the original individual resource. + +The LinksValueSchema and SelfLink data types shall be added to the list of re-used data types of the 3GPP API. + +A NF Service Consumer that receives link(s) in the response body may retrieve the remaining part(s) of the resources by sending GET requests towards the URI(s) contained in the link(s). + +### 4.9.4 Indirect Delivery + +A NF Service Producer may not return any requested resource representation and instead may return a representation containing only a list of links to the requested resources in the response body. + +The returned representation containing the list is a "3gppHal+json" document. The document is a JSON object with one member whose name is: + +- \_links. + +This member shall contain a member whose name is "item" and whose value is an array of "link" objects. Each of the link objects contains one requested resource URI. There shall be one link object per requested resource. + +It shall also contain a member whose name is "self" and whose value is a "link" object that contains the URI of the returned representation. + +A NF Service Consumer that receives such a response may then send a GET request per resource URI to retrieve the requested resources from the NF Service Producer. + +### 4.9.5 Indirect Delivery with HTTP/2 Server Push + +A NF Service Producer may use HTTP/2 Server Push, if HTTP/2 Server Push is supported in the PLMN. + +To use HTTP/2 Server Push, the NF Service Producer shall send PUSH\_PROMISE frames in the HTTP response, with each PUSH\_PROMISE frame containing a GET request targeting the URI of one resource to be transferred and the reserved stream identifier to be used for transferring the resource. Then the NF Service Producer shall send Push Responses via the corresponding reserved streams, with each Push Response containing the representation of the associated resource. The NF Service Producer shall also send links with the URIs of the resources in DATA frame(s) of the response message. + +A NF Service Consumer may disable HTTP/2 Server Push by sending SETTINGS\_ENABLE\_PUSH parameter with value "0" on HTTP level, as specified in IETF RFC 7540 [13]. + +![Sequence diagram illustrating Indirect Delivery with HTTP/2 Server Push between an NF Service Consumer and an NF Service Producer.](329c96049bb432e9c2cbda4e224a0c9c_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NF Service Consumer + participant Producer as NF Service Producer + + Note right of Producer: 2. Detects of sending multiple resources and choose to use Server Push + + Consumer->>Producer: 1. Ask for resources (HTTP GET /resource-path?query-parameters) + Producer-->>Consumer: 3. HTTP 200 OK + Note left of Consumer: PUSH_PROMISE frame 1 +(:path=,stream id=) +PUSH_PROMISE frame 2 +(:path=,stream id=) +... +PUSH_PROMISE frame N +(:path=,stream id=) +Response HEADERS frame & DATA frames +(List of URIs of the resources) + Note left of Consumer: 4.1 Push response +(body: data representation of ) ————— Stream: + Note left of Consumer: 4.2 Push response +(body: data representation of ) ————— Stream: + Note left of Consumer: ... +4.n Push response +(body: data representation of ) ————— Stream: + Note left of Consumer: 5. Get Single Resource Request +(:path=) + Note left of Consumer: 5.a. Get Single Resource Response +(body: data representation of ) + +``` + +The diagram illustrates the interaction between an NF Service Consumer and an NF Service Producer for indirect delivery using HTTP/2 Server Push. The sequence of events is as follows: + +- The NF Service Consumer sends a request (HTTP GET /resource-path?query-parameters) to the NF Service Producer. +- The NF Service Producer detects that multiple resources need to be returned and decides to use the Server Push mechanism. A box on the right indicates: "2. Detects of sending multiple resources and choose to use Server Push". +- The NF Service Producer responds with an HTTP 200 OK status. Before the response headers and data frames, it sends multiple PUSH\_PROMISE frames (labeled 3. PUSH 200 OK). Each PUSH\_PROMISE frame contains a path (e.g., , , ..., ) and a stream ID (e.g., , , ..., ). This is followed by the Response HEADERS frame and DATA frames containing a list of URIs of the resources. +- The NF Service Producer then sends push responses for each resource (labeled 4.1, 4.2, ..., 4.n). Each push response consists of the body: data representation of the resource (e.g., , , ..., ) and is associated with a specific stream (e.g., Stream: , Stream: , ..., Stream: ). +- The NF Service Consumer sends a request for a single resource (labeled 5. Get Single Resource Request) with the path . +- The NF Service Producer responds with the single resource (labeled 5.a. Get Single Resource Response) with the body: data representation of . + +Sequence diagram illustrating Indirect Delivery with HTTP/2 Server Push between an NF Service Consumer and an NF Service Producer. + +**Figure 4.9.5-1 Indirect Delivery with HTTP/2 Server Push** + +1. A NF Service Consumer sends a HTTP request to get resources(s) to the NF Service Producer, e.g. a query of a collection of resources. +2. The NF Service Producer detects that multiple resources are to be returned and choose to indirectly deliver the resources with the Server Push mechanism. +3. The NF Service Producer returns multiple PUSH\_PROMISE Requests before HEADERS frame and DATA frames(s) to the NF Service Consumer. Each PUSH\_PROMISE Request contains the URI of one resource to be + +transferred and the identifier of the reserved stream used for transferring the resource. The NF Service Producer shall also send links with the URIs of the resources in DATA frame(s) of the response message. + +- 4.1-4.n. The NF Service Producer sends Push Responses via corresponding reserved streams. Each Push Response contains the representation of the associated resource. +5. If the NF Service Consumer does not successfully receive a resource in time, it may send a request to get that resource, using the resource URI previously received from the Push Request. +- 5.a. The NF Service Producer returns the data of the requested resource in the response. + +### 4.9.6 Criteria for choosing the transfer method + +The following considerations may be used to determine which method to use transfer multiple resources to a NF Service Consumer. + +If the size of the representation of each resource is small, direct delivery is preferred. If the number of resources to be returned is large, the NF Service Producer may choose iterative delivery. + +NOTE 1: For this release of this specification, a JSON payload size less than 64000 octets is considered as not large and a JSON payload size larger than 64000 octets is considered as large. + +If the size of the representation of each resource is large, indirect delivery is preferred. If the NF Service Producer supports HTTP/2 Server Push, then: + +- when SETTINGS\_ENABLE\_PUSH parameter with value "1" has been received from the NF Service Consumer, as specified in IETF RFC 7540 [13], it should choose HTTP/2 Server Push to deliver the resource. +- when SETTINGS\_ENABLE\_PUSH parameter with value "0" has been received from the NF Service Consumer, as specified in IETF RFC 7540 [13], it must not choose HTTP/2 Server Push to deliver the resources. +- when SETTINGS\_ENABLE\_PUSH parameter has not been received from the NF Service Consumer, as specified in IETF RFC 7540 [13], it may decide whether to use HTTP/2 Server push or not, depending on other factors, e.g. operator policy, whether the client and server pertain to the same PLMN, etc. + +An NF Service Producer shall use Indirect Delivery with HTTP/2 Server Push only if the NF Service Consumer (client) indicated support for accepting server pushed resource representations, via the Supported Features negotiation as specified in clause 6.6.2 of 3GPP TS 29.500 [2]. + +NOTE 2: In this release the Indirect Delivery with HTTP/2 Server Push is not used by 3GPP service based interface APIs. + +## 4.10 Scopes definition for OAuth2.0 access token + +As indicated in 3GPP TS 33.501 [22] and in clause 6.7.3 of 3GPP TS 29.500 [2], the access to an 5GC API may be authorized by means of the OAuth 2.0 protocol (see IETF RFC 6749 [23]), based on local configuration. OAuth 2.0 supports the concept of scope values to signal which actual access rights an access token represents. + +Each 5GC API shall define a service-level scope set to the service name of the NF Service. This scope grants generic access to the given API, for those operations on resources that do not require a specific authorization. In addition, a 5GC API may define additional resource/operation-level scopes, that uniquely represents the type of operation (e.g. create/modify/read), the resource and the service; a resource/operation-level scope and the service-level scope, together, grant access to the operations on resources that require a specific authorization. + +The need for defining additional resource/operation-level scopes in a 5GC API depends on the API functionalities and service operations and on the expected NF service consumers, and thus is up to the API responsible Working Group to decide. The following points may be considered when assessing the need for additional scopes: + +- It should be carefully assessed during the design of the 5GC API whether different access rights to the functionalities provided by the API may be needed for different NF service consumers, e.g. considering example NF service consumers of the different service operations supported by the API. + +- A 5GC API defined with a service-level scope only, i.e. without additional resource/operation-level scopes, grants access permissions to all its service operations to all NF service consumers allowed to access the service. It should be ensured that designing the API in this way does not cause any vulnerability to the 5GS, e.g. by granting inappropriate read access to sensitive data to undue NF service consumers or by granting inappropriate write (or delete) access to undue NF service consumers. +- Additional scopes should be defined when it is needed to enable restricting the access to certain resource/operations of the 5GC API to specific NF service consumers. This may be the case e.g. when an API supports multiple service operations that may be invoked by different NF service consumers (possibly with different NF types or belonging to different S-NSSAIs, PLMNs or SNPNS), or when it is needed to differentiate access rights for read vs. create/modify/write operations. +- The definition of additional scopes comes with some implementation and network operation complexity. Care should be taken not to increase unreasonably the number of scopes defined in a 5GC API. +- Each additional resource/operation-level scope shall be defined with a clear description (in the main body and in the OpenAPI file of the Technical Specification defining the API) of the access right the additional scope corresponds to. The naming of the resource/operation-level scopes should follow the conventions defined in clause 5.3.16 for ease of understanding and consistency across all 5GC APIs. + +# --- 5 Documenting 5GC SBI APIs + +## 5.1 Naming Conventions + +### 5.1.1 Case Conventions + +The following case conventions for names and strings are used in the 5GC SBI service APIs. + +#### 1) UPPER\_WITH\_UNDERSCORE + +All letters of a string are capital letters. Digits are allowed. Word boundaries are represented by the underscore "\_" character. No other characters are allowed. + +Example 1: + +- a) DATA\_MANAGEMENT +- b) CELL\_CHANGE + +#### 2) lower\_with\_underscore + +All letters of a string are lowercase letters. Digits are allowed. Word boundaries are represented by the underscore "\_" character. No other characters are allowed. + +Example 2: + +- a) data\_management; +- b) cell\_change. + +#### 3) UPPER-WITH-HYPHEN + +All letters of a string are capital letters. Digits are allowed. Word boundaries are represented by the hyphen "-" character. No other characters are allowed. + +Example 3: + +- a) DATA-MANAGEMENT +- b) CELL-CHANGE + +#### 4) lower-with-hyphen + +All letters of a string are lowercase letters. Digits are allowed. Word boundaries are represented by the hyphen "-" character. No other characters are allowed. + +Example 4: + +- a) data-management; +- b) cell-change. + +#### 5) UpperCamel + +A string is formed by concatenating words. Each word starts with a letter or a digit. The first letter of each word shall be an uppercase letter; all other characters in the word shall be lowercase letters or digits. + +Abbreviations follow the same scheme (i.e. first letter uppercase, all other letters lowercase). + +Example 5: + +- a) DataManagement. +- b) CellChange +- c) 5QiPriorityLevel +- d) Amf3GppAccessRegistration + +#### 6) lowerCamel + +A string is formed by concatenating words. Each word starts with a letter or a digit. The first letter of the first word shall be a lowercase letter; the first letter of the rest of the words shall be an uppercase letter. All other characters in the words shall be lowercase letters or digits. + +Abbreviations follow the same scheme. + +Example 6: + +- a) dataManagement +- b) cellChange +- c) 5qiPriorityLevel + +NOTE: These naming conventions are used as guidelines, to provide some uniformity in the specification of the different 5GC APIs. However, for different reasons, sometimes exceptions can be made. In any case, the OpenAPI specifications are mandatory, and the different network elements cannot determine that a certain message, that otherwise complies to the OpenAPI specification, is incorrect based only on the fact that it does not follow a given naming convention in a certain data element. + +### 5.1.2 API Naming Conventions + +An API shall take the name of the corresponding service (e.g. Nudm\_SubscriberDataManagement). When used in URIs the name shall be converted to lower-with-hyphen and may use an abbreviated form (e.g. nudm-sdm). + +### 5.1.3 Conventions for URI Parts + +#### 5.1.3.1 Introduction + +The parts of the URI syntax that are relevant in the context of the 5GC SBI service APIs are as follows: + +- Path, consisting of segments, separated by "/" (e.g. segment1/segment2/segment3). +- Query, consisting of pairs of parameter name and value (e.g., ?mcc=262&mnc=01, where two pairs are presented). + +#### 5.1.3.2 URI Path Segment Naming Conventions + +- a) All path segments of a resource URI which represent a string constant shall use lower-with-hyphen (this implies that a path cannot end with "/"). + +Example 1: + +subscriber-data + +- b) If a resource represents a collection of entities and the last path segment of the resource URI is a string constant, that last path segment shall be plural. + +Example 2: + +.../prefix/api/v1/users + +- c) For resources where the last path segment of the resource URI is a string constant, that last path segment shall be a noun or a composite noun. + +Example 3: + +.../prefix/api/v1/users + +Example 4: + +.../prefix/api/v1/user-session + +- d) For custom operations, the last path segment of the URI via which the operation is invoked shall be a verb, or shall start with a verb. + +Example 5: + +.../app\_instances/{appInstanceId}/instantiate + +Example 6: + +.../sessions/terminate-all + +- e) All path segments of a URI which are variable names shall use lowerCamel, and shall be surrounded by curly brackets. + +Example 7: + +.../subscriber-data/{supi} + +- f) Once a variable is replaced at runtime by an actual string, the string shall follow the rules for a path segment defined in IETF RFC 3986 [9]. IETF RFC 3986 [9] disallows certain characters from use in a path segment. Each actual 5GC SBI service API specification shall define this restriction to be followed when generating values for path segment variables, or propose a suitable encoding (such as percent-encoding according to IETF RFC 3986 [9]), to escape such characters if they can appear in input strings intended to be substituted for a path segment variable. + +#### 5.1.3.3 URI Query Naming Conventions + +- a) URI query parameter names in queries shall use lower-with-hyphen. + +Example 1: + +?nf-type=AMF + +- b) Variables that represent actual parameter values in queries shall use lowerCamel and shall be surrounded by curly brackets. + +Example 2: + +?nf-id={chooseAValue} + +- c) When a variable is replaced at runtime by an actual string, the convention defined in clause 5.1.3.2 item f) applies to that string. + +### 5.1.4 Conventions for Names in Data Structures + +The following syntax conventions apply when defining the names for attributes in the 5GC SBI service API data structures, carried in the payload body of http requests and responses. + +- a) Names of attributes shall be represented using lowerCamel. + +Example 1: + +attributeName + +- b) Names of arrays (i.e. those with cardinality 1..N or 0..N) shall be plural rather than singular. + +Example 2: + +users + +- c) Each value of an enumeration type shall be represented using UPPER\_WITH\_UNDERSCORE. + +Example 3: + +PROHIBITTED\_LISTED + +- d) The names of data types shall be represented using UpperCamel. + +Example 4: + +ResourceHandle + +## 5.2 API Definition + +### 5.2.1 Resource Structure + +Resource structure shall define the structure of the resource URIs, the resources, the associated HTTP methods and custom operations used for the service. + +Figure 5.2.1-1 provides an example of the resource URI structure (i.e. resource tree) of an API. Table 5.2.1-1 provides an example of an overview of the resources defined for the service, and their applicable HTTP methods and custom operations. + +![Diagram showing the resource URI structure of the API. The root is {apiRoot}. It branches into two main paths. The first path is / This is a Collection, e.g. /sessions, which further branches into / This is a collection, e.g. /contexts, then / This is a Document, and finally / (dashed box). The second path is /, which branches into / e.g update, release, etc. (dashed box) and / e.g./subscriptions, which further branches into / This is a Document, e.g. /.](4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg) + +{apiRoot} + +``` + +graph TD + Root["{apiRoot}"] --> RA["/ This is a Collection, e.g. /sessions"] + Root --> B["/"] + RA --> A1["/ This is a collection, e.g. /contexts"] + A1 --> A2["/ This is a Document"] + A2 --> A3["/"] + B --> C1["/ e.g update, release, etc."] + B --> C2["/ e.g./subscriptions"] + C2 --> C2_ref["/ This is a Document, e.g. /"] + style A3 stroke-dasharray: 5 5 + style C1 stroke-dasharray: 5 5 + +``` + +Diagram showing the resource URI structure of the API. The root is {apiRoot}. It branches into two main paths. The first path is / This is a Collection, e.g. /sessions, which further branches into / This is a collection, e.g. /contexts, then / This is a Document, and finally / (dashed box). The second path is /, which branches into / e.g update, release, etc. (dashed box) and / e.g./subscriptions, which further branches into / This is a Document, e.g. /. + +**Figure 5.2.1-1: Resource URI structure of the API** + +In figure 5.2.1-1 the following graphical conventions are used: + +- a child node with a solid-line frame represents: + - a resource-URI that has at least one supported HTTP method associated, see e.g. "/resource A" in Figure 5.2.1-1. Such node may be any of the archetypes defined in Annex C1, C2 and C3; + - a resource-URI, which does not have any standard HTTP operation defined, but has a custom operation, see e.g. "/individual child resource A2" in Figure 5.2.1-1; +- a child node with a dashed-line frame represents a specific custom operation, see e.g. "/custom operation A3" and "/custom operation C1" in Figure 5.2.1-1. Such node is a Custom operation archetype, see Annex C4; +- a child node without a line around its frame (e.g. "/special node type B" in Figure 5.2.1-1) typically represents a path segment for which no standard HTTP operation is specified. This graphical representation is also used when a custom operation without an associated resource is defined for a path segment. . + +Table 5.2.1-1: Resources and methods overview + +| Resource purpose/name | Resource URI (relative path after API URI) | HTTP method or custom operation | Description (service operation) | +|-----------------------|--------------------------------------------|---------------------------------|------------------------------------------| +| | | GET | | +| | | PUT | | +| | | PATCH | | +| | | POST | | +| | | DELETE | | +| | /release | release (POST) | | + +NOTE 1: The "API URI" is defined in clauses 3.1 and 4.4.1. + +For a resource, the "relative path after API URI" is appended to the API URI to form the resource URI as defined in clause 3.1. + +### 5.2.2 Resources and HTTP Methods + +Resources and HTTP methods shall specify the resource URI, resource URI variables for the resource and the standard HTTP methods supported by the resource. + +Example: + +Resource URI: {apiRoot}/// + +The resource URI variables supported by the resource shall be defined as table 5.2.2-1 illustrates. + +Table 5.2.2-1: Resource URI variables for the resource + +| Name | Definition | +|------------------------------------------------|-------------------------------------------------------| +| apiRoot | See clause 4.4.1 | +| < Name of resource URI variables for resource> | < Definition of resource URI variables for resource > | + +The {apiRoot} URI variable should be defined in clauses and this definition should be referenced to ease a possible update of the apiVersion value. + +Each method supported by the resource shall be described including the URI query parameters supported by the method, data structures supported by the request body, and the data structures supported by the response body. + +URI query parameters supported by the method shall be defined as table 5.2.2-2 illustrates. + +Table 5.2.2-2: URI query parameters supported by a method on the resource + +| Name | Data type | P | Cardinality | Description | Applicability | +|---------------|-------------------------|-------------|--------------------------------------------|----------------------|---------------| +| or n/a | or | | 0..1 or 1 or 0..N or 1..N or | | | + +**Name:** Name of query parameter in URI. If no query parameters are defined for the URI, the name should be marked as "n/a". + +**Data type:** Data type of URI query parameters, i.e. a data type defined in the specification. If no query parameter is defined for the URI, the column is left empty. + +**P:** Presence condition of URI query parameters. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). If no query parameter is defined for the URI, the column is left empty. + +**Cardinality:** Defines the allowed number of occurrence. It shall be "0..1", "1", "0..N", "1..N". If no query parameter is defined for the URI, the column is left empty. + +**Description:** Additional information for URI query parameter, i.e. describes the use of the parameter or the presence condition of the parameter and so on. + +**Applicability:** If the URI query parameter is only applicable for optional feature(s) negotiated using the mechanism defined in clause 6.6.2 of 3GPP TS 29.500 [2], the name of the corresponding feature(s) shall be indicated in this column. If no feature is indicated, the attribute can be used with any feature. + +NOTE 1: If no optional features are defined for an API, the applicability column can be omitted for that API. + +Data structures supported by the request body of the method shall be specified as table 5.2.2-3 illustrates. + +**Table 5.2.2-3: Data structures supported by the request body on the resource** + +| Data type | P | Cardinality | Description | +|-----------------------------------------------------|-----------------|------------------------------------------|----------------------| +| "" or "array()" or "map()" or n/a | "M", "C" or "O" | "0..1", "1", or "M..N", or | | + +**Data type:** Data type of the data structure in the request body. If the data type is indicated as "", the request body shall be of data type . If the data type is indicated as "array()", the request body shall be an array (see IETF RFC 8259 [3]) that contains elements of data type . If the data type is indicated as "map()", the request body shall be an object (see IETF RFC 8259 [3]) encoding a map (see clause 5.2.4.2) that contains as values elements of data type . can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. If no request body is allowed, the Data type shall be marked as "n/a". + +**P:** Presence condition of a data structure in request body. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). + +**Cardinality:** Defines the allowed number of occurrence of data type . A cardinality of "M..N", is only allowed for data types "array()" and "map()" and indicates the number of elements within the array or map; the values M and N can either be the characters "M" and "N", respectively, or integer numbers with M being greater than or equal 0, and N being greater than 0 and M. For data type "", the cardinality shall be set to "0..1" if the Presence condition is "C" or "O", and to "1" if the Presence condition is "M". The Cardinality shall be left empty if no request body is allowed. + +**Description:** Additional information for a data structure, i.e. describes the use of the data structure or the presence condition of the data structure and so on. + +NOTE 2: The cardinality of "0..N" does not imply that the presence condition of the array or map is optional or conditional, i.e. the presence condition can be "M" while the cardinality is "0..N", the presence condition can be "O" or "C" while the cardinality is "1..N". + +Data structures supported by the response body of the method shall be specified as table 5.2.2-4 illustrates. + +**Table 5.2.2-4: Data structures supported by the response body on the resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------|-----------------|------------------------------------------|------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| +| "" or "array()" or "map()" or n/a | "M", "C" or "O" | "0..1", "1", or "M..N", or | | or | + +**Data type:** Data type of the data structure in the response body. If the data type is indicated as "", the response body shall be of data type . If the data type is indicated as "array()", the response body shall be an array + +(see IETF RFC 8259 [3]) that contains elements of data type **. If the data type is indicated as "map(**)", the response body shall be an object (see IETF RFC 8259 [3]) encoding a map (see clause 5.2.4.2) that contains as values elements of data type **. ** can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. If no response body is allowed, the Data type shall be marked as "n/a". + +**P:** Presence condition of a data structure in response body. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). + +**Cardinality:** Defines the allowed number of occurrence of data type **. A cardinality of "*M..N*", is only allowed for data types "array(**)" and "map(**)" and indicates the number of elements within the array or map; the values *M* and *N* can either be the characters "M" and "N", respectively, or integer numbers with *M* being greater than or equal 0, and *N* being greater than 0 and *M*. For data type "**", the cardinality shall be set to "0..1" if the Presence condition is "C" or "O", and to "1" if the Presence condition is "M". The Cardinality shall be left empty if no response body is allowed. + +**Response codes:** Lists applicable response codes with name from HTTP Status Code Registry at IANA [12]. Mandatory HTTP status codes listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [2] for the corresponding HTTP method shall only be included if specific clarifications in the description part or special data types of the response body are required. Applicable HTTP status codes in addition to the mandatory HTTP status codes listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [2] for the corresponding HTTP method shall be included. + +**Description:** Additional information for a response, i.e. describes the meaning of the success case or meaning of the error case with additional statement regarding error handling. + +NOTE 3: The cardinality of "0..N" does not imply that the presence condition of the array or map is optional or conditional, i.e. the presence condition can be "M" while the cardinality is "0..N", the presence condition can be "O" or "C" while the cardinality is "1..N". + +### 5.2.3 Representing RPC as Custom Operations on Resources + +Custom operations (RPC-style interaction) may be used on a resource. The description of each custom operation contains the custom operation URI, the HTTP method on which the operation is mapped (typically POST), data structures supported by the request body and the data structures supported by the response body. + +An overview of the custom operations on a resource is illustrated in table 5.2.3-1. + +**Table 5.2.3-1: Custom operation** + +| Custom operation URI | Mapped HTTP method | Description | +|------------------------|--------------------|------------------------------------------| +| | e.g. POST | | + +Data structures supported by the request body of the method shall be specified as table 5.2.3-2 illustrates. + +**Table 5.2.3-2: Data structures supported by the mapped HTTP method request body on the resource** + +| Data type | P | Cardinality | Description | +|-------------------------------------------------------------------------------------------|-----------------|---------------------------------------------------|----------------------| +| " <type> " or "array( <type> )" or "map( <type> )" | "M", "C" or "O" | "0..1", "1", or " M..N ", or | | + +**Data type:** Data type of the data structure in the request body. If the data type is indicated as "**", the request body shall be of data type **. If the data type is indicated as "array(**)", the request body shall be an array (see IETF RFC 8259 [3]) that contains elements of data type **. If the data type is indicated as "map(**)", the request body shall be an object (see IETF RFC 8259 [3]) encoding a map (see clause 5.2.4.2) that contains as values elements of data type **. ** can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. If no request body is allowed, the Data type shall be marked as "n/a". + +**P:** Presence condition of a data structure in request body. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). + +**Cardinality:** Defines the allowed number of occurrence of data type **. A cardinality of "*M..N*", is only allowed for data types "array(**)" and "map(**)" and indicates the number of elements within the array or map; the values *M* and *N* can either be the characters "M" and "N", respectively, or integer numbers with *M* being greater than or equal 0, and *N* being greater than 0 and *M*. For data type "<*type*>", the cardinality shall be set to "0..1" if the Presence condition is "C" or "O", and to "1" if the Presence condition is "M". The Cardinality shall be left empty if no request body is allowed. + +**Description:** Additional information for a data structure, i.e. describes the use of the data structure or the presence condition of the data structure and so on. + +NOTE 1: The cardinality of "0..N" does not imply that the presence condition of the array or map is optional or conditional, i.e. the presence condition can be "M" while the cardinality is "0..N", the presence condition can be "O" or "C" while the cardinality is "1..N". + +Data structures supported by the response body of the method shall be specified as table 5.2.3-3 illustrates. + +**Table 5.2.3-3: Data structures supported by the mapped HTTP method response body on the resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------|-----------------|----------------------------------------------------|------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| +| "< type >" or "array(< type >)" or "map(< type >)" | "M", "C" or "O" | "0..1", "1" or "< M..N >", or | | or | + +**Data type:** Data type of the data structure in the response body. If the data type is indicated as "<*type*>", the response body shall be of data type **. If the data type is indicated as "array(<*type*>)", the response body shall be an array (see IETF RFC 8259 [3]) that contains elements of data type **. If the data type is indicated as "map(<*type*>)", the response body shall be an object (see IETF RFC 8259 [3]) encoding a map (see clause 5.2.4.2) that contains as values elements of data type **. ** can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. If no response body is allowed, the Data type shall be marked as "n/a". + +**P:** Presence condition of a data structure in response body. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). + +**Cardinality:** Defines the allowed number of occurrence of data type **. A cardinality of "*M..N*", is only allowed for data types "array(<*type*>)" and "map(<*type*>)" and indicates the number of elements within the array or map; the values *M* and *N* can either be the characters "M" and "N", respectively, or integer numbers with *M* being greater than or equal 0, and *N* being greater than 0 and *M*. For data type "<*type*>", the cardinality shall be set to "0..1" if the Presence condition is "C" or "O", and to "1" if the Presence condition is "M". The Cardinality shall be left empty if no response body is allowed. + +**Response codes:** Lists applicable response codes with name from HTTP Status Code Registry at IANA [12]. Mandatory HTTP status codes listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [2] for the corresponding HTTP method shall only be included if specific clarifications in the description part or special data types of the response body are required. Applicable HTTP status codes in addition to the mandatory HTTP status codes listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [2] for the corresponding HTTP method shall be included. + +**Description:** Additional information for a response, i.e. describes the meaning of the success case or meaning of the error case with additional statement regarding error handling. + +NOTE 2: The cardinality of "0..N" does not imply that the presence condition of the array or map is optional or conditional, i.e. the presence condition can be "M" while the cardinality is "0..N", the presence condition can be "O" or "C" while the cardinality is "1..N". + +### 5.2.3A Notifications + +Notifications based on the Callback URI as specified in clause 4.6.2.3 and clause 6.2 of 3GPP TS 29.500 [2] may be supported. The description of each notification contains the Callback URI, the HTTP method (typically POST), data structures supported by the request body and the data structures supported by the response body. + +An overview of the notifications is illustrated in table 5.2.3A-1. + +**Table 5.2.3A-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------------------------------|----------------------------------------------|---------------------------------|---------------------------------| +|
e.g. Status Change Notification | < Callback URI >
e.g. {StatusCallbackUri} | e.g POST | e.g. Notify Event | + +Example: + +Callback URI: {notifUri} + +The callback URI variables shall be defined as table 5.2.3A-2 illustrates. + +**Table 5.2.3A-2: Callback URI variables** + +| Name | Definition | +|----------|-----------------------------------------------| +| notifUri | String formatted as URI with the Callback Uri | + +Data structures supported by the request body of the method shall be specified as table 5.2.3A-3 illustrates. + +**Table 5.2.3A-3: Data structures supported by the HTTP method request body** + +| Data type | P | Cardinality | Description | +|----------------------------------------------------|-----------------|---------------------------------------------|----------------------| +| "" or
"array()" or
"map()" | "M", "C" or "O" | "0..1", "1", or
"M..N", or | | + +**Data type:** Data type of the data structure in the request body. If the data type is indicated as "", the request body shall be of data type . If the data type is indicated as "array()", the request body shall be an array (see IETF RFC 8259 [3]) that contains elements of data type . If the data type is indicated as "map()", the request body shall be an object (see IETF RFC 8259 [3]) encoding a map (see clause 5.2.4.2) that contains as values elements of data type . can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. If no request body is allowed, the Data type shall be marked as "n/a". + +**P:** Presence condition of a data structure in request body. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). + +**Cardinality:** Defines the allowed number of occurrence of data type . A cardinality of "M..N", is only allowed for data types "array()" and "map()" and indicates the number of elements within the array or map; the values M and N can either be the characters "M" and "N", respectively, or integer numbers with M being greater than or equal 0, and N being greater than 0 and M. For data type "", the cardinality shall be set to "0..1" if the Presence condition is "C" or "O", and to "1" if the Presence condition is "M". The Cardinality shall be left empty if no request body is allowed. + +**Description:** Additional information for a data structure, i.e. describes the use of the data structure or the presence condition of the data structure and so on. + +NOTE 1: The cardinality of "0..N" does not imply that the presence condition of the array or map is optional or conditional, i.e. the presence condition can be "M" while the cardinality is "0..N", the presence condition can be "O" or "C" while the cardinality is "1..N". + +Data structures supported by the response body of the method shall be specified as table 5.2.3A-4 illustrates. + +**Table 5.2.3A-4: Data structures supported by the mapped HTTP method response body** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------|-----------------|-----------------------------------------|------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| +| "" or "array()" or "map()" | "M", "C" or "O" | "0..1", "1" or "M..N", or | | or | + +**Data type:** Data type of the data structure in the response body. If the data type is indicated as "", the response body shall be of data type . If the data type is indicated as "array()", the response body shall be an array (see IETF RFC 8259 [3]) that contains elements of data type . If the data type is indicated as "map()", the response body shall be an object (see IETF RFC 8259 [3]) encoding a map (see clause 5.2.4.2) that contains as values elements of data type . can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. If no response body is allowed, the Data type shall be marked as "n/a". + +**P:** Presence condition of a data structure in response body. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). + +**Cardinality:** Defines the allowed number of occurrence of data type . A cardinality of "M..N", is only allowed for data types "array()" and "map()" and indicates the number of elements within the array or map; the values M and N can either be the characters "M" and "N", respectively, or integer numbers with M being greater than or equal 0, and N being greater than 0 and M. For data type "", the cardinality shall be set to "0..1" if the Presence condition is "C" or "O", and to "1" if the Presence condition is "M". The Cardinality shall be left empty if no response body is allowed. + +**Response codes:** Lists applicable response codes with name from HTTP Status Code Registry at IANA [12]. Mandatory HTTP status codes listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [2] for the corresponding HTTP method shall only be included if specific clarifications in the description part or special data types of the response body are required. Applicable HTTP status codes in addition to the mandatory HTTP status codes listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [2] for the corresponding HTTP method shall be included. + +**Description:** Additional information for a response, i.e. describes the meaning of the success case or meaning of the error case with additional statement regarding error handling. + +NOTE 2: The cardinality of "0..N" does not imply that the presence condition of the array or map is optional or conditional, i.e. the presence condition can be "M" while the cardinality is "0..N", the presence condition can be "O" or "C" while the cardinality is "1..N". + +### 5.2.4 Data Models + +#### 5.2.4.1 General + +The application data model supported by the API shall be specified with the following data types: + +1. Structured data types +2. Simple data types +3. Enumerations +4. Binary data +5. Data types describing alternative data types +6. Data types describing combinations of data types + +Each data type can be specific for the API or common to multiple APIs (offered by the same or different NFs). The common data types shall be specified in 3GPP TS 29.571 [5]. + +Characters in an enumeration or string data type in both simple and structured/combination data types specific for the API or common to multiple APIs shall be handled as case sensitive by default, unless stated otherwise. + +Strings representing a numerical value or a binary octet string, encoded as hexadecimal characters, shall be handled as case insensitive. + +#### 5.2.4.2 Structured data types + +The structured data types shall represent an object (see IETF RFC 8259 [3]). The structured data types shall contain attributes that are simple data types, structured data types, arrays (see below), maps (as defined below), enumerations, data types describing alternative data types, data types describing combinations of data types or "Any Type" (as described below). + +An array (see IETF RFC 8259 [3]) shall represent a list of values without keys and with significance in the order of sequence. All values shall be of the same type. + +A map shall represent an object (see IETF RFC 8259 [3]) with a list of key-value pairs (with no significance in the order of sequence), where all keys are of type string and shall be unique identifiers assigned by the application rather than by the schema, and where all values shall be of the same type. + +NOTE 1: Maps are supported by the OpenAPI specification [4] as described at . Maps can enable a faster lookup of elements identified by some key in huge data structures compared to arrays that contain the key within the elements. Maps can also be used instead of arrays to modify individual elements when modification instructions of the PATCH method are compliant to IETF RFC 7396 [7]. + +Each structured data type shall be specified in a separate clause as illustrated in table 5.2.4.2-1. + +**Table 5.2.4.2-1: Definition of type ** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------------------------------------------------|-----------------|-----------------------|----------------------|---------------| +| | "" or "array()" or "map()" or "Any Type" | "M", "C" or "O" | "0..1", "1" or "M..N" | | | + +**Table 5.2.4.2-2: Definition of type with nested structures** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------------------------------------------------------------------------------|-----------------|------------------|----------------------|---------------| +| | "array(map()" or "map(array()" or "array(array()" or "map(map()" | "M", "C" or "O" | "M1..N1(M2..N2)" | | | + +**Attribute name:** Name of attributes that belong to the specified data type. The attribute names within a structured data type shall be unique, and their relative order inside the structured data type shall not imply any specific ordering of the corresponding JSON elements in a JSON object. + +NOTE 2: The JSON specification (IETF RFC 8259 [3]) allows duplicate keys in a JSON object, but its usage is discouraged, since it makes interoperability more difficult, and makes the behavior of the JSON parsing software unpredictable. Similarly, that RFC encourages to make implementations not dependent on attribute ordering. + +**Data type:** Data type of the attribute. If the data type is indicated as "", the attribute shall be of data type . If the data type is indicated as "array()", the attribute shall be an array (see IETF RFC 8259 [3]) that contains elements of data type . If the data type is indicated as "map()", the attribute shall be an object (see IETF RFC 8259 [3]) encoding a map that contains as values elements of data type . can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a + +3GPP specification. If the data type is indicated as "Any Type", the attribute can either be "integer", "number", "string", "boolean", "array" or "object" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. + +**P:** Presence condition of a data structure in request body. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). + +**Cardinality:** Defines the allowed number of occurrence of data type . A cardinality of "M..N", is only allowed for data types "array()" and "map()" and indicates the number of elements within the array or map; the values M and N can either be the characters "M" and "N", respectively, or integer numbers; with M being greater than or equal 0, and N being greater than 0 and M. For data type with nested structures, the cardinality is expressed in a nested manner, each level of the M and N values describe the cardinality of the corresponding level of the data structure. For data type "" and "Any Type", the cardinality shall be set to "0..1" if the Presence condition is "C" or "O", and to "1" if the Presence condition is "M". + +**Description:** Describes the meaning and use of the attribute and may contain normative statements. + +**Applicability:** If the attribute is only applicable for optional feature(s) negotiated using the mechanism defined in clause 6.6 of 3GPP TS 29.500 [2], the name of the corresponding feature(s) shall be indicated in this column. If no feature is indicated, the attribute can be used with any feature. + +NOTE 3: The cardinality of "0..N" does not imply that the presence condition of the array or map is optional or conditional, i.e. the presence condition can be "M" while the cardinality is "0..N", the presence condition can be "O" or "C" while the cardinality is "1..N". + +NOTE 4: If no optional features are defined for an API, the applicability column can be omitted for that API. + +#### 5.2.4.3 Simple data types and enumerations + +The simple data types and enumerations can be referenced from data structures. All simple data types and enumerations should map to base types supported by OpenAPI specification [4]. Simple data types shall be specified as illustrated in table 5.2.4.3-1. + +**Table 5.2.4.3-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|------------------------------------------------------------------|-------------|---------------| +| | | | | + +**Type Name:** The name of the simple data type. + +**Type Definition:** Base types supported by OpenAPI specification [4], i.e. Boolean, integer, string and so on. + +**Description:** Additional descriptions for simple data types like range, string length, string pattern (regular expression) and so on. + +**Applicability:** If the type is only applicable for optional feature(s) negotiated using the mechanism defined in clause 6.6 of 3GPP TS 29.500 [2], the name of the corresponding feature(s) shall be indicated in this column. If no feature is indicated, the type can be used with any feature. + +NOTE 1: If no optional features are defined for an API, the applicability column can be omitted for that API. + +Each enumeration type shall be respectively specified for their elements sets as illustrated in table 5.2.4.3-2. + +**Table 5.2.4.3-2: Enumeration ** + +| Enumeration value | Description | Applicability | +|---------------------|------------------------------------------|---------------| +| Enumeration value 1 | The description of this enum value | | +| Enumeration value 2 | The description of this other enum value | | + +**Enumeration value:** Defines the valid values, which can be integer, string or boolean, it is suggested to keep the same value style in one API specification. + +**Description:** Additional descriptions for enumeration attributes, like the meaning and usage of enumeration elements. + +**Applicability:** If the enumeration value is only applicable for optional feature(s) negotiated using the mechanism defined in clause 6.6 of 3GPP TS 29.500 [2], the name of the corresponding feature(s) shall be indicated in this column. If no feature is indicated, the enumeration value can be used with any feature. + +NOTE 2: If no optional features are defined for an API, the applicability column can be omitted for that API. + +#### 5.2.4.4 Binary Data + +#### 5.2.4.5 Data types describing alternative data types or combinations of data types + +The data types describing alternative data types or combinations of data types shall represent an OpenAPI schema object using the "oneOf" , "anyOf" or "allOf" keyword to list alternative or to be combined data types (see the OpenAPI specification [4] and ). + +An instance (i.e. a corresponding part of a JSON file to be evaluated against the schema) matches a list of mutually exclusive alternative data types , as described using the OpenAPI "oneOf" keyword, if the instance matches against one and only one of the alternative data types. + +NOTE 1: Data types with the same simple data type but different format and/or pattern attributes are mutually exclusive if the corresponding formats and/or patterns are mutually exclusive. + +An instance (i.e. a corresponding part of a JSON file to be evaluated against the schema) matches a list of non-exclusive alternative data types, as described using the OpenAPI "anyOf" keyword, if the instance matches against one or more of the alternative data types. + +An instance (i.e. a corresponding part of a JSON file to be evaluated against the schema) matches a list of to be combined data types, as described using the OpenAPI "allOf" keyword, if the instance matches against all of the to be combined data types. + +The alternative or to be combined data types shall be simple data types, structured data types, arrays (see clause 5.2.4.2), maps (see clause 5.2.4.2), enumerations, data types describing alternative data types, or data types describing combinations of data types. + +Each structured data type shall be specified in a separate clause as illustrated in table 5.2.4.2-1. + +**Table 5.2.4.2-1: Definition of type as a list of <"mutually exclusive alternatives" / "non-exclusive alternatives" / "to be combined data types">** + +| Data type | Cardinality | Description | Applicability | +|----------------------------------------------------|---------------|----------------------|---------------| +| "" or
"array()" or
"map()" | "1" or "M..N" | | | + +**Data type:** Data type of the alternative or to be combined data type. If the data type is indicated as "", the alternative or to be combined data type shall be of data type . If the data type is indicated as "array()", the alternative or to be combined data type shall be an array (see IETF RFC 8259 [3]) that contains elements of data type . If the data type is indicated as "map()", the alternative or to be combined data type shall be an object (see IETF RFC 8259 [3]) encoding a map (see clause 5.2.4.2) that contains as values elements of data type . can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. + +**Cardinality:** Defines the allowed number of occurrence of data type . A cardinality of "M..N", is only allowed for data types "array()" and "map()" and indicates the number of elements within the array or map; the values M and N can either be the characters "M" and "N", respectively, or integer numbers; with M being greater than or equal 0, and N being greater than 0. For data type "", the cardinality shall be set to "1". + +**Description:** Describes the meaning and use of the attribute and may contain normative statements. + +**Applicability:** If the type is only applicable for optional feature(s) negotiated using the mechanism defined in clause 6.6 of 3GPP TS 29.500 [2], the name of the corresponding feature(s) shall be indicated in this column. If no feature is indicated, the type can be used with any feature. + +NOTE 2: If no optional features are defined for an API, the applicability column can be omitted for that API. + +NOTE 3: Data types describing alternative data types or combinations of data types can only be extended with additional data types in a backward compatible manner if the new data types are associated with an optional feature and the mechanism defined in clause 6.6 of 3GPP TS 29.500 [2] is used to negotiate the support of that optional feature before that new data type is used. + +### 5.2.5 Void + +### 5.2.6 3GPP Custom HTTP Headers + +The definition of 3GPP APIs for the Service-Based Architecture includes the definition of 3GPP-specific HTTP headers, both generic (i.e. applicable to any API), and also API-specific headers. + +The definition of the generic HTTP headers is done in 3GPP TS 29.500 [2]. It consists of the ABNF definition of each header, along with a detailed description of the syntax and expected behaviour and handling by the receiver of such header; each header is specified in its own separate clause. + +3GPP TS 29.500 [2], Annex D, contains a self-contained full grammar of the entire set of custom HTTP headers, comprising both the definition of ABNF components/rules re-used from IETF RFCs, and the 3GPP-specific ABNF rule definitions. + +In addition, the zip file of the published 3GPP TS 29.500 [2] shall contain a file, named "TS29500\_CustomHeaders.abnf", that reflects the content of such Annex D, and the same file shall be made available on the 3GPP Forge GitLab repository mentioned in clause 5.3.1, along with the OpenAPI files, where tooling can be used for validation of the ABNF grammar. + +For API-specific HTTP header definition, a similar procedure shall be followed: if an API defines custom HTTP headers, their ABNF shall be included in the TS where such API is defined, along with the description of each header; each header shall be described in its own separate clause. + +Similarly, each TS that defines custom HTTP headers shall contain an Annex with a self-contained and minimal set of ABNF rules, including re-used rules from other sources (e.g. IETF RFCs, 3GPP TS 29.500, etc.). The zip file of the published TS shall contain a file with ".abnf" extension, with the same content as the Annex, and such file shall be made available, and validated, on 3GPP Forge/GitLab. + +## 5.3 OpenAPI specification files + +### 5.3.1 General + +5GC SBI APIs' OpenAPI specification files shall comply with the OpenAPI specification [4] and with the present clause 5.3. + +Each API shall be described in one OpenAPI specification file contained in an Annex of the 3GPP specification that describes the corresponding API. In addition, 3GPP specifications may contain OpenAPI specification file with common data types. + +Informative copies of all OpenAPI specification files contained in 3GPP Technical Specifications are available on a Git-based repository hosted in 3GPP Forge, that uses the GitLab software version control system. + +The repository is named "5G APIs" and is publicly accessible via the following URI: + +[https://forge.3gpp.org/rep/all/5G\\_APIs](https://forge.3gpp.org/rep/all/5G_APIs) + +NOTE: As indicated in 3GPP TR 21.900 [25], clause 5C, there is an alternative option for the availability and distribution of OpenAPI specification files (decided by the responsible Working Group of each TS), where these files can be stored in a 3GPP Forge GitLab repository and can be declared as normative. + +In that case, the TS does not contain OpenAPI descriptions in normative Annexes and instead it includes information about the repository used for the storage of OpenAPI files, e.g., GitLab group, repository name, branch, directory path (if any), and a Git tag representing the repository snapshot that corresponds to the specific TS version. + +### 5.3.2 Formatting of OpenAPI specification files + +The following guidelines shall be used when documenting OpenAPI specification files: + +- OpenAPI specification files shall be documented using YAML format (see YAML 1.2 [16]). For specific restrictions on the usage of YAML in OpenAPI, see OpenAPI Specification [4]. +- The style used for the specification shall be "PL" (Programming Language). +- The different scopes in the YAML data structures representing collections (objects, arrays...) shall use an indentation of two white spaces. +- Comments may be added by following the standard YAML syntax ("#"). +- Tabs shall not be used in OpenAPI specification files (e.g. within description fields). +- "Unbreakable" spaces (UTF-8 'NO-BREAK SPACE' (U+00A0)) shall not be used in OpenAPI specification files (e.g. within description fields). Only "normal" spaces (UTF-8 'SPACE' (U+0020)) shall be allowed. +- Trailing spaces (i.e. white spaces at the end of a line) should not be used in OpenAPI specification files. + +### 5.3.3 Info + +The OpenAPI specification file of an API shall contain an "info" object with the title that should be set to the same value as chosen for the API name in the heading of Annex A.x of the corresponding 3GPP TS, and with the version set as described in clause 4.3. + +The "info" object shall also include a "description" field, containing the name of the service that the API implements, and the same copyright notice as included in the front page of the corresponding 3GPP TS that specifies the API. The content of the "description" field shall be formatted using the YAML block notation for scalars (i.e. using the "|" character). + +EXAMPLE: "info" object with the title, version and description of the API. + +``` +info: + title: 'Nsmf_PDUSession' + version: '1.0.0' + description: | + SMF PDUSession Service. + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +``` + +### 5.3.4 externalDocs + +Each OpenAPI specification file shall provide an "externalDocs" object as illustrated in the example below that shall contain: + +- within the "description" field the 3GPP TS number, the version number and the name of the 3GPP TS describing the API, and +- within the "url" field a reference to the folder of that TS within the specification archive of the public 3GPP fileserver (i.e. "https://www.3gpp.org/ftp/Specs/archive///"). + +The version number in the "externalDocs" object shall be updated each time when the TS version contains new changes to the OpenAPI specification file. + +NOTE 1: If a new TS version is provided without any changes to the OpenAPI specification file, the TS version number included in the "description" field of the "externalDocs" field in the OpenAPI specification file is not updated. + +NOTE 2: If a new TS version is provided with changes to the OpenAPI specification file, the TS version number included in the "description" field of the "externalDocs" object is updated. However, if the API version in a given release is still the same as in a previous release, the first TS version in the first release that contains that API version is provided as TS version within the "externalDocs" object also in the TS versions of the subsequent releases. + +EXAMPLE: "externalDocs" object. + +``` +externalDocs: + description: 3GPP TS 29.503 V15.1.0; 5G System; Unified Data Management Services + url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' +``` + +### 5.3.5 Servers + +As defined in clause 4.4.1, the API URI consists of {apiRoot}//. It shall be encoded in the corresponding OpenAPI specification file as "servers" field with {apiRoot} as variable. + +Example: + +``` +servers: +- url: '{apiRoot}/nxxx-yyyy/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4.1 of 3GPP TS 29.501 +``` + +### 5.3.6 References to other 3GPP-defined OpenAPI specification files + +Open API specification files may contain references to fragments of other 3GPP-defined Open API specification files. + +Such references shall be formatted to refer to local files stored on the same folder. + +NOTE 1: For the purpose of referencing, it is assumed that each OpenAPI specification file contained in a 3GPP specification is stored as separate physical file and that all OpenAPI specification files are stored in the same directory on the local server. + +The referenced file names for other 3GPP-defined Open API specification files shall comply with the following convention, unless a specific file name is indicated in the Annex of a 3GPP specification defining an OpenAPI specification file. The file name shall consist of (in the order below): + +- the 3GPP specification number in the format "TSxxyyy"; +- an "\_" character; +- if the OpenAPI specification file contains an API definition: the API name which shall be taken from the heading of the relevant annex A.x as defined in the corresponding 3GPP TS of that API. +- if the OpenAPI specification file contains a definition of CommonData: the string "CommonData"; and +- the string ".yaml". + +NOTE 2: The informative copies of OpenAPI specification files contained in 3GPP Technical Specifications at the public 3GPP file server (see clause 5.3.1) follow the above conventions and can be copied into a local folder in order to resolve references. + +Such a reference to another OpenAPI specification file shall be interpreted as referring to the related OpenAPI specification file contained in the version of the corresponding 3GPP TS indicated in the reference clause of the specification, i.e. for a non-specific reference the latest version of that 3GPP TS in the same Release as the specification. + +EXAMPLE: Reference to Data Type "Xxx" defined in the same file + +``` +$ref: '#/components/schemas/Xxx' +``` + +EXAMPLE: Reference to Data Type "Xxx" defined as Common Data in 3GPP TS 29.571: + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Xxx' +``` + +EXAMPLE: Reference to Data Type "Xxx" defined within API "Nudm\_UEAU" in 3GPP "TS 29.503": + +``` +$ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Xxx' +``` + +### 5.3.7 Server-initiated communication + +If an API contains server-initiated communication (see clause 6.2 of 3GPP TS 29.500 [2]), e.g. for notifications as described in clause 4.6.2.3, it should be described as "callbacks" in OpenAPI specification files. + +Example: + +``` +paths: + /subscriptions: + post: + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + callbackUrl: # Callback URL + type: string + format: uri + responses: + '201': + description: Success + callbacks: + myNotification: # arbitrary name + '{ $request.body#/callbackUrl }': # refers The callback URL in the POST + post: + requestBody: # Contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationBody' + responses: # Expected responses to the callback message + '204': + description: xxx +``` + +An API description may consist of standalone notifications, i.e., notifications where there is no previous interaction between consumer and producer to create a subscription. In such case, the API shall be documented by including a "dummy" subscription request pseudo-operation that shall not be used by the consumer. In such case, the notification URI may be obtained by the producer by different means (e.g. out of band configuration, or via a separate signaling interaction with the producer, or by querying NRF for the NF Profile of the consumer and looking for a "default notification endpoint"). + +Example: + +``` +paths: + /subscriptions: + post: + # This is a pseudo operation, consumers shall NOT invoke this method! +``` + +``` + +requestBody: + required: true + content: + application/json: + # Unspecified schema for the JSON body, since this is not used by consumer or producer + schema: {} +responses: + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + standaloneNotification: + '{notificationUri}': + # The URI in {notificationUri} is obtained out of band by the producer + post: + requestBody: # Contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationBody' + responses: # Expected responses to the callback message + '204': + description: xxx + +``` + +### 5.3.8 Describing the body of HTTP PATCH requests + +#### 5.3.8.1 General + +As described in clause 4.6.1.1.3.2, the bodies of HTTP PATCH requests either use a "JSON Merge Patch" encoding as defined in IETF RFC 7396 [7], or a "JSON Patch" encoding as defined IETF RFC 6902 [8]. + +It is possible to allow both encodings in a OpenAPI Specification [4] offering both schemas as alternative contents. + +NOTE: In Rel-15 a single encoding will be selected for each resource as backward compatibility considerations do not yet apply. + +An example OpenAPI specification file offering both PATCH encodings is included in Annex D. + +#### 5.3.8.2 JSON Merge Patch + +In the OpenAPI Specification [4] file, the content field key of the Request Body Object shall contain "application/merge-patch+json". The content field value is a Media Type Object identifying the applicable patch body Schema Object. The patch body Schema Object may contain structured data types derived from the data types used in the schema to describe a complete representation of the resource in such a manner that attributes that are allowed to be modified are listed in the "properties" validation keyword. + +NOTE 1: A derived structured data type is beneficial if the data types used to describe a complete representation of the resource contains mandatory attributes, if attributes are allowed to be removed by the PATCH operation, or if a checking by the OpenAPI tooling that only allowed modifications are done via the "additionalProperties: false" keyword is desired. It also provides a clear description in the OpenAPI specification file to developers which modifications need to be supported. + +As an alternative, the data types used in the schema to describe a complete representation of the resource may be used if any attributes that are allowed to be removed are marked as "nullable: true" in that schema. + +Any attributes that are allowed to be removed shall be marked as "nullable: true" in the patch body Schema Object. + +The "additionalProperties: false" keyword may be set. + +NOTE 2: The "additionalProperties: false" keyword enables the OpenAPI tooling to check that only allowed modifications are done. Extensions of the object in future releases are still possible under the assumption that the supported features mechanism is used to negotiate the usage of any new attribute prior to the PATCH invocation. If new optional attributes are expected to be introduced without corresponding supported feature or if PATCH can be used as first operation in an API, the usage of the "additionalProperties: false" keyword is not appropriate. + +#### 5.3.8.3 JSON PATCH + +In the OpenAPI Specification [4] file, the content field of the key Request Body Object shall contain "application/json-patch+json". The content field value is a Media Type Object identifying the applicable patch body. It may contain a mutually exclusive list (using the "oneOf" keyword) of all allowed modifications as tuples, where "path" is a string containing a JSON Pointer value referring to a JSON object that is allowed to be modified, "op" is an enumeration of allowed JSON PATCH operations on the JSON object identified by "path" and "value" representing the schema/type of the value that will be updated or added at the JSON object identified by "path". In addition, an open alternative containing an object with no properties may be added using the "anyOf" keyword. + +NOTE 1: A mutually exclusive list provides a clear description in the OpenAPI specification file to developers which modifications need to be supported. This is of particular interest if only a limited number of modifications need to be supported. If no open alternative is included, the OpenAPI tooling will also check that only allowed modifications are done. + +NOTE 2: The open alternative allows for extensions of the PATCH in scenarios where new optional attributes are expected to be introduced without corresponding supported feature or if PATCH can be used as first operation in an API. + +### 5.3.9 Structured data types + +For a structured data type, as defined in clause 5.2.4.2, the OpenAPI Specification [4] file shall contain a definition in the components/schemas clause defining a schema with the name of the structured data type as key. + +The schema shall contain: + +- "type: object"; +- "description: ", where is the description of the data type in the table defining the structured data type. The "description" attribute should be provided for all data types, specially if they are frequently reused from the same or other OpenAPI specification files; the "description" attribute shall always be provided for data types defined as maps, with a clear indication of the values (strings) used as key of the map. +- if any attributes in the structured data type are marked as mandatory, a "required" keyword listing those attributes; and +- a "properties" keyword containing for each attribute in the structured data type an entry with the attribute name as key and: + 1. if the data type is "": + - a. if the data type of the attribute is "string", "number", "integer", or "boolean"; + - i) a type definition using that data type as value ("type: "); and + - ii) optionally "description: ", where is the description of the attribute in the table defining the structured data type; or + - b. otherwise a reference to the data type schema for the data type of the attribute, i.e. "\$ref: '#/components/schemas/'" if that data type schema is contained in the same OpenAPI specification file and "\$ref: '#/components/schemas/'" if that data type schema is contained in file in the same directory on the same server; + 2. if the data type is "array()": + - a. a type definition "type: array"; + - b. an "items:" definition containing: + - i). if the data type of the attribute is "string", "number", "integer", or "boolean", a type definition using that data type as value ("type: "); or + - ii). otherwise a reference to the data type schema for the data type of the attribute, i.e. "\$ref: '#/components/schemas/'" if that data type schema is contained in the same + +OpenAPI specification file and "\$ref: '/#/components/schemas/'"" if that data type schema is contained in file in the same directory on the same server; + +- c. if the cardinality contained an integer value as lower boundary, "minItems: "; and + - d. if the cardinality contained an integer value as upper boundary, "maxItems: "; and + - e. optionally "description: ", where is the description of the attribute in the table defining the structured data type; +3. if the data type is "map()": +- a. a type definition "type: object"; and + - b. an "additionalProperties:" definition containing: + - i. if the data type of the attribute is "string", "number", "integer", or "boolean", a type definition using that data type as value ("type: "); or + - ii. otherwise a reference to the data type schema for the data type of the attribute, i.e. "\$ref: '#/components/schemas/'"" if that data type schema is contained in the same OpenAPI specification file and "\$ref: '/#/components/schemas/'"" if that data type schema is contained in file in the same directory on the same server; + - c. if the cardinality contained an integer value as lower boundary, "minProperties: "; and + - d. if the cardinality contained an integer value as upper boundary, "maxProperties: "; and + - e. "description: ", where is the description of the attribute in the table defining the structured data type; the "description" attribute shall always be provided for attributes defined as maps, with a clear indication of the values (strings) used as key of the map. + +NOTE: An omission of the "minProperties", and "maxProperties" keywords indicates that no lower or upper boundaries respectively, for the number of properties in an object are defined. An omission of the "minItems", and "maxItems" keywords indicates that no lower or upper boundaries, respectively, for the number of items in an array are defined. + +4. if the data type is "Any Type": +- a. if no properties to be defined, a pair of curly braces after the attribute name key ": {}", which is shorthand syntax for an arbitrary-type schema; or + - b. at least one of the following properties: + - i) if null value is allowed, "nullable: true"; or + - ii). "description: ", where is the description of the attribute in the table defining the structured data type. + +In the OpenAPI 3.0.0 Specification [4], the '\$ref' keyword must be the only attribute of the JSON object. Therefore it is not allowed to use e.g. a "description" attribute along with the '\$ref' keyword. However, if it is deemed necessary, a "description" attribute can be added before or after the '\$ref' keyword as a comment, i.e. by adding a comment sign '#' in front of the "description" field. + +NOTE: CT4 decides on case-by-case basis when it is deemed necessary to add such a "description" attribute along with the '\$ref' keyword. + +Example: + +**Table 5.3.9-1: Definition of type ExampleStructuredType** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|--------------------|---|-------------|------------------------------------------------|---------------| +| exSimple | ExSimple | M | 1 | exSimple attribute description | | +| exArrayElements | array(string) | O | 0..10 | exArrayElements attribute description | | +| exMapElements | map(ExStructure) | M | 1..N | exMapElements attribute description | | +| exNestedArray | array(map(string)) | M | 0..N(1..M) | exNestedArray attribute description | | +| exNestedMap | map(array(string)) | O | 1..N(2..M) | exNestedMap attribute description | | +| exAnyTypeNullableElement | Any Type | O | 0..1 | exAnyTypeNullableElement attribute description | | +| exAnyTypeNoDescription | Any Type | O | 0..1 | n/a | | + +The data structure in table 5.3.9-1 is described in an OpenAPI specification file as follows: + +``` + +components: + schemas: + ExampleStructuredType: + type: object + description: ExampleStructuredType data type description + required: + - exSimple + - exMapElements + properties: + exSimple: + $ref: '#/components/schemas/ExSimple' + exArrayElements: + type: array + items: + type: string + minItems: 0 + maxItems: 10 + description: exArrayElements attribute description + exMapElements: + type: object + additionalProperties: + # description: commented out description of the additionalProperties + $ref: '#/components/schemas/ExStructure' + minProperties: 1 + description: exMapElements attribute description, indicating values of the map keys + exNestedArray: + type: array + items: + type: object + additionalProperties: + type: string + minProperties: 1 + description: exNestedArray attribute description + exNestedMap: + type: object + additionalProperties: + type: array + items: + type: string + minItems: 2 + minProperties: 1 + description: exNestedMap attribute description + exAnyTypeNullableElement: + nullable: true + description: exAnyTypeNullableElement attribute description + exAnyTypeNoDescription: {} + +``` + +### 5.3.10 Data types describing alternative data types or combinations of data types + +For a data type describing alternatives, as defined in clause 5.2.4.5, the OpenAPI Specification [4] file shall contain a definition in the components/schemas clause defining a schema with the name of the data type describing alternatives as key. + +The schema shall contain: + +- the "oneOf", "anyOf" or "allOf" keyword selected as follows: + 1. for table caption "Definition of type as a list of mutually exclusive alternatives", the "oneOf" keyword; + 2. for table caption "Definition of type as a list of non-exclusive alternatives", the "anyOf" keyword; + 3. for table caption "Definition of type as a list of to be combined data types", the "allOf" keyword; +- a list of alternatives, containing for each line in the table describing the data type a separate line starting with "-": + 1. if the data type is "": + - a. if the data type of the attribute is "string", "number", "integer", or "boolean"; + - i) a type definition using that data type as value ("type: "); and + - ii) optionally "description: ", where is the description of the attribute in the table defining the structured data type; or + - b. otherwise a reference to the data type schema for the data type of the attribute, i.e. "\$ref: '#/components/schemas/'" if that data type schema is contained in the same OpenAPI specification file and "\$ref: '#/components/schemas/'" if that data type schema is contained in file in the same directory on the same server; + 2. if the data type is "array()": + - a. a type definition "type: array"; + - b. an "items:" definition containing: + - i). if the data type of the attribute is "string", "number", "integer", or "boolean", a type definition using that data type as value ("type: "); or + - ii). otherwise a reference to the data type schema for the data type of the attribute, i.e. "\$ref: '#/components/schemas/'" if that data type schema is contained in the same OpenAPI specification file and "\$ref: '#/components/schemas/'" if that data type schema is contained in file in the same directory on the same server; + - c. if the cardinality contained an integer value as lower boundary, "minItems: "; and + - d. if the cardinality contained an integer value as upper boundary, "maxItems: "; and + - e. optionally "description: ", where is the description of the attribute in the table defining the structured data type; + 3. if the data type is "map()": + - a. a type definition "type: object"; and + - b. an "additionalProperties:" definition containing: + - i). if the data type of the attribute is "string", "number", "integer", or "boolean", a type definition using that data type as value ("type: "); or + - ii). otherwise a reference to the data type schema for the data type of the attribute, i.e. "\$ref: '#/components/schemas/'" if that data type schema is contained in the same OpenAPI specification file and "\$ref: '#/components/schemas/'" if that data type schema is contained in file in the same directory on the same server; + - c. if the cardinality contained an integer value as lower boundary, "minProperties: "; and + - d. if the cardinality contained an integer value as upper boundary, "maxProperties: "; and + - e. optionally "description: ", where is the description of the attribute in the table defining the structured data type. + +NOTE: An omission of the "minProperties", and "maxProperties" keywords indicates that no lower or upper boundaries respectively, for the number of properties in an object are defined. An omission of the "minItems", and "maxItems" keywords indicates that no lower or upper boundaries, respectively, for the number of items in an array are defined. + +Example: + +**Table 5.3.10-1: Definition of type ExampleAlternativesType as a list of mutually exclusive alternatives** + +| Data type | Cardinality | Description | Applicability | +|------------------|-------------|---------------------------------------|---------------| +| ExSimple | 1 | exSimple attribute description | | +| array(string) | 0..10 | exArrayElements attribute description | | +| map(ExStructure) | 1..N | exMapElements attribute description | | + +The data structure in table 5.3.10-1 is described in an OpenAPI specification file as follows: + +``` +components: + schemas: + ExampleAlternativesType: + oneOf: + - $ref: '#/components/schemas/ExSimple' + - type: array + items: + type: string + minItems: 0 + maxItems: 10 + description: exArrayElements attribute description + - type: object + additionalProperties: + $ref: '#/components/schemas/ExStructure' + minProperties: 1 + description: exMapElements attribute description +``` + +### 5.3.11 Error Responses + +As described in clause 4.8 of the present specification and clause 5.2.7 of 3GPP TS 29.500 [2], 5GC SBI APIs use valid HTTP response codes as error codes in HTTP responses and may include a "ProblemDetails" data structure specified in clause 5.2.4.1 of 3GPP TS 29.571 [5] or an application-specific data structure. + +Table 5.2.7.1-1 of 3GPP TS 29.500 [2] specifies HTTP status code per HTTP method. For each HTTP method of an API, HTTP status codes shall be specified using response code tables as described in clauses 5.2.2 and 5.2.3. OpenAPI specification files shall include in the description of an HTTP method in the "paths" segment the mandatory HTTP status codes in Table 5.2.7.1-1 of 3GPP TS 29.500 [2] and the HTTP status codes listed in response codes table of that HTTP method. + +For the purpose of referencing, HTTP error responses with "ProblemDetails" data structure are specified as part of the CommonData OpenAPI specification file in Annex A of 3GPP TS 29.571 [5]. + +Example: + +In the example below, the 400, 500 and default error response descriptions defined in 3GPP TS 29.571 [5] are referenced. + +``` +paths: + /users: + get: + responses: + '200': + content: + application/json + schema: + $ref: '#/components/schemas/ExampleGetBody' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +``` + +The following definitions provided in Annex A of 3GPP TS 29.571 [5] are used in that example: + +``` +components: + responses: + '400': + description: Bad request + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '500': + description: Internal Server Error + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + default: + description: Generic Error +``` + +### 5.3.12 Enumerations + +For enumerations, as defined in clause 5.2.4.3, the OpenAPI Specification [4] file shall contain a definition in the components/schemas clause defining a schema with the name of the enumeration as key. + +The schema + +- shall contain the "anyOf" keyword listing as alternatives: + 1. the "type: string" keyword and the "enum" keyword with a list of all defined values for the enumeration; and + 2. the "type: string" keyword and the "description" keyword with a description stating that the string is only provided for forward compatibility with future extensions but is not used to encode contents defined in the present version of the specification. Future extensions may need to be defined in conjunction with the supported feature mechanism as specified in clause 6.6.2 of 3GPP TS 29.500 [2], and +- should contain a description field, containing the overall meaning and purpose of the enumeration; additionally, this field may contain a list of the defined values of the enumeration together with explanations of those values. + +NOTE: The "enum" keyword restricts the permissible values of the string to the enumerated ones. This can lead to extensibility problems when new values need to be introduced. + +Example: + +ExampleEnumeration represents xxx, and it is used to indicate yyy or zzz; it complies with the provisions defined in Table 5.3.12-1 + +**Table 5.3.12-1: Enumeration ExampleEnumeration** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------|---------------| +| "ONE" | Value One description | | +| "TWO" | Value Two description | | + +The data structure in table 5.3.12-1 is described in an OpenAPI specification file as follows: + +``` +components: + schemas: + ExampleEnumeration: + anyOf: + - type: string + enum: + - ONE + - TWO + - type: string + description: > + 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. + description: | + ExampleEnumeration represents xxx, and it is used to indicate yyy or zzz; + it complies with the provisions defined in Table 5.3.12-1 of 3GPP TS ab.cde. +``` + +``` +Possible values are: +- ONE: Value One description +- TWO: Value Two description +``` + +### 5.3.13 Formatting of structured data types in query parameters + +Structured data types shall represent JSON objects or arrays. + +When used in query parameters of a URI, the following formatting shall be used: + +- JSON objects and arrays of JSON objects: they shall be formatted using the JSON syntax, which is specified in OpenAPI Specification [4] by including a "content:" block, and specifying the "application/json" media type, followed by the OpenAPI definition of the object. + +##### EXAMPLE: + +``` +- name: plmn-id + in: query + content: + application/json: + schema: + type: object + properties: + mcc: + type: string + mnc: + type: string +``` + +This results in the following formatting: + +``` +.../resource?plmn-id={"mcc":"123","mnc":"456"} +``` + +- Arrays of simple types: they shall be formatted using the OpenAPI "style" keyword set to "form" and the "explode" keyword set to "false". + +#### EXAMPLE: + +``` +- name: service-names + in: query + style: form + explode: false + schema: + type: array + items: + type: string +``` + +This results in the following formatting: + +``` +.../resource?service-names=service1,service2,service3 +``` + +As described in 3GPP TS 29.500 [2], clause 5.2.10, when the URI is composed, it shall escape (percent-encode) certain "reserved" characters. When an array of strings is formatted with "explode: false" keyword, the COMMA (U+002C) character is used as separator of the different string values; this implies that this character (the value separator) shall not be escaped, while any other comma used inside the different string values shall be escaped (percent-encoded). + +### 5.3.14 Attribute Presence Conditions + +In an OpenAPI Specification [4], presence conditions for attributes in a JSON schema definition shall be expressed by using the "required" keyword, indicating a list (array) of attributes that shall always be present in an object conforming to such schema. + +The "required" keyword may be used as part of any of the expressions defined by OpenAPI to combine schemas ("oneOf", "anyOf", "allOf", "not"). + +#### EXAMPLES: + +- JSON object defining attributes "a" and "b", of type integer, where attribute "a" shall always be present: + +``` +components: + schemas: + ExampleType1: + type: object + required: [ a ] + properties: + a: + type: integer + b: + type: integer +``` + +- JSON object defining attributes "a" and "b", of type integer, where at least one of them, or both, shall be present: + +``` +components: + schemas: + ExampleType2: + type: object + anyOf: + - required: [ a ] + - required: [ b ] + properties: + a: + type: integer + b: + type: integer +``` + +- JSON object defining attributes "a" and "b", of type integer, where at least one of them shall be present, but not both: + +``` +components: + schemas: + ExampleType3: + type: object + oneOf: + - required: [ a ] + - required: [ b ] + properties: + a: + type: integer + b: + type: integer +``` + +- JSON object defining attributes "a" and "b", of type integer, where "a" and "b" can be both absent but, if one of them is present, the other shall be absent: + +``` +components: + schemas: + ExampleType4: + type: object + not: + required: [ a, b ] + properties: + a: + type: integer + b: + type: integer +``` + +- JSON object defining attributes "a" and "b", of type integer, where "b" shall be present if "a" takes a given value (e.g., value 1), but may be absent otherwise: + +``` +components: + schemas: + ExampleType5: + type: object + properties: + a: + type: integer + b: + type: integer + anyOf: + - not: + required: [ a ] + properties: + a: + type: integer + enum: [ 1 ] +``` + +- required: [ b ] +- JSON object defining attributes "a" and "b", of type integer, where "b" shall be present if and only if "a" takes a given value (e.g., value 1): + +``` +components: + schemas: + ExampleType6: + type: object + properties: + a: + type: integer + b: + type: integer + oneOf: + - required: [ a ] + properties: + a: + type: integer + enum: [ 1 ] + - not: + required: [ b ] +``` + +- JSON object defining attributes "a", "b", "c" and "d", of type integer, where none of the pairs ("a" and "b") and ("c" and "d") shall be present: + +``` +components: + schemas: + ExampleType7: + type: object + properties: + a: + type: integer + b: + type: integer + c: + type: integer + d: + type: integer + allOf: + - not: + required: [ a, b ] + - not: + required: [ c, d ] +``` + +NOTE: Object schema definitions should not have property names in the "required" attribute for which a corresponding property definition does not exist. + +### 5.3.15 Usage of the "tags" field + +In an OpenAPI specification, all HTTP operations belonging to the same resource should include a "tags" field containing a same value, briefly describing that resource (e.g. using the name of the resource and its archetype). This results in all operations being grouped by the User Interface of OpenAPI tools, which helps with readability of the API documentation. + +#### EXAMPLE: + +``` +openapi: 3.0.0 +(...) +paths: + /nf-instances/{nfInstanceID}: + get: + summary: Read the profile of a given NF Instance + operationId: GetNFInstance + tags: + - NF Instance ID (Document) + (...) + put: + summary: Register a new NF Instance + operationId: RegisterNFInstance + tags: + - NF Instance ID (Document) + (...) + patch: +``` + +``` + +summary: Update NF Instance profile +operationId: UpdateNFInstance +tags: + - NF Instance ID (Document) +(...) + +``` + +### 5.3.16 Security + +As indicated in 3GPP TS 33.501 [22] and 3GPP TS 29.500 [2], the access to an 5GC API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [23]), based on local configuration. 5GC APIs thus need to support the OAuth2 protocol. + +To reflect this, the OpenAPI specification file of an API shall contain: + +- a top-level "security" field, that applies to the overall API unless overridden by a resource/operation-level "security" field, listing as alternatives: + - i) "{}" to indicate that usage of security is optional; and + - ii) the name of the security scheme for OAuth2, including in the array of scopes the name of the API as the only scope; and optionally +- a resource/operation-level "security" field, that applies to a specific operation on a specific resource, and overrides the top-level "security" field, listing as alternatives: + - i) "{}" to indicate that usage of security is optional; and + - ii) the name of the security scheme for OAuth2, including in the array of scopes the name of the API as the only scope, and + - iii) the name of the security scheme for OAuth2, including in the array of scopes the name of the API and the name of one scope to be used to invoke the specific resource/operation, and optionally + - iv) the name of the security scheme for OAuth2, including in the array of scopes the name of the API and the names of two scopes to be used to invoke the specific resource/operation, and + +NOTE: the option iv) can be used e.g. to define one scope for a set of specific resources, and a second scope for a specific operation within the set. + +- a "securitySchemes" field in the "components" clause defining a security schema for OAuth2 as follows: + - i) to be of type "oauth2"; and + - ii) with a "flows" field containing a "clientCredentials" field that contains: + - 1) a "tokenUrl" field pointing to the Access Token Request service provided by the NRF (see 3GPP TS 29.510 [18]); and + - 2) a "scopes" field defining all the different scopes applicable to this API, which includes the name of the corresponding API (using the format used within URIs of that API) to be used as the scope required to get access to the overall API, and also including those resource/operation-level scopes to be used as scopes required to invoke a specific operation on a specific resource. + +The naming of the resource/operation-level scopes should consist of the concatenation of the service name, a string or sequence of strings representing a resource name or set of resource names or custom operation, and optionally a string indicating the type of access (e.g. read/modify/create), separated by the ":" (colon) character. + +Such last string component of the resource/operation-level scope, that represents the type of access for a resource, should comply with the following principles: + +- "read": for GET operations for any resource archetype, +- "create": for POST or PUT operations that result in a creation of new resources from a collection or store resource, + +- "modify": for PUT, PATCH or DELETE operations that result on an update or deletion of a document resource, +- "invoke": for POST operations that result in the invocation of a custom operation +- "write": for any operation that results in creation, modification or deletion of resource representations. + +#### Example 1: + +``` +security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + +paths: + /nf-instances: + get: + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:nf-instances:read + parameters: + (...) + responses: + (...) + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnrf-nfm: Access to the Nnrf_NFManagement API + nnrf-nfm:nf-instances:read: Read access to the NF Instances (Collection) resource +``` + +#### Example 2: + +``` +security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + +paths: + /exposure-data/{ueId}/access-and-mobility-data: + get: + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:read + parameters: + (...) + responses: + (...) + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nudr-dr: Access to the Nudr_DataRepository API + nudr-dr:exposure-data: Access to the ExposureData data set +``` + +nudr-dr:exposure-data:read: Access to read ExposureData + +### 5.3.17 Reuse of Structured Data Types + +As indicated in clause 5.2.4.1, common data types can be defined in 3GPP TS 29.571 [5], in order to avoid the duplication of data type definitions across multiple APIs. + +When such data types are of type object, a given API may require that the common data type is extended with additional attributes, on top of those from the original definition in 3GPP TS 29.571 [5]. + +In such case, the new data type in that API should not re-define entirely the common data type, and instead, it should use appropriate constructs in OpenAPI (i.e. the "allOf" keyword) to indicate that the new data type contains all the attributes from the common data type, by referencing to it, and indicate the additional attributes needed in the new data type. + +#### EXAMPLE: + +The ProblemDetails data type is defined in 3GPP TS 29.571 [5] as: + +``` +ProblemDetails: + type: object + properties: + type: + $ref: '#/components/schemas/Uri' + title: + type: string + status: + type: integer + detail: + type: string + instance: + $ref: '#/components/schemas/Uri' + cause: + type: string + invalidParams: + type: array + items: + $ref: '#/components/schemas/InvalidParam' + minItems: 1 +``` + +Then, if a given API needs to extend ProblemDetails with an additional attribute, e.g. "action" of type string, it should define, e.g. an ExtendedProblemDetails data type as follows: + +``` +ExtendedProblemDetails: + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/ProblemDetailsExtension' + +ProblemDetailsExtension: + type: object + properties: + action: + type: string +``` + +### 5.3.18 Operation identifiers + +Service operations defined in an OpenAPI specification file should be assigned an Operation ID. + +#### EXAMPLE: + +``` +get: + operationId: ReadInfo + summary: Read Information. + tags: + - Information (Document) + parameters: + - name: infoType + in: path + description: Requested information Type + required: true + schema: + type: string +``` + +(...) + +### 5.3.19 Formatting of description fields + +As indicated in OpenAPI Specification [4], "description" fields support the CommonMark Markdown formatting (see ). + +In the 3GPP APIs, a description field may consist of multiple lines of YAML text; in order to have a proper output formatting (i.e., to be correctly rendered by tooling producing, e.g., HTML-based content), they should be documented as follows: + +- If line breaks need to be kept in the output formatting, this shall be indicated by two trailing white spaces (see ). Those are represented in the example below as gray-shaded non-break spaces for illustration purposes, but the YAML file shall contain two normal white spaces: + +``` +description: | + Text in the first line.    + More text in the second line.    + Additional text in the third line. +``` + +- If the text in the different lines should be formatted as a bulleted HTML list, each line may be prepended by the hyphen "-" character, as follows: + +``` +description: | + Text in the first line: + - List item 1 + - List item 2 +``` + +- If the text should be displayed in the output formatting as a single line, the YAML file may be formatted using one of the following options: + +- All text in a single YAML line, following the "description" keyword, such as: + +``` +description: This is a long description text that is formatted as a single YAML line, which is correct, but may not be optimal when the YAML file is displayed on a text editor configured to not automatically wrap long lines. +``` + +- The "description" keyword is followed by the ">" character and the text is placed in different lines (this option should be the preferred approach, rather than having extremely long lines in the YAML file), such as: + +``` +description: > + This text is the first part of a single line, + followed by this second line, + where all these 3 lines will be displayed in the same line in the output formatting. +``` + +# --- 6 Requirements for secure API design + +## 6.1 Introduction + +This clause contains a list of security requirements for API design provided by SA3. + +## 6.2 General + +The following requirements are intended as general guidance for 3GPP Stage 3 work in order to specify secure protocols and APIs. As such, these guidelines are independent of the specific technology and shall be followed at all times. + +- The valid format and range of values (when applicable) for each IE shall be defined unambiguously. + +NOTE 1: Explicitly defining format and range of values not only helps to improve the security of a certain implementation, but also allows for reliable interoperability between different protocol implementations. Example: Defining a "lowercase string variable of length 10 and range [a..z]" is much more explicit than just defining a "string of length 10". There are known vulnerabilities such as a denial of service (resulting in the parser converting from a string representing an integer – an attacker can pass in an arbitrarily large integer and trigger an unhandled exception) and such leading to a heap corruption and crash (proof-of-concept available), or potentially remote code execution (no proof-of-concept known). Unicode literals also require special treatment when doing string comparisons to ensure that equivalent strings return true when compared. + +- For each message the number of leaf IEs shall not exceed 2048K. If a leaf IE is an array of a simple data type, then the whole array shall count as one leaf. If a leaf IE is a data structure or an array of data structures, then it shall be considered a branch, i.e. it shall not be counted as a leaf. The data structure's (branch) attributes determine the number of leaves. For instance, a data structure with e.g. three attributes will count as three leaves. +- The maximum size of the JSON body of any HTTP request/response shall not exceed 16 million octets before compression is applied, if any. + +NOTE 2: APIs need to be designed taking care to avoid a too large HTTP payload size for performance reasons. + +- The maximum nesting depth of leaves shall not exceed 32. If a leaf IE is an array of a simple data type, then the whole array shall be considered as the first level of nesting. If a leaf IE is a data structure or an array of data structures, then it shall be considered a branch and the first level of nesting. The data structure's attributes (leaves) shall be considered as the second level of nesting. For instance, a data structure with e.g. one attribute-A, which is also a data structure with e.g. one attribute-B, then attribute-B will make the third level of nesting. + +NOTE 3: There are resource exhaustion attacks on JSON parsers. Defined maximum numbers of IEs, sizes and nesting depths allow implementations to know an upper bound of required resources. It also allows validation of incoming messages. Recursively processing nested objects leads to stack exhaustion and a denial of service bug. + +- For data structures where values are accessible using names (sometimes referred to as keys), e.g. a JSON object, the name shall be unique. The occurrence of the same name (or key) twice within such a structure shall be an error and the message shall be rejected. + +NOTE 4: Serialization schemes (e.g. JSON) can leave the handling of repeated names (keys) up to the implementer's discretion. For example, for a repeated name an error can be raised, the pair can be ignored, or the first or last value read can be used, though there is no canonical order in which a parser should treat the data it receives. Failure to adhere to consistent handling rules can lead to vulnerabilities. From a security perspective rejecting objects with repeated names, rather than accepting according to some rule, is the more robust solution, and aids in identification of potentially malicious activity. There are known attacks with specially crafted malicious messages that are designed to confuse implementations of NFs to get fraudulent messages into a PLMN. + +## 6.3 SBA-specific requirements + +The following requirements shall be considered for every network function that implements a service-based interface. + +- OpenAPI specifications are machine-readable JSON objects and can be used as the basis for re-configuring an NFs action when an API or message structure changes. Therefore, each OpenAPI specifications shall contain all necessary information to correctly and unambiguously parse the contents of the message body. + +NOTE: Attacks often exploit corner cases and unspecified behavior in order to exploit a system. Traffic normalization counters this by either dropping traffic that is malformed or by forcing certain information elements to a "normal" value. Typically, this relates to inconsistent fields. + +- 3GPP TS 33.501 [22] documents which type of information shall be confidentiality protected on the N32 interface. The fields where these types of information (e.g. SUPI) is contained may have different names. Even if the field names are different, the mechanism specified in clause 5.2.3.3 of 3GPP TS 29.573 [24] shall clearly identify the type of information carried in each IE and which information types shall be confidentiality protected. + +# --- Annex A (informative): TS Skeleton Template + +A TS Skeleton Template to be used as a starting point of drafting a 5G System SBI Stage 3 specification is available at the following location: + +[https://www.3gpp.org/ftp/information/All\\_Templates/29.xxx-SBI-Stage3-Template.zip](https://www.3gpp.org/ftp/information/All_Templates/29.xxx-SBI-Stage3-Template.zip) + +# --- Annex B (informative): Backward Incompatible Changes + +This Annex provides information about the changes in the API that are considered as backwards compatible and those that are considered as backwards incompatible. This list is to be considered informative and it may be expanded in future releases, when necessary. + +Backward compatible changes are additions or changes in the API that do not break the existing Service Consumer behaviour. Examples of backward compatible changes include: + +- Adding a new, optional child resource/URI; +- Supporting a new HTTP method; +- Adding new elements to a resource representation; +- Changing the order of fields in a resource representation; +- Addition of a new status code: + +NOTE 1: When a NF / NF Service receives a HTTP status code that it cannot recognize it will treat it as the corresponding x00 status code as specified in clause 5.2.7.3 of 3GPP TS 29.500 [2]. + +- Corrections of obvious errors in an OpenAPI file required to enable a correct parsing of the file such as misspelled references; +- Corrections that only relate to smaller and optional parts of the functionality (e.g. a supported feature, see 3GPP TS 29.500 [2] clause 6.6.2), even if the changes are backward incompatible with respect to that part of the functionality; and + +NOTE 2: It is recommended to only apply corrections which are also backward compatible with respect to such smaller and optional parts of the functionality. If this is not possible a new supported feature can be introduced to enable a negotiation of the support of the correction, and the old corresponding supported feature can be marked as "withdrawn" in the table defining the supported features of an API. + +- Backward-compatible changes related to the semantics (i.e. functional behaviour) specified for an API. + +Changes in the API that do not result in any loss of existing functionality (i.e. functionality that works fine if both consumer and provider do not support the change) if only consumer or only provider implements the change can be considered as backwards compatible corrections or additions. + +Backward incompatible changes are additions or changes in the API that break the existing Service Consumer behaviour. Here is a list of backward incompatible changes that shall require incrementing the 1st field (MAJOR) of the API version number unless they only relate to smaller and optional parts of the functionality (see above): + +- Removing a resource/URI; +- Removing support for an HTTP method; +- Renaming a field in a resource representation; +- Adding mandatory parameters to a resource URI or resource representation; + +- Attribute data type changes; +- Cardinality changes (NOTE 3); and + +NOTE 3: Whether attribute cardinality changes are backward compatible depend on the type of change. Examples of non-backward compatibility changes include decreasing the upper bound of a cardinality range for attributes sent by the NF service consumer, changing the meaning of the default behavior associated to the absence of an attribute of cardinality 0..N, etc. + +- Backward incompatible changes related to the semantics (i.e. functional behaviour) specified for an API. + +Changes in the API that result in loss of existing functionality (i.e. functionality that works fine if both consumer and provider do not support the change) if only consumer or only provider implements the change can be considered as backwards incompatible modifications. + +When a change although being categorised as backwards compatible correction or addition results in interoperability issues, it is expected that the issue will be resolved by implementing the change at both consumer and provider. + +# --- Annex C (Informative): Resource modelling + +## C.0 General + +When designing an API, one shall first think of defining the set of resources consumed. Resources represent objects that are modified by standard HTTP methods and that can be modelled with one of 4 archetypes detailed below. Resource archetypes help API designers to structure the resources. In this process the designer should refer to the appropriate archetype when the resource definition perfectly matches the archetype one. Referring to an archetype immediately defines what operations and HTTP methods are supported by the resource. + +The archetypes provided hereafter don't preclude the existence of resources of different types. + +## --- C.1 Document + +The document archetype is the conceptual base archetype of the other ones. Any resource that is not identified with one of the other resource archetypes is a document. + +A document may have child resources that represent its specific subordinate concepts. + +The archetype does not place any restriction on HTTP methods when acting on a document. + +Only CRUD operations are performed directly on a document resource, i.e. by sending an HTTP request to the URI of that resource. Custom methods are not performed directly on the resource, but by sending an HTTP request to a URI that is associated by a convention with the URI of the resource. + +## --- C.2 Collection + +The collection archetype can be used to model a resource that serves as a directory of resources. A collection is NF Service Provider-managed so the NF Service Provider decides the URIs of each resource that is created in the collection. + +NOTE: Even though a collection resource typically contains child resources, it is allowed that a particular collection resource does not contain any child resource at a particular point in time ("empty collection"). + +The Create and Read operations are performed on a collection directly. + +More specifically: + +- A collection child resource is created by sending a POST with the collection URI if accepted by the collection; +- A collection is read by sending a GET with the collection URI; +- The PUT and PATCH methods with the collection URI are not allowed; +- The DELETE method with the collection URI is only allowed if the collection resource has been created dynamically based on a request from the NF Service Consumer. +- The authorized operations on a collection child resource depend on that resource's archetype. + +## --- C.3 Store + +The store archetype can also be used to model a resource that serves as a directory of resources but a store is NF Service Consumer-managed. The NF Service Consumer solely decides what resource shall be added to / deleted from a store. The NF Service Consumer decides what the URI of the added resource is. + +NOTE: Even though a store resource typically contains child resources, it is allowed that a particular store resource does not contain any child resource at a particular point in time ("empty store"). + +The Read operation is performed on a store directly, and the Create operation is performed on store child resources. + +More specifically: + +- A store child resource is created by sending a PUT with the URI of the child resource to be created. +- A store is read by sending a GET with the store URI; +- The POST, PUT and PATCH methods with the store URI are not allowed; +- The DELETE method with the store URI is only allowed if the store resource has been created dynamically based on a request from the NF Service Consumer. +- Apart from Create (PUT), the authorized operations on a store child resource depend on that resource's archetype. + +## --- C.4 Custom operation + +The custom operation archetype can be used to model an unsafe and non-idempotent operation that is not a Create on a collection. + +A custom operation does not operate directly on the resource that would be identified by the custom operation URI. Instead, when the custom operation is associated with a resource, the operation is performed on this associated resource. For instance, a custom operation may modify the associated resource in a special way. This associated resource is identified by stripping the suffix string "" from the custom operation URI template in clause 4.4.2. + +When the custom operation is not associated with any resource but with the service, it acts as an executable function with input parameters and returns the result of the executed function in the response body, not modifying any resource. + +POST is the only method allowed with a custom operation URI. + +The semantic of the custom operation is encoded in the last segment of the URI template in clause 4.4.2: +/{custOpName}. + +# Annex D (informative): Example of an OpenAPI specification file for Patch + +As described in clause 4.6.1.1.3.2, the bodies of HTTP PATCH requests will either use a "JSON Merge Patch" encoding as defined in IETF RFC 7396 [7], or a "JSON Patch" encoding as defined IETF RFC 6902 [8]. This annex provides an example OpenAPI Specification [4] allowing both encodings. + +NOTE: Both encoding possibilities are shown in this example for illustrative purposes. However, only a single of the above encodings will be specified for each resource where the PATCH method is supported unless backward compatibility considerations necessitate the support of both encodings. + +``` +openapi: 3.0.0 + +info: + version: "1.0.0" + title: PATCH Example + +paths: + /inventory: + post: + summary: adds an inventory item + operationId: addInventory + description: Adds an item to the system + responses: + '201': + description: item created + '400': + description: 'invalid input, object invalid' + '409': + description: an existing item already exists + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItem' + description: Inventory item to add + + /inventory/{id}: + get: + summary: read inventory item + parameters: + - name: id + in: path + required: true + schema: + type: integer + responses: + '200': + description: search results matching criteria + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItem' + '400': + description: bad input parameter + patch: + summary: patch inventory item + parameters: + - name: id + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/PatchInventoryItem' + application/merge-patch+json: + schema: + $ref: '#/components/schemas/MergePatchInventoryItem' + responses: + '200': +``` + +``` + description: Patch was successfull and updated Inventory Item is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItem' + '204': + description: Patch was successfull + '400': + description: bad input parameter + +components: + + schemas: + InventoryItem: + type: object + required: + - name + - manufacturer + properties: + id: + type: integer + name: + type: string + manufacturer: + $ref: '#/components/schemas/Manufacturer' + customers: + type: array + items: + type: string + + Manufacturer: + type: object + description: Represents the manufacturer. + required: + - name + properties: + name: + type: string + homePage: + type: string + format: url + phone: + type: string + + ManufacturerRm: + type: object + description: > + This data type is defined in the same way as the "Manufacturer" data type, + but with the OpenAPI "nullable: true" property. + required: + - name + properties: + name: + type: string + homePage: + type: string + format: url + phone: + type: string + nullable: true + + PatchInventoryItem: + type: array + description: A JSON PATCH body schema to Patch selected parts of an Inventory Item + items: + anyOf: + - oneOf: + - type: object + description: Modifies the URL of a Manufacturer + properties: + op: + type: string + enum: + - "add" + - "remove" + - "replace" + path: +``` + +``` + + type: string + pattern: '^/manufacturer/homePage$' + value: + type: string + format: url + required: + - "op" + - "path" + - type: object + description: Modifies a Manufacturer + properties: + op: + type: string + enum: + - "replace" + path: + type: string + pattern: '^/manufacturer$' + value: + $ref: '#/components/schemas/Manufacturer' + required: + - "op" + - "path" + - "value" + - type: object + description: Modifies a Customer + properties: + op: + type: string + enum: + - "add" + - "remove" + - "replace" + path: + type: string + pattern: '^/customers/(-|\d+)$' + value: + type: string + required: + - "op" + - "path" + - type: object + description: Open Alternative + minItems: 1 + +MergePatchInventoryItem: + description: A JSON Merge PATCH body schema to Patch selected parts of an Inventory Item + type: object + properties: + manufacturer: + $ref: '#/components/schemas/ManufacturerRm' + customers: + type: array + description: Allows to replace the entire array, but not to modify individual elements. + items: + type: string + +``` + +# --- Annex E (Informative): Considerations for handling of JSON arrays + +This Annex provides guidelines on the use of JSON arrays on the SBI APIs of the 5GC. + +As described in clause 5.2.4, the data model of an API definition in a 5GC API consists of any of the different data types supported by OpenAPI, corresponding to the different data structures found in the JSON data format. One of these structures is the "array", representing a set of ordered values. + +It should be noted that, while JSON allows that the value of the elements of an array may be of different types, in OpenAPI Specification [4] this is further restricted, and all elements of an array shall be of the same type. + +Also, it is important to note that the JSON format itself, as specified in IETF RFC 8259 [3], does not define any syntax to refer to specific array elements. + +However, there are certain conventions to specify mechanism to refer to array elements, e.g. based on the position a given element has in the array. + +In particular, the JSON Pointer syntax defines a string syntax for identifying a specific value within a JSON document. This syntax consists of a number of tokens separated by the "/" character; in order to refer to a specific element in an array, then token shall contain an unsigned decimal value, indicating the zero-based index of the element in the array. + +### EXAMPLE: + +JSON document: + +``` +{ + "attr1": 0, + "attr2": true, + "attr3": [ 1, 2, 3 ] +} +``` + +JSON Pointer expression "/attr3/0" evaluated on such JSON document: 1 + +There are several scenarios, frequently employed in the 5GC APIs, that make use of the JSON Pointer mechanism to refer to specific elements in an array: + +- Update of resources using the PATCH method, as described in clause 4.6.1.1.3.2. If the syntax used in the PATCH request payload is based on the "JSON Patch" format, then the JSON Pointer mechanism is used to specify patch operations applied to specific array elements. +- Notifications of events (such as data changes), as described in clause 4.6.2.3, using as notification payload the notation defined in "NotifyItem" / "ChangeItem" data types defined in 3GPP TS 29.571 [5]. This notation is similar to "JSON Patch", so it also makes use of the JSON Pointer syntax to refer to specific array elements. +- Explicit usage of attributes containing JSON Pointer expressions in request or response payloads. + +In these scenarios, it is critical that any JSON Pointer expression is applied by both client and server on the exact same array representation, since otherwise the indexes may vary, and the JSON Pointer will give unexpected results. + +A typical scenario that may create issues could be as follows: + +1. NF Service Consumer sends a first GET request towards a NF Service Producer, including certain query parameters in the HTTP request, that result into retrieving a resource representation that contains a subset of the data that the NF Service Producer holds under such resource. When such subset refers to returning just some of the elements of an array, rather than the entire array, then the content of the array will differ between consumer and producer. +- 2a. The NF Service Consumer sends a subsequent PATCH request towards the NF Service Producer, with the intention to modify a given element of the array (specified by the array index, per the JSON Pointer syntax). This results into the server modifying a wrong element in the array, given that the NF Service Producer contains a different array. +- 2b. The NF Service Consumer may subscribe to be notified by the NF Service Producer when a given resource representation has changed. When the NF Service Producer detects such a change, it sends a notification that may include a reference to an array index, which may be different than the array index kept by the NF Service Producer. +- 2c. The NF Service Consumer is a stateless NF Service Consumer that has no local representation of the array that subscribes to be notified by the NF Service Producer when a given resource representation has changed. + +Another scenario that may lead to incorrect array updates is: + +1. Two different NF Service Consumer sends a GET request towards a NF Service Producer to retrieve the representation of a certain resource. +2. A first NF Service Consumer NF1 sends a PATCH request towards the NF Service Producer, with the intention to delete a given element of the array (specified by the array index, per the JSON Pointer syntax). This results in some of the array indexes being changed (of those elements placed after the deleted element) + +3. A second NF Service Consumer NF2, sends another PATCH request towards the NF Service Producer, to modify any of the elements of the array whose index was affected by the previous operation done by NF1. This results in modifying unintentionally the wrong array element. + +The design of 5GC SBI APIs should take into account these scenarios and provide mechanisms to avoid unintended modifications of array elements, when they are referred by their position index in the array. + +To achieve these, both NF Service Consumer and Producer (taking the role of HTTP client and server) should ensure that any resource update takes place on a known and current resource representation, based on the content of ETag values sent along with resource representations by the resource owner. + +If an NF Service Consumer needs to cache a resource representation received from an NF Service Producer (i.e. the JSON information received in an HTTP response message), it shall use the exact same representation of arrays as received from the service producer. + +When sending notifications or modifications whose semantics is based on the JSON Pointer syntax, the sending NF shall use the exact same representation of arrays as previously signalled in a previous interaction with the receiver of such notifications/modifications. Further, when sending notifications whose semantics is based on the JSON Pointer syntax, if the NF Service Consumer is a stateless NF Service Consumer and thus has no local representation of the array, the NF Producer shall use the complete replacement array representation as the NF Service Consumer is otherwise required to request the complete data from the NF Service Producer with a GET request. + +# Annex F (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|---------|-----|-----------------------------------------------|----------------| +| Date | Meeting | TDoc | CR | R
ev | Cat | Subject/Comment | New
version | +| 2017-10 | CT4#80 | C4-175250 | | | | TS skeleton | 0.1.0 | +| 2017-10 | CT4#80 | C4-175358
C4-175252
C4-175253
C4-175254
C4-175255
C4-175331
C4-175332
C4-175333
C4-175334
C4-175359
C4-175327
C4-175328
C4-175360
C4-175330
C4-175336
C4-175337 | | | | Inclusion of pCRs agreed at CT4#80 | 0.2.0 | +| 2017-12 | CT4#81 | C4-176414
C4-176372
C4-176447
C4-176415
C4-176416
C4-176417
C4-176418
C4-176250
C4-176419
C4-176422 | | | | Inclusion of pCRs agreed at CT4#81 | 0.3.0 | +| 2018-01 | CT4#82 | C4-181179
C4-181384 | | | | Inclusion of pCRs agreed at CT4#82 | 0.4.0 | +| 2018-03 | CT4#83 | C4-182396
C4-182397
C4-182394
C4-182395
C4-182399
C4-182261
C4-182184
C4-182330
C4-182398
C4-182332 | | | | Inclusion of pCRs agreed at CT4#83 | 0.5.0 | +| 2018-03 | CT#79 | CP-180029 | | | | Presented for information | 1.0.0 | +| 2018-04 | CT4#84 | C4-183238
C4-183288
C4-183289
C4-183291
C4-183292
C4-183385
C4-183387
C4-183388
C4-183477
C4-183478 | | | | Inclusion of pCRs agreed at CT4#84 | 1.1.0 | +| 2018-05 | | | | | | 29.xxx-SBI-Stage3 Template added in zip-file. | 1.1.1 | +| 2018-05 | CT4#85 | C4-184492
C4-184493
C4-184494
C4-184495
C4-184496
C4-184544
C4-184614
C4-184503
C4-184497
C4-184592 | | | | Inclusion of pCRs agreed at CT4#85 | 1.2.0 | +| 2018-06 | CT#80 | CP-181099 | | | | Presented for approval | 2.0.0 | +| 2018-06 | CT#80 | | | | | Approved in CT#80. | 15.0.0 | +| 2018-07 | | | | | | TS template added in zip-file | 15.0.1 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------------------------------|--------| +| 2018-09 | CT#81 | CP-182054 | 0001 | 4 | B | Security requirements for API design | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0002 | | F | Example URIs in figures | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0003 | 2 | F | Clarification on the use of API version number | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0004 | 2 | F | External Docs Clause in OpenAPI file | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0006 | 1 | B | JSON Structures in Query Parameters | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0008 | 1 | F | Servers Selection in OpenAPI | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0009 | | F | Query Parameter | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0010 | | F | yaml file names | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0011 | | F | OpenAPI servers field | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0012 | 1 | F | Query parameter | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0013 | 1 | F | presence condition and cardinality | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0014 | 1 | F | Clarification on Naming Conventions and Digits | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0015 | 1 | F | URIs of created resources | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0016 | 1 | F | Custom operation in resource structure presentation | 15.1.0 | +| 2018-12 | CT#82 | CP-183012 | 0018 | 2 | F | Attribute Presence Conditions | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0019 | 1 | F | Version addressed by references within OpenAPI files | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0020 | 2 | F | Resolve Editor's Note | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0021 | | F | Attribute with Any Type | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0022 | | F | Incorrect resource URI structure presentation | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0023 | 1 | F | Storage of OpenAPI files within a central directory | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0025 | 3 | F | Complex query expression | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0031 | 1 | F | Correction and Clarification on Security Requirements | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0032 | 2 | R | Subscription Lifetime for Subscribe / Notify operations | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0033 | | F | Usage of the "tags" field in OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0035 | 2 | F | Corrections to API versioning | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0036 | 1 | F | Security in Open API specification files | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0037 | 1 | F | Custom Operations | 15.2.0 | +| 2019-03 | CT#83 | CP-190017 | 0039 | 2 | F | Address Editor's Note on implicit subscriptions | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0040 | | F | Address Editor's Note on partial representation in POST response | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0041 | 1 | F | Maximum HTTP payload size | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0042 | 1 | F | HTTP Scheme | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0043 | 2 | F | Resolve Editor's Notes | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0044 | | F | Correction to Minor Field Increment Rules in API Versioning | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0045 | 1 | F | Handling of unknown attributes during resource creation and modification | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0046 | 1 | F | Correct use of "OpenAPI" name | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0047 | 1 | F | Resolution of Editor's Notes in Annex C | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0048 | 2 | F | IANA registration of "3gppHal+json" media type | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0049 | 1 | F | Addition of applicability column to query parameters table | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0050 | 1 | F | Removing multiple redundant appearances of major version number in TS template to ease update of that number | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0051 | 2 | F | Storage of OpenAPI specification files | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0052 | - | F | Use of Relative URI in Location Header | 15.3.0 | +| 2019-06 | CT#84 | CP-191028 | 0053 | 2 | F | Criteria for non-backward compatible changes | 15.4.0 | +| 2019-06 | CT#84 | CP-191028 | 0056 | 1 | F | Reuse of Structured Data Types | 15.4.0 | +| 2019-06 | CT#84 | CP-191028 | 0057 | 1 | F | Delete editor's note on complex query | 15.4.0 | +| 2019-06 | CT#84 | CP-191028 | 0059 | - | F | Correction on Notifications | 15.4.0 | +| 2019-06 | CT#84 | CP-191028 | 0060 | 1 | F | Copyright Note in YAML files | 15.4.0 | +| 2019-06 | CT#84 | CP-191028 | 0055 | 2 | F | Precedence of OpenAPI file | 15.4.0 | +| 2019-06 | CT#84 | CP-191028 | 0054 | 4 | F | Withdrawing API versions | 15.4.0 | +| 2019-06 | CT#84 | CP-191057 | 0061 | 2 | F | Updates to TS Template for SBI | 16.0.0 | +| 2019-09 | CT#85 | CP-192101 | 0065 | 1 | F | Externaldoc version number change | 16.1.0 | +| 2019-12 | CT#86 | CP-193025 | 0069 | 2 | A | Fourth field of API versions | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0070 | 1 | F | Add Corresponding API descriptions in clause 5.1 | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0066 | 2 | B | HAL-forms media type | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0067 | 1 | F | Extending ProblemDetails for Backward Compatibility | 16.2.0 | +| 2020-03 | CT#87e | CP-200054 | 0072 | 1 | F | Storage of YAML files in ETSI Forge | 16.3.0 | +| 2020-03 | CT#87e | CP-200039 | 0073 | 1 | F | New tables in 29.501 template | 16.3.0 | +| 2020-06 | CT#88e | CP-201034 | 0074 | 2 | F | Clarifications to callback URI | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0075 | 1 | B | Resource-Level Authorization | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0077 | 2 | F | Delimiters - URI and SBI specific | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0078 | 2 | F | URI types | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0080 | - | F | Correct the Resource Tree Example | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0081 | 1 | F | Requirements for secure API design | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0079 | 1 | F | API URI correction and template update | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0082 | 1 | F | Maximum JSON payload size | 16.4.0 | +| 2020-06 | CT#88e | CP-201071 | 0076 | - | F | Correction of the method used for Notification | 16.4.0 | +| 2020-06 | CT#88e | CP-201071 | 0083 | 1 | F | Missing abbreviations | 16.4.0 | +| 2020-09 | CT#89e | CP-202043 | 0093 | - | A | Storage of YAML files in 3GPP Forge | 16.5.0 | +| 2020-09 | CT#89e | CP-202109 | 0085 | 2 | D | Editorial fixes | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0086 | 2 | F | Handling of JSON Arrays | 16.5.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------------------------------------|--------| +| 2020-09 | CT#89e | CP-202110 | 0087 | - | F | Naming requirements for resource/operation-level scopes | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0088 | 1 | F | Data types with string type | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0089 | - | F | Content of Location header when TLS is used | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0090 | - | F | Miscellaneous corrections | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0091 | 1 | F | API URI correction and template update | 16.5.0 | +| 2020-12 | CT#90e | CP-203064 | 0094 | - | F | API Versioning System based on Semantic Versioning | 17.0.0 | +| 2020-12 | CT#90e | CP-203064 | 0095 | - | F | OpenAPI Reference | 17.0.0 | +| 2020-12 | CT#90e | CP-203064 | 0096 | - | F | OpenAPI "description" fields in data type definitions | 17.0.0 | +| 2021-03 | CT#91e | CP-210027 | 0097 | - | D | Use of inclusive terminology | 17.1.0 | +| 2021-03 | CT#91e | CP-210021 | 0098 | - | F | Guidance on Error Response design for Indirect Communication | 17.1.0 | +| 2021-03 | CT#91e | CP-210021 | 0099 | 1 | B | SBI TS Template Update | 17.1.0 | +| 2021-03 | CT#91e | CP-210021 | 0101 | - | D | Editorial Corrections | 17.1.0 | +| 2021-03 | CT#91e | CP-210021 | 0102 | - | F | Withdrawing API versions | 17.1.0 | +| 2021-06 | CT#92e | CP-211065 | 0105 | - | A | Nested cardinality | 17.2.0 | +| 2021-06 | CT#92e | CP-211028 | 0103 | 1 | F | Change Notification of Array to Stateless NF Consumer | 17.2.0 | +| 2021-06 | CT#92e | CP-211028 | 0103 | 1 | B | Additional guidelines for OpenAPI specification files | 17.2.0 | +| 2021-09 | CT#93e | CP-212026 | 0107 | 1 | F | Compatibility Clarification | 17.3.0 | +| 2021-09 | CT#93e | CP-212026 | 0108 | 2 | F | Clarification to API name guidance in the SBI template | 17.3.0 | +| 2021-09 | CT#93e | CP-212026 | 0109 | 2 | F | Corrections to the API URI and relative URI below root concepts | 17.3.1 | +| 2021-12 | CT#94e | CP-213085 | 0110 | 1 | F | Miscellaneous clarifications | 17.4.0 | +| 2021-12 | CT#94e | CP-213087 | 0111 | 5 | F | Resource URI structure in the Guidelines for Services Definition | 17.4.0 | +| 2021-12 | CT#94e | CP-213086 | 0112 | 2 | F | Resource URI structure in the SBI skeleton | 17.4.0 | +| 2021-12 | CT#94e | CP-213086 | 0114 | - | F | Subscription update with PUT request | 17.4.0 | +| 2022-03 | CT#95e | CP-220023 | 0115 | 1 | F | Adding examples to the Resource URI structure clause | 17.5.0 | +| 2022-03 | CT#95e | CP-220023 | 0116 | 1 | F | Handling Description field along with the '\$ref' keyword | 17.5.0 | +| 2022-03 | CT#95e | CP-220023 | 0117 | 1 | F | Aligning SBI-Stage3-Template with TS 29.501 | 17.5.0 | +| 2022-03 | CT#95e | CP-220023 | 0118 | - | F | JSON schema example with a combination of restrictions | 17.5.0 | +| 2022-03 | CT#95e | CP-220024 | 0122 | - | F | URL Encoding | 17.5.0 | +| 2022-03 | CT#95e | CP-220024 | 0120 | 1 | D | Miscellaneous corrections to the 5GC SBI TS Skeleton | 17.5.0 | +| 2022-03 | CT#95e | CP-220025 | 0119 | 1 | F | Formatting of Description Fields | 17.5.0 | +| 2022-03 | CT#95e | CP-220025 | 0121 | 1 | F | Notification Clarification | 17.5.0 | +| 2022-06 | CT#96 | CP-221027 | 0123 | 1 | F | SBI stage 3 template update - OpenAPI | 17.6.0 | +| 2022-06 | CT#96 | CP-221027 | 0124 | 1 | F | SBI stage 3 template update - Data models | 17.6.0 | +| 2022-06 | CT#96 | CP-221027 | 0125 | - | F | Remove the apiVersion placeholder from the resource URI variables table | 17.6.0 | +| 2022-06 | CT#96 | CP-221028 | 0127 | - | F | OAuth2 clarification | 17.6.0 | +| 2022-06 | CT#96 | CP-221029 | 0126 | 1 | F | Default logical relationship between query parameters | 17.6.0 | +| 2022-09 | CT#97e | CP-222070 | 0129 | 1 | A | Essential Correction for Location Header in 201 Response | 17.7.0 | +| 2022-09 | CT#97e | CP-222026 | 0130 | 1 | F | Limits for number and length of query parameters | 17.7.0 | +| 2022-12 | CT#98e | CP-223027 | 0132 | - | F | Standalone Notifications | 18.0.0 | +| 2022-12 | CT#98e | CP-223029 | 0131 | 1 | F | Description fields in enumerations | 18.0.0 | +| 2023-03 | CT#99 | CP-230090 | 0137 | 2 | F | Maximum number of leaves | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0134 | 1 | D | Editorial modifications to the rules for incrementing API version | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0138 | 1 | F | Guidelines for OAuth2 scopes definition | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0139 | - | F | Correction of the NO-\$REF SIBLINGS error for nullable attributes within PATCH method | 18.1.0 | +| 2023-06 | CT#100 | CP-231026 | 0140 | 1 | B | Adding Redirection clause to SBI template | 18.2.0 | +| 2023-06 | CT#100 | CP-231027 | 0133 | 2 | F | Rules for incrementing API version field values | 18.2.0 | +| 2023-09 | CT#101 | CP-232033 | 0142 | 2 | B | Prefix in Callback URIs | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 0143 | - | B | Documentation of 3GPP Custom HTTP Headers | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 0144 | 1 | F | Correct SBI stage 3 template for custom operations without resources | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 0145 | - | B | Uptade of the template to add ABNF | 18.3.0 | +| 2023-12 | CT#102 | CP-233028 | 0148 | 1 | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233028 | 0149 | 1 | F | Update of SBI TS skeleton template | 18.4.0 | +| 2023-12 | CT#102 | CP-233030 | 0151 | - | F | Case-insensitive hexadecimal encoding | 18.4.0 | +| 2023-12 | CT#102 | CP-233056 | 0150 | 1 | B | Optional usage of 3GPP Forge as normative storage of OpenAPI files | 18.4.0 | +| 2023-12 | CT#102 | CP-233062 | 0147 | - | A | wrong CR implementation | 18.4.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29508/raw.md b/marked/Rel-18/29_series/29508/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..249a0b2d3f9975e465dd48f1ea69e2545397fcc6 --- /dev/null +++ b/marked/Rel-18/29_series/29508/raw.md @@ -0,0 +1,3133 @@ + + +# 3GPP TS 29.508 V18.4.0 (2023-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Session Management Event Exposure Service; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +## --- Keywords --- + +## **3GPP** + +## --- Postal address --- + +## 3GPP support office address --- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## Internet --- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Session Management Event Exposure Service ..... | 8 | +| 4.1 Service Description ..... | 8 | +| 4.1.1 Overview ..... | 8 | +| 4.1.2 Service Architecture ..... | 9 | +| 4.1.3 Network Functions ..... | 10 | +| 4.1.3.1 Session Management Function (SMF) ..... | 10 | +| 4.1.3.2 NF Service Consumers ..... | 10 | +| 4.2 Service Operations ..... | 11 | +| 4.2.1 Introduction ..... | 11 | +| 4.2.2 Nsmf_EventExposure_Notify Service Operation ..... | 11 | +| 4.2.2.1 General..... | 11 | +| 4.2.2.2 Notification about subscribed events..... | 11 | +| 4.2.3 Nsmf_EventExposure_Subscribe Service Operation ..... | 17 | +| 4.2.3.1 General..... | 17 | +| 4.2.3.2 Creating a new subscription..... | 17 | +| 4.2.3.3 Modifying an existing subscription ..... | 20 | +| 4.2.4 Nsmf_EventExposure_UnSubscribe Service Operation ..... | 21 | +| 4.2.4.1 General..... | 21 | +| 4.2.4.2 Unsubscription from event notifications..... | 22 | +| 4.2.5 Nsmf_EventExposure_AppRelocationInfo Service Operation ..... | 22 | +| 4.2.5.1 General..... | 22 | +| 4.2.5.2 Acknowledgement of Notification about subscribed events ..... | 22 | +| 5 Nsmf_EventExposure API..... | 23 | +| 5.1 Introduction ..... | 23 | +| 5.2 Usage of HTTP..... | 24 | +| 5.2.1 General ..... | 24 | +| 5.2.2 HTTP standard headers ..... | 24 | +| 5.2.2.1 General..... | 24 | +| 5.2.2.2 Content type..... | 24 | +| 5.2.3 HTTP custom headers ..... | 24 | +| 5.3 Resources ..... | 24 | +| 5.3.1 Resource Structure..... | 24 | +| 5.3.2 Resource: SMF Notification Subscriptions ..... | 25 | +| 5.3.2.1 Description..... | 25 | +| 5.3.2.2 Resource definition ..... | 25 | +| 5.3.2.3 Resource Standard Methods ..... | 25 | +| 5.3.2.3.1 POST ..... | 25 | +| 5.3.2.4 Resource Custom Operations..... | 26 | +| 5.3.3 Resource: Individual SMF Notification Subscription ..... | 26 | +| 5.3.3.1 Description..... | 26 | +| 5.3.3.2 Resource definition..... | 26 | +| 5.3.3.3 Resource Standard Methods ..... | 27 | +| 5.3.3.3.1 GET ..... | 27 | +| 5.3.3.3.2 PUT ..... | 28 | +| 5.3.3.3.3 DELETE..... | 29 | +| 5.3.3.4 Resource Custom Operations..... | 30 | +| 5.4 Custom Operations without associated resources ..... | 30 | +| 5.5 Notifications..... | 31 | + +| | | | +|--------------------------------------------------------|--------------------------------------------|-----------| +| 5.5.1 | General ..... | 31 | +| 5.5.2 | Event Notification ..... | 31 | +| 5.5.2.1 | Description..... | 31 | +| 5.5.2.2 | Target URI ..... | 31 | +| 5.5.2.3 | Standard Methods ..... | 31 | +| 5.5.2.3.1 | POST ..... | 31 | +| 5.5.3 | Acknowledgement of event notification..... | 32 | +| 5.5.3.1 | Description..... | 32 | +| 5.5.3.2 | Target URI ..... | 33 | +| 5.5.3.3 | Standard Methods ..... | 33 | +| 5.5.3.3.1 | POST ..... | 33 | +| 5.6 | Data Model..... | 34 | +| 5.6.1 | General ..... | 34 | +| 5.6.2 | Structured data types ..... | 37 | +| 5.6.2.1 | Introduction..... | 37 | +| 5.6.2.2 | Type NsmfEventExposure ..... | 38 | +| 5.6.2.3 | Type NsmfEventExposureNotification..... | 41 | +| 5.6.2.4 | Type EventSubscription..... | 42 | +| 5.6.2.5 | Type EventNotification..... | 43 | +| 5.6.2.6 | void. .... | 48 | +| 5.6.2.7 | Type AckOfNotify ..... | 48 | +| 5.6.2.8 | Type SmNasFromUe ..... | 48 | +| 5.6.2.9 | Type SmNasFromSmf ..... | 48 | +| 5.6.2.10 | Type TransactionInfo..... | 49 | +| 5.6.2.11 | Type PduSessionInformation..... | 49 | +| 5.6.2.12 | Type PduSessionInfo ..... | 49 | +| 5.6.2.13 | Type UpfInformation..... | 49 | +| 5.6.2.14 | Type: TrafficCorrelationNotification ..... | 50 | +| 5.6.3 | Simple data types and enumerations ..... | 50 | +| 5.6.3.1 | Introduction..... | 50 | +| 5.6.3.2 | Simple data types ..... | 50 | +| 5.6.3.3 | Enumeration: SmfEvent..... | 51 | +| 5.6.3.4 | Enumeration: NotificationMethod ..... | 51 | +| 5.6.3.5 | void. .... | 52 | +| 5.6.3.6 | Enumeration: AppliedSmccType..... | 52 | +| 5.6.3.7 | Enumeration: TransactionMetric ..... | 52 | +| 5.6.3.8 | Enumeration: PduSessionStatus ..... | 52 | +| 5.7 | Error handling ..... | 52 | +| 5.7.1 | General ..... | 52 | +| 5.7.2 | Protocol Errors..... | 52 | +| 5.7.3 | Application Errors ..... | 52 | +| 5.8 | Feature negotiation..... | 53 | +| 5.9 | Security..... | 55 | +| Annex A (normative): OpenAPI specification..... | | 56 | +| A.1 | General..... | 56 | +| A.2 | Nsmf_EventExposure API..... | 56 | +| Annex B (informative): Change history ..... | | 70 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present specification provides the stage 3 definition of the Session Management Event Exposure Service (Nsmf\_EventExposure) of the 5G System. + +The stage 2 definition and procedures of the Session Management Event Exposure Service are contained in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [6]. The 5G System Architecture is defined in 3GPP TS 23.501 [2]. + +Stage 3 call flows for policy and charging control use cases are provided in 3GPP TS 29.513 [7]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition of the 5G System are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +The Session Management Event Exposure Service is provided by the Session Management Function (SMF). This service exposes events related to PDU Sessions observed at the SMF. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System; Stage 2". +- [7] 3GPP TS 29.513: "5G System; Policy and Charging Control signalling flows and QoS parameter mapping; Stage 3". +- [8] IETF RFC 9113: "HTTP/2". +- [9] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [10] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [11] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [12] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [13] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". +- [14] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3". +- [15] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [16] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". + +- [18] IETF RFC 9457: "Problem Details for HTTP APIs". +- [19] 3GPP TR 21.900: "Technical Specification Group working methods". +- [20] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [21] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". +- [22] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [23] 3GPP TS 29.244: "Interface between the Control Plane and the User Plane of EPC Nodes". +- [24] 3GPP TS 29.122: "T8 reference point for Northbound APIs". +- [25] 3GPP TS 29.591: "5G System; Network Exposure Function Southbound Services; Stage 3". +- [26] 3GPP TS 29.564: "5G System; User Plane Function Services; Stage 3". +- [27] 3GPP TS 29.554: "5G System; Background Data Transfer Policy Control Service; Stage 3". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|------------------------------------------------| +| AF | Application Function | +| AMBR | Aggregate Maximum Bit Rate | +| AMF | Access and Mobility Management Function | +| API | Application Programming Interface | +| DCCF | Data Collection Coordination Function | +| DDD | Downlink Data Delivery | +| DNAI | DN Access Identifier | +| DNN | Data Network Name | +| EAS | Edge Application Server | +| FQDN | Fully Qualified Domain Name | +| GPSI | Generic Public Subscription Identifier | +| GUAMI | Globally Unique AMF Identifier | +| HTTP | Hypertext Transfer Protocol | +| H-SMF | Home SMF | +| I-SMF | Intermediate SMF | +| JSON | JavaScript Object Notation | +| NEF | Network Exposure Function | +| NF | Network Function | +| NID | Network Identifier | +| NRF | Network Repository Function | +| NSSAI | Network Slice Selection Assistance Information | +| NWDAF | Network Data Analytics Function | +| PCF | Policy Control Function | +| PRA | Presence Reporting Area | +| QFI | QoS Flow Identifier | + +| | | +|---------|-------------------------------------------------------| +| SMCC | Session Management Congestion Control | +| SMCCE | Session Management Congestion Control Experience | +| SMF | Session Management Function | +| SNPN | Stand-alone Non-Public Network | +| SUPI | Subscription Permanent Identifier | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| SSC | Session and Service Continuity | +| UDM | Unified Data Management | +| UPF | User Plane Function | +| V-SMF | Visited SMF | + +# --- 4 Session Management Event Exposure Service + +## 4.1 Service Description + +### 4.1.1 Overview + +The Session Management Event Exposure Service, as defined in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [6], is provided by the Session Management Function (SMF). + +This service: + +- allows NF service consumers to subscribe and unsubscribe for events on a PDU session; and +- notifies recipient of notification(s) subscribed by NF service consumers with a corresponding subscription about observed events on the PDU session. + +The types of observed events applicable for (H-)SMF include: + +- UP path change (e.g. addition and/or removal of PDU session anchor); +- access type change; +- RAT type change; +- PLMN change; +- PDU session release; +- PDU session establishment; +- Downlink data delivery status (for non-roaming); +- UE IP address/prefix change; +- QFI allocation; +- QoS monitoring; +- SM congestion control experience for PDU Session; +- Dispersion; +- Satellite backhaul category change; +- WLAN information for PDU Session; +- Redundant transmission experience for PDU Session; +- UPF events; and/or +- Traffic Correlation. + +The types of observed events applicable for V-SMF include: + +- Downlink data delivery status. + +The types of observed events applicable for I-SMF include: + +- Downlink data delivery status. + +### 4.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Policy and Charging related 5G architecture is also described in 3GPP TS 29.513 [7]. + +The Session Management Event Exposure Service (Nsmf\_EventExposure) is part of the Nsmf service-based interface exhibited by the Session Management Function (SMF). + +The known NF service consumers of the Nsmf\_EventExposure service are: + +- Network Exposure Function (NEF), +- Access and Mobility Management Function (AMF), +- Application Function (AF), +- Unified Data Management (UDM), +- Network Data Analytics Function (NWDAF), and +- Data Collection Coordination Function (DCCF). + +The PCF accesses the Session Management Event Exposure Service at the SMF via the N7 Reference point. + +NOTE: The PCF can implicitly subscribe on behalf of the AF or NEF to the UP\_PATH\_CH, TRAFFIC\_CORRELATION event and/or the QOS\_MON event by including the information on AF or NEF subscription within the PCC rule. + +The AMF accesses the Session Management Event Exposure Service at the SMF via the N11 Reference point. + +![Reference Architecture for the Nsmf_EventExposure Service; SBI representation diagram](5a24ac755b962fd5f0183f13de0726de_img.jpg) + +The diagram illustrates the service architecture for the Nsmf\_EventExposure service. At the top, a box labeled 'SMF' contains an oval labeled 'Nsmf'. A vertical line descends from the 'Nsmf' oval to a horizontal line labeled 'Nsmf\_EventExposure'. From this horizontal line, six vertical lines descend to a row of six boxes at the bottom, labeled from left to right: 'UDM', 'AMF', 'NEF', 'Application Function', 'NWDAF', and 'DCCF'. + +Reference Architecture for the Nsmf\_EventExposure Service; SBI representation diagram + +**Figure 4.1.2-1: Reference Architecture for the Nsmf\_EventExposure Service; SBI representation** + +![Figure 4.1.2-2: Reference Architecture for the Nsmf_EventExposure Service: reference point representation. The diagram shows a central SMF box at the top connected to six boxes below: AMF, NEF, AF, UDM, NWDAF, and DCCF. Lines connect SMF to each of these boxes. The line to AMF is labeled N11. The line to NEF is labeled N29. The lines to AF, UDM, NWDAF, and DCCF are collectively labeled N10.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +graph TD + SMF[SMF] -- N11 --> AMF[AMF] + SMF -- N29 --> NEF[NEF] + SMF -- N10 --> AF[AF] + SMF -- N10 --> UDM[UDM] + SMF -- N10 --> NWDAF[NWDAF] + SMF -- N10 --> DCCF[DCCF] + +``` + +Figure 4.1.2-2: Reference Architecture for the Nsmf\_EventExposure Service: reference point representation. The diagram shows a central SMF box at the top connected to six boxes below: AMF, NEF, AF, UDM, NWDAF, and DCCF. Lines connect SMF to each of these boxes. The line to AMF is labeled N11. The line to NEF is labeled N29. The lines to AF, UDM, NWDAF, and DCCF are collectively labeled N10. + +**Figure 4.1.2-2: Reference Architecture for the Nsmf\_EventExposure Service: reference point representation** + +### 4.1.3 Network Functions + +#### 4.1.3.1 Session Management Function (SMF) + +The Session Management function (SMF) provides: + +- Session Management e.g. Session establishment, modification and release; +- UE IP address allocation & management; +- Selection and control of UP function; +- Termination of interfaces towards Policy control functions; and +- Control part of policy enforcement and QoS. + +#### 4.1.3.2 NF Service Consumers + +The Network Exposure Function (NEF); + +- provides means to securely expose the services and capabilities provided by 3GPP network functions to e.g. 3rd parties or internal exposure consumer NF. + +The Access and Mobility Management function (AMF) provides: + +- Registration management; +- Connection management; +- Reachability management; and +- Mobility Management. + +The Application Function (AF) + +- interacts with the 3GPP Core Network to provide services. + +The Unified Data Management (UDM). + +- has access to subscriber information, can determine the SMF serving a user based on that data, and can then subscribe to event notifications for a user (e.g. when triggered by the NEF). + +The Network Data Analytics Function (NWDAF) + +- collects data based on event subscription provided by AMF, SMF, UPF, PCF, UDM, AF (directly or via NEF) and OAM; +- retrieves information about NFs; + +- performs on demand provision of analytics to NF service consumers, as indicated in clause 6, 3GPP TS 23.288 [21]. + +The Data Collection Coordination Function (DCCF) + +- coordinates the collection and distribution of data and analytics. + +## 4.2 Service Operations + +### 4.2.1 Introduction + +**Table 4.2.1-1: Operations of the Nsmf\_EventExposure Service** + +| Service operation name | Description | Initiated by | +|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------| +| Notify | Report UE PDU session related event(s) to recipient of notification(s) which the NF service consumer has subscribed to the event report service. | (H-)SMF, V-SMF, I-SMF | +| Subscribe | This service operation is used by an NF service consumer to subscribe for event notifications on a specified PDU session, or for all PDU Sessions of one UE, a group of UE(s) or any UE, or to modify a subscription. | NF service consumers (e.g. AMF, NEF, AF, UDM, NWDAF, DCCF) | +| UnSubscribe | This service operation is used by an NF service consumer to unsubscribe from event notifications. | NF service consumers (e.g. AMF, NEF, AF, UDM, NWDAF, DCCF) | +| AppRelocationInfo | This service operation is used by an NF service consumer to acknowledge the notification from the SMF regarding UE PDU Session related event(s) | NF service consumers (e.g. NEF, AF) | + +NOTE: The Nsmf\_TrafficCorrelation\_Notify Service Operation defined in clause 5.2.8.5.2 of 3GPP TS 23.502 [3] is implemented as the "TRAFFIC\_CORRELATION" event in the Nsmf\_EventExposure\_Notify Service Operation with "CommonEASDNAI" feature support. + +### 4.2.2 Nsmf\_EventExposure\_Notify Service Operation + +#### 4.2.2.1 General + +The Nsmf\_EventExposure\_Notify service operation enables the SMF (i.e. (H-)SMF, V-SMF and/or I-SMF) to send notifications to recipient of notification(s) subscribed by NF service consumers upon the occurrence of a previously subscribed event on the related PDU session. + +The following procedure using the Nsmf\_EventExposure\_Notify service operation is supported: + +- notification about subscribed events. + +#### 4.2.2.2 Notification about subscribed events + +The present "notification about subscribed events" procedure is performed by the SMF when any of the subscribed events occur. + +The following applies with respect to the detection of subscribed events: + +- If: + - the SMF supports the "DownlinkDataDeliveryStatus" feature, + - the event "DDDS" is subscribed, + - the traffic descriptors of the downlink data source have been provided for that subscription, and + +- the SMF is informed that the UE corresponding to that subscription is unreachable, +- if the data is buffered at the UPF, then the SMF shall interact with the UPF to notify that the UPF buffers the downlink packets. The SMF shall include the traffic descriptor of the subscriptions in the PDR with a higher priority if the PCC is not applied to the PDU session or derive the PDR from the PCC rule received from the PCF as defined in clause 4.2.4.27 of 3GPP TS 29.512 [14] if the PCC is applied to the PDU session and request the UPF to report when there are corresponding buffered downlink packets or discarded packets in the UPF as defined in clause 5.28.1 of 3GPP TS 29.244 [23]. When receiving the report from the UPF, the SMF shall determine whether that subscribed event with delivery status "DISCARDED" or "BUFFERED" occurred. The SMF shall determine that subscribed event with delivery status "TRANSMITTED" occurred by the fact that the related PDU session becomes ACTIVE. +- if the data is buffered at the SMF, the SMF shall determine whether that subscribed event occurred by comparing the downlink packets with the traffic descriptors received in the corresponding event subscription. If the SMF decides to buffer the packets, the subscribed event with delivery status "BUFFERED" occurred. If the SMF decides to discard the packets, the subscribed event with delivery status "DISCARDED" occurred. The SMF shall determine that subscribed event with delivery status "TRANSMITTED" occurred by the fact that the related PDU session becomes ACTIVE. + +Figure 4.2.2.2-1 illustrates the notification about subscribed events. + +![Sequence diagram showing the notification about subscribed events between SMF and NF service consumer.](7f17c430b9598e4d748a8041457810b3_img.jpg) + +``` +sequenceDiagram + participant SMF + participant NF as NF service consumer + Note right of SMF: 1. POST {notifUri} + SMF->>NF: 1. POST {notifUri} + Note left of NF: 2. "204 No Content" + NF-->>SMF: 2. "204 No Content" +``` + +The diagram illustrates a sequence of two messages between the SMF and an NF service consumer. The SMF sends a POST request with the body {notifUri} to the NF service consumer. The NF service consumer responds with a "204 No Content" status. + +Sequence diagram showing the notification about subscribed events between SMF and NF service consumer. + +**Figure 4.2.2.2-1: Notification about subscribed events** + +If the SMF observes PDU Session related event(s) for which an NF service consumer has subscribed, the SMF shall send an HTTP POST request with "{notifUri}", as previously provided by the NF service consumer within the corresponding subscription, as URI and NsmfEventExposureNotification data structure as request body that shall include: + +- Notification correlation ID provided by the NF service consumer during the subscription, or as provided by the PCF for implicit subscription of UP path change and/or traffic correlation as defined in clause 4.2.6.2.6.2 of 3GPP TS 29.512 [14], or as provided by the PCF for implicit subscription of QoS Monitoring as defined in clause 4.2.3.25 of 3GPP TS 29.512 [14], as "notifId" attribute; and +- information about the observed event(s) within the "eventNotifs" attribute that shall contain for each observed event an "EventNotification" data structure that shall include: + 1. the Event Trigger as "event" attribute; + 2. for a UP path change notification: + - a) type of notification ("EARLY" or "LATE") as "dnaiChgType" attribute; + - b) source DNAI and/or target DNAI as "sourceDnai" attribute and "targetDnai" attribute if DNAI is changed, respectively (NOTE 3); and + - c) if the PDU Session type is IP, for the source DNAI IP address/prefix of the UE as "sourceUeIpv4Addr" attribute or "sourceUeIpv6Prefix" attribute; and + +- d) if the PDU Session type is IP, for the target DNAI IP address/prefix of the UE as "targetUeIpv4Addr" attribute or "targetUeIpv6Prefix" attribute; +- e) if available (NOTE 3), for the source DNAI, N6 traffic routing information related to the UE as "sourceTraRouting" attribute; +- f) if available (NOTE 3), for the target DNAI, N6 traffic routing information related to the UE as "targetTraRouting" attribute; +- g) if the PDU Session type is Ethernet, the MAC address of the UE in the "ueMac" attribute; +- h) if the "CommonEASDNAI" feature is supported, + - the candidate DNAI(s) for the PDU Session in "candidateDnais" attribute, optionally together with the indication of their prioritization within the "candDnaisPrioInd" attribute, if the "candDnailInd" attribute was set to "true" in the PCC rule(s); or + - the indication of EAS re-discovery in "easRediscoverInd" attribute if EAS re-discovery took place. +- i) if both the SMF and the NF service consumer support "ULBuffering" and/or "EASIPreplacement" features, these supported features within the "supportedFeatures" attribute. + +NOTE 1: The SMF gets the knowledge of the feature supported by the NF service consumer as described in clause 5.8. + +- j) if the "EasRelocationEnh" feature is supported and the SMF determines that the target DNAI is supported by an AF different to the one that shall receive this notification, the identifier of the target AF that supports this DNAI in the "targetAfId" attribute. + +NOTE 2: The SMF can determine this by comparing the AF ID of the EAS Deployment Information entry that contains the old DNAI with the AF ID of the EAS Deployment Information entry that contains the target DNAI. These EAS Deployment Information entries are received via the Nnef\_EASDeployment API defined in 3GPP TS 29.591 [25]. + +NOTE 3: UP path change notification, i.e. DNAI change notification and/or N6 traffic routing information change notification, can be the result of an implicit subscription of the PCF on behalf of the NEF/AF as part of setting PCC rule(s) via the Npcf\_SMPolicyControl service (see clause 4.2.6.2.6.2 of 3GPP TS 29.512 [14]). + +NOTE 4: If the DNAI is not changed while the N6 traffic routing information change, the source DNAI and target DNAI are not provided. + +NOTE 5: The change from the UP path status where no DNAI applies to a status where a DNAI applies indicates the activation of the related AF request and therefore only the target DNAI and N6 traffic routing information is provided in the event notification; the change from the UP path status where a DNAI applies to a status where no DNAI applies indicates the de-activation of the related AF request and therefore only the source DNAI and N6 traffic routing information is provided in the event notification. + +##### 3. for a UE IP address change: + +- a) added new UE IP address or prefix as "adIpv4Addr" attribute or "adIpv6Prefix" attribute, respectively; and/or +- b) released UE IP address or prefix as "reIpv4Addr" attribute or "reIpv6Prefix" attribute, respectively; + +##### 4. for an access type change: + +- a) new access type as "accType" attribute; + +##### 5. for a PLMN Change: + +- a) new PLMN as "plmnId" attribute; + +##### 6. for a PDU Session Release: + +- a) ID of the released PDU session as "pduSeId" attribute; + +- b) DNN of the released PDU session as "dnn" attribute, if the "PduSessionStatus" feature is supported; + - c) The type of the released PDU session as "pduSessType" attribute, if the "PduSessionStatus" feature is supported; + - d) UE IPv4 address as "ipv4Addr" attribute and/or IPv6 information (IPv6 prefix(es) or IPv6 address(es)) as "ipv6Prefixes" or "ipv6Addrs" attributes, if the released PDU session type is IP and the "PduSessionStatus" feature is supported; and + - e) S-NSSAI of the released PDU session as "snssai" attribute, if the "EneNA" feature is supported and "snssai" attribute is present in the subscribed "NsmfEventExposure" data type; +- 7. the time at which the event was observed encoded as "timeStamp" attribute; + - 8. the SUPI as the "supi" attribute if the subscription applies to a group of UE(s) or any UE. If the "WlanPerformanceExt\_AIML" feature is supported, the "supi" attribute may also be included for a single UE when the subscription applies to the "WLAN\_INFO" event; + - 9. if available, the GPSI as the "gpsi" attribute if the subscription applies to a group of UE(s) or any UE; + - 10. for a Downlink Data Delivery Status, if the "DownlinkDataDeliveryStatus" feature is supported: + - a) the downlink data delivery status as "dddStatus" attribute; + - b) the downlink data descriptors impacted by the downlink data delivery status change within the "dddTraDescriptor" attribute; and + - c) for downlink data delivery status "BUFFERED". the estimated maximum waiting time as "maxWaitTime" attribute; + - 11. for a Communication Failure, if the "CommunicationFailure" feature is supported: + - a) the detailed communication failure information (e.g. 5G SM cause) as "commFailure" attribute; and + - 12. for QoS Monitoring, if the "QoSMonitoring" or "E2eDataVolTransTime" feature is supported: + - a) one or two uplink packet delays within the "ulDelays" attribute; and/or + - b) one or two downlink packet delays within the "dlDelays" attribute; and/or + - c) one or two round trip packet delays within the "rtDelays" attribute; or + - d) if the feature "PacketDelayFailureReport" is supported, the packet delay measurement failure indicator within the "pdmf" attribute; and/or + - e) if the feature "EnQoSMon" is supported, UL and/or DL congestion information within the "ulConInfo" attribute and "dlConInfo" attribute; or + - f) if the feature "EnQoSMon" is supported, the congestion information measurement failure indicator within "cimf" attribute and/or + - g) if the feature "EnQoSMon" is supported, UL and/or DL data rate measurement within the "ulDataRate" attribute and/or "dlDataRate" attribute. +- NOTE 6: The SMF gets the knowledge of the NF service consumer support of "QoSMonitoring" feature as described in 3GPP TS 29.512 [14]. +- NOTE 7: QoS Monitoring notification can be the result of an implicit subscription of the PCF on behalf of the NEF/AF as part of setting PCC rule(s) via the Npcf\_SMPolicyControl service (see clause 4.2.3.25 of 3GPP TS 29.512 [14]). +- 13. for a PDU Session Establishment, if the "PduSessionStatus" feature is supported: + - a) ID of the established PDU session as "pduSeId" attribute; + - b) DNN of the established PDU session as "dnn" attribute; + +- c) The type of the established PDU session as "pduSessType" attribute; + - d) UE IPv4 address as "ipv4Addr" attribute and/or IPv6 information (IPv6 prefix(es) or IPv6 address(es)) as "ipv6Prefixes" or "ipv6Addrs" attributes if available at PDU session establishment; and + - e) S-NSSAI of the established PDU session as "snssai" attribute, if the "EneNA" feature is supported and "snssai" attribute is present in the subscribed "NsmfEventExposure" data type; +14. for a QFI allocation, if the "QfiAllocation" or "E2eDataVolTransTime" feature is supported: +- a) QFI of the allocated QoS Flow ID for the application as "qfi" attribute; + - b) DNN of the allocated PDU session as "dnn" attribute; + - c) Slice of the allocated PDU session as "snssai" attribute; + - d) The description of the application traffic as "appId", "fDescs" or "ethfDescs" attribute; and + - e) ID of the allocated PDU session as "pduSeId" attribute if the subscription was for a UE, a group of UEs, or any UE, and not for a specific PDU Session; + - f) To obtain the PDU Session information, if the "PduSessionInfo" feature is supported: + - i) the information about the UE access type provided as "accessType" attribute; + - ii) the information about the PDU Session Type in the "pduSessType" attribute and/or the SSC mode in the "sscMode" attribute associated with the application provided as "appId" attribute; and/or + - iii) the information about the PDU Session associated access type as "pduAccTypes" attribute, if the "MultipleAccessTypes" feature is also supported. +15. for an RAT type change, if the "EneNA" feature is supported: +- a) new RAT type as "ratType" attribute; +16. for a SM congestion control experience for PDU Session, if the "SMCCE" feature is supported: +- a) DNN of the PDU session as "dnn" attribute if DNN based SMCC is applied +or Slice of the allocated PDU session as "snssai" attribute if S-NSSAI based SMCC is applied; + - b) Time window representing a start time and a stop time of the data collection period as "timeWindow" attribute; + - c) The information of the SM NAS requests from UE as "smNasFromUe" attribute; and + - d) The information of the SM NAS messages from SMF with backoff timer as "smNasFromSmf" attribute; +17. for transactions dispersion collection, if the Dispersion feature is supported: +- a) The transactions dispersion information collected as "transacInfos" attribute; and + - b) The UE IP address as "ueIpAddr" attribute if it is available and requested in the subscription; +18. for redundant transmission experience of PDU Session, if the "RedundantTransmissionExp" feature is supported: +- a) DNN associated with URLLC service for the PDU session as "dnn" attribute; and + - b) UP with redundant transmission setup as "upRedTrans" attribute; +19. for WLAN information on PDU Session, if the "WlanPerformance" feature is supported: +- a) SSID or BSSID that the PDU session is related to as "ssid" or "bssid" attribute; and + - b) Start time or End time of the PDU Session for WLAN as "startWLAN" or "endWLAN" attribute; +20. for obtaining the UPF information, if the "ServiceExperience" and/or "DnPerformance" feature is supported: + +- a) the information of the UPF serving the UE provided as "upfInfo" attribute. +- 21. for obtaining the User Plane status information, if the "UeCommunication" feature is supported: + - a) the information about the User Plane status provided as "pduSessionInfos" attribute. + - 22. for a satellite backhaul category change, if the "EnSatBackhaulCategoryChg" feature is supported: + - a) satellite backhaul category as "satBackhaulCat" attribute. + - 23. for traffic correlation, if the "CommonEASDNAI" feature is supported: + - a) the traffic correlation information in the "trafCorreInfo" attribute, if the "notifUri" attribute, "notifCorrId" attribute and "tfcCorrId" attribute are provided in the PCC rule, and the common EAS is not provided in the PCC rule or the SMF decides to reselect an EAS for the set of UE(s). + +NOTE 8: Traffic correlation notification can be the result of an implicit subscription of the PCF on behalf of the NEF as part of setting PCC rule(s) via the Npcf\_SMPolicyControl service (see clause 4.2.6.2.6.2 of 3GPP TS 29.512 [14]). + +- an URI for further AF acknowledgement in the "ackUri" attribute if the SMF determines to wait for the AF acknowledgement before activating the new UP path associated with the new DNAI. + +NOTE 9: Based on the indication of AF acknowledgment to be expected in the PCC rules received from the PCF and local configuration, the SMF may determine to wait for the AF acknowledgement before activating the new UP path associated with the new DNAI. + +Upon the reception of an HTTP POST request with "{notifUri}" as URI and an NsmfEventExposureNotification data structure as request body, the notified NF shall send an HTTP "204 No Content" response for a successful processing. + +If errors occur when processing the HTTP POST request, the notified NF shall send the HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is not supported and, + +- if the notified NF is not able to handle the Notification but another unknown NF could possibly handle the notification, it shall reply with an HTTP "404 Not found" error response. + +NOTE 10: An AMF as NF service consumer and/or notified NF can change. + +- if the SMF becomes aware that a new NF service consumer is requiring notifications (e.g. via the "404 Not found" response, or via Namf\_Communication service AMFStatusChange Notifications, see 3GPP TS 29.518 [13], or via link level failures or via the Nnrf\_NFDiscovery Service (using the service name and GUAMI obtained during the creation of the subscription) to discover the other AMFs within the AMF set) specified in 3GPP TS 29.510 [12]), and the SMF knows alternate or backup IPv4 Address(es), IPv6 Address(es) or FQDN(s) where to send Notifications (e.g. via "altNotifIpv4Addrs", "altNotifIpv6Addrs" or "altNotifFqdns" attributes received when the subscription was created), the SMF shall exchange the authority part of the Notification URI with one of those addresses and shall use that URI in any subsequent communication. If the SMF received a "404 Not found" response, the SMF should resend the failed notification to that URI. + +If the feature "ES3XX" is supported, and the notified NF determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4] and, + +- if the SMF receives a "307 Temporary Redirect" response, the SMF shall resend the failed event notification request using the received URI in the Location header field as Notification URI. Subsequent event notifications, triggered after the failed one, shall be sent to the Notification URI provided by the NF service consumer during the corresponding subscription creation/update; or +- if the SMF receives a "308 Permanent Redirect" response, the SMF shall resend the failed event notification request and send the subsequent event notification using the received URI in the Location header field as Notification URI. + +If the SMF in the VPLMN needs to send an event notification to the NEF in the HPLMN, it may normalize the event based on roaming agreements when required before provisioning the event report to the NEF of the HPLMN. + +### 4.2.3 Nsmf\_EventExposure\_Subscribe Service Operation + +#### 4.2.3.1 General + +This service operation is used by an NF service consumer to subscribe to event notifications on a specific PDU Session, or for all PDU Sessions of one UE, group of UE(s) or any UE, or to modify an existing subscription. + +The following procedures using the Nsmf\_EventExposure\_Subscribe service operation are supported: + +- creating a new subscription; +- modifying an existing subscription. + +#### 4.2.3.2 Creating a new subscription + +Figure 4.2.3.2-1 illustrates the creation of a subscription. + +![Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to the SMF, and the SMF responds with a 201 Created status.](90ee16ccc0ad16aeca48087797d7b07f_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant SMF + Note right of NF service consumer: 1. POST .../subscriptions + NF service consumer->>SMF: Request + Note left of SMF: 2. "201 Created" + SMF-->>NF service consumer: Response + +``` + +Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to the SMF, and the SMF responds with a 201 Created status. + +**Figure 4.2.3.2-1: Creation of a subscription** + +To subscribe to event notifications, the NF service consumer shall send an HTTP POST request with: "{apiRoot}/nsmf-event-exposure/v1/subscriptions" as Resource URI and the NsmfEventExposure data structure as request body that shall include: + +- if the subscription applies to events related to a single PDU session for a UE, the PDU Session ID of that PDU session as "pduSessionId" attribute and the UE identification as "supi" or "gpsi" attribute; +- if the subscription applies to events not related to a single PDU session, the Network Function instance identity if "UPEAS" feature is supported and the "eventSubs" attribute contains an entry with the "event" set to the value "UPF\_EVENT", and identification of UEs to which the subscription applies via: + - a) identification of a single UE by SUPI as "supi" attribute or GPSI as "gpsi" attribute; + - b) identification of a group of UE(s) via a "groupId" attribute; or + - c) identification of any UE via the "anyUeInd" attribute set to true; + +NOTE 1: The identification of any UE does not apply for local breakout roaming scenarios where the SMF is located in the VPLMN and the NF service consumer is located in the HPLMN. + +- an URI where to receive the requested notifications as "notifUri" attribute; +- a Notification Correlation Identifier provided by the NF service consumer for the requested notifications as "notifId" attribute; and +- if the NF service consumer is an AMF, the GUAMI encoded as "guami" attribute; +- a description of the subscribed events as "eventSubs" attribute that for each event shall include: + - a) an event identifier as "event" attribute; and + +- b) for event "UP\_PATH\_CH", whether the subscription is for early, late, or early and late notifications of UP path reconfiguration in the "dnaiChgType" attribute; + - c) for event "DDDS", the traffic descriptor(s) of the downlink data source in the "dddTraDescriptors" attribute; +- and that may include: +- a) for event "DDDS", the subscribed delivery statuses in the "dddStati" attribute; + - b) for event "QFI\_ALLOC" or "DISPERSION", the application identifiers in the "appIds" attribute; + - c) for event "SMCC\_EXP", the data collection target period in the "targetPeriod" attribute; + - d) for event "DISPERSION", the UE IP Address in the "ueIpAddr" attribute, the indication of transaction dispersion collection in the "transacDispInd" attribute and the requested transaction metrics in the "transacMetrics" attribute; + - e) for event "WLAN\_INFO", the data collection target period in the "targetPeriod" attribute; + - f) for event "RED\_TRANS\_EXP", the data collection target period in the "targetPeriod" attribute; + - g) for event "UPF\_EVENT", the UPF event exposure information in the "upfEvents" attribute; and/or +- h) for event "QOS\_MON", the Application Identifier in the "appIds" of the application for which the QoS flows are to be monitored and an indication within the "defQosSupp" attribute to inform whether the NF service consumer supports to receive QoS Flow performance information for the QoS Flow associated with the default QoS rule if there are no measurements available for the provided Application Identifier included within the "appIds" attribute.NOTE 2: Explicit subscription to "UPF\_EVENT" and "QOS\_MON" events as described in this clause implies the direct notification from the UPF. + +The NsmfEventExposure data structure as request body may also include: + +- if the NF service consumer is an AMF: + - a) the name of a service produced by the AMF that expects to receive the notifications about subscribed events encoded as "serviceName" attribute; + - b) Alternate or backup IPv4 Address(es) where to send Notifications encoded as "altNotifIpv4Addrs" attribute; + - c) Alternate or backup IPv6 Address(es) where to send Notifications encoded as "altNotifIpv6Addrs" attribute; + - d) Alternate or backup FQDN(s) where to send Notifications encoded as "altNotifFqdns" attribute; +- a Data Network Name as "dnn" attribute; +- a single Network Slice Selection Assistance Information as "snssai" attribute; +- an identification of network area by "networkArea" attribute, if the feature AreaFilter is supported and the "anyUeInd" attribute is provided and set to true; + +NOTE 3: Care needs to be taken with regards to load and major signalling caused when requesting Any UE. This could be achieved via utilization of some event filters (e.g. Area of Interest), a specific DNN, S-NSSAI or sampling ratio as part of Event Reporting Information. + +- a Data Network Identifier as "dnai" attribute, if the feature UPEAS is supported; +- the SSID that the PDU session is related to as "ssid" attribute, if the feature UPEAS is supported; +- the BSSID that the PDU session is related to as "bssid" attribute, if the feature UPEAS is supported; +- the UPF identifier as "upfId" attribute, if the feature UPEAS is supported; +- immediate reporting flag as "ImmeRep" attribute; +- event notification method (periodic, one time, on event detection) as "notifMethod" attribute; +- maximum Number of Reports as "maxReportNbr" attribute; + +- monitoring Duration as "expiry" attribute; +- repetition Period for periodic reporting as "repPeriod" attribute; +- sampling ratio as "sampRatio" attribute; +- partitioning criteria for partitioning the UEs before performing sampling as "partitionCriteria" attribute if the EneNA feature is supported; and/or +- group reporting guard time as "grpRepTime" attribute; +- a notification flag as "notifFlag" attribute if the EneNA feature is supported; and/or +- notification muting exception instructions within the "notifFlagInstruct" attribute, if the EnhDataMgmt feature is supported and the "notifFlag" attribute is provided and set to "DEACTIVATE". + +NOTE 4: For the "PDU\_SES\_EST" event subscription, the "ImmeRep" attribute needs to be included to enable the SMF to report the current available "PDU\_SES\_EST" event information for the subscribed PDU Session which is already established. + +Upon the reception of an HTTP POST request with: "{apiRoot}/nsmf-event-exposure/v1/subscriptions" as Resource URI and NsmfEventExposure data structure as request body, the SMF shall: + +- create a new subscription; +- assign a subscription correlation ID; +- select an expiry time that is equal to or less than the expiry time potentially received in the request; +- store the subscription; +- if the feature "UPEAS" is supported, and if the NF service consumer subscribed to "QOS\_MON" event, the SMF shall check if there is an active PCC rule that includes a Data Collection Application Identifier as described in 3GPP TS 29.512 [14] that matches the Application Identifier received within "applIds" attribute. If there is an active PCC rule, the SMF shall allow the NF service consumer to receive QoS monitoring reports enabled by that PCC rule. If no PCC rule is identified and the "defQosSupp" attribute was received and set to true, the SMF may instruct the UPF to perform QoS monitoring for the QoS Flow associated to the default QoS rule as described in 3GPP TS 29.244 [23]. If no PCC rule is identified and the "defQosSupp" attribute was received and set to false or not received, the SMF may, based on local configuration, reject the request by sending the NO\_ACTIVE\_PCC\_RULE error described in clause 5.7 or include the "qosMonPending" indication set to true in the response to inform the NF service consumer that the reporting will be activated when the measurements are enabled by a PCC rule; + +NOTE 5: The reporting can be activated when a new PCC rule is installed or an existing one is modified with QoS monitoring information that includes the Data Collection Application Identifier related to the subscription. In this case the SMF will act as if the new subscription is received from the NF service consumer. + +- send an HTTP "201 Created" response with NsmfEventExposure data structure as response body and a Location header field containing the URI of the created individual subscription resource, i.e. "{apiRoot}/nsmf-event-exposure/v1/subscriptions/{subId}"; +- if the feature "ERIR" is not supported, and if the "ImmeRep" attribute is included and set to true in the request, the SMF shall immediately notify the recipient of notification(s) subscribed in the "notifUri" attribute of the current available value(s) using the Nsmf\_EventExposure\_Notify service operation, as defined in clause 4.2.2.1; +- if the feature "ERIR" is supported, and if the "ImmeRep" attribute is included and set to true, the SMF may immediately notify the NF service consumer with the current available value(s) for the subscribed event(s) within the HTTP "201 Created" response as shown in figure 4.2.3.2-1, step 2. The "NsmfEventExposure" data type in the response may include the corresponding event(s) notification within the "eventNotifs" attribute. +- if the sampling ratio attribute, as "sampRatio", is included in the subscription without a "partitionCriteria" attribute, the SMF shall select a random subset of UEs among the target UEs according to the sampling ratio and only report the event(s) related to the selected subset of UEs. If the "partitionCriteria" attribute is additionally included, then the SMF shall first partition the UEs according to the value of the "partitionCriteria" attribute and + +then select a random subset of UEs from each partition according to the sampling ratio and only report the event(s) related to the selected subsets of UEs; + +- when the group reporting guard time attribute, as "grpRepTime", is included in the subscription, the SMF shall accumulate all the event reports for the target UEs until the group reporting guard time expires. Then the SMF shall notify the NF service consumer using the Nsmf\_EventExposure\_Notify service operation, as described in clause 4.2.2.2; and +- if the "notifFlag" attribute is included and set to "DEACTIVATE" in the request, the SMF shall mute the event notification and store the available events until the NF service consumer requests to retrieve them by setting the "notifFlag" attribute to "RETRIEVAL" or until a muting exception occurs (e.g. full buffer). When a muting exception occurs, the SMF may consider the contents of the "notifFlagInstruct" attribute (if provided) and/or local configuration to determine its actions. If the EnhDataMgmt feature is supported and the SMF accepts the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes, it may indicate the applied muting notification settings within the "mutingSetting" attribute in the response. If the SMF does not accept the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes, it shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "MUTING\_INSTR\_NOT\_ACCEPTED". + +If the SMF received an GUAMI, the SMF may subscribe to GUAMI changes using the AMFStatusChange service operation of the Namf\_Communication service specified in 3GPP TS 29.518 [13], and it may use the Nnrf\_NFDiscovery Service specified in 3GPP TS 29.510 [12] (using the obtained GUAMI and possibly service name) to query the other AMFs within the AMF set. + +If errors occur when processing the HTTP POST request, the SMF shall send an HTTP error response as specified in clause 5.7. + +#### 4.2.3.3 Modifying an existing subscription + +Figure 4.2.3.3-1 illustrates the modification of an existing subscription. + +![Sequence diagram showing the modification of an existing subscription. An NF service consumer sends a PUT request to the SMF. The SMF responds with either a 200 OK or a 204 No Content.](a51105b2031bad93b818b82f071c6add_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant SMF + Note left of NF service consumer: + NF service consumer->>SMF: 1. PUT.../subscriptions/{subId} + Note right of SMF: + SMF-->>NF service consumer: 2a. 200 OK + SMF-->>NF service consumer: 2b. 204 No Content + +``` + +Sequence diagram showing the modification of an existing subscription. An NF service consumer sends a PUT request to the SMF. The SMF responds with either a 200 OK or a 204 No Content. + +**Figure 4.2.3.3-1: Modification of an existing subscription** + +To modify an existing subscription to event notifications, the NF service consumer shall send an HTTP PUT request with: "{apiRoot}/nsmf-event-exposure/v1/subscriptions/{subId}" as Resource URI, where "{subId}" is the subscription correlation ID of the existing subscription, and NsmfEventExposure data structure as request body as described in clause 4.2.3.2. + +NOTE 1: An alternate NF service consumer than the one that requested the generation of the subscription resource can send the PUT. For instance, an AMF as NF service consumer can change. + +NOTE 2: The "notifUri" attribute within the NsmfEventExposure data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +When the "notifFlag" attribute is included and set to "DEACTIVATE" in the request, the SMF shall mute the event notification and store the available events until the NF service consumer requests to retrieve them by setting the "notifFlag" attribute to "RETRIEVAL" or until a muting exception occurs (e.g. full buffer). When a muting exception occurs, the SMF may consider the contents of the "notifFlagInstruct" attribute (if provided) and/or local configuration to + +determine its actions; if the "notifFlag" attribute is set to "RETRIEVAL" in the request, the SMF shall send the stored events to the NF service consumer, mute the event notification again and store available events; if the "notifFlag" attribute is set to "ACTIVATE" and the event notifications are muted (due to a previously received "DEACTIVATE" value), the SMF shall unmute the event notification, i.e. start sending again notifications for available events. If the EnhDataMgmt feature is supported and the SMF accepts the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes, it may indicate the applied muting notification settings within the "mutingSetting" attribute in the response. If the SMF does not accept the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes, it shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "MUTING\_INSTR\_NOT\_ACCEPTED". + +When the "ImmRep" attribute set to true is included in the subscription and the subscribed event(s) are available: + +- if the feature "ERIR" is not supported, the SMF shall immediately notify the in the "notifUri" attribute in the "notifUri" attribute with the current available value(s) for the subscribed event(s) using the Nsmf\_EventExposure\_Notify service operation, as described in clause 4.2.2.1. +- if the feature "ERIR" is supported, the SMF may immediately notify the NF service consumer with the current available value(s) for the subscribed event(s) within the HTTP "200 OK" response as shown in figure 4.2.3.3-1, step 2a. The "NsmfEventExposure" data type may include the corresponding event(s) notification within the "eventNotifs" attribute. + +NOTE 3: Only the newly added event(s) needs to be reported during the subscription update. + +NOTE 4: For the "PDU\_SES\_EST" event subscription, the "ImmeRep" attribute needs to be included to enable the SMF to report the current available "PDU\_SES\_EST" event information for the subscribed PDU Session which is already established. + +If the "sampRatio" attribute is included in the request without a "partitionCriteria" attribute, the SMF shall select a random subset of UEs among the target UEs according to the sampling ratio and only report the event(s) related to the selected subset of UEs. If the "partitionCriteria" attribute is additionally included, then the SMF shall first partition the UEs according to the value of the "partitionCriteria" attribute and then select a random subset of UEs from each partition according to the sampling ratio and only report the event(s) related to the selected subsets of UEs. + +When the "grpRepTime" attribute is included in the request, the SMF shall accumulate all the event reports for the target UEs until the group reporting guard time expires. Then the SMF shall notify the NF service consumer using the Nsmf\_EventExposure\_Notify service operation, as described in clause 4.2.2.2. + +When the "expiry" attribute is included in the request, the SMF shall select an expiry time that is equal to or less than the expiry time received in the request. + +Upon the reception of an HTTP PUT request with: "{apiRoot}/nsmf-event-exposure/v1/subscriptions/{subId}" as Resource URI and NsmfEventExposure data structure as request body, if the received HTTP request is successfully processed and accepted, the SMF shall: + +- update the concerned subscription; and +- send an HTTP "200 OK" response with a response body containing a representation of the updated subscription in the NsmfEventExposure data structure or send a HTTP "204 No Content". + +If errors occur when processing the HTTP PUT request, the SMF shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the SMF determines the received HTTP PUT request needs to be redirected, the SMF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +### 4.2.4 Nsmf\_EventExposure\_UnSubscribe Service Operation + +#### 4.2.4.1 General + +This service operation is used by an NF service consumer to unsubscribe from event notifications. + +The following procedure using the Nsmf\_EventExposure\_UnSubscribe service operation is supported: + +- unsubscription from event notifications. + +#### 4.2.4.2 Unsubscription from event notifications + +Figure 4.2.4.2-1 illustrates the unsubscription from event notifications. + +![Sequence diagram showing the unsubscription from event notifications between an NF service consumer and an SMF.](7d3d5fb5d09c0cd35a9d637be241651e_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant SMF + Note right of NF service consumer: 1. DELETE .../subscriptions/{subId} + NF service consumer->>SMF: 1. DELETE .../subscriptions/{subId} + Note left of SMF: 2. "204 No Content" + SMF-->>NF service consumer: 2. "204 No Content" +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and an SMF. The first message, labeled '1. DELETE .../subscriptions/{subId}', is sent from the NF service consumer to the SMF. The second message, labeled '2. "204 No Content"', is sent from the SMF back to the NF service consumer. + +Sequence diagram showing the unsubscription from event notifications between an NF service consumer and an SMF. + +**Figure 4.2.4.2-1: Unsubscription from event notifications** + +To unsubscribe from event notifications, the NF service consumer shall send an HTTP DELETE request with: "{apiRoot}/nsmf-event-exposure/v1/subscriptions/{subId}" as Resource URI, where "{subId}" is the subscription correlation ID of the existing subscription that is to be deleted. + +Upon the reception of the HTTP DELETE request with: "{apiRoot}/nsmf-event-exposure/v1/subscriptions/{subId}" as Resource URI, if the received HTTP request is successfully processed and accepted, the SMF shall: + +- remove the corresponding subscription; and +- send an HTTP "204 No Content" response. + +If errors occur when processing the HTTP DELETE request, the SMF shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the SMF determines the received HTTP DELETE request needs to be redirected, the SMF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +### 4.2.5 Nsmf\_EventExposure\_AppRelocationInfo Service Operation + +#### 4.2.5.1 General + +The Nsmf\_EventExposure\_AppRelocationInfo service operation enables the NF service consumer to acknowledge the notification of subscribed events on the related PDU session from the SMF. + +The following procedure using the Nsmf\_EventExposure\_AppRelocationInfo service operation is supported: + +- acknowledgement of notification about subscribed events. + +#### 4.2.5.2 Acknowledgement of Notification about subscribed events + +Figure 4.2.5.2-1 illustrates the acknowledgement of notification about subscribed events. + +![Sequence diagram showing the acknowledgement of a notification. An NF service consumer sends a POST {ackUri} request to the SMF, and the SMF responds with a 204 No Content.](eb03559a4d92ea9ebd63ea9be663c50a_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant SMF + Note right of NF service consumer: 1. POST {ackUri} + NF service consumer->>SMF: 1. POST {ackUri} + Note left of SMF: 2. "204 No Content" + SMF-->>NF service consumer: 2. "204 No Content" + +``` + +Sequence diagram showing the acknowledgement of a notification. An NF service consumer sends a POST {ackUri} request to the SMF, and the SMF responds with a 204 No Content. + +**Figure 4.2.5.2-1: Acknowledgement of Notification about subscribed events** + +In order to acknowledge the SMF of the application relocation information after the handling of a notification about UP path change event, an NF service consumer shall send an HTTP POST request to the callback URI "{ackUri}" as previously provided by the SMF in an attribute within the NsmfEventExposureNotification data during UP path change notification procedure as defined in clause 4.2.2.2. + +The request body contains the AckOfNotify data structure that shall include: + +- Notification correlation ID provided by the SMF during UP path change notification, as "notifId" attribute; +- an identifier of UE (i.e. SUPI or GPSI), if available and the subscription does not apply to a group of UE(s) or any UE; and +- information about the AF acknowledgement within the "ackResult" attribute that shall contain result status of the application relocation as "afStatus" attribute. If the "afStatus" attribute sets to "SUCCESS", the N6 traffic routing information associated to the target DNAI may be included as "trafficRoute" attribute and, if the "ULBuffering" feature is supported, an indication that buffering of uplink traffic to the target DNAI is needed may be included as "upBuffInd" attribute and, if the feature "EASIPreplacement" is supported, EAS IP replacement information may be included as "easIpReplaceInfos" attribute. If the application relocation is not completed on time, the "afStatus" attribute shall set to the corresponding failure cause. + +**NOTE** The NF service consumer gets the knowledge of the support of "ULBuffering" and/or "EASIPreplacement" negotiated features as part of the notification of the subscribed events as described in clause 4.2.2.2. + +Upon the reception of an HTTP POST request with AckOfNotify data structure as request body, the SMF shall send an HTTP "204 No Content" response for a successful processing. + +If errors occur when processing the HTTP POST request, the SMF shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the SMF determines the received HTTP POST request needs to be redirected, the SMF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +# 5 Nsmf\_EventExposure API + +## 5.1 Introduction + +The Session Management Event Exposure Service shall use the Nsmf\_EventExposure API. + +The API URI of the Nsmf\_EventExposure API shall be: + +**{apiRoot}//** + +The request URIs used in HTTP requests from the NF service consumer towards the SMF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nsmf-event-exposure". +- The shall be "v1". +- The shall be set as described in clause 5.3. + +## 5.2 Usage of HTTP + +### 5.2.1 General + +HTTP/2, IETF RFC 9113 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [10] specification of HTTP messages and content bodies for the Nsmf\_EventExposure is contained in Annex A. + +### 5.2.2 HTTP standard headers + +#### 5.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +#### 5.2.2.2 Content type + +JSON, IETF RFC 8259 [9], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [18]. + +### 5.2.3 HTTP custom headers + +The Nsmf\_EventExposure API shall support HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4]. + +In this Release of the specification, no specific custom headers are defined for the Nsmf\_EventExposure API. + +## 5.3 Resources + +### 5.3.1 Resource Structure + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 5.3.1-1 depicts the resource URIs structure for the Nsmf\_EventExposure API. + +![Diagram showing the resource URI structure of the Nsmf_EventExposure API. The root path is {apiRoot}/nsmf-event-exposure/v1. A line branches down to a box containing /subscriptions. From this box, another line branches down to a box containing /{subId}.](26d664119ad25250780f554633444e54_img.jpg) + +{apiRoot}/nsmf-event-exposure/v1 + +``` + +graph TD + Root["{apiRoot}/nsmf-event-exposure/v1"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubId["/{subId}"] + +``` + +Diagram showing the resource URI structure of the Nsmf\_EventExposure API. The root path is {apiRoot}/nsmf-event-exposure/v1. A line branches down to a box containing /subscriptions. From this box, another line branches down to a box containing /{subId}. + +**Figure 5.3.1-1: Resource URI structure of the Nsmf\_EventExposure API** + +Table 5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|------------------------------------------|------------------------|---------------------------------|--------------------------------------------------------------------------------------------------| +| SMF Notification Subscriptions | /subscriptions | POST | Create a new Individual SMF Notification Subscription resource. | +| Individual SMF Notification Subscription | /subscriptions/{subId} | GET | Read an Individual SMF Notification Subscription resource. | +| | | PUT | Modify an existing Individual SMF Notification Subscription resource. | +| | | DELETE | Delete an Individual SMF Notification Subscription resource and cancel the related subscription. | + +### 5.3.2 Resource: SMF Notification Subscriptions + +#### 5.3.2.1 Description + +The SMF Notification Subscriptions resource represents the collection of subscriptions to the SMF event exposure service at a given SMF. + +#### 5.3.2.2 Resource definition + +Resource URI: {apiRoot}/nsmf-event-exposure/v1/subscriptions + +This resource shall support the resource URI variables defined in table 5.3.2.2-1. + +**Table 5.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 5.1 | + +#### 5.3.2.3 Resource Standard Methods + +##### 5.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.2.3.1-1. + +**Table 5.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.2.3.1-3. + +**Table 5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|-----------------------------------------------------------------| +| NsmfEventExposure | M | 1 | Create a new Individual SMF Notification Subscription resource. | + +**Table 5.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------| +| NsmfEventExposure | M | 1 | 201 Created | The creation of an Individual SMF Notification Subscription resource is confirmed and a representation of that resource is returned. | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: Failure cases are described in clause 5.7. + +**Table 5.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nsmf-event-exposure/v1/subscriptions/{subId} | + +#### 5.3.2.4 Resource Custom Operations + +None. + +### 5.3.3 Resource: Individual SMF Notification Subscription + +#### 5.3.3.1 Description + +The SMF Notification Subscriptions resource represents a single subscription to the SMF event exposure service. + +#### 5.3.3.2 Resource definition + +Resource URI: {apiRoot}/nsmf-event-exposure/v1/subscriptions/{subId} + +This resource shall support the resource URI variables defined in table 5.3.3.2-1. + +**Table 5.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|-------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.1 | +| subId | string | Identifies a subscription to the SMF event exposure service formatted as defined for the SubId type in table 5.6.3.2-1. | + +#### 5.3.3.3 Resource Standard Methods + +##### 5.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.3.3.3.1-1. + +**Table 5.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.1-2 and the response data structures and response codes specified in table 5.3.3.3.1-3. + +**Table 5.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| NsmfEventExposure | M | 1 | 200 OK | A representation of the SMF Notification Subscription matching the subId is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual SMF Notification Subscription retrieval.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual SMF Notification Subscription retrieval.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative SMF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance towards which the request is redirected | + +**Table 5.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative SMF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance towards which the request is redirected | + +##### 5.3.3.3.2 PUT + +This method shall support the URI query parameters specified in table 5.3.3.3.2-1. + +**Table 5.3.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.2-2 and the response data structures and response codes specified in table 5.3.3.3.2-3. + +**Table 5.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| NsmfEventExposure | M | 1 | Modify the existing Individual SMF Notification Subscription resource matching the subId according to the representation in the NsmfEventExposure | + +**Table 5.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NsmfEventExposure | M | 1 | 200 OK | Successful case: The Individual SMF Notification Subscription resource matching the subId was modified and a representation is returned. | +| n/a | | | 204 No Content | Successful case: The Individual SMF Notification Subscription resource matching the subId was modified. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual SMF Notification Subscription modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual SMF Notification Subscription modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: Failure cases are described in clause 5.7. + +NOTE 3: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative SMF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance towards which the request is redirected | + +**Table 5.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative SMF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance towards which the request is redirected | + +##### 5.3.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 5.3.3.3.3-1. + +**Table 5.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.3-2 and the response data structures and response codes specified in table 5.3.3.3.3-3. + +**Table 5.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case: The Individual SMF Notification Subscription resource matching the subId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual SMF Notification Subscription deletion.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual SMF Notification Subscription deletion.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.3.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative SMF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance towards which the request is redirected | + +**Table 5.3.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative SMF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance towards which the request is redirected | + +#### 5.3.3.4 Resource Custom Operations + +None. + +## 5.4 Custom Operations without associated resources + +None. + +## 5.5 Notifications + +### 5.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 5.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|---------------------------------------|--------------|---------------------------------|------------------------------------------------| +| Event Notification | {notifUri} | POST | Provides information about observed events. | +| Acknowledgement of event notification | {ackUri} | POST | Provides acknowledgement of event notification | + +### 5.5.2 Event Notification + +#### 5.5.2.1 Description + +The Event Notification is used by the SMF to report one or several observed Events to a recipient of notification(s) that a NF service consumer has subscribed to such Notifications. + +NOTE 1: The definition of "callbacks" in the OpenAPI specification found in clause A.2 associated to the POST method of the "SMF Notification Subscriptions" resource is used as the notification request for both explicit and implicit subscriptions. + +NOTE 2: For implicit subscriptions, the PCF can have previously stored in the SMF the notification URI to be used in the notifications initiated by the SMF. See 3GPP TS 29.512 [14] for the details. + +#### 5.5.2.2 Target URI + +The Callback URI "{notifUri}" shall be used with the callback URI variables defined in table 5.5.2.2-1. + +**Table 5.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | The Notification Uri as assigned either within the Individual SMF Notification Subscription Resource during the explicit subscription service operation and described within the NsmfEventExposure type (see table 5.6.2.2-1) or assigned during the implicit subscription via the provisioning of the subscription information within the PCC Rule from the PCF (see 3GPP TS 29.512 [14]). | + +#### 5.5.2.3 Standard Methods + +##### 5.5.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.5.2.3.1-1. + +**Table 5.5.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.2.3.1-2 and the response data structures and response codes specified in table 5.5.2.3.1-3. + +**Table 5.5.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------------|---|-------------|--------------------------------------------| +| NsmfEventExposureNotification | M | 1 | Provides Information about observed events | + +**Table 5.5.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during the event notification.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during the event notification.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The NF service consumer can use this response when the notification can be sent to another host. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.5.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. May be included if the feature "ES3XX" is supported. | + +**Table 5.5.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +### 5.5.3 Acknowledgement of event notification + +#### 5.5.3.1 Description + +The Acknowledgement of Event Notification is used by the NF service consumer to acknowledge the SMF about handling result of the event notification (e.g. UP path change). + +#### 5.5.3.2 Target URI + +The Callback URI "{ackUri}" shall be used with the callback URI variables defined in table 5.5.3.2-1. + +**Table 5.5.3.2-1: Callback URI variables** + +| Name | Data type | Definition | +|--------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ackUri | Uri | Acknowledgement Uri as assigned during the procedure of notification about subscribed events and described within the NsmfEventExposureNotification data type (see table 5.6.2.3-1). | + +#### 5.5.3.3 Standard Methods + +##### 5.5.3.3.1 POST + +This method shall support the URI query parameters specified in table 5.5.3.3.1-1. + +**Table 5.5.3.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.3.3.1-2 and the response data structures and response codes specified in table 5.5.3.3.1-3. + +**Table 5.5.3.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------|---|-------------|---------------------------------------------------| +| AckOfNotify | M | 1 | Acknowledgement information of event notification | + +**Table 5.5.3.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the acknowledgement is successful. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during acknowledgement of notification.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during acknowledgement of notification.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.5.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative SMF (service) instance towards which the acknowledgement should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance towards which the acknowledgement request is redirected | + +**Table 5.5.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative SMF (service) instance towards which the acknowledgement should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance towards which the acknowledgement request is redirected | + +## 5.6 Data Model + +### 5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.6.1-1 specifies the data types defined for the Nsmf\_EventExposure service based interface protocol. + +Table 5.6.1-1: Nsmf\_EventExposure specific Data Types + +| Data type | Section defined | Description | Applicability | +|--------------------------------|-----------------|------------------------------------------------------------------------------|------------------------------------| +| AckOfNotify | 5.6.2.7 | Acknowledgement information of event notification | | +| AppliedSmccType | 5.6.3.6 | The type of applied SM congestion control. | SMCCE | +| EventNotification | 5.6.2.5 | Describes notifications about a single event that occurred. | | +| EventSubscription | 5.6.2.4 | Represents the subscription to a single event | | +| NotificationMethod | 5.6.3.4 | Represents the notification methods that can be subscribed | | +| NsmfEventExposure | 5.6.2.2 | Represents an Individual SMF Notification Subscription resource | | +| NsmfEventExposureNotification | 5.6.2.3 | Describes Notifications about events that occurred. | | +| PduSessionInfo | 5.6.2.12 | Represents session information. | UeCommunication | +| PduSessionInformation | 5.6.2.11 | Represents the PDU session related information. | UeCommunication | +| PduSessionStatus | 5.6.3.8 | Status of the PDU Session. | UeCommunication | +| SmfEvent | 5.6.3.3 | Represents the types of events that can be subscribed | | +| SubId | 5.6.3.2 | Identifies an Individual SMF Notification Subscription. | | +| SmNasFromSmf | 5.6.2.9 | Describes the information of the SM NAS messages from SMF with backoff timer | SMCCE | +| SmNasFromUe | 5.6.2.8 | Describes the information of the SM NAS requests from UE | SMCCE | +| TrafficCorrelationNotification | 5.6.2.14 | Represents the traffic correlation Information for Notification. | CommonEASD
NAI | +| TransactionInfo | 5.6.2.10 | UE Session Management transaction information. | Dispersion | +| TransactionMetric | 5.6.3.7 | Metric on UE Session Management transactions. | Dispersion | +| UpfInformation | 5.6.2.13 | The information of the UPF serving the UE. | ServiceExperience
DnPerformance | + +Table 5.6.1-2 specifies data types re-used by the Nsmf\_EventExposure service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nsmf\_EventExposure service based interface. + +Table 5.6.1-2: Nsmf\_EventExposure re-used Data Types + +| Data type | Reference | Comments | Applicability | +|-----------------------------|---------------------|------------------------------------------------------------------------------------------------------------|------------------------------------| +| 5Qi | 3GPP TS 29.571 [11] | The 5G QoS Identifier. | EnQfiAllocation | +| AccessType | 3GPP TS 29.571 [11] | | | +| AfResultInfo | 3GPP TS 29.522 [20] | Represents application handling information. | | +| ApplicationId | 3GPP TS 29.571 [11] | The application identifier. | QfiAllocation
PduSessionInfo | +| BitRate | 3GPP TS 29.571 [11] | Represents the bit rate. | EnQoSMon | +| CommunicationFailure | 3GPP TS 29.518 [13] | Represents the communication failure information. | Communication Failure | +| DateTime | 3GPP TS 29.571 [11] | | | +| DiDataDeliveryStatus | 3GPP TS 29.571 [11] | Status of downlink data delivery | DownlinkDataDeliveryStatus | +| DddTrafficDescriptor | 3GPP TS 29.571 [11] | Traffic descriptor of source of downlink data | DownlinkDataDeliveryStatus | +| Dnai | 3GPP TS 29.571 [11] | | | +| DnaiChangeType | 3GPP TS 29.571 [11] | Describes the types of DNAI change. | | +| Dnn | 3GPP TS 29.571 [11] | | QfiAllocation,
PduSessionStatus | +| DurationSec | 3GPP TS 29.571 [11] | | | +| EthFlowDescription | 3GPP TS 29.514 [22] | Ethernet flow description | QfiAllocation | +| FlowDescription | 3GPP TS 29.514 [22] | IP flow description | QfiAllocation | +| Fqdn | 3GPP TS 29.571 [11] | FQDN | | +| Gpsi | 3GPP TS 29.571 [11] | | | +| GroupId | 3GPP TS 29.571 [11] | | | +| Guami | 3GPP TS 29.571 [11] | Globally Unique AMF Identifier | | +| IpAddr | 3GPP TS 29.571 [11] | UE IP address. | Dispersion
CommonEASD
NAI | +| Ipv4Addr | 3GPP TS 29.571 [11] | | | +| Ipv6Addr | 3GPP TS 29.571 [11] | | | +| Ipv6Prefix | 3GPP TS 29.571 [11] | | | +| MacAddr48 | 3GPP TS 29.571 [11] | MAC Address. | | +| MutingExceptionInstructions | 3GPP TS 29.571 [11] | Contains instructions to be executed upon the occurrence of an event muting exception (e.g. full buffer). | EnhDataMgmt | +| MutingNotificationsSettings | 3GPP TS 29.571 [11] | Contains setting related to the muting of notifications. | EnhDataMgmt | +| NetworkAreaInfo | 3GPP TS 29.554 [27] | Identifies the network area. | AreaFilter | +| NfInstanceId | 3GPP TS 29.571 [11] | Instance identity of the Network Function | UPEAS
CommonEASD
NAI | +| NotificationFlag | 3GPP TS 29.571 [11] | Notification flag. | EneNA | +| PartitioningCriteria | 3GPP TS 29.571 [11] | Used to partition UEs before applying sampling. | EneNA | +| PduSessionId | 3GPP TS 29.571 [11] | | | +| PduSessionType | 3GPP TS 29.571 [11] | PDU session type. | PduSessionStatus
PduSessionInfo | +| PlmnIdNid | 3GPP TS 29.571 [11] | Identification of a network: the PLMN Identifier or the SNPN Identifier (the PLMN Identifier and the NID). | | +| ProblemDetails | 3GPP TS 29.571 [11] | | | +| Qfi | 3GPP TS 29.571 [11] | QoS flow identifier. | QfiAllocation | +| RatType | 3GPP TS 29.571 [11] | | | +| RedirectResponse | 3GPP TS 29.571 [11] | Contains redirection related information. | ES3XX | +| RouteToLocation | 3GPP TS 29.571 [11] | A traffic route to/from an DNAI | | +| SamplingRatio | 3GPP TS 29.571 [11] | Sampling Ratio. | | +| SatelliteBackhaulCategory | 3GPP TS 29.571 [11] | Indicates the satellite backhaul category or non-satellite backhaul. | EnSatBackhaul
CategoryChg | +| ServiceName | 3GPP TS 29.510 [12] | Name of the service instance. | | +| Snssai | 3GPP TS 29.571 [11] | S-NSSAI | QfiAllocation | +| SscMode | 3GPP TS 29.571 [11] | SSC Mode selected for the PDU Session. | PduSessionInfo | + +| | | | | +|-------------------|---------------------|--------------------------------------------------------------------------------------|-------| +| Supi | 3GPP TS 29.571 [11] | | | +| SupportedFeatures | 3GPP TS 29.571 [11] | Used to negotiate the applicability of the optional features defined in table 5.8-1. | | +| TimeWindow | 3GPP TS 29.122 [24] | A start time and a stop time of a time window. | SMCCE | +| Uinteger | 3GPP TS 29.571 [11] | | | +| UpfEvent | 3GPP TS 29.564 [26] | Contains UPF event information. | UPEAS | +| Uri | 3GPP TS 29.571 [11] | | | + +### 5.6.2 Structured data types + +#### 5.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +#### 5.6.2.2 Type NsmfEventExposure + +Table 5.6.2.2-1: Definition of type NsmfEventExposure + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|--------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | Subscription Permanent Identifier (NOTE 1) | | +| gpsi | Gpsi | C | 0..1 | Generic Public Subscription Identifier (NOTE 1)
This IE is not applicable to "SMCC_EXP" event. | | +| anyUeInd | boolean | C | 0..1 | This IE shall be present if the event subscription is applicable to any UE. It indicates whether the event subscription is applicable to any UE:
- "true": the event subscription is applicable to any UE;
- "false"(default): the event subscription is not applicable to any UE.
(NOTE 1) (NOTE 4) | | +| groupId | GroupId | C | 0..1 | Identifies a group of UEs. (NOTE 1) | | +| pduSessionId | PduSessionId | C | 0..1 | PDU session ID (NOTE 1) | | +| dnn | Dnn | O | 0..1 | Data Network Name. | | +| snssai | Snssai | O | 0..1 | A single Network Slice Selection Assistance Information. (NOTE 4) | | +| dnai | Dnai | O | 0..1 | Data network access identifier. | UPEAS | +| ssld | string | O | 0..1 | SSID that the PDU session is related to. | UPEAS | +| bssld | string | O | 0..1 | BSSID that the PDU session is related to. | UPEAS | +| upfId | string | O | 0..1 | Identifies the UPF. | UPEAS | +| nfId | NfInstanceId | C | 0..1 | Indicates the instance identity of the NF creating the subscription. It shall be provided if the "eventSubs" attribute contains an entry with the "event" set to the value "UPF_EVENT". | UPEAS | +| subId | SubId | C | 0..1 | Subscription ID.
This parameter shall be supplied by the SMF in HTTP responses that include an object of NsmfEventExposure type. | | +| notifId | string | M | 1 | Notification Correlation ID provided by the NF service consumer. (NOTE 2) | | +| notifUri | Uri | M | 1 | Identifies the recipient of Notifications sent by the SMF. | | +| altNotifIpv4Addrs | array(Ipv4Addr) | O | 1..N | Alternate or backup IPv4 Address(es) where to send Notifications. | | +| altNotifIpv6Addrs | array(Ipv6Addr) | O | 1..N | Alternate or backup IPv6 Address(es) where to send Notifications. | | +| altNotifFqdns | array(Fqdn) | O | 1..N | Alternate or backup FQDN(s) where to send Notifications. | | +| eventSubs | array(EventSubscription) | M | 1..N | Subscribed events. (NOTE 4) | | +| eventNotifs | array(EventNotification) | O | 1..N | Represents the SMF Events to be reported in the Nsmf_EvenExposure_Subscribe response.
May be present when the "ERIR" feature is supported and the "ImmeRep" attribute set to true is included in the subscription request. | ERIR | + +| | | | | | | +|---------------------|-----------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| ImmeRep
(NOTE 6) | boolean | O | 0..1 | It is included and set to true if the immediate reporting of the current status of the subscribed event, if available is required. | | +| notifMethod | NotificationMethod | O | 0..1 | If "notifMethod" is not supplied, the default value "ON_EVENT_DETECTION" applies. (NOTE 4) (NOTE 5) | | +| maxReportNbr | UInteger | O | 0..1 | If omitted, there is no limit. (NOTE 4) (NOTE 5) | | +| expiry | DateTime | C | 0..1 | This attribute indicates the expiry time of the subscription, after which the SMF shall not send any event notifications and the subscription becomes invalid. It may be included in an event subscription request and may be included in an event subscription response based on operator policies. If an expiry time was included in the request, then the expiry time returned in the response should be less than or equal to that value. If the expiry time is not included in the response, the NF service consumer shall not associate an expiry time for the subscription. (NOTE 4) | | +| repPeriod | DurationSec | C | 0..1 | Is supplied for notification Method "periodic". | | +| guami | Guami | C | 0..1 | The Globally Unique AMF Identifier (GUAMI) shall be provided by an AMF as NF service consumer. | | +| serviceName | ServiceName | O | 0..1 | If the NF service consumer is an AMF, it should provide the name of a service produced by the AMF that makes use of the notification about subscribed events. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | List of Supported features used as described in clause 5.8. This parameter shall be supplied by NF service consumer and SMF in the POST request that request the creation of an SMF Notification Subscriptions resource and the related reply, respectively. | | +| sampRatio | SamplingRatio | O | 0..1 | Indicates the ratio of the random subset to target UEs, event reports only relates to the subset. | | +| partitionCriteria | array(PartitioningCriteria) | O | 1..N | Defines criteria for partitioning the UEs in order to apply the sampling ratio for each partition. It may only be included in event subscription requests when the "sampRatio" attribute is also provided. (NOTE 3) | EneNA | +| grpRepTime | DurationSec | O | 0..1 | Indicates the time for which the SMF aggregates the event reports detected by the UEs in a group and report them together to the NF service consumer. | | +| notifFlag | NotificationFlag | O | 0..1 | Indicates the notification flag, which is used to mute/unmute notifications and to retrieve events stored during a period of muted notifications. Default: "ACTIVATE" | EneNA | +| notifFlagInstruct | MutingExceptionInstructions | O | 0..1 | Contains instructions to be executed upon the occurrence of an event muting exception (e.g. full buffer). It may only be provided if the | EnhDataMgmt | + +| | | | | | | +|---------------|------------------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| | | | | "notifFlag" is provided and set to "DEACTIVATE". | | +| mutingSetting | MutingNotifications Settings | O | 0..1 | Contains settings related to the muting of notifications. It may only be provided in the NF service producer response and only if the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes are accepted. | EnhDataMgmt | +| defQosSupp | boolean | O | 0..1 | Indicates whether the NF service consumer requests to receive QoS Flow performance information for the QoS Flow associated with the default QoS rule if there are no measurements available for the provided Application Identifier included within the "appIds" attribute.
True: NF service consumer requests to receive QoS Flow performance information for the QoS Flow associated with the default QoS rule.
False (default): NF service consumer does not request to receive QoS Flow performance information for the QoS Flow associated with the default QoS rule. | UPEAS | +| qosMonPending | boolean | O | 0..1 | Indicates that the reporting will be activated when the measurements are enabled by a PCC rule. It shall be always set to true when present. It may only be provided in the response.
Default value is false. | UPEAS | + +NOTE 1: If the event subscription applies for a specific PDU session, the PDU session of a single UE (pduSeld, and gpsi/supi) shall be included; otherwise one and only one of a single UE (gpsi/supi), a group of UEs (groupId), or anyUeInd set to true shall be included. + +NOTE 2: If the UDM as NF service consumer subscribes to event (e.g. downlink data delivery status, PDU Session Establishment, PDU Session Release) on behalf of AF/NEF, "notifId" shall be set the same as "referenceId" received from the AF/NEF as defined in clause 6.4.6.2.4 of 3GPP TS 29.503 [14]. + +NOTE 3: For a given type of partitioning criteria, the UE shall belong to only one single partition as long as it is served by the NF service producer. + +NOTE 4: If EneNA feature is supported, when the "snssai" attribute is presented together with "anyUeInd" attribute and the "eventSubs" attribute contains "PDU\_SES\_EST" and "PDU\_SES\_REL", then only the "ON\_EVENT\_DETECTION" value is applicable in the "notifMethod" attribute together with "maxReportNbr" attribute and/or "expiry" attribute presence. + +NOTE 5: The attribute "maxReportNbr" is not applicable when the value of "notifMethod" is set to "ONE\_TIME". + +NOTE 6: The attribute does not follow the related naming convention (i.e. "lowerCamel") defined in clause 5.1.4 of 3GPP TS 29.501 [7]. This attribute is however kept as currently defined in this specification for backward compatibility considerations. + +#### 5.6.2.3 Type NsmfEventExposureNotification + +Table 5.6.2.3-1: Definition of type NsmfEventExposureNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| notifId | string | M | 1 | Notification correlation ID used to identify the subscription which the notification is corresponding to. It shall be set to the same value as the "notifId" attribute of NsmfEventExposure data type or the value of "notifCorrelId" within the UpPathChgEvent data type defined in 3GPP TS 29.512 [14], the value of "notifCorrelId" in the "tfcCorrelInfo" attribute within the TrafficControlData data type defined in 3GPP TS 29.512 [14], or the value of "notifCorrelId" within the QosMonitoringData data type defined in 3GPP TS 29.512 [14]. | | +| eventNotifs | array(EventNotification) | M | 1..N | Notifications about Individual Events | | +| ackUri | Uri | O | 0..1 | The URI provided by the SMF for the AF acknowledgement. If present, it only applies to the "UP_PATH_CH" event indicated in the "eventNotifs" attribute. | | + +#### 5.6.2.4 Type EventSubscription + +Table 5.6.2.4-1: Definition of type EventSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------------------------|-----------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------| +| event | SmfEvent | M | 1 | Subscribed events | | +| dnaiChgType | DnaiChangeType | C | 0..1 | For event UP path change, this attribute indicates whether the subscription is for early, late, or early and late DNAI change notification shall be supplied. | | +| dddTraDescriptors | array(DddTrafficDescriptor) | C | 1..N | The traffic descriptor(s) of the downlink data source. Shall be included for event "DDDS". | DownlinkDataDeliveryStatus | +| dddStati | array(DIDataDeliveryStatus) | O | 1..N | May be included for event "DDDS". The subscribed statuses (discarded, transmitted, buffered) for the event. If omitted all statuses are subscribed. | DownlinkDataDeliveryStatus | +| appIds | array(ApplicationId) | O | 1..N | May be included for event "QFI_ALLOC", "DISPERSION" or "QOS_MON".
(NOTE) | QfiAllocation
Dispersion
PduSessionInfo
UPEAS | +| networkArea | NetworkAreaInfo | O | 0..1 | Identification of network area to which the subscription applies. | AreaFilter | +| targetPeriod | TimeWindow | O | 0..1 | Indicates the data collection target period.
May be included for event "SMCC_EXP", "RED_TRANS_EXP" or "WLAN_INFO". | SMCC
RedundantTransmissionExp
WlanPerformance | +| transacDispInd | boolean | O | 0..1 | Indicates the subscription for UE transaction dispersion collection, if it is included and set to "true". Default value is "false".
May be included for event "DISPERSION". | Dispersion | +| transacMetrics | array(TransactionMetric) | O | 1..N | Requested transaction metrics.
May be included for event "DISPERSION". | Dispersion | +| uelpAddr | lpAddr | O | 0..1 | Indicates the UE IP address. May be included for event "DISPERSION". | Dispersion | +| upfEvents | array(UpfEvent) | O | 1..N | Indicates the exposure information related to UPF events.
May be included for event "UPF_EVENT". | UPEAS | +| NOTE: Only one instance of "ApplicationId" shall be provided when the event is "QOS_MON". | | | | | | + +#### 5.6.2.5 Type EventNotification + +Table 5.6.2.5-1: Definition of type EventNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| event | SmfEvent | M | 1 | Event that is notified. | | +| timeStamp | DateTime | M | 1 | Time at which the event is observed. | | +| supi | Supi | C | 0..1 | Subscription Permanent Identifier. It is included when the subscription applies to a group of UE(s) or any UE. (NOTE 9) | | +| gpsi | Gpsi | C | 0..1 | Identifies a GPSI. It shall contain an MSISDN. It is included when it is available and the subscription applies to a group of UE(s) or any UE.
This IE is not applicable to "SMCC_EXP" event. | | +| uelpAddr | IpAddr | C | 0..1 | Indicates the UE IP address, It is included for event "DISPERSION" when it is available and requested in the subscription. | Dispersion | +| transacInfos | array(TransactionInfo) | C | 1..N | Transaction Information. Shall be included for event "DISPERSION". | Dispersion | +| sourceDnai | Dnai | C | 0..1 | Source DN Access Identifier. Shall be included for event "UP_PATH_CH" if the DNAI changed (NOTE 1, NOTE 2). | | +| targetDnai | Dnai | C | 0..1 | Target DN Access Identifier. Shall be included for event "UP_PATH_CH" if the DNAI changed (NOTE 1, NOTE 2). | | +| dnaiChgType | DnaiChangeType | C | 0..1 | DNAI Change Type. Shall be included for event "UP_PATH_CH". | | +| candidateDnais | array(Dnai) | O | 1..N | The candidate DNAI(s) for the PDU Session. May be included for event "UP_PATH_CH". | CommonEAS DNAI | +| easRediscoverInd | boolean | O | 0..1 | Indication of EAS re-discovery. If present and set to "true", it indicates the EAS re-discovery is performed, e.g. due to change of common EAS. Default value is "false" if omitted. | CommonEAS DNAI | +| candDnaisPriInd | boolean | O | 0..1 | If provided and set to "true", it indicates that the candidate DNAIs provided in the "candidateDnais" attribute are in descending priority order, i.e. the lower the array index the higher the priority of the respective DNAI. If omitted, the default value is "false". It may only be provided if the "candidateDnais" attribute is provided and the "dnaiChgType" attribute is set to the value "EARLY". | CommonEAS DNAI | +| trafCorrInfo | TrafficCorrelationNotification | O | 0..1 | Contains traffic correlation information for notification. It shall be provided if the event attribute has the value "TRAFFIC_CORRELATION". | CommonEASDNAI | +| sourceUelpv4Addr | Ipv4Addr | O | 0..1 | The IPv4 Address of the served UE for the source DNAI. May be included for event "UP_PATH_CH". | | +| sourceUelpv6Prefix | Ipv6Prefix | O | 0..1 | The Ipv6 Address Prefix of the served UE for the source DNAI. May be included for event "UP_PATH_CH". | | + +| | | | | | | +|--------------------|----------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| targetUelpv4Addr | Ipv4Addr | O | 0..1 | The IPv4 Address of the served UE for the target DNAI. May be included for event "UP_PATH_CH". | | +| targetUelpv6Prefix | Ipv6Prefix | O | 0..1 | The Ipv6 Address Prefix of the served UE for the target DNAI. May be included for event "UP_PATH_CH". | | +| sourceTraRouting | RouteToLocation | C | 0..1 | N6 traffic routing information for the source DNAI. Shall be included for event "UP_PATH_CH" if available (NOTE 2). | | +| targetTraRouting | RouteToLocation | C | 0..1 | N6 traffic routing information for the target DNAI. Shall be included for event "UP_PATH_CH" if available (NOTE 2). | | +| ueMac | MacAddr48 | O | 0..1 | UE MAC address. May be included for event "UP_PATH_CH". | | +| adIpv4Addr | Ipv4Addr | O | 0..1 | Added IPv4 Address(es). May be included for event "UE_IP_CH". | | +| adIpv6Prefix | Ipv6Prefix | O | 0..1 | Added Ipv6 Address Prefix(es). May be included for event "UE_IP_CH". | | +| relIpv4Addr | Ipv4Addr | O | 0..1 | Removed IPv4 Address(es). May be included for event "UE_IP_CH". | | +| relIpv6Prefix | Ipv6Prefix | O | 0..1 | Removed Ipv6 Address Prefix(es). May be included for event "UE_IP_CH". | | +| plmnId | PlmnIdNid | C | 0..1 | New PLMN Identifier or the SNPN Identifier. Shall be included for event "PLMN_CH". (NOTE 7) | | +| accType | AccessType | C | 0..1 | New Access Type. Shall be included for event "AC_TY_CH" and may be included for event "QFI_ALLOC". | | +| pduAccTypes | array(AccessType) | O | 1..N | The list of Access Types used for the PDU session. May be included for event "QFI_ALLOC". (NOTE 11) | MultipleAccessTypes | +| pduSeld | PduSessionId | C | 0..1 | PDU session ID. Shall be included for event "PDU_SES_REL" and "PDU_SES_EST". It shall also be included for event "QFI_ALLOC" if the subscription was for a UE, a group of UEs, or any UE, and not for a specific PDU Session. | | +| ratType | RatType | C | 0..1 | New RAT Type. Shall be included for event 'RAT_TY_CH'. | EneNA | +| dddStatus | DIDataDeliveryStatus | C | 0..1 | Downlink data delivery status (discarded, transmitted, buffered). Shall be included for event "DDDS", | DownlinkDataDeliveryStatus | +| maxWaitTime | DateTime | C | 0..1 | The estimated maximum waiting time for downlink data delivery, Shall be included for event "DDDS" with status "BUFFERED". | DownlinkDataDeliveryStatus | +| dddTraDescriptor | DddTrafficDescriptor | C | 0..1 | The downlink data descriptor impacted by downlink data delivery status change. Shall be included for event "DDDS" | DownlinkDataDeliveryStatus | +| commFailure | CommunicationFailure | C | 0..1 | Describes the communication failure cause for the UE. Shall be included for event "COMM_FAIL". | CommunicationFailure | +| ipv4Addr | Ipv4Addr | O | 0..1 | IPv4 address. May be included for event "PDU_SES_REL" or "PDU_SES_EST". | PduSessionStatus | +| ipv6Prefixes | array(Ipv6Prefix) | O | 1..N | IPv6 prefixes. May be included for event "PDU_SES_REL" or "PDU_SES_EST". (NOTE 3) | PduSessionStatus | +| ipv6Addrs | array(Ipv6Addr) | O | 1..N | IPv6 addresses. May be included for | PduSessionSt | + +| | | | | | | +|--------------|---------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------| +| | | | | event "PDU_SES_REL" or "PDU_SES_EST". (NOTE 3) | atus | +| pduSessType | PduSessionType | C | 0..1 | PDU session type. Shall be included if the PduSessionStatus or PduSessionInfo feature is supported. (NOTE 8) | PduSessionStatus
PduSessionInfo | +| sscMode | SscMode | O | 0..1 | Represents the SSC mode of the PDU Session. It may be included for event "QFI_ALLOC". (NOTE 8) | PduSessionInfo | +| qfi | Qfi | C | 0..1 | QoS flow identifier. Shall be included for event "QFI_ALLOC". | QfiAllocation | +| appId | ApplicationId | O | 0..1 | Contains the application identifier. May be included for event "QFI_ALLOC". (NOTE 4) (NOTE 8) | QfiAllocation
PduSessionInfo | +| ethFlowDescs | array(EthFlowDescription) | O | 1..N | Descriptor(s) for non-IP traffic in which only ethernet flow description is defined. It allows the encoding of multiple UL and/or DL flows. Each entry of the array describes a single Ethernet flow. May be included for event "QFI_ALLOC", when the description of the Ethernet traffic requires multiple UL and/or DL flows. (NOTE 4) | MultipleFlowDescriptions | +| ethfDescs | array(EthFlowDescription) | O | 1..2 | Contains the flow description for the Uplink and/or Downlink Ethernet flows. May be included for event "QFI_ALLOC". (NOTE 4) | QfiAllocation | +| flowDescs | array(FlowDescription) | O | 1..N | Descriptor(s) of IP traffic. It allows the encoding of multiple UL and/or DL flows. Each entry of the array describes a single IP flow. May be included for event "QFI_ALLOC", when the description of the IP traffic requires multiple UL and/or DL flows. (NOTE 4) | MultipleFlowDescriptions | +| fDescs | array(FlowDescription) | O | 1..2 | Contains the flow description for the Uplink and/or Downlink IP flows. May be included for event "QFI_ALLOC". (NOTE 4) | QfiAllocation | +| dnn | Dnn | C | 0..1 | Data network name, Shall be included for event "QFI_ALLOC". May be included for event "PDU_SES_REL" or "PDU_SES_EST". Shall be included to indicate the DNN associated with URLLC service for event "RED_TRANS_EXP". Shall be included if DNN based SMCC is applied. | QfiAllocation,
PduSessionStatus
RedundantTransmissionExp
SMCCE | +| snssai | Snssai | C | 0..1 | Identifies the slice information. Shall be included for event "QFI_ALLOC". Shall be included if S-NSSAI based SMCC is applied. | QfiAllocation
EneNA
SMCCE | +| ulDelays | array(Uinteger) | O | 1..N | Uplink packet delay in units of milliseconds. May be included for event "QOS_MON". (NOTE 5) | QoSMonitoring
E2eDataVolTransTime | +| dlDelays | array(Uinteger) | O | 1..N | Downlink packet delay in units of milliseconds. May be included for event "QOS_MON". (NOTE 5) | QoSMonitoring
E2eDataVolTransTime | +| ulCongInfo | Uinteger | O | 0..1 | Uplink congestion information. Percentage of packets that UPF uses for ECN marking for L4S (without "%" sign). (NOTE 10) | EnQoSMon | +| dlCongInfo | Uinteger | O | 0..1 | Downlink congestion information. | EnQoSMon | + +| | | | | | | +|--------------|------------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------| +| | | | | Percentage of packets that UPF uses for ECN marking for L4S (without "%" sign). (NOTE 10) | | +| cimf | boolean | O | 0..1 | Congestion information measurement failure indicator. When set to true, it indicates that a congestion information failure has occurred. Default value is false if omitted. (NOTE 10) | EnQoSMon | +| rtDelays | array(UInteger) | O | 1..N | Round trip delay in units of milliseconds. May be included for event "QOS_MON". (NOTE 5) | QoSMonitoring
E2eDataVolTransTime | +| ulDataRate | BitRate | O | 0..1 | Uplink data rate.(NOTE 12) | EnQoSMon | +| dlDataRate | BitRate | O | 0..1 | Downlink data rate.(NOTE 12) | EnQoSMon | +| timeWindow | TimeWindow | C | 0..1 | Time window representing a start time and a stop time of the data collection period. Shall be included for event "SMCC_EXP". | SMCCE | +| smNasFromUe | array(SmNasFromUe) | C | 1..N | Information on the SM NAS messages that SMF receives from UE for PDU Session. Shall be included for event "SMCC_EXP". | SMCCE | +| smNasFromSmf | array(SmNasFromSmf) | C | 1..N | Information on the SM congestion control applied SM NAS messages that SMF sends to UE for PDU Session. Shall be included for event "SMCC_EXP". | SMCCE | +| upRedTrans | boolean | C | 0..1 | Indicates whether the redundant transmission is setup or terminated. Set to "true" if the redundant transmission is setup, otherwise set to "false" if the redundant transmission is terminated. Default value is set to "false". Shall be included for event "RED_TRANS_EXP". | RedundantTransmissionExp | +| ssid | string | C | 0..1 | SSID that the PDU session is related to. (NOTE 6) | WlanPerformance | +| bssid | string | C | 0..1 | BSSID that the PDU session is related to. (NOTE 6) | WlanPerformance | +| startWlan | DateTime | C | 0..1 | The time stamp that indicates when the existing PDU Session's access type changes to WLAN or when the new PDU Session for WLAN is established. (NOTE 6) | WlanPerformance | +| endWlan | DateTime | C | 0..1 | The time stamp that indicates when the existing WLAN based PDU Session's access type is not WLAN any more or when the PDU Session for WLAN is released. (NOTE 6) | WlanPerformance | +| pduSessInfos | array(PduSessionInformation) | C | 1..N | The PDU session related information. It shall be included for event "UP_STATUS_INFO". | UeCommunication | +| upfInfo | UpfInformation | C | 0..1 | The information of the UPF serving the UE. Shall be included for event "UPF_INFO". | ServiceExperience
DnPerformance | +| pdmf | boolean | O | 0..1 | Packet delay measurement failure indicator. When set to true, it indicates that a packet delay failure has occurred, i.e. no measurement result is available during the reporting period. Default value is false if omitted. May be included for event | PacketDelayFailureReport | + +| | | | | | | +|-------------------|---------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| | | | | "QOS_MON". | | +| satBackhaulCat | SatelliteBackhaulCategory | C | 0..1 | The satellite backhaul category or non-satellite backhaul used for the PDU session shall be included for event "SATB_CH". | EnSatBackhaulCategoryChg | +| supportedFeatures | SupportedFeatures | C | 0..1 | List of negotiated features supported by the SMF and NF service consumer as described in clause 5.8.
This parameter shall be supplied by the SMF when the SMF detects that at least one feature related to an implicit subscription is supported by both the SMF and the NF service consumer. | | +| targetAfId | string | O | 0..1 | Identifier of the Application Function responsible for the target DNAI. May be included for event "UP_PATH_CH" if the target DNAI is not known to the source AF. | EasRelocationEnh | +| 5qi | 5Qi | O | 0..1 | The 5G QoS Identifier. May be included for event "QFI_ALLOC". | EnQfiAllocation | + +| | | +|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE 1: | If the DNAI is not changed while the N6 traffic routing information is changed, the "sourceDnai" attribute and "targetDnai" attribute shall not be provided. | +| NOTE 2: | The change from the UP path status where no DNAI applies to a status where a DNAI applies indicates the activation of the related AF request and therefore only the target DNAI and N6 traffic routing information is provided in the event notification; the change from the UP path status where a DNAI applies to a status where no DNAI applies indicates the de-activation of the related AF request and therefore only the source DNAI and N6 traffic routing information is provided in the event notification. | +| NOTE 3: | If provided, either ipv6Prefixes or ipv6Addrs shall be present. | +| NOTE 4: | Only one of the appId, ethFDescs, ethFlowDescs, flowDescs or fDescs attributes shall be provided. | +| NOTE 5: | In this release of the specification the maximum number of elements in the array is 2. If more than one value is received at one given point of time for UL packet delay, DL packet delay or round trip packet delay respectively, the SMF reports the minimum and maximum packet delays to the NEF/AF. | +| NOTE 6: | If notified event is "WLAN_INFO", then one of the "ssid" or "bssid" attribute and one of the "startWLAN" or "endWLAN" attribute shall be present. | +| NOTE 7: | The SNPn Identifier consists of the PLMN Identifier and the NID. | +| NOTE 8: | When the subscribed event is "QFI_ALLOC" and the PduSessionInfo feature is supported, if the "pduSessionType" attribute and/or "sscMode" attribute is included, the associated "appId" attribute shall be provided. | +| NOTE 9: | If the "WlanPerformanceExt_AIML" feature is supported, the "supi" attribute may also be included for a single UE when the subscription applies to the "WLAN_INFO" event. | +| NOTE 10: | If the "cimf" attribute is set to true, "ulConInfo" and "dlConInfo" shall not be present. | +| NOTE 11: | If multiple Access Types are used for the PDU session and the "MultipleAccessTypes" feature is supported, the SMF shall include one Access Type in the "accType" attribute and the remaining Access Types in the "addAccTypes" attribute. | +| NOTE 12: | When the "ulDataRate" and/or "dlDataRate" attributes are present, the congestion related attributes and the packet delay related attributes shall not be present. | + +Editor's note: Whether the "ulCongInfo" and "dlCongInfo" attributes are single or plural is FFS. + +5.6.2.6 void. + +5.6.2.7 Type AckOfNotify + +Table 5.6.2.7-1: Definition of type AckOfNotify + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|-------------------------------------------------------------------------------------|---------------| +| notifId | string | M | 1 | Notification correlation ID provided by the SMF during UP path change notification. | | +| ackResult | AfResultInfo | M | 1 | Identifies the result of application layer handling. | | +| supi | Supi | O | 0..1 | Subscription Permanent Identifier. | | +| gpsi | Gpsi | O | 0..1 | Identifies a GPSI. | | + +5.6.2.8 Type SmNasFromUe + +Table 5.6.2.8-1: Definition of type SmNasFromUe + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------|---------------| +| smNasType | string | M | 1 | The type of SM NAS message transmitted by UE (e.g. PDU Session Establishment Request, PDU Session Modification Request, etc.). | | +| timeStamp | DateTime | M | 1 | Indicates the time stamp when SMF receives SM NAS message from UE. | | + +5.6.2.9 Type SmNasFromSmf + +Table 5.6.2.9-1: Definition of type SmNasFromSmf + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| smNasType | string | M | 1 | The type of SM NAS message with backoff timer provided to UE (e.g. PDU Session Establishment Reject, PDU Session Modification Reject, PDU Session Release Command, etc.). | | +| timeStamp | DateTime | M | 1 | Indicates the time stamp when SMF sends SM NAS message to UE. | | +| backOffTimer | DurationSec | M | 1 | Indicates the value of backoff timer provided to UE in terms of time units of seconds. | | +| appliedSmccType | AppliedSmccType | M | 1 | The type of applied SM congestion control, i.e. DNN based congestion control or S-NSSAI based congestion control. | | + +#### 5.6.2.10 Type TransactionInfo + +Table 5.6.2.10-1: Definition of type TransactionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|---------------------------------------------------|---------------| +| transaction | UInteger | M | 1 | Number of transactions. | | +| snssai | Snssai | C | 0..1 | Identifier of the network slice. | | +| appIds | array(ApplicationId) | O | 1..N | Application Identifiers. | | +| transMetrics | array(TransactionMetric) | O | 1..N | Indicates Session Management Transaction metrics. | | + +#### 5.6.2.11 Type PduSessionInformation + +Table 5.6.2.11-1: Definition of type PduSessionInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|--------------------------------------------------------------------|---------------| +| pduSessionId | PduSessionId | C | 0..1 | Identification of PDU Session. It shall be provided if available. | | +| sessInfo | PduSessionInfo | C | 0..1 | Represents session information. It shall be provided if available. | | + +#### 5.6.2.12 Type PduSessionInfo + +Table 5.6.2.12-1: Definition of type PduSessionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------|---|-------------|-------------------------------------------------------------------------------|---------------| +| n4SessionId | string | C | 0..1 | Identification of N4 Session. It shall be provided if available. | | +| sessInactiveTime | DurationSec | C | 0..1 | The value of the session inactivity timer. It shall be provided if available. | | +| pduSessionStatus | PduSessionStatus | C | 0..1 | Status of the PDU Session. It shall be provided if available. | | + +#### 5.6.2.13 Type UpfInformation + +Table 5.6.2.13-1: Definition of type UpfInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-----------------------------------------------------------------|---------------| +| upfId | string | C | 0..1 | Identifies the UPF.
(NOTE 1) (NOTE 2) | | +| upfAddr | AddrFqdn | C | 0..1 | Represents the IP address/FQDN of the UPF.
(NOTE 1) (NOTE 2) | | + +NOTE 1: At least one of the "upfId" attribute and "upfAddr" attribute shall be included. + +NOTE 2: The "upfId" attribute and "upfAddr" attribute may indicate an anchor UPF of the PDU session containing the QoS flow. + +#### 5.6.2.14 Type: TrafficCorrelationNotification + +**Table 5.6.2.14-1: Definition of type TrafficCorrelationNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|---------------------------------------------------------------------------------------------|---------------| +| smfId | NfInstanceId | M | 1 | Identifies the SMF Id sending the notification. | | +| tfCorrId | string | M | 1 | Identification of traffic correlation. | | +| dnais | array(Dnai) | C | 1..N | Identification(s) of user plane access to DN(s) which the subscription applies.
(NOTE 2) | | +| easFqdn | Fqdn | C | 0..1 | The Fqdn of the EAS.
(NOTE 1) (NOTE 2) | | +| easIpAddr | IpAddr | C | 0..1 | Indicates the EAS IP address based on EASDF procedure.
(NOTE 1) (NOTE 2) | | +| pduSessionNbr | Uinteger | M | 1 | Indicates the number of PDU sessions that the SMF is serving for the UE(s). | | + +NOTE 1: The "easFqdn" attribute and the "easIpAddr" attribute are mutually exclusive. +NOTE 2: At least one of the "dnais" attribute and the EAS ID ("easFqdn" attribute or "easIpAddr" attribute) shall be provided. + +### 5.6.3 Simple data types and enumerations + +#### 5.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 5.6.3.2 Simple data types + +The simple data types defined in table 5.6.3.2-1 shall be supported. + +**Table 5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| SubId | string | Identifies an Individual SMF Notification Subscription. To enable that the value is used as part of a URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501 [5]. In an OpenAPI [10] schema, the format shall be designated as "SubId". | | + +#### 5.6.3.3 Enumeration: SmfEvent + +Table 5.6.3.3-1: Enumeration SmfEvent + +| Enumeration value | Description | Applicability | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| AC TY CH | Access Type Change | | +| UP_PATH_CH | UP Path Change | | +| PDU_SES_REL | PDU Session Release | | +| PLMN_CH | PLMN Change | | +| UE_IP_CH | UE IP address change | | +| RAT TY_CH | RAT Type Change | EneNA | +| DDDS | Downlink data delivery status | DownlinkDataDeliveryStatus | +| COMM_FAIL | Communication failure | CommunicationFailure | +| PDU_SES_EST | PDU Session Establishment | PduSessionStatus | +| QFI_ALLOC | QFI allocation | QfiAllocation | +| QOS_MON | QoS Monitoring | QoSMonitoring | +| SMCC_EXP | SM congestion control experience for PDU Session | SMCCE | +| DISPERSION | Session Management transaction dispersion | Dispersion | +| RED_TRANS_EXP | Redundant transmission experience for PDU Session | RedundantTransmissionExp | +| WLAN_INFO | WLAN information on PDU session for which Access Type is NON_3GPP_ACCESS and RAT Type is TRUSTED_WLAN | WlanPerformance | +| UPF_INFO | The UPF information, including the UPF ID/address/FQDN information. | ServiceExperienceDnPerformance | +| UP_STATUS_INFO | User Plane status information | UeCommunication | +| UPF_EVENT | UPF event subscribed via SMF. (NOTE) | UPEAS | +| SATB_CH | Indicates that the SMF has detected a change between different satellite category, or non-satellite backhaul | EnSatBackhaulCategoryChg | +| TRAFFIC_CORRELATION | Indicates that the SMF provides 5GC determined traffic correlation information for a set of UEs identified by Traffic Correlation ID. | CommonEASDNI | + +NOTE: UPF\_EVENT shall only be used for "USER\_DATA\_USAGE\_MEASURES" and "USER\_DATA\_USAGE\_TRENDS" event types in 3GPP TS 29.564 [26]. + +#### 5.6.3.4 Enumeration: NotificationMethod + +The enumeration NotificationMethod represents the notification methods that can be subscribed. It shall comply with the provisions defined in table 5.6.3.4-1. + +Table 5.6.3.4-1: Enumeration NotificationMethod + +| Enumeration value | Description | Applicability | +|--------------------|-----------------------------------------------------------|---------------| +| PERIODIC | The notification is periodically sent. | | +| ONE_TIME | The notification is only sent one time. | | +| ON_EVENT_DETECTION | The notification is sent each time the event is detected. | | + +5.6.3.5 void. + +5.6.3.6 Enumeration: AppliedSmccType + +**Table 5.6.3.6-1: Enumeration AppliedSmccType** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------|---------------| +| DNN_CC | Indicates the DNN based congestion control. | | +| SNSSAI_CC | Indicates the S-NSSAI based congestion control. | | + +5.6.3.7 Enumeration: TransactionMetric + +**Table 5.6.3.7-1: Enumeration TransactionMetric** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------|---------------| +| PDU_SES_EST | PDU Session Establishment | | +| PDU_SES_AUTH | PDU Session Authentication | | +| PDU_SES_MODIF | PDU Session Modification | | +| PDU_SES_REL | PDU Session Release | | + +5.6.3.8 Enumeration: PduSessionStatus + +**Table 5.6.3.8-1: Enumeration PduSessionStatus** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------|---------------| +| ACTIVATED | Indicates the pdu session status is activated. | | +| DEACTIVATED | Indicates the pdu session status is deactivated. | | + +## 5.7 Error handling + +### 5.7.1 General + +For the Nsmf\_EventExposure API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. + +Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nsmf\_EventExposure API. + +### 5.7.2 Protocol Errors + +No specific procedures for the Nsmf\_EventExposure service are specified. + +### 5.7.3 Application Errors + +The application errors defined for the Nsmf\_EventExposure service are listed in Table 5.7.3-1. + +**Table 5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------|------------------|------------------------------------------------------------------------------------------------------------| +| MUTING_INSTR_NOT_ACCEPTED | 403 Forbidden | Indicates that the muting instructions received by the NF service consumer cannot be accepted. | +| NO_ACTIVE_PCC_RULE | 403 Forbidden | Indicates that QoS monitoring cannot be performed because there is no PCC rule active for the application. | + +## 5.8 Feature negotiation + +The optional features in table 5.8-1 are defined for the Nsmf\_EventExposure API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +Table 5.8-1: Supported Features + +| Feature number | Feature Name | Description | +|----------------|----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | DownlinkDataDeliveryStatus | This feature indicates support for the "Downlink data delivery status" event. | +| 2 | CommunicationFailure | This feature indicates support for the "communication failure" event. | +| 3 | PduSessionStatus | This feature indicates support for the PDU session establishment event and enhancement (PDU session type, IP address) for the PDU session release event. | +| 4 | QfiAllocation | This feature indicates support for the "QFI allocation" event. | +| 5 | QosMonitoring | This feature indicates support for the "QoS Monitoring" event. (NOTE 1) | +| 6 | ES3XX | Extended Support for 3xx redirections. This feature indicates the support of redirection for any service operation, according to Stateless NF procedures as specified in clauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [4] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. | +| 7 | EneNA | This feature indicates support for the enhancements of network data analytics requirements. | +| 8 | ULBuffering | This feature indicates support for Uplink buffering indication. (See NOTE 2) | +| 9 | SMCCE | This feature indicates support for Session Management Congestion Control Experience for PDU Session. | +| 10 | Dispersion | This feature indicates support for Session Management transactions dispersion. | +| 11 | ERIR | Indicates the support of immediate report of the available subscribed event(s) within the subscription response to the NF service consumer. | +| 12 | RedundantTransmissionExp | This feature indicates support for Redundant Transmission Experience. | +| 13 | WlanPerformance | This feature indicates support for WLAN information on PDU Session for which Access Type is NON_3GPP_ACCESS and RAT Type is TRUSTED_WLAN, to support WLAN performance analytics. | +| 14 | EASIPreplacement | This feature indicates the support of provisioning of EAS IP replacement info (See NOTE 2). | +| 15 | BIUMR | This feature bit indicates whether the NF Service Consumer (e.g. SMF) and PCF supports Binding Indication Update for multiple resource contexts specified in clauses 6.12.1 and 5.2.3.2.6 of 3GPP TS 29.500 [4]. | +| 16 | UeCommunication | This feature indicates the support of UE communication analytics. | +| 17 | ServiceExperience | This feature indicates support for service experience analytics. | +| 18 | DnPerformance | This feature indicates support for DN performance analytics. | +| 19 | MultipleFlowDescriptions | This feature indicates the support of the report of multiple UL and/or DL flows. | +| 20 | PacketDelayFailureReport | This feature indicates the support of packet delay failure report as part of QoS Monitoring procedures. This feature requires that QosMonitoring feature is supported. | +| 21 | CommonEASDNAI | This feature indicates support of enhancements of UP path change event notification. (NOTE 1) | +| 22 | PduSessionInfo | This feature indicates support for PDU Session parameters information. | +| 23 | EnhDataMgmt | Indicates the support of enhanced data management mechanisms. Supporting this feature also requires the support of feature EneNA. | +| 24 | WlanPerformanceExt_AIML | This feature indicates support for the enhancements of WLAN performance supporting AIML, including support of analytics per UE granularity. Supporting this feature also requires the support of feature WlanPerformance. | +| 25 | EasRelocationEnh | This feature indicates enhanced support of EAS relocation procedures via additional information about the AFs that are responsible for certain EAS. | +| 26 | UPEAS | This feature indicates the support of UPF enhancements for exposure. | + +| | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 27 | EnSatBackhaulCategoryChg | This feature indicates the support of notification of a change between different satellite backhaul categories, or dynamic satellite backhaul categories, or between satellite backhaul and non-satellite backhaul. | +| 28 | E2eDataVolTransTime | This feature indicates support for E2E data volume transfer time analytics. | +| 29 | XRM_5G | This feature indicates the support of multi-modal communication service for extended reality (XR) and interactive media services. | +| 30 | AreaFilter | This feature indicates support for using an area as a subscription filter. | +| 31 | MultipleAccessTypes | This feature indicates the support of providing list of Access Type(s) used for the PDU Session. | +| 32 | EnQfiAllocation | Indicates the enhancement on "QFI allocation" event. Supporting this feature also requires the support of feature QfiAllocation. | +| 33 | EnQoSMon | This feature indicates the support of enhanced QoS monitoring functionality, i.e. the report of the congestion information, and/or, the data rate information monitoring. | +| NOTE 1: SMF determines the support of this feature by the NF service consumer as part of the implicit subscription information provided by the PCF as described in 3GPP TS 29.512 [14] for the "UP_PATH_CH" event and "TRAFFIC_CORRELATION" event. | | | +| NOTE 2: NF service consumers determine the support of this feature as part of the notification of the implicitly subscribed events as described in clause 4.2.2.2. | | | + +## 5.9 Security + +As indicated in 3GPP TS 33.501 [15] and 3GPP TS 29.500 [4], the access to the Nsmf\_EventExposure API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [16]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [12]) plays the role of the authorization server. + +If OAuth2 is used, an NF service consumer, prior to consuming services offered by the Nsmf\_EventExposure API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [12], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF service consumer used for discovering the Nsmf\_EventExposure service. + +The Nsmf\_EventExposure API defines a single scope "nsmf-event-exposure" for the entire service, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +The present Annex contains an OpenAPI [10] specification of HTTP messages and content bodies used by the Nsmf\_EventExposure API. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API. + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification file contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [19] and clause 5.3.1 of the 3GPP TS 29.501 [5] for further information). + +## A.2 Nsmf\_EventExposure API + +``` +openapi: 3.0.0 + +info: + version: 1.3.0-alpha.5 + title: Nsmf_EventExposure + description: | + Session Management Event Exposure Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.508 V18.4.0; 5G System; Session Management Event Exposure Service. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.508/ + +servers: + - url: '{apiRoot}/nsmf-event-exposure/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nsmf-event-exposure + +paths: + /subscriptions: + post: + operationId: CreateIndividualSubscription + summary: Create an individual subscription for event notifications from the SMF + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NsmfEventExposure' + responses: + '201': + description: Created. + headers: + Location: + description: > +``` + +``` + + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nsmf-event-exposure/v1/subscriptions/{subId} + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/NsmfEventExposure' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + myNotification: + '{$request.body#/notifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NsmfEventExposureNotification' + responses: + '204': + description: No Content, Notification was successful. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + afAcknowledgement: + '{request.body#/ackUri}': + post: + +``` + +``` + + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AckOfNotify' + responses: + '204': + description: No Content (successful acknowledgement) + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subId}: + get: + operationId: GetIndividualSubscription + summary: Read an individual subscription for event notifications from the SMF + tags: + - IndividualSubscription (Document) + parameters: + - name: subId + in: path + description: Event Subscription ID + required: true + schema: + type: string + responses: + '200': + description: OK. Resource representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/NsmfEventExposure' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + +``` + +``` +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + operationId: ReplaceIndividualSubscription + summary: Replace an individual subscription for event notifications from the SMF + tags: + - IndividualSubscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NsmfEventExposure' + parameters: + - name: subId + in: path + description: Event Subscription ID + required: true + schema: + type: string + responses: + '200': + description: OK. Resource was successfully modified and representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/NsmfEventExposure' + '204': + description: No Content. Resource was successfully modified + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + operationId: DeleteIndividualSubscription + summary: Delete an individual subscription for event notifications from the SMF + tags: + - IndividualSubscription (Document) + parameters: + - name: subId + in: path + description: Event Subscription ID + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +``` + +``` +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nsmf-event-exposure: Access to the Nsmf_EventExposure API + +schemas: + + NsmfEventExposure: + description: > + Represents an Individual SMF Notification Subscription resource. The serviceName property + corresponds to the serviceName in the main body of the specification. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + anyUeInd: + type: boolean + description: > + Any UE indication. This IE shall be present if the event subscription is applicable to + any UE. Default value "false" is used, if not present. + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + pduSeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + ssid: + type: string + description: SSID that the PDU session is related to. + bssId: + type: string + description: BSSID that the PDU session is related to. + upfId: + type: string + description: UPF identity. + nfid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + subId: + $ref: '#/components/schemas/SubId' + notifId: + type: string + description: Notification Correlation ID assigned by the NF service consumer. + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + altNotifIpv4Addrs: + type: array + items: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +description: Alternate or backup IPv4 address(es) where to send Notifications. +minItems: 1 +altNotifIpv6Addrs: +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' +description: Alternate or backup IPv6 address(es) where to send Notifications. +minItems: 1 +altNotifFqdns: +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +minItems: 1 +description: Alternate or backup FQDN(s) where to send Notifications. +eventSubs: +type: array +items: + $ref: '#/components/schemas/EventSubscription' +minItems: 1 +description: Subscribed events +eventNotifs: +type: array +items: + $ref: '#/components/schemas/EventNotification' +minItems: 1 +ImmeRep: +type: boolean +notifMethod: +$ref: '#/components/schemas/NotificationMethod' +maxReportNbr: +$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' +expiry: +$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +repPeriod: +$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +guami: +$ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' +serviveName: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' +supportedFeatures: +$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +sampRatio: +$ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' +partitionCriteria: +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PartitioningCriteria' +minItems: 1 +description: Criteria for partitioning the UEs before applying the sampling ratio. +grpRepTime: +$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +notifFlag: +$ref: 'TS29571_CommonData.yaml#/components/schemas/NotificationFlag' +notifFlagInstruct: +$ref: 'TS29571_CommonData.yaml#/components/schemas/MutingExceptionInstructions' +mutingSetting: +$ref: 'TS29571_CommonData.yaml#/components/schemas/MutingNotificationsSettings' +defQosSupp: +type: boolean +description: > + Indicates whether the NF service consumer requests to receive QoS Flow performance + information for the QoS Flow associated with the default QoS rule if there are no + measurements available for the provided Application Identifier included in the appIds + attribute. +qosMonPending: +type: boolean +description: > + Indicates that the reporting will be activated when the measurements are enabled by a + PCC rule. It shall always be set to true when present. It may only be provided in the + response. +required: +- notifId +- notifUri +- eventSubs + +NsmfEventExposureNotification: +description: Represents notifications on events that occurred. +``` + +``` +type: object +properties: + notifId: + type: string + description: Notification correlation ID + eventNotifs: + type: array + items: + $ref: '#/components/schemas/EventNotification' + minItems: 1 + description: Notifications about Individual Events + ackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + required: + - notifId + - eventNotifs + +EventSubscription: + description: Represents a subscription to a single event. + type: object + properties: + event: + $ref: '#/components/schemas/SmfEvent' + dnaIChgType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DnaiChangeType' + dddTraDescriptors: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor' + minItems: 1 + dddStati: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus' + minItems: 1 + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + networkArea: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + targetPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + transacDispInd: + type: boolean + description: > + Indicates the subscription for UE transaction dispersion collectionon, if it is included + and set to "true". Default value is "false". + transacMetrics: + type: array + items: + $ref: '#/components/schemas/TransactionMetric' + description: Indicates Session Management Transaction metrics. + minItems: 1 + ueIpAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + upfEvents: + type: array + items: + $ref: 'TS29564_Nupf_EventExposure.yaml#/components/schemas/UpfEvent' + description: Indicates UPF event exposure information. + minItems: 1 + required: + - event + +EventNotification: + description: Represents a notification related to a single event that occurred. + type: object + properties: + event: + $ref: '#/components/schemas/SmfEvent' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' +``` + +``` +ueIpAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' +transacInfos: + type: array + items: + $ref: '#/components/schemas/TransactionInfo' + description: Transaction Information. + minItems: 1 +sourceDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' +targetDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' +dnaiChgType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DnaiChangeType' +candidateDnais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + description: The candidate DNAI(s) for the PDU Session. +candDnaisPrioInd: + type: boolean + description: > + If provided and set to true, it indicates that the candidate DNAIs provided + in the candidateDnais attribute are in descending priority order, i.e., + the lower the array index the higher the priority of the respective DNAI. + If omitted, the default value is false. +easRediscoverInd: + type: boolean + description: > + Indication of EAS re-discovery. If present and set to "true", it indicates the EAS + re-discovery is performed, e.g. due to change of common EAS. Default value is "false" if + omitted. +trafCorreInfo: + $ref: '#/components/schemas/TrafficCorrelationNotification' +sourceUeIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +sourceUeIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' +targetUeIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +targetUeIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' +sourceTraRouting: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' +targetTraRouting: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' +ueMac: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' +adIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +adIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' +reIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +reIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' +plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +accType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' +pduAccTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 +pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' +ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' +dddStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus' +dddTraDescriptor: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor' +maxWaitTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +commFailure: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/CommunicationFailure' +``` + +``` +ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +ipv6Prefixes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 +ipv6Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 +pduSessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' +sscMode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode' +qfi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' +appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' +ethFlowDescs: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + minItems: 1 + description: > + Descriptor(s) for non-IP traffic. It allows the encoding of multiple UL and/or DL flows. + Each entry of the array describes a single Ethernet flow. +ethfDescs: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + minItems: 1 + maxItems: 2 + description: > + Contains the UL and/or DL Ethernet flows. Each entry of the array describes a single + Ethernet flow. +flowDescs: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription' + minItems: 1 + description: > + Descriptor(s) for IP traffic. It allows the encoding of multiple UL and/or DL flows. + Each entry of the array describes a single IP flow. +fDescs: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription' + minItems: 1 + maxItems: 2 + description: > + Contains the UL and/or DL IP flows. Each entry of the array describes a single + IP flow. +dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +ulDelays: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + minItems: 1 +dlDelays: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + minItems: 1 +rtDelays: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + minItems: 1 +ulCongInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +dlCongInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +cimf: +``` + +``` + type: boolean + description: Represents the congestion information measurement failure indicator. + ulDataRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + dlDataRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + timeWindow: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + smNasFromUe: + $ref: '#/components/schemas/SmNasFromUe' + smNasFromSmf: + $ref: '#/components/schemas/SmNasFromSmf' + upRedTrans: + type: boolean + description: > + Indicates whether the redundant transmission is setup or terminated. Set to "true" if + the redundant transmission is setup, otherwise set to "false" if the redundant + transmission is terminated. Default value is set to "false". + ssId: + type: string + bssId: + type: string + startWlan: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + endWlan: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + pduSessionInfos: + type: array + items: + $ref: '#/components/schemas/PduSessionInformation' + minItems: 1 + upfInfo: + $ref: '#/components/schemas/UpfInformation' + pdmf: + type: boolean + description: Represents the packet delay measurement failure indicator. + satBackhaulCat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + targetAfId: + type: string + description: Identifier of the Application Function responsible for the target DNAI. + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + required: + - event + - timeStamp + not: + required: [ipv6Prefixes, ipv6Addrs] + +SubId: + type: string + format: SubId + description: > + Identifies an Individual SMF Notification Subscription. To enable that the value is used as + part of a URI, the string shall only contain characters allowed according to the + "lower-with-hyphen" naming convention defined in 3GPP TS 29.501. In an OpenAPI schema, the + format shall be designated as "SubId". + +AckOfNotify: + description: Represents an acknowledgement information of an event notification. + type: object + properties: + notifId: + type: string + ackResult: + $ref: 'TS29522_TrafficInfluence.yaml#/components/schemas/AfResultInfo' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + required: + - notifId + - ackResult + +SmNasFromUe: + description: > +``` + +``` + Represents information on the SM NAS messages that SMF receives from UE for PDU Session. + type: object + properties: + smNasType: + type: string + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - smNasType + - timeStamp + +SmNasFromSmf: + description: > + Represents information on the SM congestion control applied SM NAS messages that SMF sends + to UE for PDU Session. + type: object + properties: + smNasType: + type: string + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + backoffTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + appliedSmccType: + $ref: '#/components/schemas/AppliedSmccType' + required: + - smNasType + - timeStamp + - backoffTimer + - appliedSmccType + +TransactionInfo: + description: Represents SMF Transaction Information. + type: object + properties: + transaction: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + transacMetrics: + type: array + items: + $ref: '#/components/schemas/TransactionMetric' + minItems: 1 + required: + - transaction + +PduSessionInformation: + description: Represents the PDU session related information. + type: object + properties: + pduSessId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + sessInfo: + $ref: '#/components/schemas/PduSessionInfo' + +PduSessionInfo: + description: Represents session information. + type: object + properties: + n4SessId: + type: string + description: The identifier of the N4 session for the reported PDU Session. + sessInactiveTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + pduSessStatus: + $ref: '#/components/schemas/PduSessionStatus' + +UpfInformation: + description: Represents the ID/address/FQDN of the UPF. + type: object + properties: + upfId: +``` + +``` +type: string +upfAddr: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AddrFqdn' + +TrafficCorrelationNotification: + description: Represents notifications for 5GC determined Traffic Correlation Information. + type: object + properties: + smfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + tfcCorrId: + type: string + description: > + Identification of a set of UEs accessing the application identified by the + Application Identifier or traffic filtering information. + dnais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + easFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + easIpAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + pduSessionNbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + required: + - smfId + - pduSessionNbr + - tfcCorrId + anyOf: + - required: [dnais] + - anyOf: + - required: [easFqdn] + - required: [easIpAddr] + +SmfEvent: + anyOf: + - type: string + enum: + - AC TY_CH + - UP_PATH_CH + - PDU_SES_REL + - PLMN_CH + - UE_IP_CH + - RAT TY_CH + - DDDS + - COMM_FAIL + - PDU_SES_EST + - QFI_ALLOC + - QOS_MON + - SMCC_EXP + - DISPERSION + - RED_TRANS_EXP + - WLAN_INFO + - UPF_INFO + - UP_STATUS_INFO + - SATB_CH + - TRAFFIC_CORRELATION + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration and is not used to encode + content defined in the present version of this API. + description: | + Represents the types of events that can be subscribed. + Possible values are: + - AC TY_CH: Access Type Change. + - UP_PATH_CH: UP Path Change. + - PDU_SES_REL: PDU Session Release. + - PLMN_CH: PLMN Change. + - UE_IP_CH: UE IP address change. + - RAT TY_CH: RAT Type Change. + - DDDS: Downlink data delivery status. + - COMM_FAIL: Communication Failure. + - PDU_SES_EST: PDU Session Establishment. + - QFI_ALLOC: QFI allocation. + - QOS_MON: QoS Monitoring. +``` + +- SMCC\_EXP: SM congestion control experience for PDU Session. +- DISPERSION: Session Management transaction dispersion. +- RED\_TRANS\_EXP: Redundant transmission experience for PDU Session. +- WLAN\_INFO: WLAN information on PDU session for which Access Type is NON\_3GPP\_ACCESS and RAT Type is TRUSTED\_WLAN. +- UPF\_INFO: The UPF information, including the UPF ID/address/FQDN information. +- UP\_STATUS\_INFO: The User Plane status information. +- SATB\_CH: Satellite backhaul category change. +- TRAFFIC\_CORRELATION: Indicates that the SMF provides 5GC determined traffic correlation information for a set of UEs identified by Traffic Correlation ID. + +### NotificationMethod: + +anyOf: + +- type: string +enum: + - PERIODIC + - ONE\_TIME + - ON\_EVENT\_DETECTION +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +description: | +Represents the notification methods that can be subscribed. +Possible values are: + +- PERIODIC +- ONE\_TIME +- ON\_EVENT\_DETECTION + +### AppliedSmccType: + +anyOf: + +- type: string +enum: + - DNN\_CC + - SNSSAI\_CC +- type: string +description: > +This string indicates the type of applied SM congestion control. +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +description: | +Represents the type of applied SM congestion control. +Possible values are: + +- DNN\_CC: Indicates the DNN based congestion control. +- SNSSAI\_CC: Indicates the S-NSSAI based congestion control. + +### TransactionMetric: + +anyOf: + +- type: string +enum: + - PDU\_SES\_EST + - PDU\_SES\_AUTH + - PDU\_SES\_MODIF + - PDU\_SES\_REL +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +description: | +Represents the metric on UE Session Management transactions. +Possible values are: + +- PDU\_SES\_EST: PDU Session Establishment +- PDU\_SES\_AUTH: PDU Session Authentication +- PDU\_SES\_MODIF: PDU Session Modification +- PDU\_SES\_REL: PDU Session Release + +### PduSessionStatus: + +anyOf: + +- type: string +enum: + - ACTIVATED + - DEACTIVATED +- type: string +description: > + +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +description: | +Represents the status of the PDU Session. +Possible values are: +- ACTIVATED: PDU Session status is activated. +- DEACTIVATED: PDU Session status is deactivated. + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-10 | | | | | | TS skeleton of Session Management Event Exposure Service specification | 0.0.0 | +| 2017-10 | CT3#92 | | | | | C3-175326, C3-175327 and C3-175281 | 0.1.0 | +| 2017-12 | CT3#93 | | | | | C3-176071, C3-176240, C3-176316, C3-176242, C3-176243, C3-176244, C3-176317 and C3-176318 | 0.2.0 | +| 2018-01 | CT3#94 | | | | | C3-180034, C3-180196 and C3-180197 | 0.3.0 | +| 2018-03 | CT3#95 | C3-181366 | | | | Inclusion of P-CRs agreed in CT3#95:
C3-181214, C3-181215, C3-181216, C3-181217, C3-181354, C3-181353. | 0.4.0 | +| 2018-04 | CT3#96 | | | | | C3-182315, C3-182316, C3-182144, C3-182317 | 0.5.0 | +| 2018-05 | CT3#97 | | | | | C3-183452, C3-183451, C3-183829, C3-183453, C3-183454, C3-183283 and C3-183455. | 0.6.0 | +| 2018-06 | CT#80 | CP-181039 | | | | TS sent to plenary for approval | 1.0.0 | +| 2018-06 | CT#80 | CP-181039 | | | | TS approved by plenary | 15.0.0 | +| 2018-09 | CT#81 | CP-182015 | 0001 | 2 | F | DNAI change notification type | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0002 | 4 | F | Completion of Error Codes in OpenAPI file | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0003 | | F | Definition of DNAI | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0004 | 2 | F | Stateless AMF support updates | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0007 | 1 | F | Encoding of the "N6 traffic routing information" | 15.1.0 | +| 2018-09 | CT#81 | CP-182033 | 0008 | 2 | F | Addition of Time Stamp | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0009 | 1 | F | Update of resource figure | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0010 | | F | Update of resource figure | 15.1.0 | +| 2018-12 | CT#82 | CP-183205 | 0011 | 6 | F | Correction to the event subscription | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0012 | 4 | F | Correction to the AF influence traffic steering control | 15.2.0 | +| 2018-12 | CT#82 | CP-183137 | 0013 | 5 | F | Immediate reporting flag | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0014 | 2 | F | UE ID in the notification | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0015 | 1 | F | Correction to the overview | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0016 | 2 | F | Correction to the NF consumer | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0017 | 1 | F | Location Header | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0018 | | F | Data for notification | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0019 | 1 | F | NotificationMethod | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0020 | 1 | F | Correction of apiName | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0021 | | F | Default value for apiRoot | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0023 | | F | API version | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0024 | 1 | F | ExternalDocs OpenAPI field | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0025 | | F | Location header field in OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0026 | 1 | F | Security | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0027 | | F | supported content types | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0028 | 2 | F | HTTP Error responses | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0029 | 1 | F | Monitoring identities | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0030 | | F | Correction to the names of data types | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0031 | | F | Report of Ethernet UE address | 15.2.0 | +| 2019-03 | CT#83 | CP-190117 | 0032 | 1 | F | Correction of name of security scope | 15.3.0 | +| 2019-03 | CT#83 | CP-190117 | 0033 | 2 | F | API version update for Rel-15 | 15.3.0 | +| 2019-03 | CT#83 | CP-190117 | 0034 | 1 | F | Correction of URIs in resource structure table and figure | 15.3.0 | +| 2019-06 | CT#84 | CP-191074 | 0037 | 3 | F | Correct condition for DNAI in UP path change | 15.4.0 | +| 2019-06 | CT#84 | CP-191074 | 0038 | 1 | F | Precedence of OpenAPI file | 15.4.0 | +| 2019-06 | CT#84 | CP-191074 | 0041 | 1 | F | Correction of Misplaced Location header in OpenAPI file | 15.4.0 | +| 2019-06 | CT#84 | CP-191074 | 0043 | 2 | F | API version Update | 15.4.0 | +| 2019-06 | CT#84 | CP-191074 | 0044 | 1 | F | Copyright Note in YAML file | 15.4.0 | +| 2019-06 | CT#84 | CP-191070 | 0039 | 3 | B | Downlink data delivery status event | 16.0.0 | +| 2019-06 | CT#84 | CP-191071 | 0040 | 3 | B | AF acknowledgement of UP path event notification | 16.0.0 | +| 2019-06 | CT#84 | CP-191101 | 0042 | 2 | F | API version Update | 16.0.0 | +| 2019-09 | CT#85 | CP-192169 | 0045 | | B | Add communication failure event | 16.1.0 | +| 2019-09 | CT#85 | CP-192141 | 0046 | 1 | A | Correct SMF event exposure service name | 16.1.0 | +| 2019-09 | CT#85 | CP-192157 | 0047 | 1 | B | Enhancement of event reporting information | 16.1.0 | +| 2019-09 | CT#85 | CP-192157 | 0048 | 2 | B | Support for Service Experience | 16.1.0 | +| 2019-09 | CT#85 | CP-192159 | 0049 | 1 | B | I-SMF notification to SMF | 16.1.0 | +| 2019-09 | CT#85 | CP-192220 | 0050 | 3 | B | Notification of downlink data delivery status | 16.1.0 | +| 2019-09 | CT#85 | CP-192138 | 0051 | 2 | B | AF acknowledgement of UP path event notification | 16.1.0 | +| 2019-09 | CT#85 | CP-192173 | 0054 | | F | OpenAPI version update for TS 29.508 Rel-16 | 16.1.0 | +| 2019-12 | CT#86 | CP-193183 | 0056 | | A | Usage of the "serviveName" attribute | 16.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------|--------| +| 2019-12 | CT#86 | CP-193197 | 0057 | | F | Data type of the "serviceName" attribute | 16.2.0 | +| 2019-12 | CT#86 | CP-193181 | 0058 | 1 | B | OpenAPI file update to support AF acknowledgement | 16.2.0 | +| 2019-12 | CT#86 | CP-193181 | 0059 | 3 | F | Update of AFRelocationAck feature | 16.2.0 | +| 2019-12 | CT#86 | CP-193201 | 0060 | 1 | B | I-SMF applicable event | 16.2.0 | +| 2019-12 | CT#86 | CP-193183 | 0062 | 1 | A | Correction on 307 error, 29.508 | 16.2.0 | +| 2019-12 | CT#86 | CP-193212 | 0064 | | F | Update of API version and TS version in OpenAPI file | 16.2.0 | +| 2020-03 | CT#87e | CP-200220 | 0065 | 1 | B | Update of the Availability after DDN Failure event | 16.3.0 | +| 2020-03 | CT#87e | CP-200230 | 0066 | 1 | B | Update of the DDD status event | 16.3.0 | +| 2020-03 | CT#87e | CP-200202 | 0067 | 1 | B | QoS Monitoring Report | 16.3.0 | +| 2020-03 | CT#87e | CP-200198 | 0068 | | B | Support PDU session establishment event | 16.3.0 | +| 2020-03 | CT#87e | CP-200198 | 0070 | | F | V-SMF applicable event | 16.3.0 | +| 2020-03 | CT#87e | CP-200241 | 0071 | 2 | B | QFI allocation event | 16.3.0 | +| 2020-03 | CT#87e | CP-200211 | 0072 | | F | DDD status for I-SMF | 16.3.0 | +| 2020-03 | CT#87e | CP-200216 | 0073 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.3.0 | +| 2020-06 | CT#88e | CP-201210 | 0075 | 1 | F | Correction to the DDD status event | 16.4.0 | +| 2020-06 | CT#88e | CP-201246 | 0077 | 1 | F | Correct presence condition in event subscription | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0078 | 1 | F | Storage of YAML files in ETSI Forge | 16.4.0 | +| 2020-06 | CT#88e | CP-201210 | 0079 | | F | Monitoring event normalization in roaming case | 16.4.0 | +| 2020-06 | CT#88e | CP-201256 | 0080 | 1 | F | URI of the Nsmf_EventExposure service | 16.4.0 | +| 2020-06 | CT#88e | CP-201213 | 0081 | 1 | F | Correction to QoS Monitoring report | 16.4.0 | +| 2020-06 | CT#88e | CP-201216 | 0083 | | A | Notification Uri and subld resource URI | 16.4.0 | +| 2020-06 | CT#88e | CP-201216 | 0085 | 1 | A | OpenAPI: adding Location header field in 307 response | 16.4.0 | +| 2020-06 | CT#88e | CP-201233 | 0086 | 1 | B | FQDN of alternate or backup AMF | 16.4.0 | +| 2020-06 | CT#88e | CP-201210 | 0087 | | B | Add DNN and Slice filter | 16.4.0 | +| 2020-06 | CT#88e | CP-201210 | 0088 | | F | Correct presence condition for snssai | 16.4.0 | +| 2020-06 | CT#88e | CP-201213 | 0089 | 1 | F | Add missing event | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0092 | | F | Optionality of ProblemDetails | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0093 | 1 | F | Supported headers, Resource Data type, Operation Name | 16.4.0 | +| 2020-06 | CT#88e | CP-201255 | 0095 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.4.0 | +| 2020-09 | CT#89e | CP-202050 | 0096 | 1 | F | notifId used for QoS monitoring report | 16.5.0 | +| 2020-09 | CT#89e | CP-202048 | 0097 | | F | Correction to detection of downlink data delivery status change | 16.5.0 | +| 2020-09 | CT#89e | CP-202067 | 0100 | | F | Remove UP path change for I-SMF | 16.5.0 | +| 2020-09 | CT#89e | CP-202209 | 0101 | 1 | F | Subscribed delivery status | 16.5.0 | +| 2020-09 | CT#89e | CP-202073 | 0098 | | F | Successful status code | 17.0.0 | +| 2020-12 | CT#90e | CP-203139 | 0103 | 1 | A | Essential corrections and alignments | 17.1.0 | +| 2020-12 | CT#90e | CP-203139 | 0105 | 1 | A | Storage of YAML files in 3GPP Forge | 17.1.0 | +| 2020-12 | CT#90e | CP-203108 | 0107 | | A | Correction to ddd status when the SMF buffers the data | 17.1.0 | +| 2020-12 | CT#90e | CP-203113 | 0110 | 1 | A | Corrections on resourceURI | 17.1.0 | +| 2020-12 | CT#90e | CP-203108 | 0112 | 1 | A | notifId provided by the UDM for CIoT events | 17.1.0 | +| 2021-03 | CT#91e | CP-210191 | 0115 | 1 | A | Support of stateless NFs | 17.2.0 | +| 2021-03 | CT#91e | CP-210218 | 0118 | | F | OpenAPI reference | 17.2.0 | +| 2021-03 | CT#91e | CP-210219 | 0119 | | F | Clarification on optional HTTP custom headers | 17.2.0 | +| 2021-03 | CT#91e | CP-210189 | 0121 | 1 | A | Correction to DDD status event detection | 17.2.0 | +| 2021-03 | CT#91e | CP-210189 | 0123 | | A | Correction to DDD status event subscription | 17.2.0 | +| 2021-03 | CT#91e | CP-210221 | 0124 | 1 | F | Ambiguous concept of NF service consumer terminology | 17.2.0 | +| 2021-03 | CT#91e | CP-210219 | 0125 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files | 17.2.0 | +| 2021-03 | CT#91e | CP-210194 | 0128 | | A | alignment of dnaiChgType attribute | 17.2.0 | +| 2021-03 | CT#91e | CP-210240 | 0130 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.2.0 | +| 2021-06 | CT#92e | CP-211221 | 0131 | 2 | B | Partitioning criteria for applying sampling in specific UE partitions in SMF exposure | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0132 | 1 | B | Support of Mute Reporting | 17.3.0 | +| 2021-06 | CT#92e | CP-211200 | 0134 | 1 | A | Temporary and Permanent Redirection | 17.3.0 | +| 2021-06 | CT#92e | CP-211243 | 0135 | 1 | F | Removal of resource URI in Notification Acknowledgement procedure | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0136 | 1 | B | Nsmf_EventExposure supports RAT Type Change Event | 17.3.0 | +| 2021-06 | CT#92e | CP-211265 | 0138 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.3.0 | +| 2021-09 | CT#93e | CP-212220 | 0139 | 1 | F | Correction of URI structure | 17.4.0 | +| 2021-09 | CT#93e | CP-212221 | 0141 | 1 | A | Missing PDU Session ID from QFI allocation event notifications | 17.4.0 | +| 2021-09 | CT#93e | CP-212198 | 0142 | 2 | B | Adding uplink buffering indication for Application Relocation | 17.4.0 | +| 2021-09 | CT#93e | CP-212203 | 0143 | 1 | F | Corrections for RAT Type exposure | 17.4.0 | +| 2021-09 | CT#93e | CP-212223 | 0144 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.4.0 | +| 2021-12 | CT#94e | CP-213227 | 0145 | 1 | B | Update input data collection for Slice load level information | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0146 | 2 | B | New event for SM congestion control experience | 17.5.0 | +| 2021-12 | CT#94e | CP-213238 | 0148 | | A | The of the Nsmf_EventExposure API | 17.5.0 | +| 2021-12 | CT#94e | CP-213223 | 0149 | 1 | B | Adding EAS IP replacement information in AppRelocationInfo | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0150 | 1 | B | Adding DCCF as SMF event exposure NF service consumer | 17.5.0 | +| 2021-12 | CT#94e | CP-213239 | 0151 | | F | Adding missing conditions on features for notifications about subscribed events | 17.5.0 | +| 2021-12 | CT#94e | CP-213244 | 0152 | | F | Handling of implicit subscriptions | 17.5.0 | +| 2021-12 | CT#94e | CP-213215 | 0154 | 1 | A | Essential correction to immediate report | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0155 | 1 | B | Transactions dispersion information collected from serving SMF | 17.5.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------------|--------| +| 2021-12 | CT#94e | CP-213246 | 0156 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.5.0 | +| 2022-03 | CT#95e | CP-220195 | 0159 | 4 | B | Event report in the subscription response | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0161 | 1 | B | Support Redundant Transmission Experience | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0162 | 1 | B | Support new event on WLAN information | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0163 | 1 | F | Corrections related to SMCCE | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0164 | 1 | F | Corrections related to Dispersion | 17.6.0 | +| 2022-03 | CT#95e | CP-220192 | 0165 | 1 | D | Correction of SMCC and other abbreviations | 17.6.0 | +| 2022-03 | CT#95e | CP-220186 | 0166 | 1 | F | Handling of supported features for Edge Computing | 17.6.0 | +| 2022-03 | CT#95e | CP-220175 | 0168 | | A | Corrections related to URLLC | 17.6.0 | +| 2022-03 | CT#95e | CP-220201 | 0169 | | B | Updating Binding Indication for multiple resource contexts feature | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0170 | | B | Provide PDU session information for supporting the UE communication analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220192 | 0171 | 1 | B | Support UPF information for service experience and DN performance analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220194 | 0172 | | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-06 | CT#96 | CP-221154 | 0173 | 1 | F | Formatting of description fields | 17.7.0 | +| 2022-06 | CT#96 | CP-221154 | 0174 | | F | Using the common data type for FQDN | 17.7.0 | +| 2022-06 | CT#96 | CP-221157 | 0175 | | F | Inaccurate condition for immediate reporting | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0176 | | F | Correction to the notifFlag attribute in subscription modification | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0177 | | F | Completion of subscription modification procedure | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0178 | | F | missing applicable RED_TRANS_EXP event for targetPeriod attribute | 17.7.0 | +| 2022-06 | CT#96 | CP-221130 | 0179 | 1 | B | Resolve editor's note on Redundant Transmission Experience event | 17.7.0 | +| 2022-06 | CT#96 | CP-221130 | 0180 | | F | Corrections to SMCCE | 17.7.0 | +| 2022-06 | CT#96 | CP-221133 | 0181 | | F | Muting notifications correction | 17.7.0 | +| 2022-06 | CT#96 | CP-221157 | 0182 | 1 | F | Correction to the reported flows | 17.7.0 | +| 2022-06 | CT#96 | CP-221151 | 0183 | | F | Update of info and externalDocs fields | 17.7.0 | +| 2022-09 | CT#97e | CP-222123 | 0184 | 1 | F | Alignment with the SBI template | 17.8.0 | +| 2022-12 | CT#98e | CP-223173 | 0186 | 1 | F | User Plane Status Information event handling | 17.9.0 | +| 2022-12 | CT#98e | CP-223177 | 0188 | | F | Adding support of SNPn | 17.9.0 | +| 2022-12 | CT#98e | CP-223188 | 0190 | | F | Update of info and externalDocs fields | 17.9.0 | +| 2022-12 | CT#98e | CP-223191 | 0187 | | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223192 | 0189 | 1 | F | Enumeration definitions in the OpenAPI file | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0191 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230166 | 0192 | | F | Adding missing presence condition for IPv6 addresses and prefixes | 18.1.0 | +| 2023-03 | CT#99 | CP-230175 | 0196 | 1 | F | Clarification regarding maxReportNbr | 18.1.0 | +| 2023-03 | CT#99 | CP-230176 | 0197 | 1 | F | Correct the event name for downlink data delivery status | 18.1.0 | +| 2023-03 | CT#99 | CP-230174 | 0198 | | F | Corrections on subscription notification | 18.1.0 | +| 2023-03 | CT#99 | CP-230174 | 0199 | | F | Corrections on PDU Session Establishment | 18.1.0 | +| 2023-03 | CT#99 | CP-230166 | 0200 | | F | Correction of the description fields in enumerations | 18.1.0 | +| 2023-03 | CT#99 | CP-230145 | 0202 | | A | Missing presence condition for transacInfos attribute | 18.1.0 | +| 2023-03 | CT#99 | CP-230174 | 0204 | | F | Alignment of packet delay report | 18.1.0 | +| 2023-03 | CT#99 | CP-230175 | 0209 | 1 | F | Support of indirect feature negotiation | 18.1.0 | +| 2023-03 | CT#99 | CP-230173 | 0211 | 1 | A | Correction on handling of Packet Delay Failure report Threshold | 18.1.0 | +| 2023-03 | CT#99 | CP-230166 | 0212 | | F | Corrections to attributes not respecting the naming convention | 18.1.0 | +| 2023-03 | CT#99 | CP-230137 | 0213 | 1 | B | Support of common DNAI selection by AF | 18.1.0 | +| 2023-03 | CT#99 | CP-230161 | 0217 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231124 | 0215 | 2 | B | Support NWDAF assisted URSPs in Service Experience | 18.2.0 | +| 2023-06 | CT#100 | CP-231135 | 0218 | 1 | B | Prioritization of candidate DNAIs | 18.2.0 | +| 2023-06 | CT#100 | CP-231136 | 0219 | 3 | B | Indicating target AF in UP path change events | 18.2.0 | +| 2023-06 | CT#100 | CP-231125 | 0220 | 1 | B | Event muting enhancements for SMF event exposure | 18.2.0 | +| 2023-06 | CT#100 | CP-231135 | 0222 | 1 | B | Support NWDAF assisted URSPs in Service Experience | 18.2.0 | +| 2023-06 | CT#100 | CP-231135 | 0225 | 1 | B | Complete common DNAI and EAS selection | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0226 | 1 | B | Enhancements to WLAN performance event | 18.2.0 | +| 2023-06 | CT#100 | CP-231157 | 0227 | 1 | B | Subscription to UPF notifications via SMF | 18.2.0 | +| 2023-06 | CT#100 | CP-231132 | 0228 | 1 | F | HTTP redirection clause correction | 18.2.0 | +| 2023-06 | CT#100 | CP-231183 | 0229 | 1 | B | Support of SMF event exposure related to dynamic satellite backhaul | 18.2.0 | +| 2023-06 | CT#100 | CP-231128 | 0230 | 1 | B | Input data support of End-to-end data volume transfer time analytics | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 0231 | | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232250 | 0233 | 2 | B | Support of the Congestion Information Monitoring | 18.3.0 | +| 2023-09 | CT#101 | CP-232085 | 0234 | | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-12 | CT#102 | CP-233225 | 0232 | 3 | B | Supporting data collection for PDU Session Traffic Analytics | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0235 | 1 | B | Collect list of Access Types used for the PDU session from SMF | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0236 | 1 | B | Support of 5QI collection from SMF | 18.4.0 | +| 2023-12 | CT#102 | CP-233233 | 0237 | 1 | F | Support of the new feature name EnQoSMon | 18.4.0 | +| 2023-12 | CT#102 | CP-233239 | 0238 | | B | Supporting SMF Traffic Correlation Notification | 18.4.0 | +| 2023-12 | CT#102 | CP-233228 | 0239 | | F | Update HTTP RFC 7540 obsoleted by IETF RFC 9113 | 18.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------|--------| +| 2023-12 | CT#102 | CP-233249 | 0240 | | F | Corrections to the inputs of subscription to UPF events | 18.4.0 | +| 2023-12 | CT#102 | CP-233228 | 0241 | 1 | F | Update HTTP RFC 7807 obsoleted by IETF RFC 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233254 | 0242 | 1 | A | Correction of anyUeInd attribute | 18.4.0 | +| 2023-12 | CT#102 | CP-233249 | 0243 | 1 | B | Support of explicit QoS monitoring subscription | 18.4.0 | +| 2023-12 | CT#102 | CP-233237 | 0244 | | F | Update of info and externalDocs fields | 18.4.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29511/raw.md b/marked/Rel-18/29_series/29511/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..d25bacd6b87920e9b79e94ec3f85338bab3691a7 --- /dev/null +++ b/marked/Rel-18/29_series/29511/raw.md @@ -0,0 +1,805 @@ + + +# 3GPP TS 29.511 V18.2.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Equipment Identity Register Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Overview..... | 7 | +| 4.1 Introduction ..... | 7 | +| 5 Services offered by the 5G-EIR NF..... | 8 | +| 5.1 Introduction ..... | 8 | +| 5.2 N5g-eir_EquipmentIdentityCheck Service ..... | 8 | +| 5.2.1 Service Description ..... | 8 | +| 5.2.2 Service Operations..... | 9 | +| 5.2.2.1 Introduction..... | 9 | +| 5.2.2.2 CheckEquipmentIdentity ..... | 9 | +| 5.2.2.2.1 General ..... | 9 | +| 5.2.2.2.2 Procedure using CheckEquipmentIdentity Operation..... | 9 | +| 6 API Definitions ..... | 9 | +| 6.1 N5g-eir_EquipmentIdentityCheck Service API..... | 9 | +| 6.1.1 API URI..... | 9 | +| 6.1.2 Usage of HTTP..... | 10 | +| 6.1.2.1 General..... | 10 | +| 6.1.2.2 HTTP standard headers..... | 10 | +| 6.1.2.2.1 General ..... | 10 | +| 6.1.2.2.2 Content type ..... | 10 | +| 6.1.2.3 HTTP custom headers..... | 10 | +| 6.1.2.3.1 General ..... | 10 | +| 6.1.3 Resources..... | 11 | +| 6.1.3.1 Overview..... | 11 | +| 6.1.3.2 Resource: equipmentStatus..... | 11 | +| 6.1.3.2.1 Description ..... | 11 | +| 6.1.3.2.2 Resource Definition..... | 11 | +| 6.1.3.2.3 Resource Standard Methods..... | 11 | +| 6.1.4 Data Model ..... | 13 | +| 6.1.4.1 General..... | 13 | +| 6.1.4.2 Structured data types..... | 13 | +| 6.1.4.2.1 Introduction ..... | 13 | +| 6.1.4.2.2 Type: EirResponseData..... | 13 | +| 6.1.4.3 Simple data types and enumerations..... | 14 | +| 6.1.4.3.1 Introduction ..... | 14 | +| 6.1.4.3.2 Simple data types ..... | 14 | +| 6.1.4.3.3 Enumeration: EquipmentStatus..... | 14 | +| 6.1.5 Error Handling ..... | 14 | +| 6.1.5.1 General..... | 14 | +| 6.1.5.2 Protocol Errors ..... | 14 | +| 6.1.5.3 Application Errors..... | 14 | +| 6.1.6 Feature Negotiation ..... | 14 | +| 6.1.7 Security ..... | 15 | +| 6.1.7.1 General..... | 15 | +| 6.1.7.2 Transport Layer Security Protection of Messages..... | 15 | +| 6.1.7.3 Authorization of 5G-EIR NF Service Access..... | 16 | +| 6.1.8 HTTP redirection..... | 16 | + +A.1 General..... 16 +A.2 N5g-eir\_EquipmentIdentityCheck Service API..... 16 + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document describes the stage 3 protocol and data model for the N5g-eir Service Based Interface between the 5G-EIR and its consumers over which the service to check the equipment identity as described in 3GPP TS 23.501 [2] is performed. It provides the stage 3 protocol definitions and message flows, and specifies the API for each service offered by the 5G-EIR. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [7] IETF RFC 9113: "HTTP/2". +- [8] OpenAPI Initiative, "OpenAPI Specification Version 3.0.0", .[9] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [10] IETF RFC 9457: "Problem Details for HTTP APIs". +- [11] 3GPP TS 33.501: "Security Architecture and Procedures for 5G System". +- [12] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [13] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". + +- [14] 3GPP TR 21.900: "Technical Specification Group working methods". +- [15] 3GPP TS 29.524: "5G System; Cause codes mapping between 5GC interfaces; Stage 3". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**N5g-eir:** Service-based interface exhibited by 5G-EIR + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|--------|--------------------------------| +| 5G-EIR | 5G-Equipment Identity Register | +| EIR | Equipment Identity Register | +| PEI | Permanent Equipment Identifier | + +# --- 4 Overview + +## 4.1 Introduction + +N5g-eir is a Service-based interface exhibited by 5G-EIR (5G-Equipment Identity Register) which is an optional network function that supports the following functionality: + +- Check the status of Equipment's identity (e.g. to check that it has not been prohibited listed). + +The reference point N17 (see Fig 4-1 below) shows the interaction between the 5G-Equipment Identity Register 5G-EIR and the AMF (Access and Mobility Management Function) enabling the check of the status of the mobile equipment identity. + +![Diagram showing the interaction between AMF and 5G-EIR via the N17 / N5g-eir interface.](ba9d6e1a75eb6672d04e61a86e1b8a61_img.jpg) + +``` +graph LR; AMF[AMF] --- N17_N5g_eir[N17 / N5g-eir] --- 5G_EIR[5G-EIR]; +``` + +Diagram showing the interaction between AMF and 5G-EIR via the N17 / N5g-eir interface. + +**Figure 4-1: Reference Model – N5g-eir** + +During any procedure establishing a signalling connection with the UE the network may optionally perform an ME identity check with 5G-EIR via the N5g-eir\_Equipment Identity Check Service exhibited by 5G-EIR. + +# 5 Services offered by the 5G-EIR NF + +## 5.1 Introduction + +The following NF service is offered by the N5g-eir to check the ME whether it is prohibited listed or not: + +- N5g-eir\_EquipmentIdentityCheck + +**Table 5.1-1: NF Services provided by 5G-EIR** + +| Service Name | Description | Consumer | +|--------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| N5g-eir_EquipmentIdentityCheck | This service offered by the 5G-EIR allows the consumer to check the Permanent Equipment Identifier (PEI) and check whether the PEI is in the prohibited list or not. | AMF | + +The N5g-eir\_Equipment Identity Check service is specified in 3GPP TS 23.502 [3], clause 4.2.2.2.2 + +Table 5.1-2 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-2: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|--------------------------------|--------|-----------------------------------------|---------------------------------------------|-------------|-------| +| N5g-eir_EquipmentIdentityCheck | 6.1 | 5G-EIR Equipment Identity Check Service | TS29511_N5g-eir_EquipmentIdentityCheck.yaml | n5g-eir-eic | A.2 | + +The N5g-eir\_Equipment Identity Check service is specified in 3GPP TS 23.502 [3], clause 4.2.2.2.2 + +## 5.2 N5g-eir\_EquipmentIdentityCheck Service + +### 5.2.1 Service Description + +The N5g-eir\_Equipment Identity Check service is provided by the 5G-EIR to check the Permanent Equipment Identifier (PEI) whether it is in the prohibited list or not. The service can be consumed by AMF which initiates ME identity check by invoking the N5g-eirEquipmentIdentityCheckGet service operation (see clause 5.2.4.2. of 3GPP TS 23.502 [3]). + +During the initial registration the Permanent Equipment Identifier is obtained from the UE. The AMF operator may check the PEI with an EIR. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +#### 5.2.2.2 CheckEquipmentIdentity + +##### 5.2.2.2.1 General + +The CheckEquipmentIdentity operation shall be used to check the PEI and determine whether the subscriber is allowed to use the equipment, in the following procedures: + +- ME Identity check procedure (see clause 4.7 of 3GPP TS 23.502 [3]); + +##### 5.2.2.2.2 Procedure using CheckEquipmentIdentity Operation + +The NF Service Consumer (e.g. AMF) shall check the PEI by using the HTTP GET method as shown in Figure 5.2.2.2.2-1. + +![Sequence diagram showing the PEI status check procedure. An NF service consumer sends a GET request to a 5G-EIR. The 5G-EIR responds with either a 200 OK (EirResponseData) or a 4xx/5xx (ProblemDetails) or 3xx status.](0bf9346902e9a3bdabf05ceacc1947f5_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant 5G-EIR + Note left of NF service consumer: 1. GET .../equipment-status?pei={pei}&supi={supi}&gpsi={gpsi} + NF service consumer->>5G-EIR: Request + Note right of 5G-EIR: 2a. 200 OK (EirResponseData) or 2b. 4xx/5xx (ProblemDetails) or 3xx + 5G-EIR-->>NF service consumer: Response + +``` + +Sequence diagram showing the PEI status check procedure. An NF service consumer sends a GET request to a 5G-EIR. The 5G-EIR responds with either a 200 OK (EirResponseData) or a 4xx/5xx (ProblemDetails) or 3xx status. + +**Figure 5.2.2.2.2-1: PEI status check by the NF Service Consumer** + +1. The NF Service Consumer (e.g. AMF) sends a GET request to the resource representing the PEI equipment Status. It shall include the PEI as a query parameter and, optionally, the SUPI and/or GPSI may also be included. +- 2a. On success, "200 OK" with the message body containing the equipment status of the PEI. +- 2b. If the PEI is not known, "404 Not Found" with the message body containing a ProblemDetails object, with the "details" attribute set to "ERROR\_EQUIPMENT\_UNKNOWN". When receiving the response from the 5G-EIR, the NF Service Consumer (e.g. AMF) shall check the equipment Status and the detailed problem. Dependent upon the result, the NF Service Consumer will decide its subsequent actions (e.g. sending a Registration Reject if the 5G-EIR indicates that the PEI is unknown or prohibited listed). + +The definition of the equipment-status resource is specified in clause 6.1.3. + +# 6 API Definitions + +## 6.1 N5g-eir\_EquipmentIdentityCheck Service API + +### 6.1.1 API URI + +The N5g-eir\_EquipmentIdentityCheck Service shall use the N5g-eir\_EquipmentIdentityCheck API. + +The API URI of the N5g-eir\_EquipmentIdentityCheck API shall be: + +{apiRoot}/ + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in subclause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "n5g-eir-eic". +- The shall be "v1". +- The shall be set as described in subclause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [7], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the N5g-eir\_EquipmentIdentityCheck Service shall comply with the OpenAPI [8] specification contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [9]. The use of the JSON format shall be signalled by the content type "application/json". See also clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 9457 [10]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +#### 6.1.2.3 HTTP custom headers + +##### 6.1.2.3.1 General + +In this release of this specification, no custom headers specific to the N5g-eir\_EquipmentIdentityCheck Service are defined. For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +![Diagram showing the resource URI structure. The root path is //{apiRoot}/n5g-eir-eic/. A line branches from this root to a box containing the specific resource path /equipment-status.](7e670a2b556b53ea9002dfff3a420e08_img.jpg) + +``` + + graph TD + Root[" //{apiRoot}/n5g-eir-eic/"] --> Box[ ] + Box --- Status["/equipment-status"] + style Box fill:none,stroke:none + +``` + +Diagram showing the resource URI structure. The root path is //{apiRoot}/n5g-eir-eic/. A line branches from this root to a box containing the specific resource path /equipment-status. + +**Figure 6.1.3.1-1: Resource URI structure of the n5g-eir-eic API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------|-------------------|---------------------------------|------------------------------------------| +| equipmentStatus | /equipment-status | GET | Retrieve the equipment status of the PEI | + +#### 6.1.3.2 Resource: equipmentStatus + +##### 6.1.3.2.1 Description + +This resource represents the equipmentStatus for a PEI. + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/n5g-eir-eic//equipment-status + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| pei | Pei | M | 1 | The PEI of the UE shall be included for equipment identify checking | +| supi | Supi | O | 0..1 | The SUPI of the UE | +| gpsi | Gpsi | O | 0..1 | The GPSI of the UE | +| supported-features | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.6 is supported. | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EirResponseData | M | 1 | 200 OK | Upon success, a response body containing the Equipment Status shall be returned | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same 5G-EIR or 5G-EIR (service) set. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same 5G-EIR or 5G-EIR (service) set. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The equipment identify checking has failed. The "cause" attribute may be used to indicate one of the following application errors:
- ERROR_EQUIPMENT_UNKNOWN
See table 6.1.5.3-1 for the description of this error. | + +NOTE : The mandatory HTTP error status codes for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type when needed (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponses may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G-EIR or 5G-EIR (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G-EIR or 5G-EIR (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.4 Data Model + +#### 6.1.4.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.4.1-1 specifies the data types defined for the n5g-eir-eic service based interface protocol. + +**Table 6.1.4.1-1: n5g-eir-eic specific Data Types** + +| Data type | Clause defined | Description | +|-----------------|----------------|--------------------------------------------------------| +| EirResponseData | 6.1.4.2.2 | | +| EquipmentStatus | 6.1.4.3.3 | Equipment status of the PEI, this data type is string. | + +Table 6.1.6.1-2 specifies data types re-used by the N service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the N service based interface. + +**Table 6.1.4.1-2: 5g-eir-eic re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|--------------------|---------------------------------------------------------------------------------------------------------------| +| Pei | 3GPP TS 29.571 [6] | Data type representing the PEI of the UE. | +| Supi | 3GPP TS 29.571 [6] | Data type representing the SUPI of the subscriber.
pattern: See pattern of type Supi in 3GPP TS 29.571 [6] | +| ProblemDetails | 3GPP TS 29.571 [6] | Common data type for error responses | +| Gpsi | 3GPP TS 29.571 [6] | Data type representing the GPSI of the subscriber. | +| SupportedFeatures | 3GPP TS 29.571 [6] | Supported Features | +| RedirectResponse | 3GPP TS 29.571 [6] | Response body of the redirect response message. | + +#### 6.1.4.2 Structured data types + +##### 6.1.4.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.4.2.2 Type: EirResponseData + +**Table 6.1.4.2.2-1: Definition of type EirResponseData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|------------------| +| status | EquipmentStatus | M | 1 | Status of the UE | + +#### 6.1.4.3 Simple data types and enumerations + +##### 6.1.4.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.4.3.2 Simple data types + +The simple data types defined in table 6.1.4.3.2-1 shall be supported. + +**Table 6.1.4.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|---------------------------------------------------------------------|-------------| +| | | | + +##### 6.1.4.3.3 Enumeration: EquipmentStatus + +**Table 6.1.4.3.3-1: Enumeration EquipmentStatus** + +| Enumeration value | Description | +|-------------------|--------------------------------------------| +| "WHITELISTED" | Indicates the PEI is permitted whitelisted | +| "BLACKLISTED" | Indicates the PEI is prohibited listed | +| "GREYLISTED" | Indicates the PEI is tracking listed | + +### 6.1.5 Error Handling + +#### 6.1.5.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +The Cause codes mapping performed by AMF between the following HTTP responses returned by the EIR services to the AMF and the 5GMM related values is specified in clause 4.5.2 of 3GPP TS 29.524 [15]. + +#### 6.1.5.2 Protocol Errors + +Protocol Error Handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.1.5.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the N5g-eir\_EquipmentIdentityCheck service, and the following application errors listed in Table 6.1.5.3-1 are specific for the N5g-eir\_EquipmentIdentityCheck service. + +**Table 6.1.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------------|------------------|--------------------------------------------------------| +| ERROR_EQUIPMENT_UNKNOWN | 404 Not Found | Indicate the mobile equipment is not known in the EIR. | + +### 6.1.6 Feature Negotiation + +The optional features in table 6.1.6-1 are defined for the N5g-eir\_EquipmentIdentityCheck API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.6-1: Supported Features** + +| Feature number | Feature Name | M/O | Description | +|----------------|--------------|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ES3XX | M | Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. AMF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the EquipmentIdentityCheck service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | + +### 6.1.7 Security + +#### 6.1.7.1 General + +The security mechanisms for service based interfaces are specified in clause 13 of 3GPP TS 33.501 [11] and in clause 6.7.3 of 3GPP TS 29.500 [4]. The access to the N5g-eir\_EquipmentIdentityCheck API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [12]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [13]) plays the role of the authorization server. + +The N5g-eir\_EquipmentIdentityCheck API defines scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [11]; it defines a single scope consisting on the name of the service (i.e., "n5g-eir-eic"), and it does not define any additional scopes at resource or operation level. + +Security Protection Edge Proxy (SEPP), as specified in 3GPP TS 33.501 [11], shall be used between service based interfaces across PLMNs. The NFs in a PLMN shall use the SEPP as a HTTP/2 proxy for the HTTP/2 messages that carry ":authority" pseudo header with a uri-host formatted as specified in clause 6.1.4.3 of 3GPP TS 29.500 [4] + +#### 6.1.7.2 Transport Layer Security Protection of Messages + +As specified in clause 13.1 of 3GPP TS 33.501 [11], TLS shall be used for the security protection of messages at the transport layer for the N5g-eir service based interface if network security is not provided by other means. + +The protocol stack for the N5g-eir service based interface is shown on Figure 6.1.7.2-1. + +![Figure 6.1.7.2-1: SBI Protocol Stack diagram showing a vertical stack of layers: Application, HTTP/2, TLS (dashed box), TCP, IP, and L2.](e4c6fa93821e3546ee9fcae897ae2771_img.jpg) + +| | +|-------------| +| Application | +| HTTP/2 | +| TLS | +| TCP | +| IP | +| L2 | + +Figure 6.1.7.2-1: SBI Protocol Stack diagram showing a vertical stack of layers: Application, HTTP/2, TLS (dashed box), TCP, IP, and L2. + +**Figure 6.1.7.2-1: SBI Protocol Stack** + +The N5g-eir service based interface uses HTTP/2 protocol (see clause 5.2) with JSON (see clause 5.4) as the application layer serialization protocol. For the security protection at the transport layer, 5G-EIR NF shall support TLS and TLS shall be used within a PLMN if network security is not provided by other means, as specified in 3GPP TS 33.501 [11]. + +#### 6.1.7.3 Authorization of 5G-EIR NF Service Access + +As specified in clause 13.4.1 of 3GPP TS 33.501 [11] OAuth 2.0 (see IETF RFC 6749 [12]) may be used for authorization of N5g-eir\_EquipmentIdentityCheck service access. The 5G-EIR NF and the NRF (as defined in 3GPP TS 29.510 [13]) shall support the OAuth 2.0 authorization framework with "Client Credentials" grant type as specified in clause 4.4 of IETF RFC 6749 [12]. The NRF shall act as the Authorization Server providing the access tokens to the NF service consumers to access the service provided by the 5G-EIR. If the 5G-EIR NF receives an OAuth 2.0 authorization token in the "Authorization" HTTP request header field, the N5g-eir\_EquipmentIdentityCheck service shall validate the access token, its expiry and its access scope before allowing access to the requested resource, as specified in clause 7 of IETF RFC 6749 [12]. + +### 6.1.8 HTTP redirection + +An HTTP request may be redirected to a different 5G-EIR service instance, within the same 5G-EIR or a different 5G-EIR of an 5G-EIR set, e.g. when an 5G-EIR service instance is part of an 5G-EIR (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See also the ES3XX feature in clause 6.1.6. + +An SCP that reselects a different 5G-EIR producer instance will return the NF Instance ID of the new 5G-EIR producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an 5G-EIR within an 5G-EIR set redirects a service request to a different 5G-EIR of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new 5G-EIR towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the N5g-eir\_EquipmentIdentityCheck Service API. It consists of an OpenAPI 3.0.0 specification, in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE : The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [14] clause 5B). + +## --- A.2 N5g-eir\_EquipmentIdentityCheck Service API + +openapi: 3.0.0 + +info: + +``` +version: '1.3.0-alpha.1' +title: '5G-EIR Equipment Identity Check' +description: | + 5G-EIR Equipment Identity Check Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.511 V18.0.0; 5G System; Equipment Identity Register Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.511/' + +servers: + - url: '{apiRoot}/n5g-eir-eic/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - n5g-eir-eic + +paths: + /equipment-status: + get: + summary: Retrieves the status of the UE + operationId: GetEquipmentStatus + tags: + - Equipment Status (Document) + parameters: + - name: pei + in: query + description: PEI of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + - name: supi + in: query + description: SUPI of the UE + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: gpsi + in: query + description: GPSI of the UE + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + - name: supported-features + in: query + description: supported features of the NF consumer + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/EirResponseData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + description: PEI Not Found + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '406': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + n5g-eir-eic: Access to the N5g-eir_EquipmentIdentityCheck API + +schemas: + EirResponseData: + description: Represents equipment status data provided in an EIR response message. + type: object + required: + - status + properties: + status: + $ref: '#/components/schemas/EquipmentStatus' + EquipmentStatus: + description: Represents equipment status of the PEI. This data type is a string. + type: string + enum: + - WHITELISTED # PERMITTED + - BLACKLISTED # PROHIBITED + - GREYLISTED # TRACKING +``` + +# --- Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|---------|-----------|-------|-----|-----|----------------------------------------------------------------------------------|-------------|--| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | | +| 2017-10 | CT4#80 | C4-175323 | | | | Initial Draft. | 0.1.0 | | +| 2017-10 | CT4#80 | C4-175396 | | | | At CT4#80 approved pCRs C4-175323, C4-175324, C4-175325, C4-175326 incorporated. | 0.2.0 | | +| 2017-12 | CT4#81 | C4-176439 | | | | At CT4#81 approved pCRs C4-176428, C4-176429 incorporated | 0.3.0 | | +| 2018-03 | CT4#83 | C4-182436 | | | | At CT4#83 approved pCRs C4-182368, C4-182369, C4-182384 incorporated. | 0.4.0 | | +| 2018-03 | CT#79 | CP-180032 | | | | Presented for information | 1.0.0 | | +| 2018-05 | CT4#85 | C4-184627 | | | | At CT4#85 approved pCRs C4-184475, C4-184476, C4-184628 incorporated. | 1.1.0 | | +| 2018-06 | CT#80 | CP-181106 | | | | Presented for approval | 2.0.0 | | +| 2018-06 | CT#80 | | | | | Approved in CT#80. | 15.0.0 | | +| 2018-09 | CT#81 | CP-182061 | 0001 | - | F | Error Handling | 15.1.0 | | +| 2018-09 | CT#81 | CP-182061 | 0002 | - | F | Description of Structured data types | 15.1.0 | | +| 2018-09 | CT#81 | CP-182061 | 0003 | - | F | Update of Resource Figure | 15.1.0 | | +| 2018-09 | CT#81 | CP-182061 | 0004 | - | F | API Version Number Update | 15.1.0 | | +| 2018-12 | CT#82 | CP-183178 | 0005 | 2 | F | 5G-EIR OpenAPI Updates | 15.2.0 | | +| 2018-12 | CT#82 | CP-183019 | 0007 | - | F | APIRoot Clarification | 15.2.0 | | +| 2018-12 | CT#82 | CP-183019 | 0008 | - | F | Common Status codes | 15.2.0 | | +| 2018-12 | CT#82 | CP-183019 | 0009 | 1 | F | API Version Update | 15.2.0 | | +| 2018-12 | CT#82 | CP-183198 | 00010 | 1 | F | Correction of "externalDocs" for N5g-eir_EquipmentIdentityCheck Service | 15.2.0 | | +| 2019-03 | CT#83 | CP-190024 | 0012 | 1 | F | GPSI | 15.3.0 | | +| 2019-03 | CT#83 | CP-190024 | 0014 | 1 | F | Reuse of data types in EIR OpenAPI | 15.3.0 | | +| 2019-03 | CT#83 | CP-190024 | 0015 | - | F | API Version Update | 15.3.0 | | +| 2019-06 | CT#84 | CP-191035 | 0017 | 2 | F | Storage of OpenAPI specification files | 15.4.0 | | +| 2019-06 | CT#84 | CP-191035 | 0018 | - | F | Copyright Note in YAML file | 15.4.0 | | +| 2019-06 | CT#84 | CP-191035 | 0019 | - | F | Wrong formatting in OpenAPI annex | 15.4.0 | | +| 2019-06 | CT#84 | CP-191035 | 0020 | - | F | 3GPP TS 29.511 API version update | 15.4.0 | | +| 2019-11 | CT#84 | CP-193036 | 0022 | 1 | F | Add reference to TS 29.524 | 16.0.0 | | +| 2019-12 | CT#84 | CP-193121 | 0024 | - | F | ExternalDocs field and API version change in the OpenAPI | 16.0.0 | | +| 2020-03 | CT#87e | CP-200039 | 0025 | 2 | F | Add Corresponding API descriptions in clause 5.1 | 16.1.0 | | +| 2020-03 | CT#87e | CP-200039 | 0028 | 2 | D | Editorial corrections | 16.1.0 | | +| 2020-03 | CT#87e | CP-200020 | 0029 | 1 | B | Optionality of ProblemDetails | 16.1.0 | | +| 2020-03 | CT#87e | CP-200035 | 0030 | - | B | SUPI pattern | 16.1.0 | | +| 2020-04 | CT#88e | CP-201064 | 0032 | 1 | F | Datatype column in Resource URI variables Table | 16.2.0 | | +| 2020-06 | CT#88e | CP-201034 | 0033 | - | B | Storage of YAML files | 16.2.0 | | +| 2020-06 | CT#88e | CP-201332 | 0034 | 1 | F | API Version and ExternalDoc Version Update | 16.2.0 | | +| 2020-12 | CT#90e | CP-203035 | 0036 | - | F | Storage of YAML files in 3GPP Forge | 16.3.0 | | +| 2021-03 | CT#91e | CP-210037 | 0038 | | F | HTTP 3xx redirection | 16.4.0 | | +| 2021-03 | CT#91e | CP-210054 | 0041 | | F | 29.511 Rel-16 API version and External doc update | 16.4.0 | | +| 2021-03 | CT#91e | CP-210026 | 0037 | | D | Use of inclusive terminology | 17.0.0 | | +| 2021-03 | CT#91e | CP-210034 | 0039 | | F | OpenAPI Reference | 17.0.0 | | +| 2021-03 | CT#91e | CP-210029 | 0040 | | F | 29.511 Rel-17 API version and External doc update | 17.0.0 | | +| 2021-06 | CT#91e | CP-211028 | 0042 | | F | backward compatible correction | 17.1.0 | | +| 2021-06 | CT#92e | CP-211059 | 0044 | 2 | F | backward compatible correction | 17.1.0 | | +| 2021-06 | CT#92e | CP-211050 | 0045 | - | F | 29.511 Rel-17 API version and External doc update | 17.1.0 | | +| 2021-09 | CT#93e | CP-212060 | 0048 | | A | 3xx description correction for SCP | 17.2.0 | | +| 2022-06 | CT#96 | CP-221027 | 0051 | | F | Correction of typos in description fields | 17.3.0 | | +| 2022-06 | CT#96 | CP-221304 | 0053 | | F | 29.511 Rel17 API version and External doc update | 17.3.0 | | +| 2022-12 | CT#98e | CP-223027 | 0055 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 | | +| 2022-12 | CT#98e | CP-223033 | 0056 | | F | 29.511 Rel18 API version and External doc update | 18.0.0 | | +| 2023-09 | CT#101 | CP-232058 | 0057 | 1 | F | Major API version | 18.1.0 | | +| 2023-12 | CT#102 | CP-233028 | 0058 | | F | Update and replace obsoleted HTTP RFCs | 18.2.0 | | +| 2023-12 | CT#102 | CP-233031 | 0059 | | F | Replacing obsoleted HTTP RFC 7807 with 9457 | 18.2.0 | | + diff --git a/marked/Rel-18/29_series/29518/raw.md b/marked/Rel-18/29_series/29518/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..2e2de41bc068f322f8965eb12c0ab595354b8f0a --- /dev/null +++ b/marked/Rel-18/29_series/29518/raw.md @@ -0,0 +1,20051 @@ + + +# 3GPP TS 29.518 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Access and Mobility Management Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' in black with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller black text to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps, sans-serif font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----| +| Foreword..... | 16 | +| 1 Scope..... | 17 | +| 2 References..... | 17 | +| 3 Definitions and abbreviations..... | 19 | +| 3.1 Definitions..... | 19 | +| 3.2 Abbreviations..... | 19 | +| 4 Overview..... | 20 | +| 4.1 Introduction..... | 20 | +| 5 Services offered by the AMF..... | 21 | +| 5.1 Introduction..... | 21 | +| 5.2 Namf_Communication Service..... | 23 | +| 5.2.1 Service Description..... | 23 | +| 5.2.2 Service Operations..... | 23 | +| 5.2.2.1 Introduction..... | 23 | +| 5.2.2.2 UE Context Operations..... | 24 | +| 5.2.2.2.1 UEContextTransfer..... | 24 | +| 5.2.2.2.1.1 General..... | 24 | +| 5.2.2.2.1.2 Retrieve UE Context after successful UE authentication..... | 26 | +| 5.2.2.2.2 RegistrationStatusUpdate..... | 27 | +| 5.2.2.2.2.1 General..... | 27 | +| 5.2.2.2.3 CreateUEContext..... | 28 | +| 5.2.2.2.3.1 General..... | 28 | +| 5.2.2.2.3.2 Create UE Context with AMF Relocation..... | 30 | +| 5.2.2.2.4 ReleaseUEContext..... | 31 | +| 5.2.2.2.4.1 General..... | 31 | +| 5.2.2.2.5 RelocateUEContext..... | 32 | +| 5.2.2.2.5.1 General..... | 32 | +| 5.2.2.2.6 CancelRelocateUEContext..... | 33 | +| 5.2.2.2.6.1 General..... | 33 | +| 5.2.2.3 UE Specific N1N2 Message Operations..... | 34 | +| 5.2.2.3.1 N1N2MessageTransfer..... | 34 | +| 5.2.2.3.1.1 General..... | 34 | +| 5.2.2.3.1.2 Detailed behaviour of the AMF..... | 36 | +| 5.2.2.3.2 N1N2Transfer Failure Notification..... | 39 | +| 5.2.2.3.3 N1N2MessageSubscribe..... | 40 | +| 5.2.2.3.3.1 General..... | 40 | +| 5.2.2.3.4 N1N2MessageUnSubscribe..... | 40 | +| 5.2.2.3.4.1 General..... | 40 | +| 5.2.2.3.5 N1MessageNotify..... | 41 | +| 5.2.2.3.5.1 General..... | 41 | +| 5.2.2.3.5.2 Using N1MessageNotify in the Registration with AMF Re-allocation Procedure..... | 42 | +| 5.2.2.3.5.3 Using N1MessageNotify in the UE Assisted and UE Based Positioning Procedure..... | 42 | +| 5.2.2.3.5.4 Using N1MessageNotify in the UE Configuration Update for transparent UE Policy delivery..... | 43 | +| 5.2.2.3.5.5 Using N1MessageNotify in the LCS Event Report, Event Reporting in RRC INACTIVE state procedures, LCS Cancel Location and LCS Periodic-Triggered Invoke Procedures..... | 43 | +| 5.2.2.3.5.6 Using N1MessageNotify in the UE triggered policy provisioning procedure to request UE policies..... | 43 | +| 5.2.2.3.5.7 Using N1MessageNotify in the procedures applicable to a PRU..... | 44 | +| 5.2.2.3.6 N2InfoNotify..... | 44 | +| 5.2.2.3.6.1 General..... | 44 | +| 5.2.2.3.6.2 Using N2InfoNotify during Inter NG-RAN node N2 based handover procedure..... | 45 | +| 5.2.2.3.6.3 Using N2InfoNotify during Location Services procedures..... | 46 | +| 5.2.2.3.6.4 Using N2InfoNotify during AMF planned removal procedure with UDSF deployed procedure..... | 46 | + +| | | | +|-------------|------------------------------------------------------------------------------------------------|----| +| 5.2.2.4 | Non-UE N2 Message Operations..... | 47 | +| 5.2.2.4.1 | NonUeN2MessageTransfer..... | 47 | +| 5.2.2.4.1.1 | General..... | 47 | +| 5.2.2.4.1.2 | Obtaining Non UE Associated Network Assistance Data Procedure..... | 47 | +| 5.2.2.4.1.3 | Warning Request Transfer Procedure..... | 47 | +| 5.2.2.4.1.4 | Configuration Transfer Procedure..... | 48 | +| 5.2.2.4.1.5 | RIM Information Transfer Procedures..... | 48 | +| 5.2.2.4.1.6 | Broadcast of Assistance Data by an LMF..... | 49 | +| 5.2.2.4.1.7 | Management of network timing synchronization status monitoring procedures..... | 49 | +| 5.2.2.4.2 | NonUeN2InfoSubscribe..... | 49 | +| 5.2.2.4.2.1 | General..... | 49 | +| 5.2.2.4.3 | NonUeN2InfoUnSubscribe..... | 50 | +| 5.2.2.4.3.1 | General..... | 50 | +| 5.2.2.4.4 | NonUeN2InfoNotify..... | 50 | +| 5.2.2.4.4.1 | General..... | 50 | +| 5.2.2.4.4.2 | Using NonUeN2InfoNotify during Location Services procedures..... | 51 | +| 5.2.2.4.4.3 | Use of NonUeN2InfoNotify for PWS related events..... | 51 | +| 5.2.2.4.4.4 | Using NonUeN2InfoNotify during network timing synchronization status monitoring procedure..... | 52 | +| 5.2.2.5 | AMF Status Change Operations..... | 52 | +| 5.2.2.5.1 | AMFStatusChangeSubscribe..... | 52 | +| 5.2.2.5.1.1 | General..... | 52 | +| 5.2.2.5.1.2 | Creation of a subscription..... | 52 | +| 5.2.2.5.1.3 | Modification of a subscription..... | 53 | +| 5.2.2.5.2 | AMFStatusChangeUnSubscribe..... | 53 | +| 5.2.2.5.2.1 | General..... | 53 | +| 5.2.2.5.3 | AMFStatusChangeNotify..... | 54 | +| 5.2.2.5.3.1 | General..... | 54 | +| 5.2.2.6 | EBIAssignment..... | 54 | +| 5.2.2.6.1 | General..... | 54 | +| 5.3 | Namf_EventExposure Service..... | 56 | +| 5.3.1 | Service Description..... | 56 | +| 5.3.2 | Service Operations..... | 61 | +| 5.3.2.1 | Introduction..... | 61 | +| 5.3.2.2 | Subscribe..... | 62 | +| 5.3.2.2.1 | General..... | 62 | +| 5.3.2.2.2 | Creation of a subscription..... | 62 | +| 5.3.2.2.3 | Modification of a subscription..... | 64 | +| 5.3.2.2.4 | Remove or add group member UE(s) for a group subscription..... | 65 | +| 5.3.2.3 | Unsubscribe..... | 66 | +| 5.3.2.3.1 | General..... | 66 | +| 5.3.2.4 | Notify..... | 67 | +| 5.3.2.4.1 | General..... | 67 | +| 5.3.2.4.2 | Event Subscription Synchronization for specific UE..... | 67 | +| 5.4 | Namf_MT Service..... | 68 | +| 5.4.1 | Service Description..... | 68 | +| 5.4.2 | Service Operations..... | 68 | +| 5.4.2.1 | Introduction..... | 68 | +| 5.4.2.2 | EnableUEREACHABILITY..... | 69 | +| 5.4.2.2.1 | General..... | 69 | +| 5.4.2.3 | ProvideDomainSelectionInfo..... | 70 | +| 5.4.2.3.1 | General..... | 70 | +| 5.4.2.4 | EnableGroupReachability..... | 71 | +| 5.4.2.4.1 | General..... | 71 | +| 5.4.2.5 | UEREACHABILITYInfoNotify..... | 72 | +| 5.4.2.5.1 | General..... | 72 | +| 5.5 | Namf_Location Service..... | 72 | +| 5.5.1 | Service Description..... | 72 | +| 5.5.2 | Service Operations..... | 73 | +| 5.5.2.1 | Introduction..... | 73 | +| 5.5.2.2 | ProvidePositioningInfo..... | 73 | + +| | | | +|---------------|-------------------------------------------------------------------------|-----| +| 5.5.2.2.1 | General..... | 73 | +| 5.5.2.3 | EventNotify..... | 74 | +| 5.5.2.3.1 | General..... | 74 | +| 5.5.2.4 | ProvideLocationInfo..... | 75 | +| 5.5.2.4.1 | General..... | 75 | +| 5.5.2.5 | CancelLocation..... | 76 | +| 5.5.2.5.1 | General..... | 76 | +| 5.6 | Namf_MBSBroadcast Service..... | 77 | +| 5.6.1 | Service Description..... | 77 | +| 5.6.2 | Service Operations..... | 77 | +| 5.6.2.1 | Introduction..... | 77 | +| 5.6.2.2 | ContextCreate..... | 77 | +| 5.6.2.3 | ContextUpdate..... | 79 | +| 5.6.2.4 | ContextRelease..... | 80 | +| 5.6.2.5 | ContextStatusNotify..... | 81 | +| 5.7 | Namf_MBSCommunication Service..... | 83 | +| 5.7.1 | Service Description..... | 83 | +| 5.7.2 | Service Operations..... | 83 | +| 5.7.2.1 | Introduction..... | 83 | +| 5.7.2.2 | N2MessageTransfer..... | 83 | +| 5.7.2.3 | Notify..... | 84 | +| 6 | API Definitions..... | 85 | +| 6.1 | Namf_Communication Service API..... | 85 | +| 6.1.1 | API URI..... | 85 | +| 6.1.2 | Usage of HTTP..... | 86 | +| 6.1.2.1 | General..... | 86 | +| 6.1.2.2 | HTTP standard headers..... | 86 | +| 6.1.2.2.1 | General..... | 86 | +| 6.1.2.2.2 | Content type..... | 86 | +| 6.1.2.3 | HTTP custom headers..... | 86 | +| 6.1.2.3.1 | General..... | 86 | +| 6.1.2.4 | HTTP multipart messages..... | 86 | +| 6.1.3 | Resources..... | 88 | +| 6.1.3.1 | Overview..... | 88 | +| 6.1.3.2 | Resource: Individual ueContext..... | 89 | +| 6.1.3.2.1 | Description..... | 89 | +| 6.1.3.2.2 | Resource Definition..... | 90 | +| 6.1.3.2.3 | Resource Standard Methods..... | 90 | +| 6.1.3.2.3.1 | PUT..... | 90 | +| 6.1.3.2.4 | Resource Custom Operations..... | 92 | +| 6.1.3.2.4.1 | Overview..... | 92 | +| 6.1.3.2.4.2 | Operation: release (POST)..... | 92 | +| 6.1.3.2.4.2.1 | Description..... | 92 | +| 6.1.3.2.4.2.2 | Operation Definition..... | 92 | +| 6.1.3.2.4.3 | Operation: assign-ebi (POST)..... | 93 | +| 6.1.3.2.4.3.1 | Description..... | 93 | +| 6.1.3.2.4.3.2 | Operation Definition..... | 93 | +| 6.1.3.2.4.4 | Operation: transfer (POST)..... | 96 | +| 6.1.3.2.4.4.1 | Description..... | 96 | +| 6.1.3.2.4.4.2 | Operation Definition..... | 96 | +| 6.1.3.2.4.5 | Operation: transfer-update (POST)..... | 97 | +| 6.1.3.2.4.5.1 | Description..... | 97 | +| 6.1.3.2.4.5.2 | Operation Definition..... | 98 | +| 6.1.3.2.4.6 | Operation: relocate (POST)..... | 99 | +| 6.1.3.2.4.6.1 | Description..... | 99 | +| 6.1.3.2.4.6.2 | Operation Definition..... | 99 | +| 6.1.3.2.4.7 | Operation: cancel-relocate (POST)..... | 100 | +| 6.1.3.2.4.7.1 | Description..... | 100 | +| 6.1.3.2.4.7.2 | Operation Definition..... | 100 | +| 6.1.3.3 | Resource: N1N2 Subscriptions Collection for Individual UE Contexts..... | 101 | +| 6.1.3.3.1 | Description..... | 101 | + +| | | | +|---------------|-----------------------------------------------------------------------|-----| +| 6.1.3.3.2 | Resource Definition..... | 101 | +| 6.1.3.3.3 | Resource Standard Methods..... | 101 | +| 6.1.3.3.3.1 | POST..... | 101 | +| 6.1.3.3.4 | Resource Custom Operations..... | 103 | +| 6.1.3.4 | Resource: N1N2 Individual Subscription..... | 103 | +| 6.1.3.4.1 | Description..... | 103 | +| 6.1.3.4.2 | Resource Definition..... | 103 | +| 6.1.3.4.3 | Resource Standard Methods..... | 103 | +| 6.1.3.4.3.1 | DELETE..... | 103 | +| 6.1.3.4.4 | Resource Custom Operations..... | 104 | +| 6.1.3.5 | Resource: N1N2 Messages Collection..... | 104 | +| 6.1.3.5.1 | Description..... | 104 | +| 6.1.3.5.2 | Resource Definition..... | 104 | +| 6.1.3.5.3 | Resource Standard Methods..... | 105 | +| 6.1.3.5.3.1 | POST..... | 105 | +| 6.1.3.6 | Resource: subscriptions collection..... | 109 | +| 6.1.3.6.1 | Description..... | 109 | +| 6.1.3.6.2 | Resource Definition..... | 109 | +| 6.1.3.6.3 | Resource Standard Methods..... | 109 | +| 6.1.3.6.3.1 | POST..... | 109 | +| 6.1.3.7 | Resource: individual subscription..... | 111 | +| 6.1.3.7.1 | Description..... | 111 | +| 6.1.3.7.2 | Resource Definition..... | 111 | +| 6.1.3.7.3 | Resource Standard Methods..... | 111 | +| 6.1.3.7.3.1 | DELETE..... | 111 | +| 6.1.3.7.3.2 | PUT..... | 112 | +| 6.1.3.8 | Resource: Non UE N2 Messages Collection..... | 113 | +| 6.1.3.8.1 | Description..... | 113 | +| 6.1.3.8.2 | Resource Definition..... | 114 | +| 6.1.3.8.3 | Resource Standard Methods..... | 114 | +| 6.1.3.8.4 | Resource Custom Operations..... | 114 | +| 6.1.3.8.4.1 | Overview..... | 114 | +| 6.1.3.8.4.2 | Operation: transfer..... | 114 | +| 6.1.3.8.4.2.1 | Description..... | 114 | +| 6.1.3.8.4.2.2 | Operation Definition..... | 114 | +| 6.1.3.9 | Resource: Non UE N2 Messages Subscriptions Collection..... | 116 | +| 6.1.3.9.1 | Description..... | 116 | +| 6.1.3.9.2 | Resource Definition..... | 116 | +| 6.1.3.9.3 | Resource Standard Methods..... | 116 | +| 6.1.3.9.3.1 | POST..... | 116 | +| 6.1.3.9.4 | Resource Custom Operations..... | 117 | +| 6.1.3.10 | Resource: Non UE N2 Message Notification Individual Subscription..... | 118 | +| 6.1.3.10.1 | Description..... | 118 | +| 6.1.3.10.2 | Resource Definition..... | 118 | +| 6.1.3.10.3 | Resource Standard Methods..... | 118 | +| 6.1.3.10.3.1 | DELETE..... | 118 | +| 6.1.3.10.4 | Resource Custom Operations..... | 119 | +| 6.1.4 | Custom Operations without associated resources..... | 119 | +| 6.1.5 | Notifications..... | 119 | +| 6.1.5.1 | General..... | 119 | +| 6.1.5.2 | AMF Status Change Notification..... | 120 | +| 6.1.5.2.1 | Description..... | 120 | +| 6.1.5.2.2 | Notification Definition..... | 120 | +| 6.1.5.2.3 | Notification Standard Methods..... | 120 | +| 6.1.5.2.3.1 | POST..... | 120 | +| 6.1.5.3 | Non UE N2 Information Notification..... | 121 | +| 6.1.5.3.1 | Description..... | 121 | +| 6.1.5.3.2 | Notification Definition..... | 121 | +| 6.1.5.3.3 | Notification Standard Methods..... | 122 | +| 6.1.5.3.3.1 | POST..... | 122 | +| 6.1.5.4 | N1 Message Notification..... | 123 | + +| | | | +|-------------|-----------------------------------------------|-----| +| 6.1.5.4.1 | Description..... | 123 | +| 6.1.5.4.2 | Notification Definition..... | 123 | +| 6.1.5.4.3 | Notification Standard Methods..... | 123 | +| 6.1.5.4.3.1 | POST..... | 123 | +| 6.1.5.5 | UE Specific N2 Information Notification..... | 124 | +| 6.1.5.5.1 | Description..... | 124 | +| 6.1.5.5.2 | Notification Definition..... | 124 | +| 6.1.5.5.3 | Notification Standard Methods..... | 124 | +| 6.1.5.5.3.1 | POST..... | 124 | +| 6.1.5.6 | N1N2 Transfer Failure Notification..... | 125 | +| 6.1.5.6.1 | Description..... | 125 | +| 6.1.5.6.2 | Notification Definition..... | 125 | +| 6.1.5.6.3 | Notification Standard Methods..... | 126 | +| 6.1.5.6.3.1 | POST..... | 126 | +| 6.1.5.7 | Void..... | 127 | +| 6.1.6 | Data Model..... | 127 | +| 6.1.6.1 | General..... | 127 | +| 6.1.6.2 | Structured data types..... | 134 | +| 6.1.6.2.1 | Introduction..... | 134 | +| 6.1.6.2.2 | Type: SubscriptionData..... | 135 | +| 6.1.6.2.3 | Type: AmfStatusChangeNotification..... | 135 | +| 6.1.6.2.4 | Type: AmfStatusInfo..... | 135 | +| 6.1.6.2.5 | Type: AssignEbiData..... | 136 | +| 6.1.6.2.6 | Type: AssignedEbiData..... | 136 | +| 6.1.6.2.7 | Type: AssignEbiFailed..... | 137 | +| 6.1.6.2.8 | Type: UEContextRelease..... | 137 | +| 6.1.6.2.9 | Type: N2InformationTransferReqData..... | 137 | +| 6.1.6.2.10 | Type: NonUeN2InfoSubscriptionCreateData..... | 138 | +| 6.1.6.2.11 | Type: NonUeN2InfoSubscriptionCreatedData..... | 139 | +| 6.1.6.2.12 | Type: UeN1N2InfoSubscriptionCreateData..... | 139 | +| 6.1.6.2.13 | Type: UeN1N2InfoSubscriptionCreatedData..... | 139 | +| 6.1.6.2.14 | Type: N2InformationNotification..... | 140 | +| 6.1.6.2.15 | Type: N2InfoContainer..... | 143 | +| 6.1.6.2.16 | Type: N1MessageNotification..... | 144 | +| 6.1.6.2.17 | Type: N1MessageContainer..... | 145 | +| 6.1.6.2.18 | Type: N1N2MessageTransferReqData..... | 146 | +| 6.1.6.2.19 | Type: N1N2MessageTransferRspData..... | 150 | +| 6.1.6.2.20 | Type: RegistrationContextContainer..... | 151 | +| 6.1.6.2.21 | Type: AreaOfValidity..... | 153 | +| 6.1.6.2.22 | Void..... | 153 | +| 6.1.6.2.23 | Type: UeContextTransferReqData..... | 153 | +| 6.1.6.2.24 | Type: UeContextTransferRspData..... | 154 | +| 6.1.6.2.25 | Type: UeContext..... | 155 | +| 6.1.6.2.26 | Type: N2SmInformation..... | 165 | +| 6.1.6.2.27 | Type: N2InfoContent..... | 166 | +| 6.1.6.2.28 | Type: NrppaInformation..... | 166 | +| 6.1.6.2.29 | Type: PwsInformation..... | 167 | +| 6.1.6.2.30 | Type: N1N2MsgTxfrFailureNotification..... | 169 | +| 6.1.6.2.31 | Type: N1N2MessageTransferError..... | 169 | +| 6.1.6.2.32 | Type: N1N2MsgTxfrErrDetail..... | 170 | +| 6.1.6.2.33 | Type: N2InformationTransferRspData..... | 170 | +| 6.1.6.2.34 | Type: MmContext..... | 171 | +| 6.1.6.2.35 | Type: SeafData..... | 174 | +| 6.1.6.2.36 | Type: NasSecurityMode..... | 174 | +| 6.1.6.2.37 | Type: PduSessionContext..... | 175 | +| 6.1.6.2.38 | Type: NssaiMapping..... | 180 | +| 6.1.6.2.39 | Type: UeRegStatusUpdateReqData..... | 181 | +| 6.1.6.2.40 | Type: AssignEbiError..... | 181 | +| 6.1.6.2.41 | Type: UeContextCreateData..... | 182 | +| 6.1.6.2.42 | Type: UeContextCreatedData..... | 183 | +| 6.1.6.2.43 | Type: UeContextCreateError..... | 183 | + +| | | | +|------------|-----------------------------------------------|-----| +| 6.1.6.2.44 | Type: NgRanTargetId..... | 184 | +| 6.1.6.2.45 | Type: N2InformationTransferError..... | 184 | +| 6.1.6.2.46 | Type: PWSSResponseData..... | 184 | +| 6.1.6.2.47 | Type: PWSErrorData..... | 185 | +| 6.1.6.2.48 | Void..... | 185 | +| 6.1.6.2.49 | Type: NgKsi..... | 185 | +| 6.1.6.2.50 | Type: KeyAmf..... | 185 | +| 6.1.6.2.51 | Type: ExpectedUeBehavior..... | 185 | +| 6.1.6.2.52 | Type: UeRegStatusUpdateRspData..... | 186 | +| 6.1.6.2.53 | Type: N2RanInformation..... | 186 | +| 6.1.6.2.54 | Type: N2InfoNotificationRspData..... | 186 | +| 6.1.6.2.55 | Type: SmallDataRateStatusInfo..... | 186 | +| 6.1.6.2.56 | Type: SmfChangeInfo..... | 187 | +| 6.1.6.2.57 | Type: V2xContext..... | 187 | +| 6.1.6.2.58 | Type: ImmediateMdtConf..... | 188 | +| 6.1.6.2.59 | Type: V2xInformation..... | 190 | +| 6.1.6.2.60 | Type: EpsNasSecurityMode..... | 190 | +| 6.1.6.2.61 | Type: UeContextRelocateData..... | 191 | +| 6.1.6.2.62 | Type: UeContextRelocatedData..... | 191 | +| 6.1.6.2.63 | Void..... | 191 | +| 6.1.6.2.64 | Type: EcRestrictionDataWb..... | 192 | +| 6.1.6.2.65 | Type: ExtAmfEventSubscription..... | 192 | +| 6.1.6.2.66 | Type: AmfEventSubscriptionAddInfo..... | 193 | +| 6.1.6.2.67 | Type: UeContextCancelRelocateData..... | 194 | +| 6.1.6.2.68 | Type: UeDifferentiationInfo..... | 194 | +| 6.1.6.2.69 | Type: CeModeBInd..... | 194 | +| 6.1.6.2.70 | Type: LteMInd..... | 195 | +| 6.1.6.2.71 | Type: NpnAccessInfo..... | 195 | +| 6.1.6.2.72 | Type: ProseContext..... | 195 | +| 6.1.6.2.73 | Type: AnalyticsSubscription..... | 196 | +| 6.1.6.2.74 | Type: NwdafSubscription..... | 196 | +| 6.1.6.2.75 | Type: UpdpSubscriptionData..... | 196 | +| 6.1.6.2.76 | Type: ProSeInformation..... | 196 | +| 6.1.6.2.77 | Type: ReleaseSessionInfo..... | 197 | +| 6.1.6.2.78 | Type: AreaOfInterestEventState..... | 197 | +| 6.1.6.2.79 | Type: TssInformation..... | 197 | +| 6.1.6.2.80 | Type: AmPolicyInfoContainer..... | 197 | +| 6.1.6.2.81 | Type: RslpInformation..... | 198 | +| 6.1.6.2.82 | Type: A2xContext..... | 198 | +| 6.1.6.2.83 | Type: A2xInformation..... | 198 | +| 6.1.6.2.84 | Type: LcsUpContext..... | 198 | +| 6.1.6.3 | Simple data types and enumerations..... | 199 | +| 6.1.6.3.1 | Introduction..... | 199 | +| 6.1.6.3.2 | Simple data types..... | 199 | +| 6.1.6.3.3 | Enumeration: StatusChange..... | 200 | +| 6.1.6.3.4 | Enumeration: N2InformationClass..... | 200 | +| 6.1.6.3.5 | Enumeration: N1MessageClass..... | 200 | +| 6.1.6.3.6 | Enumeration: N1N2MessageTransferCause..... | 201 | +| 6.1.6.3.7 | Enumeration: UeContextTransferStatus..... | 202 | +| 6.1.6.3.8 | Enumeration: N2InformationTransferResult..... | 202 | +| 6.1.6.3.9 | Enumeration: CipheringAlgorithm..... | 202 | +| 6.1.6.3.10 | Enumeration: IntegrityAlgorithm..... | 202 | +| 6.1.6.3.11 | Enumeration: SmsSupport..... | 202 | +| 6.1.6.3.12 | Enumeration: ScType..... | 203 | +| 6.1.6.3.13 | Enumeration: KeyAmfType..... | 203 | +| 6.1.6.3.14 | Enumeration: TransferReason..... | 203 | +| 6.1.6.3.15 | Enumeration: PolicyReqTrigger..... | 203 | +| 6.1.6.3.16 | Enumeration: RatSelector..... | 204 | +| 6.1.6.3.17 | Enumeration: NgapIeType..... | 204 | +| 6.1.6.3.18 | Enumeration: N2InfoNotifyReason..... | 204 | +| 6.1.6.3.19 | Enumeration: SmfChangeIndication..... | 204 | + +| | | | +|-------------|-----------------------------------------------------|-----| +| 6.1.6.3.20 | Enumeration: SbiBindingLevel..... | 205 | +| 6.1.6.3.21 | Enumeration: EpsNasCipheringAlgorithm..... | 205 | +| 6.1.6.3.22 | Enumeration: EpsNasIntegrityAlgorithm..... | 205 | +| 6.1.6.3.23 | Enumeration: PeriodicCommunicationIndicator..... | 205 | +| 6.1.6.3.24 | Enumeration: UuamMmStatus..... | 205 | +| 6.1.6.3.25 | Enumeration: ReleaseCause..... | 206 | +| 6.1.6.4 | Binary data..... | 206 | +| 6.1.6.4.1 | Introduction..... | 206 | +| 6.1.6.4.2 | N1 Message..... | 206 | +| 6.1.6.4.3 | N2 Information..... | 207 | +| 6.1.6.4.3.1 | Introduction..... | 207 | +| 6.1.6.4.3.2 | NGAP IEs..... | 207 | +| 6.1.6.4.3.3 | NGAP Messages..... | 209 | +| 6.1.6.4.4 | Mobile Terminated Data..... | 211 | +| 6.1.6.4.5 | GTP-C Message..... | 211 | +| 6.1.7 | Error Handling..... | 211 | +| 6.1.7.1 | General..... | 211 | +| 6.1.7.2 | Protocol Errors..... | 211 | +| 6.1.7.3 | Application Errors..... | 212 | +| 6.1.8 | Feature Negotiation..... | 215 | +| 6.1.9 | Security..... | 218 | +| 6.1.10 | HTTP redirection..... | 219 | +| 6.2 | Namf_EventExposure Service API..... | 219 | +| 6.2.1 | API URI..... | 219 | +| 6.2.2 | Usage of HTTP..... | 220 | +| 6.2.2.1 | General..... | 220 | +| 6.2.2.2 | HTTP standard headers..... | 220 | +| 6.2.2.2.1 | General..... | 220 | +| 6.2.2.2.2 | Content type..... | 220 | +| 6.2.2.3 | HTTP custom headers..... | 220 | +| 6.2.2.3.1 | General..... | 220 | +| 6.2.3 | Resources..... | 221 | +| 6.2.3.1 | Overview..... | 221 | +| 6.2.3.2 | Resource: Subscriptions collection..... | 221 | +| 6.2.3.2.1 | Description..... | 221 | +| 6.2.3.2.2 | Resource Definition..... | 221 | +| 6.2.3.2.3 | Resource Standard Methods..... | 222 | +| 6.2.3.2.3.1 | POST..... | 222 | +| 6.2.3.2.4 | Resource Custom Operations..... | 223 | +| 6.2.3.3 | Resource: Individual subscription..... | 223 | +| 6.2.3.3.1 | Description..... | 223 | +| 6.2.3.3.2 | Resource Definition..... | 223 | +| 6.2.3.3.3 | Resource Standard Methods..... | 223 | +| 6.2.3.3.3.1 | PATCH..... | 223 | +| 6.2.3.3.3.2 | DELETE..... | 225 | +| 6.2.3.3.4 | Resource Custom Operations..... | 226 | +| 6.2.4 | Custom Operations without associated resources..... | 226 | +| 6.2.5 | Notifications..... | 226 | +| 6.2.5.1 | Void..... | 226 | +| 6.2.5.2 | AMF Event Notification..... | 226 | +| 6.2.5.2.1 | Notification Definition..... | 226 | +| 6.2.5.2.3 | Notification Standard Methods..... | 226 | +| 6.2.5.2.3.1 | POST..... | 226 | +| 6.2.6 | Data Model..... | 227 | +| 6.2.6.1 | General..... | 227 | +| 6.2.6.2 | Structured data types..... | 229 | +| 6.2.6.2.1 | Introduction..... | 229 | +| 6.2.6.2.2 | Type: AmfEventSubscription..... | 230 | +| 6.2.6.2.3 | Type: AmfEvent..... | 233 | +| 6.2.6.2.4 | Type: AmfEventNotification..... | 239 | +| 6.2.6.2.5 | Type: AmfEventReport..... | 240 | + +| | | | +|------------|---------------------------------------------|-----| +| 6.2.6.2.6 | Type: AmfEventMode..... | 245 | +| 6.2.6.2.7 | Type: AmfEventState..... | 247 | +| 6.2.6.2.8 | Type: RmInfo..... | 248 | +| 6.2.6.2.9 | Type: CmInfo..... | 248 | +| 6.2.6.2.10 | Void..... | 248 | +| 6.2.6.2.11 | Type: CommunicationFailure..... | 248 | +| 6.2.6.2.12 | Type: AmfCreateEventSubscription..... | 248 | +| 6.2.6.2.13 | Type: AmfCreatedEventSubscription..... | 249 | +| 6.2.6.2.14 | Type: AmfUpdateEventSubscriptionItem..... | 250 | +| 6.2.6.2.15 | Type: AmfUpdatedEventSubscription..... | 254 | +| 6.2.6.2.16 | Type: AmfEventArea..... | 254 | +| 6.2.6.2.17 | Type: LadnInfo..... | 255 | +| 6.2.6.2.18 | Type: AmfUpdateEventOptionItem..... | 256 | +| 6.2.6.2.19 | Type: 5GsUserInfo..... | 257 | +| 6.2.6.2.20 | Type: TrafficDescriptor..... | 257 | +| 6.2.6.2.21 | Type: UEIdExt..... | 257 | +| 6.2.6.2.22 | Type: AmfEventSubsSyncInfo..... | 257 | +| 6.2.6.2.23 | Type: AmfEventSubscriptionInfo..... | 258 | +| 6.2.6.2.24 | Type: TargetArea..... | 258 | +| 6.2.6.2.25 | Type: SnssaiTaiMapping..... | 258 | +| 6.2.6.2.26 | Type: SupportedSnssai..... | 259 | +| 6.2.6.2.27 | Type: UeInAreaFilter..... | 259 | +| 6.2.6.2.28 | Type: IdleStatusIndication..... | 260 | +| 6.2.6.2.29 | Type: UeAccessBehaviorReportItem..... | 260 | +| 6.2.6.2.30 | Type: UeLocationTrendsReportItem..... | 261 | +| 6.2.6.2.31 | Type: DispersionArea..... | 261 | +| 6.2.6.2.32 | Type: MmTransactionLocationReportItem..... | 262 | +| 6.2.6.2.33 | Type: MmTransactionSliceReportItem..... | 262 | +| 6.2.6.3 | Simple data types and enumerations..... | 262 | +| 6.2.6.3.1 | Introduction..... | 262 | +| 6.2.6.3.2 | Simple data types..... | 262 | +| 6.2.6.3.3 | Enumeration: AmfEventType..... | 263 | +| 6.2.6.3.4 | Enumeration: AmfEventTrigger..... | 265 | +| 6.2.6.3.5 | Enumeration: LocationFilter..... | 266 | +| 6.2.6.3.6 | Void..... | 266 | +| 6.2.6.3.7 | Enumeration: UeReachability..... | 266 | +| 6.2.6.3.8 | Void..... | 266 | +| 6.2.6.3.9 | Enumeration: RmState..... | 266 | +| 6.2.6.3.10 | Enumeration: CmState..... | 266 | +| 6.2.6.3.11 | Enumeration: 5GsUserInfoState..... | 267 | +| 6.2.6.3.12 | Enumeration: LossOfConnectivityReason..... | 267 | +| 6.2.6.3.13 | Enumeration: ReachabilityFilter..... | 267 | +| 6.2.6.3.14 | Enumeration: UeType..... | 267 | +| 6.2.6.3.15 | Enumeration: AccessStateTransitionType..... | 268 | +| 6.2.6.3.16 | Enumeration: SubTerminationReason..... | 268 | +| 6.2.6.4 | Binary data..... | 268 | +| 6.2.7 | Error Handling..... | 268 | +| 6.2.7.1 | General..... | 268 | +| 6.2.7.2 | Protocol Errors..... | 268 | +| 6.2.7.3 | Application Errors..... | 268 | +| 6.2.8 | Feature Negotiation..... | 269 | +| 6.2.9 | Security..... | 272 | +| 6.2.10 | HTTP redirection..... | 272 | +| 6.3 | Namf_MT Service API..... | 272 | +| 6.3.1 | API URI..... | 272 | +| 6.3.2 | Usage of HTTP..... | 273 | +| 6.3.2.1 | General..... | 273 | +| 6.3.2.2 | HTTP standard headers..... | 273 | +| 6.3.2.2.1 | General..... | 273 | +| 6.3.2.2.2 | Content type..... | 273 | +| 6.3.2.3 | HTTP custom headers..... | 273 | + +| | | | +|---------------|-----------------------------------------------------|-----| +| 6.3.2.3.1 | General..... | 273 | +| 6.3.3 | Resources..... | 274 | +| 6.3.3.1 | Overview..... | 274 | +| 6.3.3.2 | Resource: ueReachInd..... | 274 | +| 6.3.3.2.1 | Description..... | 274 | +| 6.3.3.2.2 | Resource Definition..... | 274 | +| 6.3.3.2.3 | Resource Standard Methods..... | 275 | +| 6.3.3.2.3.1 | PUT..... | 275 | +| 6.3.3.2.4 | Resource Custom Operations..... | 277 | +| 6.3.3.3 | Resource: ueContext..... | 277 | +| 6.3.3.3.1 | Description..... | 277 | +| 6.3.3.3.2 | Resource Definition..... | 277 | +| 6.3.3.3.3 | Resource Standard Methods..... | 277 | +| 6.3.3.3.3.1 | GET..... | 277 | +| 6.3.3.3.4 | Resource Custom Operations..... | 279 | +| 6.3.3.4 | Resource: ueContexts collection..... | 279 | +| 6.3.3.4.1 | Description..... | 279 | +| 6.3.3.4.2 | Resource Definition..... | 279 | +| 6.3.3.4.3 | Resource Standard Methods..... | 279 | +| 6.3.3.4.4 | Resource Custom Operations..... | 279 | +| 6.3.3.4.4.1 | Overview..... | 279 | +| 6.3.3.4.4.2 | Operation: enable-group-reachability..... | 279 | +| 6.3.3.4.4.2.1 | Description..... | 279 | +| 6.3.3.4.4.2.2 | Operation Definition..... | 279 | +| 6.3.4 | Custom Operations without associated resources..... | 281 | +| 6.3.5 | Notifications..... | 281 | +| 6.3.5.1 | General..... | 281 | +| 6.3.5.2 | UE Reachability Info Notify..... | 281 | +| 6.3.5.2.1 | Notification Definition..... | 281 | +| 6.3.5.2.3 | Notification Standard Methods..... | 281 | +| 6.3.5.2.3.1 | POST..... | 281 | +| 6.3.6 | Data Model..... | 282 | +| 6.3.6.1 | General..... | 282 | +| 6.3.6.2 | Structured data types..... | 283 | +| 6.3.6.2.1 | Introduction..... | 283 | +| 6.3.6.2.2 | Type: EnableUeReachabilityReqData..... | 284 | +| 6.3.6.2.3 | Type: EnableUeReachabilityRspData..... | 285 | +| 6.3.6.2.4 | Type: UeContextInfo..... | 285 | +| 6.3.6.2.5 | Type: ProblemDetailsEnableUeReachability..... | 285 | +| 6.3.6.2.6 | Type: AdditionInfoEnableUeReachability..... | 286 | +| 6.3.6.2.7 | Type: EnableGroupReachabilityReqData..... | 286 | +| 6.3.6.2.8 | Type: EnableGroupReachabilityRspData..... | 286 | +| 6.3.6.2.9 | Type: UeInfo..... | 286 | +| 6.3.6.2.10 | Type: ReachabilityNotificationData..... | 287 | +| 6.3.6.2.11 | Type: ReachableUeInfo..... | 287 | +| 6.3.6.3 | Simple data types and enumerations..... | 287 | +| 6.3.6.3.1 | Introduction..... | 287 | +| 6.3.6.3.2 | Simple data types..... | 287 | +| 6.3.6.3.3 | Enumeration: UeContextInfoClass..... | 287 | +| 6.3.6.4 | Binary data..... | 287 | +| 6.3.7 | Error Handling..... | 287 | +| 6.3.7.1 | General..... | 287 | +| 6.3.7.2 | Protocol Errors..... | 287 | +| 6.3.7.3 | Application Errors..... | 288 | +| 6.3.8 | Feature Negotiation..... | 288 | +| 6.3.9 | Security..... | 289 | +| 6.3.10 | HTTP redirection..... | 289 | +| 6.4 | Namf_Location Service API..... | 290 | +| 6.4.1 | API URI..... | 290 | +| 6.4.2 | Usage of HTTP..... | 290 | +| 6.4.2.1 | General..... | 290 | + +| | | | +|---------------|-----------------------------------------------------|-----| +| 6.4.2.2 | HTTP standard headers..... | 290 | +| 6.4.2.2.1 | General..... | 290 | +| 6.4.2.2.2 | Content type..... | 290 | +| 6.4.2.3 | HTTP custom headers..... | 291 | +| 6.4.2.3.1 | General..... | 291 | +| 6.4.3 | Resources..... | 291 | +| 6.4.3.1 | Overview..... | 291 | +| 6.4.3.2 | Resource: Individual UE Context..... | 292 | +| 6.4.3.2.1 | Description..... | 292 | +| 6.4.3.2.2 | Resource Definition..... | 292 | +| 6.4.3.2.3 | Resource Standard Methods..... | 292 | +| 6.4.3.2.4 | Resource Custom Operations..... | 292 | +| 6.4.3.2.4.1 | Overview..... | 292 | +| 6.4.3.2.4.2 | Operation: provide-pos-info (POST)..... | 292 | +| 6.4.3.2.4.2.1 | Description..... | 292 | +| 6.4.3.2.4.2.2 | Operation Definition..... | 292 | +| 6.4.3.2.4.3 | Operation: provide-loc-info (POST)..... | 294 | +| 6.4.3.2.4.3.1 | Description..... | 294 | +| 6.4.3.2.4.3.2 | Operation Definition..... | 294 | +| 6.4.3.2.4.4 | Operation: cancel-pos-info (POST)..... | 295 | +| 6.4.3.2.4.4.1 | Description..... | 295 | +| 6.4.3.2.4.4.2 | Operation Definition..... | 296 | +| 6.4.4 | Custom Operations without associated resources..... | 297 | +| 6.4.5 | Notifications..... | 297 | +| 6.4.5.1 | General..... | 297 | +| 6.4.5.2 | Event Notify..... | 297 | +| 6.4.5.2.1 | Description..... | 297 | +| 6.4.5.2.2 | Notification Definition..... | 297 | +| 6.4.5.2.3 | Notification Standard Methods..... | 297 | +| 6.4.5.2.3.1 | POST..... | 297 | +| 6.4.6 | Data Model..... | 298 | +| 6.4.6.1 | General..... | 298 | +| 6.4.6.2 | Structured data types..... | 302 | +| 6.4.6.2.1 | Introduction..... | 302 | +| 6.4.6.2.2 | Type: RequestPosInfo..... | 303 | +| 6.4.6.2.3 | Type: ProvidePosInfo..... | 308 | +| 6.4.6.2.4 | Type: NotifiedPosInfo..... | 312 | +| 6.4.6.2.5 | Type: RequestLocInfo..... | 315 | +| 6.4.6.2.6 | Type: ProvideLocInfo..... | 316 | +| 6.4.6.2.7 | Type: CancelPosInfo..... | 316 | +| 6.4.6.2.11 | Type: ProvidePosInfoExt..... | 317 | +| 6.4.6.2.12 | Type: NotifiedPosInfoExt..... | 317 | +| 6.4.6.3 | Simple data types and enumerations..... | 317 | +| 6.4.6.3.1 | Introduction..... | 317 | +| 6.4.6.3.2 | Simple data types..... | 317 | +| 6.4.6.3.3 | Enumeration: LocationType..... | 318 | +| 6.4.6.3.4 | Enumeration: LocationEvent..... | 318 | +| 6.4.6.3.5 | Enumeration: LocationPrivacyVerResult..... | 318 | +| 6.4.6.3.6 | Enumeration: LpHapType..... | 318 | +| 6.4.7 | Error Handling..... | 319 | +| 6.4.7.1 | General..... | 319 | +| 6.4.7.2 | Protocol Errors..... | 319 | +| 6.4.7.3 | Application Errors..... | 319 | +| 6.4.8 | Feature Negotiation..... | 319 | +| 6.4.9 | Security..... | 320 | +| 6.4.10 | HTTP redirection..... | 320 | +| 6.5 | Namf_MBSBroadcast Service API..... | 321 | +| 6.5.1 | API URI..... | 321 | +| 6.5.2 | Usage of HTTP..... | 321 | +| 6.5.2.1 | General..... | 321 | +| 6.5.2.2 | HTTP standard headers..... | 321 | + +| | | | +|---------------|----------------------------------------------------------|-----| +| 6.5.2.2.1 | General..... | 321 | +| 6.5.2.2.2 | Content type..... | 321 | +| 6.5.2.3 | HTTP custom headers..... | 322 | +| 6.5.2.3.1 | General..... | 322 | +| 6.5.2.4 | HTTP multipart messages..... | 322 | +| 6.5.3 | Resources..... | 323 | +| 6.5.3.1 | Overview..... | 323 | +| 6.5.3.2 | Resource: Broadcast MBS session contexts collection..... | 323 | +| 6.5.3.2.1 | Description..... | 323 | +| 6.5.3.2.2 | Resource Definition..... | 323 | +| 6.5.3.2.3 | Resource Standard Methods..... | 324 | +| 6.5.3.2.3.1 | POST..... | 324 | +| 6.5.3.2.4 | Resource Custom Operations..... | 325 | +| 6.5.3.3 | Resource: Individual broadcast MBS session context..... | 325 | +| 6.5.3.3.1 | Description..... | 325 | +| 6.5.3.3.2 | Resource Definition..... | 325 | +| 6.5.3.3.3 | Resource Standard Methods..... | 325 | +| 6.5.3.3.3.1 | DELETE..... | 325 | +| 6.5.3.3.4 | Resource Custom Operations..... | 326 | +| 6.5.3.2.4.2 | Operation: update (POST)..... | 326 | +| 6.5.3.2.4.2.1 | Description..... | 326 | +| 6.5.3.2.4.2.2 | Operation Definition..... | 326 | +| 6.5.4 | Custom Operations without associated resources..... | 327 | +| 6.5.5 | Notifications..... | 327 | +| 6.5.5.1 | General..... | 327 | +| 6.5.5.2 | Broadcast MBS Session Context Status Notification..... | 328 | +| 6.5.5.2.1 | Description..... | 328 | +| 6.5.5.2.2 | Target URI..... | 328 | +| 6.5.5.2.3 | Notification Standard Methods..... | 328 | +| 6.5.5.2.3.1 | POST..... | 328 | +| 6.5.6 | Data Model..... | 329 | +| 6.5.6.1 | General..... | 329 | +| 6.5.6.2 | Structured data types..... | 330 | +| 6.5.6.2.1 | Introduction..... | 330 | +| 6.5.6.2.2 | Type: ContextCreateReqData..... | 330 | +| 6.5.6.2.3 | Type: ContextCreateRspData..... | 330 | +| 6.5.6.2.4 | Type: ContextStatusNotification..... | 331 | +| 6.5.6.2.5 | Type: ContextUpdateReqData..... | 332 | +| 6.5.6.2.6 | Type: ContextUpdateRspData..... | 332 | +| 6.5.6.2.7 | Type: N2MbsSmInfo..... | 333 | +| 6.5.6.2.8 | Type: OperationEvent..... | 333 | +| 6.5.6.2.9 | Type: NgranFailureEvent..... | 333 | +| 6.5.6.2.10 | Type: ContextStatusNotificationResponse..... | 334 | +| 6.5.6.3 | Simple data types and enumerations..... | 334 | +| 6.5.6.3.1 | Introduction..... | 334 | +| 6.5.6.3.2 | Simple data types..... | 334 | +| 6.5.6.3.3 | Enumeration: OperationStatus..... | 334 | +| 6.5.6.3.4 | Enumeration: NgapIeType..... | 335 | +| 6.5.6.3.5 | Enumeration: OpEventType..... | 335 | +| 6.5.6.3.6 | Enumeration: NgranFailureIndication..... | 335 | +| 6.5.6.4 | Binary data..... | 335 | +| 6.5.6.4.1 | Introduction..... | 335 | +| 6.5.6.4.2 | N2 Information..... | 336 | +| 6.5.6.4.2.1 | Introduction..... | 336 | +| 6.5.6.4.2.2 | NGAP IEs..... | 336 | +| 6.5.7 | Error Handling..... | 336 | +| 6.5.7.1 | General..... | 336 | +| 6.5.7.2 | Protocol Errors..... | 336 | +| 6.5.7.3 | Application Errors..... | 336 | +| 6.5.8 | Feature Negotiation..... | 337 | +| 6.5.9 | Security..... | 337 | + +| | | | +|---------------|------------------------------------------------------|-----| +| 6.5.10 | HTTP redirection..... | 337 | +| 6.6 | Namf_MBSCCommunication Service API..... | 337 | +| 6.6.1 | API URI..... | 337 | +| 6.6.2 | Usage of HTTP..... | 338 | +| 6.6.2.1 | General..... | 338 | +| 6.6.2.2 | HTTP standard headers..... | 338 | +| 6.6.2.2.1 | General..... | 338 | +| 6.6.2.2.2 | Content type..... | 338 | +| 6.6.2.3 | HTTP custom headers..... | 338 | +| 6.6.2.3.1 | General..... | 338 | +| 6.6.2.4 | HTTP multipart messages..... | 339 | +| 6.6.3 | Resources..... | 339 | +| 6.6.3.1 | Overview..... | 339 | +| 6.6.3.1 | Resource: N2 Message Handler (Custom Operation)..... | 340 | +| 6.6.3.1.1 | Description..... | 340 | +| 6.6.3.1.2 | Resource Definition..... | 340 | +| 6.6.3.1.3 | Resource Standard Methods..... | 340 | +| 6.6.3.1.4 | Resource Custom Operations..... | 340 | +| 6.6.3.1.4.1 | Overview..... | 340 | +| 6.6.3.1.4.2 | Operation: transfer..... | 340 | +| 6.6.3.1.4.2.1 | Description..... | 340 | +| 6.6.3.1.4.2.2 | Operation Definition..... | 340 | +| 6.6.4 | Custom Operations without associated resources..... | 341 | +| 6.6.5 | Notifications..... | 341 | +| 6.6.5.1 | General..... | 341 | +| 6.6.5.2 | Notification..... | 342 | +| 6.6.5.2.1 | Description..... | 342 | +| 6.6.5.2.2 | Notification Definitionn..... | 342 | +| 6.6.5.2.3 | Notification Standard Methods..... | 342 | +| 6.6.5.2.3.1 | POST..... | 342 | +| 6.6.6 | Data Model..... | 343 | +| 6.6.6.1 | General..... | 343 | +| 6.6.6.2 | Structured data types..... | 344 | +| 6.6.6.2.1 | Introduction..... | 344 | +| 6.6.6.2.2 | Type: MbsN2MessageTransferReqData..... | 344 | +| 6.6.6.2.3 | Type: MbsN2MessageTransferRspData..... | 344 | +| 6.6.6.2.4 | Type: N2MbsSmInfo..... | 345 | +| 6.6.6.2.5 | Type: Notification..... | 345 | +| 6.6.6.2.6 | Type: RanFailure..... | 345 | +| 6.6.6.3 | Simple data types and enumerations..... | 345 | +| 6.6.6.3.1 | Introduction..... | 345 | +| 6.6.6.3.2 | Simple data types..... | 345 | +| 6.6.6.3.3 | Enumeration: MbsNgapIeType..... | 346 | +| 6.6.6.3.4 | Enumeration: RanFailureIndication..... | 346 | +| 6.6.6.4 | Binary data..... | 346 | +| 6.6.6.4.1 | Introduction..... | 346 | +| 6.6.6.4.2 | N2 Information..... | 346 | +| 6.6.6.4.2.1 | Introduction..... | 346 | +| 6.6.6.4.2.2 | NGAP IEs..... | 346 | +| 6.6.7 | Error Handling..... | 347 | +| 6.6.7.1 | General..... | 347 | +| 6.6.7.2 | Protocol Errors..... | 347 | +| 6.6.7.3 | Application Errors..... | 347 | +| 6.6.8 | Feature Negotiation..... | 347 | +| 6.6.9 | Security..... | 348 | +| 6.6.10 | HTTP redirection..... | 348 | + +| | | | +|-------|---------------------------------------------------------------------|-----| +| A.1 | General..... | 348 | +| A.2 | Namf_Communication API..... | 349 | +| A.3 | Namf_EventExposure API..... | 404 | +| A.4 | Namf_MT..... | 419 | +| A.5 | Namf_Location..... | 424 | +| A.6 | Namf_MBSSroadcast API..... | 433 | +| A.7 | Namf_MBSCommunication API..... | 445 | +| B.1 | Example of HTTP multipart message..... | 448 | +| B.1.1 | General..... | 448 | +| B.1.2 | Example HTTP multipart message with N2 Information binary data..... | 448 | + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document +- might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +- is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +--- + +## 1 Scope + +The present document specifies the stage 3 protocol and data model for the Namf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the AMF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.247 [55]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +--- + +## 2 References + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [7] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System; Stage 2". +- [8] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [9] IETF RFC 2387: "The MIME Multipart/Related Content-type". +- [10] IETF RFC 2045: "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies". +- [11] 3GPP TS 24.501: "Non-Access-Stratum (NAS) Protocol for 5G System (5GS); Stage 3". +- [12] 3GPP TS 38.413: "NG Radio Access Network (NG-RAN); NG Application Protocol (NGAP)". +- [13] 3GPP TS 36.355: "Evolved Universal Terrestrial Radio Access (E-UTRA); LTE Positioning Protocol (LPP)". +- [14] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". +- [15] 3GPP TS 24.007: "Mobile radio interface signalling layer 3; General Aspects". +- [16] 3GPP TS 29.502: "5G System, Session Management Services; Stage 3". +- [17] 3GPP TS 38.455: "NR Positioning Protocol A (NRPPa)". +- [18] 3GPP TS 29.531: "Network Slice Selection Services; Stage 3". +- [19] IETF RFC 9113: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [20] 3GPP TS 23.041: "Technical realization of Cell Broadcast Service (CBS)". +- [21] Void. + +- [22] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols; Stage 3". +- [23] OpenAPI Initiative, "OpenAPI Specification Version 3.0.0". +- [24] 3GPP TS 36.413: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 Application Protocol (S1AP)". +- [25] 3GPP TS 29.572: "5G System, Location Management Services; Stage 3". +- [26] Void. +- [27] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [28] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [29] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [30] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management". +- [31] Void. +- [32] 3GPP TS 29.507: "5G System; Access and Mobility Policy Control Service; Stage 3". +- [33] 3GPP TS 23.527: "5G System; Restoration Procedures". +- [34] 3GPP TS 29.525: "5G System; UE Policy Control Service; Stage 3". +- [35] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [36] IETF RFC 9457: "Problem Details for HTTP APIs". +- [37] 3GPP TR 21.900: "Technical Specification Group working methods". +- [38] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". +- [39] 3GPP TS 23.216: "Single Radio Voice Call Continuity (SRVCC); Stage 2". +- [40] IETF RFC 6901: "JavaScript Object Notation (JSON) Pointer". +- [41] 3GPP TS 29.274: "3GPP Evolved Packet System (EPS); Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C); Stage 3". +- [42] 3GPP TS 23.273: "5G System (5GS) Location Services (LCS); Stage 2". +- [43] 3GPP TS 24.080: "Mobile radio interface layer 3 supplementary services specification; Formats and coding". +- [44] 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS)". +- [45] 3GPP TS 24.011: "Point-to-Point (PP) Short Message Service (SMS) support on mobile radio interface". +- [46] 3GPP TS 29.515: "5G System; Gateway Mobile Location Services Stage 3". +- [47] 3GPP TS 23.287: "Architecture enhancements for 5G System (5GS) to support Vehicle-to-Everything (V2X) services". +- [48] 3GPP TS 23.316: "Wireless and wireline convergence access support for the 5G System (5GS)". +- [49] 3GPP TS 33.401: "3GPP System Architecture Evolution (SAE); Security architecture". +- [50] 3GPP TS 29.010: "Information element mapping between Mobile Station - Base Station System (MS - BSS) and Base Station System - Mobile-services Switching Centre (BSS - MSC); Signalling Procedures and the Mobile Application Part (MAP)". +- [51] 3GPP TS 23.304: "Proximity based Services (ProSe) in the 5G System (5GS)". + +- [52] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". +- [53] 3GPP TS 24.587: "Vehicle-to-Everything (V2X) services in 5G System (5GS); Stage 3". +- [54] 3GPP TS 24.554: " Proximity-services (ProSe) in 5G System (5GS) protocol aspects; Stage 3". +- [55] 3GPP TS 23.247: "Architectural enhancements for 5G multicast-broadcast services". +- [56] 3GPP TS 23.256: "Support of Uncrewed Aerial Systems (UAS) connectivity, identification and tracking; Stage 2". +- [57] 3GPP TS 33.256: "Security aspects of Uncrewed Aerial Systems (UAS)". +- [58] 3GPP TS 23.548: "5G System Enhancements for Edge Computing; Stage 2". +- [59] 3GPP TS 23.586: "Architectural Enhancements to support Ranging based services and Sidelink Positioning". +- [60] 3GPP TS 24.577: "Aircraft-to-Everything (A2X) services in 5G system (5GS); Protocol aspects; Stage 3". + +--- + +## 3 Definitions and abbreviations + +### 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +**example:** text used to clarify abstract rules by applying them literally. + +### 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|---------|-----------------------------------------| +| 5GC | 5G Core Network | +| 5GS | 5G System | +| 5G-AN | 5G Access Network | +| 5G-GUTI | 5G Globally Unique Temporary Identifier | +| 5QI | 5G QoS Identifier | +| AMF | Access and Mobility Management Function | +| ASTI | Access Stratum TTime | +| DAPS | Dual Active Protocol Stacks | +| DCCF | Data Collection Coordination Function | +| EBI | EPS Bearer Identity | +| GAD | Universal Geographical Area Description | +| GPSI | Generic Public Subscription Identifier | +| GUAMI | Globally Unique AMF Identifier | +| JSON | JavaScript Object Notation | +| LADN | Local Area Data Network | +| LDR | Location Deferred Request | +| LIR | Location Immediate Request | +| LMF | Location Management Function | + +| | | +|---------|----------------------------------------------------------------| +| LPHAP | Low Power and High Accuracy Positioning | +| MA | Multi-Access | +| MBS | Multicast/Broadcast Service | +| MB-SMF | Multicast/Broadcast Session Management Function | +| MM | Mobility Management | +| N3IWF | Non-3GPP InterWorking Function | +| NEF | Network Exposure Function | +| NR | New Radio | +| NRF | Network Repository Function | +| NRPPa | NR Positioning Protocol A | +| NSI ID | Network Slice Instance Identifier | +| NSSAI | Network Slice Selection Assistance Information | +| NSSAA | Network Slice-Specific Authentication and Authorization | +| NWDAF | Network Data Analytics Function | +| PCF | Policy Control Function | +| PEI | Permanent Equipment Identifier | +| PRU | Positioning Reference Unit | +| RAT | Radio Access Type | +| RFSP | RAT/Frequency Selection Priority | +| SARI | Service Area Restriction Information | +| SBI | Service Based Interface | +| SM | Session Management | +| SMF | Session Management Function | +| SMSF | Short Message Service Function | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| SUCI | Subscription Concealed Identifier | +| SUPI | Subscription Permanent Identifier | +| TA | Tracking Area | +| TAI | Tracking Area Identity | +| TNAP | Trusted Non-3GPP Access Point | +| TSCTSF | Time Sensitive Communication and Time Synchronization Function | +| TWAP | Trusted WLAN Access Point | +| UDM | Unified Data Management | +| UDSF | Unstructured Data Storage Function | + +--- + +## 4 Overview + +### 4.1 Introduction + +Within the 5GC, the AMF offers services to the SMF, other AMF, PCF, SMSF, LMF, GMLC, CBCF, PWS-IWF, NWDAF, DCCF, NEF, TSCTSF and MB-SMF via the Namf service based interface (see 3GPP TS 23.501 [2], 3GPP TS 23.502 [3], 3GPP TS 23.041 [20], 3GPP TS 23.288 [38] and 3GPP TS 23.247 [55]). + +Figure 4.1-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the AMF and the scope of the present specification. + +![Reference model diagram showing the AMF connected to various network functions via Nn interfaces.](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +The diagram illustrates the reference model for the AMF (Access and Management Function). A central AMF block is connected to various network functions (NFs) through interfaces labeled Nn. The NFs and their connections are as follows: + +- Top row:** AMF, NEF, NWDAF, TSCTSF. Connections: AMF to AMF (N14), NEF to AMF (N51), NWDAF to AMF (N11), TSCTSF to AMF (N89). +- Left column:** SMF, PCF, UDM, SMSF, LMF, GMLC, CBCF. Connections: SMF to AMF (N15), PCF to AMF (N11), UDM to AMF (N8), SMSF to AMF (N20), LMF to AMF (NLg), GMLC to AMF (N50), CBCF to AMF (N14). +- Bottom row:** PWS-IWF, DCCF, MB-SMF. Connections: PWS-IWF to AMF (N50), DCCF to AMF (N11mb), MB-SMF to AMF (N11). + +The central AMF block is labeled with 'Namf' on its left side, indicating the service interface. + +Reference model diagram showing the AMF connected to various network functions via Nn interfaces. + +Figure 4.1-1: Reference model – AMF + +The functionalities supported by the AMF are listed in clause 6.2.1 of 3GPP TS 23.501 [2]. + +## 5 Services offered by the AMF + +### 5.1 Introduction + +The table 5.1-1 shows the AMF Services and AMF Service Operations: + +**Table 5.1-1 List of AMF Services** + +| Service Name | Service Operations | Operation Semantics | Example Consumer(s) | +|-----------------------|---------------------------------|----------------------------|-----------------------------------------------| +| Namf_Communication | UEContextTransfer | Request/Response | Peer AMF | +| | RegistrationStatusUpdate | Request/Response | Peer AMF | +| | CreateUEContext | Request/Response | Peer AMF | +| | ReleaseUEContext | Request/Response | Peer AMF | +| | RelocateUEContext | Request/Response | Peer AMF | +| | CancelRelocateUEContext | Request/Response | Peer AMF | +| | N1MessageNotify | Subscribe/Notify | Peer AMF, LMF, PCF | +| | N2InfoNotify | | LMF, AMF | +| | N1N2MessageSubscribe | | PCF | +| | N1N2MessageUnSubscribe | | PCF | +| | N1N2MessageTransfer | Request/Response | Peer AMF, SMF, SMSF, LMF, PCF | +| | N1N2TransferFailureNotification | Subscribe/Notify | SMF, SMSF, LMF, PCF | +| | NonUeN2MessageTransfer | Request/Response | Peer AMF, LMF, CBCF, PWS-IWF, TSCTSF | +| | NonUeN2InfoSubscribe | Subscribe/Notify | CBCF, PWS-IWF, TSCTSF | +| | NonUeN2InfoUnSubscribe | | CBCF, PWS-IWF, TSCTSF | +| | NonUeN2InfoNotify | | LMF, CBCF, PWS-IWF, TSCTSF | +| | EBIAssignment | Request/Response | SMF | +| | AMFStatusChangeSubscribe | Subscribe / Notify | SMF, PCF, NEF, SMSF, UDM | +| | AMFStatusChangeUnSubscribe | Subscribe / Notify | SMF, PCF, NEF, SMSF, UDM | +| | AMFStatusChangeNotify | Subscribe / Notify | SMF, PCF, NEF, SMSF, UDM | +| Namf_EventExposure | Subscribe (see NOTE) | Subscribe/Notify | NEF, SMF, UDM, NWDAF, LMF, GMLC, DCCF, TSCTSF | +| | Unsubscribe (see NOTE) | Subscribe/Notify | NEF, SMF, UDM, NWDAF, LMF, GMLC, DCCF, TSCTSF | +| | Notify | Subscribe/Notify | NEF, SMF, UDM, NWDAF, LMF, GMLC, DCCF, TSCTSF | +| Namf_MT | EnableUEReachability | Request/Response | SMSF, SMF | +| | ProvideDomainSelectionInfo | Request/Response | UDM | +| | EnableGroupReachability | Request/Response | SMF | +| | UEReachabilityInfoNotify | Subscribe/Notify | SMF | +| Namf_Location | ProvidePositioningInfo | Request/Response | GMLC | +| | EventNotify | Subscribe / Notify | GMLC | +| | ProvideLocationInfo | Request/Response | UDM | +| | CancelLocation | Request/Response | GMLC | +| Namf_MBSBroadcast | ContextCreate | Request/Response | MB-SMF | +| | ContextUpdate | Request/Response | MB-SMF | +| | ContextRelease | Request/Response | MB-SMF | +| | ContextStatusNotify | Subscribe / Notify | MB-SMF | +| Namf_MBSCommunication | N2MessageTransfer | Request/Response | MB-SMF | +| | Notify | Subscribe/Notify | MB-SMF | + +NOTE: A subscription applies for one UE, group of UE(s) or any UE. + +Table 5.1-2 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-2: API Descriptions** + +| Service Name | Claus
e | Description | OpenAPI Specification File | apiNam
e | Anne
x | +|-----------------------|--------------------|-------------------------------|------------------------------------|---------------------|-------------------| +| Namf_Communication | 6.1 | AMF Communication Service | TS29518_Namf_Communication.yaml | namf-comm | A.2 | +| Namf_EventExposure | 6.2 | AMF Event Exposure Service | TS29518_Namf_EventExposure.yaml | namf-evts | A.3 | +| Namf_MT | 6.3 | AMF Mobile Terminated Service | TS29518_Namf_MT.yaml | namf-mt | A.4 | +| Namf_Location | 6.4 | AMF Location Service | TS29518_Namf_Location.yaml | namf-loc | A.5 | +| Namf_MBSBroadcast | 6.5 | AMF MBS Broadcast Service | TS29518_Namf_MBSBroadcast.yaml | namf-mbs-bc | A.6 | +| Namf_MBSCommunication | 6.6 | AMF MBS Communication Service | TS29518_Namf_MBSCommunication.yaml | namf-mbs-com | A.7 | + +## 5.2 Namf\_Communication Service + +### 5.2.1 Service Description + +This service enables an NF to communicate with the UE through N1 NAS messages or with the AN (both UE and non UE specific). The service operations defined below allow the NF to communicate with the UE and the AN. The following are the key functionalities of this NF service. + +- Provide service operations for transporting N1 messages to the UE; +- Allow NFs to subscribe and unsubscribe for notifications of specific N1 messages from the UE; +- Allow NFs to subscribe and unsubscribe for notifications about specific information from AN; +- Provide service operations for initiating N2 messages towards the AN; +- Security Context Management; and +- UE information management and transfer (including its security context). + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +The Namf\_Communication service supports following service operations: + +- UEContextTransfer +- RegistrationStatusUpdate +- N1N2MessageTransfer (UE Specific) +- N1N2TransferFailureNotification (UE Specific) +- N1N2MessageSubscribe (UE Specific) +- N1N2MessageUnsubscribe (UE Specific) + +- N1MessageNotify (UE Specific) +- N2InfoNotify (UE Specific) +- NonUeN2MessageTransfer +- NonUeN2InfoSubscribe +- NonUeN2InfoUnsubscribe +- NonUeN2InfoNotify +- EBIAssignment +- CreateUEContext +- ReleaseUEContext +- RelocateUEContext +- CancelRelocateUEContext +- AMFStatusChangeSubscribe +- AMFStatusChangeUnsubscribe +- AMFStatusChangeNotify + +## 5.2.2.2 UE Context Operations + +### 5.2.2.2.1 UEContextTransfer + +#### 5.2.2.2.1.1 General + +The UEContextTransfer service operation is used during the following procedure: + +- General Registration procedure (see 3GPP TS 23.502 [3], clause 4.2.2.2.2) +- Registration with Onboarding SNPN (see 3GPP TS 23.502 [3], clause 4.2.2.2.4) + +The UEContextTransfer service operation is invoked by a NF Service Consumer, e.g. a target AMF, towards the AMF (acting as source AMF), when the target AMF receives a Registration Request with the UE's 5G-GUTI included and the serving AMF has changed since last registration, to retrieve the UE Context, e.g. the UE's SUPI and MM Context, in the source AMF. + +The NF Service Consumer (e.g. the target AMF) shall retrieve the UE Context by invoking the "transfer" custom method on the URI of an "Individual ueContext" resource identified by UE's 5G-GUTI, see clause 6.1.3.2.4. See also Figure 5.2.2.2.1.1-1. + +![Sequence diagram for UE Context Transfer between NF Service Consumer and AMF.](a3953dce8dbd7ef15d61a314dbef2cf9_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note right of NF Service Consumer: POST « ue-contexts/{ueContextId}/transfer (UeContextTransferReqData) » + NF Service Consumer->>AMF: Request + Note left of AMF: -2a. 200 OK (UeContextTransferRspData) + AMF-->>NF Service Consumer: Response 2a + Note left of AMF: -2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: Response 2b + +``` + +The diagram illustrates the interaction between an NF Service Consumer and an AMF. The NF Service Consumer sends a POST request to the AMF using the URI « ue-contexts/{ueContextId}/transfer » with data of type UeContextTransferReqData. The AMF responds with either a 200 OK (UeContextTransferRspData) or an error status (4xx/5xx ProblemDetails or 3xx). + +Sequence diagram for UE Context Transfer between NF Service Consumer and AMF. + +**Figure 5.2.2.2.1.1-1 UE Context Transfer** + +1. The NF Service Consumer, e.g. target AMF, shall send a HTTP POST request to invoke "transfer" custom method on an "Individual ueContext" resource URI. The content of the request shall be an object of "UeContextTransferReqData" data type. + +If UE Context Transfer is triggered by UE initial registration, mobility registration, disaster roaming initial registration or disaster roaming mobility registration, the NF Service Consumer, e.g. target AMF, shall set the + +reason attribute to "INIT\_REG" or "MOBI\_REG" and include the integrity protected registration request message which triggers the UE context transfer in the content. + +2a. On success: + +- if the reason attribute is "INIT\_REG" and integrity check is successful, the (source) AMF shall respond with the status code "200 OK". The content of the response shall be an object of "UeContextTransferRspData" data type, containing: + - case a) the representation of the requested UE Context as follows: + - without PDU Session Contexts associated to the access type indicated in the request by the NF Service Consumer (e.g. target AMF); and + - with PDU Session Contexts associated to the other access type, if the UE is registered for the other access type in the (source) AMF, unless the source AMF determines based on the PLMN ID or SNPN ID of the (target) AMF that there is no possibility for relocating the N2 interface for non-3GPP access to the (target) AMF; + - or + - case b) the representation of the requested UE Context only containing the "supi" attribute, if the UE is registered in a different access type in the (source) AMF and the source AMF determines based on the PLMN ID of the (target) AMF that there is no possibility for relocating the N2 interface to the (target) AMF. + - If the reason attribute is "MOBI\_REG" and integrity check is successful, the (source) AMF shall respond with the status code "200 OK". The content of the response shall be an object of "UeContextTransferRspData" data type, containing: + - a) the representation of the complete UE Context including available MM and PDU Session Contexts. The source AMF shall transfer the complete UE context including both access types if the UE is registered for both 3GPP and non-3GPP accesses and if the target PLMN is the same as the source PLMN; or + - b) the representation of the requested UE Context including the available MM and PDU Session Contexts for the 3GPP access type, if the UE is registered for both 3GPP and non-3GPP accesses in the (source) AMF and the source AMF determines based on the PLMN ID or SNPN ID of the (target) AMF that there is no possibility for relocating the N2 interface for non-3GPP access to the (target) AMF. +- NOTE: The source AMF can determine that it is not possible to relocate the N2 interface to the target AMF when both AMFs pertain to different PLMNs or SNPNs. + +The UE context shall contain trace control and configuration parameters, if signalling based trace has been activated (see 3GPP TS 32.422 [30]). + +The NF Service Consumer, e.g. target AMF, starts tracing according to the received trace control and configuration parameters, if trace data is received in the UE context indicating that signalling based trace has been activated. Once the NF Service Consumer receives subscription data, trace requirements received from the UDM supersedes the trace requirements received from the AMF. + +The UE context shall contain analytics subscription parameters, if the (source) AMF has created analytics subscription(s) towards NWDAF related to the UE (see clause 5.2.2.2.2 of 3GPP TS 23.502 [3]). The NF Service Consumer, e.g. target AMF, may take over the analytics subscription(s). + +The UE context shall contain event subscriptions information in the following cases: + +- a) Any NF Service Consumer has subscribed for UE specific event; and/or +- b) Any NF Service Consumer has subscribed for UE group specific events to which the UE belongs. In this case the event subscriptions provided in the UE context shall contain the event details applicable to this specific UE in the group (e.g maxReports in options IE). + +The NF Service Consumer, e.g. target AMF, shall: + +- in case a) create event subscriptions for the UE specific events; +- in case b) create event subscriptions for the group Id if there are no existing event subscriptions for that group Id, subscription change notification URI (subsChangeNotifyUri) and the subscription change notification correlation Id (subsChangeNotifyCorrelationId). If there is already an existing event subscription for the group Id, and for the given subscription change notification URI (subsChangeNotifyUri) and subscription change notification correlation Id (subsChangeNotifyCorrelationId), then an event subscription shall not be created at the NF Service Consumer. The individual UE specific event details (e.g maxReports in options IE) within that group shall be taken into account. +- for both the cases, for each created event subscription, allocate a new subscription Id, if necessary (see clause 6.5.2 of 3GPP TS 29.500 [4]), and if allocated, send the new subscription Id to the notification endpoint for informing the subscription Id creation, along with the notification correlation Id for the + +subscription Id change. If the UEContextTransfer service operation is performed towards the old AMF as part of the EPS to 5GS mobility registration procedure using N26 interface (see clause 4.11.1.3.3 of 3GPP TS 23.502 [3]), the target AMF may also initiate event subscription synchronization procedure with UDM, as specified in clause 5.3.2.4.2, when both the target AMF and the UDM support the "ESSYNC" feature. + +NOTE: Subscription Id can be reused if the mobility is between AMFs of same AMF Set. + +If the UE context being transferred from the source AMF is the last UE context that belongs to a UE group Id related subscription, then the source AMF shall not delete the UE group Id related subscription until the expiry of that event subscription (see clause 5.3.2.2.2). + +The target AMF may authorize the event subscriptions transferred from the source AMF as specified in clause 13.4.1.4 of 3GPP TS 33.501 [27]. Based on local policy, the target AMF may consider that transferred subscriptions containing no or an invalid access token are not authorized. Transferred subscriptions that are not authorized by the target AMF shall not be regarded active; if the target AMF supports the STEN (Subscription Termination Event Notification) feature, and if the notification of event subscription termination was requested by the NF service consumer, the target AMF shall send a notification to the NF service consumer to report the termination of the subscription with the subscription termination cause "SUBSCRIPTION\_NOT\_AUTHORIZED". + +The source AMF shall not transfer those PDU sessions which are not supported by the target AMF, e.g. the MA-PDU sessions shall not be transferred if the target AMF does not support ATSSS. + +The UE context shall contain SNPN Onboarding indication, if the UE is registered for onboarding in an SNPN as described in clause 4.2.2.2.4 of 3GPP TS 23.502 [3]. The NF Service Consumer, i.e. target AMF, may start an implementation specific timer to deregister the onboarding registered UE, i.e. if the received UE context contains SNPN Onboarding indication.2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.4.4.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.2.4.4.2-2. + +#### 5.2.2.2.1.2 Retrieve UE Context after successful UE authentication + +When a successful UE authentication has been performed after a previous integrity check failure, the NF service consumer (e.g. the target AMF) shall retrieve the UE context by invoking "transfer" service operation on the URI of the "Individual ueContext" resource identified by UE's SUPI. The same requirements in clause 5.2.2.2.1.1 shall be applied with following modifications: + +1. Same as step 1 of figure 5.2.2.2.1.1-1, with following differences: + - The {ueContextId} in the URI shall be composed using UE's SUPI, and + - The "reason" attribute in request body shall be set to "MOBI\_REG\_UE\_VALIDATED", and + - The request body shall not include registration request message from UE. +2. Same as step 2a of figure 5.2.2.2.1.1-1, with following differences: + - The (source) AMF shall skip integrity check and shall respond with the status code "200 OK "with the UE Context excluding SeafData and including available PDU Session Contexts + +#### 5.2.2.2.2 RegistrationStatusUpdate + +##### 5.2.2.2.2.1 General + +The RegistrationStatusUpdate service operation is used during the following procedure: + +- General Registration procedure (see 3GPP TS 23.502 [3], clause 4.2.2.2.2) +- Registration with AMF re-allocation procedure (see 3GPP TS 23.502 [3], clause 4.2.2.2.3) + +The RegistrationStatusUpdate service operation is invoked by a NF Service Consumer, e.g. the target AMF, towards the NF Service Producer, i.e. the source AMF, to update the status of UE registration at the target AMF, thereby indicating the result of previous UE Context transfer for a given UE (see clause 5.2.2.2.1.1). + +The target AMF shall update the NF Service Producer (i.e. source AMF) with the status of the UE registration at the target AMF due to a previous UE Context transfer. The NF Service Consumer (e.g. target AMF) shall use the HTTP + +method POST to invoke the "transfer-update" custom operation on the URI of an "Individual ueContext" resource, see clause 6.1.3.2.4. See also Figure 5.2.2.2.2.1-1. + +![Sequence diagram showing the Registration Status Update procedure. The NF Service Consumer (e.g. Target AMF) sends a POST request to the Source AMF. The Source AMF responds with either 2a. 200 OK (UeRegStatusUpdateRspData) or 2b. 4xx/5xx (ProblemDetails)Or 3xx.](e90987faabad6a6665cd8ed1151dc474_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer (e.g. Target AMF) + participant Source AMF + Note left of NF Service Consumer: POST « ue-contexts/{ueContextId}/transfer-update (UeRegStatusUpdateReqData) » + NF Service Consumer->>Source AMF: POST request + Note right of Source AMF: 2a. 200 OK (UeRegStatusUpdateRspData) + Source AMF-->>NF Service Consumer: 2a. 200 OK + Note right of Source AMF: 2b. 4xx/5xx (ProblemDetails)Or 3xx + Source AMF-->>NF Service Consumer: 2b. 4xx/5xx + +``` + +Sequence diagram showing the Registration Status Update procedure. The NF Service Consumer (e.g. Target AMF) sends a POST request to the Source AMF. The Source AMF responds with either 2a. 200 OK (UeRegStatusUpdateRspData) or 2b. 4xx/5xx (ProblemDetails)Or 3xx. + +**Figure 5.2.2.2.2.1-1 Registration Status Update** + +1. The NF service consumer (e.g. target AMF), shall send a POST request to invoke the "transfer-update" custom operation on the URI of an "Individual ueContext" resource, to update the source AMF with the status of the UE registration at the target AMF. The UE's 5G-GUTI is included as the UE identity. + +The request content shall include the transferStatus attribute set to "TRANSFERRED" if the UE context transfer was completed successfully (including the case where only the supi was transferred to the target AMF during the UE context transfer procedure) or to "NOT\_TRANSFERRED" otherwise. + +If any network slice(s) become no longer available and there are PDU Session(s) associated with them, the target AMF shall include these PDU session(s) in the toReleaseSessionList attribute in the content. If the continuity of the PDU Session(s) cannot be supported between networks (e.g. SNPN-SNPN mobility, inter-PLMN mobility where no HR agreement exists), the target AMF shall include these PDU session(s) with release cause in the toReleaseSessionInfo attribute in the content. + +If the target AMF selects a new PCF for AM Policy and/or UE policy other than the one which was included in the UeContext by the old AMF, the target AMF shall set pcfReselectedInd to true. + +NOTE: AMF selects the same PCF instance for AM policy and for UE policy, as described in clause 6.3.7.1, 3GPP TS 23.501 [2]. + +The NF service consumer shall include the smfChangeInfoList attribute including the UE's PDU Session ID(s) for which the I-SMF or V-SMF has been changed or removed, if any, with for each such PDU session, the related smfChangeIndication attribute set to "CHANGED" or "REMOVED", if the I-SMF or V-SMF is changed or removed respectively. + +If the target AMF receives analytics subscription parameters from the source AMF, and one or more analytics subscription(s) are not taken over by the target AMF, the target AMF shall include these analytics subscription(s) in the analyticsNotUsedList IE. The source AMF may unsubscribe the analytics subscriptions included in analyticsNotUsedList IE for the UE. + +Once the update is received, the source AMF shall: + +- remove the individual ueContext resource and release any PDU session(s) in the toReleaseSessionList attribute, if the transferStatus attribute included in the POST request body is set to "TRANSFERRED" and if the source AMF transferred the complete UE Context including all MM contexts and PDU Session Contexts. The source AMF may choose to start a timer to supervise the release of the UE context resource and may keep the individual ueContext resource until the timer expires. If the pcfReselectedInd is set to true, the source AMF shall terminate the AM Policy Association and/or the UE Policy Association that the source AMF has to the old PCF. + - keep the UE context only including the MM context and PDU session(s) associated to the non-3GPP access, if the transferStatus attribute included in the POST request body is set to "TRANSFERRED" and if the source AMF did not transfer the MM context and PDU Session Contexts for the non-3GPP access type; the AMF shall release any PDU session(s) in the toReleaseSessionList attribute. The source AMF may choose to start a timer and keep the MM context and PDU session(s) associated to the 3GPP access until the timer expires. + - keep the UE Context as if the context transfer procedure had not happened if the transferStatus attribute included in the POST request body is set to "NOT\_TRANSFERRED". +- 2a. On Success: The source AMF shall respond with the status code "200 OK" if the request is accepted. If the smfChangeInfoList attribute was received in the request, the source AMF shall release the SM context at the I- + +SMF or V-SMF only, for all the PDU sessions listed in the smfChangeInfoList attribute with the smfChangeIndication attribute set to "CHANGED" or "REMOVED". + +If some PDU sessions are not supported by the target AMF and thus not transferred to the target AMF, the source AMF shall release these PDU sessions after this step. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.4.5.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.2.4.5.2-2, where applicable. + +### 5.2.2.2.3 CreateUEContext + +#### 5.2.2.2.3.1 General + +The CreateUEContext service operation is used during the following procedure: + +- Inter NG-RAN node N2 based handover (see 3GPP TS 23.502 [3], clause 4.9.1.3, and clause 4.23.7) + +The CreateUEContext service operation is invoked by a NF Service Consumer, e.g. a source AMF, towards the AMF (acting as target AMF), when the source AMF can't serve the UE and selects the target AMF during the handover procedure, to create the UE Context in the target AMF. + +The NF Service Consumer (e.g. the source AMF) shall create the UE Context by using the HTTP PUT method with the URI of the "Individual UeContext" resource (See clause 6.1.3.2.3.1). See also Figure 5.2.2.2.3.1-1. + +![Sequence diagram showing the Create UE Context procedure. An NF Service Consumer sends a PUT request to an AMF. The AMF responds with either a 201 Created status or a 4xx/5xx error status.](49a49278cad196bdfe0db6b4dd1be7fd_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: 1. PUT .../ue-contexts/{ueContextId}(UeContextCreateData) + NF Service Consumer->>AMF: Request + Note right of AMF: -2a. 201 Created (UeContextCreatedData) + AMF-->>NF Service Consumer: Response 2a + Note right of AMF: -2b. 4xx/5xx (UeContextCreateError) or 3xx + AMF-->>NF Service Consumer: Response 2b + +``` + +Sequence diagram showing the Create UE Context procedure. An NF Service Consumer sends a PUT request to an AMF. The AMF responds with either a 201 Created status or a 4xx/5xx error status. + +Figure 5.2.2.2.3.1-1 Create UE Context + +1. The NF Service Consumer, e.g. source AMF, shall send a PUT request, to create the ueContext in the target AMF. The content of the PUT request shall contain a UeContextCreateData structure, including a N2 Information Notification callback URI. + +The UE context shall contain trace control and configuration parameters, if signalling based trace has been activated (see 3GPP TS 32.422 [30]). + +The source AMF shall transfer the complete UE context including both access types if the UE is registered for both 3GPP and non-3GPP accesses and if the target PLMN is the same as the source PLMN. + +The source AMF shall transfer only UE context for 3GPP access if the source AMF determines there is no possibility for relocating the N2 interface for non-3GPP access to the (target) AMF, e.g. when the target AMF is in another PLMN. + +For a UE supporting 5G-SRVCC, the NF Service Consumer (i.e. AMF) shall include the Mobile Station Classmark 2, STN-SR, C-MSISDN and Supported Codec List in the request, if available, as specified in 3GPP TS 23.502 [3]. + +The UE context shall contain analytics subscription parameters, if the (source) AMF has created analytics subscription(s) towards NWDAF related to the UE (see clause 5.2.2.2.11 of 3GPP TS 23.502 [3]). The NF service producer, e.g. target AMF, may take over the analytics subscription(s). + +The UE context shall contain SNPN Onboarding indication and the target AMF shall support SNPN Onboarding, if the UE is registered for onboarding in an SNPN as described in clause 4.2.2.2.4 of 3GPP TS 23.502 [3]. + +- 2a. On success, the target AMF shall respond with the status code "201 Created" if the request is accepted, together with a HTTP Location header to provide the location of a newly created resource. The content of the PUT + +response shall contain the representation of the created UE Context. If the target AMF selects a new PCF for AM Policy other than the one which was included in the UeContext by the old AMF, the target AMF shall set pcfReselectedInd to true. If the pcfReselectedInd is set to true, the source AMF shall terminate the AM Policy Association to the old PCF. + +The target AMF starts tracing according to the received trace control and configuration parameters, if trace data is received in the UE context indicating that signalling based trace has been activated. Once the AMF receives subscription data, trace requirements received from the UDM supersedes the trace requirements received from the NF Service Consumer. + +If the target AMF receives analytics subscription parameters from the source AMF, and one or more analytics subscription(s) are not taken over by the target AMF, the target AMF shall include these analytics subscription(s) in the analyticsNotUsedList IE. The source AMF may unsubscribe the analytics subscriptions included in analyticsNotUsedList IE for the UE. + +The UE context shall contain event subscriptions information in the following cases: + +- a) Any NF Service Consumer has subscribed for UE specific event; and/or +- b) Any NF Service Consumer has subscribed for UE group specific events to which the UE belongs. In this case the event subscriptions provided in the UE context shall contain the event details applicable to this specific UE in the group (e.g maxReports in options IE). + +The target AMF shall: + +- in case a) create event subscriptions for the UE specific events; +- in case b) create event subscriptions for the group Id if there are no existing event subscriptions for that group Id, subscription change notification URI (subsChangeNotifyUri) and the subscription change notification correlation Id (subsChangeNotifyCorrelationId). If there is already an existing event subscription for the group Id and for the given subscription change notification URI (subsChangeNotifyUri) and subscription Id change notification correlation Id (subsChangeNotifyCorrelationId), then an event subscription shall not be created at the target AMF. The individual UE specific event details (e.g maxReports in options IE) within that group shall be taken into account. +- for both the cases, for each created event subscription, allocate a new subscription Id, if necessary (see clause 6.5.2 of 3GPP TS 29.500 [4]), and if allocated send the new subscription Id to the notification endpoint for informing the subscription Id creation, along with the notification correlation Id for the subscription Id change. + +NOTE: Subscription Id can be reused if the mobility is between AMFs of same AMF Set. + +If the UE context being transferred from the NF service consumer (e.g. source AMF) is the last UE context that belongs to a UE group Id related subscription, then the NF service consumer (e.g. source AMF) shall not delete the UE group Id related subscription until the expiry of that event subscription (see clause 5.3.2.2.2). + +The target AMF may authorize the event subscriptions transferred from the source AMF as specified in clause 13.4.1.4 of 3GPP TS 33.501 [27]. Based on local policy, the target AMF may consider that transferred subscriptions containing no or an invalid access token are not authorized. Transferred subscriptions that are not authorized by the target AMF shall not be regarded active; if the target AMF supports the STEN (Subscription Termination Event Notification) feature, and if the notification of event subscription termination was requested by the NF service consumer, the target AMF shall send a notification to the NF service consumer to report the termination of the subscription with the subscription termination cause "SUBSCRIPTION\_NOT\_AUTHORIZED". + +If the target AMF receives SNPN Onboarding indication from the source AMF, the target AMF may start an implementation specific timer to deregister the onboarding registered UE, i.e. if the received UE context contains SNPN Onboarding indication. + +The source AMF shall: release those PDU sessions not supported by the target AMF and thus not transferred to the target AMF. + +2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body shall contain a UeContextCreateError structure, including: + +- a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.2.3.1-3. The cause in the error attribute shall be set to HANDOVER\_FAILURE, if all of the PDU sessions are failed, e.g. no response from the SMF within a maximum wait timer; +- NgAPCause, if available; +- N2 information carrying the Target to Source Failure Transparent Container, if this information has been received from the target NG-RAN and if the source AMF supports the NPN feature. + +### 5.2.2.2.3.2 Create UE Context with AMF Relocation + +During inter-PLMN N2 Handover, the initial AMF may relocate the UE context to a target AMF (e.g. due to slices cannot be served by initial AMF). This clause describes the procedure for this scenario. + +The NF Service Consumer (e.g. the source AMF) shall create the UE Context by using the HTTP PUT method with the URI of the "Individual UeContext" resource (See clause 6.1.3.2.3.1). See also Figure 5.2.2.2.3.2-1. + +![Sequence diagram for Create UE Context with AMF Relocation. The diagram shows three lifelines: NF Service Consumer, Initial AMF, and Target AMF. Step 1: NF Service Consumer sends a PUT request to Initial AMF. Step 2: Initial AMF performs a 'Create UE Context Procedure' with Target AMF. Step 3a: Initial AMF sends a 201 Created response to NF Service Consumer. Step 3b: Initial AMF sends an error response (4xx/5xx or 3xx) to NF Service Consumer.](6470d350326789d5306eabcb76533951_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant Initial AMF + participant Target AMF + Note right of Initial AMF: 2. Create UE Context Procedure + NF Service Consumer->>Initial AMF: 1. PUT « ue-contexts/{ueContextId}(UeContextCreateData) » + Initial AMF-->>NF Service Consumer: 3a. 201 Created (UeContextCreatedData) + Initial AMF-->>NF Service Consumer: 3b. 4xx/5xx (UeContextCreateError) or 3xx + +``` + +Sequence diagram for Create UE Context with AMF Relocation. The diagram shows three lifelines: NF Service Consumer, Initial AMF, and Target AMF. Step 1: NF Service Consumer sends a PUT request to Initial AMF. Step 2: Initial AMF performs a 'Create UE Context Procedure' with Target AMF. Step 3a: Initial AMF sends a 201 Created response to NF Service Consumer. Step 3b: Initial AMF sends an error response (4xx/5xx or 3xx) to NF Service Consumer. + +**Figure 5.2.2.2.3.2-1 Create UE Context with AMF Relocation** + +Same requirement of clause 5.2.2.2.3.1 applies, with following modifications: + +1. Same as step 1 of clause 5.2.2.2.3.1. +2. The initial AMF selects a target AMF and perform CreateUeContext procedure (see clause 5.2.2.2.3.1). + - the request body shall include the information received from the source AMF in step 1, including the serving network, the supported features, etc. + - if the received serving network (from the source AMF) is different from the PLMN of the target AMF, the resource URI in the Location header in 201 Create response shall contain the inter-PLMN API Root. +- 3a. Same as step 2a of clause 5.2.2.2.3.1, with following modifications: + - the request body shall contain the UE Context and other information received from the target AMF in step 2. + - the Location header shall contain the resource URI received in the "201 Created" response from target AMF in step 2. + - the initial AMF shall insert a 3gpp-Sbi-Producer-Id header indicating the target AMF. +- 3b. Same as step 2b of clause 5.2.2.2.3.1. + +### 5.2.2.2.4 ReleaseUEContext + +#### 5.2.2.2.4.1 General + +The ReleaseUEContext service operation is used during the following procedure: + +- Inter NG-RAN node N2 based handover, Cancel procedure (see 3GPP TS 23.502 [3], clause 4.9.1.4) + +The ReleaseUEContext service operation is invoked by a NF Service Consumer, e.g. a source AMF, towards the AMF (acting as target AMF), when the source AMF receives the Handover Cancel from the 5G-AN during the handover procedure, to release the UE Context in the target AMF. + +The NF Service Consumer (e.g. the source AMF) shall release the UE Context by using the HTTP "release" custom operation with the URI of the "Individual UeContext" resource (See clause 6.1.3.2.4.2). See also Figure 5.2.2.2.4.1-1. + +![Sequence diagram for Figure 5.2.2.4.1-1 Release UE Context. It shows an NF Service Consumer sending a POST request to an AMF. The AMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code.](00504fc688ebcf131ccbeff94dfc9939_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note right of NF Service Consumer: 1. POST « /ue-contexts/{ueContextId}/release(UEContextRelease) » + NF Service Consumer->>AMF: Request + Note left of AMF: 2a. 204 No Content + AMF-->>NF Service Consumer: Success Response + Note left of AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: Error/Redirect Response + +``` + +Sequence diagram for Figure 5.2.2.4.1-1 Release UE Context. It shows an NF Service Consumer sending a POST request to an AMF. The AMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code. + +**Figure 5.2.2.4.1-1 Release UE Context** + +1. The NF Service Consumer, e.g. source AMF, shall send a POST request, to release the ueContext in the target AMF. The content of the POST request shall contain the UEContextRelease. +- 2a. On success, the target AMF shall return "204 No Content" with an empty content in the POST response. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.2.4.2.2-2. + +**5.2.2.2.5 RelocateUEContext** + +**5.2.2.2.5.1 General** + +The RelocateUEContext service operation is used during the following procedure: + +- EPS to 5GS handover using N26 interface with AMF re-allocation (see 3GPP TS 23.502 [3], clause 4.11.1.2.2). + +The RelocateUEContext service operation is invoked by a NF Service Consumer, e.g. an initial AMF, towards the AMF (acting as target AMF), during an EPS to 5GS handover with AMF re-allocation, to relocate the UE Context in the target AMF. + +The NF Service Consumer (e.g. the initial AMF) shall relocate the UE Context in the target AMF by invoking the "relocate" custom method on the URI of an "Individual ueContext" resource (see clause 6.1.3.2.4). See also Figure 5.2.2.2.5.1-1. + +![Sequence diagram for Figure 5.2.2.2.5.1-1 Relocate UE Context. It shows an NF Service Consumer sending a POST request to an AMF. The AMF responds with two dashed return arrows, representing the successful relocation of the UE context.](dfa6249d64e9f63db89f2c5b7bbd01de_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note right of NF Service Consumer: POST request to relocate UE context + NF Service Consumer->>AMF: Request + Note left of AMF: Success + AMF-->>NF Service Consumer: Response + Note left of AMF: Success + AMF-->>NF Service Consumer: Response + +``` + +Sequence diagram for Figure 5.2.2.2.5.1-1 Relocate UE Context. It shows an NF Service Consumer sending a POST request to an AMF. The AMF responds with two dashed return arrows, representing the successful relocation of the UE context. + +**Figure 5.2.2.2.5.1-1 Relocate UE Context** + +1. The NF Service Consumer, e.g. initial AMF, shall send a POST request to relocate the UE context in the target AMF. The content of the POST request shall contain a UeContextRelocateData structure. + +The UE context shall contain trace control and configuration parameters, if signalling based trace has been activated (see 3GPP TS 32.422 [30]). + +For an EPS to 5GS handover procedure, the NF Service Consumer shall carry per PDU session the S-NSSAI for serving PLMN, the MME Control Plane Address and the TEID in the request. If S-NSSAI for interworking is configured and used in initial AMF for the PDU session, the initial AMF shall also carry the configured S-NSSAI for interworking to the target AMF, as specified in clause 4.11.1.2.2 of 3GPP TS 23.502 [3]. In Home Routed roaming case, the S-NSSAI for serving PLMN is derived by the initial AMF based on the S-NSSAI for home PLMN retrieved from SMF+PGW-C, as specified in 3GPP TS 23.502 [3]. + +- 2a. On success, the target AMF shall respond with the status code "201 Created" if the request is accepted, together with a HTTP Location header to provide the location of the newly created resource. The content of the POST response shall contain the representation of the created UE Context. + +The target AMF starts tracing according to the received trace control and configuration parameters, if trace data is received in the UE context indicating that signalling based trace has been activated. Once the AMF receives subscription data, trace requirements received from the UDM supersedes the trace requirements received from the NF Service Consumer. + +- 2b. On failure to relocate the UE context or redirection, one of the HTTP status code listed in Table 6.1.3.2.4.6.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.2.4.6.2-2. + +If the target RAN rejects the Handover Request, the target AMF shall send Forward Relocation Response message directly to the source MME over the N26 interface, carrying the appropriate cause value. + +#### 5.2.2.2.6 CancelRelocateUEContext + +##### 5.2.2.2.6.1 General + +The CancelRelocateUEContext service operation is used during the following procedure: + +- EPS to 5GS Handover with AMF re-allocation, Handover Cancel procedure (see 3GPP TS 23.502 [3], clause 4.11.1.2.3) + +The CancelRelocateUEContext service operation is invoked by a NF Service Consumer (i.e. initial AMF), towards the AMF (acting as target AMF), when the initial AMF receives Forward Cancel Request from the source MME during EPS to 5GS Handover with AMF re-allocation procedure, to trigger the target AMF to release the UE Context. + +The NF Service Consumer (i.e. the initial AMF) shall cancel the UE Context Relocation by using the HTTP "cancel-relocate" custom operation with the URI of the "Individual UeContext" resource (See clause 6.1.3.2.4.2). See also Figure 5.2.2.2.6.1-1. + +![Sequence diagram for Cancel Relocate UE Context. It shows two vertical dashed lines representing lifelines. A solid horizontal arrow points from the left lifeline to the right lifeline. Below it, a dashed horizontal arrow points from the right lifeline back to the left lifeline. At the bottom, another dashed horizontal arrow points from the right lifeline back to the left lifeline. There are rectangular boxes at the top of each lifeline and small rectangular boxes on the return arrows.](0977b81510f7649846289ee785d20e74_img.jpg) + +Sequence diagram for Cancel Relocate UE Context. It shows two vertical dashed lines representing lifelines. A solid horizontal arrow points from the left lifeline to the right lifeline. Below it, a dashed horizontal arrow points from the right lifeline back to the left lifeline. At the bottom, another dashed horizontal arrow points from the right lifeline back to the left lifeline. There are rectangular boxes at the top of each lifeline and small rectangular boxes on the return arrows. + +**Figure 5.2.2.2.6.1-1 Cancel Relocate UE Context** + +1. The NF Service Consumer, i.e. initial AMF, shall send a POST request, to release the ueContext in the target AMF. The content of the POST request shall contain the UeContextCancelRelocateData that needs to be passed to the target AMF. +- 2a. On success, the target AMF shall return "204 No Content" with an empty content in the POST response. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.4.7.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.2.4.7.2-2. + +### 5.2.2.3 UE Specific N1N2 Message Operations + +#### 5.2.2.3.1 N1N2MessageTransfer + +##### 5.2.2.3.1.1 General + +The N1N2MessageTransfer service operation is used by a NF Service Consumer to transfer N1 and/or N2 information to the UE and/or 5G-AN through the AMF in the following procedures: + +- Network triggered Service Request (see clause 4.2.3.3 of 3GPP TS 23.502 [3]) +- PDU Session establishment (see clause 4.3.2 of 3GPP TS 23.502 [3]) +- PDU Session modification (see clause 4.3.3 of 3GPP TS 23.502 [3]) +- PDU Session release (see clause 4.3.4 of TS 3GPP 23.502 [3]) +- Session continuity, service continuity and UP path management (see clause 4.3.5 of 3GPP TS 23.502 [3]) +- Inter NG-RAN node N2 based handover (see clause 4.9.1.3 of 3GPP TS 23.502 [3]) +- SMS over NAS procedures (see clause 4.13.3 of 3GPP TS 23.502 [3]) +- UE assisted and UE based positioning procedure (see clause 6.11.1 of 3GPP TS 23.273 [42]) +- Network assisted positioning procedure (see clause 6.11.2 of 3GPP TS 23.273 [42]) +- LCS Event Report, Event Reporting in RRC INACTIVE state procedures, LCS Cancel Location and LCS Periodic-Triggered Invoke procedures (see clause 6.3, clause 6.7 and clause 6.20.3 of 3GPP TS 23.273 [42]) +- UE configuration update procedure for transparent UE policy delivery (see clause 4.2.4.3 of 3GPP TS 23.502 [3]) +- UPF anchored Mobile Terminated Data Transport in Control Plane CIoT 5GS Optimisation (see clause 4.24.2 of 3GPP TS 23.502 [3]) +- NEF Anchored Mobile Terminated Data Transport (see clause 4.25.5 of 3GPP TS 23.502 [3]) +- System interworking procedures with EPC (see clause 4.3 in 3GPP TS 23.501 [2] and clause 4.11 in 3GPP TS 23.502 [3]) +- SMF triggered N3 data transfer establishment procedure (see clause 4.2.10.2 of 3GPP TS 23.502 [3]) +- 5G-RG requested PDU Session Establishment via W-5GAN (see clause 7.3.1 of 3GPP TS 23.316 [48]) +- 5G-RG or Network requested PDU Session Modification via W-5GAN (see clause 7.3.2 of 3GPP TS 23.316 [48]) +- 5G-RG or Network requested PDU Session Release via W-5GAN (see clause 7.3.3 of 3GPP TS 23.316 [48]) +- FN-RG related PDU Session Establishment via W-5GAN (see clause 7.3.4 of 3GPP TS 23.316 [48]) +- CN-initiated selective deactivation of UP connection of an existing PDU Session associated with W-5GAN Access (see clause 7.3.5 of 3GPP TS 23.316 [48]) +- FN-RG or Network Requested PDU Session Modification via W-5GAN (see clause 7.3.6 of 3GPP TS 23.316 [48]) +- FN-RG or Network Requested PDU Session Release via W-5GAN (see clause 7.3.7 of 3GPP TS 23.316 [48]) +- Non-5G capable device behind 5G-CRG and FN-CRG requested PDU Session Establishment via W-5GAN (see clause 4.10a of 3GPP TS 23.316 [48]) +- Non-5G capable device behind 5G-CRG and FN-CRG or Network Requested PDU Session Modification via W-5GAN (see clause 4.10a of 3GPP TS 23.316 [48]) +- Non-5G capable device behind 5G-CRG and FN-CRG or Network Requested PDU Session Release via W-5GAN (see clause 4.10a of 3GPP TS 23.316 [48]) +- Handover procedures between 3GPP access / 5GC and W-5GAN access (see clause 7.6.3 of 3GPP TS 23.316 [48]) + +- Handover from 3GPP access / EPS to W-5GAN / 5GC (see clause 7.6.4.1 of 3GPP TS 23.316 [48]) +- Transfer UAV specific data via N1 SM (see clause 5.2.4.3 of 3GPP TS 23.256 [56]) +- MBS join and Session establishment procedure (see clause 7.2.1.3 of 3GPP TS 23.247 [55]) +- MBS activation procedure (see clause 7.2.5.2 of 3GPP TS 23.247 [55]) +- Multicast session leave requested by the network or MBS session release (see clause 7.2.2.3 of 3GPP TS 23.247 [55]) +- Procedures applicable to a PRU (see clause 6.17 of 3GPP TS 23.273 [42]) +- Procedures of SL-MT-LR involving LMF (see 3GPP TS 23.273 [42], clause 6.20.3) +- Procedures of SL-MT-LR for periodic, triggered Location Events (see 3GPP TS 23.273 [42], clause 6.20.4) +- 5GC-MT-LR Procedure using SL positioning (see 3GPP TS 23.273 [42], clause 6.20.5) + +NOTE: Though in 3GPP TS 23.502 [3] the procedure is called "UE configuration update procedure for transparent UE policy delivery", as per 3GPP TS 24.501 [11] clause 5.4.5.3.1, the network initiated NAS transport procedure is used. + +The NF Service Consumer shall invoke the service operation by using HTTP method POST, to request the AMF to transfer N1 and/or N2 information for a UE and/or 5G-AN, with the URI of "N1 N2 Messages Collection" resource (see clause 6.1.3.5.3.1). + +The NF Service Consumer may include the following information in the HTTP Request message body: + +- SUPI +- PDU Session ID or LCS Correlation ID depending on the N1/N2 message class to be transferred +- N2 SM Information (PDU Session ID, QoS profile, CN N3 Tunnel Info, S-NSSAI) +- N1 Message Container, including a N1 SM, LPP message, LCS message, SMS, UPDP message, PRU message +- N2 Information Container, including N2 SM, NRPPa message, PWS or RAN related information +- Mobile Terminated Data (i.e. CIoT user data container) +- Allocation and Retention Priority (ARP) +- Paging Policy Indication +- 5QI +- Notification URL (used for receiving Paging Failure Indication) +- Last Message Indication +- NF Instance Identifier and optionally Service Instance Identifier of the NF Service Consumer (e.g. an LMF or SMF) +- N1 SM Skipping Indication +- Area of Validity for N2 SM Information +- A MA PDU Session Accepted indication, if a MA-PDU session is established; +- Extended Buffering Support Indication, if SMF determines that Extended Buffering applies during Network triggered Service Request Procedure (see clause 4.2.3.3 of 3GPP TS 23.502 [3]), UPF anchored Mobile Terminated Data Transport in Control Plane CIoT 5GS Optimisation procedure (see clause 4.24.2 of 3GPP TS 23.502 [3]) or NEF Anchored Mobile Terminated Data Transport (see clause 4.25.5 of 3GPP TS 23.502 [3]); +- Target Access type towards which the SMF requests to send N2 information and optionally N1 information, for a Multi-Access (MA) PDU session, or through which the LMF requests to transfer an LPP message to the UE. + +During an intra-AMF handover between 3GPP and non-3GPP accesses, the SMF shall include the targetAccess IE set to the old access type in the HTTP Request message body, when releasing the N2 PDU session resources in the old access (see step 3 of Figure 4.9.2.1-1 and step 3 of Figure 4.9.2.2-1 of 3GPP TS 23.502 [3]). + +![Sequence diagram showing N1N2MessageTransfer for UE related signalling between NF Service Consumer and AMF. The NF Service Consumer sends a POST request to /ue-contexts/{ueContextId}/n1-n2-messages. The AMF responds with either a 202 or 200 status code (N1N2MessageTransferRspData) or a 4xx/5xx status code (N1N2MessageTransferError) or 3xx.](6e15fc9ea763541c5913d26f85072ae1_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: 1. POST .../ue-contexts/{ueContextId}/n1-n2-messages(N1N2MessageTransferReqData) + NF Service Consumer->>AMF: Request + Note right of AMF: 2a. 202 or 200 (N1N2MessageTransferRspData) + AMF-->>NF Service Consumer: Success Response + Note right of AMF: 2b. 4xx/5xx (N1N2MessageTransferError) or 3xx + AMF-->>NF Service Consumer: Error/Redirect Response + +``` + +Sequence diagram showing N1N2MessageTransfer for UE related signalling between NF Service Consumer and AMF. The NF Service Consumer sends a POST request to /ue-contexts/{ueContextId}/n1-n2-messages. The AMF responds with either a 202 or 200 status code (N1N2MessageTransferRspData) or a 4xx/5xx status code (N1N2MessageTransferError) or 3xx. + +**Figure 5.2.2.3.1.1-1 N1N2MessageTransfer for UE related signalling** + +1. The NF Service Consumer shall send a POST request to transfer N1 and N2 information. The NF Service Consumer may include a N1N2MessageTransfer Notification URI to AMF in the request message. +- 2a. On success, i.e. if the request is accepted and the AMF is able to transfer the N1/N2 message to the UE and/or the AN, the AMF shall respond with a "200 OK" status code. The AMF shall set the cause IE in the N1N2MessageTransferRspData as "N1\_N2\_TRANSFER\_INITIATED" in this case. + +The AMF shall respond with a "200 OK" status code and set the cause IE in the N1N2MessageTransferRspData to "N2\_MSG\_NOT\_TRANSFERRED", if the N1N2MessageTransfer request included an area of validity for the N2 SM Information, the UE is in CM-CONNECTED state and outside of the area of validity. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.5.3.1-2 shall be returned. For a 4xx/5xx response, the message body shall contain a N1N2MessageTransferError structure, including: + - a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.5.3.1-2; + +#### 5.2.2.3.1.2 Detailed behaviour of the AMF + +When an NF service consumer is requesting to send N1 and/or N2 information and the UE is in CM-IDLE state for the access type for which the N1 and/or N2 information is related (called "associated access type" hereafter in this clause), the requirements specified in clause 5.2.2.3.1.1 shall apply with the following modifications: + +NOTE: N1 and/or N2 Session Management information is related to the access type of the targeted PDU session for a single access PDU session, or to the Target Access received in the request for a MA PDU session; LCS related N2 (NRPPa) information is related to 3GPP access in this release of specification. + +4xx and 5xx response cases shall also apply to UEs in CM-CONNECTED state, when applicable. + +#### 2xx Response Cases: + +##### Case A: When UE is CM-IDLE in 3GPP access and the associated access type is 3GPP access: + +- a) Same as step 2a of Figure 5.2.2.3.1.1-1, the AMF should respond with the status code "200 OK", if "skipInd" attribute is set to "true" in the request body, with a response body that carries the cause "N1\_MSG\_NOT\_TRANSFERRED". +- b) Same as step 2a of Figure 5.2.2.3.1.1-1, the AMF shall respond with the status code "202 Accepted", if the asynchronous type communication is invoked and hence the UE is not paged, update the UE context and store N1 and/or N2 information and initiate communication with the UE and/or 5G-AN when the UE becomes reachable. In this case the AMF shall provide the URI of the resource in the AMF in the "Location" header of the response. In this release, the URI shall only be used by NF Service consumer to correlate the possible N1/N2 Message Transfer Failure Notification with the related N1/N2 Message Transfer Operation. The NF service consumer shall not send any service requests towards the URI received in the Location header. + +The AMF shall also provide a response body containing the cause, "WAITING\_FOR\_ASYNCHRONOUS\_TRANSFER" that represents the current status of the N1/N2 message transfer; + +- c) Same as step 2a of Figure 5.2.2.3.1.1-1, the AMF shall respond with the status code "202 Accepted", if paging is issued when the UE is in CM-IDLE and reachable for 3GPP access, with a response body that carries a cause "ATTEMPTING\_TO\_REACH\_UE" as specified in clause 4.2.3.3 and 5.2.2.2.7 of 3GPP TS 23.502 [3]. + +**Case B: When UE is CM-IDLE in Non-3GPP access but CM-CONNECTED in 3GPP access and the associated access type is Non-3GPP access:** + +- a) Same as step 2a of Figure 5.2.2.3.1.1-1, the AMF shall respond with the status code "200 OK" with cause "N1\_N2\_TRANSFER\_INITIATED" and initiate N1 NAS SM message transfer via 3GPP access, if the NF service consumer (i.e. SMF) requests to send only N1 NAS SM message without any associated N2 SM information, and the current access type related to the PDU session is Non-3GPP access and the UE is CM-CONNECTED in 3GPP access. +- b) Same as step 2a of Figure 5.2.2.3.1.1-1, the AMF shall respond with the status code "202 Accepted", if NAS Notification procedure is issued when the UE is in CM-CONNECTED in 3GPP access, with a response body that carries a cause "ATTEMPTING\_TO\_REACH\_UE" as specified in step 4c of clause 4.2.3.3 and 5.2.2.2.7 of 3GPP TS 23.502 [3]. + +**Case C: When UE is CM-IDLE in both Non-3GPP access and 3GPP access and the associated access type is Non-3GPP access:** + +All the bullets specified in Case A are applicable. + +The NF Service Consumer shall not send any further signalling for the UE if it receives a POST response body with a cause "ATTEMPTING\_TO\_REACH\_UE" unless it has higher priority signalling. In such a case the response shall include the "Location" header containing the URI of the resource created in the AMF, e.g. + +".../n1-n2-messages/{n1N2MessageId}". In this release, the URI shall only be used by NF Service consumer to correlate the possible N1/N2 Message Transfer Failure Notification with the related N1/N2 Message Transfer Operation. The NF service consumer shall not send any service requests towards the URI received in the Location header. The AMF shall: + +- store the N1 and/or N2 information related to 3GPP access and, when the UE responds with a Service Request, shall initiate communication with the UE and/or 5G-AN using the stored N1 and/or N2 information; +- store the N1 NAS SM information related to Non-3GPP access if no N2 information was received and the AMF initiated paging towards the UE. Later when the UE responds with a Service Request, the AMF shall initiate communication with the UE using the stored N1 information via 3GPP access; +- inform the SMF which invoked the service operation, that the access type of the PDU Session can be changed from Non-3GPP access to 3GPP access as specified in clause 5.2.2.3.2.1 of 3GPP TS 29.502 [16], when the UE responds with a "List Of Allowed PDU Sessions" and the indicated non-3GPP PDU session of the N2 (and N1 if received) information is included in the list; or +- notify the NF which invoked the service operation, as specified in clause 5.2.2.3.2, if the Notification URI is provided, when the AMF determines that the paging or NAS Notification has failed or when the UE responds with a "List Of Allowed PDU Sessions" and the indicated Non-3GPP PDU session of the N2 (and N1 if received) information is not included in the list. + +**4xx Response Cases:** + +- Same as step 2b of Figure 5.2.2.3.1.1-1, the AMF shall respond with status code "409 Conflict" in the following cases: + - if the UE is in 3GPP access and there is already an ongoing paging procedure with higher or same priority, the AMF shall set the application error as "HIGHER\_PRIORITY\_REQUEST\_ONGOING" in the "cause" attribute of the ProblemDetails structure of the POST response body. The AMF may provide a retryAfter IE to the NF Service Consumer in order for the NF Service Consumer to retry the request after the expiry of the timer. When the retryAfter IE is provided, the NF Service Consumer shall not initiate the downlink messaging until the timer expires. The AMF may also provide the ARP value of the QoS flow that has triggered the currently ongoing highest priority paging, so that the NF Service Consumer (e.g. SMF) knows that if any subsequent trigger initiating downlink messaging for a QoS flow with the same or lower priority happens. + - if there is an ongoing registration procedure (see clause 4.2.3.3 of 3GPP TS 23.502 [3]) the AMF shall set the application error as "TEMPORARY\_REJECT\_REGISTRATION\_ONGOING" in the "cause" attribute of the ProblemDetails structure in the POST response body; The AMF may provide a retryAfter IE to the NF Service Consumer in order for the NF Service Consumer to retry the request after a short period. When the retryAfter IE is provided, the NF Service Consumer should not initiate new N1/N2 Message Transfer request until the timer expires. + +- if this is a request to transfer a N2 PDU Session Resource Modify Request or a N2 PDU Session Resource Release Command to a 5G-AN and if the UE is in CM-IDLE state at the AMF for the Access Network Type associated to the PDU session (see clauses 4.3.3 and 4.3.4 of 3GPP TS 23.502 [3] and clause 5.3.2.1 of 3GPP TS 23.527 [33]), the AMF shall set the application error "UE\_IN\_CM\_IDLE\_STATE" in the "cause" attribute of the ProblemDetails structure in the POST response body. +- if there is an ongoing Xn or N2 handover procedure (see clause 4.9.1.2.1 and 4.9.1.3.1 of 3GPP TS 23.502 [3]) the AMF shall set the application error as "TEMPORARY\_REJECT\_HANDOVER\_ONGOING" in the "cause" attribute of the ProblemDetails structure in the POST response body, if the AMF rejects the request due to the on-going handover. +- if the RAT Type is NB-IoT, and the UE already has 2 PDU Sessions with active user plane resources, the AMF shall set the application error as "MAX\_ACTIVE\_SESSIONS\_EXCEEDED" in POST response body. +- if Paging Restrictions information restricts the N1N2MessageTransfer request from causing paging (see clause 4.2.3.3 of 3GPP TS 23.502 [3]) the AMF shall set the application error as "REJECTION\_DUE\_TO\_PAGING\_RESTRICTION" in the "cause" attribute of the ProblemDetails structure in the POST response body. +- Same as step 2b of Figure 5.2.2.3.1.1-1, the AMF shall respond with the status code "403 Forbidden", if the UE is in a Non-Allowed Area and the service request is not for regulatory prioritized service. The AMF shall set the application error as "UE\_IN\_NON\_ALLOWED\_AREA" in POST response body. + - The NF service consumer (i.e. the SMF) that receives this application error may suppress subsequent message (e.g. N1N2MessageTransfer) to the AMF for non regulatory prioritized service. In this case, the NF service consumer (i.e. the SMF) should subscribe the Reachability-Report event for "UE Reachability Status Change" from the AMF, so as to get notified by the AMF when the UE becomes reachable again. +- Same as step 2b of Figure 5.2.2.3.1.1-1, the AMF shall respond with the status code "403 Forbidden", if the NF service consumer (e.g. an LMF) is requesting to send N1 LPP message to the UE and the UE has indicated that it does not support LPP in N1 mode during registration procedure (see clause 5.5.1.2.2 and 5.5.1.3.2 of 3GPP TS 24.501 [11]). The AMF shall set the application error to "UE\_WITHOUT\_N1\_LPP\_SUPPORT" in POST response body. +- Same as step 2b of Figure 5.2.2.3.1.1-1, the AMF shall respond with the status code "403 Forbidden", if the request body includes an nfd IE indicating an SMF instance which is different from the stored SMF instance hosting the SM Context of the PDU session. The AMF shall set the application error to "INVALID\_SM\_CONTEXT" in POST response body. During procedures with SM Context relocation, e.g. UE mobility procedures with I-SMF insertion/change/removal, the AMF shall allow N1N2MessageTransfer from both SMF instances holding the old and new SM Contexts. + +The NF service consumer (i.e. the SMF) that receives this application error shall remove the SM Context for the PDU session and release the PDU session resource in (H-)SMF if available. The SMF shall not send a SMContextStatusNotification to the AMF for the PDU session release. + +- Same as step 2b of Figure 5.2.2.3.1.1-1, the AMF shall respond with the status code "403 Forbidden", if the NF service consumer (e.g. an LMF) is requesting to initiate a positioning procedure towards a PRU (see clause 6.11.2 of 3GPP TS 23.273 [42]), i.e. the pruInd IE with the value true was included in the request, but the UE is not a valid PRU. The AMF shall set the application error to "INVALID\_PRU" in POST response body. + +### 5xx Response Cases: + +- Same as step 2b of Figure 5.2.2.3.1.1-1, the AMF shall respond with the status code "504 Gateway Timeout", if the UE is currently unreachable (e.g., due to the UE in MICO mode, the UE using extended idle mode DRX or the UE is only registered over Non-3GPP access and its state is CM-IDLE). The AMF shall set the application error as "UE\_NOT\_REACHABLE" in POST response body. If Extended Buffering Support Indication is received in the request, the AMF shall include the Estimated Maximum Waiting time in the response body when the message is rejected due to the UE in MICO mode or the UE using extended idle mode DRX. +- step 2b of Figure 5.2.2.3.1.1-1, the AMF may respond with the status code "504 Gateway Timeout", if the UE is temporarily not responding (e.g., not responding to the paging). The AMF shall set the application error as "UE\_NOT\_RESPONDING" in POST response body. The AMF may provide a retryAfter IE to the NF Service Consumer in order for the NF Service Consumer to throttle sending further N1/N2 Message Transfer request for a short period. When the retryAfter IE is provided, the NF Service Consumer should not initiate new N1/N2 Message Transfer request until the timer expires. + +### 5.2.2.3.2 N1N2Transfer Failure Notification + +The AMF uses this notification to inform the NF service consumer that initiated an earlier + +Namf\_Communication\_N1N2MessageTransfer, that the AMF failed to deliver the N1 and/or N2 message. The HTTP POST method shall be used on the notification callback URI provided by the NF service consumer as specified in clause 5.2.2.3.1.2. + +![Sequence diagram showing N1N2Transfer Failure Notification for UE related signalling. The AMF sends a POST request to the NF Service Consumer, which responds with a 204 No Content or an error status code.](04cfca33e3fc26513abe649d7474f733_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant NF Service Consumer + Note right of AMF: 1. POST {n1n2FailureTxfNotifURI} (N1N2MsgTxfrFailureNotification) + AMF->>NF Service Consumer: 1. POST {n1n2FailureTxfNotifURI} (N1N2MsgTxfrFailureNotification) + Note left of NF Service Consumer: 2. 204 No Content +Or 4xx/5xx (ProblemDetails) Or 3xx + NF Service Consumer-->>AMF: 2. 204 No Content +Or 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram showing N1N2Transfer Failure Notification for UE related signalling. The AMF sends a POST request to the NF Service Consumer, which responds with a 204 No Content or an error status code. + +**Figure 5.2.2.3.2-1 N1N2Transfer Failure Notification for UE related signalling** + +1. If the NF service consumer had provided a notification URI (see clause 5.2.2.3.1.2), the AMF shall send a POST request to the NF Service Consumer on that Notification URI when the AMF determines that: + +- the paging or NAS Notification has failed; +- the indicated non-3GPP PDU session is not allowed to move to 3GPP access; +- the UE has rejected the page as defined in 3GPP TS 23.501 [2] clause 5.38.4; +- the delivery of the N1 message fails, e.g. in case the UE is in RRC Inactive and NG-RAN paging was not successful or in case an Xn or N2 handover is being triggered at the NG-RAN + +The AMF shall include the N1N2MessageTransfer request resource URI returned earlier in the N1N2MessageTransfer response if any (see clause 5.2.2.3.1.2), otherwise a dummy URI (see clause 6.1.6.2.30), in the POST request body. The AMF shall also include a N1/N2 message transfer cause information in the POST request body and set the value as specified in clause 6.1.5.6.3.1. + +The NF Service Consumer shall delete any stored representation of the N1N2MessageTransfer request resource URI upon receiving this notification. + +The AMF may also include a "retryAfter" IE in the POST request body in order for the NF consumer to throttle sending further N1/N2 Message Transfer request for a short period, e.g. to reduce unnecessary paging to an unresponding UE for a period of time to save the RAN resources. + +2. The NF Service Consumer shall send a response with "204 No Content" status code. + +On failure or redirection, one of the HTTP status codes together with the response body listed Table 6.1.5.6.3.1-2 shall be returned. + +### 5.2.2.3.3 N1N2MessageSubscribe + +#### 5.2.2.3.3.1 General + +The N1N2MessageSubscribe service operation is used by a NF Service Consumer (e.g. PCF) to subscribe to the AMF for notifying N1 messages of a specific type (e.g. UPDP) or N2 information of a specific type. For the N1 message class UPDP, a PCF shall subscribe for the N1 message notification with the AMF to receive the N1 messages from UE that are related to UE Policy. + +**NOTE:** Step 0 of clause 4.2.4.3 of 3GPP TS 23.502 [3] specifies that the PCF can split the UPDP transfer towards UE into multiple units. One UE specific callback URI is registered with the AMF by the PCF for the AMF to notify all UPDP message responses from the UE to the same callback URI. As a result, an explicit subscription per UE policy association is defined in stage 3 for this purpose. + +An NF Service Consumer (e.g. PCF) may subscribe to notifications of specific N1 message type (e.g. LPP or UPDP) or N2 information type. In this case the NF Service Consumer shall subscribe by using the HTTP POST method with the URI of the "N1N2 Subscriptions Collection for Individual UE Contexts" resource (See clause 6.1.3.3). See also Figure 5.2.2.3.3.1-1. + +![Sequence diagram for N1N2 Message Subscribe. The NF Service Consumer sends a POST request to the AMF to create a subscription resource. The AMF responds with a 201 Created status code and a response body containing subscription details or an error code.](9f6dec4d4e9fde40bce018861ef1278e_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note right of NF Service Consumer: 1. POST ./namf_comm/v1/ue_contexts/{ueContextId}/n1-n2-messages/subscriptions (UeN1N2InfoSubscriptionCreateData) + NF Service Consumer->>AMF: Request + Note left of AMF: 2. 201 Created (UeN1N2InfoSubscriptionCreatedData) Or 4xx/5xx (ProblemDetails) Or 3xx + AMF-->>NF Service Consumer: Response + +``` + +Sequence diagram for N1N2 Message Subscribe. The NF Service Consumer sends a POST request to the AMF to create a subscription resource. The AMF responds with a 201 Created status code and a response body containing subscription details or an error code. + +**Figure 5.2.2.3.3.1-1 N1N2 Message Subscribe** + +1. The NF Service Consumer shall send a POST request to create a subscription resource in the AMF for a UE specific N1/N2 message notification. The content of the POST request shall contain: + - N1 and/or N2 Message Type, identifying the type of N1 and/or N2 message to be notified + - A callback URI for the notification +2. If the request is accepted, the AMF shall include a HTTP Location header to provide the location of a newly created resource (subscription) together with the status code 201 indicating the requested resource is created in the response message. + +On failure or redirection, one of the HTTP status codes together with the response body listed Table 6.1.3.3.3.1-3 shall be returned. + +#### 5.2.2.3.4 N1N2MessageUnSubscribe + +##### 5.2.2.3.4.1 General + +The N1N2MessageUnSubscribe service operation is used by a NF Service Consumer (e.g. PCF) to unsubscribe to the AMF to stop notifying N1 messages of a specific type (e.g. LPP or UPDP). + +The NF Service Consumer shall use the HTTP method DELETE with the URI of the "N1N2 Individual Subscription" resource (See clause 6.1.3.7.3.1), to request the deletion of the subscription for the N1 / N2 message towards the AMF. See also Figure 5.2.2.3.4.1-1. + +![Sequence diagram for N1N2 Message UnSubscribe. The NF Service Consumer sends a DELETE request to the AMF to delete an existing subscription resource. The AMF responds with a 204 No Content status code and a response body containing subscription details or an error code.](f10dc32e3673e1392029a49e958a9d6c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note right of NF Service Consumer: 1. DELETE ./namf_comm/v1/ue_contexts/{ueContextId}/n1-n2-messages/subscriptions/{subscriptionId} + NF Service Consumer->>AMF: Request + Note left of AMF: 2. 204 No Content Or 4xx/5xx (ProblemDetails) Or 3xx + AMF-->>NF Service Consumer: Response + +``` + +Sequence diagram for N1N2 Message UnSubscribe. The NF Service Consumer sends a DELETE request to the AMF to delete an existing subscription resource. The AMF responds with a 204 No Content status code and a response body containing subscription details or an error code. + +**Figure 5.2.2.3.4.1-1 N1N2 Message UnSubscribe** + +1. The NF Service Consumer shall send a DELETE request to delete an existing subscription resource in the AMF. +2. If the request is accepted, the AMF shall reply with the status code 204 indicating the resource identified by subscription ID is successfully deleted, in the response message. + +On failure or redirection, one of the HTTP status codes together with the response body listed Table 6.1.3.4.3.1-3 shall be returned. + +#### 5.2.2.3.5 N1MessageNotify + +##### 5.2.2.3.5.1 General + +The N1MessageNotify service operation is used by an AMF notifying the N1 message received from the UE to a destination CN NF, and it is used in the following procedures: + +- Registration with AMF re-allocation (see clause 4.2.2.2.3 of 3GPP TS 23.502 [3]) +- UE assisted and UE based positioning procedure (see clause 6.11.1 of 3GPP TS 23.273 [42]) +- LCS Event Report, Event Reporting in RRC INACTIVE state procedures, LCS Cancel Location and LCS Periodic-Triggered Invoke procedures (see clause 6.3, clause 6.7 and clause 6.20.3 of 3GPP TS 23.273 [42]) +- UE configuration update procedure for transparent UE policy delivery (See clause 4.2.4.3 in 3GPP TS 23.502 [3]) + +NOTE: Though in 3GPP TS 23.502 [3] the procedure is called "UE configuration update procedure for transparent UE policy delivery", as per 3GPP TS 24.501 [11] clause 5.4.5.2.1, the UE initiated NAS transport procedure is used. + +- UE triggered policy provisioning procedure to request UE policies. (See clause 6.2.4 in 3GPP TS 23.287 [47] and clause 6.2.4 in 3GPP TS 23.304 [51]) +- Procedures applicable to a PRU (see clause 6.17 of 3GPP TS 23.273 [42]) +- Procedures of SL-MT-LR involving LMF (see 3GPP TS 23.273 [42], clause 6.20.3) +- Procedures of SL-MT-LR for periodic, triggered Location Events (see 3GPP TS 23.273 [42], clause 6.20.4) +- 5GC-MT-LR Procedure using SL positioning (see 3GPP TS 23.273 [42], clause 6.20.5) + +The AMF shall use HTTP POST method to the N1 Notification URI provided by the NF Service Consumer via N1N2MessageSubscribe service operation (See clause 5.2.2.3.3). See also figure 5.2.2.3.5.1-1. + +![Sequence diagram showing N1 Message Notify interaction between AMF and NF Service Consumer.](26e334e61dd059cff029338a2a604d8d_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant NFSC as NF Service Consumer + Note left of NFSC: + AMF->>NFSC: 1. POST {n1NotifyCallbackUri} (N1MessageNotification) + NFSC-->>AMF: 2a. 204 No Content + NFSC-->>AMF: 2b. 4xx/5xx (ProblemDetails) Or 3xx + +``` + +The diagram illustrates the interaction between the AMF and the NF Service Consumer. The AMF sends a POST request (step 1) to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content (step 2a) or an error status code (step 2b). + +Sequence diagram showing N1 Message Notify interaction between AMF and NF Service Consumer. + +**Figure 5.2.2.3.5.1-1 N1 Message Notify** + +1. The AMF shall send a HTTP POST request to the N1 Notification URI, and the content of the POST request shall contain an N1MessageNotification data structure with the subscribed N1 message. +- 2a. On success, "204 No Content" shall be returned and the content of the POST response shall be empty. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.5.4.3.1-3 shall be returned. The message body shall contain a ProblemDetails object with "cause" set to one of the corresponding application errors listed in Table 6.1.5.4.3.1-3. + +#### 5.2.2.3.5.2 Using N1MessageNotify in the Registration with AMF Re-allocation Procedure + +In the Registration with AMF re-allocation procedure, the N1MessageNotify service operation is invoked by a NF Service Producer, i.e. an Initial AMF, towards a NF Service Consumer, e.g. the target AMF, which is selected to serve the UE, by the initial AMF. + +The requirements specified in clause 5.2.2.3.5.1 shall apply with the following modifications: + +1. The initial AMF discovers the NF Service Consumer (e.g. the target AMF) from the NRF, and fetch N1 Notification URI from the default notification subscription registered with "N1\_MESSAGE" notification type and "5GMM" N1 message class (See Table 6.2.6.2.3-1 and Table 6.2.6.2.4-1 of 3GPP TS 29.510 [29]). + +NOTE: The alternate AMF is expected to have registered a callback URI with the NRF. + +2. Same as step 1 of Figure 5.2.2.3.5.1-1, the request content shall include the following information in the HTTP POST Request message body: + +- RAN NGAP ID and initial AMF name (the information enabling (R)AN to identify the N2 terminating point); +- RAN identity, e.g. RAN Node Id, RAN N2 IPv4/v6 address; +- Information from RAN, e.g. User Location, RRC Establishment Cause and UE Context Request; +- the N1 message, which shall be the complete Registration Request message in clear text if the UE has a valid NAS security context, or as the one contained in the NAS message container IE in the Security Mode Complete message as specified in clause 4.2.2.2.3 of 3GPP TS 23.502 [2]; +- the UE's SUPI and MM Context; +- the Allowed NSSAI and if available the partially Allowed NSSAI, together with the corresponding NSI IDs (if network slicing is used and the initial AMF has obtained). + +#### 5.2.2.3.5.3 Using N1MessageNotify in the UE Assisted and UE Based Positioning Procedure + +In the UE assisted and UE based positioning procedure, the N1MessageNotify service operation is invoked by the AMF, towards the LMF, to notify the N1 UE positioning messages received from the UE. + +The requirements specified in clause 5.2.2.3.5.1 shall apply with the following modifications: + +1. If the corresponding N1 notification URI is not available, the AMF shall retrieve the NF profile of the NF Service Consumer (e.g. the LMF) from the NRF using the NF Instance Identifier received during corresponding N1N2MessageTransfer service operation (see clause 5.2.2.3.1), and further identify the corresponding service instance if Service Instance Identifier was also received, and fetch N1 Notification URI from the default notification subscription registered with "N1\_MESSAGE" notification type and "LPP" N1 message class (See Table 6.2.6.2.3-1 and Table 6.2.6.2.4-1 of 3GPP TS 29.510 [29]). +2. Same as step 1 of Figure 5.2.2.3.5.1-1, the request content shall include the following information: + - the N1 Uplink Positioning Message; + - LCS correlation identifier. + +#### 5.2.2.3.5.4 Using N1MessageNotify in the UE Configuration Update for transparent UE Policy delivery + +In the UE Configuration Update for transparent UE Policy delivery procedure, the N1MessageNotify service operation is invoked by the AMF, towards the PCF which subscribed to be notified with UPDP messages received from the UE. + +The requirements specified in clause 5.2.2.3.5.1 shall apply with the following modifications: + +1. Same as step 1 of Figure 5.2.2.3.5.1-1. The request content shall include the following information: + - the UPDP message. + +#### 5.2.2.3.5.5 Using N1MessageNotify in the LCS Event Report, Event Reporting in RRC INACTIVE state procedures, LCS Cancel Location and LCS Periodic-Triggered Invoke Procedures + +In the LCS Event Report, Event Reporting in RRC INACTIVE state procedures, LCS Cancel Location and LCS Periodic-Triggered Invoke procedure, the N1MessageNotify service operation is invoked by the AMF, towards the LMF, to notify the N1 UE LCS messages received from the UE. + +The requirements specified in clause 5.2.2.3.5.1 shall apply with the following modifications: + +1. If the corresponding N1 notification URI is not available, the AMF shall retrieve the NF profile of the NF Service Consumer (e.g. the LMF) from the NRF using the NF Instance Identifier received during corresponding N1N2MessageTransfer service operation (see clause 5.2.2.3.1), and further identify the corresponding service instance if Service Instance Identifier was also received, and fetch N1 Notification URI from the default notification subscription registered with "N1\_MESSAGE" notification type and "LCS" N1 message class (See Table 6.2.6.2.3-1 and Table 6.2.6.2.4-1 of 3GPP TS 29.510 [29]). +2. Same as step 1 of Figure 5.2.2.3.5.1-1, the request content shall include the following information: + - the N1 Uplink LCS Message; + - LCS correlation identifier; + - indication of Control Plane CIoT 5GS Optimisation if Control Plane CIoT 5GS Optimisation is being used. and may include serving cell ID if it is available; + +NOTE: For the EventReport message and UE initiated CancelDeferredLocation message, the AMF includes the deferred routing identifier received from UE in N1 UL NAS TRANSPORT message as LCS correlation identifier. The LCS correlation identifier can assist a serving LMF in identifying the periodic or triggered location session if the same LMF had assigned the deferred routing identifier or can indicate to the LMF that it is acting as a default LMF. + +#### 5.2.2.3.5.6 Using N1MessageNotify in the UE triggered policy provisioning procedure to request UE policies + +In the UE triggered policy provisioning procedure, the N1MessageNotify service operation is invoked by the AMF, towards the PCF which subscribed to be notified with UPDP messages received from the UE. + +The requirements specified in clause 5.2.2.3.5.1 shall apply with the following modifications: + +1. Same as step 1 of Figure 5.2.2.3.5.1-1. The request content shall include the following information: + - the UPDP message. + +#### 5.2.2.3.5.7 Using N1MessageNotify in the procedures applicable to a PRU + +In the PRU Association Procedure, LMF Initiated PRU Disassociation Procedure or PRU Initiated PRU Disassociation Procedure, the N1MessageNotify service operation is invoked by the AMF, towards the LMF, to notify the N1 PRU messages received from the PRU. + +The requirements specified in clause 5.2.2.3.5.1 shall apply with the following modifications: + +1. If the corresponding N1 notification URI is not available, the AMF shall select the LMF and retrieve the NF profile of the LMF from the NRF (see clause 6.17 of 3GPP TS 23.273 [42]), and fetch N1 Notification URI from the default notification subscription registered with "N1\_MESSAGE" notification type and "LCS" N1 message class (See Table 6.2.6.2.3-1 and Table 6.2.6.2.4-1 of 3GPP TS 29.510 [29]). +2. Same as step 1 of Figure 5.2.2.3.5.1-1, the request content shall include the following information if available: + - the N1 PRU messages; + - PRU subscription Indication; + - the TAI and cell Id of the PRU; + - Correlation identifier; + - SUPI of the PRU. + +#### 5.2.2.3.6 N2InfoNotify + +##### 5.2.2.3.6.1 General + +The N2InfoNotify service operation is used during the following procedure: + +- Inter NG-RAN node N2 based handover procedure (see 3GPP TS 23.502 [3], clauses 4.9.1.3.3, 4.9.1.3.3a and 4.23.7.3); +- Network assisted positioning procedure (see clause 6.11.2 of 3GPP TS 23.273 [42]) +- AMF planned removal procedure with UDSF deployed (see clause 5.21.2.2.1 of 3GPP TS 23.501 [2]), to forward uplink N2 signalling to a different AMF. + +The N2InfoNotify service operation is invoked by AMF, to notify a NF Service Consumer that subscribed N2 information has been received from access network. + +The AMF shall use HTTP POST method to the N2Info Notification URI provided by the NF Service Consumer via N1N2MessageSubscribe service operation (See clause 5.2.2.3.3). See also figure 5.2.2.3.6.1-1. + +![Sequence diagram for N2 Information Notify. It shows an AMF sending a POST request to an NF Service Consumer. The request is labeled '1. POST {n2NotifyCallbackUri} (N2InformationNotification)'. The NF Service Consumer responds with '2a. 204 No Content' on success or '2b. 4xx/5xx (ProblemDetails) Or 3xx' on failure or redirection.](8269648391c59363ea61243864a2adf7_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant NF Service Consumer + Note left of AMF: 1. POST {n2NotifyCallbackUri} (N2InformationNotification) + AMF->>NF Service Consumer: 1. POST {n2NotifyCallbackUri} (N2InformationNotification) + Note right of NF Service Consumer: 2a. 204 No Content + NF Service Consumer-->>AMF: 2a. 204 No Content + Note right of NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) Or 3xx + NF Service Consumer-->>AMF: 2b. 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram for N2 Information Notify. It shows an AMF sending a POST request to an NF Service Consumer. The request is labeled '1. POST {n2NotifyCallbackUri} (N2InformationNotification)'. The NF Service Consumer responds with '2a. 204 No Content' on success or '2b. 4xx/5xx (ProblemDetails) Or 3xx' on failure or redirection. + +**Figure 5.2.2.3.6.1-1 N2 Information Notify** + +1. The AMF shall send a HTTP POST request to the n2NotifyCallbackUri, and the content of the POST request shall contain a N2InformationNotification data structure, containing the N2 information that was subscribed by the NF Service Consumer. +- 2a. On success, "204 No Content" shall be returned and the content of the POST response shall be empty. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.5.5.3.1-3 shall be returned. The message body shall contain a ProblemDetails object with "cause" set to one of the corresponding application errors listed in Table 6.1.5.5.3.1-3. + +#### 5.2.2.3.6.2 Using N2InfoNotify during Inter NG-RAN node N2 based handover procedure + +The N2InfoNotify service operation is invoked by a NF Service Producer, e.g. the target AMF, towards the NF Service Consumer, i.e. the source AMF, to notify that the handover procedure has been successful in the target side, for a given UE. + +![Sequence diagram for N2 Information Notify during N2 Handover execution. It shows a Target AMF sending a POST request to a Source AMF. The request is labeled '1. POST {n2InfoNotifyUri} (N2InformationNotification)'. The Source AMF responds with '2a. 200 OK (N2InfoNotificationRspData) or 204 No Content' on success or '2b. 4xx/5xx (ProblemDetails) Or 3xx' on failure or redirection.](bc9d0c0b02cbe628b1b6548cc1107734_img.jpg) + +``` + +sequenceDiagram + participant Source AMF + participant Target AMF + Note left of Target AMF: 1. POST {n2InfoNotifyUri} (N2InformationNotification) + Target AMF->>Source AMF: 1. POST {n2InfoNotifyUri} (N2InformationNotification) + Note right of Source AMF: 2a. 200 OK (N2InfoNotificationRspData) or 204 No Content + Source AMF-->>Target AMF: 2a. 200 OK (N2InfoNotificationRspData) or 204 No Content + Note right of Source AMF: 2b. 4xx/5xx (ProblemDetails) Or 3xx + Source AMF-->>Target AMF: 2b. 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram for N2 Information Notify during N2 Handover execution. It shows a Target AMF sending a POST request to a Source AMF. The request is labeled '1. POST {n2InfoNotifyUri} (N2InformationNotification)'. The Source AMF responds with '2a. 200 OK (N2InfoNotificationRspData) or 204 No Content' on success or '2b. 4xx/5xx (ProblemDetails) Or 3xx' on failure or redirection. + +**Figure 5.2.2.3.6.2-1 N2 Information Notify during N2 Handover execution** + +The requirements specified in clause 5.2.2.3.6.1 shall apply with the following modifications: + +0. During an inter AMF handover procedure, the source AMF, acting as a NF Service Consumer, when invoking the CreateUEContext service operation (see clause 5.2.2.2.3), shall include a N2Info Notification URI to the target AMF in the HTTP request message. +1. Same as step 1 of Figure 5.2.2.3.6.1-1, the request content shall contain the following information: + - notification content (see clause 6.1.5.5) without the "n2InfoContainer" attribute; + - the "notifyReason" attribute set to "HANDOVER\_COMPLETED"; + - the "smfChangeInfoList" attribute including the UE's PDU Session ID(s) for which the I-SMF or V-SMF has been changed or removed, if any, with for each such PDU session, the related "smfChangeIndication" attribute set to "CHANGED" or "REMOVED", if the I-SMF or the V-SMF is changed or removed respectively. + - the "notifySourceNgRan" attribute set to "true" during an Inter NG-RAN node N2 based DAPS handover procedure, if the target AMF receives this indication in the Handover Notify from the target NG-RAN node (see clause 4.9.1.3.3a of 3GPP TS 23.502 [3]). + +If any network slice(s) become no longer available and there are PDU Session(s) associated with them, the target AMF shall include these PDU session(s) in the toReleaseSessionList attribute in the content. The n2NotifySubscriptionId included in the notification content shall be the UE context Id. + +2. Same as Step 2a of Figure 5.2.2.3.6.1-1, with the following additions/modifications: + +- the source AMF shall release the PDU Session(s) listed in the toReleaseSessionList attribute in the content; +- if the smfChangeInfoList attribute was received in the request, the source AMF shall release the SM Context at the I-SMF or V-SMF only, for all the PDU sessions listed in the smfChangeInfoList attribute with the smfChangeIndication attribute set to "CHANGED" or "REMOVED"; +- the source AMF shall remove the individual ueContext resource. The source AMF may choose to start a timer to supervise the release of the UE context resource and may keep the individual ueContext resource until the timer expires; +- if Secondary RAT usage data have been received from the source NG-RAN and buffered at the source AMF for one or more PDU sessions as specified in step 2a0 of clause 4.9.1.3.3 of 3GPP TS 23.502 [3], the source AMF shall send a 200 OK response with the Secondary RAT usage data included in the response content for one or more PDU sessions. +- if the "notifySourceNgRan" attribute was set to "true" in the request, the source AMF shall send a HANDOVER SUCCESS to the source NG-RAN (see clause 4.9.1.3.3a of 3GPP TS 23.502 [3]). + +NOTE: This notification is due to an implicit subscription and hence no explicit subscription Id is created. UE context Id is included as the notification subscription Id for the NF Service Consumer (e.g. Source AMF) to co-relate the notification to an earlier initiated UE context creation during a handover procedure. + +#### 5.2.2.3.6.3 Using N2InfoNotify during Location Services procedures + +The N2InfoNotify service operation is invoked by a NF Service Producer, i.e. the AMF, towards the NF Service Consumer, e.g. the LMF, to notify the positioning parameters received from the 5G-AN in the NRPPa message. + +The requirements specified in clause 5.2.2.3.6.1 shall apply with the following modifications: + +1. If the corresponding N2 notification URI is not available, the AMF shall retrieve the NF profile of the NF Service Consumer (e.g. the LMF) from the NRF using the NF Instance Identifier received during corresponding N1N2MessageTransfer service operation (see clause 5.2.2.3.1), and further identify the corresponding service instance if Service Instance Identifier was also received, and fetch N2 Notification URI from the default subscription registered with "N2\_INFORMATION" notification type and "NRPPa" N2 information class (See Table 6.2.6.2.3-1 and Table 6.2.6.2.4-1 of 3GPP TS 29.510 [29]). +2. Same as step 1 of Figure 5.2.2.3.6.1-1, the request content shall contain N2 information of type NRPPa and LCS correlation identifier. + +#### 5.2.2.3.6.4 Using N2InfoNotify during AMF planned removal procedure with UDSF deployed procedure + +In the AMF planned removal procedure with UDSF deployed (see clause 5.21.2.2.1 of 3GPP TS 23.501 [2]), the N2InfoNotify service operation is invoked by a NF Service Producer, i.e. an initial AMF, towards the NF Service Consumer, i.e. the target AMF, to forward uplink N2 signalling to the target AMF. + +The requirements specified in clause 5.2.2.3.6.1 shall apply with the following modifications: + +1. If the N2 notification URI is not available, the initial AMF shall discover the NF Service Consumer (i.e. the target AMF) from the NRF, and fetch the N2 Notification URI from the default notification subscription registered with "N2\_INFORMATION" notification type and "RAN" N2 message class (See Table 6.2.6.2.3-1 and Table 6.2.6.2.4-1 of 3GPP TS 29.510 [29]). + +NOTE: The target AMF is expected to have registered a callback URI with the NRF. + +2. Same as step 1 of Figure 5.2.2.3.6.1-1, the request content shall contain the following information in the HTTP POST Request message body: + - N2 information of type "RAN"; + - N2 message; + - initial AMF name; + - RAN identity, e.g. RAN Node Id, RAN N2 IPv4/v6 address. + +## 5.2.2.4 Non-UE N2 Message Operations + +### 5.2.2.4.1 NonUeN2MessageTransfer + +#### 5.2.2.4.1.1 General + +The NonUeN2MessageTransfer service operation is used by a NF Service Consumer to transfer N2 information to the 5G-AN through the AMF in the following procedures: + +- Obtaining non-UE associated network assistance data (See clause 4.13.5.6 in 3GPP TS 23.502 [3]); +- Warning Request Transfer procedures (See clause 9A in 3GPP TS 23.041 [20]); +- Configuration Transfer procedure (see clause 5.26 of 3GPP TS 23.501 [2]) +- RIM Information Transfer procedures (see clause 8.16 of 3GPP TS 38.413 [12]). +- Broadcast of Assistance Data by an LMF (see clause 6.14.1 of 3GPP TS 23.273 [42]). +- Management of network timing synchronization status monitoring procedures (see clause 4.15.9.X of 3GPP TS 23.502 [3]). + +The NF Service Consumer shall invoke the service operation by sending POST to the URI of the "transfer" customer operation on the "Non UE N2Messages Collection" resource (See clause 6.1.3.8.4.2) on the AMF. See also figure 5.2.2.4.1.1-1. + +![Sequence diagram illustrating the Non-UE N2 Message Transfer procedure between an NF Service Consumer and an AMF. The NF Service Consumer sends a POST request (1.POST .../non-ue-n2-messages/transfer (N2InformationTransferReqData)) to the AMF. The AMF responds with either a 200 OK (2a. 200 OK (N2InformationTransferRspData)) or an error status code (2b. 4xx/5xx(N2InformationTransferError) or 3xx).](9edb407536d4d4d4a6ac391527af047c_img.jpg) + +``` + +sequenceDiagram + participant NFSC as NF Service Consumer + participant AMF + Note left of NFSC: 1.POST .../non-ue-n2-messages/transfer (N2InformationTransferReqData) + NFSC->>AMF: Request + Note right of AMF: 2a. 200 OK (N2InformationTransferRspData) + AMF-->>NFSC: Success Response + Note right of AMF: 2b. 4xx/5xx(N2InformationTransferError) or 3xx + AMF-->>NFSC: Error Response + +``` + +Sequence diagram illustrating the Non-UE N2 Message Transfer procedure between an NF Service Consumer and an AMF. The NF Service Consumer sends a POST request (1.POST .../non-ue-n2-messages/transfer (N2InformationTransferReqData)) to the AMF. The AMF responds with either a 200 OK (2a. 200 OK (N2InformationTransferRspData)) or an error status code (2b. 4xx/5xx(N2InformationTransferError) or 3xx). + +**Figure 5.2.2.4.1.1-1 Non-UE N2 Message Transfer** + +1. The NF Service Consumer shall invoke the custom operation for non UE associated N2 message transfer by sending a HTTP POST request, and the request body shall carry the N2 information to be transferred. +- 2a. On success, AMF shall respond a "200 OK" status code with N2InformationTransferRspData data structure. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.8.4.2.2-2shall be returned with the message body containing a N2InformationTransferError structure, including a ProblemDetails attribute with the "cause" attribute set to one of the application errors listed in Table 6.1.3.8.4.2.2-2. + +#### 5.2.2.4.1.2 Obtaining Non UE Associated Network Assistance Data Procedure + +The NonUeN2MessageTransfer service operation shall be invoked by a NF Service Consumer, e.g. LMF to transfer non UE associated N2 information of N2 information class NRPPa to NG-RAN for obtaining the network assistance data. + +The requirements specified in clause 5.2.2.4.1.1 shall apply with the following modifications: + +1. Same as step 1 of Figure 5.2.2.4.1.1-1, the POST request body shall carry the N2 information to be transferred together with the NG RAN node identifier(s) to which the transfer needs to be initiated. The POST request body shall also include the NF Instance Identifier of the NF Service Consumer (e.g. LMF) in "nflId" attribute. + +#### 5.2.2.4.1.3 Warning Request Transfer Procedure + +The NonUeN2MessageTransfer service operation shall be invoked by the NF Service Consumer, e.g. CBCF/PWS-IWF, to send non-UE specific messages of N2 information class PWS to the NG-RAN. + +The requirements specified in clause 5.2.2.4.1.1 shall apply with the following modifications: + +1. Same as step 1 of Figure 5.2.2.4.1.1-1, the request body shall include the N2 Message Container and: + +- the *globalRanNodeList* IE, or; +- the *taiList* IE and the *ratSelector* IE, or; +- the *ratSelector* IE. + +The AMF shall forward the N2 Message Container to ng-eNBs or to gNBs indicated in the *globalRanNodeList* IE if present. If the *globalRanNodeList* IE if not present, the AMF shall forward the N2 Message Container to ng-eNBs or to gNBs, subject to the value of the *ratSelector* IE, that serve Tracking Areas as listed in the *taiList* IE if present. If the *taiList* IE and the *globalRanNodeList* IE are not present, the AMF shall forward the N2 Message Container to all attached ng-eNBs or all attached gNBs, subject to the value of the *ratSelector* IE. + +NOTE: The *globalRanNodeList* IE can be present when transferring WRITE-REPLACE WARNING REQUEST. When present, the *globalRanNodeList* IE only contains RAN nodes of the same type, i.e. only ng-eNBs or only gNBs. + +The request body may additionally include the *omcId* IE and/or the *sendRanResponse* IE. + +- 2a. Same as step 2a of Figure 5.2.2.4.1.1-1, and the POST response body shall contain the mandatory elements from the Write-Replace-Warning Confirm response (see clause 9.2.17 in TS 23.041 [20]) or the mandatory elements and optionally the *unknown TAI List* IE from the Stop-Warning Confirm response (see clause 9.2.19 in TS 23.041 [20]). + +If the *sendRanResponse* IE with the value "true" was received in the request, but the corresponding N2 information subscription for PWS information from the NF service consumer is not available in the AMF, the AMF should include the *n2PwsSubMissInd* IE with the value "true" in the response. + +- 2b. Same as step 2b of Figure 5.2.2.4.1.1-1, and the POST response body shall contain following additional information: + +- PWS specific information, if any, e.g. PWS Cause information. + +#### 5.2.2.4.1.4 Configuration Transfer Procedure + +The NonUeN2MessageTransfer service operation shall be invoked by the NF Service Consumer (i.e. source AMF) towards the NF Service Producer (i.e. target AMF) to transfer the RAN configuration information received from the source NG-RAN towards the target NG-RAN. + +The requirements specified in clause 5.2.2.4.1.1 shall apply with the following modifications: + +1. Same as step 1 of Figure 5.2.2.4.1.1-1. The POST request body shall contain the SON Configuration Transfer IE received from the source NG-RAN, the NG RAN node identifier of the destination of this configuration information, and the N2 information class "RAN". + +The target AMF shall forward the SON Configuration Transfer IE in a NGAP Downlink RAN Configuration Transfer message to the target NG-RAN. + +#### 5.2.2.4.1.5 RIM Information Transfer Procedures + +The NonUeN2MessageTransfer service operation shall be invoked by the NF Service Consumer (i.e. source AMF) towards the NF Service Producer (i.e. target AMF) to transfer the RIM information received from the source NG-RAN towards the target NG-RAN. + +The requirements specified in clause 5.2.2.4.1.1 shall apply with the following modifications: + +1. Same as step 1 of Figure 5.2.2.4.1.1-1. The POST request body shall contain the RIM Information Transfer IE received from the source NG-RAN, the NG RAN node identifier of the destination of this configuration information, and the N2 information class "RAN". + +The target AMF shall forward the RIM Information Transfer IE in a NGAP Downlink RIM Information Transfer message to the target NG-RAN. + +#### 5.2.2.4.1.6 Broadcast of Assistance Data by an LMF + +The NonUeN2MessageTransfer service operation shall be invoked by a NF Service Consumer, e.g. LMF to transfer non UE associated N2 information of N2 information class NRPPa to NG-RAN for sending assistance information broadcasting. + +The requirements specified in clause 5.2.2.4.1.1 shall apply with the following modifications: + +1. Same as step 1 of Figure 5.2.2.4.1.1-1, the POST request body shall contain NRPPa-PDU IE carrying Network Assistance Data generated by LMF to be transferred together with the target NG RAN node identifier(s) to which the transfer needs to be initiated. The POST request body shall also include the NF Instance Identifier of the NF Service Consumer (e.g. LMF) in "nflId" attribute. + +#### 5.2.2.4.1.7 Management of network timing synchronization status monitoring procedures + +The NonUeN2MessageTransfer service operation shall be invoked by a NF Service Consumer, e.g. TSCTSF, to transfer clock quality reporting control information to NG-RAN. + +The requirements specified in clause 5.2.2.4.1.1 shall apply with the following modifications: + +1. Same as step 1 of Figure 5.2.2.4.1.1-1, the POST request body shall contain Clock Quality Reporting Control Information IE to be transferred together with the information identifying target NG RAN node(s) to which the transfer needs to be initiated, and the N2 information class "TSS". The POST request body shall also include the NF Instance Identifier of the NF Service Consumer (e.g. TSCTSF) in "nflId" attribute. + +**Editor's note:** Further details on NGAP IE "Clock Quality Reporting Control Information" to be aligned with RAN WG3, and it shall be specified in clause 6.1.6.4.3.2. + +**Editor's note:** Whether the target NG-RAN node(s) are identified by TAI or NG-RAN node identifiers is FFS. + +#### 5.2.2.4.2 NonUeN2InfoSubscribe + +##### 5.2.2.4.2.1 General + +The NonUeN2InfoSubscribe service operation is used by a NF Service Consumer (e.g. CBCF, PWS-IWF, TSCTSF) to subscribe to the AMF for notifying non UE specific N2 information of a specific type (e.g. PWS Indications, TSS). + +An NF Service Consumer (e.g. CBCF, PWS-IWF, TSCTSF) may subscribe to notifications of specific N2 information type (e.g. PWS Indications, TSS) that are not associated with any UE. In this case, the NF Service Consumer shall subscribe by using the HTTP POST method with the URI of the "Non UE N2Messages Subscriptions Collection" resource (See clause 6.1.3.9.3.1). See also Figure 5.2.2.4.2.1-1. + +![Sequence diagram showing the N2 Information Subscription for Non UE Information. The NF Service Consumer sends a POST request to the AMF, and the AMF responds with a 201 Created status code.](9e5ebd04b22b9fa09c82a10a81129278_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note right of NF Service Consumer: 1. POST /namf_comm/v1/non-ue-n2-messages/subscriptions +(NonUeN2InfoSubscriptionCreateData) + NF Service Consumer->>AMF: Request + Note left of AMF: 2. 201 Created (NonUeN2InfoSubscriptionCreatedData) +Or 4xx/5xx (ProblemDetails) Or 3xx + AMF-->>NF Service Consumer: Response + +``` + +Sequence diagram showing the N2 Information Subscription for Non UE Information. The NF Service Consumer sends a POST request to the AMF, and the AMF responds with a 201 Created status code. + +**Figure 5.2.2.4.2.1-1 N2 Information Subscription for Non UE Information** + +1. The NF Service Consumer shall send a POST request to create a subscription resource in the AMF for a non UE specific N2 information notification. The content of the POST request shall contain: + - N2 Information Type, identifying the type of N2 information to be notified + - A callback URI for the notification +2. If the request is accepted, the AMF shall include a HTTP Location header to provide the location of a newly created resource (subscription) together with the status code 201 indicating the requested resource is created in the response message. + +On failure or redirection, one of the HTTP status codes together with the response body listed Table 6.1.3.9.3.1-3 shall be returned. + +### 5.2.2.4.3 NonUeN2InfoUnSubscribe + +#### 5.2.2.4.3.1 General + +The NonUeN2InfoUnSubscribe service operation is used by a NF Service Consumer (e.g. CBCF, PWS-IWF, TSCTSF) to unsubscribe to the AMF to stop notifying N2 information of a specific type (e.g. PWS Indications, TSS). + +The NF Service Consumer shall use the HTTP method DELETE with the URI of the "Non UE N2 Message Notification Individual Subscription" resource (See clause 6.1.3.10.3.1), to request the deletion of the subscription for non UE specific N2 information notification, towards the AMF. See also Figure 5.2.2.4.3.1-1. + +![Sequence diagram for NonUeN2InfoUnSubscribe. The NF Service Consumer sends a DELETE request to the AMF. The AMF responds with a 204 No Content or an error status code.](1316d63eca7b84e13c27f55f0027b7b5_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note right of NF Service Consumer: 1. DELETE /namf_comm/v1/non-ue-n2-messages/subscriptions/{n2NotifySubscriptionId} + NF Service Consumer->>AMF: Request + Note left of AMF: 2. 204 No Content +Or 4xx/5xx (ProblemDetails) Or 3xx + AMF-->>NF Service Consumer: Response + +``` + +Sequence diagram for NonUeN2InfoUnSubscribe. The NF Service Consumer sends a DELETE request to the AMF. The AMF responds with a 204 No Content or an error status code. + +**Figure 5.2.2.4.3.1-1 NonUeN2InfoUnSubscribe for Non UE Specific Information** + +1. The NF Service Consumer shall send a DELETE request to delete an existing subscription resource in the AMF. +2. If the request is accepted, the AMF shall reply with the status code 204 indicating the resource identified by subscription ID is successfully deleted, in the response message. + +On failure or redirection, one of the HTTP status codes together with the response body listed Table 6.1.3.10.3.1-3 shall be returned. + +### 5.2.2.4.4 NonUeN2InfoNotify + +#### 5.2.2.4.4.1 General + +The NonUeN2InfoNotify service operation is used during the following procedures: + +- Obtaining non-UE associated network assistance data (See clause 4.13.5.6 in 3GPP TS 23.502 [3]) +- Receiving PWS related events from the NG-RAN +- Broadcast of Assistance Data by an LMF (see clause 6.14.1 of 3GPP TS 23.273 [42]). +- Monitoring of Timing synchronization status information (see clause 4.15.9.X of 3GPP TS 23.502 [3]). + +The NonUeN2InfoNotify service operation is invoked by the AMF to notify a NF Service Consumer that subscribed Non-UE N2 information has been received from the 5G-AN. + +The AMF shall use HTTP POST method to the N2Info Notification URI provided by the NF Service Consumer via NonUeN2InfoSubscribe service operation (See clause 5.2.2.4.2). See also Figure 5.2.2.4.4.1-1. + +![Sequence diagram for Non-UE N2 Information Notify. The AMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with a 204 No Content or an error status code.](dbcb760c24ceea4fb409492e549777e5_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note right of AMF: 1. POST {n2NotifyCallbackUri} (N2InformationNotification) + AMF->>NF Service Consumer: Request + Note left of NF Service Consumer: 2a. 204 No Content + NF Service Consumer-->>AMF: Response + Note left of NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer-->>AMF: Response + +``` + +Sequence diagram for Non-UE N2 Information Notify. The AMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with a 204 No Content or an error status code. + +**Figure 5.2.2.4.4.1-1 Non-UE N2 Information Notify** + +1. The AMF shall send a HTTP POST request to the N2Info Notification URI, and the content of the POST request shall contain a N2InformationNotification data structure, with the N2 information that was subscribed by the NF Service Consumer. +- 2a. On success, "204 No Content" shall be returned and the content of the POST response shall be empty. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.5.3.3.1-3 shall be returned. The message body shall contain a ProblemDetails object with "cause" set to one of the corresponding application errors listed in Table 6.1.5.3.3.1-3. + +#### 5.2.2.4.4.2 Using NonUeN2InfoNotify during Location Services procedures + +The NonUeN2InfoNotify service operation is invoked by a NF Service Producer, i.e. the AMF, towards the NF Service Consumer, e.g. the LMF, to notify the assistance data received from the 5G-AN. + +The requirements specified in clause 5.2.2.4.4.1 shall apply with the following modifications: + +1. If the corresponding N2 notification URI is not available, the AMF shall retrieve the NF profile of the NF Service Consumer (e.g. the LMF) from the NRF using the NF Instance Identifier received during "Obtaining Non UE Associated Network Assistance Data Procedure" or "Broadcast of Assistance Data by an LMF Procedure" (see clause 5.2.2.4.1.2), and further identify the corresponding service instance if Service Instance Identifier was also received, and fetch N2 Notification URI from the default subscription registered with "N2\_INFORMATION" notification type and "NRPPa" information class (See Table 6.2.6.2.3-1 and Table 6.2.6.2.4-1 of 3GPP TS 29.510 [29]). +2. Same as step 1 of Figure 5.2.2.4.4.1-1, the content shall contain network assistance data. + +#### 5.2.2.4.4.3 Use of NonUeN2InfoNotify for PWS related events + +The NonUeN2InfoNotify service operation shall be used during the following PWS related events: + +- 1) The AMF has received a Write-Replace-Warning-Response or a PWS-Cancel-Response from the NG-RAN over N2. + +Upon receiving the N2 Message Content the RAN Nodes return a response which may include the *Broadcast Completed Area List IE* or the *Broadcast Cancelled Area List IE*, depending on the *Message Type IE*. The AMF may aggregate the lists it receives from the RAN Nodes for the same request. + +If the *Send-Write-Replace-Warning Indication IE* was present in the Write-Replace-Warning Request message, then the AMF may forward the *Broadcast Completed Area List IE(s)* to the NF Service Consumer. If the NG-RAN node(s) have responded without the *Broadcast Completed Area List IE* then the AMF shall include the NG-RAN node ID(s) in "bcEmptyAreaList" attribute in the request body. + +If the *Send-Stop-Warning Indication IE* was present in the Stop-Warning-Request message, then the AMF may forward the *Broadcast Cancelled Area List IE(s)* to the NF Service Consumer. If the NG-RAN node(s) have responded without the *Broadcast Cancelled Area List IE* then the AMF shall include the NG-RAN node ID(s) in "bcEmptyAreaList" attribute in the request body. + +- 2) The AMF has received a Restart Indication or a Failure Indication from a NG-RAN Node. The AMF shall forward the Restart Indication or Failure Indication to the NF Service Consumer. + +The requirements specified in clause 5.2.2.4.4.1 shall apply with the following modifications: + +- Same as step 1 of Figure 5.2.2.4.4.1-1, the request body shall include the PWS related N2 information. + +#### 5.2.2.4.4.4 Using NonUeN2InfoNotify during network timing synchronization status monitoring procedure + +The NonUeN2InfoNotify service operation is invoked by a NF Service Producer, i.e. the AMF, towards the NF Service Consumer, e.g. the TSCTSF, to notify the RAN timing synchronization status information from the 5G-AN. + +The requirements specified in clause 5.2.2.4.4.1 shall apply with the following modifications: + +- Same as step 1 of Figure 5.2.2.4.4.1-1, the request body shall include the RAN Timing Synchronization Status Report message for TSS related N2 information. + +Editor's note: Further details on NGAP "RAN Timing Synchronization Status Report" to be aligned with RAN WG3, and it shall be specified in clause 6.1.6.4.3.3 + +## 5.2.2.5 AMF Status Change Operations + +### 5.2.2.5.1 AMFStatusChangeSubscribe + +#### 5.2.2.5.1.1 General + +This service operation is used by a NF Service Consumer to subscribe the status change of the AMF. + +The AMFStatusChangeSubscribe service operation is used during the following procedure: + +- AMF planned removal procedure (see 3GPP TS 23.501 [2], clause 5.21.2.2) + +#### 5.2.2.5.1.2 Creation of a subscription + +This service operation creates a subscription so a NF Service Consumer can request to be notified when the status of the AMF is changed. + +It is executed by creating a new individual resource under the collection resource "subscriptions". The operation shall be invoked by issuing a POST request on the URI of the "subscriptions collection" resource (See clause 6.1.3.6.3.1). + +![Sequence diagram showing the interaction between an NF Service Consumer and an AMF for subscription creation. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 201 Created status (2a) or a 4xx/5xx status (2b).](f9528ea5b0d2cd0192b7242e5a6af969_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note right of NF Service Consumer: 1. POST .../subscriptions/(subscriptionData) + NF Service Consumer->>AMF: Request + Note left of AMF: 2a. 201 Created (createdSubscriptionData) + AMF-->>NF Service Consumer: Response 2a + Note left of AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: Response 2b + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an AMF for subscription creation. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 201 Created status (2a) or a 4xx/5xx status (2b). + +Figure 5.2.2.5.1.1-1 NF Service Consumer Subscription to Notifications + +1. The NF Service Consumer shall send a POST request to the resource URI representing the "subscriptions" collection resource. The request body shall include the data indicating the GUAMI(s) supported by the AMF that the NF Service Consumer is interested in receiving the related status change notification. The request body also contains a callback URI, where the NF Service Consumer shall be prepared to receive the actual notification from the AMF (see AMFStatusChangeNotify operation in clause 5.2.2.5.3). +- 2a. On success, the AMF shall include a HTTP Location header to provide the location of a newly created resource (subscription) together with the status code 201 indicating the requested resource is created in the response message. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.6.3.1-3 shall be returned. For a 4xx/5xx response, the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.6.3.1-3. + +#### 5.2.2.5.1.3 Modification of a subscription + +This service operation updates the subscription data of an NF Service Consumer previously subscribed in the AMF by providing the updated subscription data to the AMF. The update operation shall apply to the whole subscription data (complete replacement of the existing subscription data by a new subscription data). + +The NF Service Consumer shall issue an HTTP PUT request, towards the URI of the "individual subscription" resource (See clause 6.1.3.7.3.2), as shown in Figure 5.2.2.5.1.3-1: + +![Sequence diagram for Subscription Data Complete Replacement. The NF Service Consumer sends a PUT request to the AMF. The AMF responds with either a 200 OK or 204 No Content (success), or a 4xx/5xx or 3xx status code (failure/redirection).](187d05bf7ead21e1394b61320d8b3632_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: 1. PUT « /subscriptions/{subscriptionId} (subscriptionData) » + NF Service Consumer->>AMF: Request + Note right of AMF: -2a. 200 OK (subscriptionData) or 204 No Content + AMF-->>NF Service Consumer: Success Response + Note right of AMF: -2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: Error/Redirect Response + +``` + +Sequence diagram for Subscription Data Complete Replacement. The NF Service Consumer sends a PUT request to the AMF. The AMF responds with either a 200 OK or 204 No Content (success), or a 4xx/5xx or 3xx status code (failure/redirection). + +**Figure 5.2.2.5.1.3-1 Subscription Data Complete Replacement** + +1. The NF Service Consumer shall send a PUT request to the resource URI representing the individual subscription. The request body shall include a representation of subscription data to replace the previous subscription data in the AMF. +- 2a. On success, "200 OK" shall be returned, the content of the PUT response shall contain the representation of the replaced resource. "204 No Content" may be returned, if the NF Service Producer accepts entirely the resource representation provided by the NF Service Consumer in the request. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.7.3.2-3 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.7.3.2-3. + +## 5.2.2.5.2 AMFStatusChangeUnSubscribe + +### 5.2.2.5.2.1 General + +This service operation removes an existing subscription to notifications. + +The AMFStatusChangeUnSubscribe service operation is used during the following procedure: + +- AMF planned removal procedure (see 3GPP TS 23.501 [2], clause 5.21.2.2) + +It is executed by deleting a given resource identified by a "subscriptionId". The operation is invoked by issuing a DELETE request on the URI of the specific "individual subscription" resource (See clause 6.1.3.7.3.1). + +![Sequence diagram for NF Service Consumer Unsubscription to Notifications. The NF Service Consumer sends a DELETE request to the AMF. The AMF responds with a 204 No Content (success), or a 4xx/5xx or 3xx status code (failure/redirection).](ae375ead8aa673286b534e079e9a8533_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: 1. DELETE ../subscriptions/{subscriptionId} () + NF Service Consumer->>AMF: Request + Note right of AMF: -2a. 204 No Content () + AMF-->>NF Service Consumer: Success Response + Note right of AMF: -2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: Error/Redirect Response + +``` + +Sequence diagram for NF Service Consumer Unsubscription to Notifications. The NF Service Consumer sends a DELETE request to the AMF. The AMF responds with a 204 No Content (success), or a 4xx/5xx or 3xx status code (failure/redirection). + +**Figure 5.2.2.5.2.1-1: NF Service Consumer Unsubscription to Notifications** + +1. The NF Service Consumer shall send a DELETE request to the resource URI representing the individual subscription. The request body shall be empty. +- 2a. On success, "204 No Content" shall be returned. The response body shall be empty. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.7.3.1-3 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.7.3.1-3. + +### 5.2.2.5.3 AMFStatusChangeNotify + +#### 5.2.2.5.3.1 General + +This service operation notifies each NF Service Consumer that was previously subscribed to receiving notifications of the status change of the AMF (e.g. AMF unavailable). The notification is sent to a callback URI that each NF Service Consumer provided during the subscription (see AMFStatusChangeSubscribe operation in 5.2.2.5.1). + +The AMFStatusChangeNotify service operation is used during the following procedure: + +- AMF planned removal procedure (see 3GPP TS 23.501 [2], clause 5.21.2.2) + +The operation is invoked by issuing a POST request to each callback URI of the different NF Service Consumer. + +![Sequence diagram showing AMF Notifications. The diagram illustrates the interaction between an NF Service Consumer and an AMF. The AMF sends a POST request to the NF Service Consumer's callback URI. The NF Service Consumer responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code.](9e9104f9ba7eec1259a7893c6380ca1b_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant NFSC as NF Service Consumer + Note left of AMF: 1. POST {amfStatusUri} (AmfStatusChangeNotification) + AMF->>NFSC: + Note right of NFSC: 2a. 204 No Content + NFSC-->>AMF: + Note right of NFSC: 2b. 4xx/5xx (ProblemDetails) Or 3xx + NFSC-->>AMF: + +``` + +Sequence diagram showing AMF Notifications. The diagram illustrates the interaction between an NF Service Consumer and an AMF. The AMF sends a POST request to the NF Service Consumer's callback URI. The NF Service Consumer responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code. + +**Figure 5.2.2.5.3.1-1: AMF Notifications** + +1. The AMF shall send a POST request to the callback URI. The request body shall include the GUAMI(s) and the related status change, GUAMI(s) is indicated by the NF Service Consumer during the subscription operation. For network deployment without UDSF case, the target AMF Name which is to serve the user of the indicated GUAMI(s) is also included. +- 2a. On success, "204 No content" shall be returned by the NF Service Consumer. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.5.2.3.1-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.5.2.3.1-2. + +### 5.2.2.6 EBIAssignment + +#### 5.2.2.6.1 General + +The EBIAssignment service operation is used during the following procedures (see 3GPP TS 23.502 [3], clause 4.11.1.4): + +- UE requested PDU Session Establishment including Request Types "Initial Request", "Existing PDU Session", "Initial emergency request" and "Existing emergency PDU session" (Non-roaming and Roaming with Local Breakout (see 3GPP TS 23.502 [3], clause 4.3.2.2.1). +- UE requested PDU Session Establishment including Request Types "Initial Request" and "Existing PDU Session" (Home-routed Roaming (see 3GPP TS 23.502 [3], clause 4.3.2.2.2). +- UE or network requested PDU Session Modification (non-roaming and roaming with local breakout) (see 3GPP TS 23.502 [3], clause 4.3.3.2). +- UE or network requested PDU Session Modification (home-routed roaming) (see 3GPP TS 23.502 [3], clause 4.3.3.3). +- UE Triggered Service Request (see 3GPP TS 23.502 [3], clause 4.2.3.2) to move PDU Session(s) from untrusted non-3GPP access to 3GPP access. +- Network requested PDU Session Modification, when the SMF needs to release the assigned EBI from a QoS flow (see 3GPP TS 23.502 [3], clause 4.11.1.4.3). + +The EBIAssignment service operation is invoked by a NF Service Consumer, e.g. a SMF, towards the NF Service Producer, i.e. the AMF, to request the AMF to allocate EPS bearer ID(s) towards EPS bearer(s) mapped from QoS flow(s) for an existing PDU Session for a given UE. + +EBI allocation shall apply only to: + +- QoS flows of Single Access PDU Session(s) via 3GPP access supporting EPS interworking with N26; +- QoS flows of Multi-Access PDU Session(s) supporting EPS interworking with N26, that are not only allowed over non-3GPP access. + +EBI allocation shall not apply to: + +- PDU Session(s) via 3GPP access supporting EPS interworking without N26, or; +- PDU Session(s) via non-3GPP access supporting EPS interworking; +- GBR QoS flow(s) that are only allowed over non-3GPP access in Multi-Access PDU Session(s) supporting EPS interworking. + +The EBIAssignment service operation is also invoked by an NF Service Consumer, e.g. an SMF, towards the NF Service Producer supporting the EAEA feature, i.e. the AMF, to request the AMF to update the mapping of EBI and ARP, if the ARP for a QoS flow that has already been allocated an EBI is changed during the network requested PDU Session Modification. + +The NF Service Consumer (e.g. the SMF) shall perform EBIAssignment service operation by invoking "assign-ebi" custom operation on the "individual ueContext" resource (See clause 6.1.3.2.4.3). See also Figure 5.2.2.6.1-1. + +![Sequence diagram illustrating the EBI Assignment process. Two rectangular boxes represent the NF Service Consumer (left) and the NF Service Producer (right). A dashed vertical line extends downwards from each box. The consumer sends a solid horizontal arrow to the producer. The producer responds with two dashed horizontal arrows pointing back to the consumer.](c3e8a7fe2e4f51806e05b9b1aae20d57_img.jpg) + +Sequence diagram illustrating the EBI Assignment process. Two rectangular boxes represent the NF Service Consumer (left) and the NF Service Producer (right). A dashed vertical line extends downwards from each box. The consumer sends a solid horizontal arrow to the producer. The producer responds with two dashed horizontal arrows pointing back to the consumer. + +**Figure 5.2.2.6.1-1 EBI Assignment** + +1. The NF Service Consumer, e.g. the SMF, shall invoke "assign-ebi" custom method on individual ueContext resource, which is identified by the UE's SUPI or PEI in the AMF. The NF Service consumer shall provide PDU Session ID and ARP list as input for the service operation. If the NF Service Consumer invokes this service operation to update the mapping of EBI and ARP for a QoS flow to which an EBI is already allocated in the AMF, the NF Service Consumer shall provide the PDU Session ID and modifiedEbiList. +- 2a. On success, the AMF shall assign EBI for each ARP in received ARP list, if enough EBI(s) are available. If there is not enough EBI(s) available, the AMF may revoke already assigned EBI(s) based on the ARP(s) and the S-NSSAI of the PDU session for which the request was received, EBIs information in the UE context and local policies. The AMF may only assign a subset of the requested EPS Bearer ID(s), e.g. when other PDU Sessions with higher ARP have occupied other available EPS Bearer IDs. If AMF has successfully assigned all or part of the requested EBI(s), the AMF shall respond with the status code 200 OK, together with the assigned EBI to ARP mapping(s), the list of ARPs for which the AMF failed to allocate an EBI (if any) and the list of EBI(s) released for this PDU session due to revocation based on ARP(s) and the S-NSSAI (if any). + +If the request contains "releasedEbiList", the AMF shall release the requested EBI(s). The AMF shall respond with the status code 200 OK and shall include the EBI(s) released in the "releasedEbiList" IE of the POST response body. The "releasedEbiList" in the request shall be handled before the EBI assignment in AMF. + +If the same EBI(s) are both in the "releasedEbiList" and "assignedEbiList", the NF service consumer considers that EBI(s) have been released and reassigned. + +If the request contains "modifiedEbiList", the AMF shall store the association of the assigned EBI and ARP pair to the corresponding PDU Session ID. The AMF shall respond with the status code 200 OK and shall include the EBI(s) with ARP updated in the "modifiedEbiList" IE of the POST response body. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.4.3.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain an AssignEbiError structure, including: +- a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.2.4.3.2-2; + - a failureDetails which describes the details of the failure including the list of ARPs for which the EBI assignment failed. + +## 5.3 Namf\_EventExposure Service + +### 5.3.1 Service Description + +The AMF may offer this service as a Service Producer to enable an NF to subscribe to event notifications on its own or on behalf of another NF and get notified about an event. The known Service Consumers are NEF, SMF, UDM, NWDAF, DCCF, LMF, TSCTSF and GMLC. See also clause 5.34.7 of 3GPP TS 23.501 [2] and clauses 4.15.1, 4.15.3.2, 4.15.4.2 and 5.2.2.3.1 of 3GPP TS 23.502 [3], clause 6.2.2 in 3GPP TS 23.288 [38]. + +The following events are provided by Namf\_EventExposure Service: + +#### Event: Location-Report + +A NF subscribes to this event to receive the Last Known Location or the Current Location of a UE or a group of UEs or any UE, and Updated Location of any of these UEs when AMF becomes aware of a location change of any of these UEs with the granularity as requested. + +This event implements the "Location Reporting" event in table 4.15.3.1-1 of 3GPP TS 23.502 [3]. + +UE Type: One UE, Group of UEs, any UE + +Report Type: One-Time Report, Continuous Report (See NOTE 1), Periodic Report (See NOTE 1 and 2) + +Input: UE-ID(s), "ANY\_UE", optional filters: TAI, Cell-ID, N3IWF, UE-IP, UDP-PORT, TNAP ID, TWAP ID, Global Line Id + +Notification: UE-ID, filtered updated location (TAI, Cell-ID for 3GPP access, most recent N3IWF node, UE local IP address and UDP source port number for non-3GPP access, TNAP ID, TWAP ID, Global Line Id). + +NOTE 1: Support of Continuous Report or Periodic Report should be controlled by operator policy. + +NOTE 2: For Periodic Report, UE Last Known Location is reported if the UE is in CM-IDLE state when the report is being generated. + +#### Event: Presence-In-AOI-Report + +A NF subscribe to this event to receive the current present state of a UE or a group of UEs or any UE in a specific Area of Interest (AOI), and notification when a specified UE enters or leaves the specified area. The area could be identified by a TA list, a NG-RAN node ID list, a cell ID list, an area ID or specific interested area name like "LADN". + +For one-time reporting or for the first notification of Continuous reporting, the AMF shall generate the notification as following: + +- when the event subscription is targeting a UE or a group of UEs, the AMF shall report the current presence status of the target UE(s); +- when the event subscription is targeting any UE, the AMF shall only report the UEs that are "IN" the Area of Interest (AOI); if no UE is currently "IN" the Area of Interest (AOI), the AMF shall generate a report only including the AnyUe indication (without any UE ID) and the subscribed AOI with the presence status set to "IN". The NF consumer should consider other UEs served by the AMF are "OUT" of the AOI or with "UNKNOWN" state. + +In subsequent notifications, the AMF shall only report the UE(s) whose presence status has changed compared to the previous notification sent by the AMF. + +If the event subscription indicates that the AoI may be adjusted based on the UE's Registration Area, the AMF shall report that the UE is IN the AoI if the UE is inside a Registration Area which contains at least one Tracking Area that is contained within the Area of Interest (see clause 5.3.4.4 of 3GPP TS 23.501 [2] and clauses 4.15.9.3.2, 4.15.9.4, 5.2.2.3.1 and Annex D.1 of 3GPP TS 23.502 [3]). + +If the subscription to the Presence-In-AOI-Report event includes the "RAN timing synchronization status change event" indication and the UE indicated support for network reconnection due to RAN timing synchronization status change, the AMF shall report the UE presence in AoI based on the most recent N2 connection as described in clause 5.3.4.4 of 3GPP TS 23.501 [2] and Annex D.1 of 3GPP TS 23.502 [3]. + +For an AMF supporting the AOIEF feature (AOI Event Filters for Subscriptions targeting any UE, see clause 6.2.8), a subscription to the Presence-In-AOI-Report event targeting Any UE may include: + +- the notifyForSupiList IE to request the AMF to notify the NF service consumer about AOI events only if the event is for a UE belonging to the provided list of SUPIs; and/or +- the notifyForSnssaiDnnList IE to request the AMF to notify the NF service consumer about AOI events only if the event is for a UE having a PDU session established for the provided DNN(s)/S-NSSAI(s). + +If a subscription to the Presence-In-AOI-Report event targeting Any UE includes both the notifyForSupiList and the notifyForSnssaiDnnList IEs, the AMF shall notify the NF service consumer about AOI events only if the event is for a UE fulfilling all the related conditions specified above. + +UE Type: One UE, Group of UEs, any UE + +Report Type: One-Time Report, Continuously Report + +Input: UE ID(s), "ANY\_UE", Area identifier (a TA list, a NG-RAN node ID list, a cell ID list, an area Id or "LADN"), S-NSSAI, NSI ID, Adjust AoI based on RA indication, RAN timing synchronization status change indication, optional filters (Notify the NF service consumer only for UEs in the notifyForSupiList, Notify the NF service consumer only for UEs having a PDU session established with a DNN/S-NSSAI in the notifyForSnssaiDnnList IE). + +Notification: UE-ID(s), Area identifier, Presence Status (IN/OUT/UNKNOWN) + +Event: Time-Zone-Report + +A NF subscribes to this event to receive the current time zone of a UE or a group of UEs, and updated time zone of the UE or any UE in the group when AMF becomes aware of a time zone change of the UE. + +UE Type: One UE, Group of UEs + +Report Type: One-Time Report, Continuous Report + +Input: UE ID(s) + +Notification: UE-ID, most recent time-zone + +Event: Access-Type-Report + +A NF subscribes to this event to receive the current access type(s) of a UE or a group of UEs or any UE, and updated access type(s) of any of the UEs when AMF becomes aware of the access type change of any of these UEs. The area could be identified by a TA list, an area ID or specific interested area name like "LADN". + +UE Type: One UE, Group of UEs, any UE + +Report Type: One-Time Report, Continuous Report + +Input: UE ID(s), "ANY\_UE", optionally filters: Area identifier (a TA list, an area Id or "LADN") + +Notification: UE ID, most recent access-types (3GPP, Non-3GPP) + +Event: Registration-State-Report + +A NF subscribes to this event to receive the current registration state of a UE or a group of UEs or any UE, and report for updated registration state of any of these UEs when AMF becomes aware of a registration state change of any of these UEs. The area could be identified by a TA list, an area ID or specific interested area name like "LADN". + +UE Type: One UE, Group of UEs, any UE + +Report Type: One-Time Report, Continuous Report + +Input: UE ID(s), "ANY\_UE", optionally filters: Area identifier (a TA list, an area Id or "LADN") + +Notification: UE ID, most recent registration state (REGISTERED/DEREGISTERED) with access type + +Event: Connectivity-State-Report + +A NF subscribes to this event to receive the current connection management state of a UE or a group of UEs, and report for updated connection management state of a UE or any UE in the group when AMF becomes aware of a connection management state change of the UE. + +UE Type: One UE, Group of UEs + +Report Type: One-Time Report, Continuous Report + +Input: UE ID(s) + +Notification: UE ID, most recent connection management state (IDLE/CONNECTED) with access type + +Event: Reachability-Report + +A NF subscribes to this event for "UE Reachability Status Change" to receive the current reachability state of a UE or a group of UEs in the AMF, and report for updated reachability state of a UE or any UE in the group when AMF becomes aware of a reachability state change of the UEs between REACHABLE, UNREACHABLE, REGULATORY\_ONLY. The following conditions apply: + +- the AMF shall send a Reachability Report ("UNREACHABLE") if the Mobile Reachable Timer expires (see clause 5.4.1.1 of 3GPP TS 23.501 [2]) or the UE enters CM-IDLE when it is only registered over the Non-3GPP access (see clause 5.5.3 of 3GPP TS 23.501 [2]); +- the AMF shall send a Reachability Report ("REGULATORY\_ONLY") if the UE becomes reachable only for regulatory prioritized service (see clause 4.15.4.2 of 3GPP TS 23.502 [3]); + +- the AMF shall send a Reachability Report ("REACHABLE") when the UE reachability state changes from any of the two above states to REACHABLE. + +NOTE 3: The AMF does not send a Reachability Report ("UNREACHABLE") in particular when the UE enters extended DRX cycle (see clause 5.31.7.2.2.3 of 3GPP TS 23.501 [2]), the UE enters power saving state (see clause 5.31.8 of 3GPP TS 23.501 [2]), the UE enters CM IDLE in MICO mode (see clause 5.4.1.3 of 3GPP TS 23.501 [2]), or when the UE does not respond to a paging request. + +An NF subscribes to this event for "UE Reachable for DL Traffic" to receive reports of a UE or a group of UEs when the UE becomes reachable for sending downlink data. In this case, the event is detected when the UE transitions to CM-CONNECTED mode or when the UE will become reachable for paging, as specified in table 4.15.3.1-1, clauses 4.2.5 and 4.3.3 of 3GPP TS 23.502 [3]. When reporting the "UE Reachable for DL Traffic", the AMF shall also indicate the access types through which the UE is reachable. + +NOTE 4: The AMF does not send an event report for "UE Reachable for DL Traffic" immediately after an UECM Registration in UDM, if the AMF has previously been indicated that reachability event will be detected at UDM. The UDM will detect the UE reachability from the UECM Registration and send a notification to the NF consumer (unless the UDM is indicated that the UE is currently not reachable, as specified in clause 5.3.2.2.2 of 3GPP TS 29.503 [35]), thus the notification report from AMF is omitted. + +UE Type: One UE, Group of UEs + +Report Type: One-Time Report, Continuous Report + +Input: UE ID(s), (optional) Reachability Filter + +Notification: UE ID, AMF Id, most recent reachability state + +(REACHABLE/UNREACHABLE/REGULATORY\_ONLY), access type(s) through which the UE is reachable. + +Event: Communication-Failure-Report + +A NF subscribes to this event to receive the Communication failure report of a UE or group of UEs or any UE, when the AMF becomes aware of a RAN or NAS failure event. + +This event implements the "Communication failure" event in table 4.15.3.1-1 of 3GPP TS 23.502 [3], which is an unexpected termination of the communication. + +UE Type: One UE, Group of UEs, any UE + +Report Type: One-Time Report, Continuous Report + +Input: UE ID(s), "ANY\_UE", optionally filters: Area identifier (a TA list, an area Id or "LADN") + +Notification: UE ID, RAN/NAS release code. + +Event: UEs-In-Area-Report + +A NF subscribes to this event to receive the number of UEs in a specific area. A NF may ask AMF for the UEs within the area based on Last Known Location or it may request AMF to actively look for the UEs within the area based on Current Location. + +This event implements the "Number of UEs present in a geographical area" event in table 4.15.3.1-1 of 3GPP TS 23.502 [3]. + +UE Type: any UE + +Input: "ANY\_UE", Area identified in a TA List or cell ID list, optionally Ue in Area filters: UE Aerial Indication, Indication of PDU session established for DNN(s) subject to aerial service, indication to omit UE IDs in the event reports + +Report Type: One-Time Report (See NOTE 3), Continuous Report (See NOTE 4), Periodic Report (See NOTE 4) + +Notification: Number of UEs in the area, and if eNA is supported also the UE IDs + +NOTE 5: For an Immediate Report, UE Last Known Location is used to count the UEs within the area. + +NOTE 6: Support of Continuous Report or Periodic Report should be controlled by operator. + +Event: Loss-of-Connectivity + +An NF subscribes to this event to receive the event report of a UE or group of UEs when AMF detects that a target UE is no longer reachable for either signalling or user plane communication. Such condition is identified when Mobile Reachable timer expires in the AMF (see 3GPP TS 23.501 [2]), when the UE detaches, when AMF deregisters from UDM for an active UE and when UE indicates Unavailability Period by including Unavailability Period Duration during Mobility Registration or Deregistration procedure. If the UE is already not reachable for either signalling or user plane communication when the event is subscribed, the AMF reports the event directly, and shall include, when applicable, the remaining value of Unavailability Period Duration to determine the foreseen Loss of Connectivity time. If the UE included Start of + +Unavailability Period, the event is reported when unavailability period starts, else the event is reported immediately, if subscribed. + +This event implements the "Loss of Connectivity" event in table 4.15.3.1-1 of 3GPP TS 23.502 [3]. + +UE Type: One UE, Group of UEs. + +Report Type: One-Time Report, Continuous Report + +Input: UE ID(s) + +Notification: UE ID, optionally Unavailability Period Duration. + +Event: 5GS-User-State-Report + +A NF subscribes to this event to receive the 5GS User State of a UE. + +UE Type: One UE + +Report Type: One-Time Report + +Input: UE ID(s) + +Notification: UE ID, 5GS User State + +Event: Availability-after-DDN-failure + +A NF subscribes to this event to be notified about the Availability of a UE after a DDN failure. + +UE Type: One UE, Group of UEs + +Report Type: One-Time Report, Continuous Report + +Input: UE ID(s) + +Notification: UE ID(s) + +Event: Type-Allocation-Code-Report + +A NF subscribes to this event to receive the TAC of a UE or a group of UEs or any UE. + +UE Type: One UE, Group of UEs, any UE + +Report Type: One-Time Report, Continuous Report + +Input: UE ID(s), "ANY\_UE", optionally filters: TAI, Area identifier (a TA list, an area Id or "LADN") + +Notification: UE ID(s), TAC(s) + +Event: Frequent-Mobility-Registration-Report + +A NF subscribes to this event to receive the number of mobility registration during a period for a UE or a group of UEs or any UE. + +UE Type: One UE, Group of UEs, any UE + +Report Type: One-Time Report, Continuous Report + +Input: UE ID(s), expiry time, "ANY\_UE", optionally filters: Area identifier (a TA list, an area Id or "LADN") + +Notification: UE ID(s), Frequent Registration + +Event: Snssai-TA-Mapping-Report + +A NF subscribes to this event to receive the related access type and the list of supported S-NSSAIs. + +UE Type: any UE + +Report Type: One-Time Report, Continuous Report + +Input: Target Area: TA list or "ANY\_TAI", optionally filters: S-NSSAI(s) + +Notification: Access type, list of supported S-NSSAIs with an indication of restriction at the AMF + +Event: UE-Access-Behavior-Trends + +A NF subscribes to this event to receive the UE access behavior trends (e.g. access type change, handover, etc.) within a period for a UE or a group of UEs, as specified in clause 4.15.4.2 of 3GPP TS 23.502 [3]. + +UE Type: One UE, Group of UEs + +Report Type: Periodic Report + +Input: UE ID(s), expiry time + +Notification: UE ID(s), UE access behavior trends report. + +Event: UE-Location-Trends + +A NF subscribes to this event to receive the UE Location Trends within a period for a UE or a group of UEs, as specified in clause 4.15.4.2 of 3GPP TS 23.502 [3]. + +UE Type: One UE, Group of UEs + +Report Type: Periodic Report + +Input: UE ID(s), expiry time, Dispersion Area (e.g. a TAI list). + +Notification: UE ID(s), UE Location Trends report. + +Event: UE-MM-Transaction-Report + +A NF subscribes to this event to receive the Total Number of Mobility Management transactions during a period for a UE or a group of UEs, as specified in clause 5.2.2.3.1 of 3GPP TS 23.502 [3]. The Total number of + +transactions is incremented when the NAS signalling transactions from Authentication, Registration, De-Registration, Service Request and UE Configuration Update procedures is completed + +UE Type: One UE, Group of UEs + +Report Type: Periodic Report + +Input: UE ID(s), expiry time, filters: Dispersion Area (e.g. a TA list) or Slice filter (i.e. a list of S-NSSAIs) + +Notification: UE ID(s), List of UE transaction numbers per location or List of UE transaction numbers per slice. + +## 5.3.2 Service Operations + +### 5.3.2.1 Introduction + +For the Namf\_EventExposure service the following service operations are defined: + +- Subscribe; +- Unsubscribe; +- Notify. + +### 5.3.2.2 Subscribe + +#### 5.3.2.2.1 General + +The Service Operation is used by a NF Service Consumer (e.g. NEF) to subscribe to an event(s) for one UE, group of UE(s) or any UE. + +#### 5.3.2.2.2 Creation of a subscription + +The Subscribe service operation is invoked by a NF Service Consumer, e.g. NEF, towards the AMF, when it needs to create a subscription to monitor at least one event relevant to the AMF. The NF Service Consumer may subscribe to multiple events in a subscription. A subscription may be associated with one UE, a group of UEs or any UE. + +The NF Service Consumer shall request to create a new subscription by using HTTP method POST with URI of the subscriptions collection, see clause 6.2.3.2. + +The NF Service Consumer shall include the following information in the HTTP message body: + +- NF ID, indicates the identity of the network function instance initiating the subscription; +- Subscription Target, indicates the target(s) to be monitored, as one of the following types: + - A specific UE, identified with a SUPI, a PEI or a GPSI; + - A group of UEs, identified with a group identity; + - Any UE, identified by the "anyUE" flag. +- Notification URI, indicates the address to deliver the event notifications generated by the subscription; +- Notification Correlation ID, indicates the correlation identity to be carried in the event notifications generated by the subscription; +- List of events to be subscribed; +- Event Types per event, as specified in clause 5.3.1. + +The NF Service Consumer may include the following information in the HTTP message body: + +- Immediate Report Flag per event, indicates an immediate report to be generated with current event status; +- Event Trigger, indicates how the events shall be reported (One-time Reporting or Continuously Reporting). +- Maximum Number of Reports, defines the maximum number of reports after which the event subscription ceases to exist; +- Expiry, defines maximum duration after which the event subscription ceases to exist; + +- Sampling ratio, defines the random subset of UEs among target UEs, and AMF only report the event(s) related to the selected subset of UEs; +- partitioning criteria, that defines Criteria for partitioning UEs before applying sampling ratio; +- Periodic Report Flag per event, indicates the report to be generated periodically; +- Repetition Period, defines the period for periodic reporting; +- Variable reporting periodicity information, defines the list of conditions related to Reporting periodicity and the period per condition. +- Event Filters per applicable event, defines further options on when/how the event shall be reported; +- Reference Id per event, indicates the value of the Reference Id associated with the event to be monitored. If provided, the Reference Id shall be included in the reports triggered by the event; +- a notification flag as "notifFlag" attribute if the EneNA feature is supported; and/or +- Muting Exception Instructions, which specify instructions to apply to the subscription and the stored events when an exception occurs at the AMF while the event is muted (e.g., the buffer of stored event reports is full, or the number of stored event reports exceeds a certain number), if the ENAPH3 feature is supported (see clause 6.2.8). + +![Sequence diagram showing the interaction between an NF Service Consumer and an AMF for subscription creation. The NF Service Consumer sends a POST request to the AMF. The AMF responds with a 201 Created status (with optional event report) or a 4xx/5xx (ProblemDetails) or 3xx status.](03d9aaba6c1af8bfd8e42c1d2422ae5c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: NF Service Consumer + Note right of AMF: AMF + NF Service Consumer->>AMF: 1. POST .../subscriptions (AmfCreateEventSubscription) + AMF-->>NF Service Consumer: -2a. 201 Created (AmfCreatedEventSubscription (with optional event report)) + AMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an AMF for subscription creation. The NF Service Consumer sends a POST request to the AMF. The AMF responds with a 201 Created status (with optional event report) or a 4xx/5xx (ProblemDetails) or 3xx status. + +**Figure 5.3.2.2.2-1 Subscribe for Creation** + +- The NF Service Consumer shall send a POST request to create a subscription resource in the AMF. The content of the POST request shall contain a representation of the individual subscription resource to be created. The request may contain an expiry time, suggested by the NF Service Consumer as a hint, representing the time upto which the subscription is desired to be kept active and the time after which the subscribed event(s) shall stop generating report. +- On success, the request is accepted, the AMF shall include a HTTP Location header to provide the location of a newly created resource (subscription) together with the status code 201 indicating the requested resource is created in the response message. If the NF Service Consumer has included more than one events in the event subscription and some of the events are failed to be subscribed, the AMF shall accept the message and provide the successfully subscribed event(s) in AmfEventSubscription. If the NF Service Consumer has included the immediateFlag with value as "true" in the event subscription, the AMF shall include the current status of the events subscribed, if available (e.g. last known location information is included if the subscribed event is LOCATION\_REPORT). If the events with immediateFlag set to "true" are subscribed by an NF service consumer on behalf of a third NF and the NF service consumer has not indicated supporting of IERSR feature (see 6.2.8), the notification will be sent to the third NF directly, i.e. subsChangeNotifyUri is included in the event subscription, the current status of the events subscribed shall not be included in response. The AMF shall subsequently send a notification to the third NF including the current status of the events subscribed. + +If the NF Service Consumer has set the event reporting option as ONE\_TIME and if the AMF has included the current status of the events subscribed in the response, then the AMF shall not do any subsequent event notification for the events given in the AmfCreateEventSubscription parameter. If the NF Service Consumer has set the event reporting option as ONE\_TIME, the subscribed event as LOCATION\_REPORT and the immediateFlag is set to false or absent, the AMF shall send an event notification to notify the current location of the UE after the subscription; if the UE is in RM-REGISTERED and CM-IDLE state over 3GPP access and the UE does not respond to the paging, or if the UE is in RM-REGISTERED over non-3GPP access, the event notification shall include the last known location and the ageOfLocationInformation IE set to a value other than "0", which indicates to the NF service consumer that the AMF returned the last known location. + +If the NF Service Consumer has set the CONTINUOUS or PERIODIC event reporting option, the subscribed event as LOCATION\_REPORT and the immediateFlag is set to false or absent, the AMF shall send a first event notification to notify the current location of the UE after the subscription is created and then subsequent event notifications when the user location changes or according to the requested period respectively; if at the time of the subscription creation the UE is in RM-REGISTERED and CM-IDLE state over 3GPP access and the UE does not respond to the paging, or if the UE is in RM-REGISTERED over non-3GPP access, the AMF shall send the first event notification including the last known location and the ageOfLocationInformation IE set to a value other than "0", which indicates to the NF service consumer that the AMF returned the last known location. + +The response, based on operator policy and taking into account the expiry time included in the request, may contain the expiry time, as determined by the AMF, after which the subscription becomes invalid. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the AMF. The AMF shall not provide the same expiry time for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. If the expiry time is not included in the response, the NF Service Consumer shall consider the subscription to be valid without an expiry time. + +If the sampling ratio ("sampRatio") attribute is included in the subscription without a partitioningCriteria, the AMF shall select a random subset of UEs among target UEs according to the sampling ratio and only report the event(s) related to the selected subset of UEs. If the partitioningCriteria attribute is also included along with sampling ratio, the AMF shall apply the sampling ratio on the group of UEs determined according to the partitioning criteria. + +If the AMF supports the EneNA feature and the "notifFlag" attribute is included and set to "DEACTIVATE" in the request (by e.g. the NWDAF or DCCF), the AMF shall mute the event notification and store the available events. Additionally, if the AMF also supports the ENAPH3 feature (see clause 6.2.8) and the NF service consumer also included event muting instructions in the request, the AMF should evaluate the received event muting instructions against local actions (if configured) and, if the subscription creation request is accepted, the AMF may indicate the following information to the NF service consumer in the response: + +- the maximum number of notifications that the AMF expects to be able to store for the subscription; +- an estimate of the duration for which notifications can be buffered. + +If the NF service consumer is a UDM, the AMF and the UDM both support the "ESSYNC" feature and the subscription is targeting a specific UE with Reference Id(s) included in the subscription, the AMF shall locally store the information that the event subscription is subject to the Event Subscription Synchronization with UDM during EPS to 5GS mobility as specified in clause 5.3.2.4.2. During inter-AMF mobility procedures, the source AMF shall include the "eventSyncInd" IE (in AmfEventSubscriptionAddInfo data type) with the value "true" in the UE Context for the event subscriptions that are subject to Event Subscription Synchronization with UDM. + +If the subscription creation request targets a group of UE or any UE, the AMF shall accept the request and create a subscription even if the AMF does not currently serve any UE of the group or any UE respectively, unless other reasons exist to reject the request. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.2.3.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.2.3.2.3.1-3. + +If the subscription creation request targets a specific UE and this UE is not served by the AMF (i.e. it is not known to the AMF), the AMF shall reject the request with a 403 Forbidden response and the application error "UE\_NOT\_SERVED\_BY\_AMF", unless the request can be redirected to another AMF known to serve the UE (e.g. another AMF of the same AMF set). + +If the AMF supports the EneNA and ENAPH3 features (see clause 6.2.8), the NF service consumer sets the "notifFlag" attribute to "DEACTIVATE" and event muting instructions in the request, but the AMF cannot accept the received instructions, the AMF may reject the request with a 403 Forbidden response and the application error "MUTING\_EXC\_INSTR\_NOT\_ACCEPTED". + +### 5.3.2.2.3 Modification of a subscription + +The Subscribe service operation is invoked by a NF Service Consumer, e.g. NEF, towards the AMF, when it needs to modify an existing subscription previously created by itself at the AMF. + +The NF Service Consumer shall modify the subscription by using HTTP method PATCH with the URI of the individual subscription resource (see clause 6.2.3.3) to be modified. + +See also Figure 5.3.2.2.3-1 below. + +![Sequence diagram showing the modification of a subscription. The NF Service Consumer sends a PATCH request to the AMF. The AMF responds with either a 200 OK (AmfUpdatedSubscriptionData) or a 4xx/5xx (ProblemDetails) or 3xx status code.](65e8c0628536d6d4245e9ab46ba070c3_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note right of NF Service Consumer: 1. PATCH .../subscriptions/{subscriptionId} (AmfUpdateEventSubscriptionItem) or +PATCH .../subscriptions/{subscriptionId} (AmfUpdateEventOptionItem) + NF Service Consumer->>AMF: 1. PATCH request + AMF-->>NF Service Consumer: 2a. 200 OK (AmfUpdatedSubscriptionData) + AMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the modification of a subscription. The NF Service Consumer sends a PATCH request to the AMF. The AMF responds with either a 200 OK (AmfUpdatedSubscriptionData) or a 4xx/5xx (ProblemDetails) or 3xx status code. + +**Figure 5.3.2.2.3-1 Modification of a Subscription** + +- The NF Service Consumer shall send a PATCH request to modify a subscription resource in the AMF. The modification may be for the events subscribed or for updating the event options. +- On success, the request is accepted, the AMF shall return the representation of the modified subscription resource or its sub-resource together with the status code 200 OK. When the PATCH request is for modifying the expiry attribute of the options IE of the subscription, then the AMF based on operator policies and taking into account the expiry time included in the request, shall include an expiry time, after which the subscription becomes invalid. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the AMF, as specified in clause 5.3.2.2.2. The AMF shall not provide the same expiry time for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. + +The PATCH request may be used to modify the "notifFlag" attribute of the options IE of the subscription, when both the AMF and NF Service Consumer support the EneNA feature as defined in clause 6.2.8: + +- if the "notifFlag" attribute is set to "DEACTIVATE" in the request and the event notification is currently not muted, the AMF shall mute the event notification and store the available events, or +- if the "notifFlag" is set to "RETRIEVAL" in the request and the event notification is currently muted, the AMF shall send the stored events to the NF service consumer, mute the event notification again and store available events; or +- if the "notifFlag" is set to "ACTIVATE" in the request and the event notification is currently muted, the AMF shall send the stored events to the NF service consumer and stop muting the event notification. + +In addition, if both the AMF and the NF service consumer (e.g. NWDAF or DCCF) also support the ENAPH3 feature (see clause 6.2.8), the PATCH request modifies the "notifFlag" attribute to "DEACTIVATE" and contains muting exception instructions, the AMF should evaluate the received event muting instructions against local actions (if configured) and, if the subscription modification request is accepted, the AMF may indicate the following information to the NF service consumer in the response: + +- the maximum number of notifications that the AMF expects to be able to store; +- an estimate of the duration for which notifications can be buffered. + +If the subscription requested to be modified targets a group of UE or any UE, the AMF shall accept the request and modify the subscription even if the AMF does not currently serve any UE of the group or any UE respectively, unless other reasons exist to reject the request. + +- On failure or redirection, one of the HTTP status codes listed in Table 6.2.3.3.1-3 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.2.3.3.1-3. + +If the AMF cannot accept the received muting exception instructions, the AMF may reject the request with a 403 Forbidden response and the application error "MUTING\_EXC\_INSTR\_NOT\_ACCEPTED". + +#### 5.3.2.2.4 Remove or add group member UE(s) for a group subscription + +The Subscribe service operation is invoked by a NF Service Consumer, e.g. UDM, towards the AMF, to remove or add group member UE(s) for an existing group subscription. + +The NF Service Consumer shall modify the subscription by using HTTP method PATCH with the URI of the individual subscription resource (see clause 6.2.3.3) to be modified. + +See also Figure 5.3.2.2.4-1 below. + +![Sequence diagram for Figure 5.3.2.2.4-1: Remove or add group member UE(s) for a group subscription. The diagram shows an NF Service Consumer sending a PATCH request to the AMF. The AMF responds with either a 200 OK (AmfUpdatedSubscriptionData) or a 4xx/5xx (ProblemDetails) or 3xx status code.](56a5265d174ce056c1dbe5e7a60839fc_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: 1. PATCH « subscriptions/{subscriptionId} (AmfUpdateEventSubscriptionItem) » + NF Service Consumer->>AMF: Request + Note right of AMF: 2a. 200 OK (AmfUpdatedSubscriptionData) + AMF-->>NF Service Consumer: Success Response + Note right of AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: Error Response + +``` + +Sequence diagram for Figure 5.3.2.2.4-1: Remove or add group member UE(s) for a group subscription. The diagram shows an NF Service Consumer sending a PATCH request to the AMF. The AMF responds with either a 200 OK (AmfUpdatedSubscriptionData) or a 4xx/5xx (ProblemDetails) or 3xx status code. + +**Figure 5.3.2.2.4-1 Remove or add group member UE(s) for a group subscription** + +1. The NF Service Consumer shall send a PATCH request to modify a subscription resource targeting a group of UEs in the AMF. The modification shall indicate the group member UE(s) to be excluded or added for the group subscription. +- 2a. On success, the request is accepted, the AMF shall return the representation of the modified subscription resource with the status code 200 OK. + +The AMF shall stop monitoring events for excluded member UE(s). If Maximum number of Reports is applied, the AMF shall set the number of reports of the indicated UE(s) to Maximum Number of Reports. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.2.3.3.3.1-3 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.2.3.3.3.1-3. + +## 5.3.2.3 Unsubscribe + +### 5.3.2.3.1 General + +The Unsubscribe service operation is invoked by a NF Service Consumer, e.g. NEF, towards the AMF, to remove an existing subscription previously created by itself at the AMF. + +The NF Service Consumer shall unsubscribe to the subscription by using HTTP method DELETE with the URI of the individual subscription resource (see clause 6.2.3.3) to be deleted. + +![Sequence diagram for Figure 5.3.2.3.1-1: Unsubscribe a subscription. The diagram shows an NF Service Consumer sending a DELETE request to the AMF. The AMF responds with either a 204 No Content or a 4xx/5xx (ProblemDetails) or 3xx status code.](9cd7ec4a653f07d02def283cb6f2309e_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: 1. DELETE .../subscriptions/{subscriptionId} + NF Service Consumer->>AMF: Request + Note right of AMF: 2a. 204 No Content + AMF-->>NF Service Consumer: Success Response + Note right of AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: Error Response + +``` + +Sequence diagram for Figure 5.3.2.3.1-1: Unsubscribe a subscription. The diagram shows an NF Service Consumer sending a DELETE request to the AMF. The AMF responds with either a 204 No Content or a 4xx/5xx (ProblemDetails) or 3xx status code. + +**Figure 5.3.2.3.1-1 Unsubscribe a subscription** + +1. The NF Service Consumer shall send a DELETE request to delete an existing subscription resource in the AMF. +- 2a. On success, the request is accepted, the AMF shall reply with the status code 204 indicating the resource identified by subscription ID is successfully deleted in the response message. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.2.3.3.3.2-3 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.2.3.3.3.2-3. + +### 5.3.2.4 Notify + +#### 5.3.2.4.1 General + +The Notify service operation is invoked by the AMF, to send a notification, towards the notification URI, when certain event included in the subscription has taken place. + +The AMF shall use the HTTP method POST, using the notification URI received in the subscription creation as specified in clause 5.3.2.2.2, including e.g. the subscription ID, Event ID(s) for which event has happened, notification correlation ID provided by the NF service consumer at the time of event subscription, to send a notification. See Figure 5.3.2.4.1-1. + +Additionally, the Notify service operation shall also be invoked by the AMF, when: + +- there is a change of AMF during UE mobility procedures, if the subscription Id changes (i.e. Registration procedures and Handover procedures), or +- the subscription is terminated by the AMF, if event subscription termination notification is requested by the NF consumer. + +![Sequence diagram showing the Notify service operation between an NF Service Consumer and an AMF. The AMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content or a 4xx/5xx (ProblemDetails) or 3xx status code.](ae0dd5533e0b7fd2db452b5e2fdf8e5b_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant NFSC as NF Service Consumer + Note left of AMF: 1. POST {eventNotificationUrl}(AmfEventNotification) + AMF->>NFSC: 1. POST {eventNotificationUrl}(AmfEventNotification) + Note right of NFSC: 2a. 204 No Content + NFSC-->>AMF: 2a. 204 No Content + Note right of NFSC: 2b. 4xx/5xx (ProblemDetails) Or 3xx + NFSC-->>AMF: 2b. 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram showing the Notify service operation between an NF Service Consumer and an AMF. The AMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content or a 4xx/5xx (ProblemDetails) or 3xx status code. + +Figure 5.3.2.4.1-1 Notify + +1. The AMF shall send a POST request to send a notification. +- 2a. On success, "204 No content" shall be returned by the NF Service Consumer. +- 2b. On failure or redirection, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned and appropriate additional error information should be returned. + +When the AMF received the following response code (and application error), the AMF should consider the subscription is no longer valid and terminate the subscription: + +- "400 Bad Request" with application error "RESOURCE\_CONTEXT\_NOT\_FOUND" +- "404 Not Found" + +When AMF terminates the subscription in above scenarios, if the subscription is created by the NF consumer on behalf of another NF (e.g. the UDM subscribes to the AMF on behalf of the NEF) and notification of event subscription termination is requested by the NF consumer, the AMF supporting the 'STEN' feature shall send a notification to the NF consumer (e.g. the UDM) to report the termination of the subscription. + +#### 5.3.2.4.2 Event Subscription Synchronization for specific UE + +When the AMF and the UDM both support the "ESSYNC" feature, the AMF may initiate synchronization for event subscriptions with the UDM for the specific UE during EPS to 5GS mobility registration procedure (see clause 4.11.5.2 of 3GPP TS 23.502 [3]), if UE specific event subscriptions from the UDM are available in UE Context. + +To initiate event subscription synchronization, when sending notification for subscription change to the UDM, the AMF shall include the event subscription information in the notification request. If subscription change notification is not needed, e.g. when UE registers to the same AMF after moving from EPS, the AMF may send a notification to the subscription change notification URI. The notification request in this case only includes the event subscription information but no event report list. + +The AMF shall only include active event subscriptions that are subject to Event Subscription Synchronization with UDM (determined as defined in clause 5.3.2.2.2) in the event subscription information. + +For each active subscription, the following information shall include: + +- URI of the subscription resource in the AMF; and +- Notification Correlation Id of the subscription; and +- list of Reference Ids, one per event in the subscription; and +- optionally, the URI of old subscription resource on the source AMF, if the subscription Id is changed during the mobility procedure. + +When the UDM receives event subscription information from AMF, the UDM shall compare the active event subscriptions in AMF with the active UDM Event Exposure subscriptions using Reference Id(s) and Notification Correlation Id, and perform the following: + +- if an event is to be detected by AMF but not existing in the AMF, the UDM shall subscribe the event in AMF by creating a new AMF event subscription or updating an existing AMF event subscription; +- if an event exists in AMF but does not exist in UDM, the UDM shall unsubscribe the event from AMF by removing or update an AMF event subscription. + +When the AMF identified that event synchronization with UDM is required, but either the UDM or the AMF or both do not support the "ESSYNC" feature, the AMF may require the UDM to re-subscribe the stored event exposure subscriptions to the AMF, see clause 5.3.2.2.2 and 5.3.2.2.3 of 3GPP TS 29.503 [35]. + +## 5.4 Namf\_MT Service + +### 5.4.1 Service Description + +Namf\_MT service allows a NF to request information related to capabilities to send MT signalling or data to a target UE. The following are the key functionalities of this NF service: + +- enabling UE reachability by: + - paging the UE if the UE is in CM-IDLE state and responding to the requester NF after the UE enters CM-CONNECTED state, or + - responding to the requester NF if UE is in CM-CONNECTED state. +- providing the terminating domain selection information for IMS voice to the consumer NF. +- enabling reachability of a list of UEs by: + - paging UEs for an MBS session if the UEs are in CM-IDLE state, and + - responding to the requester NF, including the list of UEs that are already in CM-CONNECTED state if any, and + - sending notification with the UE reachability information and user location information to NF consumers. + +### 5.4.2 Service Operations + +#### 5.4.2.1 Introduction + +For the Namf\_MT Service the following service operations are defined: + +- EnableUEReachability +- ProvideDomainSelectionInfo +- EnableGroupReachability +- UEReachabilityInfoNotify + +## 5.4.2.2 EnableUEReachability + +### 5.4.2.2.1 General + +The EnableUEReachability service operation is used in the following procedure: + +- MT SMS over NAS in CM-IDLE state (see 3GPP TS 23.502 [3], clause 4.13.3.6), or in CM-CONNECTED state (see 3GPP TS 23.502 [3], clause 4.13.3.7). +- UPF anchored Mobile Terminated Data Transport in Control Plane CIoT 5GS Optimisation (see clause 4.24.2 of 3GPP TS 23.502 [3]). +- Network Triggered Connection Resume in RRC Inactive with CN based MT communication handling (see clause 4.8.2.2b of 3GPP TS 23.502 [3]). + +The EnableUEReachability service operation shall be invoked by the NF Service Consumer (e.g. SMSF, SMF) to enable the reachability of the UE. + +The NF Service Consumer shall invoke the service by using the HTTP method PUT, towards the URI of a "ueReachInd" resource as specified in clause 6.3.3.2. See also figure 5.4.2.2.1-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and an AMF to enable UE reachability. The NF Service Consumer sends a PUT request to the AMF. The AMF responds with either a 200 OK (success) or a 4xx/5xx error (failure).](921458d4fc1b778c2450592ac9745b48_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: 1. PUT « /{ueContextId}/ue-reachind(EnableUeReachabilityReqData) » + NF Service Consumer->>AMF: Request + Note right of AMF: 2a. 200 OK (EnableUeReachabilityRspData) + AMF-->>NF Service Consumer: Success Response + Note right of AMF: 2b. 4xx/5xx (ProblemDetails / ProblemDetailsEnableUeReachability) or 3xx + AMF-->>NF Service Consumer: Error Response + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an AMF to enable UE reachability. The NF Service Consumer sends a PUT request to the AMF. The AMF responds with either a 200 OK (success) or a 4xx/5xx error (failure). + +**Figure 5.4.2.2.1-1: NF Service Consumer enables the reachability of the UE** + +1. The NF Service Consumer sends a PUT request to the resource representing the ueReachInd resource of the AMF. The content of the PUT request shall contain an "EnableUeReachabilityReqData" object. + +During the Network Triggered Connection Resume in RRC Inactive with CN based MT communication handling (see clause 4.8.2.2b of 3GPP TS 23.502 [3]), the SMF may include the ppi, the arp, the qfi and the 5qi of the QoS flow of the PDU session for which DL packets are received, together with the PDU session identifier, to enable NG-RAN to take this information into account when paging the UE. + +The SMF shall send a new Namf\_MT\_EnableUEReachability request with a higher priority or a different Paging Policy Indicator to the AMF if the SMF receives any additional Data Notification from the UPF for data packets pertaining to another QoS Flow associated with a higher priority (i.e. ARP priority level) than the priority indicated to the AMF in the previous Namf\_MT\_EnableUEReachability request, or if the SMF derives a different Paging Policy Indicator according to the additional Data Notification, while waiting for the response from the AMF. + +- 2a. On success: + +- if the UE is in CM-CONNECTED state, the AMF shall immediately respond using "200 OK" status code, with content containing an "EnableUeReachabilityRspData" object. +- if the UE is in CM-IDLE state and the NAS message is to be sent over via 3GPP access and paging is not restricted as defined in 3GPP TS 23.501 [2] clause 5.38.5, the AMF shall page the UE. When UE becomes CM-CONNECTED and the UE has not rejected the page as specified in 3GPP TS 23.501 [2] clause 5.38.4, "200 OK" shall be returned with content containing an "EnableUeReachabilityRspData" object. +- if the UE is in Extended DRX for RRC-INACTIVE state and with CN based MT communication handling, and the AMF determines that the UE is reachable, then the AMF shall send a N2 RAN paging request message to NG-RAN with the request for the UE's RRC connection to be resumed as specified in clause 4.8.2.2b of 3GPP TS 23.502 [3]. When an N2 Notification is received by the AMF indicating that the UE is in RRC-CONNECTED state as specified in clause 4.8.2.2 of 3GPP TS 23.502 [3], "200 OK" shall be returned with the content containing an "EnableUeReachabilityRspData" object. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.3.3.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails or ProblemDetailsEnableUeReachability structure with the "cause" attribute set to one of the application error listed in Table 6.3.3.2.3.1-3. + +The AMF shall respond with the status code "403 Forbidden", if the UE is in a Non-Allowed Area and the service request is not for regulatory prioritized service. The AMF shall set the application error as "UE\_IN\_NON\_ALLOWED\_AREA" in POST response body. + +The AMF shall respond with the status code "409 Conflict", if Paging Restriction Information restrict the EnableUeReachability request from causing paging as defined in 3GPP TS 23.501 [2] clause 5.38.5 or if the UE rejects the paging as defined in 3GPP TS 23.501 [2] clause 5.38.4. The AMF shall set the application error as "REJECTION\_DUE\_TO\_PAGING\_RESTRICTION" in POST response body. + +The AMF shall respond with the status code "504 Gateway Timeout" and set the application error as "UE\_NOT\_REACHABLE" and include an Estimated Maximum Wait time in POST response body when the AMF determines the UE is unreachable (e.g. if the UE is in MICO mode or the UE has entered Extended DRX in CM-IDLE or Extended DRX for RRC-INACTIVE state) as specified in clauses 4.24.2 and 4.8.2.2b of 3GPP TS 23.502 [3]). If the UE is in Extended DRX for RRC-INACTIVE state and with CN based MT communication handling, when the AMF determines that the UE is reachable, the AMF shall send a N2 RAN paging request message to NG-RAN with the request for the UE's RRC connection to be resumed as specified in clause 4.8.2.2b of 3GPP TS 23.502 [3]) using the information received in the EnableUeReachabilityReqData (i.e. the ppi, the arp, the qfi and the 5qi of the QoS flow of the PDU session for which DL packets are received, together with the PDU session identifier). If the UE is in Extended DRX in CM-IDLE state, and the AMF determines that the UE is reachable, the AMF shall page the UE (i.e. using CN paging). + +## 5.4.2.3 ProvideDomainSelectionInfo + +### 5.4.2.3.1 General + +The ProvideDomainSelectionInfo service operation shall be invoked by the NF Service Consumer (e.g. UDM) to get the UE information for terminating domain selection of IMS voice, including following information: + +- Indication of supporting IMS voice over PS Session; +- Time stamp of the last radio contact with the UE; +- Current Access type and RAT type + +The NF Service Consumer shall invoke the service by using the HTTP GET towards the URI of the "UeContext" resource (See clause 6.3.3.3.3.1). See also figure 5.4.2.3.1-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and an AMF for providing UE information for terminating domain selection. The NF Service Consumer sends a GET request to the AMF. The AMF responds with either a 200 OK (UeContextInfo) or a 4xx/5xx (ProblemDetails) or 3xx response.](7355f66b8620d44cf566215621addb74_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: Request + NF Service Consumer->>AMF: 1. GET ...{ueContextId}?Info-class=TADS + Note right of AMF: Success + AMF-->>NF Service Consumer: 2a. 200 OK (UeContextInfo) + Note right of AMF: Failure + AMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an AMF for providing UE information for terminating domain selection. The NF Service Consumer sends a GET request to the AMF. The AMF responds with either a 200 OK (UeContextInfo) or a 4xx/5xx (ProblemDetails) or 3xx response. + +**Figure 5.4.2.3.1-1: Provide UE Information for Terminating Domain Selection** + +1. The NF Service Consumer shall send a GET request to the URI of the "UeContext" resource on the AMF, with query parameter "info-class" set to value "TADS". +- 2a. On success, the AMF shall return "200 OK" status code with content containing an "UeContextInfo" data structure including UE information for terminating domain selection for IMS voice. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.3.3.3.3.1-3 shall be returned. The message body shall contain a ProblemDetails object with "detail" set to one of the corresponding application errors listed in Table 6.3.3.3.3.1-3. + +If the request cannot be completed due to a Registration procedure going-on for the target UE, the AMF shall reject the request with a 409 Conflict response and with the TEMPORARY\_REJECT\_REGISTRATION\_ONGOING application error. The NF Service Consumer should repeat the request after a suitable delay. + +If the request cannot be completed due to the target UE being in RM\_DEREGISTERED state, the AMF shall reject the request with a 403 Forbidden response and with the UE\_DEREGISTERED application error. + +## 5.4.2.4 EnableGroupReachability + +### 5.4.2.4.1 General + +The EnableGroupReachability service operation is used in the following procedure: + +- MBS session activation procedure (see 3GPP TS 23.247 [55], clause 7.2.5.2). + +The EnableGroupReachability service operation shall be invoked by the NF Service Consumer (e.g. SMF) to enable the reachability of the list of UEs involved in the MBS Session. + +The NF Service Consumer shall invoke the service by using the HTTP method POST (enable-group-reachability custom operation) as shown in figure 5.4.2.4.1-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and an AMF. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 200 OK (EnableGroupReachabilityRspData) or a 4xx/5xx (ProblemDetails) or 3xx- response.](d7efe1d3c9fce95c7bacefb7e7d7faff_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: POST /ue-contexts/enable-group-reachability(EnableGroupReachabilityReqData) + NF Service Consumer->>AMF: 1. POST request + Note right of AMF: 2a. 200 OK (EnableGroupReachabilityRspData) + AMF-->>NF Service Consumer: 2a. 200 OK response + Note right of AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx- + AMF-->>NF Service Consumer: 2b. Error response + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an AMF. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 200 OK (EnableGroupReachabilityRspData) or a 4xx/5xx (ProblemDetails) or 3xx- response. + +**Figure 5.4.2.4.1-1: NF Service Consumer enabling the reachability of a list of UEs** + +1. The NF Service Consumer shall send a POST request to the resource representing the UeContexts resource of the AMF. The content of the POST request shall contain an "EnableGroupReachabilityReqData" object. + +2a. On success: + +If at least one UE in the list of UEs included in EnableGroupReachabilityReqData is in CM-CONNECTED state, the AMF shall respond using "200 OK" status code, with the content containing the list of UEs in CM-CONNECTED state in "EnableGroupReachabilityRspData" object; or + +If all the UEs in the list of UEs included in EnableGroupReachabilityReqData are in CM-IDLE state, the AMF shall respond with "200 OK" status code. + +The AMF shall page UEs in CM-IDLE state as specified in clause 7.2.5.2 of 3GPP TS 23.247 [55]. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.3.3.4.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.3.3.4.4.2.2-2. + +## 5.4.2.5 UEReachabilityInfoNotify + +### 5.4.2.5.1 General + +The UEReachabilityInfoNotify service operation is used in the following procedure: + +- MBS session activation procedure (see 3GPP TS 23.247 [55], clause 7.2.5.2). + +The UEReachabilityInfoNotify service operation shall be invoked by the AMF to send a notification towards the notification URI for the UE(s) which are reachable or do not respond to paging. + +The AMF shall use the HTTP method POST, using the notification URI received in the EnableGroupReachability request as specified in clause 5.4.2.4.1, to send a notification. See Figure 5.4.2.5.1-1. + +![Sequence diagram showing UE Reachability Info Notify. The AMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content or an error status code (4xx/5xx or 3xx).](343e05a9fd8a8c8743428fa4ae6e2736_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant NF Service Consumer + Note left of AMF: 1. POST {reachabilityNotifyUri}(ReachabilityNotificationData) + AMF->>NF Service Consumer: 1. POST {reachabilityNotifyUri}(ReachabilityNotificationData) + Note right of NF Service Consumer: 2a. 204 No Content + NF Service Consumer-->>AMF: 2a. 204 No Content + Note right of NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer-->>AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing UE Reachability Info Notify. The AMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content or an error status code (4xx/5xx or 3xx). + +**Figure 5.4.2.5.1-1: UE Reachability Info Notify** + +1. The AMF shall send a POST request to send a notification. +- 2a. On success, "204 No content" shall be returned by the NF Service Consumer. +- 2b. On failure or redirection, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned and appropriate additional error information should be returned. + +## 5.5 Namf\_Location Service + +### 5.5.1 Service Description + +The Namf\_Location service is used by NF service consumers to request the AMF for initiating positioning requests and provide the location information. It is also used to subsequently notify the location change events towards the NF service consumers. The following are the key functionalities of this NF service: + +- Allow NFs to request the current geodetic and optionally local and/or civic location of a target UE. +- Allow NFs to be notified of event information related to emergency sessions. +- Allow NFs to request Network Provided Location Information (NPLI) and/or local time zone corresponding to the location of a target UE. +- Allow NFs to request the ranging and sidelink positioning location results for a group of n UEs ( $n \geq 2$ ), the ranging and sidelink positioning location results may include absolute locations, relative locations or ranges and directions related to the UEs. +- Allow NFs to enable the location reporting over user plane. + +### 5.5.2 Service Operations + +#### 5.5.2.1 Introduction + +For the Namf\_Location Service the following service operations are defined: + +- ProvidePositioningInfo; +- EventNotify; and +- ProvideLocationInfo. +- CancelLocation + +## 5.5.2.2 ProvidePositioningInfo + +### 5.5.2.2.1 General + +The ProvidePositioningInfo service operation is used in the following procedure: + +- 5GC-MT-LR Procedure without UDM Query (see 3GPP TS 23.273 [42], clause 6.10.2) +- 5GC-MT-LR Procedure (see 3GPP TS 23.273 [42], clause 6.1) +- Initiation and Reporting of Location Events (see 3GPP TS 23.273 [42], clause 6.3.1) +- Location Continuity for Handover of an Emergency session from NG-RAN (see 3GPP TS 23.273 [42], clause 6.10.3) +- 5GC-MT-LR multiple location procedure without UDM Query (see 3GPP TS 23.273 [42], clause 6.10.4) +- Procedures of SL-MT-LR involving LMF (see 3GPP TS 23.273 [42], clause 6.20.3) +- Procedures of SL-MT-LR for periodic, triggered Location Events (see 3GPP TS 23.273 [42], clause 6.20.4) +- 5GC-MT-LR Procedure using SL positioning (see 3GPP TS 23.273 [42], clause 6.20.5) + +The ProvidePositioningInfo service operation shall be invoked by the NF Service Consumer (e.g. GMLC) to request the current or deferred geodetic and optionally local and/or civic location of the UE. The service operation triggers the AMF to invoke the service towards the LMF. + +The NF Service Consumer shall invoke the service operation by sending POST to the URI of the "provide-pos-info" custom operation on the "Individual UE Context" resource (See clause 6.4.3.2.4.2). See also figure 5.5.2.2.1-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and an AMF. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 200 OK (ProvidePosInfoExt), a 204 No Content, or a 4xx/5xx (ProblemDetails) or 3xx response.](314da473d582c4327e1e3d56fcba19dd_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: 1. POST « /{ueContextId}/provide-pos-info(RequestPosInfo) » + NF Service Consumer->>AMF: Request + Note right of AMF: 2a. 200 OK (ProvidePosInfoExt) +2b. 204 No Content + AMF-->>NF Service Consumer: Response + Note right of AMF: 2c. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: Error/Redirect + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an AMF. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 200 OK (ProvidePosInfoExt), a 204 No Content, or a 4xx/5xx (ProblemDetails) or 3xx response. + +**Figure 5.5.2.2.1-1: NF Service Consumer requests the positioning information of the UE** + +1. The NF Service Consumer shall send a POST request to the resource URI of "provide-pos-info" custom operation of the "Individual UE context" resource of the AMF. The content of the POST request may contain: + +- an indication of a positioning request from emergency services or commercial services client, +- the required location QoS, and additionally the mapped location QoS applicable to EPS if multiple location QoS is required, +- Supported GAD shapes, +- scheduled location time, +- reliable UE Location Request, +- UE unaware indication, +- the LMF ID that should be used for selecting the LMF, +- the reporting indication, +- the integrity requirements +- the requested ranging\_SL location results, including absolute locations, relative locations or ranges and directions related to the UEs for ranging and sidelink positioning, and/or +- the information of the related UEs, including application layer ID(s) and the related UE type for each related UE for ranging and sidelink positioning. + +If the NF service consumer wants the location change information or deferred location information to be notified (e.g. during a handover procedure or for activation or completion of deferred location), it also provides a callback URI on which the EventNotify service operation is executed (see clause 5.5.2.3). + +During 5GC-MT-LR multiple location procedure for regulatory location service, the request body may also include the indication of acceptance for intermediate response and the maximum response time, the GMLC callback address and the LIR reference number. + +- 2a. On success, "200 OK" shall be returned. The content may contain the LCS correlation identifier, the location estimate, its age and accuracy, the information about the positioning method. If the request is invoked during a handover the response body shall also include the target AMF node identifier as specified in clause 6.10.3 of 3GPP TS 23.273 [42]. + +If the location determination will be sent by LMF to GMLC directly, the content shall include the directReportInd and supportedFeatures attributes. + +- 2b. On accept, "204 No Content" shall be returned to acknowledge that AMF supports a deferred location request and a deferred location is accepted as specified in step 6 of clause 6.3.1 of 3GPP TS 23.273 [42]; +- 2c. On failure or redirection, one of the HTTP status code listed in Table 6.4.3.2.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.4.3.2.4.2.2-2. + +If the AMF received the LMF ID from the NF service consumer and the AMF does not find an LMF with the LMF ID received from GMLC, the AMF should return a 403 Forbidden response with the cause attribute set to "REQUESTED\_LMF\_NOT\_AVAILABLE" to the NF service consumer, if no other LMF is configured as backup selection. Otherwise, the ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.4.3.2.4.2.2-2 shall be applied. + +### 5.5.2.3 EventNotify + +#### 5.5.2.3.1 General + +The EventNotify service operation is used in the following procedure: + +- 5GC-NI-LR Procedure (see 3GPP TS 23.273 [42], clause 6.10.1) +- Location Continuity for Handover of an Emergency session from NG-RAN (see 3GPP TS 23.273 [42], clause 6.10.3) +- Completion of a deferred location for the UE available event or activation of deferred location for periodic location, area event triggered location or motion event triggered location (see 3GPP TS 23.273 [42], clause 6.3.1) + +The EventNotify service operation notifies the NF Service Consumer (i.e. GMLC) about a UE location related event information related to emergency sessions or deferred location, i.e. the initiation, handover or termination of an emergency session or the completion or activation of deferred location. The notification is delivered to: + +- the callback URI received from the GMLC during an earlier ProvidePositioningInfo service operation, if any; + +Otherwise (if not available), + +- the callback URI registered in the NRF, if the GMLC registered to the NRF with notification endpoints for location notifications (see clauses 6.1.6.2.4 and 6.1.6.3.4 of 3GPP TS 29.510 [29]); + +Otherwise (if not available), + +- GMLC URI locally provisioned in the AMF. + +NOTE: During a handover procedure, both the source AMF and the target AMF can invoke the EventNotify service operation, based on the local configuration. + +The operation is invoked by issuing a POST request to the callback URI of the NF Service Consumer (See clause 6.4.5.2.2). See also figure 5.5.2.3.1-1. + +![Sequence diagram for UE Location Notification. The AMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code.](5e9af8986a5845504f251d3079da8078_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant NF Service Consumer + Note left of AMF: 1. POST {locationNotificationUri}(NotifiedPosInfoExt) + AMF->>NF Service Consumer: 1. POST {locationNotificationUri}(NotifiedPosInfoExt) + Note right of NF Service Consumer: 2a. 204 No Content + NF Service Consumer-->>AMF: 2a. 204 No Content + Note right of NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) Or 3xx + NF Service Consumer-->>AMF: 2b. 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram for UE Location Notification. The AMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code. + +**Figure 5.5.2.3.1-1: UE Location Notification** + +1. The AMF shall send a POST request to the callback URI provided by the NF service consumer determined as described above. The request body shall include the type of location related event and UE Identification (SUPI or PEI), and may include the GPSI, Geodetic Location, Local Location, Civic Location, MSC server identity, the Position methods used or a serving LMF identification for activation of periodic or triggered location. +- 2a. On success, "204 No content" shall be returned by the NF Service Consumer. +- 2b. On failure or redirection, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned and appropriate additional error information should be returned. + +## 5.5.2.4 ProvideLocationInfo + +### 5.5.2.4.1 General + +The ProvideLocationInfo service operation allows an NF Service Consumer (e.g. UDM) to request the Network Provided Location Information (NPLI) of a target UE. + +The NF Service Consumer shall invoke the service operation by sending POST request to the URI of the "provide-loc-info" custom operation on the "Individual UE Context" resource (see clause 6.4.3.2.4.3), as shown in figure 5.5.2.4.1-1. + +![Sequence diagram for NF Service Consumer requests the Location Information of the UE. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 200 OK (ProvideLocInfo) (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code.](f14f0843f9944e61124817d06809d7ad_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: 1. POST .../{ueContextId}/provide-loc-info(RequestLocInfo) + NF Service Consumer->>AMF: 1. POST .../{ueContextId}/provide-loc-info(RequestLocInfo) + Note right of AMF: 2a. 200 OK (ProvideLocInfo) + AMF-->>NF Service Consumer: 2a. 200 OK (ProvideLocInfo) + Note right of AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for NF Service Consumer requests the Location Information of the UE. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 200 OK (ProvideLocInfo) (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code. + +**Figure 5.5.2.4.1-1: NF Service Consumer requests the Location Information of the UE** + +1. The NF Service Consumer shall send a POST request to the resource URI of "provide-loc-info" custom operation of the "Individual UE context" resource on the AMF. The content of the POST request shall contain a "requestLocInfo" data structure indicating the desired type of location information. + +If the NF Service Consumer desires the current location information of the target UE, it shall set "reqCurrentLoc" attribute to "true". + +- 2a. On success, "200 OK" response shall be returned. The content of the response shall contain a "ProvideLocInfo" data structure including the Network Provide Location Information (NPLI) of the target UE. + +If "reqCurrentLoc" attribute is set to "true" and the UE is in RM-REGISTERED and CM-IDLE state over 3GPP access, the AMF shall initiate a paging procedure to the UE. If the paging procedure is successful, the AMF shall return the current location information and set "currentLoc" attribute to "true" in the response; if the UE does not respond to the paging, the AMF shall provide the last known location and set "currentLoc" attribute to "false" in the response. + +If "reqCurrentLoc" attribute is set to "true" and the UE is in RM-REGISTERED and CM-CONNECTED state over 3GPP access, the AMF shall follow NG-RAN Location reporting procedure, as specified in clause 4.10 of 3GPP TS 23.502 [3], to trigger a single standalone report by setting "direct" event type in Location Reporting + +Control message. If NG-RAN reports current location of the UE, the AMF shall set "currentLoc" attribute to "true" in the response; if NG-RAN reports last known location of the UE with timestamp, the AMF shall set "currentLoc" attribute to "false" in the response. + +If the UE is in RM-REGISTERED over non-3GPP access, the AMF shall include the latest non-3GPP access location information. + +- 2b. On failure or redirection, one of the HTTP status code listed in table 6.4.3.2.4.3.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in table 6.4.3.2.4.3.2-2. + +## 5.5.2.5 CancelLocation + +### 5.5.2.5.1 General + +This service operation is used in the following procedure: + +- Cancellation of Reporting of Location Events by an AF or External LCS Client (see 3GPP TS 23.273 [42], clause 6.3.3) + +The CancelLocation service operation shall be invoked by the NF Service Consumer (e.g. GMLC) to cancel reporting periodic or events triggered location. + +The NF Service Consumer shall invoke the service operation by sending a POST request to the URI of the "cancel-pos-info" custom operation on the "Individual UE Context" resource (See clause 6.4.3.2.4.4). See also figure 5.5.2.5.1-1. + +![Sequence diagram showing the cancellation of reporting periodic or events triggered location of the UE. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection).](4f2887d5043c0923cf5b37ca0d80c60b_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: POST .../{ueContextId}/cancel-pos-info(CancelLocInfo) + NF Service Consumer->>AMF: 1. POST .../{ueContextId}/cancel-pos-info(CancelLocInfo) + Note right of AMF: 2a. 204 No Content + AMF-->>NF Service Consumer: 2a. 204 No Content + Note right of AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the cancellation of reporting periodic or events triggered location of the UE. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection). + +**Figure 5.5.2.5.1-1: Cancellation of reporting periodic or events triggered location of the UE** + +1. The NF Service Consumer shall send a POST request to the resource URI of "cancel-pos-info" custom operation of the "Individual UE context" resource of the AMF. The content of the POST request shall contain a "CancelLocInfo" data structure indicating the desired cancellation of reporting periodic or events triggered location of the UE. +- 2a. On success, AMF responds with "204 No Content". +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.4.3.2.4.4-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors. + +## 5.6 Namf\_MBSBroadcast Service + +### 5.6.1 Service Description + +This service enables the NF Service Consumer (e.g. MB-SMF) to create, update or release a broadcast MBS session context in the AMF and to be notified about status change of the MBS broadcast context. + +### 5.6.2 Service Operations + +#### 5.6.2.1 Introduction + +The Namf\_MBSBroadcast service supports following service operations: + +- ContextCreate +- ContextUpdate +- ContextRelease +- ContextStatusNotify + +### 5.6.2.2 ContextCreate + +The ContextCreate service operation shall be used by the NF Service Consumer (e.g. MB-SMF) to request the AMF to create a broadcast MBS session context. + +NOTE: For a location dependent MBS service, one single ContextCreate service operation is performed per MBS session (for a given AMF). + +It is used in the following procedures: + +- MBS Session Start for Broadcast (see clause 7.3.1 of 3GPP TS 23.247 [55]); +- MBS Session Update for Broadcast (see clause 7.3.3 of 3GPP TS 23.247 [55]); +- Support for Local Broadcast Service (see clause 7.3.4 of 3GPP TS 23.247 [55]). + +There shall be only one broadcast MBS session context per MBS session, or per MBS session and Area Session ID for an MBS session with Location dependent Broadcast service. + +The NF Service Consumer (e.g. MB-SMF) shall create a broadcast MBS session context by using the HTTP POST method as shown in Figure 5.6.2.2-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and an AMF for Broadcast MBS session context creation. The NF Service Consumer sends a POST request to /mbs-contexts. The AMF responds with either a 201 Created response or a 4xx/5xx error response.](1ae16a393229b439c7b3f8b2e63d8d6c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: POST /mbs-contexts (ContextCreateReqData) + NF Service Consumer->>AMF: 1. POST « /mbs-contexts (ContextCreateReqData) » + Note right of AMF: 2a. 201 Created (ContextCreateRspData) + AMF-->>NF Service Consumer: 2a. 201 Created (ContextCreateRspData) + Note right of AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an AMF for Broadcast MBS session context creation. The NF Service Consumer sends a POST request to /mbs-contexts. The AMF responds with either a 201 Created response or a 4xx/5xx error response. + +**Figure 5.6.2.2-1: Broadcast MBS session context creation** + +- The NF Service Consumer shall send a POST request targeting the Broadcast MBS session contexts collection resource of the AMF. The content of the POST request shall contain the following information: + - MBS Session ID (i.e. TMGI, or TMGI and NID for an MBS session in an SNP); + - list of Area Session ID and related MBS service area, for a Location dependent broadcast MBS service; + - MBS service area, for a Local broadcast MBS session; + - N2 MBS Session Management container (see MBS Session Setup or Modification Request Transfer IE in 3GPP TS 38.413 [12]); + - Notification URI where to be notified about the status change of the broadcast MBS session context; and + - SNSSAI. + +The NF Service Consumer may also include the maxResponseTime IE in the request to indicate the maximum response time to receive information about the completion of the Broadcast MBS session establishment. + +The NF Service Consumer may also include the MB-SMF instance ID and MB-SMF service instance ID to enable the AMF subscribing to the MB-SMF status notifications. + +The NF Service Consumer may also include the MBS associated session ID to enable NG-RAN to identify the multiple MBS sessions delivering the same content when AF creates multiple broadcast MBS Sessions via different Core Networks to deliver the same content. + +- 2a. On success, "201 Created" shall be returned. The AMF should respond success when it receives the first successful response from the NG-RAN(s). The 201 Created response shall contain MBS session identifier and may contain one or more N2 MBS Session Management containers, if additional information (e.g. MBS Session Setup or Modification Response Transfer IE or MBS Session Setup or Modification Failure Transfer IE in 3GPP TS 38.413 [12]) needs to be transferred to the MB-SMF. If the AMF received the NG-RAN responses from all involved NG-RAN(s), e.g. if the broadcast MBS session involves only one NG-RAN, the AMF shall include an indication of completion of the operation in all NG-RANs in the 201 Created response. + +Upon receipt of subsequent responses from other NG-RANs after sending the 201 Created response, if additional information (e.g. MBS Session Setup or Modification Response Transfer IE or MBS Session Setup or Modification Failure Transfer IE in 3GPP TS 38.413 [12]) needs to be transferred to the MB-SMF, the AMF shall transfer such information by sending one or more Namf\_MBSBroadcast\_ContextStatusNotify requests to the MB-SMF. A Namf\_MBSBroadcast\_ContextStatusNotify request may include a list of N2 MBS Session Management containers received from different NG-RANs. When the AMF receives the response from all NG-RANs, the AMF shall include an indication of the completion of the operation in the Namf\_MBSBroadcast\_ContextStatusNotify request. + +If the AMF does not receive responses from all NG-RAN nodes before the maximum response time elapses since the reception of the Namf\_MBSBroadcast\_ContextCreate Request, then the AMF should send one Namf\_MBSBroadcast\_ContextStatusNotify request indicating the incompletion of the Broadcast MBS session establishment. + +For each N2 MBS Session Management container sent towards the MB-SMF, the AMF shall insert the identifier of the NG-RAN node that generated it in the corresponding entry of the n2MbsSmInfoList attribute. + +The AMF may send one or more Namf\_MBSBroadcast\_ContextStatusNotify request including an operationEvents attribute to report the MB-SMF about failure to reach one or more NG-RANs. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.5.3.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.5.3.2.3.1-3. + +### 5.6.2.3 ContextUpdate + +The ContextUpdate service operation shall be used by the NF Service Consumer (e.g. MB-SMF) to request the AMF to update a broadcast MBS session context. + +It is used in the following procedures: + +- MBS Session Update for Broadcast (see clause 7.3.3 of 3GPP TS 23.247 [55]). +- Broadcast MBS session restoration by MB-SMF (see clause 8.3.2.3 of 3GPP TS 23.527 [33]). +- Selecting an alternative AMF for a Broadcast MBS Session at AMF failure (see clause 8.3.2.4 of 3GPP TS 23.527 [33]). + +The NF Service Consumer (e.g. MB-SMF) shall update a broadcast MBS session context by using the HTTP POST method as shown in Figure 5.6.2.3-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and an AMF for a Broadcast MBS session context update. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 200 OK or 204 No Content, or a 4xx/5xx error with ProblemDetails or 3xx.](b97737027bd1b2effd7ca4dba8914877_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: POST /mbs-contexts/{mbsContextRef}/update + NF Service Consumer->>AMF: 1. POST « /mbs-contexts/{mbsContextRef}/update (ContextUpdateReqData) » + Note right of AMF: 2a. 200 OK (ContextUpdateRspData) / 2b. 204 No Content + AMF-->>NF Service Consumer: 2a. 200 OK (ContextUpdateRspData) / 2b. 204 No Content + Note right of AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an AMF for a Broadcast MBS session context update. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 200 OK or 204 No Content, or a 4xx/5xx error with ProblemDetails or 3xx. + +Figure 5.6.2.3-1: Broadcast MBS session context update + +1. The NF Service Consumer shall send a POST request targeting the individual Broadcast MBS session context resource to be updated in the AMF. The content of the POST request may contain the following information: + +- N2 MBS Session Management container (see MBS Session Setup or Modification Request Transfer IE in 3GPP TS 38.413 [12]); +- Notification URI, if the NF Service Consumer wishes to modify the notification URI where to be notified about the status change of the broadcast MBS session context; +- updated MBS service area, for a Local broadcast MBS session; +- updated list of Area Session ID and related MBS service area, for a Location dependent broadcast MBS session. +- the n2MbsInfoChangeInd IE set to "true" or "false" to indicate to the AMF whether the information within the N2 MBS Session Management container has changed or not for the MBS session + +The NF Service Consumer may also include the maxResponseTime IE in the request to indicate the maximum response time to receive information about the completion of the Broadcast MBS session update. + +During a broadcast MBS session restoration procedure for an NG-RAN failure with restart, the MB-SMF may include one or more ranIds attributes to request the AMF to setup the Broadcast MBS session in a list of NG-RANs as identified by the NG-RAN ID(s), as specified in clause 8.3.2.3 of 3GPP TS 23.527 [33]. + +During a restoration procedure upon an AMF failure without restart, for an AMF deployed in an AMF set, the MB-SMF may set the noNgapSignallingInd IE to "true" when the MB-SMF detects the original AMF has failed and then selects an alternative AMF to take over the MBS session but without a need to trigger any NGAP signalling towards NG-RANs, as specified in clause 8.3.2.4 of 3GPP TS 23.527 [33]. + +- 2a. On success, "200 OK" shall be returned if additional information needs to be returned in the response. The 200 OK response may contain one or more N2 MBS Session Management containers, if such information (e.g. MBS Session Setup or Modification Response Transfer IE, MBS Session Setup or Modification Failure Transfer IE or MBS Session Release Response Transfer IE in 3GPP TS 38.413 [12]) needs to be transferred to the MB-SMF. If the AMF received the NG-RAN responses from all involved NG-RAN(s), the AMF shall include an indication of completion of the operation in all NG-RANs. +- 2b. On success, "204 No Content" shall be returned if no additional information needs to be returned in the response. + +In both 2a and 2b cases, upon receipt of subsequent responses from other NG-RANs after sending the 200 OK response or the 204 No Content response, if additional information (e.g. MBS Session Setup or Modification Response Transfer IE, MBS Session Setup or Modification Failure Transfer IE or MBS Session Release Response Transfer IE in 3GPP TS 38.413 [12]) needs to be transferred to the MB-SMF, the AMF shall transfer such information by sending one or more Namf\_MBSBroadcast\_ContextStatusNotify requests to the MB-SMF. A Namf\_MBSBroadcast\_ContextStatusNotify request may include a list of N2 MBS Session Management containers received from different NG-RANs. When the AMF receives the response from all NG-RANs, the AMF shall include an indication of the completion of the operation in the Namf\_MBSBroadcast\_ContextStatusNotify request. + +If the AMF does not receive responses from all NG-RAN nodes before the maximum response time elapses since the reception of the Namf\_MBSBroadcast\_ContextUpdate Request, then the AMF should send one Namf\_MBSBroadcast\_ContextStatusNotify request indicating the incompletion of the Broadcast MBS session update. + +If the n2MbsInfoChangeInd IE is present in the request and set to "false", the AMF does not need to contact NG-RAN nodes unaffected by the MBS service area change. + +For each N2 MBS Session Management container sent towards the MB-SMF, the AMF shall insert the identifier of the NG-RAN node that generated it in the corresponding entry of the n2MbsSmInfoList attribute. + +The AMF may send one or more Namf\_MBSBroadcast\_ContextStatusNotify request including an operationEvents attribute to report the MB-SMF about failure to reach one or more NG-RANs. + +- 2c. On failure or redirection, one of the HTTP status code listed in Table 6.5.3.2.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.5.3.2.4.2.2-2. + +## 5.6.2.4 ContextRelease + +The ContextRelease service operation shall be used by the NF Service Consumer (e.g. MB-SMF) to request the AMF to release a broadcast MBS session context. + +It is used in the following procedures: + +- MBS Session Release for Broadcast (see clause 7.3.2 of 3GPP TS 23.247 [55]). + +The NF Service Consumer (e.g. MB-SMF) shall release a broadcast MBS session context by using the HTTP DELETE method as shown in Figure 5.6.2.4-1. + +![Sequence diagram showing the Broadcast MBS session context release. The NF Service Consumer sends a DELETE request to the AMF. The AMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) response.](350dece6293a0ac3d4c9e4bf41eefa5d_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: 1. DELETE « /mbs-contexts/{mbsContextRef} » + NF Service Consumer->>AMF: 1. DELETE « /mbs-contexts/{mbsContextRef} » + Note right of AMF: 2a. 204 No Content + AMF-->>NF Service Consumer: 2a. 204 No Content + Note right of AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx +``` + +Sequence diagram showing the Broadcast MBS session context release. The NF Service Consumer sends a DELETE request to the AMF. The AMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) response. + +**Figure 5.6.2.4-1: Broadcast MBS session context release** + +1. The NF Service Consumer shall send a DELETE request targeting the individual Broadcast MBS session context resource to be released in the AMF. +- 2a. On success, "204 No Content" shall be returned. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.5.3.3.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.5.3.3.3.1-3. + +The AMF may send one or more Namf\_MBSBroadcast\_ContextStatusNotify request including an operationEvents attribute to report the MB-SMF about failure to reach one or more NG-RANs. + +## 5.6.2.5 ContextStatusNotify + +The ContextStatusNotify service operation shall be used by the AMF to notify status change of a broadcast MBS session context to the NF Service Consumer (e.g. MB-SMF). + +It is used in the following procedures: + +- MBS Session Start for Broadcast (see clause 7.3.1 of 3GPP TS 23.247 [55]); +- MBS Session Update for Broadcast (see clause 7.3.3 of 3GPP TS 23.247 [55]); +- Broadcast MBS Session Release Require (see clause 7.3.6 of 3GPP TS 23.247 [55]). +- Broadcast MBS session restoration by MB-SMF (see clause 8.3.2.3 of 3GPP TS 23.527 [33]). +- Selecting an alternative AMF for a Broadcast MBS Session at AMF failure (see clause 8.3.2.4 of 3GPP TS 23.527 [33]). +- Transport change for resource sharing across broadcast MBS Sessions in network sharing (see clause 7.3.7 of 3GPP TS 23.247 [55]). + +The AMF shall notify status change of a broadcast MBS session context to the NF Service Consumer (e.g. MB-SMF) by using the HTTP POST method as shown in Figure 5.6.2.5-1. + +![Sequence diagram showing the Broadcast MBS session context status change notification. The NF Service Consumer sends a POST {notifyURI} (ContextStatusNotification) to the AMF. The AMF responds with one of the following: 2a. 204 No Content, 2a. 200 OK (ContextStatusNotificationResponse), or 2b. 4xx/5xx (ProblemDetails) or 3xx.](ffb6acd27b8e3a54392840948a75869f_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: POST {notifyURI} (ContextStatusNotification) + NF Service Consumer->>AMF: 1. POST {notifyURI} (ContextStatusNotification) + AMF-->>NF Service Consumer: 2a. 204 No Content + AMF-->>NF Service Consumer: 2a. 200 OK (ContextStatusNotificationResponse) + AMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the Broadcast MBS session context status change notification. The NF Service Consumer sends a POST {notifyURI} (ContextStatusNotification) to the AMF. The AMF responds with one of the following: 2a. 204 No Content, 2a. 200 OK (ContextStatusNotificationResponse), or 2b. 4xx/5xx (ProblemDetails) or 3xx. + +**Figure 5.6.2.5-1: Broadcast MBS session context status change notification** + +- The AMF shall send a POST request targeting the notification URI received from the NF Service Consumer. The content of the POST request shall contain the following information: + - MBS Session ID (i.e. TMGI, or TMGI and NID for an MBS session in an SNPN); + - Area Session ID, if this is a Location dependent broadcast MBS service; + - one or more N2 MBS Session Management containers, if N2 MBS Session Management information (e.g. MBS Session Setup or Modification Response Transfer IE, MBS Session Setup or Modification Failure Transfer IE or MBS Session Release Response Transfer IE or Broadcast Session Transport Request Transfer IE in 3GPP TS 38.413 [12]) has been received from one or more NG-RANs that needs to be transferred to the NF Service Consumer; for each N2 MBS Session Management container sent towards the MB-SMF, the AMF shall insert the identifier of the NG-RAN node that generated it in the corresponding entry of the n2MbsSmInfoList attribute. + - the operationStatus IE indicating the completion of the Broadcast MBS session establishment or update, if the NF Service Consumer has requested to establish or update the Broadcast MBS session context and a response has been received from all NG-RANs; and + - the operationStatus IE indicating the incompletion of the Broadcast MBS session establishment or update, if the NF Service Consumer has requested to establish or update the Broadcast MBS session context including a maximum response time and the AMF has not received responses from all NG-RANs before the maximum response time elapses. + +During a Broadcast MBS Session Release Require procedure (see clause 7.3.6 of 3GPP TS 23.247 [55]), one or more NG-RANs may request the AMF to release the Broadcast MBS session. In this case, based on operator's policy, the AMF may: + +- report the Broadcast MBS Session release to the MB-SMF by including the operationEvent attribute in the MBS Context Status Notification request with the opEventType set to "NG\_RAN\_EVENT" together with a list of "ngranFailureEvent" for each NG-RAN that requested to release the Broadcast MBS Session. Upon receiving such a notification, per local policies, the MB-SMF may attempt to re-establish the MBS session after some operator configurable time in these NG-RANs by performing the Broadcast MBS session restoration by MB-SMF procedure specified in clause 8.3.2.3 of 3GPP TS 23.527 [33]; or +- attempt to re-establish the MBS session after some operator configurable time in these NG-RANs by performing the Broadcast MBS session restoration by AMF procedure specified in clause 8.3.2.2 of 3GPP TS 23.527 [33]. + +If all the NG-RANs serving the Broadcast MBS session requested the AMF to release the Broadcast MBS session, the AMF shall release the Broadcast MBS session context and send a notification with the releaseInd attribute set to true to report to the MB-SMF that the Broadcast MBS session (context) is released at the AMF and NG-RANs. + +The AMF may include an operationEvents attribute in the MBS Context Status Notification request to report the MB-SMF: + +- a NG-RAN failure event, e.g. the NG-RAN failure with or without restart, as specified in clause 8.3.2.3 of 3GPP TS 23.527 [33]; +- that a new AMF has taken over the control of the broadcast MBS session upon an AMF failure as specified in clause 8.3.2.4 of 3GPP TS 23.527 [33]. + +- 2a. On success, if the ContextStatusNotification does not contain a N2 MBS Session Management container with a Broadcast Session Transport Request Transfer IE, the NF Service Consumer shall return a "204 No Content" response. + +If the ContextStatusNotification contains one or more N2 MBS Session Management containers encapsulating a Broadcast Session Transport Request Transfer IE, the MB-SMF shall return a "200 OK" with the ContextStatusNotificationResponse containing one or more N2 MBS Session Management containers encapsulating a Broadcast Session Transport Response Transfer IE or a Broadcast Session Transport Failure Transfer IE. For each N2 MBS Session Management container sent towards the AMF, the MB-SMF shall insert the identifier of the NG-RAN node to which the information in the container relates in the corresponding entry of the n2MbsSmInfoList attribute. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.5.5.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails attribute with the "cause" attribute set to one of the application errors listed in Table 6.5.5.2.3.1-3. + +## 5.7 Namf\_MBSSCommunication Service + +### 5.7.1 Service Description + +This service enables an NF Service Consumer (e.g. MB-SMF) to request the AMF to transfer MBS multicast related N2 message towards NG-RAN(s) serving a multicast MBS session, during a multicast MBS session activation, deactivation or update. + +### 5.7.2 Service Operations + +#### 5.7.2.1 Introduction + +The Namf\_MBSSCommunication service supports the following service operations: + +- N2MessageTransfer +- Notify + +#### 5.7.2.2 N2MessageTransfer + +The N2MessageTransfer service operation shall be used by the NF Service Consumer (e.g. MB-SMF) to request the AMF to transfer an MBS related N2 message to the NG-RAN nodes serving the multicast MBS session. It is used during the following procedures: + +- MBS session activation procedure (see clause 7.2.5.2 of 3GPP TS 23.247 [55]); +- MBS session deactivation procedure (see clause 7.2.5.3 of 3GPP TS 23.247 [55]); and +- Multicast session update procedure (see clause 7.2.6 of 3GPP TS 23.247 [55]). + +The NF Service Consumer shall invoke the service operation by sending a POST request to the URI of the "transfer" custom operation (see clause 6.6.3.1) of the AMF. See Figure 5.7.2.2-1. + +![Sequence diagram showing the N2 Message Transfer for a multicast MBS session between an NF Service Consumer and an AMF. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 200 OK or a 4xx/5xx/3xx response.](681dffd423541f7ba0c17aedcbef4959_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: POST .../n2-messages/transfer (MbsN2MessageTransferReqData) + NF Service Consumer->>AMF: 1.POST .../n2-messages/transfer (MbsN2MessageTransferReqData) + Note right of AMF: 2a. 200 OK (MbsN2MessageTransferRspData) or 2b. 4xx/5xx(ProblemDetails) or 3xx + AMF-->>NF Service Consumer: 2a. 200 OK (MbsN2MessageTransferRspData) + AMF-->>NF Service Consumer: 2b. 4xx/5xx(ProblemDetails) or 3xx + +``` + +Sequence diagram showing the N2 Message Transfer for a multicast MBS session between an NF Service Consumer and an AMF. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 200 OK or a 4xx/5xx/3xx response. + +Figure 5.7.2.2-1 N2 Message Transfer for a multicast MBS session + +1. The NF Service Consumer shall invoke the custom operation for N2 message transfer by sending a HTTP POST request and the request body shall carry the MbsN2MessageTransferReqData data structure which contains the N2 MBS Session Management information to be transferred. The MbsN2MessageTransferReqData shall contain: + +- MBS Session ID (i.e. TMGI, or TMGI and NID for an MBS session in an SNPN); + +and may also contain: + +- the Area Session ID, if this is a location dependent multicast MBS session; and/or +- a notification URI where to be notified about any failure of the MBS related N2 procedure for an NG RAN node in this list; and +- an optional notification correlation ID to be sent within notifications. + +If the AMF supports the RAN-ID-LIST feature, the AMF shall distribute the MBS related N2 message to the list of NG-RAN nodes indicated by the MB-SMF, if any, otherwise to the list of NG-RAN nodes having established shared delivery that the AMF stores locally, if any. + +NOTE: An AMF which does not support the the RAN-ID-LIST feature distributes the MBS related N2 message to the list of NG-RAN nodes having established shared delivery that the AMF stores locally. + +- 2a. On success, the AMF shall respond with a "200 OK" status code with MbsN2MessageTransferRspData data structure. The AMF should respond success when it receives the first successful response from the NG-RAN(s). + +If the AMF supports the RAN-ID-LIST feature (see clause 6.6.8), and if the request included a list of NG RAN node IDs and a notification URI where to be notified about failures, the AMF shall report failure(s) of the N2 MBS related N2 procedure with an NG RAN node in this list by including the failureList IE in the "200 OK" response or in a subsequent Notify request towards the notification URI received in the request. See clause 8.4.1.2 of 3GPP TS 23.527 [33]. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.6.3.1.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails attribute with the "cause" attribute set to one of the application errors listed in Table 6.6.4.2.2-2 if any. + +### 5.7.2.3 Notify + +The Notify service operation shall be used by the AMF to notify the NF Service Consumer about a failure of an MBS related N2 procedure with an NG RAN node (see clause 5.7.2.2). + +It is used in the following procedure: + +- N2 MBS session request distribution with list of NG RAN Node IDs provided by MB-SMF to AMF (see clause 8.4.1.2 of 3GPP TS 23.527 [33]). + +The AMF shall notify a failure of an MBS related N2 procedure with an NG RAN node to the NF Service Consumer (e.g. MB-SMF) by using the HTTP POST method as shown in Figure 5.7.2.3-1. + +![Sequence diagram showing the notification process between NF Service Consumer and AMF. The AMF sends a POST {notifyURI} (Notification) to the NF Service Consumer. The NF Service Consumer responds with 2a. 204 No Content or 2b. 4xx/5xx (ProblemDetails) or 3xx.](6835f8f6a39e5504463c9a73f0c58674_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant NFSC as NF Service Consumer + Note right of AMF: 1. POST {notifyURI} (Notification) + AMF->>NFSC: 1. POST {notifyURI} (Notification) + Note left of NFSC: 2a. 204 No Content + NFSC-->>AMF: 2a. 204 No Content + Note left of NFSC: 2b. 4xx/5xx (ProblemDetails) or 3xx + NFSC-->>AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the notification process between NF Service Consumer and AMF. The AMF sends a POST {notifyURI} (Notification) to the NF Service Consumer. The NF Service Consumer responds with 2a. 204 No Content or 2b. 4xx/5xx (ProblemDetails) or 3xx. + +Figure 5.7.2.3-1: Notification + +1. The AMF shall send a POST request targeting the notification URI received from the NF Service Consumer. The content of the POST request shall contain the following information: + +- MBS Session ID (i.e. TMGI, or TMGI and NID for an MBS session in an SNPN); +- the Area Session ID, if this is a location dependent multicast MBS session; and +- one or more failures including, for each failure, the related NG-RAN Node ID and failure cause. +- a notification correlation ID if it is received in the N2MessageTransfer request. + +2a. On success, the NF Service Consumer shall return a "204 No Content" response. + +2b. On failure or redirection, one of the HTTP status code listed in Table 6.6.5.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails attribute with the "cause" attribute set to one of the application errors listed in Table 6.6.5.2.3.1-3. + +--- + +## 6 API Definitions + +### 6.1 Namf\_Communication Service API + +#### 6.1.1 API URI + +The Namf\_Communication shall use the Namf\_Communication API. + +The API URI of the Namf\_Communication API shall be: + +**{apiRoot}//** + +The request URI used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "namf-comm". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +#### 6.1.2 Usage of HTTP + +##### 6.1.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [19], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Namf\_Communication service shall comply with the OpenAPI [23] specification contained in Annex A. + +##### 6.1.2.2 HTTP standard headers + +###### 6.1.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +###### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [8], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. + +- The Problem Details JSON Object (IETF RFC 9457 [36]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +Multipart messages shall also be supported (see clause 6.1.2.4) using the content type "multipart/related", comprising: + +- one JSON body part with the "application/json" content type; and +- one or more binary body parts with 3gpp vendor specific content subtypes. + +The 3gpp vendor specific content subtypes defined in Table 6.1.2.2.2-1 shall be supported. + +**Table 6.1.2.2.2-1: 3GPP vendor specific content subtypes** + +| content subtype | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| vnd.3gpp.ngap | Binary encoded content, encoding NG Application Protocol (NGAP) IEs, as specified in clause 9.4 of 3GPP TS 38.413 [12] (ASN.1 encoded). | +| vnd.3gpp.5gnas | Binary encoded content, encoding a 5GS NAS message, as specified in 3GPP TS 24.501 [11]. | +| NOTE: Using 3GPP vendor content subtypes allows to describe the nature of the opaque content (e.g. NGAP or 5GS NAS information) without having to rely on metadata in the JSON content. | | + +See clause 6.1.2.4 for the binary contents supported in the binary body part of multipart messages. + +## 6.1.2.3 HTTP custom headers + +### 6.1.2.3.1 General + +In this release of this specification, no custom headers specific to the Namf\_Communication service are defined. For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.1.2.4 HTTP multipart messages + +HTTP multipart messages shall be supported, to transfer opaque N1 Information (e.g. SM, LPP) and/or N2 Information (e.g. SM, NRPPa, PWS), in the following service operations (and HTTP messages): + +- N1N2MessageTransfer Request and Response (POST); +- NonUeN2MessageTransfer Request and Response (POST); +- N1MessageNotify (POST); +- N2InfoNotify (POST); +- NonUeN2InfoNotify (POST); +- UEContextTransfer (POST); +- CreateUEContext (PUT) + +HTTP multipart messages shall include one JSON body part and one or more binary body parts comprising: + +- N1payload, and/or N2 payload (see clause 6.1.6.4). + +The JSON body part shall be the "root" body part of the multipart message. It shall be encoded as the first body part of the multipart message. The "Start" parameter does not need to be included. + +The multipart message shall include a "type" parameter (see IETF RFC 2387 [9]) specifying the media type of the root body part, i.e. "application/json". + +NOTE: The "root" body part (or "root" object) is the first body part the application processes when receiving a multipart/related message, see IETF RFC 2387 [9]. The default root is the first body within the multipart/related message. The "Start" parameter indicates the root body part, e.g. when this is not the first body part in the message. + +For each binary body part in a HTTP multipart message, the binary body part shall include a Content-ID header (see IETF RFC 2045 [10]), and the JSON body part shall include an attribute, defined with the RefToBinaryData type, that contains the value of the Content-ID header field of the referenced binary body part. + +## 6.1.3 Resources + +### 6.1.3.1 Overview + +![Figure 6.1.3.1-1: Resource URI structure of the Namf_Communication API. The diagram shows a hierarchical tree of resource paths starting from the root //apiRoot/namf-comm/apiVersion. It branches into /ue-contexts, /subscriptions, and /non-ue-n2-messages. /ue-contexts leads to {ueContextId}, which further branches into /assign-ebi, /transfer, /release, /transfer-update, /relocate, /cancel-relocate, and /n1-n2-messages. /n1-n2-messages leads to {n1N2MessageId}, /subscriptions, and {ueContextId}. /subscriptions under /ue-contexts leads to {subscriptionsId}, which further branches into /transfer, /subscriptions, and {n2NotifySubscriptionId}. /non-ue-n2-messages leads to /transfer, /subscriptions, and {ueContextId}. /transfer under /non-ue-n2-messages leads to {ueContextId}. /subscriptions under /non-ue-n2-messages leads to {n2NotifySubscriptionId}. /ue-contexts under /non-ue-n2-messages leads to {ueContextId}.](78de09c382ab51b5c3e87979204228c8_img.jpg) + +``` + +graph TD + Root["//apiRoot/namf-comm/apiVersion"] --> UEContexts["/ue-contexts"] + Root --> Subscriptions1["/subscriptions"] + Root --> NonUeN2Messages["/non-ue-n2-messages"] + + UEContexts --> UEContextId["{ueContextId}"] + UEContextId --> AssignEbi["/assign-ebi"] + UEContextId --> Transfer1["/transfer"] + UEContextId --> Release["/release"] + UEContextId --> TransferUpdate["/transfer-update"] + UEContextId --> Relocate["/relocate"] + UEContextId --> CancelRelocate["/cancel-relocate"] + UEContextId --> N1N2Messages["/n1-n2-messages"] + + N1N2Messages --> N1N2MessageId["{n1N2MessageId}"] + N1N2Messages --> Subscriptions2["/subscriptions"] + N1N2Messages --> UEContextId2["{ueContextId}"] + + Subscriptions1 --> SubscriptionsId1["{subscriptionsId}"] + SubscriptionsId1 --> Transfer2["/transfer"] + SubscriptionsId1 --> Subscriptions3["/subscriptions"] + SubscriptionsId1 --> N2NotifySubscriptionId["{n2NotifySubscriptionId}"] + + NonUeN2Messages --> Transfer3["/transfer"] + NonUeN2Messages --> Subscriptions4["/subscriptions"] + NonUeN2Messages --> UEContextId3["{ueContextId}"] + + Transfer3 --> UEContextId4["{ueContextId}"] + Subscriptions4 --> N2NotifySubscriptionId2["{n2NotifySubscriptionId}"] + UEContextId3 --> UEContextId5["{ueContextId}"] + +``` + +Figure 6.1.3.1-1: Resource URI structure of the Namf\_Communication API. The diagram shows a hierarchical tree of resource paths starting from the root //apiRoot/namf-comm/apiVersion. It branches into /ue-contexts, /subscriptions, and /non-ue-n2-messages. /ue-contexts leads to {ueContextId}, which further branches into /assign-ebi, /transfer, /release, /transfer-update, /relocate, /cancel-relocate, and /n1-n2-messages. /n1-n2-messages leads to {n1N2MessageId}, /subscriptions, and {ueContextId}. /subscriptions under /ue-contexts leads to {subscriptionsId}, which further branches into /transfer, /subscriptions, and {n2NotifySubscriptionId}. /non-ue-n2-messages leads to /transfer, /subscriptions, and {ueContextId}. /transfer under /non-ue-n2-messages leads to {ueContextId}. /subscriptions under /non-ue-n2-messages leads to {n2NotifySubscriptionId}. /ue-contexts under /non-ue-n2-messages leads to {ueContextId}. + +**Figure 6.1.3.1-1: Resource URI structure of the Namf\_Communication API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description (Mapped Service Operations) | +|----------------------------------------------------------|--------------------------------------------------------------------------|---------------------------------|-----------------------------------------| +| Individual ueContext | /ue-contexts/{ueContextId} | | | +| | | PUT | CreateUEContext | +| | /ue-contexts/{ueContextId}/release | release (POST) | ReleaseUEContext | +| | /ue-contexts/{ueContextId}/assign-ebi | assign-ebi (POST) | EBIAssignment | +| | /ue-contexts/{ueContextId}/transfer | transfer (POST) | UEContextTransfer | +| | /ue-contexts/{ueContextId}/transfer-update | transfer-update (POST) | RegistrationStatusUpdate | +| | /ue-contexts/{ueContextId}/relocate | relocate (POST) | RelocateUEContext | +| | /ue-contexts/{ueContextId}/cancel-relocate | cancel-relocate (POST) | CancelRelocateUEContext | +| n1N2Message collection | /ue-contexts/{ueContextId}/n1-n2-messages | POST | N1N2MessageTransfer | +| N1N2 Subscriptions Collection for Individual UE Contexts | /ue-contexts/{ueContextId}/n1-n2-messages/subscriptions | POST | N1N2MessageSubscribe | +| N1N2 Individual Subscription | /ue-contexts/{ueContextId}/n1-n2-messages/subscriptions/{subscriptionId} | DELETE | N1N2MessageUnSubscribe | +| subscriptions collection | /subscriptions | POST | AMFStatusChangeSubscribe | +| individual subscription | /subscriptions/{subscriptionId} | PUT | AMFStatusChangeSubscribe | +| | | DELETE | AMFStatusChangeUnSubscribe | +| Non UE N2Messages collection | /non-ue-n2-messages/transfer | transfer (POST) | NonUEN2MessageTransfer | +| Non UE N2Messages Subscriptions collection | /non-ue-n2-messages/subscriptions | POST | NonUEN2InfoSubscribe | +| Non UE N2 Message Notification Individual Subscription | /non-ue-n2-messages/subscriptions/{n2NotifySubscriptionId} | DELETE | NonUEN2InfoUnsubscribe | + +### 6.1.3.2 Resource: Individual ueContext + +#### 6.1.3.2.1 Description + +This resource represents the an individual ueContext identified by the ueContextId. + +This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +#### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/namf-comm//ue-contexts/{ueContextId} + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|-------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | String | See clause 6.1.1 | +| apiVersion | String | See clause 6.1.1. | +| ueContextId | String | Represents the 5G Globally Unique Temporary Identifier (See 3GPP TS 23.501 [2] clause 5.9.4)
Pattern: "5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}"
Or represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: see pattern of type Supi in 3GPP TS 29.571 [6]
Or represents the Permanent Equipment Identifier (see 3GPP TS 23.501 [2] clause 5.9.3)
pattern: "(imei-[0-9]{15} imeisv-[0-9]{16} .+)" | + +When the ueContextId is composed by UE's SUPI or PEI, UE's PEI shall be used for the case: + +- If the UE is emergency registration and the UE is UICClass; +- If the UE is emergency registration but SUPI is not authenticated. + +For other cases, UE's SUPI shall be used. + +#### 6.1.3.2.3 Resource Standard Methods + +##### 6.1.3.2.3.1 PUT + +This ueContextId identifies the individual ueContext resource is composed by UE's SUPI or PEI, See table 6.1.3.2.2-1. + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|---------------------------------------| +| UeContextCreate Data | M | 1 | Defines the UE Context to be created. | + +**Table 6.1.3.2.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UeContextCreatedData | M | 1 | 201
Created | This case represents the successful creation of a new UE Context.
Upon success, a response body is returned containing the newly created UE Context. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| UeContextCreateError | O | 0..1 | 403
Forbidden | This case represents the creation of a new UE Context is not successful.

The "cause" attribute may be used to indicate one of the following application errors:
- HANDOVER_FAILURE | +| ProblemDetails | O | 0..1 | 403
Forbidden | This error shall only be returned by an SCP or a SEPP for errors they originate. | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/namf-comm//ue-contexts/{ueContextId} | +| 3gpp-Sbi-Producer-Id | string | C | 0..1 | This header shall be included when the UE Context is created in a target AMF other than the initial AMF sending the response.

When included, this header shall indicate the target AMF serving the created UE Context. | + +**Table 6.1.3.2.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.1.3.2.4 Resource Custom Operations + +### 6.1.3.2.4.1 Overview + +**Table 6.1.3.2.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|-----------------|--------------------------------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| release | /ue-contexts/{ueContextId}/release | POST | Release an existing individual ueContext resource.
It is used for the Release UE Context service operation. | +| assign-ebi | /ue-contexts/{ueContextId}/assign-ebi | POST | Assign EPS bearer ID(s) towards EPS bearer(s) mapped from QoS Flow(s), for a PDU session for the UE.
It is used for EBIAssignment service operation. | +| transfer | /ue-contexts/{ueContextId}/transfer | POST | Transfer an existing individual ueContext resource from old AMF to new AMF.
It is used for the UEContextTransfer service operation. | +| transfer-update | /ue-contexts/{ueContextId}/transfer-update | POST | Update the source AMF about the status of UE registration at the target AMF.
It is used for the RegistrationStatusUpdate service operation. | +| relocate | /ue-contexts/{ueContextId}/relocate | POST | Relocate an existing individual ueContext resource.
It is used for the RelocateUEContext service operation. | +| relocate | /ue-contexts/{ueContextId}/cancel-relocate | POST | Cancel a UE Context Relocation.
It is used for the CancelRelocateUEContext service operation. | + +### 6.1.3.2.4.2 Operation: release (POST) + +#### 6.1.3.2.4.2.1 Description + +This ueContextId identifies the individual ueContext resource is composed by UE's SUPI or PEI, See table 6.1.3.2.2-1. + +#### 6.1.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.2.2-2. + +**Table 6.1.3.2.4.2.2-1: Data structures supported by the (POST) release Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------------------| +| UEContextRelease | M | 1 | The information used for releasing of the UE Context | + +**Table 6.1.3.2.4.2.2-2: Data structures supported by the (POST) release Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents the handover is cancelled successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- UNSPECIFIED
- SUPI_OR_PEI_UNKNOWN

See table 6.1.7.3-1 for the description of this error. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND

See table 6.1.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.2.4.3 Operation: assign-ebi (POST) + +##### 6.1.3.2.4.3.1 Description + +This ueContextId identifies the individual ueContext resource is composed by UE's SUPI or PEI, see Table 6.1.3.2.2-1. + +##### 6.1.3.2.4.3.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.2.4.3.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.3.2-2. + +**Table 6.1.3.2.4.3.2-1: Data structures supported by the (POST) assign-ebi Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|----------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AssignEbiData | M | 1 | The information required for AMF to allocate EPS bearer ID(s) or to update the mapping of EBI and ARP for a QoS flow to which an EBI is already allocated. | + +**Table 6.1.3.2.4.3.2-2: Data structures supported by the (POST) assign-ebi Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AssignedEbiData | M | 1 | 200 OK | Represent successful assignment of EPS bearer ID service operation, with the assigned EBIs included, or represent successful update of the mapping of EBI and ARP for a QoS flow to which an EBI is already allocated.
AMF may allocate only a subset of the requested EBIs, when not enough available EBI(s) can be allocated, e.g. when other PDU sessions with higher ARP have occupied too many EBIs. If the POST request body contained "releasedEbiList" the AMF shall release those EBI(s) and shall include the "releaseEbiList" IE in the POST response body.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 3) | +| AssignEbiError | O | 0..1 | 403
Forbidden | This represents the case when none of the requested EBI(s) can be assigned by the AMF. The "cause" attribute of the ProblemDetails shall be set to:
  • - EBI_EXHAUSTED, if the number of EBIs allocated for the UE has already reached the maximum limit.
  • - EBI_REJECTED_LOCAL_POLICY, if the EBI allocation is rejected due to local policies at the AMF as specified in clause 4.11.1.4.1 of 3GPP TS 23.502 [3].
  • - EBI_REJECTED_NO_N26, if the EBI allocation was rejected when the AMF is in a serving PLMN that does not support 5GS-EPS interworking procedures with N26 interface as specified in clause 5.17.2.3.1 of 3GPP TS 23.501 [2].
| +| ProblemDetails | O | 0..1 | 403
Forbidden | This error shall only be returned by an SCP for errors it originates. | +| AssignEbiError | O | 0..1 | 409
Conflict | This represents the case when none of the requested EBI(s) can be assigned by the AMF. The "cause" attribute of the ProblemDetails shall be set to:
  • - TEMPORARY_REJECT_REGISTRATION_ONGOING, if there is an ongoing registration procedure.
  • - TEMPORARY_REJECT_HANDOVER_ONGOING, if there is an ongoing N2 handover procedure or an ongoing Xn handover procedure.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: When receiving EBI assignment request during Xn Handover or N2 Handover, the AMF may either reject the request with the TEMPORARY\_REJECT\_HANDOVER\_ONGOING application error in a 409 Conflict response or proceed with assigning EBIs with a 200 OK response. In the latter case, upon receipt of the 200 OK response, the SMF shall take the assigned EBIs into account in subsequent processing. + +NOTE 3: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.4.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.4.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +6.1.3.2.4.4 Operation: transfer (POST) + +6.1.3.2.4.4.1 Description + +This ueContextId identifies the individual ueContext resource is composed by UE's 5G-GUTI or SUPI, see Table 6.1.3.2.2-1. + +6.1.3.2.4.4.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.2.4.4.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.4.2-2. + +**Table 6.1.3.2.4.4.2-1: Data structures supported by the (POST) transfer Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|-----------------------------------------------------------------------------------------------| +| UeContextTransferReqData | M | 1 | Represents to start transferring of an individual ueContext resource from old AMF to new AMF. | + +**Table 6.1.3.2.4.4.2-2: Data structures supported by the (POST) transfer Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UeContextTransferRspData | M | 1 | 200 OK | Indicates the transferring of the individual ueContext resource is started successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | Indicates that AMF can understand the request but cannot fulfil the request due to errors. If the integrity check of the included complete registration message fails at the source AMF the "cause" attribute is set to:
- INTEGRITY_CHECK_FAIL.

See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 404 Not Found | If the AMF does not have the requested UE context, the AMF shall return this status code and the "cause" attribute is set to:
- CONTEXT_NOT_FOUND

See table 6.1.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.4.4.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.4.4.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +6.1.3.2.4.5 Operation: transfer-update (POST) + +6.1.3.2.4.5.1 Description + +This ueContextId identifies the individual ueContext resource is composed by UE's 5G-GUTI, see Table 6.1.3.2.2-1. + +## 6.1.3.2.4.5.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.2.4.5.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.5.2-2. + +**Table 6.1.3.2.4.5.2-1: Data structures supported by the (POST) transfer-update Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------| +| UeRegStatusUpdateReqData | M | 1 | Represents to the update of status on the transferring of an individual ueContext resource from old AMF to new AMF. | + +**Table 6.1.3.2.4.5.2-2: Data structures supported by the (POST) transfer-update Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| UeRegStatusUpdateRspData | M | 1 | 200 OK | Indicates the update of UE context transfer status is successful at the source AMF. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | Indicates that AMF can understand the request but cannot fulfil the request due to errors. | +| ProblemDetails | O | 0..1 | 404 Not Found | If the AMF does not have the requested UE context, the AMF shall return this status code and the "cause" attribute is set to:
- CONTEXT_NOT_FOUND | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.4.5.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.4.5.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.1.3.2.4.6 Operation: relocate (POST) + +## 6.1.3.2.4.6.1 Description + +The ueContextId identifying the individual ueContext resource is composed by UE's SUPI or PEI, see Table 6.1.3.2.2-1. + +## 6.1.3.2.4.6.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.2.4.6.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.5.2-2. + +**Table 6.1.3.2.4.6.2-1: Data structures supported by the (POST) relocate Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|------------------------------------------------------| +| UeContextRelocateData | M | 1 | Defines the UE Context to be relocated to a new AMF. | + +**Table 6.1.3.2.4.6.2-2: Data structures supported by the (POST) relocate Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UeContextRelocatedData | M | 1 | 201 Created | This case represents the successful relocation of UE Context to a new AMF.
Upon success, a response body is returned containing the newly created UE Context in new AMF. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetail | O | 0..1 | 403 Forbidden | This case represents an unsuccessful relocation of UE Context to a new AMF.

The "cause" attribute may be used to indicate one of the following application errors:
- HANDOVER_FAILURE | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.4.6.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.4.6.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +6.1.3.2.4.7 Operation: cancel-relocate (POST) + +6.1.3.2.4.7.1 Description + +This ueContextId identifying the individual ueContext resource is composed by UE's SUPI or PEI, See table 6.1.3.2.2-1. + +6.1.3.2.4.7.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.2.4.7.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.7.2-2. + +**Table 6.1.3.2.4.7.2-1: Data structures supported by the (POST) release Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------------|---|-------------|-----------------------------------------------------------------| +| UEContextCancel RelocateData | M | 1 | The information used for cancellation of UE Context Relocation. | + +**Table 6.1.3.2.4.7.2-2: Data structures supported by the (POST) release Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents the handover is cancelled successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- UNSPECIFIED
- SUPI_OR_PEI_UNKNOWN

See table 6.1.7.3-1 for the description of this error. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND

See table 6.1.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.4.2.7-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set.
v For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.4.2.7-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.3.3 Resource: N1N2 Subscriptions Collection for Individual UE Contexts + +#### 6.1.3.3.1 Description + +This resource represents the collection under an individual UE context for storing the subscriptions for notifications of UE specific N1 and N2 message types. This resource is modelled as the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +#### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/namf-comm//{ueContextId}/n1-n2-messages/subscriptions + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1. | +| ueContextId | string | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: see pattern of type Supi in 3GPP TS 29.571 [6]
Or represents the Permanent Equipment Identifier (see 3GPP TS 23.501 [2] clause 5.9.3)
pattern: "(imei-[0-9]{15} imeisv-[0-9]{16} .+)" | + +#### 6.1.3.3.3 Resource Standard Methods + +##### 6.1.3.3.3.1 POST + +This method creates an individual N1/N2 information subscription resource for UE related N1/N2 information. This method is used by NF Service Consumers (e.g. PCF) to subscribe for notifications about UE related N1/N2 Information. + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.1.3.3.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UeN1N2InfoSubscriptionCreateData | C | 0..1 | Representation of the subscription for N1 and/or N2 information notification. It shall contain the information regarding N1 and/or N2 information to be notified and the callback URI for the respective notifications. | + +**Table 6.1.3.3.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UeN1N2InfoSubscriptionCreatedData | C | 0..1 | 201
Created | This case represents the successful creation of the subscription for N1 and/or N2 information notification.

Upon success, a response body is returned containing the representation describing the status of the request.

The Location header shall contain the location (URI) of the created subscription resource. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/namf-comm//ue-contexts/{ueContextId}/n1-n2-messages/subscriptions/{subscriptionId} | + +**Table 6.1.3.3.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.3.4 Resource Custom Operations + +There are no custom operations supported on this resource. + +#### 6.1.3.4 Resource: N1N2 Individual Subscription + +##### 6.1.3.4.1 Description + +This resource represents the individual subscription for the subscription for notifications of UE specific N1 and N2 message types. + +This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.1.3.4.2 Resource Definition + +Resource URI: {apiRoot}/namf-comm//{ueContextId}/n1-n2-messages/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.1.3.4.2-1. + +**Table 6.1.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1. | +| ueContextId | string | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: see pattern of type Supi in 3GPP TS 29.571 [6]
Or represents the Permanent Equipment Identifier (see 3GPP TS 23.501 [2] clause 5.9.3)
pattern: "(imei-[0-9]{15} imeisv-[0-9]{16} .+)" | +| subscriptionId | string | Represents the individual subscription to the UE specific N1/N2 message notification. | + +##### 6.1.3.4.3 Resource Standard Methods + +###### 6.1.3.4.3.1 DELETE + +This method deletes an individual N1/N2 message notification subscription resource for an individual UE. This method is used by NF Service Consumers (e.g. PCF) to unsubscribe for notifications about UE related N1/N2 information. + +This method shall support the request data structures specified in table 6.1.3.4.3.1-2 and the response data structures and response codes specified in table 6.1.3.4.3.1-3. + +**Table 6.1.3.4.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.4.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | If the resource corresponding to the SubscriptionId cannot be found, the AMF shall return this status code. The "cause" attribute is set to:
- SUBSCRIPTION_NOT_FOUND | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.4.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.4.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.4.4 Resource Custom Operations + +There are no custom operations supported on this resource. + +#### 6.1.3.5 Resource: N1N2 Messages Collection + +##### 6.1.3.5.1 Description + +This resource represents the collection on which UE related N1 messages and N2 information transfer are initiated and the N1 information for the UE is stored temporarily until the UE is reachable. This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.1.3.5.2 Resource Definition + +Resource URI: {apiRoot}/namf-comm//ue-contexts/{ueContextId}/n1-n2-messages + +This resource shall support the resource URI variables defined in table 6.1.3.5.2-1. + +**Table 6.1.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1. | +| ueContextId | string | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: see pattern of type Supi in 3GPP TS 29.571 [6]
Or represents the Permanent Equipment Identifier (see 3GPP TS 23.501 [2] clause 5.9.3)
pattern: "(imei-[0-9]{15} imeisv-[0-9]{16})"
Or represents the LCS Correlation ID (see 3GPP TS 29.572 [25] clause 6.1.6.3.2) (NOTE)
pattern: "(cid-{1,255})" | + +NOTE: The LCS Correlation ID shall only be applied when transferring LCS related UE-Specific N1 and/or N2 messages. + +### 6.1.3.5.3 Resource Standard Methods + +#### 6.1.3.5.3.1 POST + +This method initiates a N1 message and/or N2 message transfer at the AMF and may create a resource to store the N1 and/or N2 message as specified in clause 5.2.2.3.1.2, e.g. if asynchronous type communication is invoked or if the UE is paged. + +This method shall support the request data structures specified in table 6.1.3.5.3.1-1 and the response data structures and response codes specified in table 6.1.3.5.3.1-2. + +**Table 6.1.3.5.3.1-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| N1N2MessageTransferReqData | M | 1 | This contains:
- N1 message, if the NF Service Consumer requests to transfer an N1 message to the UE or;
- N2 information, if the NF Service Consumer requests to transfer an N2 information to the 5G-AN or;
- both, if the NF Service Consumer requests to transfer both an N1 message to the UE and an N2 information to the 5G-AN. | + +**Table 6.1.3.5.3.1-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| N1N2MessageTransferRspData | M | 1 | 202 Accepted |

This case represents the successful storage of the N1/N2 information at the AMF when asynchronous communication is invoked or when the AMF pages the UE. If the AMF pages the UE, it shall store the N1/N2 message information until the UE responds to paging.

The cause included in the response body shall be set to one of the following values:

  • - WAITING_FOR_ASYNCHRONOUS_TRANSFER
  • - ATTEMPTING_TO_REACH_UE

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. In this release, the URI shall only be used by NF Service consumer to correlate the possible N1/N2 Message Transfer Failure Notification with the related N1/N2 Message Transfer Operation. The NF service consumer shall not send any service requests towards the URI received in the Location header.

| +| N1N2MessageTransferRspData | M | 1 | 200 OK |

This represents the cases where:

  • - the AMF is able to successfully transfer the N1/N2 message to the UE and/or the AN;
  • - the AMF skips sending and discards the N1 message when UE is in CM-IDLE and the "skipInd" is set to "true" in the request; or
  • - the AMF skips sending and discards the N2 message as well as the possibly included N1 message, when the UE is in CM-CONNECTED state and the UE is outside of the validity area included in the N1N2MessageTransfer Request.

The cause included in the response body shall be to one of the following values:

  • - N1_N2_TRANSFER_INITIATED
  • - N1_MSG_NOT_TRANSFERRED
  • - N2_MSG_NOT_TRANSFERRED
| +| RedirectResponse | O | 0..1 | 307 Temporary Redirect |

Temporary redirection.

When the related UE context is not fully available at the target NF Service Consumer (e.g. AMF) during a planned maintenance case (e.g. AMF planned maintenance without UDSF case), the "cause" attribute shall be set to:

  • - NF_CONSUMER_REDIRECT_ONE_TXN

See table 6.1.7.3-1 for the description of these errors

(NOTE 2)

| +| RedirectResponse | O | 0..1 | 308 Permanent Redirect |

Permanent redirection.

(NOTE 2)

| +| ProblemDetails | O | 0..1 | 403 Forbidden |

The "cause" attribute may be used to indicate one of the following application errors:

  • - UE_IN_NON_ALLOWED_AREA
  • - UE_WITHOUT_N1_LPP_SUPPORT
  • - UNSPECIFIED
  • - SM_CONTEXT_RELOCATION_REQUIRED
  • - INVALID_PRU

See table 6.1.7.3-1 for the description of these errors.

| +| ProblemDetails | O | 0..1 | 404 Not Found |

When the related UE is not found in the NF Service Consumer (e.g. AMF), the "cause" attribute shall be set

| + +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | to:
- CONTEXT_NOT_FOUND

See table 6.1.7.3-1 for the description of these errors. | +| N1N2MessageTransferError | O | 0..1 | 409
Conflict | This represents the case where the AMF rejects the N1N2MessageTransfer request due to one of the following reasons. The cause attribute of the ProblemDetails structure shall be set to:
- HIGHER_PRIORITY_REQUEST_ONGOING, if there is already an ongoing paging procedure with higher or same priority;
-
TEMPORARY_REJECT_REGISTRATION_ONGOING, if there is an ongoing registration procedure (see clause 4.2.3.3 of 3GPP TS 23.502 [3]);
- TEMPORARY_REJECT_HANDOVER_ONGOING, if there is an ongoing Xn or N2 handover procedure (see clause 4.9.1.2.1 and 4.9.1.3.1 of 3GPP TS 23.502 [3]).
- UE_IN_CM_IDLE_STATE, if this is a request to transfer a N2 PDU Session Resource Modify Request or a N2 PDU Session Resource Release Command to a 5G-AN, and if the UE is in CM-IDLE state at the AMF for the Access Network Type associated to the PDU session.
- MAX_ACTIVE_SESSIONS_EXCEEDED, if the RAT type is NB-IoT, and the UE already has 2 PDU Sessions with active user plane resources.
- REJECTION_DUE_TO_PAGING_RESTRICTION, if Paging Restrictions information restricts the N1N2MessageTransfer request from causing paging as specified in 3GPP TS 23.501 [2] clause 5.38.5

See table 6.1.7.3-1 for the description of these errors.

The AMF may additionally provide the "retryAfter" IE in order for the NF service consumer to throttle sending further N1/N2 Message Transfer request for a short period, e.g. when there is ongoing paging procedure with higher or same priority or a ongoing registration procedure. | +| N1N2MessageTransferError | O | 0..1 | 504
Gateway
Timeout | This represents the case where the UE is not reachable at the AMF and the AMF is unable to page the UE. The cause attribute of the ProblemDetails structure shall be set to:
- UE_NOT_REACHABLE, if the UE is not reachable for paging;
- UE_NOT_RESPONDING, if the UE is not responding for a previous paging.

See table 6.1.7.3-1 for the description of these errors.

The AMF may additionally provide the "retryAfter" IE in order for the NF service consumer to throttle sending further N1/N2 Message Transfer request for a short period, e.g. when UE is not responding to paging. | +| ProblemDetails | O | 0..1 | 504
Gateway
Timeout | This error shall only be returned by an SCP or a SEPP for errors they originate. | +| NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). | | | | | +| NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. | | | | | + +**Table 6.1.3.5.3.1-3: Headers supported by the 202 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | The URI of the resource located on the AMF to which the status of the N1N2 message transfer is held | + +**Table 6.1.3.5.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | The URI of the resource located on an alternative service instance within the same AMF or AMF (service) set to which the request is redirected.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.5.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.1.3.6 Resource: subscriptions collection + +### 6.1.3.6.1 Description + +This resource represents a collection of subscriptions of NF service consumers to the status change of the AMF identified by the GUAMI(s). + +This resource is modelled as the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +### 6.1.3.6.2 Resource Definition + +Resource URI: {apiRoot}/namf-comm//subscriptions + +This resource shall support the resource URI variables defined in table 6.1.3.6.2-1. + +**Table 6.1.3.6.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|-------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1. | + +### 6.1.3.6.3 Resource Standard Methods + +#### 6.1.3.6.3.1 POST + +This method creates a new subscription. This method shall support the URI query parameters specified in table 6.1.3.6.3.1-1. + +**Table 6.1.3.6.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.6.3.1-2 and the response data structures and response codes specified in table 6.1.3.6.3.1-3. + +**Table 6.1.3.6.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------| +| SubscriptionData | M | 1 | The request body contains the input parameters for the subscription. These parameters include, e.g.:
- GUAMI(s)
- amfStatusUri | + +**Table 6.1.3.6.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SubscriptionData | M | 1 | 201
Created | This case represents the successful creation of a subscription.

Upon success, the HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403
Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- UNSPECIFIED

See table 6.1.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.6.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/namf-comm//subscriptions/{subscriptionId} | + +**Table 6.1.3.6.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.6.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.3.7 Resource: individual subscription + +#### 6.1.3.7.1 Description + +This resource represents an individual subscription of a NF service consumer to the status change of the AMF identified by the GUAMI(s). + +This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +#### 6.1.3.7.2 Resource Definition + +Resource URI: {apiRoot}/namf-comm//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.1.3.7.2-1. + +**Table 6.1.3.7.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1. | +| subscriptionId | string | Represents a specific subscription | + +#### 6.1.3.7.3 Resource Standard Methods + +##### 6.1.3.7.3.1 DELETE + +This method terminates an existing subscription. This method shall support the URI query parameters specified in table 6.1.3.7.3.1-1. + +**Table 6.1.3.7.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.7.3.1-2 and the response data structures and response codes specified in table 6.1.3.7.3.1-3. + +**Table 6.1.3.7.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.7.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | 204 No Content | This case represents a successful deletion of the subscription. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | If the resource corresponding to the SubscriptionId cannot be found, the AMF shall return this status code. The "cause" attribute is set to:
- SUBSCRIPTION_NOT_FOUND | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.7.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.7.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.7.3.2 PUT + +This method replaces an existing subscription completely. This method shall support the URI query parameters specified in table 6.1.3.7.3.2-1. + +**Table 6.1.3.7.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.7.3.2-2 and the response data structures and response codes specified in table 6.1.3.7.3.2-3. + +**Table 6.1.3.7.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------| +| SubscriptionData | M | 1 | The request body contains the input parameters for the subscription. These parameters include, e.g.:
- GUAMI(s)
- amfStatusUri | + +**Table 6.1.3.7.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------| +| SubscriptionData | M | 1 | 200 OK | This case represents a successful replacement of the subscription. | +| n/a | | | 204 No Content | Represents the events subscription modification provided by the NF Service Consumer is accepted entirely. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | This case represents the failure update of an existing subscription. | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.7.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.7.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.1.3.8 Resource: Non UE N2 Messages Collection + +### 6.1.3.8.1 Description + +This resource represents the collection on which custom operations to transfer the N2 message towards the 5G-AN are specified. This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +### 6.1.3.8.2 Resource Definition + +Resource URI: {apiRoot}/namf-comm//non-ue-n2-messages + +This resource shall support the resource URI variables defined in table 6.1.3.8.2-1. + +**Table 6.1.3.8.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|------------|-----------|-------------------| +| apiRoot | String | See clause 6.1.1 | +| apiVersion | String | See clause 6.1.1. | + +### 6.1.3.8.3 Resource Standard Methods + +There are no resource standard methods for the non-ue-n2-messages collection resource in this release of this specification. + +### 6.1.3.8.4 Resource Custom Operations + +#### 6.1.3.8.4.1 Overview + +**Table 6.1.3.8.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------|------------------------|--------------------|-----------------------------------| +| transfer | {resourceUri}/transfer | POST | Transfer the N2 message to 5G-AN. | + +#### 6.1.3.8.4.2 Operation: transfer + +##### 6.1.3.8.4.2.1 Description + +The {resourceUri}/transfer custom operation is used to initiate a non UE associated N2 information transfer to the identified 5G-AN nodes. This custom operation uses the HTTP POST method. + +##### 6.1.3.8.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.8.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.8.4.2.2-2. + +**Table 6.1.3.8.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------------|---|-------------|------------------------------------------------------------------------| +| N2InformationTransferReqData | M | 1 | Representation of the data to be sent to the 5G-AN node(s) by the AMF. | + +**Table 6.1.3.8.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| N2InformationTransferRspData | M | 1 | 200 OK | Indicates AMF has successfully initiated the transferring of N2 Information to the AN.. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| N2InformationTransferError | O | 0..1 | 400 Bad Request | The "cause" attribute may be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4]. | +| ProblemDetails | O | 0..1 | 400 Bad Request | This error shall only be returned by an SCP or a SEPP for errors they originate. | +| N2InformationTransferError | O | 0..1 | 403 Forbidden | The "cause" attribute may be set to one of the following application errors:
- UNSPECIFIED
See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This error shall only be returned by an SCP or a SEPP for errors they originate. | +| N2InformationTransferError | O | 0..1 | 404 Not Found | The "cause" attribute may be set to one of the following application errors:
- CONTEXT_NOT_FOUND
See table 6.1.7.3-1 for the description of these errors. | +| N2InformationTransferError | O | 0..1 | 500 Internal Server Error | The "cause" attribute may be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4]. | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | This error shall only be returned by an SCP or a SEPP for errors they originate. | +| N2InformationTransferError | O | 0..1 | 503 Service Unavailable | The "cause" attribute may be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4]. | +| ProblemDetails | O | 0..1 | 503 Service Unavailable | This error shall only be returned by an SCP or a SEPP for errors they originate. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.8.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.8.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.3.9 Resource: Non UE N2 Messages Subscriptions Collection + +#### 6.1.3.9.1 Description + +This resource represents the collection on which individual subscriptions for non UE N2 messages from the 5G-AN are stored. This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +#### 6.1.3.9.2 Resource Definition + +Resource URI: {apiRoot}/namf-comm//non-ue-n2-messages/subscriptions + +This resource shall support the resource URI variables defined in table 6.1.3.9.2-1. + +**Table 6.1.3.9.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|-------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1. | + +#### 6.1.3.9.3 Resource Standard Methods + +##### 6.1.3.9.3.1 POST + +This method creates an individual N2 information subscription resource for non UE related N2 information. This method is used by NF Service Consumers (e.g. LMF, CBCF/PWS-IWF) to subscribe for notifications about non UE related N2 Information from a specific 5G-AN node, or from any 5G-AN node. + +This method shall support the request data structures specified in table 6.1.3.9.3.1-2 and the response data structures and response codes specified in table 6.1.3.9.3.1-3. + +**Table 6.1.3.9.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------------|---|-------------|---------------------------------------------------------------------| +| NonUeN2InfoSubscriptionCreateData | M | 1 | Representation of the subscription for N2 information notification. | + +**Table 6.1.3.9.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------|---|-------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NonUeN2InfoSubscriptionCreated Data | M | 1 | 201
Created | This case represents the successful creation of the subscription for N2 information notification.

Upon success, a response body is returned containing the representation describing the status of the request. The Location header shall carry the location (URI) of the created subscription resource. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403
Forbidden | If the NF Service Consumer is not authorized to subscribe for non UE N2 message notifications, the AMF shall return this status code with the ProblemDetails | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.9.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/namf-comm//non-ue-n2-messages/subscriptions/{n2NotifySubscriptionId} | + +**Table 6.1.3.9.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.9.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.9.4 Resource Custom Operations + +There are no custom operations supported on this resource. + +### 6.1.3.10 Resource: Non UE N2 Message Notification Individual Subscription + +#### 6.1.3.10.1 Description + +This resource represents the individual subscription for the notifications of non UE specific N2 message types (e.g. NRPPa, PWS Notifications). + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +#### 6.1.3.10.2 Resource Definition + +Resource URI: {apiRoot}/namf-comm//non-ue-n2-messages/subscriptions/{n2NotifySubscriptionId} + +This resource shall support the resource URI variables defined in table 6.1.3.10.2-1. + +**Table 6.1.3.7.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------------------|-----------|----------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1. | +| n2NotifySubscriptionId | string | Represents the individual subscription to the non UE specific N2 message notification. | + +#### 6.1.3.10.3 Resource Standard Methods + +##### 6.1.3.10.3.1 DELETE + +This method deletes an individual N2 message notification subscription resource for non UE associated N2 information. This method is used by NF Service Consumers (e.g. LMF) to unsubscribe for notifications about non UE related N2 information. + +This method shall support the request data structures specified in table 6.1.3.10.3.1-2 and the response data structures and response codes specified in table 6.1.3.10.3.1-3. + +**Table 6.1.3.10.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.10.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | If the resource corresponding to the SubscriptionId cannot be found the AMF shall return this status code. The "cause" attribute is set to:
- SUBSCRIPTION_NOT_FOUND | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.10.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.10.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.10.4 Resource Custom Operations + +There are no custom operations supported on this resource. + +### 6.1.4 Custom Operations without associated resources + +There are no custom operations without associated resources supported on Namf\_Communication Service. + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +The notifications provided by the Namf\_Communication service are specified in this clause. + +**Table 6.1.5.1-1: Callback overview** + +| Notification | Resource URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------------------|--------------------------|---------------------------------|---------------------------------| +| AMF Status Change Notification | {amfStatusUri} | POST | | +| Non UE N2 Information Notification | {n2NotifyCallbackUri} | POST | | +| N1 Message Notification | {n1NotifyCallbackUri} | POST | | +| UE Specific N2 Information Notification | {n2NotifyCallbackUri} | POST | | +| N1N2 Transfer Failure Notification | {n1n2FailureTxfNotifURI} | POST | | + +## 6.1.5.2 AMF Status Change Notification + +### 6.1.5.2.1 Description + +If a NF service consumer (e.g. SMF) has subscribed to AMF Status Change on Namf\_Communication Service, when AMF aware of a change of its own status, AMF shall create a notification including the current state, and shall deliver the notification to the call-back URI, following Subscribe/Notify mechanism defined in 3GPP TS 29.501 [5]. + +### 6.1.5.2.2 Notification Definition + +Call-back URI: {amfStatusUri} + +Call-back URI is provided by NF Service Consumer during creation of the subscription. + +### 6.1.5.2.3 Notification Standard Methods + +#### 6.1.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.2.3.1-1 and the response data structures and response codes specified in table 6.1.5.2.3.1-2. + +**Table 6.1.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|-------------------------------------------------------| +| AmfStatusChangeNotification | M | 1 | Representation of the AMF status change notification. | + +**Table 6.1.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents a successful notification of the AMF status change. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | When context of the notification is not found, the "cause" attribute shall be set to:
- CONTEXT_NOT_FOUND | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.1.5.3 Non UE N2 Information Notification + +### 6.1.5.3.1 Description + +This resource represents the callback reference provided by the NF Service Consumer (e.g. LMF, CBCF/PWS-IWF) to receive notifications about N2 information that are not related to a UE. + +### 6.1.5.3.2 Notification Definition + +Callback URI: {n2NotifyCallbackUri} + +This notification shall support the callback URI variables defined in table 6.1.5.2.2-1. + +**Table 6.1.5.3.2-1: Callback URI variables for this notification** + +| Name | Definition | +|---------------------|------------------------------------------------------------------------------------------------------| +| n2NotifyCallbackUri | Callback reference provided by the NF Service Consumer during the subscription to this notification. | + +### 6.1.5.3.3 Notification Standard Methods + +#### 6.1.5.3.3.1 POST + +This method sends an N2 information notification to the NF Service Consumer (e.g. LMF, CBCF/PWS-IWF). + +This method shall support the request data structures specified in table 6.1.5.3.3.1-2 and the response data structures and response codes specified in table 6.1.5.3.3.1-3. + +**Table 6.1.5.3.3.1-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|----------------------------------------------------| +| N2InformationNotification | M | 1 | Representation of the N2 information notification. | + +**Table 6.1.5.3.3.1-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents a successful notification of the N2 information to the NF service consumer. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.5.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | + +**Table 6.1.5.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.1.5.4 N1 Message Notification + +### 6.1.5.4.1 Description + +This resource represents the callback reference provided by the NF Service Consumer (e.g. LMF) to receive notifications about N1 message from the UE (e.g. LPP messages). + +### 6.1.5.4.2 Notification Definition + +Callback URI: { n1NotifyCallbackUri } + +Callback URI is provided by the NF Service Consumer during the subscription to this notification. . The callback URI for N1 message notification may also be obtained from the NRF, if the NF Service Consumer has registered it in the NF Profile with the NRF. + +### 6.1.5.4.3 Notification Standard Methods + +#### 6.1.5.4.3.1 POST + +This method sends an N1 message notification to the NF Service Consumer (e.g. LMF). + +This method shall support the request data structures specified in table 6.1.5.4.3.1-2 and the response data structures and response codes specified in table 6.1.5.4.3.1-3. + +**Table 6.1.5.4.3.1-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|------------------------------------------------| +| N1MessageNotification | M | 1 | Representation of the N1 message notification. | + +**Table 6.1.5.4.3.1-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents a successful notification of the N1 message to the NF service consumer. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | This case represents, the NF service consumer failing to accept the processing of the notified N1 message. The detailed information shall be provided in the ProblemDetails structure. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.5.4.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.5.4.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.1.5.5 UE Specific N2 Information Notification + +### 6.1.5.5.1 Description + +This resource represents the callback reference provided by the NF Service Consumer (e.g. LMF) to receive notifications about UE specific N2 information. + +### 6.1.5.5.2 Notification Definition + +Callback URI: {n2NotifyCallbackUri} + +Callback URI is provided by the NF Service Consumer during the subscription to this notification. + +### 6.1.5.5.3 Notification Standard Methods + +#### 6.1.5.5.3.1 POST + +This method sends an N2 information notification to the NF Service Consumer (e.g. LMF). + +This method shall support the request data structures specified in table 6.1.5.5.3.1-2 and the response data structures and response codes specified in table 6.1.5.5.3.1-3. + +**Table 6.1.5.5.3.1-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|----------------------------------------------------| +| N2InformationNotification | M | 1 | Representation of the N2 information notification. | + +**Table 6.1.5.5.3.1-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents a successful notification of the N2 information to the NF service consumer. | +| N2InfoNotificationRspData | M | 1 | 200 OK | This case represents a successful notification of the N2 information to the NF service consumer when information needs to be returned in the response. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.5.5.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.5.5.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent'.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.1.5.6 N1N2 Transfer Failure Notification + +### 6.1.5.6.1 Description + +This resource represents the callback reference provided by the NF Service Consumer (e.g. SMF) to receive notifications about failure to deliver N1 / N2 message. + +### 6.1.5.6.2 Notification Definition + +Callback URI: {n1n2FailureTxfNotifURI} + +Callback URI is provided by the NF Service Consumer during the UE specific N1N2MessageTransfer operation (see clause 6.1.3.5.3.1). + +### 6.1.5.6.3 Notification Standard Methods + +#### 6.1.5.6.3.1 POST + +This method sends an N1/N2 message transfer failure notification to the NF Service Consumer (e.g. SMF). + +This method shall support the request data structures specified in table 6.1.5.6.3.1-1 and the response data structures and response codes specified in table 6.1.5.6.3.1-3. + +**Table 6.1.5.6.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| N1N2MsgTxfrFailureNotification | M | 1 |

Representation of the N1/N2 message transfer failure notification.

The "cause" attribute shall be set to one of following cause values (see clause 6.1.6.3.6):

  • - UE_NOT_RESPONDING
  • - UE_NOT_REACHABLE_FOR_SESSION
  • - TEMPORARY_REJECT_REGISTRATION_ONGOING
  • - TEMPORARY_REJECT_HANDOVER_ONGOING
  • - REJECTION_DUE_TO_PAGING_RESTRICTION
  • - AN_NOT_RESPONDING
  • - FAILURE_CAUSE_UNSPECIFIED

The AMF may additionally provide the "retryAfter" IE in order for the NF service consumer to throttle sending further N1/N2 Message Transfer request for a short period, e.g. when UE is not responding to paging.

| + +**Table 6.1.5.6.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents a successful notification of the N1 / N2 message transfer to the NF service consumer. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.5.6.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 |

A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4].

| +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.5.6.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.5.7 Void + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Namf\_Communication service based interface protocol. + +**Table 6.1.6.1-1: Namf\_Communication specific Data Types** + +| Data type | Clause defined | Description | +|------------------------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SubscriptionData | 6.1.6.2.2 | Data within an AMF Status Change Subscription request and response. | +| AmfStatusChangeNotification | 6.1.6.2.3 | Data within an AMF Status Change Notification request. | +| AmfStatusInfo | 6.1.6.2.4 | AMF Status Information | +| AssignEbiData | 6.1.6.2.5 | Data within an EBI assignment request. | +| AssignedEbiData | 6.1.6.2.6 | Data within a successful response to an EBI assignment request. | +| AssignEbiFailed | 6.1.6.2.7 | Represents failed assignment of EBI(s) | +| UEContextRelease | 6.1.6.2.8 | Data within a Release UE Context request. | +| N2InformationTransferReqData | 6.1.6.2.9 | Data within a N2 Information Transfer request containing the N2 information requested to be transferred to 5G AN. | +| NonUeN2InfoSubscriptionCreateData | 6.1.6.2.10 | Data within a create subscription request for non-UE specific N2 information notification. | +| NonUeN2InfoSubscriptionCreatedData | 6.1.6.2.11 | Data for the created subscription for non-UE specific N2 information notification. | +| UeN1N2InfoSubscriptionCreateData | 6.1.6.2.12 | Data within a create subscription request for UE specific N1 and/or N2 information notification. | +| UeN1N2InfoSubscriptionCreatedData | 6.1.6.2.13 | Data for the created subscription for UE specific N1 and/or N2 information notification. | +| N2InformationNotification | 6.1.6.2.14 | Data within a N2 information notification request. | +| N2InfoContainer | 6.1.6.2.15 | N2 information container. | +| N1MessageNotification | 6.1.6.2.16 | Data within a N1 message notification request. | +| N1MessageContainer | 6.1.6.2.17 | N1 Message Container. | +| N1N2MessageTransferReqData | 6.1.6.2.18 | Data within a N1/N2 message transfer request. | +| N1N2MessageTransferRspData | 6.1.6.2.19 | Data within a N1/N2 message transfer response. | +| RegistrationContextContainer | 6.1.6.2.20 | Registration Context Container used to send the UE context information, N1 message from UE, AN address etc during Registration with AMF re-allocation procedure. | +| AreaOfValidity | 6.1.6.2.21 | Area of validity information for N2 information transfer | +| UeContextTransferReqData | 6.1.6.2.23 | Data within a UE Context Transfer Request to start transferring of an individual ueContext resource from old AMF to new AMF. | +| UeContextTransferRspData | 6.1.6.2.24 | Data within a successful response to the UE Context Transfer request. | +| UeContext | 6.1.6.2.25 | Represents an individual ueContext resource | +| N2SmInformation | 6.1.6.2.26 | Represents the session management SMF related N2 information data part. | +| N2InfoContent | 6.1.6.2.27 | Represents a transparent N2 information content to be relayed by AMF. | +| NrppaInformation | 6.1.6.2.28 | Represents a NRPPa related N2 information data part. | +| PwsInformation | 6.1.6.2.29 | Represents a PWS related information data part. | +| N1N2MsgTxfrFailureNotification | 6.1.6.2.30 | Data within a N1/N2 Message Transfer Failure Notification request | +| N1N2MessageTransferError | 6.1.6.2.31 | Data within a N1/N2 Message Transfer Error response. | +| N1N2MsgTxfrErrDetail | 6.1.6.2.32 | N1/N2 Message Transfer Error Details | +| N2InformationTransferRspData | 6.1.6.2.33 | Data within a successful response to the N2 Information Transfer request to transfer N2 Information to the AN. | +| MmContext | 6.1.6.2.34 | Represents a Mobility Management Context in UE Context | +| SeafData | 6.1.6.2.35 | Represents SEAF data derived from data received from AUSF | + +| | | | +|-----------------------------|------------|-----------------------------------------------------------------------------------------------------------------------------------| +| NasSecurityMode | 6.1.6.2.36 | Indicates the NAS Security Mode | +| PduSessionContext | 6.1.6.2.37 | Represents a PDU Session Context in UE Context | +| NssaiMapping | 6.1.6.2.38 | Represents the mapping between a S-NSSAI in serving PLMN to a S-NSSAI in home PLMN. | +| UeRegStatusUpdateReqData | 6.1.6.2.39 | Data within a UE registration status update request to indicate a completion of transferring at a target AMF. | +| AssignEbiError | 6.1.6.2.40 | Data within a failure response to the EBI assignment request. | +| UeContextCreateData | 6.1.6.2.41 | Data within a request to create an individual ueContext resource | +| UeContextCreatedData | 6.1.6.2.42 | Data within a successful response for creating an individual ueContext resource | +| UeContextCreateError | 6.1.6.2.43 | Data within a failure response for creating a UE context | +| NgRanTargetId | 6.1.6.2.44 | Indicates a NG RAN as target of the handover | +| N2InformationTransferError | 6.1.6.2.45 | Data within a failure response for a non-UE related N2 Information Transfer. | +| PWSResponseData | 6.1.6.2.46 | Data related PWS included in a N2 Information Transfer response. | +| PWSErrorData | 6.1.6.2.47 | Data related to PWS error included in a N2 Information Transfer failure response. | +| NgKsi | 6.1.6.2.49 | Represents the ngKSI (see 3GPP TS 33.501 [27]) | +| KeyAmf | 6.1.6.2.50 | Represents the K amf or K' amf . (see 3GPP TS 33.501 [27]). | +| ExpectedUeBehavior | 6.1.6.2.51 | Represents the expected UE behavior (e.g. UE moving trajectory) and its validity period. | +| UeRegStatusUpdateRspData | 6.1.6.2.52 | Data within a UE registration status update response to provides the status of UE context transfer status update at a source AMF. | +| N2RanInformation | 6.1.6.2.53 | Represents the RAN related N2 information data part. | +| N2InfoNotificationRspData | 6.1.6.2.54 | Data within a N2 information notification response. | +| SmallDataRateStatusInfo | 6.1.6.2.55 | Represents the small data rate status | +| SmfChangeInfo | 6.1.6.2.56 | SMF change information for PDU session(s) | +| V2xContext | 6.1.6.2.57 | Represents the V2X services related parameters | +| ImmediateMdtConf | 6.1.6.2.58 | Immediate MDT Configuration | +| V2xInformation | 6.1.6.2.59 | V2X related N2 information | +| EpsNasSecurityMode | 6.1.6.2.60 | Indicates the EPS NAS Security Mode | +| UeContextRelocateData | 6.1.6.2.61 | Data within a Relocate UE Context request | +| UeContextRelocatedData | 6.1.6.2.62 | Data within a Relocate UE Context | +| EcRestrictionDataWb | 6.1.6.2.64 | Enhanced Coverage Restriction Data for WB-N1 mode. | +| ExtAmfEventSubscription | 6.1.6.2.65 | AMF event subscription extended with additional information received for the subscription | +| AmfEventSubscriptionAddInfo | 6.1.6.2.66 | Additional information received for an AMF event subscription, e.g. binding indications. | +| UeContextCancelRelocateData | 6.1.6.2.67 | Data structure used for cancellation of UE Context Relocation. | +| UeDifferentiationInfo | 6.1.6.2.68 | Represents the UE Differentiation Information and its validity time. | +| CeModeBlnd | 6.1.6.2.69 | CE-mode-B Support Indicator | +| LteMInd | 6.1.6.2.70 | LTE-M Indication | +| NpnAccessInfo | 6.1.6.2.71 | NPN Access Information | +| ProseContext | 6.1.6.2.72 | Represents the ProSE services related parameters | +| AnalyticsSubscription | 6.1.6.2.73 | Analytics subscriptions created in the NWDAF. | +| NwdafSubscription | 6.1.6.2.74 | Individual NWDAF subscription identified by the subscription Id. | +| UpdpSubscriptionData | 6.1.6.2.75 | UE policy delivery related N1 message notification subscription data | +| ProSelInformation | 6.1.6.2.76 | 5G ProSe related N2 information. | + +| | | | +|--------------------------------|------------|--------------------------------------------------------------------------------------------| +| ReleaseSessionInfo | 6.1.6.2.77 | PDU session Id(s) and the cause for triggering the release | +| AreaOfInterestEventState | 6.1.6.2.78 | Area Of Interest Event State in old AMF | +| TssInformation | 6.1.6.2.79 | TSS related N2 information | +| AmPolicyInfoContainer | 6.1.6.2.80 | AM Policy Information Container | +| RslpInformation | 6.1.6.2.81 | Ranging/SL positioning related N2 information | +| A2xContext | 6.1.6.2.82 | Represents the A2X services related parameters | +| A2xInformation | 6.1.6.2.83 | A2X related N2 information | +| LcsUpContext | 6.1.6.2.84 | Represents the LCS UP related parameters | +| EpsBearerId | 6.1.6.3.2 | EPS Bearer Identifier | +| Ppi | 6.1.6.3.2 | Paging Policy Indicator | +| NasCount | 6.1.6.3.2 | Represents a NAS COUNT | +| 5GMMCapability | 6.1.6.3.2 | Represents a 5GMM capability | +| UeSecurityCapability | 6.1.6.3.2 | Represents a UE Security Capability | +| S1UeNetworkCapability | 6.1.6.3.2 | Represents a S1 UE Network Capability | +| DrxParameter | 6.1.6.3.2 | Indicates the UE DRX Parameters | +| OmcIdentifier | 6.1.6.3.2 | Represents the OMC Identifier | +| MsClassmark2 | 6.1.6.3.2 | Indicates the MS Classmark 2 of a 5G SRVCC UE | +| SupportedCodec | 6.1.6.3.2 | Indicates the supported codec of a 5G SRVCC UE | +| StatusChange | 6.1.6.3.3 | Enumeration for AMF status | +| N2InformationClass | 6.1.6.3.4 | Enumeration for N2 Information Class | +| N1MessageClass | 6.1.6.3.5 | Enumeration for N1 Message Class | +| N1N2MessageTransferCause | 6.1.6.3.6 | Enumeration for N1N2Message Transfer Cause | +| UeContextTransferStatus | 6.1.6.3.7 | Describes the status of an individual ueContext resource in UE Context Transfer procedures | +| N2InformationTransferResult | 6.1.6.3.8 | Describes the result of N2 information transfer by AMF to the AN. | +| CipheringAlgorithm | 6.1.6.3.9 | Indicates the supported Ciphering Algorithm | +| IntegrityAlgorithm | 6.1.6.3.10 | Indicates the supported Integrity Algorithm | +| SmsSupport | 6.1.6.3.11 | Indicates the supported SMS delivery of a UE. | +| ScType | 6.1.6.3.12 | Indicates the security context type. | +| KeyAmfType | 6.1.6.3.13 | Indicates the K amf type. | +| TransferReason | 6.1.6.3.14 | Indicates UE Context Transfer Reason | +| PolicyReqTrigger | 6.1.6.3.15 | Policy Request Triggers | +| RatSelector | 6.1.6.3.16 | Indicates the RAT type for the transfer of N2 information | +| NgapleType | 6.1.6.3.17 | Indicates the supported NGAP IE types | +| N2InfoNotifyReason | 6.1.6.3.18 | N2 Information Notify Reason | +| SmfChangeIndication | 6.1.6.3.19 | Indicates the I-SMF or V-SMF change or removal | +| SbiBindingLevel | 6.1.6.3.20 | SBI Binding Level | +| EpsNasCipheringAlgorithm | 6.1.6.3.21 | Indicates the supported EPS NAS Ciphering Algorithm | +| EpsNasIntegrityAlgorithm | 6.1.6.3.22 | Indicates the supported EPS NAS Integrity Algorithm | +| PeriodicCommunicationIndicator | 6.1.6.3.23 | Indicates the Periodic Communication Indicator | +| UuaaMmStatus | 6.1.6.3.24 | Indicates UUAA-MM status | +| ReleaseCause | 6.1.6.3.25 | The cause for triggering the release | + +Table 6.1.6.1-2 specifies data types re-used by the Namf service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Namf service based interface. + +**Table 6.1.6.1-2: Namf re-used Data Types** + +| Data type | Reference | Comments | +|------------------------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Snssai | 3GPP TS 29.571 [6] | | +| Arp | 3GPP TS 29.571 [6] | | +| PduSesisonId | 3GPP TS 29.571 [6] | | +| Guami | 3GPP TS 29.571 [6] | Globally Unique AMF Identifier | +| AmfName | 3GPP TS 29.571 [6] | The name of the AMF | +| Supi | 3GPP TS 29.571 [6] | Subscription Permanent Identifier | +| Cause | 3GPP TS 29.571 [6] | 5G-AN Cause | +| ProblemDetails | 3GPP TS 29.571 [6] | Detailed problems in failure case | +| supportedFeatures | 3GPP TS 29.571 [6] | Supported Features | +| TimeZone | 3GPP TS 29.571 [6] | | +| UserLocation | 3GPP TS 29.571 [6] | | +| AccessType | 3GPP TS 29.571 [6] | | +| AllowedNssai | 3GPP TS 29.531 [18] | | +| NfInstanceId | 3GPP TS 29.571 [6] | | +| Uri | 3GPP TS 29.571 [6] | | +| Ecgi | 3GPP TS 29.571 [6] | EUTRA Cell Identifier | +| Ncgi | 3GPP TS 29.571 [6] | NR Cell Identifier | +| Uint16 | 3GPP TS 29.571 [6] | | +| 5Qi | 3GPP TS 29.571 [6] | 5G QoS Identifier | +| CorrelationID | 3GPP TS 29.572 [25] | LCS Correlation ID | +| Pei | 3GPP TS 29.571 [6] | | +| Dnn | 3GPP TS 29.571 [6] | | +| Gpsi | 3GPP TS 29.571 [6] | | +| GroupId | 3GPP TS 29.571 [6] | | +| PlmnId | 3GPP TS 29.571 [6] | | +| RfspIndex | 3GPP TS 29.571 [6] | | +| EbiArpMapping | 3GPP TS 29.502 [16] | EBI - ARP mapping | +| NsiId | 3GPP TS 29.531 [18] | | +| TraceData | 3GPP TS 29.571 [6] | Trace control and configuration parameters | +| ConfiguredSnssai | 3GPP TS 29.531 [18] | | +| NgApCause | 3GPP TS 29.571 [6] | Represents the NG AP cause IE | +| Area | 3GPP TS 29.571 [6] | | +| ServiceAreaRestriction | 3GPP TS 29.571 [6] | | +| CoreNetworkType | 3GPP TS 29.571 [6] | | +| Ambr | 3GPP TS 29.571 [6] | | +| SliceMbr | 3GPP TS 29.571 [6] | | +| GlobalRanNodeId | 3GPP TS 29.571 [6] | | +| NfGroupId | 3GPP TS 29.571 [6] | Network Function Group Id | +| DurationSec | 3GPP TS 29.571 [6] | | +| StnSr | 3GPP TS 29.571 [6] | Session Transfer Number for SRVCC | +| CMSisdN | 3GPP TS 29.571 [6] | Correlation MSISDN | +| DateTime | 3GPP TS 29.571 [6] | | +| SmallDataRateStatus | 3GPP TS 29.571 [6] | | +| NfSetId | 3GPP TS 29.571 [13] | NF Set ID | +| NfServiceSetId | 3GPP TS 29.571 [13] | NF Service Set ID | +| LMFIdentification | 3GPP TS 29.572 [25] | LMF Identification | +| PlmnAssiUeRadioCapId | 3GPP TS 29.571 [6] | | +| ManAssiUeRadioCapId | 3GPP TS 29.571 [6] | | +| NrV2xAuth | 3GPP TS 29.571 [6] | NR V2X services authorized | +| LteV2xAuth | 3GPP TS 29.571 [6] | LTE V2X services authorized | +| BitRate | 3GPP TS 29.571 [6] | Bit Rate | +| Pc5QoSPara | 3GPP TS 29.571 [6] | PC5 QoS parameters | +| PduSessionInfo | 3GPP TS 29.571 [6] | The Slice and DNN combination of a PDU session. | +| PcfUeCallbackInfo | 3GPP TS 29.571 [6] | The callback information of the PCF for the UE to allow the PCF for the PDU session to send SM Policy Association Establishment and Termination events notification. | +| CnAssistedRanPara | 3GPP TS 29.502 [16] | SMF derived CN assisted RAN Parameters Tuning | +| MoExpDataCounter | 3GPP TS 29.571 [6] | MO Exception Data Counter | +| CagData | 3GPP TS 29.503 [35] | Closed Access Group Data | +| NssaaStatus | 3GPP TS 29.571 [6] | Subscribed S-NSSAI subject to NSSAA procedure and the status | +| JobType | 3GPP TS 29.571 [6] | Job Type in the trace | + +| | | | +|--------------------------------|---------------------|-----------------------------------------------------------------| +| MeasurementLteForMdt | 3GPP TS 29.571 [6] | Measurements used for MDT in LTE in the trace | +| MeasurementNrForMdt | 3GPP TS 29.571 [6] | Measurements used for MDT in NR in the trace | +| ReportingTrigger | 3GPP TS 29.571 [6] | Reporting Triggers for MDT in the trace | +| ReportIntervalMdt | 3GPP TS 29.571 [6] | Report Interval for MDT in LTE in the trace | +| ReportAmountMdt | 3GPP TS 29.571 [6] | Report Amount for MDT in the trace | +| CollectionPeriodRmmLteMdt | 3GPP TS 29.571 [6] | Collection period for RRM measurements LTE for MDT in the trace | +| MeasurementPeriodLteMdt | 3GPP TS 29.571 [6] | Measurement period LTE for MDT in the trace in | +| AreaScope | 3GPP TS 29.571 [6] | Area Scope | +| PositioningMethodMdt | 3GPP TS 29.571 [6] | Positioning Method for MDT in the trace in LTE | +| ReportIntervalNrMdt | 3GPP TS 29.571 [6] | Report Interval for MDT in NR in the trace | +| CollectionPeriodRmmNrMdt | 3GPP TS 29.571 [6] | Collection period for RRM measurements NR for MDT in the trace | +| SensorMeasurement | 3GPP TS 29.571 [6] | Sensor information for MDT in the trace | +| ScheduledCommunicationTime | 3GPP TS 29.571 [6] | Scheduled Communication Time | +| StationaryIndication | 3GPP TS 29.571 [6] | Stationary Indication | +| TrafficProfile | 3GPP TS 29.571 [6] | Traffic Profile | +| BatteryIndication | 3GPP TS 29.571 [6] | Battery Indication | +| NFType | 3GPP TS 29.510 [29] | NF type | +| UeAuth | 3GPP TS 29.571 [6] | UE authorisation for PC5 service | +| PartitioningCriteria | 3GPP TS 29.571 [6] | Partitioning Criteria | +| RedirectResponse | 3GPP TS 29.571 [6] | Response body of the redirect response message. | +| CagId | 3GPP TS 29.571 [6] | CAG ID | +| NnwdafEventsSubscription | 3GPP TS 29.520 [52] | Represents an Individual NWDAF Event Subscription resource | +| PresenceInfo | 3GPP TS 29.571 [6] | | +| UePositioningCapabilities | 3GPP TS 29.572 [25] | Indicates the positioning capabilities supported by the UE. | +| SmfSelectionData | 3GPP TS 29.507 [32] | | +| EpsInterworkingInfo | 3GPP TS 29.503 [35] | | +| IpAddress | 3GPP TS 29.503 [35] | | +| Fqdn | 3GPP TS 29.571 [6] | | +| PresenceState | 3GPP TS 29.571 [6] | Presence State | +| SatelliteBackhaulCategory | 3GPP TS 29.571 [6] | Satellite Backhaul Category | +| WirelineServiceAreaRestriction | 3GPP TS 29.571 [6] | | +| PartiallyAllowedSnssai | 3GPP TS 29.571 [6] | S-NSSAI with TAI information | +| VarRepPeriod | 3GPP TS 29.571 [6] | Variable Reporting Periodicity | +| AsTimeDistributionParam | 3GPP TS 29.507 [32] | | +| Prulnd | 3GPP TS 29.503 [35] | PRU Indicator | +| SliceUsageControlInfo | 3GPP TS 29.571 [6] | Slice Usage Control Information | +| MbsrOperationAllowed | 3GPP TS 29.503 [35] | MBSR Operation Information | +| UpConnectionStatus | 3GPP TS 29.572 [25] | Satellite Backhaul Category | +| LMFIdentification | 3GPP TS 29.572 [25] | | +| TaiRange | 3GPP TS 29.510 [29] | TAI range | + +## 6.1.6.2 Structured data types + +### 6.1.6.2.1 Introduction + +Structured data types used in Namf\_Communication service are specified in this clause. + +## 6.1.6.2.2 Type: SubscriptionData + +**Table 6.1.6.2.2-1: Definition of type SubscriptionData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| amfStatusUri | Uri | M | 1 | This IE shall include the callback URI to receive notification of AMF status change. | +| guamiList | array(Guami) | C | 1..N | This IE shall be absent for subscribing to status change for any GUAMI supported by the AMF, it shall be present for subscribing to specific GUAMIs supported by the AMF. | + +## 6.1.6.2.3 Type: AmfStatusChangeNotification + +**Table 6.1.6.2.3-1: Definition of type AmfStatusChangeNotification** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|----------------------|---|-------------|-------------------------------------------------------------------| +| amfStatusInfoList | array(AmfStatusInfo) | M | 1..N | This IE shall contain the status change information about the AMF | + +## 6.1.6.2.4 Type: AmfStatusInfo + +**Table 6.1.6.2.4-1: Definition of type AmfStatusInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|--------------|---|-------------|-------------------------------------------------------------------------------------------------------| +| guamiList | array(Guami) | M | 1..N | This IE shall contain the GUAMIs | +| statusChange | StatusChange | M | 1 | This IE shall contain the Status change of the related GUAMIs | +| targetAmfRemoval | AmfName | C | 0..1 | This IE shall contain the AMF Name of the target AMF in the AMF planned removal without UDSF scenario | +| targetAmfFailure | AmfName | C | 0..1 | This IE shall contain the AMF Name of the target AMF in the AMF Auto-recovery without UDSF scenario. | + +## 6.1.6.2.5 Type: AssignEbiData + +**Table 6.1.6.2.5-1: Definition of type AssignEbiData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| pduSessionId | PduSessionId | M | 1 | Represents the identifier of the PDU Session requesting EBI(s) to be assigned. | | +| arpList | array(Arp) | C | 1..N | This IE shall be present if the NF Service Consumer (e.g SMF) requests the AMF to assign EBI(s) for the PDU session. When present, this IE shall contain the list of ARP(s) of the QoS flow(s) for which EBI(s) are requested. | | +| releasedEbiList | array(EpsBearerId) | C | 1..N | This IE shall be present if the NF Service Consumer (e.g. SMF) needs to release the assigned EBI(s) from QoS flows (e.g. when the QoS flow is released). | | +| oldGuami | Guami | C | 0..1 | This IE shall be present during an AMF planned removal procedure when the NF Service Consumer initiates a request towards the target AMF, for a UE associated to an AMF that is unavailable (see clause 5.21.2.2 of 3GPP TS 23.501 [2]). | | +| modifiedEbiList | array(EbiArpMapping) | C | 1..N | This IE shall be present if a PDU session modification procedure resulted in the change of ARP for a QoS flow to which an EBI is already allocated. | EAEA | + +## 6.1.6.2.6 Type: AssignedEbiData + +**Table 6.1.6.2.6-1: Definition of type AssignedEbiData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| pduSessionId | PduSessionId | M | 1 | Represents the identifier of the PDU Session requesting EBI(s) to be assigned. | | +| assignedEbiList | array(EbiArpMapping) | M | 0..N | This IE shall be present if the AMF assigned the requested EBI(s). This IE shall contain the successfully assigned EBIs. (NOTE) | | +| failedArpList | array(Arp) | C | 1..N | This IE shall be present if the AMF fails to allocate EBIs for a set of ARP(s). (NOTE) | | +| releasedEbiList | array(EpsBearerId) | C | 1..N | This IE shall be present if the NF Service Consumer requested the release of EBI(s) or if the AMF revoked an already assigned EBI towards the same PDU session. This IE shall contain the list of EBI(s) released at the AMF. | | +| modifiedEbiList | array(EpsBearerId) | C | 1..N | This IE shall be present if the NF Service Consumer requested to update the ARP for a QoS flow to which an EBI is already allocated. This IE shall contain the list of EBI(s) whose ARP has been updated at the AMF. | EAEA | + +NOTE: The same ARP value may be returned in the assignedEbiList and in the failedArpList, if the request included the same ARP value more than once in the arpList and the AMF is not able to allocate an EBI for every occurrence of this ARP value. + +## 6.1.6.2.7 Type: AssignEbiFailed + +**Table 6.1.6.2.7-1: Definition of type AssignEbiFailed** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|--------------------------------------------------------------------------------| +| pduSessionId | PduSessionId | M | 1 | Represents the identifier of the PDU Session requesting EBI(s) to be assigned. | +| failedArpList | array(Arp) | C | 1..N | This IE shall be present if the AMF fails to allocate EBIs for a set of ARPs. | + +## 6.1.6.2.8 Type: UEContextRelease + +**Table 6.1.6.2.8-1: Definition of type UEContextRelease** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supi | Supi | C | 0..1 | This IE shall be present if the UE is emergency registered and the SUPI is not authenticated. | +| unauthenticatedSupi | boolean | C | 0..1 | When present, this IE shall be set as follows:
  • - true: unauthenticated SUPI;
  • - false (default): authenticated SUPI.
This IE shall be present if the SUPI is present in the message but is not authenticated and is for an emergency registered UE. | +| ngapCause | NgApCause | M | 1 | This IE shall contain the cause value received from the source 5G-AN in the handover Cancel message received over the NGAP interface. | + +## 6.1.6.2.9 Type: N2InformationTransferReqData + +**Table 6.1.6.2.9-1: Definition of type N2InformationTransferReqDataTransfer** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| taiList | array(Tai) | C | 1..N | This IE shall be included if the N2 information needs to be sent to the 5G-AN nodes that serve the list of tracking areas provided. | +| ratSelector | RatSelector | C | 0..1 | This IE shall be included to indicate if the N2 information shall be transferred to ng-eNBs or gNBs exclusively. | +| globalRanNodeList | array(GlobalRanNodeId) | C | 1..N | This IE shall be included if the N2 information needs to be sent to the list of RAN nodes provided. | +| n2Information | N2InfoContainer | M | 1 | This IE includes the information to be sent on the N2 interface to the identified 5G-AN nodes and additional information required for the processing of the message by the AMF. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | + +## 6.1.6.2.10 Type: NonUeN2InfoSubscriptionCreateData + +Table 6.1.6.2.10-1: Definition of type NonUeN2InfoSubscriptionCreateData + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------------------------|------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| globalRanNodeList | array(GlobalRanNodeID) | C | 1..N | This IE shall be included if the subscription is for N2 information from RAN node(s) for which the N2 information notification is subscribed (i.e N3IWF identifier or gNB identifier or Ng-eNB identifier).
(NOTE) | +| anTypeList | array(AccessType) | C | 1..N | This IE shall be included, if the globalRanNodeID IE is not included and if the N2 information from a specific access network needs to be subscribed. When included this IE shall contain the access type of the access network from which Non UE specific N2 information is to be notified.
(NOTE) | +| n2InformationClass | N2InformationClass | M | 1 | This IE represents the class of N2 information that the NF Service Consumer requires to be notified. | +| n2NotifyCallbackUri | Uri | M | 1 | This IE represents the callback URI on which the N2 information shall be notified. | +| nflId | NfInstanceId | C | 0..1 | This IE shall be present if the subscription is for "NRPPa" N2 information class and/or "LPP" N1 information class. When present, this IE shall carry the value to be used for NGAP "Routing ID" IE, which identifies the Network Function (e.g. LMF) instance handling the NRPPa and/or LPP data.

This IE may also be present if the subscription is for "PWS" N2 information class. When present, this IE shall carry the instance identity of the network function (e.g. CBCF or PWS-IWF) creating the subscription. This IE should be included when more than one CBCF/PWS-IWF instances are deployed in the network. The AMF may use this IE to identify whether the same CBCF/PWS-IWF instance has subscribed for N2 PWS information to receive the PWS Response data from the RAN.

This IE shall be present if the subscription is for "TSS" N2 information class. When present, this IE shall identify the TSCTSF NF instance subscribing the TSS data. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | +| notifCorrelationId | string | O | 0..1 | When present, this IE shall contain the notification correlation ID of the subscription. | +| NOTE: Absence of both IEs means the subscription is for N2 information from all connected Access Network node(s) via any access type. | | | | | + +## 6.1.6.2.11 Type: NonUeN2InfoSubscriptionCreatedData + +Table 6.1.6.2.11-1: Definition of type NonUeN2InfoSubscriptionCreatedData + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|--------------------|---|-------------|------------------------------------------------------------------------------------------------------| +| n2NotifySubscriptionId | string | M | 1 | Represents the Id created by the AMF for the subscription to notify a non-UE related N2 information. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | +| n2InformationClass | N2InformationClass | O | 0..1 | This IE represents the class of N2 information that the NF Service Consumer subscribed to. | + +## 6.1.6.2.12 Type: UeN1N2InfoSubscriptionCreateData + +Table 6.1.6.2.12-1: Definition of type UeN1N2InfoSubscriptionCreateData + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n2InformationClass | N2InformationClass | C | 0..1 | This IE shall be present if the NF service consumer subscribes for a N2 information notification. This IE represents the class of N2 information that the NF Service Consumer requires to be notified. | +| n2NotifyCallbackUri | Uri | C | 0..1 | This IE shall be present if the NF service consumer subscribes for a N2 information notification. This IE represents the callback URI on which the N2 information shall be notified. | +| n1MessageClass | N1MessageClass | C | 0..1 | This IE shall be present if the NF service consumer subscribes for a N1 message notification. This IE represents the class of N1 message that the NF Service Consumer requires to be notified. | +| n1NotifyCallbackUri | Uri | C | 0..1 | This IE shall be present if the NF service consumer subscribes for a N1 message notification. This IE represents the callback URI on which the N1 message shall be notified. | +| nflId | NfInstanceId | C | 0..1 | This IE shall be present if the subscription is for "NRPPa" N2 information class and/or "LPP" N1 information class. When present, this IE shall carry the value to be used for NGAP "Routing ID" IE, which identifies the Network Function (e.g. LMF) instance handling the NRPPa and/or LPP data. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | +| oldGuami | Guami | C | 0..1 | This IE shall be present during an AMF planned removal procedure when the NF Service Consumer initiates a request towards the target AMF, for a UE associated to an AMF that is unavailable (see clause 5.21.2.2 of 3GPP TS 23.501 [2]). | + +## 6.1.6.2.13 Type: UeN1N2InfoSubscriptionCreatedData + +Table 6.1.6.2.13-1: Definition of type UeN1N2InfoSubscriptionCreatedData + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------| +| n1n2NotifySubscriptionId | string | M | 1 | Represents the Id created by the AMF for the subscription to notify a UE related N1/N2 information. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | + +6.1.6.2.14 Type: N2InformationNotification + +**Table 6.1.6.2.14-1: Definition of type N2InformationNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| n2NotifySubscriptionId | string | M | 1 | Represents the subscription Id for which the notification is generated. The NF Service Consumer uses this to co-relate the notification against a corresponding subscription. If the notification is due to an implicit subscription via NRF, then the value shall be set as "implicit". During the AMF planned removal procedure with UDSF deployed procedure, this IE shall be set to "" (empty string) and be ignored by the NF Service Consumer. | | +| n2InfoContainer | N2InfoContainer | C | 0..1 | This IE shall be present, except during Inter NG-RAN node N2 based handover procedure (see clause 5.2.2.3.6.2).

When present, this IE shall contain the N2 information related to the corresponding N2 information class. | | +| toReleaseSessionList | array(PduSessionId) | C | 1..N | This IE shall be present during N2 based handover procedure, if there are any PDU session(s) associated with Network Slice(s) which become no longer available.

When present, this IE shall include all the PDU session(s) associated with no longer available S-NSSAI(s). | | +| lcsCorrelationId | CorrelationID | C | 0..1 | This IE shall be present, if an LCS correlation identifier is received in corresponding N1/N2 Message Transfer service operation.

When present, this IE shall carry the LCS correlation identifier. | | +| notifyReason | N2InfoNotifyReason | C | 0..1 | This IE shall be present, if "n2InfoContainer" attribute is not present; this IE may be present otherwise.

When present, this IE indicates the reason for the N2 information notification. | | +| smfChangeInfoList | array(SmfChangeInfo) | C | 1..N | This IE shall be present during N2 based handover procedure, if there is I-SMF or V-SMF change or removal for the related PDU session(s).

When present, this IE shall indicate the I-SMF/V-SMF situation after successful HO complete. | DTSSA | +| ranNodeId | GlobalRanNodeId | C | 0..1 | This IE shall be present during the AMF planned removal procedure with UDSF deployed procedure. When present, it shall contain the Global RAN Node ID. The IE shall contain either the gNB ID or the NG-eNB ID. | | +| initialAmfName | AmfName | C | 0..1 | This IE shall be present during the AMF planned removal procedure with UDSF deployed procedure. When present, it shall contain the AMF Name of the initial AMF. | | +| anN2IPv4Addr | Ipv4Addr | C | 0..1 | This IE shall be present during the AMF planned removal procedure with | | + +| | | | | | | +|--------------------|----------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | UDSF deployed procedure, if the Access Network N2 interface is using IPv4 address. | | +| anN2IPv6Addr | Ipv6Addr | C | 0..1 | This IE shall be present during the AMF planned removal procedure with UDSF deployed procedure, if the Access Network N2 interface is using IPv6 address. | | +| guami | Guami | C | 0..1 | This IE shall be present during Location Services procedures (see clause 5.2.2.3.6.3) and it may be present otherwise.

When present, it shall contain the GUAMI serving the UE. | | +| notifySourceNgRan | boolean | C | 0..1 | This IE shall be present during an Inter NG-RAN node N2 based DAPS handover procedure , if the target AMF receives this indication in the Handover Notify from the target NG-RAN node (see clause 4.9.1.3.3a of 3GPP TS 23.502 [3]).
When present, it shall be set as follows:
  • - true: Notify the Source NG-RAN about Handover Success
  • - false (default): Do not notify the Source NG-RAN about Handover Success
| | +| notifCorrelationId | string | O | 0..1 | When present, this IE shall contain the notification correlation ID of the subscription. | | + +## 6.1.6.2.15 Type: N2InfoContainer + +**Table 6.1.6.2.15-1: Definition of type N2InfoContainer** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| n2InformationClass | N2InformationClass | M | 1 | This IE represents the class of N2 information to be transferred. | | +| smInfo | N2SmInformation | C | 0..1 | This IE shall be present if session management N2 information is to be transferred. When present, it represents a session management SMF related N2 information data part. | | +| ranInfo | N2RanInformation | C | 0..1 | This IE shall be present if RAN related N2 information is to be transferred (i.e. n2InformationClass is "RAN"). When present, it shall contain the RAN related N2 information data part. | | +| nrppaInfo | NrppaInformation | C | 0..1 | This IE shall be present if location service related N2 information is to be transferred. When present, it represents a NRPPa related N2 information data part. | | +| pwsInfo | PwsInformation | C | 0..1 | This IE shall be present if PWS related N2 information is to be transferred. | | +| v2xInfo | V2xInformation | C | 0..1 | This IE shall be present if V2X related N2 information is to be transferred. | | +| proseInfo | ProSeInformation | C | 0..1 | This IE shall be present if 5G ProSe related N2 information is to be transferred. | ProSe | +| tssInfo | TssInformation | C | 0..1 | This IE shall be present if TSS related N2 information is to be transferred. | NTSSM | +| rsIpInfo | RsIpInformation | C | 0..1 | This IE shall be present if Ranging/SL positioning related N2 information is to be transferred. | Ranging_SL | +| a2xInfo | A2xInformation | C | 0..1 | This IE shall be present if A2X related N2 information is to be transferred. | A2X | + +## 6.1.6.2.16 Type: N1MessageNotification + +Table 6.1.6.2.16-1: Definition of type N1MessageNotification + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n1NotifySubscriptionId | string | C | 0..1 | Represents the subscription Id for which the notification is generated. The NF Service Consumer uses this to correlate the notification against a corresponding subscription. If the notification is due to an implicit subscription via NRF, then the value shall be set as "implicit".
This IE shall be present if the notification is based on a subscription to N1MessageNotification. An exception is for the case when initial AMF forwards NAS message to target AMF during AMF re-allocation procedure. | +| n1MessageContainer | N1MessageContainer | M | 1 | Contains the N1 message class and N1 message content. | +| lcsCorrelationId | CorrelationID | O | 0..1 | If the N1 message notified is for LCS procedures or PRU procedures, the NF Service Producer (e.g. AMF) may include an LCS correlation identifier. | +| registrationCtxtContainer | RegistrationContextContainer | C | 0..1 | If the N1 message notified is of type 5GMM (i.e. during Registration with AMF re-allocation procedure), the NF Service Producer (e.g. AMF) shall include this IE, if available. | +| newLmfIdentification | LMFIdentification | O | 0..1 | If a new LMF is selected by AMF, this IE may include the new selected LMF Identification. | +| guami | Guami | C | 0..1 | This IE shall be present during UE Assisted and UE Based Positioning Procedure (see clause 5.2.2.3.5.3) or the LCS Event Report, Event Reporting in RRC INACTIVE state procedures, LCS Cancel Location and LCS Periodic-Triggered Invoke Procedures (see clause 5.2.2.3.5.5) and it may be present otherwise.

When present, it shall contain the GUAMI serving the UE. | +| cloT5GSOptimisation | boolean | C | 0..1 | This IE shall be present when the N1 message class is "LPP/LCS" and the N1 message is received from the UE with Control Plane CloT 5GS Optimisation. When present, it shall be set as follows:
- true: Control Plane CloT 5GS Optimisation was used and no signalling or data is currently pending for the UE at the AMF.
- false (default): Control Plane CloT 5GS Optimisation was not used or signalling or data is currently pending for the UE at the AMF. | +| ecgi | Ecgi | O | 0..1 | When present, this IE shall indicate the identifier of the E-UTRAN cell serving the UE.
This IE may be present if the N1 message notified is for LCS procedures. | +| ncgi | Ncgi | O | 0..1 | When present, this IE shall indicate the identifier of the NR cell serving the UE or the PRU.
This IE may be present if the N1 message notified is for LCS procedures or PRU procedures. | +| tai | Tai | O | 0..1 | When present, this IE shall indicate the identifier of the tracking area serving the PRU.
This IE may be present if the N1 message notified is for PRU procedures. | +| supi | Supi | O | 0..1 | When present, this IE shall indicate the SUPI of the PRU.
This IE may be present if the N1 message notified is for PRU procedures. | +| prulnd | Prulnd | O | 0..1 | When present, this IE shall indicate whether the UE is allowed to serve as a PRU.
This IE may be present if the N1 message notified is for PRU procedures. | + +## 6.1.6.2.17 Type: N1MessageContainer + +**Table 6.1.6.2.17-1: Definition of type N1MessageContainer** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n1MessageClass | N1MessageClass | M | 1 | This IE shall contain the N1 message class for the message content specified in n1MessageContent. | +| n1MessageContent | RefToBinaryData | M | 1 | This IE shall reference the N1 message binary data corresponding to the n1MessageClass. See 3GPP TS 24.501 [11]. See clause 6.1.6.4.2. | +| nflId | NfInstanceId | C | 0..1 | This IE shall be present when the n1MessageClass IE is set to "LPP", or "LCS". It should be present when the n1MessageClass IE is set to "SM". It may be present otherwise.
When present, this IE shall carry the identifier of the Network Function (e.g. LMF or SMF) instance sending the N1 message. (NOTE) | +| serviceInstanceId | string | O | 0..1 | When present, this IE shall carry the Service Instance Identifier of the Service Instance (e.g. LMF) sending the N1 message. | +| NOTE: For a Home-routed PDU session, this IE shall carry the NF instance ID of the V-SMF; for a PDU session with I-SMF, this IE shall carry the NF instance ID of the I-SMF. | | | | | + +6.1.6.2.18 Type: N1N2MessageTransferReqData + +**Table 6.1.6.2.18-1: Definition of type N1N2MessageTransferReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| n1MessageContainer | N1MessageContainer | C | 0..1 | This IE shall be included if a N1 message needs to be transferred. | | +| n2InfoContainer | N2InfoContainer | C | 0..1 | This IE shall be included if a N2 information needs to be transferred. | | +| mtData | RefToBinaryData | C | 0..1 | This IE shall be included if mobile terminated data (i.e. CIoT user data container) needs to be transferred. When present, it shall reference the mobile terminated data (see clause 6.1.6.4.4). | CIoT | +| skipInd | boolean | C | 0..1 | This IE shall be present and set to "true" if the service consumer (e.g. SMF) requires the N1 message to be sent to the UE only when UE is in CM-CONNECTED, e.g. during SMF initiated PDU session release procedure (see clause 4.3.4.2 of 3GPP TS 23.502 [3]).

When present, this IE shall be set as following:
- true: AMF should skip sending N1 message to UE, when the UE is in CM-IDLE.
- false (default): the AMF shall send the N1 message to the UE. | | +| lastMsgIndication | boolean | O | 0..1 | This flag when present shall indicate that the message transferred is the last message. (See clause 4.13.3.3 and clause 4.13.3.6 of 3GPP TS 23.502 [3]). | | +| pduSessionId | PduSessionId | O | 0..1 | PDU Session ID for which the N1 / N2 message is sent, if the N1 / N2 message class is SM. | | +| lcsCorrelationId | CorrelationID | O | 0..1 | LCS Correlation ID, for which the N1/N2 message is sent, if

- the N1 message class is LPP (see clause 6.11.1 of 3GPP TS 23.273 [42]) or LCS (see clause 6.3 of 3GPP TS 23.273 [42]) and clause 6.17 of 3GPP TS 23.273 [42]); and/or

- the N2 Information class is NRPPa (see clause 6.11.2 of 3GPP TS 23.273 [42]). | | +| ppi | Ppi | O | 0..1 | This IE when present shall indicate the Paging policy to be applied. The paging policies are configured at the AMF. | | +| arp | Arp | O | 0..1 | This IE when present shall indicate the Allocation and Retention Priority of the PDU session for which the N1/N2 message transfer is initiated. To support priority paging, the AMF shall use this IE to determine whether to include the Paging Priority IE in the NGAP Paging Message (see clause 5.4.3.3 of 3GPP TS 23.501 [2]). The set of ARP values associated with priority paging and mapping to Paging Priority IE values are configured at the AMF. | | + +| | | | | | | +|--|--|--|--|----------------------------------------------------------------------|--| +| | | | | This IE shall not be present when the N1/N2 message class is not SM. | | +|--|--|--|--|----------------------------------------------------------------------|--| + +| | | | | | | +|------------------------|-------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| 5qi | 5Qi | O | 0..1 | This IE when present shall indicate the 5QI associated with the PDU session for which the N1 / N2 message transfer is initiated. This IE shall not be present when the N1/N2 message class is not SM. | | +| n1n2FailureTxfNotifURI | Uri | O | 0..1 | If included, this IE represents the callback URI on which the AMF shall notify the N1/N2 message transfer failure. | | +| smfReallocationInd | boolean | O | 0..1 | This IE shall indicate that the SMF is requested to be reallocated (see clause 4.3.5.2 of 3GPP TS 23.502 [3]).
When present, this IE shall be set as follows:
- true: the SMF is requested to be reallocated.
- false (default): the SMF is not requested to be reallocated. | | +| areaOfValidity | AreaOfValidity | O | 0..1 | This IE represents the list of TAs where the provided N2 information is valid. See clause 5.2.2.2.7 and 4.2.3.3 of 3GPP TS 23.502 [3]. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | +| oldGuami | Guami | C | 0..1 | This IE shall be present during an AMF planned removal procedure when the NF Service Consumer initiates a request towards the target AMF, for a UE associated to an AMF that is unavailable (see clause 5.21.2.2 of 3GPP TS 23.501 [2]). | | +| maAcceptedInd | boolean | C | 0..1 | This IE shall be present if a request to establish a MA PDU session was accepted or if a single access PDU session was upgraded into a MA PDU session (see clauses 4.22.2 and 4.22.3 of 3GPP TS 23.502 [3]).

When present, it shall be set as follows:
- true: MA PDU session
- false (default): single access PDU session | MAPDU | +| extBufSupport | boolean | O | 0..1 | This IE may be present with value "true" if Extended Buffering is permitted, during Network triggered Service Request Procedure (see clause 4.2.3.3 of 3GPP TS 23.502 [3]), UPF anchored Mobile Terminated Data Transport in Control Plane CLoT 5GS Optimisation procedure (see clause 4.24.2 of 3GPP TS 23.502 [3]) or NEF Anchored Mobile Terminated Data Transport (see clause 4.25.5 of 3GPP TS 23.502 [3]).

When present, this IE shall indicate whether Extended Buffering applies or not:

- true: Extended Buffering applies
- false (default) Extended Buffering | | + +| | | | | | | +|--------------|--------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------| +| | | | | does not apply | | +| targetAccess | AccessType | C | 0..1 |

This IE shall be included by a SMF for a MA PDU session to indicate the target access type (i.e. 3GPP access or Non-3GPP access) towards which the N2 information and optionally N1 information is requested to be sent.

This IE may be included by an LMF to indicate the access type through which an LPP message shall be transmitted to the UE.

This IE shall be included by an SMF and set to the old access type during an intra-AMF handover between 3GPP and non-3GPP accesses, when releasing the N2 PDU session resources in the old access.

|

MAPDU

ELCS

3GA-N3GA-HO

| +| nflId | NfInstanceId | C | 0..1 |

This IE should be included by the SMF when invoking N1N2MessageTransfer service operation, if the n1MessageContainer IE is not present.

When present, this IE shall carry the identifier of the NF instance invoking the service operation, i.e. the SMF instance hosting the SM Context for the PDU session. (NOTE 3)

| | +| pruInd | boolean | O | 0..1 |

When present, this IE shall be set to the value true to indicate that the LMF as NF consumer is requesting to initiate a positioning procedure towards a PRU, as specified in clause 6.11.2 of 3GPP TS 23.273 [42].

| | + +NOTE 1: For N1 message class "UPDP", as per 3GPP TS 24.501 [11] Annex D, the messages between UE and PCF carry PTI which is used by the PCF to correlate the received N1 message in the notification with a prior transaction initiated by the PCF. + +NOTE 2: During Downlink Data Notification procedure, if the SMF receives the PPI value (=DSCP(0..63)) from the UPF and wants to set the PPI value in the N1N2MessageTransfer message, the SMF shall map the PPI value received from N4 message to correct PPI value (0..7) used in N11 message. + +NOTE 3: If the n1MessageContainer IE is present, the nflId attribute in the n1MessageContainer IE should be used by the SMF and the AMF to identify the NF instance ID of the sending SMF. + +#### 6.1.6.2.19 Type: N1N2MessageTransferRspData + +**Table 6.1.6.2.19-1: Definition of type N1N2MessageTransferRspData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|--------------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| cause | N1N2MessageTransferCause | M | 1 | This IE shall provide the result of the N1/N2 message transfer processing at the AMF. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | + +6.1.6.2.20 Type: RegistrationContextContainer + +**Table 6.1.6.2.20-1: Definition of type RegistrationContextContainer** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ueContext | UeContext | M | 1 | This IE shall contain the UE Context information. | +| localTimeZone | TimeZone | O | 0..1 | This IE contains the time zone UE is currently located. | +| anType | AccessType | M | 1 | This IE shall contain the current access type of the UE. | +| anN2ApId | integer | M | 1 | This IE shall contain the RAN UE NGAP ID over N2 interface. | +| ranNodeId | GlobalRanNodeId | M | 1 | This IE shall contain the Global RAN Node ID. The IE shall contain either the gNB ID or the NG-eNB ID. | +| initialAmfName | AmfName | M | 1 | This IE shall contain the AMF Name of the initial AMF. | +| userLocation | UserLocation | M | 1 | This IE shall contain the user location received from 5G-AN. | +| anN2IPv4Addr | Ipv4Addr | C | 0..1 | If the Access Network N2 interface is using IPv4 address, this IE shall be included. | +| anN2IPv6Addr | Ipv6Addr | C | 0..1 | If the Access Network N2 interface is using IPv6 address, this IE shall be included. | +| rrcEstCause | string | C | 0..1 | This IE shall contain the RRC Establishment Cause, if received from the 5G-AN (See 3GPP TS 38.413 [12], clause 9.2.5.1).
It carries the value in hexadecimal representation
Pattern: "[0-9a-fA-F]+" | +| ueContextRequest | boolean | C | 0..1 | This IE shall contain the indication on whether UE context including security information needs to be setup at the NG-RAN, if received from the NG-RAN by the initial AMF (See 3GPP TS 38.413 [12], clause 9.2.5.1).

When present, it shall be set as follows:
- true: UE context including security information needs to be setup at the NG-RAN.
- false (default): UE context including security information does not need to be setup at the NG-RAN. | +| initialAmfN2ApId | integer | C | 0..1 | This IE shall contain the AMF UE NGAP ID of the initial AMF over N2 interface, if available. | +| allowedNssai | AllowedNssai | O | 0..1 | This IE contains the allowed NSSAI of the UE. This IE also contains the mapped home network S-NSSAI for each allowed S-NSSAI. | +| configuredNssai | array(ConfiguredSnssai) | O | 1..N | This IE shall contain the configured S-NSSAI(s) authorized by the NSSF in the serving PLMN, if received from the NSSF. | +| rejectedNssaiInPlmn | array(SNSSAI) | O | 1..N | This IE shall contain the rejected NSSAI in the PLMN, if received from the NSSF. | +| rejectedNssaiInTa | array(SNSSAI) | O | 1..N | This IE shall contain the rejected NSSAI in the current TA, if received from the NSSF. | +| selectedPlmnId | PlmnId | O | 0..1 | This IE shall contain the selected PLMN Id for the non-3GPP access, if received from the 5G-AN (See 3GPP TS 38.413 [12], clause 9.2.5.1). | +| iabNodeId | boolean | O | 0..1 | This IE shall contain the IAB Node Indication, if received from the 5G-AN (See 3GPP TS 38.413 [12], clause 9.2.5.1).

When present, it shall be set as follows:
- true: 5G-AN is an IAB Node.
- false (default): 5G-AN is not an IAB Node. | +| mbsrNodeId | boolean | O | 0..1 | This IE shall contain the MBSR Node Indication, if received from the 5G-AN.

When present, it shall be set as follows:
- true: 5G-AN is an MBSR Node.
- false (default): 5G-AN is not an MBSR Node. | +| ceModeBInd | CeModeBInd | O | 0..1 | This IE shall contain the CE-mode-B Support Indicator, if received from the 5G-AN (See 3GPP TS 38.413 [12], clause 9.2.5.1). | + +| | | | | | +|------------------|---------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lteMInd | LteMInd | O | 0..1 | This IE shall contain the LTE-M Indication, if received from the 5G-AN (See 3GPP TS 38.413 [12], clause 9.2.5.1). | +| authenticatedInd | boolean | O | 0..1 | This IE shall contain the Authenticated Indication, if received from the 5G-AN (See 3GPP TS 38.413 [12], clause 9.2.5.1).

This IE shall be set as follows:
- true: authenticated by the 5G-AN;
- false (default): unauthenticated by the 5G-AN. | +| npnAccessInfo | NpnAccessInfo | O | 0..1 | This IE shall contain the NPN Access Information, if received from the 5G-AN (See 3GPP TS 38.413 [12], clause 9.2.5.1). | + +#### 6.1.6.2.21 Type: AreaOfValidity + +**Table 6.1.6.2.21-1: Definition of type AreaOfValidity** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------|---------------| +| tailList | array(Tai i) | M | 0..N | An array of TAI representing the area of validity of the associated N2 information provided. | | +| tailRangeList | array(Tai iRange) | O | 1..N | A list of TAI ranges representing the area of validity of the associated N2 information provided.

(NOTE) | AoV-En | + +NOTE: When the tailRangeList is present, the aggregation of tailList attribute and tailRangeList indicates the entire area of validity of the associated N2 information. + +#### 6.1.6.2.22 Void + +#### 6.1.6.2.23 Type: UeContextTransferReqData + +**Table 6.1.6.2.23-1: Definition of type UeContextTransferReqData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reason | TransferReason | M | 1 | Indicate the reason for the UEContextTransfer service request | +| accessType | AccessType | M | 1 | This IE shall contain the access type of the UE. | +| plmnId | PlmnIdNid | O | 0..1 | If present, this IE shall contain the PLMN ID or SNPN ID of the NF service consumer (e.g target AMF). | +| regRequest | N1MessageContainer | O | 0..1 | If present, this IE shall refer to the registration request message which triggers the UE Context Transfer. The message class shall be "5GMM" and message content shall be reference to N1 Message Content binary data, See clause 6.1.6.4.2. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | + +## 6.1.6.2.24 Type: UeContextTransferRspData + +Table 6.1.6.2.24-1: Definition of type UeContextTransferRspData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ueContext | UeContext | M | 1 | Represents an individual ueContext resource after the modification is applied. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | +| ueRadioCapability | N2InfoContent | C | 0..1 | This IE shall be included to contain the "UE Radio Capability Information" if available during context transfer procedure. UE Radio Capability Information does not include NB-IoT UE radio capability, see clause 5.4.4.1 of 3GPP TS 23.501 [2] (NOTE) | | +| ueRadioCapabilityForPaging | N2InfoContent | C | 0..1 | This IE shall be included to contain the "UE Radio Capability for Paging" if available during context transfer procedure. (NOTE) | | +| ueNbiotRadioCapability | N2InfoContent | C | 0..1 | This IE shall be included to contain "NB-IoT UE radio capability Information" if available during context transfer procedure, see clause 5.4.4.1 of 3GPP TS 23.501 [2] | CIOT | + +NOTE: The source AMF may decide to not include ueRadioCapability and ueRadioCapabilityForPaging if the target AMF supports the RACS feature and if: +a. the PlmnAssiUeRadioCapId is included in the MM Context for an intra-PLMN AMF mobility procedure; or +b. the ManAssiUeRadioCapId is included in the MM Context for an intra-PLMN or an inter-PLMN AMF mobility procedure. + +## 6.1.6.2.25 Type: UeContext + +**Table 6.1.6.2.25-1: Definition of type UeContext** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | This IE shall be present if available. When present, this IE contains SUPI of the UE. | | +| supiUnauthInd | boolean | C | 0..1 | This IE shall be present if SUPI is present. When present, it shall indicate whether the SUPI is unauthenticated. | | +| gpsiList | array(Gpsi) | C | 1..N | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE shall contain the GPSI(s) of the UE. | | +| pei | Pei | C | 0..1 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE shall contain Mobile Equipment Identity of the UE. | | +| udmGroupId | NfGroupId | O | 0..1 | When present, it shall indicate the identity of the UDM Group serving the UE. | | +| ausfGroupId | NfGroupId | O | 0..1 | When present, it shall indicate the identity of the AUSF Group serving the UE. | | +| pcfGroupId | NfGroupId | O | 0..1 | When present, it shall indicate the identity of the PCF Group serving the UE. | | +| routingIndicator | string | O | 0..1 | When present, it shall indicate the Routing Indicator of the UE. | | +| hNwPubKeyId | integer | O | 0..1 | When present, it shall indicate the Home Network Public Key Identifier of the UE. (NOTE 4). | | +| groupList | array(GroupId) | C | 1..N | This IE shall be present if the UE belongs to any subscribed internal group(s) and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE shall list the subscribed internal group(s) to which the UE belongs to. | | +| drxParameter | DrxParameter | C | 0..1 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE shall contain the DRX parameter of the UE. | | +| subRfsp | RfspIndex | C | 0..1 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, it shall indicate the subscribed RFSP Index of the UE. | | +| pcfRfsp | RfspIndex | C | 0..1 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a.

When present, this IE shall indicate the PCF determined RFSP Index of the UE. | | +| usedRfsp | RfspIndex | C | 0..1 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, it shall indicate the used RFSP Index of the UE. | | +| subUeAmbr | Ambr | C | 0..1 | This IE shall be present if subscribed UE-AMBR has been retrieved from UDM and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a.

When present, this IE shall indicate the value of subscribed UE AMBR of the UE. | | +| pcfUeAmbr | Ambr | C | 0..1 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a.

When present, this IE shall indicate the value of the PCF determined UE AMBR of the UE. | | +| subUeSliceMbrList | map(SliceMbr) | C | 1..N | Map of SliceMbr, where the S-NSSAI shall be used as the key of the map.

This IE shall be present if the list of subscribed UE-Slice-MBR(s) has been retrieved from UDM and if it is not case b) | | + +| | | | | | | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | specified in clause 5.2.2.2.1.1 step 2a.
When present, this IE shall indicate the list of subscribed UE-Slice-MBR(s) per S-NSSAI for the UE. | | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | +|------------------------|-------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| smsfId | NfInstanceId | C | 0..1 | This IE shall be present if the SMS service for UE is activated and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, it indicates the identifier of the SMSF network function instance serving the UE. The NF service consumer (e.g. target AMF) may use this information to identify the SMSF NF service profile from among the SMSF NF service profiles it received from the NRF. | +| seafData | SeafData | C | 0..1 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a or the case specified in clause 5.2.2.2.1.2. When present, this IE contains the security data derived from data received from AUSF of the UE. | +| 5gMmCapability | 5GMmCapability | C | 0..1 | This IE shall be present if the UE had provided this IE during Registration Procedure and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE shall contain 5G MM capability of the UE. | +| pcfId | NfInstanceId | C | 0..1 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE indicates the identity of the PCF for AM Policy and/or UE Policy. | +| pcfSetId | NfSetId | C | 0..1 | This IE shall be present, if available. When present, it shall contain the NF Set ID of the PCF for AM Policy and/or UE Policy. | +| pcfAmpServiceSetId | NfServiceSetId | C | 0..1 | This shall be present, if available. When present, it shall contain the NF Service Set ID of the PCF's AM Policy service. | +| pcfUepServiceSetId | NfServiceSetId | C | 0..1 | This shall be present, if available. When present, it shall contain the NF Service Set ID of the PCF's UE Policy service. | +| pcfBindingLevel | SbiBindingLevel | C | 0..1 | This IE shall be present if available. When present, this IE shall contain the SBI binding level of the PCF's AM policy and UE Policy association resources. (NOTE 6) | +| pcfAmPolicyUri | Uri | C | 0..1 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present this IE shall contain the URI of the individual AM policy resource (see 3GPP TS 29.507 [32] clause 5.3.3.2) used by the AMF. | +| amPolicyReqTriggerList | array(PolicyReqTrigger) | C | 1..N | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present this IE shall indicate the AM policy request triggers towards the PCF. The NF Service Consumer (e.g. target AMF) shall use these triggers to request AM policy from the PCF whenever these triggers are met.

The possible AM policy control request triggers are specified in clause 6.1.2.5 of 3GPP TS 23.503 [7]. | +| pcfUePolicyUri | Uri | C | 0..1 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present this IE shall contain the URI of the individual UE policy resource (see 3GPP TS 29.507 [32] clause 5.3.3.2) used by the AMF. | +| uePolicyReqTriggerList | array(PolicyReqTrigger) | C | 1..N | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present this IE shall indicate the UE policy request triggers towards the PCF. The NF Service Consumer (e.g. target | + +| | | | | | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

AMF) shall use these triggers to request UE policy from the PCF whenever these triggers are met.

The possible UE policy control request triggers are specified in clause 6.1.2.5 of 3GPP TS 23.503 [7].

| | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | +|------------------------|--------------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| hpcfId | NfInstanceId | O | 0..1 | This IE indicates the identity of PCF for UE Policy in home PLMN, when the UE is roaming. | +| hpcfSetId | NfSetId | O | 0..1 | When present, this IE shall contain the NF Set ID of the PCF for UE Policy in home PLMN, when the UE is roaming. | +| restrictedRatList | array(RatType) | O | 1..N | When present, this IE shall indicate the list of RAT types that are restricted for the UE; see 3GPP TS 29.571 [6] (NOTE 1) | +| forbiddenAreaList | array(Area) | O | 1..N | When present, this IE shall indicate the list of forbidden areas of the UE. | +| serviceAreaRestriction | ServiceAreaRestriction | O | 0..1 | When present, this IE shall indicate subscribed Service Area Restriction for the UE. | +| restrictedCnList | array(CoreNetworkType) | O | 1..N | When present, this IE shall indicate the list of Core Network Types that are restricted for the UE. | +| eventSubscriptionList | array(ExtAmfEventSubscription) | C | 1..N |

This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, it shall indicate the event subscription(s) targeting the UE or the group the UE is part of.

If the source AMF supports binding procedures and if it received binding indications for event notifications (i.e. with "callback" scope) or for subscription change event notifications (i.e. with "subscription-events" scope) for certain subscriptions, these binding indications should also be included.

If the source AMF knows the NF type of the NF that created the subscription, this information should also be indicated.

| +| mmContextList | array(MmContext) | C | 1..2 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE contains the MM Contexts of the UE. | +| sessionContextList | array(PduSessionContext) | C | 1..N | This IE shall be present if available and if it is neither case a) nor case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE contains the PDU Session Contexts of the UE. (NOTE 2) | +| epsInterworkingInfo | EpsInterworkingInfo | C | 0..1 | This IE shall contain the associations between APN/DNN and PGW-C+SMF for EPS interworking, if available. | +| traceData | TraceData | C | 0..1 | This IE shall be present if signalling based trace has been activated (see 3GPP TS 32.422 [30]) and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. | +| serviceGapExpiryTime | DateTime | C | 0..1 |

This IE shall be present if Service Gap Control is enabled and if the AMF has started a Service Gap Timer which has not expired yet (see clause 5.31.16 of 3GPP TS 23.501 [2]).

The value of the IE shall indicate the expiry time (in UTC) of the active Service Gap Timer for the UE.

| +| stnSr | StnSr | O | 0..1 |

This IE shall be present if available, for UE supporting 5G-SRVCC (see clause 5.2.2.2.11 of 3GPP TS 23.502 [3]).

When present, this IE contains STN-SR of the UE.

| +| cMsisdn | CMSisdn | O | 0..1 | This IE shall be present if available, for UE | + +| | | | | | | +|--|--|--|--|--------------------------------------------------------------------------------------------------------------------------|--| +| | | | | supporting 5G-SRVCC (see clause 5.2.2.2.11 of 3GPP TS 23.502 [3]).
When present, this IE contains C-MSISDN of the UE. | | +|--|--|--|--|--------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|----------------------------|--------------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| msClassmark2 | MSClassmark2 | O | 0..1 | This IE shall be present if available, for UE supporting 5G-SRVCC (see clause 5.2.2.2.11 of 3GPP TS 23.502 [3]).
When present, this IE contains Mobile Station Classmark 2 of the UE. | | +| supportedCodecList | array(SupportedCodec) | O | 1..N | This IE shall be present if available, for UE supporting 5G-SRVCC (see clause 5.2.2.2.11 of 3GPP TS 23.502 [3]).
When present, this IE shall indicate the list of speech codecs supported by the UE. | | +| smallDataRateStatusInfos | array(SmallDataRateStatusInfo) | O | 1..N | List of Small Data Rate Control Statuses for released PDU Sessions, see clause 5.31.14.3 of TS 23.501 [2]. | CIOT | +| restrictedPrimaryRatList | array(RatType) | O | 1..N | When present, this IE shall indicate the list of RAT types that are restricted for use as primary RAT for the UE; see 3GPP TS 29.571 [6] (NOTE 1) | | +| restrictedSecondaryRatList | array(RatType) | O | 1..N | When present, this IE shall indicate the list of RAT types that are restricted for use as secondary RAT for the UE; see 3GPP TS 29.571 [6] (NOTE 1) | | +| v2xContext | V2xContext | O | 0..1 | This IE shall be present if available (see clause 6.5.4 of 3GPP TS 23.287 [47]).
When present, this IE shall indicate the parameters related to the V2X services. | | +| lteCatMInd | boolean | C | 0..1 | This IE shall be present with value "true" if the UE is a LTE Category M UE based on indication provided by the NG-RAN or by the MME at EPS to 5GS handover, as specified in 3GPP TS 23.502 [3].

When present, this IE shall be set as following:
- true: the UE is a Category M UE
- false (default): this UE is not a Category M UE. | | +| redCapInd | boolean | C | 0..1 | This IE shall be present with value "true" if the UE is a NR RedCap UE based on indication provided by the NG-RAN, as specified in 3GPP TS 23.502 [3].

When present, this IE shall be set as following:
- true: the UE is a NR RedCap UE
- false (default): this UE is not a NR RedCap UE. | | +| moExpDataCounter | MoExpDataCounter | C | 0..1 | This IE shall be present if a non-zero MO Exception counter has not been reported yet to SMF.

When present, this IE shall contain the MO Exception Data Counter, as specified in clause 5.31.14.3 of 3GPP TS 23.501 [2]. | | +| cagData | CagData | O | 0..1 | Closed Access Group Data
When present, the provisioningTime attribute (from the CagData data type) shall be absent. | NPN | +| managementMdtInd | boolean | C | 0..1 | This flag shall be present with value "true" if Management Based Minimization of Drive Tests (MDT) is allowed, as specified in 3GPP TS 32.422 [30].

When present, this IE shall be set as following:
- true: management based MDT is allowed.
- false (default): management based MDT is not allowed. | | +| immediateMdtConf | ImmediateMdtConf | C | 0..1 | This IE shall be sent by the source AMF to the target AMF, if the Job Type indicates | | + +| | | | | | | +|--|--|--|--|-----------------------------------------------------------|--| +| | | | | Immediate MDT. See clause 4.10 of
3GPP TS 32.422 [30]. | | +|--|--|--|--|-----------------------------------------------------------|--| + +| | | | | | | +|----------------------------|-------------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| ecRestrictionDataWb | EcRestrictionDataWb | C | 0..1 | This IE shall be present if the AMF determines whether Enhanced Coverage is restricted or not for the UE for WB-N1 mode. If absent, this IE indicates Enhanced Coverage is not restricted for WB-N1 mode. (NOTE 3) | | +| ecRestrictionDataNb | boolean | C | 0..1 | This IE shall be present if the AMF determines whether Enhanced Coverage is restricted or not for the UE for NB-N1 mode.

If present, this IE shall indicate whether Enhanced Coverage for NB-N1 mode is restricted or not.

  • - true: Enhanced Coverage for NB-N1 mode is restricted.
  • - false or absent: Enhanced Coverage for NB-N1 mode is allowed. (NOTE 3)
| | +| iabOperationAllowed | boolean | O | 0..1 | This IE shall be present if the UE is allowed for IAB operation. It may be present otherwise.

When present, it shall indicate whether the UE is allowed for IAB operation, as follows:
  • - true: indicates that the UE is allowed for IAB operation.
  • - false: indicates that the UE is not allowed for IAB operation.
| | +| mbsrOperationAllowed | MbsrOperationAllowed | O | 0..1 | Indicates whether the subscriber is allowed for MBSR operation as specified in clause 5.35A.4 of 3GPP TS 23.501 [2], optionally, with corresponding location and time period. | | +| proseContext | ProseContext | O | 0..1 | This IE shall be present if available (see clause 6.7 of 3GPP TS 23.304 [51]). When present, this IE shall indicate the parameters related to the ProSe services. | ProSe | +| analyticsSubscriptionList | array(Analytics Subscription) | C | 1..N | This IE shall be present if the AMF has created analytics subscription(s) towards NWDAF related to the UE.

If present, this IE shall include the list of analytics subscriptions, as specified in clauses 5.2.2.2.2 and 5.2.2.2.11 of 3GPP TS 23.502 [3]. | | +| pcfUepBindingInfo | string | C | 0..1 | This IE shall be present if Binding Indication was received for UE Policy Association resource from the PCF. When present, this IE shall contain the Binding indication of the PCF's UE Policy Association resource and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. | | +| pcfAmpBindingInfo | string | C | 0..1 | This IE shall be present if Binding Indication was received for AM Policy Association resource from the PCF. When present, this IE shall contain the Binding indications of the PCF's AM policy Association resource and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. | | +| usedServiceAreaRestriction | ServiceAreaRestriction | O | 0..1 | When present, this IE shall include the Service Area Restriction from PCF. | | +| pralnAmPolicy | map(PresenceI) | O | 1..N | When present, this IE shall include the map | | + +| | | | | | | +|--|------|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | nfo) | | |

of PRA Information for the subscribed "PRA_CHANGE" PolicyReqTrigger in the AM Policy Association.

The key of the map shall be the "prald" attribute within the PresenceInfo data type. The "presenceState" attribute within the PresenceInfo data type shall not be supplied here.

| | +|--|------|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|----------------------------|---------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| pralNUePolicy | map(PresenceInfo) | O | 1..N | When present, this IE shall include the map of PRA Information for the subscribed "PRA_CHANGE" PolicyReqTrigger in the UE Policy Association.

The key of the map shall be the "pralid" attribute within the PresenceInfo data type. The "presenceState" attribute within the PresenceInfo data type shall not be supplied here. | | +| updpSubscriptionData | UpdpSubscriptionData | O | 0..1 | When present, this IE shall include the subscription resource in the AMF for a UE policy delivery related N1 message notification. | | +| smPolicyNotifyPduList | array(PduSessionInfo) | C | 1..N | This IE shall be present if it has been received from the PCF for the UE, i.e. the PCF for the AM Policy Association and possibly the UE Policy Association.

When present, this IE shall contain the information (Slice and DNN combination) of the PDU session(s) applicable for the notification of SM Policy Association Establishment and Termination events. (NOTE 5) | SPAE | +| pcfUeCallbackInfo | PcfUeCallbackInfo | C | 0..1 | This IE shall be present if the smPolicyNotifyPduList IE is present.

When present, this IE shall contain the callback information of the PCF for the UE to receive SM Policy Association Establishment and Termination events notification from the PCF for the SM Policy. (NOTE 5) | SPAE | +| uePositioningCap | UePositioningCapabilities | O | 0..1 | When present, this IE shall indicate the positioning capabilities supported by the UE. | | +| snpnOnboardInd | boolean | C | 0..1 | This IE shall be present if the UE is registered for onboarding in an SNPN.

When present, it shall indicate the following:
- true: indicates that the UE is registered for onboarding in an SNPN.

- false (default): indicates that the UE is not registered for onboarding in an SNPN. | eNPN | +| astiDistributionIndication | boolean | O | 0..1 | When present, this IE shall indicate whether the access stratum time distribution via Uu reference point should be activated or deactivated for the UE.
When present, this IE shall be set as following:
- true: ASTI distribution is activated for the UE.

- false (default): ASTI distribution is deactivated for the UE. | | +| tsErrorBudget | integer | O | 0..1 | When present, this IE shall indicate the Uu time synchronization error budget for the time synchronization service (as described in clause 5.27.1 in TS 23.501 [2]). It indicates the value in nano seconds. | | +| smfSelInfo | SmfSelectionData | C | 0..1 | This IE shall be present if conditions for SMF Selection information replacement are received from the PCF for AM Policy.

When present, It shall include the conditions | | + +| | | | | | | +|--|--|--|--|-------------------------------------------------------------------------|--| +| | | | | for SMF selection information replacement,
as determined by the PCF. | | +|--|--|--|--|-------------------------------------------------------------------------|--| + +| | | | | | | +|-----------------------|--------------------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| pcfUeSliceMbrList | map(SliceMbr) | C | 1..N |

This IE shall be present when UE Slice MBR(s) were received from the PCF for AM Policy.

When present, this IE shall include one or more UE-Slice-MBR(s) as determined by the PCF for allowed S-NSSAI(s). The key of the map is the S-NSSAI in the allowed NSSAI to which the UE-Slice-MBR belongs.

| | +| smsfSetId | NfSetId | C | 0..1 |

This IE shall be present if available.

When present, this IE shall contain the NF Set ID of the SMSF serving the UE.

| | +| smsfServiceSetId | NfServiceSetId | C | 0..1 |

This shall be present, if available.

When present, it shall contain the NF Service Set ID of the SMSF's service instance serving the UE.

| | +| smsfBindingInfo | string | C | 0..1 |

This IE shall be present if available.

When present, this IE shall contain the binding indication of the UE Context for SMS in SMSF and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name.

| | +| disasterRoamingInd | boolean | C | 0..1 |

This IE shall be present if the UE is registered for disaster roaming. It may be present otherwise.

When present, this IE shall be set as follows:

  • - true: UE is registered for Disaster Roaming service;
  • - false (default): UE is not registered for Disaster Roaming service.
| | +| disasterPlmn | PlmnId | C | 0..1 |

This IE shall be included if the disasterRoamingInd is present and set to "true".

When present, this IE includes the PLMN of the UE which has faced disaster condition

| | +| satelliteBackhaulCat | SatelliteBackhaulCategory | O | 0..1 |

When present, this IE shall be set to the last value that has been reported to the PCF if the satellite backhaul category change is subscribed with the "SAT_BACKHAUL_CHANGE" PolicyReqTrigger in the UE Policy Association.

| | +| wlServAreaRes | WirelineServiceAreaRestriction | C | 0..1 |

This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a.

When present, this IE shall indicate the value of the PCF determined Wireline Service Area Restriction.

| | +| asTimeDisParam | AsTimeDistributionParam | C | 0..1 |

This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a.

When present, this IE shall contain the 5G access stratum time distribution parameters received from the PCF for AM Policy.

| | +| amPolicyInfoContainer | AmPolicyInfoContainer | C | 0..1 |

This IE shall be present if any of the information in the container is available and if

| | + +| | | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| | | | | it is not case b) specified in clause 5.2.2.2.1.1 step 2a.

When present, this IE shall contain the AM Policy information parts received from the PCF for AM Policy. | | +| a2xContext | A2xContext | O | 0..1 | This IE shall be present if available (see clause 6.3.5.4 of 3GPP TS 23.256 [56]).
When present, this IE shall indicate the parameters related to the A2X services. | A2X | +| lcsUpContext | LcsUpContext | O | 0..1 | This IE shall be present if available (see clause 4.3.7 of 3GPP TS 23.273 [42]).
When present, this IE shall indicate the parameters related to the LCS UP services. | | +| reconnectInd | boolean | O | 0..1 | Indicates whether the UE is to reconnect to the network in the case the UE determines that it does not have the latest available clock quality information as described in clause 5.27.1.12 in 3GPP TS 23.501 [2].

When present, this IE shall be set as follows:
- true: the UE reconnects to the network in the case the UE determines that the reference report ID has changed;
- false (default): the UE does not have an indication from CN to reconnect to the network in the case that the reference report ID has changed. | | +| NOTE 1: If the restrictedPrimaryRatList and restrictedSecondaryRatList attributes are supported by the sender, the sender shall include the list of RAT Types that are restricted, if any, in the restrictedRatList attribute, shall include the list of RAT Types that are restricted for use as primary RAT, if any, in the restrictedPrimaryRatList attribute and shall include the list of RAT Types that are restricted for use as secondary RAT, if any, in the restrictedSecondaryRatList attribute. If the restrictedPrimaryRatList and restrictedSecondaryRatList attributes are supported by the receiver, the receiver shall use the data in the restrictedPrimaryRatList attribute, if received, as the list of RAT Types that are restricted for use as primary RAT for the UE, and shall use the data in the restrictedSecondaryRatList attribute, if received, as the list of RAT Types that are restricted for use as secondary RAT for the UE, otherwise the receiver shall use the data in the restrictedRatList attribute, if received, as the list of RAT Types that are restricted for the UE. | | | | | | +| NOTE 2: A particular PDU session not supported by the target AMF shall not be transferred, e.g. MA-PDU session context shall not be transferred if target AMF does not support ATSSS. | | | | | | +| NOTE 3: After ecRestrictionDataWb and/or ecRestrictionDataNb attributes are sent from source AMF to target AMF to build the UeContext in the target AMF, the target AMF shall re-determine the EC restriction information based on the received subscription data from UDM and UE 5GMM capability because EC restriction information may change (e.g. due to that subscription data in UDM is changed but not notified the old AMF yet) and then compare the re-determined EC restriction information with the one received in the UeContext. If the target AMF finds EC restriction information has changed after comparing, the target AMF shall proceed as described in clause 5.31.12, 3GPP TS 23.501 [2]. | | | | | | +| NOTE 4: If present, this attribute shall be used together with routingIndicator. This attribute is only used by the HPLMN in roaming scenarios. | | | | | | +| NOTE 5: If the information as indicated in both IEs were received from the PCF for the UE or from the old AMF in UE Context, the AMF shall identify whether a non-roaming or local breakout PDU session is applicable for SM Policy Association events, i.e, whether the slice and DNN combination of the PDU session is listed in the smPolicyNotifyPduList IE or not. If the PDU session is applicable for notification of SM Policy Association events , the AMF shall provide the callback information for the PCF of the UE contained in the pcfUeCallbackInfo IE to the SMF of a new PDU session via Create SM Context service operation, or to the SMF for an ongoing PDU session via Update SM Context service operation, together with the indication for notification of SM Policy Association events. See clause 4.3.2.2.1 and clause 4.3.3.2 of 3GPP TS 23.502 [3]. | | | | | | +| NOTE 6: This IE is deprecated. An AMF complying with this version of specification shall use the pcfAmpBindingInfo IE to carry the Binding indication of the AM Policy Association resource and use the pcfUepBindingInfo IE to carry the binding indication of the UE Policy Association resource. | | | | | | + +## 6.1.6.2.26 Type: N2SmInformation + +Table 6.1.6.2.26-1: Definition of type N2SmInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| pduSessionId | PduSessionId | M | 1 | Indicates the PDU Session Identity | | +| n2InfoContent | N2InfoContent | C | 0..1 | This IE shall be present if a SMF related IE should be transferred. When present, the IE contains one of NGAP SMF related IEs specified in clause 9.3.4 of 3GPP TS 38.413 [12]. | | +| sNssai | Snssai | C | 0..1 | This IE shall be present if network slice information to be transferred for session management. When present, the IE indicates the network slice the PDU session belongs to. (NOTE) | | +| homePlmnSnssai | Snssai | C | 0..1 | This IE shall be present during EPS to 5GS handover procedure for Home Routed PDU session. When present, it shall carry the S-NSSAI for home PLMN. | ENS | +| iwkSnssai | Snssai | C | 0..1 | This IE shall be present during EPS to 5GS handover procedure with AMF relocation for Home Routed PDU session, or during EPS to 5GS handover using N26 interface with AMF relocation and with I-SMF insertion, if S-NSSAI for interworking is configured and used in the initial AMF, as specified in clause 4.11.1.2.2 and clause 4.23.12.7.1 of 3GPP TS 23.502 [3].

When present, this IE shall carry the S-NSSAI for interworking configured and used in the initial AMF for the PDU session. | ENS | +| subjectToHo | boolean | C | 0..1 | This IE shall be present if n2InfoContent carries a "Handover Required Transfer" IE. When present, it Indicates whether the PDU session shall be subject to handover to the target node. | | + +NOTE: During EPS to 5GS handover procedure for Home Routed PDU session with AMF relocation, the source AMF shall set this IE to the S-NSSAI in the serving PLMN mapped from the S-NSSAI in home PLMN indicated by the homePlmnSnssai IE in the N2SmInformation data structure sent to target AMF. + +## 6.1.6.2.27 Type: N2InfoContent + +**Table 6.1.6.2.27-1: Definition of type N2InfoContent** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ngapMessageType | Uinteger | C | 0..1 | This IE shall be present if PWS or TSS related N2 information is to be transferred, or during the AMF planned removal procedure with UDSF deployed procedure to transfer a RAN N2 message. When present, it shall indicate the NGAP Message type of the ngapData as specified in clause 6.1.6.4.3.3. Its value equals the value of the Procedure Code defined in ASN.1 in clause 9.4.7 in 3GPP TS 38.413 [12]. | +| ngapleType | NgapleType | C | 0..1 | This IE shall be present if SM, RAN, V2X, ProSe, Ranging_SL or NRPPa related N2 information is to be transferred. When present, it shall indicate the NGAP IE type of the ngapData as specified in clause 6.1.6.4.3.2. | +| ngapData | RefToBinaryData | M | 1 | This IE reference the N2 Information binary data corresponding to the N2 information class. See clause 6.1.6.4.3. | + +## 6.1.6.2.28 Type: NrppaInformation + +**Table 6.1.6.2.28-1: Definition of type NrppaInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| nflId | NfInstanceId | M | 1 | This IE shall carry the identifier of the Network Function (e.g. LMF) instance that is sending or receiving the NRPPa data. | +| nrppaPdu | N2InfoContent | M | 1 | This IE represents the encoded NGAP NRPPa-PDU IE, which is transparent to AMF. | +| serviceInstanceId | string | O | 0..1 | When present, this IE shall carry the Service Instance Identifier of the Service Instance (e.g. LMF) that is sending or receiving the NRPPa data. | + +6.1.6.2.29 Type: PwsInformation + +**Table 6.1.6.2.29-1: Definition of type PwsInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| messageIdentifier | Uint16 | M | 1 | Identifies the warning message. Sender shall set this field to 0, if the pwsContainer IE carries PWS Failure Indication or PWS Restart Indication. The receiver shall ignore this IE if the pwsContainer IE carries PWS Failure Indication or PWS Restart Indication. | +| serialNumber | Uint16 | M | 1 | identifies a particular message from the source and type indicated by the Message Identifier. Sender shall set this field to 0, if the pwsContainer IE carries PWS Failure Indication or PWS Restart Indication. The receiver shall ignore this IE if the pwsContainer IE carries PWS Failure Indication or PWS Restart Indication. | +| pwsContainer | N2InfoContent | M | 1 | This IE represents the PWS N2 information data part to be relayed between CBCF and AN. | +| bcEmptyAreaList | array(GlobalRanNodeId) | C | 1..N |

This IE shall be present if the NF consumer has previously requested the AMF to send the N2 response information for:

  • - WRITE-REPLACE-WARNING-REQUEST and the AMF has received WRITE-REPLACE-WARNING-RESPONSE from RAN node(s) not including the Broadcast Completed Area List IE, or
  • - PWS-CANCEL-REQUEST and the AMF has received PWS-CANCEL-RESPONSE from RAN node(s) not including the Broadcast Cancelled Area List IE.

When present, this IE shall list the RAN node(s) that has sent a

  • - WRITE-REPLACE-WARNING-RESPONSE not including the Broadcast Completed Area List IE, or
  • - PWS-CANCEL-RESPONSE not including the Broadcast Cancelled Area List IE.
| +| sendRanResponse | boolean | O | 0..1 |

This IE shall be present to request the AMF to send the N2 response information it has received from the RAN nodes to the NF Service Consumer.

When present, this IE shall be set as follows:

  • - true: send RAN response
  • - false (default): do not send RAN response.

The N2 information received from the RAN corresponds to the Broadcast-Completed-Area-List IE or the Broadcast-Cancelled-Area-List IE defined in 3GPP TS 38.413 [12]. See clause 6.1.6.4.3.3.

| +| omcId | OmcIdentifier | O | 0..1 | IE shall be present if the AMF is required to write the n2Information it has received from the RAN nodes into trace records on the OMC. When present, it indicates the identifier of OMC. | +| nflId | NfInstanceId | O | 0..1 |

When present, this IE shall carry the instance identity of the NF Service Consumer (e.g. CBCF or PWS-IWF).

This IE should be included when more than one CBCF/PWS-IWF instances are deployed in the network and the sendRanResponse IE is present with the value "true". The AMF may use this IE to identify whether the same CBCF/PWS-IWF instance

| + +| | | | | | +|--|--|--|--|--------------------------------------------------------------------------------------| +| | | | | has subscribed for N2 PWS information to receive the PWS Response data from the RAN. | +|--|--|--|--|--------------------------------------------------------------------------------------| + +6.1.6.2.30 Type: N1N2MsgTxfrFailureNotification + +**Table 6.1.6.2.30-1: Definition of type N1N2MsgTxfrFailureNotification** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| cause | N1N2MessageTransferCause | M | 1 | This IE shall provide the result of the N1/N2 message transfer at the AMF. | +| n1n2MsgDataUri | Uri | M | 1 |

This IE shall contain the N1N2MessageTransfer request resource URI returned in the Location header when the N1/N2 message transfer was initiated (see clause 6.1.3.5.3.1).

This IE shall be used by the NF Service Consumer to correlate the notification with the UE or session for which the earlier N1/N2 message transfer was initiated.

If no Location header was returned when the N1/N2 message transfer was initiated, e.g. when a 200 OK response was sent for a UE in RRC inactive state, this IE shall be set to a dummy URI, i.e. an URI with no authority and an empty path (e.g. "http://").

| +| retryAfter | Uinteger | O | 0..1 |

This IE may be included if the AMF requests the NF Service Consumer to throttle sending further N1/N2 Message Transfer request for a short period, e.g. when UE is not responding to paging.

When present, this IE indicates the period in number of seconds. The NF consumer should not send new N1/N2 message transfer request during the indicated period.

(NOTE)

| + +NOTE: This IE should be configured with a value less than 10 minutes, i.e. 600 seconds. + +6.1.6.2.31 Type: N1N2MessageTransferError + +**Table 6.1.6.2.31-1: Definition of type N1N2MessageTransferError** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------------|---|-------------|---------------------------------------------------------------------------------------| +| error | ProblemDetails | M | 1 | This IE shall provide the result of the N1/N2 message transfer processing at the AMF. | +| errInfo | N1N2MsgTxfrErrDetail | O | 0..1 | This IE may be included to provide additional information related to the error. | + +## 6.1.6.2.32 Type: N1N2MsgTxfrErrDetail + +Table 6.1.6.2.32-1: Definition of type N1N2MsgTxfrErrDetail + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| retryAfter | UInteger | O | 0..1 | This IE may be included if the AMF requests the NF Service Consumer to stop sending the N1/N2 message before timeout, and to retry the N1/N2 message transfer request that was rejected after a timeout. The value shall be in seconds.

When included, the value shall be set to an estimate of the AMF on how long it will take before the AMF considers paging procedure as completed.
(NOTE) | +| highestPrioArp | Arp | O | 0..1 | This IE may be included if the "cause" attribute in the ProblemDetails is set to "HIGHER_PRIORITY_REQUEST_ONGOING". When included this IE shall contain the ARP value of the highest priority QoS flow for which currently paging is ongoing.
The NF Service Consumer shall not initiate an Namf_Communication_N1N2MessageTransfer operation for the same UE with an ARP value having a lower priority than this or the same priority as this, until the retryAfter timer expires. | +| maxWaitingTime | DurationSec | C | 0..1 | This IE shall be present when:
- extBufSupport attribute with value "true" received in the request; and
- the UE is not reachable due to the UE in MICO mode or the UE using extended idle mode DRX.

When present, this IE shall indicate the estimated maximum waiting time in seconds before the UE will be reachable.

If the UE is in MICO mode, the AMF determines the Estimated Maximum Wait time based on the next expected periodic registration by the UE or by implementation. If the UE is using extended idle mode DRX, the AMF determines the Estimated Maximum Wait time based on the start of the next Paging Time Window.

(see clause 4.25.5 of 3GPP 23.502 [3]) | + +NOTE: This IE should be configured with a value less than 10 minutes, i.e. 600 seconds. + +## 6.1.6.2.33 Type: N2InformationTransferRspData + +Table 6.1.6.2.33-1: Definition of type N2InformationTransferRspData + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| result | N2InformationTransferResult | M | 1 | This IE shall provide the result of the N2 information transfer processing at the AMF. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | +| pwsRspData | PWSResponseData | C | 0..1 | This IE shall be present if the n2InformationClass is "PWS" in N2InformationTransferReqData. | + +6.1.6.2.34 Type: MmContext + +**Table 6.1.6.2.34-1: Definition of type MmContext** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|-------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| accessType | AccessType | M | 1 | This IE shall contain the access type of the MM context. | | +| nasSecurityMode | NasSecurityMode | C | 0..1 | This IE shall be present if available in 3GPP access MM context. When present, this IE shall contain the used NAS security mode of the UE. | | +| epsNasSecurityMode | EpsNasSecurityMode | C | 0..1 | This IE shall be present in 3GPP access MM context if selected EPS NAS security algorithms have been previously provided to the UE, as specified in clause 6.7.2 of 3GPP TS 33.501 [27].

When present, this IE shall contain the selected EPS NAS security algorithms provided to the UE. | | +| nasDownlinkCount | NasCount | C | 0..1 | This IE shall be present if available in 3GPP access MM context. When present, this IE shall contain the NAS downlink count of the UE. | | +| nasUplinkCount | NasCount | C | 0..1 | This IE shall be present if available in 3GPP access MM context. When present, this IE shall contain the NAS uplink count of the UE. | | +| ueSecurityCapability | UeSecurityCapability | C | 0..1 | This IE shall be present if available in 3GPP access MM context. When present, this IE shall contain the UE security capability | | +| s1UeNetworkCapability | S1UeNetworkCapability | C | 0..1 | This IE shall be present if available in 3GPP access MM context. When present, this IE shall contain the S1 UE network capabilities. | | +| allowedNssai | array(Snssai) | C | 1..N | This IE shall be present if the source AMF and the target AMF are in the same PLMN and if available. When present, this IE shall contain the allowed NSSAI for the access type. | | +| nssaiMappingList | array(NssaiMapping) | C | 1..N | This IE shall be present if the source AMF and the target AMF are in the same PLMN and if available. When present, this IE shall contain the mapping of the allowed NSSAI and if available the partially allowed NSSAI for the UE. | | +| allowedHomeNssai | array(Snssai) | C | 1..N | This IE shall be present if the source AMF and the target AMF are in different PLMNs and if available. When present, this IE shall contain the home S-NSSAIs corresponding to the allowed NSSAI and if available the partially allowed NSSAI for the access type. | | +| partiallyAllowedNssai | array(PartiallyAllowedSnssai) | C | 1..N | This IE shall be present if the source and target AMF supports the partially allowed S-NSSAI feature and if the source AMF and target AMF pertain to the same PLMN.
When present, this IE shall contain the partially allowed S-NSSAI list and the TAI list where the S-NSSAI(s) are allowed.
See 3GPP TS 23.502 [3] clause 4.2.2.2.2. | PAR-NS | +| nsInstanceList | array(Nsild) | C | 1..N | This IE shall be present if available. When present, it shall indicate the Network Slice Instances selected for the UE. | | +| expectedUEbehavior | ExpectedUeBehavior | C | 0..1 | This IE shall be present if available. When present it shall indicate the expected UE moving trajectory and its validity period. See 3GPP TS 23.502 [3] clause 4.15.6.3. | | +| ueDifferentiationInfo | UeDifferentiationInfo | C | 0..1 | This IE shall be present if available. When present it shall indicate UE Differentiation Information and its validity period. | | +| plmnAssiUeRadioCapId | PlmnAssiUeRadioCapId | C | 0..1 | This IE shall be present if the source AMF supports RACS feature and if available. When present it shall be the PLMN-assigned UE Radio Capability ID.
(NOTE 1) | | +| manAssiUeRadioCapId | ManAssiUeRadioCapId | C | 0..1 | This IE shall be present if the source AMF supports RACS feature and if available. When present it shall be the Manufacturer-assigned UE | | + +| | | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | Radio Capability ID. | | +| ucmfDicEntryId | string | C | 0..1 | This IE shall be present if the source AMF supports RACS feature and if available. When present it shall be the UCMF allocated dicEntryId received from the UCMF. | | +| n3iwfId | GlobalRanNodeId | C | 0..1 | This IE shall be present during Registration procedure with AMF changes as specified in clause 4.2.2.2 of 3GPP TS 23.502 [3] and inter AMF handover procedure, if the old AMF holds UE context established via N3IWF and if the PDU sessions associated with the non-3GPP access are transferred to the new AMF (see clause 5.2.2.2.1.1 and 5.2.2.2.3.1). When present, this IE shall contain the Global RAN Node ID of N3IWF. | | +| wagfId | GlobalRanNodeId | C | 0..1 | This IE shall be present during Registration procedure with AMF changes as specified in clause 4.2.2.2 of 3GPP TS 23.502 [3] and inter AMF handover procedure, if the old AMF holds UE context established via W-AGF and if the PDU sessions associated with the non-3GPP access are transferred to the new AMF (see clause 5.2.2.2.1.1 and 5.2.2.2.3.1). When present, this IE shall contain the Global RAN Node ID of W-AGF. | | +| tngfId | GlobalRanNodeId | C | 0..1 | This IE shall be present during Registration procedure with AMF changes as specified in clause 4.2.2.2 of 3GPP TS 23.502 [3] and inter AMF handover procedure, if the old AMF holds UE context established via TNGF and if the PDU sessions associated with the non-3GPP access are transferred to the new AMF (see clause 5.2.2.2.1.1 and 5.2.2.2.3.1). When present, this IE shall contain the Global RAN Node ID of TNGF. | | +| anN2ApId | integer | C | 0..1 | This IE shall be present during Registration procedure with AMF changes, as specified in clause 4.2.2.2 of 3GPP TS 23.502 [3] and inter AMF handover procedure, if the old AMF holds UE context established via N3IWF/W-AGF/TNGF and the UE is in CM-CONNECTED state via N3IWF/W-AGF/TNGF and if the PDU sessions associated with the non-3GPP access are transferred to the new AMF (see clause 5.2.2.2.1.1 and 5.2.2.2.3.1). When present, this IE shall contain the RAN UE NGAP ID over N2 interface. | | +| nssaaStatusList | array(NssaaStatus) | C | 1..N | This IE shall be present if available. When present, it shall contain the subscribed S-NSSAIs subject to NSSAA procedure and for which a status information is available. See 3GPP TS 23.501 [2] clause 5.15.5.2.1 and 3GPP TS 23.502 [3] clause 5.2.2.2.2. | | +| pendingNssaiMappingList | array(NssaiMapping) | C | 1..N | This IE shall be present if available. When present, this IE shall contain the mapping of the pending NSSAI for the UE. | | +| uuamMmStatus | UuamMmStatus | C | 0..1 | This IE shall be present if available in 3GPP access MM context. When present, this IE shall indicate the status of UUAM-MM if the AMF is configured to perform the UAV authentication/authorization at 5GS registration as described in clause 5.2.2 of 3GPP TS 23.256 [56]. | | +| NOTE 1: If the AMF supports RACS and the AMF detects that the selected PLMN during a service request procedure is different from the currently registered PLMN for the UE, the AMF stores the UE Radio Capability ID of the newly selected PLMN in the UE context as described in clause 5.2.3.2 of 3GPP TS 23.502 [3], and provides this UE Radio Capability ID to the target AMF during any subsequent inter-AMF mobility. | | | | | | + +Editor's note: It is FFS whether and how to address a partially allowed S-NSSAI upon inter-AMF mobility in a same PLMN when the source AMF would support partially allowed S-NSSAIs but the target AMF would not, e.g. whether the Source AMF should in such a case send the partially allowed S-NSSAI in the allowedNssai IE. + +6.1.6.2.35 Type: SeafData + +Table 6.1.6.2.35-1: Definition of type SeafData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ngKsi | NgKsi | M | 1 | Indicates the KSI used for the derivation of the keyAmf sent. | +| keyAmf | KeyAmf | M | 1 | Indicates the $K_{amf}$ or $K'_{amf}$ | +| nh | string | C | 0..1 | This IE shall be present during N2 handover procedure as specified in clause 6.9.2.3.3 of 3GPP TS 33.501 [27]. When present, this IE indicates the Next Hop value used for the key derivation. The value is encoded as a string of hexadecimal characters.
Pattern: '^[A-Fa-f0-9]+\$' | +| ncc | integer | C | 0..1 | This IE shall be present during N2 handover procedure as specified in clause 6.9.2.3.3 of 3GPP TS 33.501 [27]. When present, this IE indicates the NH Chaining Counter. The value is within the range 0 to 7. | +| keyAmfChangeInd | boolean | C | 0..1 | This IE shall be included, with a value "true", if the source AMF requires the target AMF to perform AS key re-keying, during N2 handover procedure as specified in clause 6.9.2.3.3 of 3GPP TS 33.501 [27]. | +| keyAmfHDerivationInd | boolean | C | 0..1 | This IE shall be included, with a value "true", if the source AMF has performed horizontal $K_{AMF}$ derivation, which means a new $K_{AMF}$ has been calculated. | + +6.1.6.2.36 Type: NasSecurityMode + +Table 6.1.6.2.36-1: Definition of type NasSecurityMode + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|--------------------|---|-------------|----------------------------------------------| +| integrityAlgorithm | IntegrityAlgorithm | M | 1 | Indicates the integrity protection algorithm | +| cipheringAlgorithm | CipheringAlgorithm | M | 1 | Indicates the ciphering algorithm | + +## 6.1.6.2.37 Type: PduSessionContext + +**Table 6.1.6.2.37-1: Definition of type PduSessionContext** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| pduSessionId | PduSessionId | M | 1 | Indicates the identifier of the PDU Session. | | +| smContextRef | Uri | M | 1 | Indicates the resource URI of the SM context, including the apiRoot (see clause 6.1.3.3.2 of 3GPP TS 29.502 [16]).

When present, it shall carry the URI of SM Context of:
- I-SMF, for a PDU session with I-SMF; or
- V-SMF, for HR PDU session; or
- SMF, for non-roaming PDU session without I-SMF, or LBO roaming PDU session; | | +| sNssai | Snssai | M | 1 | Indicates the associated S-NSSAI for the PDU Session. It shall be the S-NSSAI in HPLMN in non-roaming, LBO roaming or HR roaming. | | +| additionalSnssai | Snssai | C | 0..1 | This IE shall be present in intra-VPLMN mobility of LBO roaming and HR roaming.
When present, this IE shall indicate the associated S-NSSAI in VPLMN for the PDU Session. | | +| dnn | Dnn | M | 1 | This IE shall indicate the Data Network Name. The DNN shall be the full DNN (i.e. with both the Network Identifier and Operator Identifier) for a HR PDU session, and it should be the full DNN in LBO and non-roaming scenarios. If the Operator Identifier is absent, the serving core network operator shall be assumed. | | +| selectedDnn | Dnn | C | 0..1 | This IE shall be present, if another DNN other than the UE requested DNN is selected for this PDU session. When present, it shall contain the selected DNN. The DNN shall be the full DNN (i.e. with both the Network Identifier and Operator Identifier) for a HR PDU session, and it should be the full DNN in LBO and non-roaming scenarios. If the Operator Identifier is absent, the serving core network operator shall be assumed. | | +| accessType | AccessType | M | 1 | Indicates the access type of the PDU session. | | +| additionalAccessType | AccessType | C | 0..1 | Indicates the additional access type for a MA PDU session, if the UE registers to both 3GPP access and Non-3GPP access. | | +| allocatedEbiList | array(EbiArpMapping) | C | 1..N | This IE shall be present when at least one EBI is allocated to the PDU session.

When present, this IE shall contain the EBIs currently allocated to the PDU session. | | +| hsmfld | NfInstanceId | C | 0..1 | This IE shall be present for non-roaming and home-routed PDU sessions.

When present, it shall indicate the associated: | | + +| | | | | | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | - home SMF for HR PDU Session, or
- SMF, for non-roaming PDU session,
regardless of whether an I-SMF is
involved or not. | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|----------------------|-----------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| hsmfSetId | NfSetId | C | 0..1 | This IE shall be present, if available.

When present, this IE shall contain the NF Set ID of the home SMF or the SMF indicated by hsmfId. | | +| hsmfServiceSetId | NfServiceSetId | C | 0..1 | This IE shall be present, if available.

When present, this IE shall contain the NF Service Set ID of the selected PDUSession service instance of home SMF or the SMF indicated by hsmfId. | | +| smfBinding | SbiBindingLevel | C | 0..1 | This IE shall be present if available, for a non-roaming PDU session. When present, this IE shall contain the SBI binding level of the SMF's SM context resource. | | +| vsmfId | NfInstanceId | C | 0..1 | This IE shall be present for roaming PDU sessions. When present, it shall indicate the associated visited SMF for home-routed the PDU Session, or the SMF for the local-breakout PDU session (regardless of whether an I-SMF is involved or not). | | +| vsmfSetId | NfSetId | C | 0..1 | This IE shall be present, if available. When present, this IE shall contain the NF Set ID of the V-SMF. | | +| vsmfServiceSetId | NfServiceSetId | C | 0..1 | This IE shall be present, if available. When present, this IE shall contain the NF Service Set ID of the V-SMF's PDUSession service instance. | | +| vsmfBinding | SbiBindingLevel | C | 0..1 | This IE shall be present, if available. When present, this IE shall contain the SBI binding level of the V-SMF's SM context resource. | | +| ismfId | NfInstanceId | C | 0..1 | This IE shall be present if I-SMF is involved in the PDU session. When present, it shall indicate the associated I-SMF for the PDU Session. | DTSSA | +| ismfSetId | NfSetId | C | 0..1 | This IE shall be present, if available. When present, this IE shall contain the NF Set ID of the I-SMF. | DTSSA | +| ismfServiceSetId | NfServiceSetId | C | 0..1 | This IE shall be present, if available. When present, this IE shall contain the NF Service Set ID of the I-SMF's PDUSession service instance. | DTSSA | +| ismfBinding | SbiBindingLevel | C | 0..1 | This IE shall be present if available. When present, this IE shall contain the SBI binding level of the I-SMF's SM Context resource. | DTSSA | +| nsInstance | NsId | C | 0..1 | This IE shall be present if available. When present, this IE shall Indicate Network Slice Instance for the PDU Session | | +| smfServiceInstanceId | string | O | 0..1 | When present, this IE shall contain the serviceInstanceId of the SMF PDUSession service instance serving the SM Context, i.e. of:
  • - the I-SMF, for a PDU session with I-SMF;
  • - the V-SMF, for a HR PDU session; or
  • - the SMF, for a non-roaming or an LBO roaming PDU session without I-SMF.
| | + +| | | | | | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | This IE may be used by the AMF to identify PDU session contexts affected by a failure or restart of the SMF service instance (see clause 6.2 of 3GPP TS 23.527 [33]). | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|-------------------|-------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| maPduSession | boolean | C | 0..1 | This IE shall be present if available.
When present, this IE shall indicate whether it is an MA PDU session.

true: indicates the PDU session is MA PDU session;
false (default): the PDU session is not MA PDU session. | | +| cnAssistedRanPara | CnAssistedRanPara | C | 0..1 | This IE shall be present if available.

When present, this IE shall contain the PDU Session specific parameters received from the SMF and used by the AMF to derive the Core Network assisted RAN parameters tuning. | | +| nrfManagementUri | Uri | C | 0..1 | If included, this IE shall contain the API URI of the NFManagement Service (see clause 6.1.1 of 3GPP TS 29.510 [29]) of the NRF or hNRF.

It shall be present if it is returned from the NSSF or hNSSF (see clause 6.1.6.2.7 of 3GPP TS 29.531 [18]). | | +| nrfDiscoveryUri | Uri | C | 0..1 | If included, this IE shall contain the API URI of the NFDiscovery Service (see clause 6.2.1 of 3GPP TS 29.510 [29]) of the NRF or hNRF.

It shall be present if it is returned from the NSSF or hNSSF (see clause 6.1.6.2.7 of 3GPP TS 29.531 [18]). | | +| nrfAccessTokenUri | Uri | C | 0..1 | If included, this IE shall contain the API URI of the Access Token Service (see clause 6.3.2 of 3GPP TS 29.510 [29]) of the NRF or hNRF.

It shall be present if it is returned from the NSSF or hNSSF (see clause 6.1.6.2.7 of 3GPP TS 29.531 [18]). | | +| smfBindingInfo | string | C | 0..1 | This IE shall be present if available, for a non-roaming PDU session. When present, this IE shall contain the Binding indications of the SMF's SM context resource and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. | | +| vsmfBindingInfo | string | C | 0..1 | This IE shall be present, if available. When present, this IE shall contain the Binding indications of the V-SMF's SM context resource and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. | | +| ismfBindingInfo | string | C | 0..1 | This IE shall be present if available. When present, this IE shall contain the Binding indications of the I-SMF's SM Context resource and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. | DTSSA | +| interPlmnApiRoot | Uri | C | 0..1 | This IE shall be present if this information is available.
When present, it shall contain the | | + +| | | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | apiRoot of the SM context to be used in inter-PLMN signalling request targeting the SM context.
(NOTE) | | +| pgwFqdn | Fqdn | O | 0..1 | FQDN of the PGW in the PGW-C+SMF, to be included for interworking with EPS. | | +| pgwIpAddr | IpAddress | O | 0..1 | IP Address of the PGW in the PGW-C+SMF, to be included for interworking with EPS. | | +| plmnId | PlmnId | O | 0..1 | PLMN where the PGW-C+SMF is located. | | +| anchorSmfSupported Features | SupportedFeatures | O | 0..1 | When present, this IE shall include the features of the Nsmf_PDUSession service (see clause 6.1.8 of 3GPP TS 29.502 [16]) that are supported by the H-SMF (or the SMF for a PDU sessions with I-SMF).
(NOTE 2) | | +| anchorSmfOauth2Required | boolean | O | 0..1 | This IE may be present when new AMF and old AMF belong to the same PLMN.

When present, this IE shall indicate whether the H-SMF (or the SMF for a PDU session with I-SMF) requires Oauth2-based authorization for accessing its Nsmf_PDUSession service

- true: OAuth2 based authorization is required.
- false: OAuth2 based authorization is not required.

The absence of this IE means that no indication is available about the usage of Oauth2 for authorization of the anchor SMF's Nsmf_PDUSession service. | | +| hrsboAllowedInd | boolean | C | 0..1 | This IE shall be present during an intra-PLMN N2 handover, if this information is available (see clause 6.7.2.6 of 3GPP TS 23.548 [58]).

When present, it shall indicate whether HR-SBO is allowed for the PDU session and it shall be set as follows:
- true: HR-SBO is allowed
- false: HR-SBO is not allowed

The absence of this IE shall not be interpreted as meaning that HR-SBO is allowed or not allowed. | | +| NOTE 1: During an inter-PLMN mobility, the target AMF shall replace the apiRoot of the smContextRef with the interPlmnApiRoot if available and send the resulting smContextRef in the Create SM Context request towards the target V-SMF, I-SMF or anchor SMF. See 3GPP TS 29.502 [16]. | | | | | | +| NOTE 2: The new AMF may use this IE to know the supported features of the H-SMF (or the SMF for a PDU session with I-SMF) and take action based on the supported features, e.g. the new AMF shall release the PDU session when V-SMF needs to be changed but the H-SMF does not support V-SMF change. | | | | | | + +## 6.1.6.2.38 Type: NssaiMapping + +Table 6.1.6.2.38-1: Definition of type NssaiMapping + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------------------------------------| +| mappedSnssai | Snssai | M | 1 | Indicates the mapped S-NSSAI in the serving PLMN | +| hSnssai | Snssai | M | 1 | Indicates the S-NSSAI in home PLMN | + +## 6.1.6.2.39 Type: UeRegStatusUpdateReqData + +Table 6.1.6.2.39-1: Definition of type UeRegStatusUpdateReqData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|---------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| transferStatus | UeContextTransferStatus | M | 1 | This IE shall indicate if the previous UE context transfer was completed. | | +| toReleaseSessionList | array(PduSessionId) | C | 1..N | This IE shall be present during UE Context Transfer procedure, if there are any PDU session(s) associated with Network Slice(s) which become no longer available.

When present, this IE shall include all the PDU session(s) associated with no longer available S-NSSAI(s). | | +| pcfReselectedInd | boolean | C | 0..1 | This IE shall be present and set to true if the target AMF has decided to select a new PCF for AM Policy and/or UE Policy other than the one which was included in the UeContext by the old AMF.

When present, it shall be set as follows:
- true: the target AMF has selected new PCF(s) other than the one which was included in the UeContext by the old AMF for AM Policy and/or UE Policy. | | +| smfChangeInfoList | array(SmfChangeInfo) | C | 1..N | This IE shall be present during an inter-AMF registration procedure, if there is an I-SMF or V-SMF change or removal for the related PDU session(s).

When present, this IE shall indicate the I-SMF/V-SMF situation after the registration completion at the target AMF. | DTSSA | +| analyticsNotUsedList | array(Uri) | C | 1..N | This IE shall be present to include the list of resource URIs of the analytics subscription(s) that are not taken over in the target AMF. | | +| toReleaseSessionInfo | array(ReleaseSessionInfo) | C | 1..N | This IE shall be present during UE Context Transfer procedure, if there are any PDU session(s) that cannot be supported in the target AMF for a reason other than no longer available S-NSSAI(s) as specified in step 1 of clause 5.2.2.2.2.1.

When present, this IE shall include list of the PDU session(s) and the release cause. | | + +## 6.1.6.2.40 Type: AssignEbiError + +**Table 6.1.6.2.40-1: Definition of type AssignEbiError** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------| +| error | ProblemDetails | M | 1 | Represents the application error information. The application level error cause shall be encoded in the "cause" attribute. | +| failureDetails | AssignEbiFailed | M | 1 | Describes the details of the failure including the list of ARPs for which the EBI assignment failed. | + +## 6.1.6.2.41 Type: UeContextCreateData + +**Table 6.1.6.2.41-1: Definition of type UeContextCreateData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ueContext | UeContext | M | 1 | Represents an individual ueContext resource to be created | | +| targetId | NgRanTargetId | M | 1 | Represents the identification of target RAN | | +| sourceToTargetData | N2InfoContent | M | 1 | This IE shall be included to contain the "Source to Target Transparent Container". | | +| pduSessionList | array(N2SmInformation) | M | 1..N | This IE shall be included to contain the list of N2SmInformation, where each N2SmInformation includes the "Handover Required Transfer" received from the source RAN per PDU session ID. | | +| n2NotifyUri | Uri | M | 1 | This IE shall contain a callback URI to receive the N2 Information Notification. | | +| ueRadioCapability | N2InfoContent | C | 0..1 | This IE shall be included to contain the "UE Radio Capability Information" if available.
(NOTE) | | +| ueRadio_capabilityForPaging | N2InfoContent | C | 0..1 | This IE shall be included to contain the "UE Radio Capability for Paging" if available.
(NOTE) | | +| ngapCause | NgApCause | C | 0..1 | This IE shall be present, if available. When present, it shall represent the NGAP Cause received from RAN. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | +| servingNetwork | PlmnIdNid | C | 0..1 | A Source AMF complying with this release of the specification shall include this IE to indicate the current Serving Network.
When present, this IE shall contain the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN. | | + +NOTE: The source AMF may decide to not include ueRadio\_capability and ueRadio\_capabilityForPaging if the target AMF supports the RACS feature and if: +a. the PlmnAssiUeRadioCapId is included in the MM Context for an intra-PLMN AMF mobility procedure; +or +b. the ManAssiUeRadioCapId is included in the MM Context for an intra-PLMN or an inter-PLMN AMF mobility procedure. + +## 6.1.6.2.42 Type: UeContextCreatedData + +Table 6.1.6.2.42-1: Definition of type UeContextCreatedData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ueContext | UeContext | M | 1 | Represents the newly created individual ueContext resource | +| targetToSourceData | N2InfoContent | M | 1 | This IE shall contain the "Target to Source Transparent Container". | +| pduSessionList | array(N2SmInformation) | M | 1..N | This IE shall be included to contain the list of N2SmInformation, where each N2SmInformation includes the "Handover Command Transfer" received from the SMF, per PDU session ID. | +| pcfReselectedInd | boolean | C | 0..1 | This IE shall be present and set to true if the target AMF has decided to select a new PCF for AM Policy and/or UE Policy other than the one which was included in the UeContext by the old AMF.

When present, it shall be set as follows:
- true: the target AMF has selected a new PCF other than the one which was included in the UeContext by the old AMF for AM Policy and/or UE Policy. | +| failedSessionList | array(N2SmInformation) | C | 1..N | This IE shall be included to contain a list of N2SmInformation, where each N2SmInformation includes the "Handover Preparation Unsuccessful Transfer" N2 SM content either received from the SMF for a PDU session failed to be handed over or generated by the target AMF for a PDU session not accepted by the target AMF (e.g. due to no response from the SMF within a maximum wait timer or due to non-available S-NSSAI in the target AMF). See NOTE. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | +| analyticsNotUsedList | array(Uri) | C | 1..N | This IE shall be present to include the list of resource URIs of the analytics subscription(s) that are not taken over in the target AMF. | + +NOTE: As an exception, the AMF generates N2 SM Information (Handover Preparation Unsuccessful Transfer IE) for a PDU session not accepted by the AMF, since this N2 SM IE needs to be included in the Handover Command sent by the source AMF to the source NG-RAN; this N2 SM IE carries a Cause value. + +## 6.1.6.2.43 Type: UeContextCreateError + +Table 6.1.6.2.43-1: Definition of type UeContextCreateError + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------|----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| error | ProblemDetails | M | 1 | Represents the detailed application error information. The application level error cause shall be encoded in the "cause" attribute. | | +| ngapCause | NgApCause | C | 0..1 | This IE shall be present, if available. When present, it shall represent the NGAP Cause received from RAN. | | +| targetToSourceFailureData | N2InfoContent | C | 0..1 | This IE shall be present if a "Target to Source Failure Transparent Container" has been received from the target NG-RAN. When present, this IE shall contain this container. | NPN | + +## 6.1.6.2.44 Type: NgRanTargetId + +**Table 6.1.6.2.44-1: Definition of type NgRanTargetId** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|--------------------------------------------------------------------------------------------------| +| ranNodeId | GlobalRanNodeId | M | 1 | Indicates the identity of the RAN node. The IE shall contain either the gNB ID or the NG-eNB ID. | +| tai | Tai | M | 1 | Indicates the selected TAI. | + +## 6.1.6.2.45 Type: N2InformationTransferError + +**Table 6.1.6.2.45-1: Definition of type N2InformationTransferError** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|-------------------------------------------------------------------------------------------------------------| +| error | ProblemDetails | M | 1 | More information on the error shall be provided in the "cause" attribute of the "ProblemDetails" structure. | +| pwsErrorInfo | PWSErrorData | C | 0..1 | This IE shall be present if the n2InformationClass is "PWS" in N2InformationTransferReqData. | + +## 6.1.6.2.46 Type: PWSResponseData + +**Table 6.1.6.2.46-1: Definition of type PWSResponseData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ngapMessageType | UInteger | M | 1 | This IE shall identify the message type of the message being sent. Its value is the numeric code of the Procedure Code defined in ASN.1 in clause 9.4.7 in 3GPP TS 38.413 [12]. | +| serialNumber | UInt16 | M | 1 | This IE shall contain the Serial Number of the associated PWS response message. | +| messageIdentifier | integer | M | 1 | This IE shall contain the Message Identifier of the associated PWS response message. | +| unknownTAIList | array(Tai) | O | 1..N | This IE shall contain the Unknown Tracking Area List which may be present in the associated PWS response message. | +| n2PwsSubMissInd | boolean | C | 0..1 | This IE should be present when sendRanResponse IE with the value true is included in the request, i.e. the RAN responses are expected to be notified to the NF service consumer (i.e. the sender CBCF or PWS-IWF), and the corresponding N2 information subscription subscription is not available in the AMF.

When present, this IE shall be set as following:
- true: Corresponding N2 information subscription to receive the requested RAN responses is missing in the AMF. | + +## 6.1.6.2.47 Type: PWSErrorData + +Table 6.1.6.2.47-1: Definition of type PWSErrorData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| namfCause | integer | M | 1 | Represents the cause value for the error that the AMF detected.
Cause values:
0 - Message accepted
1 - Parameter not recognised
2 - Parameter value invalid
3 - Valid message not identified
4 - Tracking area not valid
5 - Unrecognised message
6 - Missing mandatory element
7 - AMF capacity exceeded
8 - AMF memory exceeded
9 - Warning broadcast not supported
10 - Warning broadcast not operational
11 - Message reference already used
12 - Unspecified error
13 - Transfer syntax error
14 - Semantic error
15 - Message not compatible with receiver state | + +## 6.1.6.2.48 Void + +## 6.1.6.2.49 Type: NgKsi + +Table 6.1.6.2.49-1: Definition of type NgKsi + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------| +| tsc | ScType | M | 1 | Indicates whether the security context type is native or mapped. | +| ksi | integer | M | 1 | Indicates the key set identifier value. The value is within the range 0 to 6. | + +## 6.1.6.2.50 Type: KeyAmf + +Table 6.1.6.2.50-1: Definition of type KeyAmf + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|---------------------------------------------------------------------------------------------------------------------| +| keyType | KeyAmfType | M | 1 | Indicates whether the keyAmf represents $K_{amf}$ or $K'_{amf}$ . | +| keyVal | string | M | 1 | Indicates the key value. The key value is encoded as a string of hexadecimal characters.
Pattern: '[A-Fa-f0-9]{' | + +## 6.1.6.2.51 Type: ExpectedUeBehavior + +Table 6.1.6.2.51-1: Definition of type ExpectedUeBehavior + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|---------------------|---|-------------|---------------------------------------------------------------------------------------| +| expMoveTrajectory | array(UserLocation) | M | 1..N | This IE shall contain a list of user location areas where the UE is expected to move. | +| validityTime | DateTime | M | 1 | This IE shall contain the UTC time upto which the UE moving trajectory is valid. | + +## 6.1.6.2.52 Type: UeRegStatusUpdateRspData + +**Table 6.1.6.2.52-1: Definition of type UeRegStatusUpdateRspData** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| regStatusTransferComplete | boolean | M | 1 | This IE shall indicate if the status update of UE context transfer is completed successfully at the source AMF or not.
The value shall be set to true if the context transfer is completed successfully and false if the context transfer did not complete successfully. | + +## 6.1.6.2.53 Type: N2RanInformation + +**Table 6.1.6.2.53-1: Definition of type N2RanInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|-----------------------------------------------------------| +| n2InfoContent | N2InfoContent | M | 1 | This IE shall contain the N2 RAN information to transfer. | + +## 6.1.6.2.54 Type: N2InfoNotificationRspData + +**Table 6.1.6.2.54-1: Definition of type N2InfoNotificationRspData** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| secRatDataUsageList | array(N2SmInformation) | C | 1..N | This IE shall be present in the N2InfoNotify response sent by the source AMF to the target AMF during an Inter NG-RAN node N2 based handover procedure (see clause 5.2.2.3.6.2), if Secondary Rat Usage Data are available at the source AMF for one or more PDU sessions.

When present, this IE shall contain a list of N2SmInformation, where each N2SmInformation includes the "Secondary RAT Data Usage Report Transfer" information received from the source RAN for a given PDU session.

The sNssai IE and subjectToHo IE shall not be included in N2SmInformation. | + +## 6.1.6.2.55 Type: SmallDataRateStatusInfo + +**Table 6.1.6.2.55-1: Definition of type SmallDataRateStatusInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| singleNssai | Snssai | M | 1 | S-NSSAI | +| dnn | Dnn | M | 1 | This IE shall indicate the Data Network Name. The DNN shall be the full DNN (i.e. with both the Network Identifier and Operator Identifier) for a HR PDU session, and it should be the full DNN in LBO and non-roaming scenarios. If the Operator Identifier is absent, the serving core network operator shall be assumed. | +| smallDataRateStatus | SmallDataRateStatus | M | 1 | Small data rate status related to the S-NSSAI and Dnn. | + +## 6.1.6.2.56 Type: SmfChangeInfo + +**Table 6.1.6.2.56-1: Definition of type SmfChangeInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|---------------------|---|-------------|-------------------------------------------------------| +| pduSessionIdList | array(PduSessionId) | M | 1..N | PDU Session ID(s) for which the smfChangeInd applies. | +| smfChangeInd | SmfChangeIndication | M | 1 | Indicates the I-SMF or V-SMF change or removal. | + +## 6.1.6.2.57 Type: V2xContext + +**Table 6.1.6.2.57-1: Definition of type V2xContext** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nrV2xServicesAuth | NrV2xAuth | C | 0..1 | This IE shall be present if the UE is authorized to use the NR sidelink for V2X services. | +| lteV2xServicesAuth | LteV2xAuth | C | 0..1 | This IE shall be present if the UE is authorized to use the LTE sidelink for V2X services. | +| nrUeSidelinkAmbr | BitRate | C | 0..1 | This IE shall be present if the UE is authorized for NR V2X services.
When present, this IE contains subscription data on UE-PC5-AMBR for NR V2X services. | +| lteUeSidelinkAmbr | BitRate | C | 0..1 | This IE shall be present if the UE is authorized for LTE V2X services.
When present, this IE contains subscription data on UE-PC5-AMBR for LTE V2X services. | +| pc5QoSPara | Pc5QoSPara | C | 0..1 | This IE shall be present if the UE is authorized for NR V2X services.
When present, this IE contains policy data on the PC5 QoS parameters. | + +6.1.6.2.58 Type: ImmediateMdtConf + +**Table 6.1.6.2.58-1: Definition of type ImmediateMdtConf** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| jobType | JobType | M | 1 | This IE shall indicate the Job type for MDT, see 3GPP TS 32.422 [30]. | +| measurementLteList | array(MeasurementLteForMdt) | C | 1..N | This IE shall be present if available. When present, this IE shall contain a list of the measurements that shall be collected for LTE. | +| measurementNrList | array(MeasurementNrForMdt) | C | 1..N | This IE shall be present if available, when present, this IE shall contain a list of the measurements that shall be collected for NR. | +| reportingTriggerList | array(ReportingTrigger) | C | 1..N | This IE shall be present if available. When present, this IE shall contain a list of the reporting triggers. | +| reportInterval | ReportIntervalMdt | C | 0..1 | This IE shall be present if available. When present, this IE shall indicate the interval between the periodical measurements to be taken when UE is in connected in LTE. | +| reportIntervalNr | ReportIntervalNrMdt | C | 0..1 | This IE shall be present if available. When present, this IE shall indicate the interval between the periodical measurements to be taken when UE is in connected in NR. | +| reportAmount | ReportAmountMdt | C | 0..1 | This IE shall be present if available. When present, this IE shall indicate the number of measurement reports that shall be taken for periodical reporting while UE is in connected. | +| eventThresholdRsrp | integer | C | 0..1 | This IE shall be present if available. When present, this IE shall indicate the Event Threshold for RSRP. Minimum = 0. Maximum = 97. | +| eventThresholdRsrq | integer | C | 0..1 | This IE shall be present if available. When present, this IE shall indicate the Event Threshold for RSRQ. Minimum = 0. Maximum = 34. | +| eventThresholdRsrpNr | integer | C | 0..1 | This IE shall be present if available. When present, this IE shall indicate the Event Threshold for RSRP in NR. Minimum = 0. Maximum = 127. | +| eventThresholdRsrqNr | integer | C | 0..1 | This IE shall be present if available. When present, this IE shall indicate the Event Threshold for RSRQ in NR. Minimum = 0. Maximum = 127. | +| collectionPeriodRmmLte | CollectionPeriodRmmLteMdt | C | 0..1 | This IE shall be present if available. When present, it shall contain the collection period that should be used to collect available measurement samples in case of RRM configured measurements. | +| collectionPeriodRmmNr | CollectionPeriodRmmNrMdt | C | 0..1 | This IE shall be present if available. When present, it shall contain the collection period that should be used to collect available measurement samples in case of RRM configured measurements when UE is in NR. | +| measurementPeriodLte | MeasurementPeriodLteMdt | C | 0..1 | This IE shall be present if available. When present, it shall contain the measurement period that should be used for the Data Volume and Scheduled IP Throughput measurements in LTE. | +| areaScope | AreaScope | O | 0..1 | When present, this IE shall contain the area in Cells or Tracking Areas where the MDT data collection shall take place, see 3GPP TS 32.422 [30]. | +| positioningMethod | PositioningMethodMdt | O | 0..1 | When present, it shall indicate the positioning method that shall be used for the MDT job in LTE. | +| addPositioningMethodList | array(PositioningMethodMdt) | O | 1..N | This IE may be present if positioningMethod IE is present. When present, it shall indicate a list of the additional positioning methods that shall be used for the MDT job | +| mdtAllowedPlmnIdList | array(PlmnId) | O | 1..16 | When present, this IE shall contain the PLMNs related to MDT. | +| sensorMeasurementList | array(SensorMea | C | 1..N | This IE shall be present if available. | + +| | | | | | +|--|-----------|--|--|------------------------------------------------------------------------------------------------------------------------| +| | surement) | | | When present, this IE shall include a list the sensor measurements to be collected for UE in NR if they are available. | +|--|-----------|--|--|------------------------------------------------------------------------------------------------------------------------| + +6.1.6.2.59 Type: V2xInformation + +**Table 6.1.6.2.59-1: Definition of type V2xInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n2Pc5Pol | N2InfoContent | C | 0..1 | This IE shall be present if N2 PC5 policy should be transferred. When present, the IE contains the NGAP V2X related IEs specified in clause 9.3.1.150 of 3GPP TS 38.413 [12]. | + +6.1.6.2.60 Type: EpsNasSecurityMode + +**Table 6.1.6.2.60-1: Definition of type EpsNasSecurityMode** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|--------------------------|---|-------------|----------------------------------------------------------| +| integrityAlgorithm | EpsNasIntegrityAlgorithm | M | 1 | Indicates the integrity protection algorithm for EPS NAS | +| cipheringAlgorithm | EpsNasCipheringAlgorithm | M | 1 | Indicates the ciphering algorithm for EPS NAS. | + +6.1.6.2.61 Type: UeContextRelocateData + +**Table 6.1.6.2.61-1: Definition of type UeContextRelocateData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ueContext | UeContext | M | 1 | Represents an individual ueContext resource to be relocated. | | +| targetId | NgRanTargetId | M | 1 | Represents the identification of target RAN | | +| sourceToTargetData | N2InfoContent | M | 1 | This IE shall be included to contain the "Source to Target Transparent Container". | | +| forwardRelocationRequest | RefToBinaryData | M | 1 | This IE shall be present, and it shall contain the reference to the binary data carrying the Forward Relocation Request message (see clause 6.1.6.4). | | +| pduSessionList | array(N2SmInformation) | C | 1..N | This IE shall contain the list of N2SmInformation, where each N2SmInformation includes a PDU Session Resource Setup Request Transfer IE (see clause 9.3.4.1 of 3GPP TS 38.413 [24]) received from the SMF(s) per PDU session ID. | | +| ueRadioCapability | N2InfoContent | C | 0..1 | This IE shall be included to contain the "UE Radio Capability Information" if available. | | +| ngapCause | NgApCause | C | 0..1 | This IE shall be present, if available. When present, it shall represent the NGAP Cause mapped from the received S1-AP cause from the source E-UTRAN. Refer to 3GPP TS 29.010 [50] for the mapping of cause values between S1AP and NGAP. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | + +## 6.1.6.2.62 Type: UeContextRelocatedData + +Table 6.1.6.2.62-1: Definition of type UeContextRelocatedData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------| +| ueContext | UeContext | M | 1 | Represents an individual ueContext resource relocated to a new AMF. | + +## 6.1.6.2.63 Void + +## 6.1.6.2.64 Type: EcRestrictionDataWb + +Table 6.1.6.2.64-1: Definition of type EcRestrictionData + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ecModeARestricted | boolean | O | 0..1 | If present, indicates whether Enhanced Coverage Mode A is restricted or not.
true: Enhanced Coverage Mode A is restricted.
false or absent: Enhanced Coverage Mode A is not restricted. | +| ecModeBRestricted | boolean | M | 1 | This IE indicates whether Enhanced Coverage Mode B is restricted or not.
true: Enhanced Coverage Mode B is restricted.
false: Enhanced Coverage Mode B is not restricted. | + +## 6.1.6.2.65 Type: ExtAmfEventSubscription + +Table 6.1.6.2.65-1: Definition of type ExtAmfEventSubscription as a list of to be combined data types + +| Data type | Cardinality | Description | Applicability | +|-----------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------|---------------| +| AmfEventSubscription | 1 | AMF event subscription | | +| AmfEventSubscriptionAddInfo | 1 | Additional information for the AMF event subscription, e.g. Binding Indications, NF type of the NF that created the subscription. | | + +## 6.1.6.2.66 Type: AmfEventSubscriptionAddInfo + +Table 6.1.6.2.66-1: Definition of type AmfEventSubscriptionAddInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| bindingInfo | array(string) | O | 1..2 |

Binding indications received for event notifications (i.e. with "callback" scope) or for subscription change event notifications (i.e. with "subscription-events" scope) for an AMF event subscription.

When present, entries of the array shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name.

Example of an array entry: "bl= nf-set; nfset=set1.udmset.5gc.mnc012.mcc345; servname=nudm-ee;scope=subscription-events"

| +| subscribingNFType | NFType | C | 0..1 |

This IE should be present if the information is available. When present, it shall contain the NF type of the NF that created the subscription.

(NOTE X)

| +| eventSyncInd | boolean | C | 0..1 |

This IE should be present with value "true" when the event subscription shall be synchronized with UDM during EPS to 5GS mobility registration procedure, as specified in clause 5.3.2.4.2.

When present, this IE shall be set as following:
- true: the event subscription shall be synchronized with UDM.
- false: the event subscription shall not be synchronized with UDM.

| +| nfConsumerInfo | array(string) | C | 1..N |

When present, this IE shall contain the NF Service Consumer information received together with the AMF event subscription and entries of the array shall be set to the value of the 3gpp-Sbi-Consumer-Info header defined in clause 5.2.3.3.7 of 3GPP TS 29.500 [4], without the header name.

| +| aoiStateList | map(AreaOfInterestEventState) | O | 1..N |

Map of subscribed Area of Interest (AoI) Event State in the old AMF.

For the subscribed AoI Event(s), the JSON pointer to an AmfEventArea element in the areaList IE (or a PresenceInfo element in presenceInfoList IE) of the AmfEvent data type (see clause 6.2.6.2.3) shall be the key of the map.

(NOTE 2)

| +| accessToken | string | O | 0..1 |

See clause 13.4.1.4 of 3GPP TS 33.501 [27], and clause 5.2.2.2.1.1 and 5.2.2.2.3.1 for the use of this IE.

When present, this IE shall contain a JWS Compact Serialized representation of the JWS signed JSON object containing AccessTokenClaims (see clause 6.3.5.2.4 of 3GPP TS 29.510 [29]) that was received by the source AMF for authorizing the subscription.

| + +NOTE 1: In scenarios where an "intermediate NF" (e.g. UDM) creates a subscription on behalf of a "source NF" (e.g. NEF), this IE shall contain the NF type of the "intermediate NF". The NF type of the "source NF" may be available in the AmfEventSubscription. + +NOTE 2: The new AMF may use the information to determine whether the UE presence state in the AOI(s) has changed, thus should be reported to the NF consumer. + +## 6.1.6.2.67 Type: UeContextCancelRelocateData + +**Table 6.1.6.2.67-1: Definition of type UeContextCancelRelocateData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|-----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supi | Supi | C | 0..1 | This IE shall be present if the UE is emergency registered and the SUPI is not authenticated. | +| relocationCancelRequest | RefToBinaryData | M | 1 | This IE shall be present, and it shall contain the reference to the binary data carrying the GTP-C Relocation Cancel Request message (see clause 6.1.6.4). | + +## 6.1.6.2.68 Type: UeDifferentiationInfo + +**Table 6.1.6.2.68-1: Definition of type UeDifferentiationInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|--------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| periodicComInd | PeriodicCommunicationIndicator | O | 0..1 | This IE indicates whether the UE communicates periodically or not, e.g. only on demand. | +| periodicTime | DurationSec | O | 0..1 | This IE indicates the interval time of periodic communication (see TS 23.502 [3] clause 4.15.6.3). | +| scheduledComTime | ScheduledCommunicationTime | O | 0..1 | This IE indicates time and day of the week when the UE is available for communication (see TS 23.502 [3] clause 4.15.6.3). | +| stationaryInd | StationaryIndication | O | 0..1 | This IE indicates whether the UE is stationary or mobile (see TS 23.502 [3] clause 4.15.6.3). | +| trafficProfile | TrafficProfile | O | 0..1 | This IE indicates the type of data transmission: single packet transmission (UL or DL), dual packet transmission (UL with subsequent DL or DL with subsequent UL), multiple packets transmission | +| batteryInd | BatteryIndication | O | 0..1 | This IE indicates the power consumption type(s) of the UE (see TS 23.502 [3] clause 4.15.6.3). | +| validityTime | DateTime | O | 0..1 | When present, this IE identifies the UTC time when the expected UE behaviour parameters expire and shall be deleted locally if it expire (see TS 23.502 [3] clause 4.15.6.3).
When absent, no expiry for the expected UE behaviour parameters applies. | + +## 6.1.6.2.69 Type: CeModeBlnd + +**Table 6.1.6.2.69-1: Definition of type CeModeBlnd** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ceModeBSupportInd | boolean | M | 1 | This IE shall contain the CE-mode-B Support Indicator (See 3GPP TS 38.413 [12], clause 9.3.1.156).

This IE shall be set as follows:
- true: CE-mode-B is supported;
- false: CE-mode-B is not supported. | + +## 6.1.6.2.70 Type: LteMInd + +Table 6.1.6.2.70-1: Definition of type LteMInd + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lteCatMInd | boolean | M | 1 | This IE shall contain the LTE-M Indication (See 3GPP TS 38.413 [12], clause 9.3.1.157).

This IE shall be set as follows:
- true: LTE-M is indicated by the UE;
- false: LTE-M is not indicated by the UE. | + +## 6.1.6.2.71 Type: NpnAccessInfo + +Table 6.1.6.2.71-1: Definition of type NpnAccessInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|-----------------------------------------------------| +| cellCagInfo | array(CagId) | O | 1..N | This IE shall contain the CAG List of the CAG cell. | + +## 6.1.6.2.72 Type: ProseContext + +Table 6.1.6.2.72-1: Definition of type ProseContext + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| directDiscovery | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to use the NR sidelink for the ProSe Direct Discovery service. | +| directComm | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to use the NR sidelink for the ProSe Direct Communication service. | +| l2Relay | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to act as a 5G ProSe Layer-2 UE-to-Network Relay. | +| l3Relay | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to act as a 5G ProSe Layer-3 UE-to-Network Relay. | +| l2Remote | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to act as a 5G ProSe Layer-2 Remote UE. | +| l3Remote | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to act as a 5G ProSe Layer-3 Remote UE. | +| l2UeRelay | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to act as a 5G ProSe Layer-2 UE-to-UE Relay. | +| l3UeRelay | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to act as a 5G ProSe Layer-3 UE-to-UE Relay. | +| l2End | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to act as a 5G ProSe Layer-2 End UE. | +| l3End | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to act as a 5G ProSe Layer-3 End UE. | +| multiPathComm | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to use multi-path communication via direct Uu path and via 5G ProSe Layer-2 UE-to-Network Relay as a 5G ProSe Layer-2 Remote UE. | +| nrUePc5Ambr | BitRate | C | 0..1 | This IE shall be present if the UE is authorized to use the NR sidelink for the ProSe services. When present, this IE contains the ProSe NR UE-PC5-AMBR. | +| pc5QoSPara | Pc5QoSPara | C | 0..1 | This IE shall be present if the UE is authorized to use the NR sidelink for the ProSe services. When present, this IE contains policy data on the PC5 QoS parameters for the ProSe services on the NR sidelink. | + +## 6.1.6.2.73 Type: AnalyticsSubscription + +**Table 6.2.6.2.73-1: Definition of type AnalyticsSubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------------------------------------|--------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------| +| nwdafId | NfInstanceId | C | 0..1 | This IE shall be present, if available.

When present, this IE shall contain the NF Instance ID of the NWDAF.
(NOTE). | +| nwdafSetId | NfSetId | C | 0..1 | This IE shall be present, if available.

When present, this IE shall contain the NF Set ID of the NWDAF.
(NOTE). | +| nwdafSubscriptionList | array(NwdafSubscription) | M | 1..N | List of NWDAF subscriptions identified by subscription Id. | +| NOTE: At least one nwdafId or nwdafSetId shall be included. | | | | | + +## 6.1.6.2.74 Type: NwdafSubscription + +**Table 6.2.6.2.74-1: Definition of type NwdafSubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|--------------------------|---|-------------|----------------------------------------------------------------------| +| nwdafEvtSubsServiceUri | Uri | M | 1 | It identifies the resource URI of the individual NWDAF subscription. | +| nwdafEventsSubscription | NnwdafEventsSubscription | M | 1 | The created Individual NWDAF Event Subscription resource | + +## 6.1.6.2.75 Type: UpdpSubscriptionData + +**Table 6.1.6.2.75-1: Definition of type UpdpSubscriptionData** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| updpNotifySubscriptionId | string | M | 1 | Represents the Id created by the AMF for the subscription to notify a UE policy delivery related N1 information. | +| updpNotifyCallbackUri | Uri | M | 1 | This IE represents the callback URI on which the UE policy delivery related N1 message shall be notified. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported by the NF service consumer. | +| updpCallbackBinding | string | C | 0..1 | This IE shall be present if Binding Indication was received for the PCF for the callback URI.

When present, this IE shall contain the Binding indication of callback URI and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. | + +## 6.1.6.2.76 Type: ProSeInformation + +**Table 6.1.6.2.76-1: Definition of type ProSeInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------| +| n2Pc5ProSePol | N2InfoContent | M | 0..1 | This attribute contains the N2 PC5 policy for 5G ProSe. This IE contains the NGAP ProSe related IEs specified in 3GPP TS 38.413 [12]. | + +## 6.1.6.2.77 Type: ReleaseSessionInfo + +**Table 6.1.6.2.77-1: Definition of type ReleaseSessionInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|---------------------|---|-------------|----------------------------------------------------------------| +| releaseSessionList | array(PduSessionId) | M | 1..N | This IE shall include the PDU session Id(s) to be released. | +| releaseCause | ReleaseCause | M | 1 | This IE shall include the cause to release the PDU session(s). | + +## 6.1.6.2.78 Type: AreaOfInterestEventState + +**Table 6.1.6.2.78-1: Definition of type AreaOfInterestEventState** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| presence | PresenceState | M | 1 | This IE shall contain the UE presence state for the indicated area of interest. | +| individualPraidList | array(string) | C | 1..N | This IE shall be present if the indicated area of interest referring to a set of Core Network predefined Presence Reporting Areas and the UE is in at least one individual PRA within the set of Core Network predefined Presence Reporting Areas.

When present, this IE shall contain the PRA Identifier of the individual PRA(s) where the UE is located. | + +## 6.1.6.2.79 Type: TssInformation + +**Table 6.1.6.2.79-1: Definition of type TssInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nflId | NfInstanceId | C | 0..1 | This IE shall be present when the N2InfoContainer containing the TssInformation is included in N2InformationTransferReqData. When present, this IE shall carry the NF instance identity of the NF Service Consumer (e.g. TSCTSF). | +| tssContainer | N2InfoContent | M | 1 | This IE represents the TSS N2 information data part to be relayed between TSCTSF and AN. | + +## 6.1.6.2.80 Type: AmPolicyInfoContainer + +**Table 6.1.6.2.80-1: Definition of type AmPolicyInfoContainer** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sliceUsgCtrlInfoSets | map(SliceUsageControlInfo) | C | 1..N | This IE shall be present when available.

When present, this IE shall indicate the network slice usage control related information received from PCF of AM Policy.

The key of the map is the S-NSSAI to which the network slice usage control related information (the value part of the map) is related. | + +## 6.1.6.2.8.1 Type: RslpInformation + +Table 6.1.6.2.8.1-1: Definition of type RslpInformation + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n2Pc5RslpPol | N2InfoContent | M | 1 | This attribute contains the N2 PC5 policy for Ranging/SL positioning. This IE contains the Ranging and Sidelink Positioning Service Information specified in 3GPP TS 38.413 [12]. | + +## 6.1.6.2.8.2 Type: A2xContext + +Table 6.1.6.2.8.2-1: Definition of type A2xContext + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nrA2xServicesAuth | NrA2xAuth | C | 0..1 | This IE shall be present if the UE is authorized to use the NR sidelink for A2X services. | +| lteA2xServicesAuth | LteA2xAuth | C | 0..1 | This IE shall be present if the UE is authorized to use the LTE sidelink for V2X services. | +| nrUeSidelinkAmbr | BitRate | C | 0..1 | This IE shall be present if the UE is authorized for NR A2X services.
When present, this IE contains subscription data on UE-PC5-AMBR for NR A2X services. | +| lteUeSidelinkAmbr | BitRate | C | 0..1 | This IE shall be present if the UE is authorized for LTE A2X services.
When present, this IE contains subscription data on UE-PC5-AMBR for LTE A2X services. | +| pc5QoSPara | Pc5QoSPara | C | 0..1 | This IE shall be present if the UE is authorized for NR A2X services.
When present, this IE contains policy data on the PC5 QoS parameters. | + +## 6.1.6.2.8.3 Type: A2xInformation + +Table 6.1.6.2.8.3-1: Definition of type A2xInformation + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n2Pc5Pol | N2InfoContent | C | 0..1 | This IE shall be present if N2 PC5 policy should be transferred. When present, the IE contains the NGAP A2X related IEs specified in clause 9.3.1.150 of 3GPP TS 38.413 [12]. | + +## 6.1.6.2.8.4 Type: LcsUpContext + +Table 6.1.6.2.8.4-1: Definition of type LcsUpContext + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|--------------------|---|-------------|----------------------| +| upConnectionStatus | UpConnectionStatus | O | 0..1 | UP Connection Status | +| servingLMFIdentification | LMFIdentification | O | 0..1 | Serving LMF ID | + +### 6.1.6.3 Simple data types and enumerations + +#### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EpsBearerId | integer | Integer identifying an EPS bearer, within the range 0 to 15, as specified in clause 11.2.3.1.5, bits 5 to 8, of 3GPP TS 24.007 [15]. | +| Ppi | integer | This represents the Paging Policy Indicator. The value is within the range 0 to 7. | +| NasCount | UInteger | Unsigned integer identifying the NAS COUNT as specified in 3GPP TS 33.501 [27] | +| 5GMmCapability | Bytes | String with format "byte" as defined in OpenAPI Specification [23], i.e. base64-encoded characters, encoding the "5GMM capability" IE as specified in clause 9.11.3.1 of 3GPP TS 24.501 [11] (starting from octet 1). | +| UeSecurityCapability | Bytes | String with format "byte" as defined in OpenAPI Specification [23], i.e. base64-encoded characters, encoding the " UE security capability" IE as specified in clause 9.11.3.54 of 3GPP TS 24.501 [11] (starting from octet 1). | +| S1UeNetworkCapability | Bytes | String with format "byte" as defined in OpenAPI Specification [23], i.e. base64-encoded characters, encoding the " S1 UE network capability" IE as specified in clause 9.11.3.48 of 3GPP TS 24.501 [11] (starting from octet 1). | +| DrxParameter | Bytes | String with format "byte" as defined in OpenAPI Specification [23], i.e. base64-encoded characters, encoding the "5GS DRX Parameters" IE as specified in clause 9.11.3.2A of 3GPP TS 24.501 [11] (starting from octet 1). | +| OmciIdentifier | string | The OMC Identifier indicates the identity of an Operation and Maintenance Centre to which Trace Records shall be sent.
minLength: 1
maxLength: 20 | +| MSClassmark2 | Bytes | String with format "byte" as defined in OpenAPI Specification [23], i.e. base64-encoded characters, encoding the Mobile Station Classmark 2 as specified in clause 9.11.3.31C of 3GPP TS 24.501 [11] (starting from octet 1). | +| SupportedCodec | Bytes | String with format "byte" as defined in OpenAPI Specification [23], i.e. base64-encoded characters, encoding the Supported Codec as specified in clause 9.11.3.51A of 3GPP TS 24.501 [11] (starting from octet 1). | + +#### 6.1.6.3.3 Enumeration: StatusChange + +**Table 6.1.6.3.3-1: Enumeration StatusChange** + +| Enumeration value | Description | +|-------------------|---------------------------------------------------------------------| +| "AMF_UNAVAILABLE" | The AMF is unavailable to serve the UEs identified by the GUAMI(s). | +| "AMF_AVAILABLE" | The AMF is available to serve the UEs identified by the GUAMI(s). | + +## 6.1.6.3.4 Enumeration: N2InformationClass + +**Table 6.1.6.3.4-1: Enumeration N2InformationClass** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------------------------------------|---------------| +| "SM" | N2 SM information. | | +| "NRPPa" | N2 NRPPa information. | | +| "PWS" | N2 PWS information of PWS type. | | +| "PWS-BCAL" | N2 Broadcast Completed Area List or the Broadcast Cancelled Area List. | | +| "PWS-RF" | N2 Restart Indication or Failure Indication | | +| "RAN" | N2 RAN related information. | | +| "V2X" | N2 V2X information | | +| "PROSE" | N2 5G ProSe information. | ProSe | +| "TSS" | N2 Timing Synchronisation Status information | | +| "RANGING_SL" | N2 ranging and sidelink positioning information transport over PC5 | Ranging_SL | +| "A2X" | N2 A2X information | A2X | + +## 6.1.6.3.5 Enumeration: N1MessageClass + +**Table 6.1.6.3.5-1: Enumeration N1MessageClass** + +| Enumeration value | Description | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "5GMM" | The whole NAS message as received (for e.g. used in forwarding the Registration message to target AMF during Registration procedure with AMF redirection). | +| "SM" | N1 Session Management message | +| "LPP" | N1 LTE Positioning Protocol message | +| "SMS" | N1 SMS message as specified in 3GPP TS 23.040 [44] and 3GPP TS 24.011 [45] | +| "UPDP" | The N1 messages for UE Policy Delivery (See Annex D of 3GPP TS 24.501 [11]). | +| "LCS" | The N1 message of Location service message type | + +## 6.1.6.3.6 Enumeration: N1N2MessageTransferCause + +**Table 6.1.6.3.6-1: Enumeration N1N2MessageTransferCause** + +| Enumeration value | Description | +|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "ATTEMPTING_TO_REACH_UE" | This cause represents the case where the AMF has initiated paging to reach the UE in order to deliver the N1 message. | +| "N1_N2_TRANSFER_INITIATED" | This cause represents the case where the AMF has initiated the N1/N2 message transfer towards the UE and/or the AN. | +| "WAITING_FOR_ASYNCHRONOUS_TRANSFER" | This cause represents the case where the AMF has stored the N1/N2 message due to Asynchronous Transfer. | +| "UE_NOT_RESPONDING" | This cause represents the case that the AMF has initiated paging to reach the UE but the UE is not responding to the paging, or the case of a UE in RRC Inactive state when NG-RAN paging is not successful (e.g. NG-RAN initiated a UE context release with a cause indicating the non-delivery of the N1 message). | +| "N1_MSG_NOT_TRANSFERRED" | This cause represents the case where the AMF has skipped sending N1 message to the UE, when UE is in CM-IDLE and the "skipInd" is set to "true" in the request. | +| "N2_MSG_NOT_TRANSFERRED" | This cause indicates that the AMF has skipped sending the N2 message (i.e. PDU Session Resource Setup Request) as well as the possibly included N1 message to the 5G-AN, when the UE is in CM-CONNECTED state and the UE is outside of the validity area included in the N1N2MessageTransfer Request. | +| "UE_NOT_REACHABLE_FOR_SESSION" | This cause indicates that the UE is not reachable for the non-3GPP PDU session, due to the UE being in CM-IDLE for non-3GPP access and the PDU session is not allowed to move to 3GPP access. | +| "TEMPORARY_REJECT_REGISTRATION_ONGOING" | This cause represents the case that the AMF has initiated paging to reach the UE but there is an ongoing registration procedure. | +| "TEMPORARY_REJECT_HANDOVER_ONGOING" | This cause indicates that the AMF has initiated N1 signalling towards the UE but the N1 message could not be delivered due to an ongoing Xn or N2 handover procedure. | +| "REJECTION_DUE_TO_PAGING_RESTRICTION" | This cause represents the case that the UE has rejected the page as specified in 3GPP TS 23.501 [2] clause 5.38.4. | +| "AN_NOT_RESPONDING" | This cause indicates that the AMF has initiated a N2 request to transfer a N2 PDU (e.g. to setup, modify or release PDU session resources) but the AN is not responding to the N2 request. | +| "FAILURE_CAUSE_UNSPECIFIED" | This cause indicates that the N1/N2 message transfer failed due to unspecified reasons. | + +## 6.1.6.3.7 Enumeration: UeContextTransferStatus + +**Table 6.1.6.3.7-1: Enumeration UeContextTransferStatus** + +| Enumeration value | Description | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "TRANSFERRED" | Indicates a UE Context Transfer procedure is completed successful for the individual ueContext resource | +| "NOT_TRANSFERRED" | Indicates a UE Context Transfer procedure either did not complete successfully or the Registration request from the UE is redirected to another NF Service Consumer (e.g. AMF). | + +## 6.1.6.3.8 Enumeration: N2InformationTransferResult + +**Table 6.1.6.3.8-1: Enumeration N2InformationTransferResult** + +| Enumeration value | Description | +|------------------------------|-------------------------------------------------------------------------------------------------------------| +| "N2_INFO_TRANSFER_INITIATED" | This cause code represents the case where the AMF has initiated the N2 information transfer towards the AN. | + +## 6.1.6.3.9 Enumeration: CipheringAlgorithm + +**Table 6.1.6.3.9-1: Enumeration CipheringAlgorithm** + +| Enumeration value | Description | +|-------------------|---------------------------------| +| "NEA0" | Null ciphering algorithm | +| "NEA1" | 128-bit SNOW 3G based algorithm | +| "NEA2" | 128-bit AES based algorithm | +| "NEA3" | 128-bit ZUC based algorithm | + +## 6.1.6.3.10 Enumeration: IntegrityAlgorithm + +**Table 6.1.6.3.10-1: Enumeration IntegrityAlgorithm** + +| Enumeration value | Description | +|-------------------|-------------------------------------| +| "NIA0" | Null Integrity Protection algorithm | +| "NIA1" | 128-bit SNOW 3G based algorithm | +| "NIA2" | 128-bit AES based algorithm | +| "NIA3" | 128-bit ZUC based algorithm | + +## 6.1.6.3.11 Enumeration: SmsSupport + +**Table 6.1.6.3.11-1: Enumeration SmsSupport** + +| Enumeration value | Description | +|-------------------|------------------------------------------------------| +| "3GPP" | Support SMS delivery over NAS in 3GPP access | +| "NON_3GPP" | Support SMS delivery via non-3GPP access | +| "BOTH" | Support SMS delivery over NAS or via non-3GPP access | +| "NONE" | Don't support SMS delivery | + +## 6.1.6.3.12 Enumeration: ScType + +**Table 6.1.6.3.12-1: Enumeration ScType** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------| +| "NATIVE" | Native security context (for KSI AMF ) | +| "MAPPED" | Mapped security context (for KSI ASME ) | + +## 6.1.6.3.13 Enumeration: KeyAmfType + +**Table 6.1.6.3.13-1: Enumeration KeyAmfType** + +| Enumeration value | Description | +|-------------------|--------------------------------------| +| "KAMF" | The K amf value is sent. | +| "KPRIMEAMF" | The K' amf value is sent. | + +## 6.1.6.3.14 Enumeration: TransferReason + +**Table 6.1.6.3.14-1: Enumeration TransferReason** + +| Enumeration value | Description | +|-------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| "INIT_REG" | It indicates the AMF requests UE context for initial registration or disaster roaming initial registration. | +| "MOBI_REG" | It indicates the AMF requests UE context for mobility registration or disaster roaming mobility registration. | +| "MOBI_REG_UE_VALIDATED" | It indicates the AMF requests UE context for mobility registration or disaster roaming mobility registration of a validated UE. | + +## 6.1.6.3.15 Enumeration: PolicyReqTrigger + +**Table 6.1.6.3.15-1: Enumeration PolicyReqTrigger** + +| Enumeration value | Description | +|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "LOCATION_CHANGE" | The AM policy request shall be triggered when the UE's location (Tracking Area) changes. | +| "PRA_CHANGE" | The AM policy request shall be triggered when the UE is entering / leaving a Presence Reporting Area. | +| "ALLOWED_NSSAI_CHANGE" | The policy request shall be triggered when the allowed NSSAI of the UE has changed. | +| "NWDAF_DATA_CHANGE" | The AM policy request shall be triggered when the NWDAF instance IDs used for the UE and/or associated Analytics IDs have changed. | +| "PLMN_CHANGE" | The UE policy request shall be triggered when the serving PLMN of UE has changed. | +| "CON_STATE_CHANGE" | The UE policy request shall be triggered when the connectivity state of UE has changed. | +| "SMF_SELECT_CHANGE" | The AM policy request shall be triggered when the UE request for an unsupported DNN or the UE request for a DNN within the list of DNN candidates for replacement per S-NSSAI. | +| "ACCESS_TYPE_CHANGE" | The AM policy request shall be triggered when the access type and the RAT type combinations available in the AMF for a UE with simultaneous 3GPP and non-3GPP connectivity have changed. | +| "SAT_BACKHAUL_CHANGE" | The UE policy request shall be triggered when the UE's satellite backhaul category changes. | + +## 6.1.6.3.16 Enumeration: RatSelector + +**Table 6.1.6.3.16-1: Enumeration RatSelector** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------------| +| "E-UTRA" | The N2 information shall be transferred to ng-eNBs only. | +| "NR" | The N2 information shall be transferred to gNBs only. | + +## 6.1.6.3.17 Enumeration: NgapleType + +Table 6.1.6.3.17-1: Enumeration NgapleType + +| Enumeration value | Description | +|----------------------------------|------------------------------------------------| +| "PDU_RES_SETUP_REQ" | PDU Session Resource Setup Request Transfer | +| "PDU_RES_REL_CMD" | PDU Session Resource Release Command Transfer | +| "PDU_RES_MOD_REQ" | PDU Session Resource Modify Request Transfer | +| "HANDOVER_CMD" | Handover Command Transfer | +| "HANDOVER_REQUIRED" | Handover Required Transfer | +| "HANDOVER_PREP_FAIL" | Handover Preparation Unsuccessful Transfer | +| "SRC_TO_TAR_CONTAINER" | Source to Target Transparent Container | +| "TAR_TO_SRC_CONTAINER" | Target to Source Transparent Container | +| "TAR_TO_SRC_FAIL_CONTAINER" | Target to Source Failure Transparent Container | +| "RAN_STATUS_TRANS_CONTAINER" | RAN Status Transfer Transparent Container | +| "SON_CONFIG_TRANSFER" | SON Configuration Transfer | +| "NRPPA_PDU" | NRPPa-PDU | +| "UE_RADIO_CAPABILITY" | UE Radio Capability | +| "RIM_INFO_TRANSFER" | RIM Information Transfer | +| "SECONDARY_RAT_USAGE" | Secondary RAT Data Usage Report Transfer | +| "PC5_QOS_PARA" | PC5 QoS Parameters | +| "EARLY_STATUS_TRANS_CONTAINER" | Early Status Transfer Transparent Container | +| "UE_RADIO_CAPABILITY_FOR_PAGING" | UE Radio Capability for Paging | + +## 6.1.6.3.18 Enumeration: N2InfoNotifyReason + +Table 6.1.6.3.18-1: Enumeration N2InfoNotifyReason + +| Enumeration value | Description | +|----------------------|--------------------------------------------------------------------------------------------------------------------| +| "HANDOVER_COMPLETED" | Indicates that the N2 Information Notification is delivered when the handover procedure is completed successfully. | + +## 6.1.6.3.19 Enumeration: SmfChangeIndication + +Table 6.1.6.3.19-1: Enumeration SmfChangeIndication + +| Enumeration value | Description | +|-------------------|-------------------------------------| +| "CHANGED" | I-SMF or V-SMF changed. (NOTE 1) | +| "REMOVED" | I-SMF or V-SMF is removed. (NOTE 2) | + +NOTE 1: This enumeration value shall also be used if the UE moves from HPLMN to a VPLMN, a V-SMF is inserted and the I-SMF is removed, or from VPLMN to HPLMN, an I-SMF is inserted and the V-SMF is removed. + +NOTE 2: This enumeration value shall also be used if the UE moves from VPLMN to HPLMN, without an I-SMF inserted in the HPLMN. + +## 6.1.6.3.20 Enumeration: SbiBindingLevel + +Table 6.1.6.3.20-1: Enumeration SbiBindingLevel + +| Enumeration value | Description | +|-------------------------------|------------------------------------------| +| "NF_INSTANCE_BINDING" | Indicates binding to NF instance | +| "NF_SET_BINDING" | Indicates binding to NF Set | +| "NF_SERVICE_SET_BINDING" | Indicates binding to NF Service Set | +| "NF_SERVICE_INSTANCE_BINDING" | Indicates binding to NF Service instance | + +#### 6.1.6.3.21 Enumeration: EpsNasCipheringAlgorithm + +This data type enumerates the algorithms for data ciphering in EPS NAS, as specified in clause 5.1.3.2 of 3GPP TS 33.401 [49]. + +**Table 6.1.6.3.21-1: Enumeration EpsNasCipheringAlgorithm** + +| Enumeration value | Description | +|-------------------|---------------------------------| +| "EEA0" | Null ciphering algorithm | +| "EEA1" | 128-bit SNOW 3G based algorithm | +| "EEA2" | 128-bit AES based algorithm | +| "EEA3" | 128-bit ZUC based algorithm | + +#### 6.1.6.3.22 Enumeration: EpsNasIntegrityAlgorithm + +This data type enumerates the algorithms for data integrity protection in EPS NAS, as specified in clause 5.1.4.2 of 3GPP TS 33.401 [49]. + +**Table 6.1.6.3.22-1: Enumeration EpsNasIntegrityAlgorithm** + +| Enumeration value | Description | +|-------------------|-------------------------------------| +| "EIA0" | Null Integrity Protection algorithm | +| "EIA1" | 128-bit SNOW 3G based algorithm | +| "EIA2" | 128-bit AES based algorithm | +| "EIA3" | 128-bit ZUC based algorithm | + +#### 6.1.6.3.23 Enumeration: PeriodicCommunicationIndicator + +This data type enumerates types of Periodic Communication Indicator. + +**Table 6.1.6.3.23-1: Enumeration PeriodicCommunicationIndicator** + +| Enumeration value | Description | +|-------------------|--------------| +| "PERIODICALLY" | Periodically | +| "ON_DEMAND" | On demand | + +#### 6.1.6.3.24 Enumeration: UuaaMmStatus + +This data type enumerates types of UUAA-MM status. + +**Table 6.1.6.3.24-1: Enumeration UuaaMmStatus** + +| Enumeration value | Description | +|-------------------|-------------| +| "SUCCESS" | Success | +| "PENDING" | Pending | +| "FAILED" | Failed | + +### 6.1.6.3.25 Enumeration: ReleaseCause + +**Table 6.1.6.3.25-1: Enumeration ReleaseCause** + +| Enumeration value | Description | +|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "SNPN_SNPN_MOBILITY" | This cause represents the case where the continuity of the PDU Session(s) cannot be supported between networks due to SNPN-SNPN mobility. | +| "NO_HR_AGREEMENT" | This cause represents the case where the continuity of the PDU Session(s) cannot be supported between networks due to inter-PLMN mobility where no HR agreement exists. | +| "UNSPECIFIED" | This cause indicates that the continuity of the PDU Session(s) cannot be supported between networks due to unspecified reasons. | + +### 6.1.6.4 Binary data + +#### 6.1.6.4.1 Introduction + +This clause defines the binary data that shall be supported in a binary body part in an HTTP multipart message (see clauses 6.1.2.2.2 and 6.1.2.4). + +**Table 6.1.6.4.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|------------------------|----------------|----------------| +| N1 Message | 6.1.6.4.2 | vnd.3gpp.5gnas | +| N2 Information | 6.1.6.4.3 | vnd.3gpp.ngap | +| Mobile Terminated Data | 6.1.6.4.3 | vnd.3gpp.5gnas | +| GTP-C message | 6.1.6.4.5 | vnd.3gpp.gtpc | + +#### 6.1.6.4.2 N1 Message + +N1 Message shall encode a 5GS NAS message of a specified type (e.g. SM, LPP) as specified in 3GPP TS 24.501 [11], using the vnd.3gpp.5gnas content-type. + +N1 Message may encode e.g. the following 5GS NAS messages: + +- For message class SM: + - PDU Session Modification Command (see clause 8.3.7 of 3GPP TS 24.501 [11]) during network initiated PDU session modification procedure (see clause 4.3.3 of 3GPP TS 23.502 [3]); + - PDU Session Release Command (see clause 8.3.12 of 3GPP TS 24.501 [11]) during network initiated PDU session release procedure (see clause 4.3.4 of 3GPP TS 23.502 [3]). + - PDU Session Establishment Accept (see clause 8.3.2 in 3GPP TS 24.501 [11]) during UE-requested PDU Session Establishment (see clause 4.3.2.2 in 3GPP TS 23.502 [3]). +- For message class LPP: + - UE Positioning Request messages as specified in 3GPP TS 36.355 [13] during UE assisted and UE based positioning procedure (see clause 6.11.1 of 3GPP TS 23.273 [42]). +- For message class 5GMM: + - REGISTRATION REQUEST message as specified in see clause 8.2.5 of 3GPP TS 24.501 [11], during registration procedures (see clause 4.2.2.2 of 3GPP TS 23.502 [3]). +- For message class UPDP: + - MANAGE UE POLICY COMMAND / MANAGE UE POLICY COMPLETE / MANAGE UE POLICY REJECT (see Annex D.5.1 to Annex D.5.3 of 3GPP TS 24.501 [11]) during network initiated UE policy management procedure (see Annex D.2.1 of 3GPP TS 24.501 [11]); + +- UE STATE INDICATION (see Annex D.5.4 of 3GPP TS 24.501 [11]) during UE initiated UE state indication procedure (see Annex D.2.2 of 3GPP TS 24.501 [11]). +- UE POLICY PROVISIONING REQUEST / UE POLICY PROVISIONING REJECT (see clause 7.2 of 3GPP TS 24.587 [53]) during UE-requested V2X policy provisioning procedure and/or 5G ProSe policy provisioning procedure (see clause 5.3.2 of 3GPP TS 24.587 [53] and/or clause 5.3.2 of 3GPP TS 24.554 [54] respectively) and/or UE-requested A2X policy provisioning procedure (see clause 5.3.2 of 3GPP TS 24.577 [60]). +- For message class LCS: + - Location services messages between UE and LMF (lcs-PeriodicTriggeredInvoke/lcs-EventReport/lcs-CancelDeferredLocation) as specified in 3GPP TS 24.080 [43] during deferred 5GC-MT-LR procedure (see clause 6.3 of 3GPP TS 23.273 [42]). + - Location services messages between PRU and LMF during PRU association and disassociation procedures (see clause 6.17 of 3GPP TS 23.273 [42]). +- For message class SMS: + - SMS payload information as specified in 3GPP TS 23.040 [44] and 3GPP TS 24.011 [45], e.g. CP-DATA, CP-ACK, CP-ERROR. + +#### 6.1.6.4.3 N2 Information + +##### 6.1.6.4.3.1 Introduction + +N2 Information shall encode NG Application Protocol (NGAP) IEs, as specified in clause 9.4 of 3GPP TS 38.413 [12] (ASN.1 encoded), using the vnd.3gpp.ngap content-type. + +##### 6.1.6.4.3.2 NGAP IEs + +For N2 information class SM, N2 Information may encode following NGAP SMF related IE specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3.2-1. + +**Table 6.1.6.4.3.2-1: N2 Information content for class SM** + +| NGAP IE | Reference
(3GPP TS 38.413 [12]) | Related NGAP message | +|-----------------------------------------------|------------------------------------|--------------------------------------| +| PDU Session Resource Setup Request Transfer | 9.3.4.1 | PDU SESSION RESOURCE SETUP REQUEST | +| PDU Session Resource Release Command Transfer | 9.3.4.12 | PDU SESSION RESOURCE RELEASE COMMAND | +| PDU Session Resource Modify Request Transfer | 9.3.4.3 | PDU SESSION RESOURCE MODIFY REQUEST | +| Handover Command Transfer | 9.3.4.10 | HANDOVER COMMAND | +| Handover Required Transfer | 9.3.4.14 | HANDOVER REQUIRED | +| Handover Preparation Unsuccessful Transfer | 9.3.4.18 | HANDOVER COMMAND | +| Secondary RAT Data Usage Report Transfer | 9.3.4.23 | SECONDARY RAT DATA USAGE REPORT | + +For N2 information class RAN, N2 Information may encode one of the following NGAP Transparent Container IEs specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3.2-2. + +**Table 6.1.6.4.3.2-2: N2 Information content for class RAN** + +| NGAP IE | Reference
(3GPP TS 38.413 [12]) | Related NGAP message | +|------------------------------------------------|------------------------------------|---------------------------------------------------------------------------| +| Source to Target Transparent Container | 9.3.1.20 | HANDOVER REQUIRED, HANDOVER REQUEST | +| Target to Source Transparent Container | 9.3.1.21 | HANDOVER COMMAND, HANDOVER REQUEST
ACKNOWLEDGE | +| Target to Source Failure Transparent Container | 9.3.1.186 | HANDOVER FAILURE | +| UE Radio Capability | 9.3.1.74 | UE RADIO CAPABILITY INFO INDICATION. (NOTE 1). | +| UE Radio Capability for Paging | 9.3.1.68 | UE RADIO CAPABILITY INFO INDICATION. (NOTE 1). | +| SON Configuration Transfer | 9.3.3.6 | UPLINK RAN CONFIGURATION TRANSFER, DOWNLINK
RAN CONFIGURATION TRANSFER | +| RAN Status Transfer Transparent Container | 9.2.3.13, 9.2.3.14 | UPLINK RAN STATUS TRANSFER, DOWNLINK RAN
STATUS TRANSFER | +| Early Status Transfer Transparent Container | 9.2.3.16, 9.2.3.17 | UPLINK RAN EARLY STATUS TRANSFER
DOWNLINK RAN EARLY STATUS TRANSFER | +| RIM Information Transfer | 9.3.3.28 | UPLINK RIM INFORMATION TRANSFER, DOWNLINK
RIM INFORMATION TRANSFER | + +NOTE 1: The AMF receives the UE Radio Capability and UE Radio Capability for Paging within a UE CAPABILITY INFO INDICATION message and then the AMF shall store the UE Radio Capability information and UE Radio Capability for Paging, and transfer them to the target AMF during an inter AMF mobility procedure. + +For N2 information class NRPPa, N2 Information may encode the following NGAP NRPPa Transport related IE specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3.2-3 + +**Table 6.1.6.4.3.2-3: N2 Information content for class NRPPa** + +| NGAP IE | Reference
(3GPP TS 38.413 [12]) | Related NGAP message | +|-----------|------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NRPPa-PDU | 9.3.3.14 | DOWNLINK UE ASSOCIATED NRPPA TRANSPORT
UPLINK UE ASSOCIATED NRPPA TRANSPORT
DOWNLINK NON UE ASSOCIATED NRPPA TRANSPORT
UPLINK NON UE ASSOCIATED NRPPA TRANSPORT | + +For N2 information class V2X, N2 Information may encode the following V2X related IE specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3.2-4 + +**Table 6.1.6.4.3.2-4: N2 Information content for class V2X** + +| NGAP IE | Reference
(3GPP TS 38.413 [12]) | Related NGAP message | +|--------------------|------------------------------------|-------------------------------------------------------------------------------------------------------------------------| +| PC5 QoS Parameters | 9.3.1.150 | INITIAL CONTEXT SETUP REQUEST
UE CONTEXT MODIFICATION REQUEST
HANDOVER REQUEST
PATH SWITCH REQUEST ACKNOWLEDGE | + +For N2 information class PROSE, N2 Information may encode the following ProSe related IE specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3.2-5 + +**Table 6.1.6.4.3.2-5: N2 Information content for class PROSE** + +| NGAP IE | Reference
(3GPP TS 38.413 [12]) | Related NGAP message | +|--------------------------------------------|------------------------------------|-------------------------------------------------------------------------------------------------------------------------| +| 5G ProSe PC5 QoS Parameters | 9.3.1.234 | INITIAL CONTEXT SETUP REQUEST
UE CONTEXT MODIFICATION REQUEST
HANDOVER REQUEST
PATH SWITCH REQUEST ACKNOWLEDGE | +| 5G ProSe Authorized | 9.3.1.233 | INITIAL CONTEXT SETUP REQUEST
UE CONTEXT MODIFICATION REQUEST
HANDOVER REQUEST
PATH SWITCH REQUEST ACKNOWLEDGE | +| 5G ProSe UE PC5 Aggregate Maximum Bit Rate | 9.3.1.148 | INITIAL CONTEXT SETUP REQUEST
UE CONTEXT MODIFICATION REQUEST
HANDOVER REQUEST
PATH SWITCH REQUEST ACKNOWLEDGE | + +**Table 6.1.6.4.3.2-6: Void** + +For N2 information class RANGING\_SL, N2 Information may encode one of the following related IEs specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3.2-7. + +**Table 6.1.6.4.3.2-7: N2 Information content for class RANGING\_SL** + +| NGAP IE | Reference
(3GPP TS 38.413 [12]) | Related NGAP message | +|------------------------------------------------------|------------------------------------|-------------------------------------------------------------------------------------------------------------------------| +| Ranging and Sidelink Positioning Service Information | 9.3.1.x | INITIAL CONTEXT SETUP REQUEST
UE CONTEXT MODIFICATION REQUEST
HANDOVER REQUEST
PATH SWITCH REQUEST ACKNOWLEDGE | + +For N2 information class A2X, N2 Information may encode the following A2X related IE specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3.2-8 + +**Table 6.1.6.4.3.2-8: N2 Information content for class A2X** + +| NGAP IE | Reference
(3GPP TS 38.413 [12]) | Related NGAP message | +|--------------------|------------------------------------|-------------------------------------------------------------------------------------------------------------------------| +| PC5 QoS Parameters | 9.3.1.150 | INITIAL CONTEXT SETUP REQUEST
UE CONTEXT MODIFICATION REQUEST
HANDOVER REQUEST
PATH SWITCH REQUEST ACKNOWLEDGE | + +#### 6.1.6.4.3.3 NGAP Messages + +For N2 information class PWS, N2 Information shall encode NGAP Messages specified in 3GPP TS 38.413 [12]. + +**Table 6.1.6.4.3.3-1: N2 PWS Request Information content** + +| NGAP message | Reference
(3GPP TS 38.413 [12]) | +|-------------------------------|------------------------------------| +| WRITE-REPLACE WARNING REQUEST | 9.2.8.1 | +| PWS CANCEL REQUEST | 9.2.8.3 | + +**Table 6.1.6.4.3.3-2: N2 PWS Response Information content** + +| NGAP message | Reference
(3GPP TS 38.413 [12]) | +|--------------------------------|--------------------------------------------| +| WRITE-REPLACE WARNING RESPONSE | 9.2.8.2 | +| PWS CANCEL RESPONSE | 9.2.8.4 | + +N2 Information received by the AMF for PWS may be processed by the AMF before re-encoding and transferring to the Service Consumer. + +If a subscription exists for N2InformationClass "PWS-BCAL" and the received N2 Message Type is a WRITE-REPLACE-WARNING-RESPONSE, then the AMF may aggregate the Broadcast Completed Area Lists it has received from the NG-RAN nodes for a message identified by its Serial Number and Message Identifier (see table 6.1.6.4.3.3-1) and transfer the ASN.1 (re-)encoded Message Type, Message Identifier, Serial Number and the (aggregated) Broadcast Completed Area List IE in the N2 Info Container in the N2InfoNotify, and the "bcEmptyAreaList" attribute if the Broadcast Completed Area List IE is not present in the PWS N2 information. + +If a subscription exists for N2InformationClass "PWS-BCAL" and the received N2 Message Type is a PWS-CANCEL-RESPONSE, then the AMF may aggregate the Broadcast Cancelled Area Lists IE it has received from the NG-RAN nodes for a message identified by its Serial Number and Message Identifier (see table 6.1.6.4.3.3-1) and transfer the ASN.1 (re-)encoded the Message Type, Message Identifier, Serial Number, the (aggregated) Broadcast Cancelled Area List IE in the N2 Info Container in the N2InfoNotify, and the "bcEmptyAreaList" attribute if the PWS-CANCEL-RESPONSE does not contain a Broadcast Cancelled Area List, in the PWS N2 information. + +For the ASN.1 definition for encoding the WRITE-REPLACE-WARNING-RESPONSE and the PWS-CANCEL-RESPONSE, see clause 9.4 of 3GPP TS 38.413 [12]. + +If a subscription exists for N2InformationClass "PWS-RF" and the received N2 Message Type is a PWS-RESTART-INDICATION, then the AMF may transfer the ASN.1 encoded string from the PWS-RESTART-INDICATION (see table 6.1.6.4.3.3-3) in the N2 Info Container in the N2InfoNotify. + +If a subscription exists for N2InformationClass "PWS-RF" and the received N2 Message Type is a PWS-FAILURE-INDICATION (see table 6.1.6.4.3.3-3), then the AMF may transfer the ASN.1 encoded string from the PWS-FAILURE-INDICATION in the N2 Info Container in the N2InfoNotify. + +**Table 6.1.6.4.3.3-3: N2 PWS Indication Information content** + +| NGAP message | Reference
(3GPP TS 38.413 [12]) | +|------------------------|--------------------------------------------| +| PWS RESTART INDICATION | 9.2.8.5 | +| PWS FAILURE INDICATION | 9.2.8.6 | + +The Message Type shall be present and encoded as the first N2 PWS Indication IE in any NonUeN2InfoNotify for PWS messages to enable the receiver to decode the N2 PWS IEs. + +For N2 information class RAN, N2 Information shall encode one of the following NGAP messages specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3.3-4. + +**Table 6.1.6.4.3.3-4: N2 Information content for class RAN** + +| NGAP message | Reference
(3GPP TS 38.413 [12]) | +|-------------------------------------|--------------------------------------------| +| Any UE specific Uplink NGAP message | | + +For N2 information class TSS, N2 Information shall encode the following NGAP message specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3.3-5. + +**Table 6.1.6.4.3.3-5: N2 Information content for class TSS** + +| NGAP message | Reference
(3GPP TS 38.413 [12]) | +|--------------------------------------|------------------------------------| +| TIMING SYNCHRONISATION STATUS REPORT | 9.2.yy.4 | + +Editor's note: Further details on the new NGAP message to be aligned with RAN WG3. + +#### 6.1.6.4.4 Mobile Terminated Data + +Mobile Terminated Data shall encode the user data to be sent by the AMF to the UE in the Payload Container specified in 3GPP TS 24.501 [7], using the vnd.3gpp.5gnas content-type, as summarized in Table 6.1.6.4.4-1. + +**Table 6.1.6.4.4-1: Mobile Terminated Data** + +| Mobile Terminated Data | Reference
(3GPP TS 24.501 [7]) | Related NAS SM message | +|---------------------------------------------|-----------------------------------|------------------------| +| Payload container contents in octets 4 to n | 9.11.3.39
(Figure 9.11.3.39.1) | DL NAS Transport | + +#### 6.1.6.4.5 GTP-C Message + +GTP-C Message shall encode a GTP-C message of a specified type (e.g. Forward Relocation Request) as specified in 3GPP TS 29.274 [41], using the vnd.3gpp.gtpc content-type. The GTP-C message carried in the HTTP multipart message shall include the UDP/IP headers. + +GTP-C Message may encode e.g. the following GTP-C messages: + +- Mobility Management message: + - Forward Relocation Request (see clause 7.3.1 of 3GPP TS 29.274 [41]) during EPS to 5GS handover with AMF re-allocation procedure (see clause 4.11.1.2.2 of 3GPP TS 23.502 [3]); + - Relocation Cancel Request (see clause 7.3.16 of 3GPP TS 29.274 [41]) during EPS to 5GS handover with AMF re-allocation procedure (see clause 4.11.1.2.3 of 3GPP TS 23.502 [3]), if handover cancel is triggered. + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.1.7.2 Protocol Errors + +Protocol Error Handling shall be supported as specified in clause 5.2.7.2 of 3GPP TS 29.500 [4]. + +### 6.1.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Namf\_Communication service. The following application errors listed in Table 6.1.7.3-1 are specific for the Namf\_Communication service. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NF_CONSUMER_REDIRECT_ONE_TXN | 307
Temporary Redirect | The request has been asked to be redirected to a specified target. | +| HANDOVER_FAILURE | 403
Forbidden | Creation of UE context or relocation in the target AMF failed during Handover procedure causing a failure of handover. | +| INTEGRITY_CHECK_FAIL | 403
Forbidden | Integrity check of the complete registration message included in the UE context transfer request failed. | +| EBI_EXHAUSTED | 403
Forbidden | Allocation of EPS Bearer ID failed due to exhaustion of EBI as the maximum number of EBIs has already been allocated to the UE. | +| EBI_REJECTED_LOCAL_POLICY | 403
Forbidden | Allocation of EPS Bearer ID failed due to local policy at the AMF as specified in clause 4.11.1.4.1 of 3GPP TS 23.502 [3]. | +| EBI_REJECTED_NO_N26 | 403
Forbidden | The allocation of EPS Bearer ID was rejected when the AMF is in a serving PLMN that does not support 5GS-EPS interworking procedures with N26 interface. | +| SUPI_OR_PEI_UNKNOWN | 403
Forbidden | The SUPI or PEI included in the message is unknown. | +| UE_IN_NON_ALLOWED_AREA | 403
Forbidden | UE is currently in a non-allowed area hence the N1/N2 message transfer cannot be completed because the request is not associated with a regulatory prioritized service. | +| UNSPECIFIED | 403
Forbidden | The request is rejected due to unspecified reasons. | +| SM_CONTEXT_RELOCATION_REQUIRED | 403
Forbidden | The request is rejected because the SM Context should be relocated to another SMF, e.g. when AMF detects that an I-SMF or V-SMF insertion, change or removal is needed, as specified in clause 4.23 of 3GPP TS 23.502 [3]. | +| UE_WITHOUT_N1_LPP_SUPPORT | 403
Forbidden | UE does not support LPP in N1 mode hence the N1 LPP message cannot be sent to the UE. | +| INVALID_SM_CONTEXT | 403
Forbidden | The request is rejected because the SM Context is invalid for the PDU session, i.e. active SM Context for the PDU session (with same PDU Session ID) has been created on another SMF. (NOTE) | +| INVALID_PRU | 403
Forbidden | The request is rejected because the request is to initiate a positioning procedure towards a PRU and the target UE is not a valid PRU. | +| CONTEXT_NOT_FOUND | 404
Not Found | The requested UE Context does not exist on the AMF | +| HIGHER_PRIORITY_REQUEST_ONGOING | 409
Conflict | Paging triggered N1/N2 transfer cannot be initiated since already there is a paging due to a higher priority session ongoing. | +| TEMPORARY_REJECT_REGISTRATION_ONGOING | 409
Conflict | N1/N2 message transfer towards UE / AN cannot be initiated or the EBI assignment fails due to an ongoing registration procedure. | +| TEMPORARY_REJECT_HANDOVER_ONGOING | 409
Conflict | N1/N2 message transfer towards UE / AN cannot be initiated due to an ongoing Xn or N2 handover procedure, or the EBI assignment fails due to an ongoing N2 handover procedure or an ongoing Xn handover procedure. | +| UE_IN_CM_IDLE_STATE | 409
Conflict | N2 message transfer towards 5G-AN cannot be initiated due to the UE being in CM-IDLE state for the Access Network Type associated to the PDU session. | +| MAX_ACTIVE_SESSIONS_EXCEEDED | 409
Conflict | If the RAT type is NB-IoT, and the UE already has 2 PDU Sessions with active user plane resources. | +| REJECTION_DUE_TO_PAGING_RESTRICTION | 409
Conflict | If Paging Restrictions information restricts the N1N2MessageTransfer request from causing | + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|-----------------------------------------------------------| +| | | paging as defined in 3GPP TS 23.501 [2]
clause 5.38.5. | +| UE_NOT_REACHABLE | 504
Gateway
Timeout | The UE is not reachable for paging. | +| UE_NOT_RESPONDING | 504
Gateway
Timeout | The UE is not responding for paging. | +| NOTE: More than one SM Contexts may be present in the network for the same PDU Session ID, e.g. when the UE established a new PDU session with the same PDU Session ID and the AMF failed to release the old SM Context in the old SMF. In such a scenario, if the old SMF tries to send N1 and/or N2 Message to the RAN/UE, the AMF shall respond with this application error if the AMF identified that service operation is invoked by the SMF holding the old SM Context. | | | + +## 6.1.8 Feature Negotiation + +The feature negotiation mechanism specified in clause 6.6 of 3GPP TS 29.500 [4] shall be used to negotiate the optional features applicable between the AMF and the NF Service Consumer, for the Namf\_Communication service, if any. + +The NF Service Consumer shall indicate the optional features it supports for the Namf\_Communication service, if any, by including the supportedFeatures attribute in content of the HTTP Request Message for following service operations: + +- N1N2MessageTransfer, as specified in clause 5.2.2.3.1; +- N1N2MessageSubscribe, as specified in clause 5.2.2.3.3; +- NonUeN2InfoSubscribe, as specified in clause 5.2.2.4.2; +- UeContextTransfer, as specified in clause 5.2.2.2.1; +- CreateUEContext, as specified in clause 5.2.2.2.3 + +The AMF shall determine the supported features for the service operations as specified in clause 6.6 of 3GPP TS 29.500 [4] and shall indicate the supported features by including the supportedFeatures attribute in content of the HTTP response for the service operation. + +The syntax of the supportedFeatures attribute is defined in clause 5.2.2 of 3GPP TS 29.571 [6]. + +The following features are defined for the Namf\_Communication service. + +**Table 6.1.8-1: Features of supportedFeatures attribute used by Namf\_Communication service** + +| Feature Number | Feature | M/O | Description | +|----------------|---------|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | DTSSA | O | Deployments Topologies with specific SMF Service Areas.

An AMF that supports this feature shall support the procedures specified in clause 5.34 of 3GPP TS 23.501 [2] and in clause 4.23 of 3GPP TS 23.502 [3]. | +| 2 | ENS | O | This feature bit indicates whether the AMF supports procedures related to Network Slicing (see 3GPP TS 23.501 [2] clause 5.15.7). This includes supporting the RelocateUEContext service operation (see clause 5.2.2.2.5). | +| 3 | CIOT | O | Cellular IoT

Support of this feature implies the support of all the CIoT features specified in clause 5.31 of 3GPP TS 23.501 [2], including in particular corresponding service's extensions to support:
  • - NB-IoT and LTE-M RAT types;
  • - Control Plane CIoT 5GS Optimisation;
  • - Rate control of user data.
| +| 4 | MAPDU | O | This feature bit indicates whether the AMF supports Multi-Access PDU session procedures related to Access Traffic Steering, Switching and Splitting (see clauses 4.2.10 and 5.32 of 3GPP TS 23.501 [2]). | +| 5 | NPN | O | Non-Public Network

Support of this feature implies support of NPN information and receipt of a Create UE context error response with a binary part during an Inter-AMF N2 Handover. | +| 6 | ELCS | O | This feature indicates supports of enhanced LCS, including the capability for the AMF to send an LCS message through the target access type requested by the LMF. | +| 7 | ES3XX | M | Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. SMF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the Namf_Communication service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | +| 8 | EAEA | O | EBI and ARP mapping update in EBIAssignment

Support of this feature implies support of updating the mapping of EBI and ARP in EBIAssignment for a QoS flow to which an EBI is already allocated. | +| 9 | ProSe | O | This feature indicates the support of UE policy and N2 information provisioning for 5G ProSe. | +| 10 | UAV | O | Uncrewed Aerial Vehicle
This feature indicates the support of UAV feature at AMF. When this feature is supported at the AMF, the AMF shall perform the UUAA-MM procedure defined in 3GPP TS 23.256 [56]. | +| 11 | SPAE | O | SM Policy Association Events

This feature bit indicates whether the AMF supports the SM Policy Association establishment and termination event notification information handling, i.e. whereby the PCF for UE subscribes to SM Policy Association events to the PCF for SM Policy via the AMF and SMF, as specified in clause 4.3.2.2.1 and clause 4.3.3.2 of 3GPP TS 23.502 [3]. | +| 12 | eNPN | O | Enhanced support of Non-Public Networks (eNPN)

This feature indicates the AMF supports UE registration for onboarding in an SNPn, see clause 5.30.2.10.2.6 and clause 5.30.2.10.2.7 in 3GPP TS 23.501 [2]. | + +| | | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 13 | 3GA-N3GA-HO | O |

Handover between 3GPP and non-3GPP accesses

An AMF and SMF that supports Handover between 3GPP and non-3GPP accesses shall support this feature, i.e. setting the targetAccess IE in N1N2MessageTransfer Request to the old access type when releasing the N2 PDU session resources in the old access (see clauses 5.2.2.3.1.1 and 6.1.6.2.18)

| +| 14 | PAR-NS | O |

Partially Allowed/Rejected Network Slice

This feature indicates the AMF supports the partially allowed network slice and the partially reject Network slice. See 3GPP TS 23.501 [2] clause 5.15.17.

| +| 15 | NTSSM | O |

Network Timing Synchronization Status Monitoring

This feature bit indicates that the AMF supports transferring TSS related information in the N2InformationTransferReqData and a subscription, e.g. created by a TSCTSF, to get notification for Non-UE related N2 Information for the Network Timing Synchronization Status information.

| +| 16 | RACS | O |

Support of RACS feature as specified in clause 5.4.4.1a in 3GPP TS 23.501 [2].

During an Inter AMF mobility procedure, the source AMF may decide to not include ueRadioCapability and ueRadioCapabilityForPaging in the UeContextTransferRspData or UeContextCreateData if the target AMF supports RACS feature, the target AMF can retrieve the same using UE Radio Capability ID Id(s) included in the MM Context.

| +| 17 | Ranging_SL | O |

This feature indicates the support of UE policy and N2 information provisioning for Ranging/SL positioning as specified in 3GPP TS 23.586 [59].

| +| 18 | A2X | O |

This feature indicates the support of UE policy and N2 information provisioning for A2X communication as specified in 3GPP TS 23.256 [56]

| +| 19 | AoV-En | O |

This feature indicates the support of enhanced AreaOfValidity handling.

When invoking N1N2MessageTransfer to deliver N2 information, the SMF may use the TAI range list to efficiently indicate the area scope to deliver the N2 information, if the AMF supports this feature.

| +|

Feature number: The order number of the feature within the supportedFeatures attribute (starting with 1).
Feature: A short name that can be used to refer to the bit and to the feature.
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature.

| | | | + +## 6.1.9 Security + +As indicated in 3GPP TS 33.501 [27], the access to the Namf\_Communication API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [28]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [29]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Namf\_Communication API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [29], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Namf\_Communication service. + +The Namf\_Communication API defines the following scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [27]. + +**Table 6.1.9-1: OAuth2 scopes defined in Namf\_Communications API** + +| Scope | Description | +|------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "namf-comm" | Access to the Namf_Communications API. | +| "namf-comm:ue-contexts:mobility" | Access to service operations applying to UE context resources for inter-AMF mobility, i.e., UEContextTransfer, RegistrationStatusUpdate, CreateUEContext, ReleaseUEContext, RelocateUEContext and CancelRelocateUEContext. | +| "namf-comm:ue-contexts:assign-ebi" | Access to service operations applying to UE context resources for EBI assignment, i.e., EBIAssignment. | +| "namf-comm:n1-n2-messages" | Access to service operations applying to the n1-n2-messages resource, i.e., N1N2MessageSubscribe, N1N2MessageUnSubscribe, N1N2MessageTransfer, N1MessageNotify, and N2InfoNotify. | +| "namf-comm:non-ue-n2-messages" | Access to service operations applying to the non-ue-n2-messages resource, i.e., NonUeN2MessageTransfer, NonUeN2InfoSubscribe, NonUeN2InfoUnSubscribe, and NonUeN2InfoNotify. | + +## 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different AMF service instance, within the same AMF or a different AMF of an AMF set, e.g. when an AMF service instance is part of an AMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See the ES3XX feature in clause 6.1.8. + +An SCP that reselects a different AMF producer instance will return the NF Instance ID of the new AMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an AMF within an AMF set redirects a service request to a different AMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new AMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.2 Namf\_EventExposure Service API + +### 6.2.1 API URI + +The Namf\_EventExposure shall use the Namf\_EventExposure API. + +The API URI of the Namf\_EventExposure API shall be: + +**{apiRoot}//** + +The request URI used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "namf-evts". + +- The shall be "v1". +- The shall be set as described in clause 6.2.3. + +## 6.2.2 Usage of HTTP + +### 6.2.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [19], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Namf\_EventExposure service shall comply with the OpenAPI [23] specification contained in Annex A. + +### 6.2.2.2 HTTP standard headers + +#### 6.2.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +#### 6.2.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [8], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 9457 [36]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". +- JSON Patch (IETF RFC 6902 [14]). The use of the JSON Patch format in a HTTP request body shall be signalled by the content type "application/json-patch+json". + +### 6.2.2.3 HTTP custom headers + +#### 6.2.2.3.1 General + +In this release of this specification, no custom headers specific to the Namf\_EventExposure service are defined. For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.2.3 Resources + +### 6.2.3.1 Overview + +![Figure 6.2.3.1-1: Resource URI structure of the Namf_EventExposure API. The diagram shows a hierarchical tree structure of URI components. The root component is {apiRoot}/namf-evts/. It branches to /subscriptions, which in turn branches to /{subscriptionId}.](b303fb8b2c64e30aac9c32b5753d3670_img.jpg) + +``` + +graph TD + Root["{apiRoot}/namf-evts/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Figure 6.2.3.1-1: Resource URI structure of the Namf\_EventExposure API. The diagram shows a hierarchical tree structure of URI components. The root component is {apiRoot}/namf-evts/. It branches to /subscriptions, which in turn branches to /{subscriptionId}. + +**Figure 6.2.3.1-1: Resource URI structure of the Namf\_EventExposure API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------------|-------------------|---------------------------------|--------------------------------------------------------------------------| +| Subscriptions collection | /subscriptions | POST | Mapped to the service operation Subscribe, when to create a subscription | +| Individual subscription | /{subscriptionId} | PATCH | Mapped to the service operation Subscribe, when to modify | +| | | DELETE | Mapped to the service operation Unsubscribe | + +### 6.2.3.2 Resource: Subscriptions collection + +#### 6.2.3.2.1 Description + +This resource represents a collection of subscriptions created by NF service consumers of Namf\_EventExposure service. + +This resource is modelled as the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +#### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/namf-evts//subscriptions + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|-------------------| +| apiRoot | string | See clause 6.2.1 | +| apiVersion | string | See clause 6.2.1. | + +### 6.2.3.2.3 Resource Standard Methods + +#### 6.2.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.2.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3. + +**Table 6.2.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|------------------------------------------------------| +| AmfCreateEventSubscription | M | 1 | Describes of an AMF Event Subscription to be created | + +**Table 6.2.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AmfCreatedEventSubscription | M | 1 | 201
Created | Represents successful creation of an AMF Event Subscription | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403
Forbidden | Indicates the creation of subscription has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
  • - UE_NOT_SERVED_BY_AMF (for a subscription targeting a specific UE)
  • - MUTING_EXC_INSTR_NOT_ACCEPTED
| + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/namf-evts//subscriptions/{subscriptionId} | + +**Table 6.2.3.2.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.2.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.2.3.2.4 Resource Custom Operations + +None. + +## 6.2.3.3 Resource: Individual subscription + +### 6.2.3.3.1 Description + +This resource represents an individual of subscription created by NF service consumers of Namf\_EventExposure service. + +This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/namf-evts//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.2.3.3.2-1. + +**Table 6.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|--------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| apiVersion | string | See clause 6.2.1. | +| subscriptionId | string | String identifies an individual subscription to the AMF event exposure service | + +### 6.2.3.3.3 Resource Standard Methods + +#### 6.2.3.3.3.1 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.3.3.1-1. + +**Table 6.2.3.3.3.1-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3. + +**Table 6.2.3.3.3.1-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------| +| array(AmfUpdateEventSubscriptionItem) | M | 1..N | Document describes the modification(s) to a AMF Event Subscription | +| array(AmfUpdateEventOptionItem) | M | 1..1 | Document describing the modification to the event subscription options (e.g subscription expiry time). | + +**Table 6.2.3.3.3.1-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AmfUpdatedEventSubscription | M | 1 | 200 OK | Represents a successful update on AMF Event Subscription | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | Indicates the modification of subscription has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- MUTING_EXC_INSTR_NOT_ACCEPTED | +| ProblemDetails | O | 0..1 | 404 Not Found | Indicates the modification of subscription has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- SUBSCRIPTION_NOT_FOUND | + +NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.2.3.3.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.3.3.2-1. + +**Table 6.2.3.3.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.2-2 and the response data structures and response codes specified in table 6.2.3.3.3.2-3. + +**Table 6.2.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.3.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | Indicates the modification of subscription has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- SUBSCRIPTION_NOT_FOUND. | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.2.3.3.4 Resource Custom Operations + +None. + +### 6.2.4 Custom Operations without associated resources + +There are no custom operations without associated resources supported on Namf\_EventExposure Service. + +### 6.2.5 Notifications + +#### 6.2.5.1 Void + +This clause specifies the notifications provided by the Namf\_EventExposure service. + +**Table 6.2.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|------------------------|-----------------------|---------------------------------|---------------------------------| +| AMF Event Notification | {eventNotifyUri} | POST | | +| AMF Event Notification | {subsChangeNotifyUri} | POST | | + +#### 6.2.5.2 AMF Event Notification + +If a NF service consumer has subscribed to an event(s) supported by Namf\_EventExposure service, when AMF aware of a state change of the event, AMF shall create a notification including the event state report, and shall deliver the notification to the call-back URI, following Subscribe/Notify mechanism defined in 3GPP TS 29.501 [5]. + +##### 6.2.5.2.1 Notification Definition + +Call-back URI: {callbackUri} + +Call-back URI is provided by NF Service Consumer during creation of the subscription. If the notification is to inform the change of subscription ID and if the "subsChangeNotifyUri" was provided in the AmfEventSubscription, then this callback URI shall be the "subsChangeNotifyUri" provided in the AmfEventSubscription. Otherwise, this callback URI shall be the "eventNotifyUri" provided in the AmfEventSubscription. + +##### 6.2.5.2.3 Notification Standard Methods + +###### 6.2.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.2.5.2.3.1-1 and the response data structures and response codes specified in table 6.2.5.2.3.1-2. + +**Table 6.2.5.2.3.1-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|---------------------------------------------| +| AmfEventNotification | M | 1 | Represents the notification to be delivered | + +**Table 6.2.5.2.3.1-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.5.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | + +**Table 6.2.5.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.2.6 Data Model + +### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Namf\_EventExposure service based interface protocol. + +**Table 6.2.6.1-1: Namf\_EventExposure specific Data Types** + +| Data type | Clause defined | Description | +|---------------------------------|-----------------------|--------------------------------------------------------------------------| +| AmfEventSubscription | 6.2.6.2.2 | Represents an individual event subscription resource on AMF | +| AmfEvent | 6.2.6.2.3 | Describes an event to be subscribed | +| AmfEventNotification | 6.2.6.2.4 | Data within an AMF Event Notification request. | +| AmfEventReport | 6.2.6.2.5 | Represents a report triggered by a subscribed event type | +| AmfEventMode | 6.2.6.2.6 | Describes how the reports shall be generated by a subscribed event | +| AmfEventState | 6.2.6.2.7 | Represents the state of a subscribed event | +| RmInfo | 6.2.6.2.8 | Represents the registration state of a UE for an access type | +| CmInfo | 6.2.6.2.9 | Represents the connection management state of a UE for an access type | +| CommunicationFailure | 6.2.6.2.11 | Describes a communication failure detected by AMF | +| AmfCreateEventSubscription | 6.2.6.2.12 | Data within a create AMF event subscription request | +| AmfCreatedEventSubscription | 6.2.6.2.13 | Data within a create AMF event subscription response | +| AmfUpdateEventSubscriptionItem | 6.2.6.2.14 | Document describing the modification(s) to an AMF Event Subscription | +| AmfUpdatedEventSubscription | 6.2.6.2.15 | Represents a successful update on an AMF Event Subscription | +| AmfEventArea | 6.2.6.2.16 | Represents an area to be monitored by an AMF event. | +| LadnInfo | 6.2.6.2.17 | LADN Information | +| AmfUpdateEventOptionItem | 6.2.6.2.18 | Document describing the modifications to AMF event subscription options. | +| 5GsUserInfo | 6.2.6.2.19 | Represents the 5GS User state of the UE for an access type | +| TrafficDescriptor | 6.2.6.2.20 | Represents the Traffic Descriptor | +| UEIdExt | 6.2.6.2.21 | UE Identity | +| AmfEventSubsSyncInfo | 6.2.6.2.22 | AMF Event Subscriptions Information for synchronization | +| AmfEventSubscriptionInfo | 6.2.6.2.23 | Individual AMF Event Subscription Information | +| TargetArea | 6.2.6.2.24 | TA list or TAI range list or any TA | +| SnsaiTaiMapping | 6.2.6.2.25 | List of restricted or unrestricted S-NSSAIs per TAI(s) | +| SupportedSnsai | 6.2.6.2.26 | Supported S-NSSAIs | +| UeInAreaFilter | 6.2.6.2.27 | Describe the filter related to UEs In Area Report event. | +| IdleStatusIndication | 6.2.6.2.28 | Represents the idle status indication. | +| UeAccessBehaviorReportItem | 6.2.6.2.29 | Report Item for UE Access Behavior Trends event. | +| UeLocationTrendsReportItem | 6.2.6.2.30 | Report Item for UE Location Trends event. | +| DispersionArea | 6.2.6.2.31 | Dispersion Area | +| MmTransactionLocationReportItem | 6.2.6.2.32 | UE MM Transaction Report Item per Location | +| MmTransactionSliceReportItem | 6.2.6.2.33 | UE MM Transaction Report Item per Slice | +| AmfEventType | 6.2.6.3.3 | Describes the supported event types of Namf_EventExposure Service | +| AmfEventTrigger | 6.2.6.3.4 | Describes how AMF should generate the report for the event | +| LocationFilter | 6.2.6.3.5 | Describes the supported filters of LOCATION_REPORT event type | +| UeReachability | 6.2.6.3.7 | Describes the reachability of the UE | +| RmState | 6.2.6.3.9 | Describes the registration management state of a UE | +| CmState | 6.2.6.3.10 | Describes the connection management state of a UE | +| 5GsUserState | 6.2.6.3.11 | Describes the 5GS User State of a UE | +| LossOfConnectivityReason | 6.2.6.3.12 | Describes the reason for loss of connectivity | +| ReachabilityFilter | 6.2.6.3.13 | Event filter for REACHABILITY_REPORT event type. | +| UeType | 6.2.6.3.14 | Describe UE type | +| AccessStateTransitionType | 6.2.6.3.15 | Access State Transition Type | +| SubTerminationReason | 6.2.6.3.16 | Subscription Termination Reason | + +Table 6.2.6.1-2 specifies data types re-used by the Namf\_EventExposure service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Namf\_EventExposure service based interface. + +**Table 6.2.6.1-2: Namf\_EventExposure re-used Data Types** + +| Data type | Reference | Comments | +|-----------------------------|---------------------|------------------------------------------------------------------------| +| Supi | 3GPP TS 29.571 [6] | | +| GroupId | 3GPP TS 29.571 [6] | | +| DurationSec | 3GPP TS 29.571 [6] | | +| Gpsi | 3GPP TS 29.571 [6] | | +| Uri | 3GPP TS 29.571 [6] | | +| Pei | 3GPP TS 29.571 [6] | | +| UserLocation | 3GPP TS 29.571 [6] | | +| Tal | 3GPP TS 29.571 [6] | | +| TimeZone | 3GPP TS 29.571 [6] | | +| AccessType | 3GPP TS 29.571 [6] | | +| Ecgi | 3GPP TS 29.571 [6] | EUTRA Cell Identifier | +| Ncgi | 3GPP TS 29.571 [6] | NR Cell Identifier | +| NfInstanceId | 3GPP TS 29.571 [6] | | +| ProblemDetails | 3GPP TS 29.571 [6] | Problem Details | +| SupportedFeatures | 3GPP TS 29.571 [6] | Supported Features | +| DateTime | 3GPP TS 29.571 [6] | | +| NgApCause | 3GPP TS 29.571 [6] | | +| PresenceInfo | 3GPP TS 29.571 [6] | Presence Reporting Area Information | +| PresenceState | 3GPP TS 29.571 [6] | Describes the presence state of the UE to a specified area of interest | +| Dnn | 3GPP TS 29.571 [6] | | +| Snssai | 3GPP TS 29.571 [6] | | +| DddTrafficDescriptor | 3GPP TS 29.571 [6] | Downlink Data Delivery Traffic Descriptor | +| SamplingRatio | 3GPP TS 29.571 [6] | Sampling Ratio. | +| RedirectResponse | 3GPP TS 29.571 [6] | Response body of the redirect response message. | +| NotificationFlag | 3GPP TS 29.571 [6] | Notification flag | +| ExtSnssai | 3GPP TS 29.571 [6] | | +| N3gaLocation | 3GPP TS 29.571 [6] | Non-3GPP Location | +| SnssaiDnnItem | 3GPP TS 29.571 [6] | Combination of S-NSSAIs and DNNs | +| ReferenceId | 3GPP TS 29.503 [35] | | +| NsId | 3GPP TS 29.531 [18] | NSI ID | +| NFType | 3GPP TS 29.510 [29] | NF type | +| TaiRange | 3GPP TS 29.510 [29] | | +| MutingExceptionInstructions | 3GPP TS 29.571 [6] | Muting exception instructions. | +| MutingNotificationsSettings | 3GPP TS 29.571 [6] | Muting notifications settings. | + +## 6.2.6.2 Structured data types + +### 6.2.6.2.1 Introduction + +Structured data types used in Namf\_EventExposure service are specified in this clause. + +## 6.2.6.2.2 Type: AmfEventSubscription + +**Table 6.2.6.2.2-1: Definition of type AmfEventSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------|-----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eventList | array(AmfEvent) | M | 1..N | Describes the events to be subscribed in subscription request or the events successfully subscribed for this subscription in subscription response. | | +| eventNotifyUri | Uri | M | 1 | Identifies the recipient of notifications sent by AMF for this subscription (NOTE 1) | | +| notifyCorrelationId | string | M | 1 | Identifies the notification correlation ID. The AMF shall include this ID in the notifications. The value of this IE shall be unique per subscription for a given NF service consumer. | | +| nflD | NfInstanceId | M | 1 | Indicates the instance identity of the network function creating the subscription. | | +| subsChangeNotifyUri | Uri | C | 0..1 | This IE shall be present if the subscription is created by an NF service consumer on behalf of another NF (e.g UDM creating event subscription at AMF for event notifications towards NEF). When present, this IE identifies the recipient of notifications sent by AMF, for the creation of a new subscription ID, that is considered as a change of subscription ID by the NF service consumer for event subscriptions related to single UE or as the creation of a new subscription Id for event subscriptions related to UE groups (e.g during mobility procedures involving AMF change). (NOTE 3). | | +| subsChangeNotifyCorrelationId | string | C | 0..1 | This IE shall be present when an NF Service Consumer (e.g. UDM) is subscribing for events on behalf of another NF Service Consumer (e.g. NEF). When present, this IE shall contain the notification correlation ID. The AMF shall include it in the notifications for the creation of a new subscription ID that is considered as a change of subscription ID by the NF service consumer for event subscriptions related to single UE or as the creation of a new subscription Id for event subscriptions related to UE groups. The value of this IE shall be unique per subscription for a given NF service consumer that is sending this IE. (NOTE 3).. | | +| supi | Supi | C | 0..1 | Subscription Permanent Identifier (NOTE 2) | | +| groupId | GroupId | C | 0..1 | Identifies a group of UEs. (NOTE 2) | | +| excludeSupiList | array(Supi) | O | 1..N | This IE may be present for a group subscription.

When present, this IE shall carry the SUPI of the group member UE(s) that are excluded from the group subscription. | DGEM | +| excludeGpsiList | array(Gpsi) | O | 1..N | This IE may be present for a group subscription.

When present, this IE shall carry the GPSI of the group member UE(s) that are excluded from the group subscription. | DGEM | +| includeSupiList | array(Supi) | O | 1..N | This IE may be present for a group subscription.

When present, this IE shall carry the SUPI of the group member UE(s) that are included for the group subscription. | DGEM | +| includeGpsiList | array(Gpsi) | O | 1..N | This IE may be present for a group subscription.

When present, this IE shall carry the GPSI of | DGEM | + +| | | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| | | | | the group member UE(s) that are included for the group subscription. | | +| gpsi | Gpsi | C | 0..1 | Generic Public Subscription Identifier (NOTE 2) | | +| pei | Pei | C | 0..1 | Permanent Equipment Identifier (NOTE 2) | | +| anyUE | boolean | C | 0..1 | This IE shall be present if the event subscription is applicable to any UE. Default value "FALSE" is used, if not present. The attribute shall be set to "TRUE", when the AMF event type is "SNSSAI_TA_MAPPING_REPORT".

(NOTE 2) | | +| options | AmfEventMode | O | 0..1 | This IE may be included if the NF service consumer wants to describe how the reports of the event have to be generated. The absence of this IE, when creating an AMF event subscription or when transferring the UE context to another AMF, shall be interpreted as a "ONE_TIME" AMF event trigger. | | +| sourceNfType | NFType | C | 0..1 | This IE should be present for a subscription that is created by an "intermediate NF" (e.g. UDM) on behalf of a "source NF" (e.g. NEF). When present, it shall contain the NF type of the "source NF". | | +| termNotifyInd | boolean | O | 0..1 | When present this IE shall indicate whether the notification of event subscription termination from the AMF is requested by the NF consumer.

- true: Event subscription termination notification requested
- false (default) Event subscription termination notification not requested | STEN | +| NOTE 1: When an NF Service Consumer subscribes on behalf of another NF, the Notification URI identifies a resource under the authority of the other NF. | | | | | | +| NOTE 2: Either information about a single UE (i.e. SUPI, GPSI, PEI) or groupId, or anyUE set to "TRUE" shall be included. | | | | | | +| NOTE 3: Same values of "subsChangeNotifyUri" and "subsChangeNotifyCorrelationId" shall be provided by an NF service consumer to all the serving AMF if the subscriptions apply to a group and triggered by one subscription from another NF. This allows the NF service consumer to associate the subscription Id creation notifications received from different serving AMFs to the same group Id subscription, | | | | | | + +### 6.2.6.2.3 Type: AmfEvent + +**Table 6.2.6.2.3-1: Definition of type AmfEvent** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|--------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| type | AmfEventType | M | 1 | Describes the AMF event type to be reported | | +| immediateFlag | boolean | O | 0..1 |

Indicates if an immediate event report containing the currently available value / status of the event is requested. The report contains the value / status of the event currently available at the AMF at the time of the subscription (NOTE 1). If the flag is not present then immediate reporting shall not be done and the first report is sent at event detection time.

When the subscribing NF subscribes on behalf of another NF, the IERSR feature controls whether or not an immediate report is sent within the subscribe response message or within a notification request message (see clause 5.3.2.2.2). Otherwise immediate reports are always sent within the subscribe response message.

The default value is false.

| | +| areaList | array(AmfEventArea) | O | 1..N |

Identifies the area to be applied.

More than one instance of AmfEventArea IE shall be used only when the AmfEventArea is provided during event subscription for Presence Reporting Area subscription.

| | +| locationFilterList | array(LocationFilter) | O | 1..N |

Describes the filters to be applied for LOCATION_REPORT event type.

If this attribute is not present in the request, it indicates the change of the TA used by the UE should be reported.

| | +| refId | ReferenceId | O | 0..1 | Indicates the Reference Id associated with the event. (NOTE 3) | | +| trafficDescriptorList | array(TrafficDescriptor) | O | 1..N | Indicates the filters to be applied for AVAILABILITY_AFTER_DDN_FAILURE event type. | | +| reportUeReachable | boolean | C | 0..1 |

This IE shall be present and set to value "true" by the source AMF to request the target AMF to notify the subscriber when UE becomes reachable, during inter-AMF mobility procedures.

When present, this IE shall be set as following:

  • - true: target AMF shall notify the subscriber when UE becomes reachable
  • - false (default): target AMF shall not notify the subscriber when UE becomes reachable, until next reporting trigger is detected, i.e. DDN failure detected (for AVAILABILITY_AFTER_DDN_FAILURE event) or UE becomes unreachable for downlink traffic (for "UE Reachable for DL Traffic" of REACHABILITY_REPORT event)

This IE only applies to following Event

| | + +| | | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------|--| +| | | | | Types:
- AVAILABILITY_AFTER_DDN_FAILURE
- REACHABILITY_REPORT (for "UE
Reachable for DL Traffic") | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|--------------------|--------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| reachabilityFilter | ReachabilityFilter | O | 0..1 |

When present, this IE shall indicate the filter to be applied for the REACHABILITY_REPORT event type.

If the subscription of REACHABILITY_REPORT is for "UE Reachability Status Change", the AMF shall report current reachability state and subsequent updated reachability state of the UE, when AMF becomes aware of a UE reachability state change between REACHABLE, UNREACHABLE and REGULATORY_ONLY.

If the subscription of REACHABILITY_REPORT is for "UE Reachable for DL Traffic", the AMF shall report the "REACHABLE" state, when the UE transitions to CM-CONNECTED mode or when the UE will become reachable for paging, as specified in table 4.15.3.1-1, clauses 4.2.5 and 4.3.3 of 3GPP TS 23.502 [3].

If this IE is absent, the subscription of REACHABILITY_REPORT is for "UE Reachability Status Change".

| | +| udmDetectInd | boolean | O | 0..1 |

The IE may be present for subscription for "UE Reachable for DL Traffic".

When present, this IE shall indicate whether the UE Reachability Event will be detected at UDM (i.e. with Nudm_UECM_Registration) or not:

  • - true: UE Reachability will be detected at UDM
  • - false (default) UE Reachability will not be detected at UDM
| | +| maxReports | integer | O | 0..1 |

This IE may be present if the trigger is set to "CONTINUOUS" or "PERIODIC". When present, this IE describes the maximum number of reports that can be generated by the subscribed event.

If the AMF event subscription is for a group of UEs, this parameter shall be applied to each individual member UE of the group.

If the event subscription is transferred from source AMF to a target AMF, this IE shall contain:

  • - the remaining number of reports for the event subscription, in the case of individual UE event subscription; or
  • - the remaining number of reports for the event subscription for this specific UE, in the case of a group event subscription. If the group subscription has not expired and all reports have been sent already for this event, the remaining number of reports shall be set to "0".

(NOTE 2)

| | +| presenceInfoList | map(PresenceInfo) | O | 1..N | Map of PRA Information, the "prald" attribute within the PresenceInfo data type shall also be the key of the map. The | MPRA | + +| | | | | | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | "presenceState" attribute within the PresenceInfo data type shall not be supplied.
When present, the areaList shall be absent. | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|-----------------|------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| maxResponseTime | DurationSec | C | 0..1 | This IE shall be present, when the UDM subscribes to "REACHABILITY_REPORT" event for "UE Reachable for DL Traffic" on behalf of the AF and the AF sets the Maximum Response Time in the Monitoring Configuration.

When present, this IE shall indicate the Maximum Response Time configured by the AF. | | +| targetArea | TargetArea | C | 0..1 | The IE shall be present for subscription for SNSSAI_TA_MAPPING_REPORT event type.

When present, this IE shall indicate the TAI list to be applied. | | +| snssaiFilter | array(ExtSnssai) | O | 1..N | The IE may be present for subscription for SNSSAI_TA_MAPPING_REPORT event type.

This IE shall be present for subscription of UE_MM_TRANSACTION_REPORT event to receive the UE Mobility Management Transaction numbers based on slices.

When present, this IE shall indicate the S-NSSAI list to be applied.

(NOTE 4) | | +| ueInAreaFilter | UeInAreaFilter | O | 0..1 | Indicates the filter to be applied for UES_IN_AREA_REPORT event type related to UAVs.

When present, this IE shall indicate the list of items to be applied together as filter. | UARF | +| minInterval | DurationSec | O | 0..1 | This IE may be present when the NF consumer subscribes to "REACHABILITY_REPORT" event for "UE Reachable for DL Traffic".

When present, this IE indicates the minimal interval to report the event, i.e. when an event is reported, a subsequent event report shall not be sent during the interval. | | +| nextReport | DateTime | O | 0..1 | This IE may be present when the event subscription is transferred from source AMF to a target AMF and minInterval is configured for this event.

When present, this IE shall indicate the UTC time point before when a subsequent event report shall be throttled. | | +| idleStatusInd | boolean | O | 0..1 | Idle Status Indication request.
May be present if type is REACHABILITY_REPORT or AVAILABILITY_AFTER_DDN_FAILURE
true: Idle status indication is requested
false (default): Idle status indication is not requested | | +| dispersionArea | DispersionArea | C | 0..1 | This IE shall be present for subscription to the UE_MM_TRANSACTION_REPORT event to receive the UE Mobility Management Transaction numbers based on location, or for subscription to the UE_LOCATION_TRENDS event.

When present, this IE indicates the target area where the related events to be reported for dispersion analytics. | | + +| | | | | | | +|--|--|--|--|----------|--| +| | | | | (NOTE x) | | +|--|--|--|--|----------|--| + +| | | | | | | +|--------------------------------------|-----------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| nextPeriodicReportTime | DateTime | C | 0..1 |

This IE should be present when the event subscription is transferred from source AMF to a target AMF and there are periodic report(s) to be generated for the event.

When present, this IE shall indicate the timestamp (in UTC) when the next periodic report for the event to be generated and notified to the NF consumer.

| | +| adjustAolOnRa | boolean | O | 0..1 |

This IE may be present if the (event) type IE is set to "PRESENCE_IN_AOI_REPORT".

When present, it shall be set as follows:

  • - true: the AMF may adjust the received AoI based on the UE's registration area.
  • - false (default) the AoI shall remain unchanged, i.e. it shall not be adjusted based on the UE's registration area.

See clause 5.3.4.4 of 3GPP TS 23.501 [2] and clauses 4.15.9.3.2, 4.15.9.4, 5.2.2.3.1 and Annex D.1 of 3GPP TS 23.502 [3].

| | +| ranTimingSynchronizationStatusChange | boolean | O | 0..1 |

This IE may be present if the (event) type IE is set to "PRESENCE_IN_AOI_REPORT".

When present, it shall be set as follows:

  • - true: this is a subscription for RAN timing synchronization status change event.
  • - false (default): this is not a subscription for RAN timing synchronization status change event

See clause 5.3.1 for the handling of this IE by the AMF.

| | +| notifyForSupiList | array(Supi) | O | 1..N |

This IE may be present if the (event) type IE is set to "PRESENCE_IN_AOI_REPORT" and the subscription targets Any UE.

If this IE is present with a non-empty list, the AMF shall report the AoI events only if an event concerns a UE belonging to the provided list of SUPIs.

If the IE is not present or if it is present with an empty list, the AMF shall report the AoI events for any UE, i.e. without checking SUPIs.

See clause 5.3.4.4 of 3GPP TS 23.501 [2] and clause 5.2.2.3.1 of 3GPP TS 23.502 [3].

| AOIEF | +| notifyForSnssaiDnnList | array(SNSSAI DNNItem) | O | 1..N |

This IE may be present if the (event) type IE is set to "PRESENCE_IN_AOI_REPORT" and the subscription targets Any UE.

If this IE is present with a non-empty list, the AMF shall report the AoI events only if an event concerns a UE having a PDU session established for the provided DNN(s)/S-NSSAI(s).

If the IE is not present or if it is present with an empty list, the AMF shall report the AoI events for any UE, i.e. without checking

| AOIEF | + +| | | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--|--|---------------------------------------------------------------------------------------------------------------|--| +| | | | | DNNs/S-NSSAIs.

See clause 5.3.4.4 of 3GPP TS 23.501 [2]
and clause 5.2.2.3.1 of 3GPP TS 23.502 [3]. | | +| NOTE 1: The requested value of the location is the last known location (i.e. age of location may be greater than zero) if the immediate Flag is set to true. An NF Service Consumer requesting to receive the current location (i.e. age of location equal to zero) shall not set the immediateFlag to true when subscribing to a location event report.
NOTE 2: When creating an AMF event subscription with multiple events, the same maximum number of reports shall apply to each event. Accordingly, maxReports in this attribute should not be present when creating an AMF event subscription; if it is present, it shall contain the same value for all events and maxReports in the AmfEventMode shall have precedence over the maxReports in this attribute. maxReports in this attribute and maxReports in the AmfEventMode have different semantics when transferring the event subscription from a source AMF to a target AMF.
NOTE 3: Each Monitoring Configuration subscribed via UDM Event Exposure service uses a Reference Id as the key. This IE shall carry the Reference Id when UDM subscribes to the AMF event for the corresponding Monitoring Configuration.
NOTE 4: For a subscription to the UE_MM_TRANSACTION_REPORT event, either the snssaiFilter IE or the dispersionArea shall be present. The AMF shall report the UE MM Transaction numbers based on slices or location according to the presence of the IE. | | | | | | + +#### 6.2.6.2.4 Type: AmfEventNotification + +**Table 6.2.6.2.4-1: Definition of type AmfEventNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| notifyCorrelationId | string | C | 0..1 |

This IE shall be included if the notification is not for informing creation of a new subscription Id.

This IE shall also be included if the notification is for informing the creation of a new subscription Id and the corresponding event subscription did not contain subsChangeNotifyCorrelationId attribute (see clause 6.2.6.2.2).

When present, this IE shall indicate the notification correlation Id provided by the NF service consumer during event subscription. This parameter can be useful if the NF service consumer uses a common call-back URI for multiple subscriptions.

| | +| subsChangeNotifyCorrelationId | string | C | 0..1 |

This IE shall be included if the notification is for informing the creation of a new subscription Id at the AMF and the corresponding event subscription contains the subsChangeNotifyCorrelationId attribute (see clause 6.2.6.2.2).

When present, this IE shall be set to the value of the subsChangeNotifyCorrelationId provided during subscription (see clause 6.2.6.2.2).

| | +| reportList | array(AmfEventReport) | C | 1..N |

This IE shall be present if a event is reported. When present, this IE represents the event reports to be delivered.

| | +| eventSubsSyncInfo | AmfEventSubsSyncInfo | C | 0..1 |

This IE may be present for AMF to initiate event subscription synchronization with UDM during UE mobility procedures.

When present, this IE shall contain the information for event subscription synchronization, including all active event subscriptions specifically targeting the UE.

| ESSYNC | + +6.2.6.2.5 Type: AmfEventReport + +**Table 6.2.6.2.5-1: Definition of type AmfEventReport** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| type | AmfEventType | M | 1 | Describes the type of the event which triggers the report | | +| state | AmfEventState | M | 1 | Describes the state of the event which triggered the report. This IE shall be set to "TRUE" when subscriptionId IE is present. | | +| timeStamp | DateTime | M | 1 | This IE shall contain the UTC time at which the event is generated. | | +| subscriptionId | Uri | C | 0..1 | This IE shall be included when the event notification is for informing the creation of a subscription Id at the AMF during mobility of a UE across AMFs.

When present, this IE shall contain the URI of the created subscription resource at the AMF; this shall contain an absolute URI set to the Resource URI specified in clause 6.2.3.3.2.

The type IE shall be set to:
- SUBSCRIPTION_ID_CHANGE, when the AMF creates a subscription Id for a UE specific event subscription during mobility registration and handover procedures involving an AMF change.
- SUBSCRIPTION_ID_ADDITION, when the AMF creates a subscription Id for a group Id specific event subscription during mobility registration and handover procedures involving an AMF change. | | +| anyUe | boolean | C | 0..1 | This IE shall be included and shall be set to "true", if the event subscription is a bulk subscription for number of UEs and the event reported is for one of those UEs. (NOTE 3) | | +| supi | Supi | C | 0..1 | This IE shall be present if available.

When present, this IE identifies the SUPI of the UE associated with the report (NOTE 1, NOTE 3). | | +| areaList | array(AmfEventArea) | C | 1..N | This IE shall be present when the AMF event type is "PRESENCE_IN_AOI_REPORT". When present, this IE represents the specified Area(s) of Interest the UE is currently IN / OUT / UNKNOWN.

If the AMF event is subscribed towards a PRA identifier referring to a Set of Core Network predefined Presence Reporting Areas, the AMF shall report both the subscribed PRA Identifier and the additional PRA identifier of the actually individual PRA(s) where the UE is currently IN / OUT, as specified in clause 5.6.11 of 3GPP TS 23.501 [2]. (NOTE 3) | | +| refId | ReferenceId | C | 0..1 | This IE shall be present if a Reference Id has previously been associated with the event triggering the report.

When present, this IE shall indicate the Reference Id associated with the event which triggers the report. | | +| gpsi | Gpsi | C | 0..1 | This IE shall be present if available.

When present, this IE identifies the GPSI of the UE associated with the report (NOTE 1, NOTE 3). | | +| pei | Pei | O | 0..1 | This IE may be included if the event reported is for a particular UE or any UE. This IE | | + +| | | | | | | +|--|--|--|--|---------------------------------------------------------------------------|--| +| | | | | identifies the PEI of the UE associated with the report (NOTE 1, NOTE 3). | | +|--|--|--|--|---------------------------------------------------------------------------|--| + +| | | | | | | +|--------------------|-------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| location | UserLocation | O | 0..1 | Represents the location information of the UE

This IE shall convey exactly one of the following:
- E-UTRA user location
- NR user location
- Non-3GPP access user location.

If the additionalLocation IE is present, this IE shall contain either an E-UTRA user location or NR user location. | | +| additionalLocation | UserLocation | O | 0..1 | This IE shall be present if the "location IE" is present and the AMF reports both a 3GPP user location and a non-3GPP access user location.

When present, this IE shall convey the non-3GPP access user location. | | +| timezone | TimeZone | O | 0..1 | Describes the time zone of the UE | | +| accessTypeList | array(Access Type) | O | 1..N | Describes the access type(s) of the UE.

When reporting that the UE is reachable for DL traffic, this IE shall indicate the access type(s) through which the UE is reachable.

This attribute shall be absent if the AMF event type is "SNSSAI_TA_MAPPING_REPORT". | | +| rmInfoList | array(RmInfo) | O | 1..N | Describes the registration management state of the UE | | +| cmInfoList | array(CmInfo) | O | 1..N | Describes the connection management state of the UE | | +| reachability | UeReachability | O | 0..1 | Describes the reachability of the UE | | +| commFailure | CommunicationFailure | O | 0..1 | Describes a communication failure for the UE. | | +| numberOfUes | integer | O | 0..1 | Represents the number of UEs in the specified area | | +| 5gsUserStateList | array(5GsUserStateInfo) | O | 1..N | Represents the 5GS User State of the UE per access type | | +| typeCode | string | C | 0..1 | This IE shall be present when the AMF event type is "TYPE_ALLOCATION_CODE_REPORT". When present, this IE represents the Type Allocation code (TAC), to indicate terminal model and vendor information of the UE. Pattern: '^[0-9]{8}\$'. | ENA | +| registrationNumber | integer | C | 0..1 | This IE shall be present when the AMF event type is "FREQUENT_MOBILITY_REGISTRATION_REPORT". When present, this IE represents the number of the mobility registration procedures during a period identified by the expiry time included in the event subscription request. | ENA | +| ueIdExtList | array(UEIdExt) | C | 1..N | This IE shall be present if multiple SUPIs and / or GPSIs need to be included and the subscribing NF indicated support of the ENA feature, unless the subscribing NF indicated to omit UE IDs in the event reports by including ueIdOmitInd IE with the value true.

This attribute provides additional SUPIs and / or GPSIs to the supi attribute or gpsci attribute if present. The ueIdExtList attribute may be present even if both the supi and gpsci | ENA | + +| | | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------|--| +| | | | | attributes are absent, e.g., in a report of "UES_IN_AREA_REPORT" event type.
(NOTE 3) | | +|--|--|--|--|------------------------------------------------------------------------------------------|--| + +| | | | | | | +|---------------------------|----------------------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| lossOfConnectReason | LossOfConnectivityReason | O | 0..1 | Describes the reason for loss of connectivity. This IE should be present when the AMF event type is "LOSS_OF_CONNECTIVITY". | | +| maxAvailabilityTime | DateTime | O | 0..1 | Indicates the time (in UTC) until which the UE is expected to be reachable.

This IE may be present in REACHABILITY_REPORT event report for "UE Reachable_for DL Traffic".

This information may be used by the SMS Service Center to prioritize the retransmission of pending Mobile Terminated Short Message to UEs using a power saving mechanism (eDRX, PSM etc.). | | +| snssaiTaiList | array(SNSSAITaiMapping) | C | 1..N | This IE shall be present when the AMF event type is "SNSSAI_TA_MAPPING_REPORT". When present, this IE represents the list of supported S-NSSAIs at the TAI(s). It shall also include the indication if S-NSSAI is restricted at the AMF. | | +| idleStatusIndication | IdleStatusIndication | O | 0..1 | Idle Status Indication
May be present when type is REACHABILITY_REPORT or AVAILABILITY_AFTER_DDN_FAILURE | | +| ueAccessBehaviorTrends | array(UeAccessBehaviorReportItem) | C | 1..N | This IE shall be present to report "UE_ACCESS_BEHAVIOR_TRENDS" event.

When present, this IE shall include the UE access behavior trends within the report period. | | +| ueLocationTrends | array(UeLocationTrendsReportItem) | C | 1..N | This IE shall be present to report "UE_LOCATION_TRENDS" event.

When present, this IE shall include the UE location trends within the report period.
(NOTE 2) | | +| mmTransLocationReportList | array(MmTransactionLocationReportItem) | C | 1..N | This IE shall be present to report "UE_MM_TRANSACTION_REPORT" event based on location.

When present, this IE shall include the number of UE MM transactions per location within the report period. | | +| mmTransSliceReportList | array(MmTransactionSliceReportItem) | C | 1..N | This IE shall be present to report "UE_MM_TRANSACTION_REPORT" event based on slices.

When present, this IE shall include the number of UE MM transactions per slice within the report period. | | +| termReason | SubTerminationReason | O | 0..1 | This IE may be present when the event type is SUBSCRIPTION_TERMINATION.

When present, this IE shall indicate the reason for the subscription termination. | | +| unavailabilityPeriod | DurationSec | O | 0..1 | This IE shall be present when the event type is LOSS_OF_CONNECTIVITY and Unavailability Period Duration is reported by the UE.

When present, it contains the Unavailability Period Duration reported by the UE. If the UE is already not available when the event is subscribed, it is set to the remaining value of | | + +| | | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--|--|---------------------------------|--| +| | | | | Unavailability Period Duration. | | +|

NOTE 1: If the event report corresponds to an event subscription of a single UE, then the same UE identifier (i.e. SUPI and/or GPSI and/or PEI) received during subscription creation shall be included in the report. If the event report corresponds to an event subscription for group of UEs or any UE, then the SUPI and if available the GPSI shall be included in the event report. SUPI, PEI and GPSI shall not be present in report for UES_IN_AREA_REPORT event type.

NOTE 2: The items shall be listed in descending order by the value of "duration" attribute.

NOTE 3: When a subscription for "PRESENCE_IN_AOI_REPORT" event targets any UE but no UE is "IN" the AOI when the AMF generates the first notification (e.g. for one-time reporting or for the first notification for continuously reporting), the anyUe IE shall be present with the value true and IEs indicating UE IDs (Supi, Gpsi, Pei and ueIdExtList) shall not be present; the areaList IE shall be present including the subscribed AOI with the Presence Status set to "IN", i.e. no UE is "IN" the AOI.

| | | | | | + +## 6.2.6.2.6 Type: AmfEventMode + +**Table 6.2.6.2.6-1: Definition of type AmfEventMode** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|-----------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| trigger | AmfEventTrigger | M | 1 | Describes how the reports are triggered. | | +| maxReports | integer | C | 0..1 |

This IE shall be present if the trigger is set to "CONTINUOUS" while "expiry" attribute is not present. This IE may be present if the trigger is set to "PERIODIC". When present, this IE describes the maximum number of reports that can be generated by each subscribed event in the subscription.

If the AMF event subscription is for a list of events, this parameter shall be applied to each individual event in the list.

If the AMF event subscription is for a group of UEs, this parameter shall be applied to each individual member UE of the group.

If the event subscription is transferred from source AMF to target AMF, this IE shall contain:

  • - the remaining number of reports for the event subscription, in the case of individual UE event subscription;
  • - the maximum number of reports for each event of the AMF event subscription for each individual member of the group, in the case of a group event subscription.

(NOTE 1)

(NOTE 2)

| | +| expiry | DateTime | C | 0..1 |

This IE shall be included in an event subscription response, if, based on operator policy and taking into account the expiry time included in the request, the AMF needs to include an expiry time.

This IE may be included in an event subscription request.

When present, this IE shall represent the UTC time after which the subscribed event(s) shall stop generating report and the subscription becomes invalid. If the trigger value included in an event subscription response is "ONE_TIME" and if an event report is included in the subscription response then the value of the expiry included in the response shall be an immediate timestamp.

(NOTE 1)

| | +| repPeriod | DurationSec | C | 0..1 |

This IE shall be present if the trigger is set to "PERIODIC". When present, this IE describes the period time for the event reports. If the AMF event subscription is for a group of UEs, this parameter shall be applied to each individual member UE of the group.

(NOTE 3)

| | +| sampRatio | SamplingRatio | O | 0..1 |

This IE may be included in an event subscription request for a group of UEs or any UE to indicate the ratio of the random subset to target UEs. Event reports only relate to the subset.

If the AMF event subscription is for a list of AMF event, this parameter shall be applied to each individual event.

| | +| partitioningCriteria | array(PartitioningCriteria) | O | 1..N | This IE may be included in an event subscription request for a group of UEs or any | | + +| | | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| | | | | UE when sampRatio is provided.

When present, this IE shall define the criteria for determining the UEs for which the sampling ratio shall apply. | | +| notifFlag | NotificationFlag | O | 0..1 | Indicates the notification flag, which is used to mute/unmute notifications and to retrieve events stored during a period of muted notifications. | EneNA | +| mutingExclInstructions | MutingExceptionInstructions | O | 0..1 | This IE may be included in the event subscription request if the notifFlag IE is present and set to "DEACTIVATE".
When present, it shall indicate the instructions for the subscription and stored events when an exception (e.g. the buffer of stored event reports is full, or the number of stored event reports exceeds a certain number) occurs at AMF while the events are muted.
See 3GPP TS 23.288 [38], clause 6.2.7.2.
Write-Only: true | ENAPH3 | +| mutingNotSettings | MutingNotificationsSettings | O | 0..1 | This IE may be included if the event notifications muting is activated.
This IE Indicates the AMF muting notification settings.
See 3GPP TS 23.288 [38], clause 6.2.7.2.
Read-Only: true | ENAPH3 | +| varRepPeriodInfo | array(VarRepPeriod) | O | 1..N | This IE may be present if the trigger is set to "PERIODIC".
This IE Indicates the variable reporting periodicity information.
See 3GPP TS 23.502 [3], clause 4.15.1.
(NOTE 3) | ENAPH3 | +| NOTE 1: If the AmfEventTrigger is set to "CONTINUOUS", at least one of the "maxReports" and "expiry" attributes shall be included. | | | | | | +| NOTE 2: See NOTE 2 of Table 6.2.6.2.3-1 regarding the precedence between maxReports in AmfEvent and maxReports in this attribute. | | | | | | +| NOTE 3: If both repPeriod and varRepPeriodInfo attributes are present, the repPeriod shall be applied if none of the conditions trigger the variable reporting is met. | | | | | | + +#### 6.2.6.2.7 Type: AmfEventState + +**Table 6.2.6.2.7-1: Definition of type AmfEventState** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| active | boolean | M | 1 | Represents the active state of the subscribe event. "TRUE" value indicates the event will continue generating reports; "FALSE" value indicates the event will not generate further report. | +| remainReports | integer | O | 0..1 | Represents the number of remain reports to be generated by the subscribed event. | +| remainDuration | DurationSec | O | 0..1 | Represents how long the subscribed event will continue generating reports. | + +#### 6.2.6.2.8 Type: RmInfo + +**Table 6.2.6.2.8-1: Definition of type RmInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|-------------------------------------------------------------------------------------------------| +| rmState | RmState | M | 1 | Describes the registration management state of the UE | +| accessType | AccessType | M | 1 | Describes the access type of the UE that applies to the registration management state reported. | + +## 6.2.6.2.9 Type: CmInfo + +Table 6.2.6.2.9-1: Definition of type CmInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|-----------------------------------------------------------------------------------------------| +| cmState | CmState | M | 1 | Describes the Connection management state of the UE | +| accessType | AccessType | M | 1 | Describes the access type of the UE that applies to the Connection management state reported. | + +## 6.2.6.2.10 Void + +## 6.2.6.2.11 Type: CommunicationFailure + +Table 6.2.6.2.11-1: Definition of type CommunicationFailure + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nasReleaseCode | string | O | 0..1 | Describes the NAS release code for the communication failure. This IE shall be formatted following the regular expression pattern:
"^(MM SM)-[0-9]{1,3}\$"

Examples:
MM-7
SM-27 | +| ranReleaseCode | NgApCause | O | 0..1 | Describes the RAN release code for the communication failure. If present, this IE shall contain the decimal value of the NG AP cause code values as specified in 3GPP TS 38.413 [12]. | + +## 6.2.6.2.12 Type: AmfCreateEventSubscription + +Table 6.2.6.2.12-1: Definition of type AmfCreateEventSubscription + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| subscription | AmfEventSubscription | M | 1 | Represents the AMF Event Subscription resource to be created. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.8 is supported. | +| oldGuami | Guami | C | 0..1 | This IE shall be present during an AMF planned removal procedure when the NF Service Consumer initiates a request towards the target AMF, for a UE associated to an AMF that is unavailable (see clause 5.21.2.2 of 3GPP TS 23.501 [2]). | + +## 6.2.6.2.13 Type: AmfCreatedEventSubscription + +**Table 6.2.6.2.13-1: Definition of type AmfCreatedEventSubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| subscription | AmfEventSubscription | M | 1 | Represents the newly created AMF Event Subscription resource. | +| subscriptionId | Uri | M | 1 | Represents the URI of the newly created AMF Event Subscription resource. This shall contain an absolute URI set to the Resource URI specified in clause 6.2.3.3.2. (NOTE 2) | +| reportList | array(AmfEventReport ) | O | 1..N | Represents the immediate event reports (i.e. the current value / status of the events subscribed), if available (NOTE 1). | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.8 is supported. | + +NOTE 1: If the subscription is on behalf of another NF and the NF service consumer has not indicated supporting of IERSR feature (see 6.2.8), then the reports attribute shall be absent. +NOTE 2: 3GPP TS 23.502 [3] specifies this attribute as "Subscription Correlation ID". + +6.2.6.2.14 Type: AmfUpdateEventSubscriptionItem + +**Table 6.2.6.2.14-1: Definition of type AmfUpdateEventSubscriptionItem** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| op | string | M | 1 |

This IE indicates the patch operation as defined in IETF RFC 6902 [14] to be performed on resource.

This IE shall support the following values:
Enum: "add"
Enum: "replace"
Enum: "remove"

| | +| path | string | M | 1 |

This IE contains a JSON pointer value (as defined in IETF RFC 6901 [40]) that references a location of a resource on which the patch operation shall be performed.

This IE shall contain the JSON pointer to a valid index of the "/eventList" array in the AMF Event Subscription, formatted with following pattern:
'^VeventListV[0-9\$] VeventListV[1-9][0-9]*\$'

Example:
"/eventList/0" stands for the first member of the array;
"/eventList/10" stands for the 11th member of the array;
"/eventList/-" stands for a new (non-existent) member after the last existing array element. Only allowed with "add" operation.

To update the PRA Information, this IE shall contain the JSON pointer to a valid key of the "/presenceInfoList" object in the AMF Event Subscription, the key shall be formatted as the "pralD" attribute within the PresenceInfo data type.
Pattern: '^(\VeventListV0 VeventListV[1-9][0-9]*\}{1}(\VpresenceInfoListV0 VpresenceInfoListV[1-9][0-9]*\})?\$'

Example:
"/eventList/10/presenceInfoList/123" stands for the PresenceInfo with PRA ID 123 for the 11th member of the array.
(NOTE 1)

To remove list of group member UE(s) from a group subscription, this IE shall contain the JSON pointer to the "/excludeSupiList" object or "/excludeGpsiList" object in the AMF Event Subscription,

Pattern:
'^VexcludeSupiList VexcludeGpsiList\$'

(NOTE 2)

To add list of group member UE(s) into a group subscription, this IE shall contain the JSON pointer to the "/includeSupiList" object or "/includeGpsiList" object in the AMF Event Subscription,

Pattern:
'^VincludeSupiList VincludeGpsiList\$'

(NOTE 3)

To modify the notifyForSupiList IE or the

| | + +| | | | | | | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

notifyForSnssaiDnnList IE, this IE shall contain the JSON pointer to the "/notifyForSupiList" or "/notifyForSnssaiDnnList" attribute in the AMF Event Subscription. The new list of SUPIs or DNN/S-NSSAIs shall replace any earlier received list of SUPIs or DNNs/S-NSSAIs respectively.

Pattern: '^(VeventListV0 VeventListV[1-9][0-9]*)(1)(VnotifyForSupiList)\$'

Pattern: '^(VeventListV0 VeventListV[1-9][0-9]*)(1)(VnotifyForSnssaiDnnList)\$'

(NOTE 4)

| | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|------------------------|------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| value | AmfEvent | C | 0..1 | This IE indicates a new AMF event to be added or updated value of an existing AMF event to be modified.
It shall be present if the patch operation is "add" or "replace" | | +| presenceInfo | PresenceInfo | O | 0..1 | This IE indicates a new PresenceInfo to be added or an existing PresenceInfo to be modified. The "presenceState" attribute within the PresenceInfo data type shall not be supplied.

It shall be present if the patch operation is "add". | MPRA | +| excludeSupiList | array(Supi) | O | 1..N | When present, this IE shall carry the SUPI of the group member UE(s) that are excluded from the group subscription.

This IE shall be present if the path attribute containing JSON pointer to "/excludeSupiList" object and the patch operation is "add" and "replace". | DGEM | +| excludeGpsiList | array(Gpsi) | O | 1..N | When present, this IE shall carry the GPSI of the group member UE(s) that are excluded from the group subscription.

This IE shall be present if the path attribute containing JSON pointer to "/excludeGpsiList" object and the patch operation is "add" and "replace". | DGEM | +| includeSupiList | array(Supi) | O | 1..N | When present, this IE shall carry the SUPI of the group member UE(s) that are included for the group subscription.

This IE shall be present if the path attribute containing JSON pointer to "/includeSupiList" object and the patch operation is "add" and "replace". | DGEM | +| includeGpsiList | array(Gpsi) | O | 1..N | When present, this IE shall carry the GPSI of the group member UE(s) that are included for the group subscription.

This IE shall be present if the path attribute containing JSON pointer to "/includeGpsiList" object and the patch operation is "add" and "replace". | DGEM | +| notifyForSupiList | array(Supi) | C | 1..N | When present, this IE shall contain the list of SUPIs for which the AMF shall report the AoI events.

This IE shall be present if the path attribute contains a JSON pointer to the "/notifyForSupiList" attribute in the AMF Event Subscription and the patch operation is "add" or "replace". | AOIEF | +| notifyForSnssaiDnnList | array(SNSSAI DNN Item) | C | 1..N | When present, this IE shall contain the list of DNNs/S-NSSAIs for which the AMF shall report the AoI events.

This IE shall be present if the path attribute contains a JSON pointer to the "/notifyForSnssaiDnnList" attribute in the AMF Event Subscription and the patch operation is "add" or "replace". | AOIEF | + +NOTE 1: Update of PRA information by extending the schema of the path IE with JSON pointer to a valid key of the "/presenceInfoList" object shall only be used if the AMF supports the MPRA feature. + +NOTE 2: Remove group member UE(s) by extending the schema of the path IE with JSON pointer to the "/excludeSupiList" object or "/excludeGpsiList" object shall only be used if the AMF supports the DGEM feature. + +NOTE 3: Add group member UE(s) by extending the schema of the path IE with JSON pointer to the "/includeSupiList" object or "/includeGpsiList" object shall only be used if the AMF supports the DGEM feature. +NOTE 4: Modifying the list of SUPIs or DNNs/S-NSSAIs shall only be used if the AMF supports the AOIEF feature. + +#### 6.2.6.2.15 Type: AmfUpdatedEventSubscription + +**Table 6.2.6.2.15-1: Definition of type AmfUpdatedEventSubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------| +| subscription | AmfEventSubscription | M | 1 | Represents the updated AMF Event Subscription resource. | +| reportList | array(AmfEventReport) | O | 1..N | Represents the immediate event reports (i.e. the current value / status of the events subscribed), if available (NOTE). | +| NOTE: For newly added AMF event subscription(s) with the immediateFlag attribute set to true, immediate event report(s) of the corresponding AMF event subscription shall be provided if available. | | | | | + +#### 6.2.6.2.16 Type: AmfEventArea + +**Table 6.2.6.2.16-1: Definition of type AmfEventArea** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| presenceInfo | PresenceInfo | C | 0..1 | This IE shall be present if the Area of Interest subscribed is not a LADN service area (e.g Presence Reporting Area or a list of TAI / cell Ids) . (See NOTE1, NOTE 2) | | +| ladnInfo | LadnInfo | C | 0..1 | This IE shall be present if the Area of Interest subscribed is a LADN service area. | | +| sNssai | SNSSAI | O | 0..1 | When present, it shall contain the associated S-NSSAI of the area. | ENA | +| nsId | NsId | O | 0..1 | When present, this IE shall contain the associated NSI ID of the S-NSSAI. | ENA | +| NOTE 1: When the AmfEventArea is provided during event subscription, then for UE specific presence reporting area subscription, the prald along with what constitutes that UE specific presence reporting area (i.e. set of Tai and/or set of ecgi and/or set of ncgi and/or set of globalRanNodeId) shall be provided. | | | | | | +| NOTE 2: If the subscription is for a Set of Core Network Predefined Presence Reporting Areas and both the AMF and the NF service consumer support the "APRA" feature, the PRA Identifier for the Set shall be carried in the "prald" IE and the individual PRA identifier shall be carried in the "additionalPrald" IE; if the subscription is for a Set of Core Network Predefined Presence Reporting Areas and the AMF or NF service consumer does not support the "APRA" feature, the individual PRA identifier shall be carried in the "prald" IE and the "additionalPrald" IE shall not be present. | | | | | | + +#### 6.2.6.2.17 Type: LadnInfo + +**Table 6.2.6.2.17-1: Definition of type LadnInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ladn | string | M | 1 | Represents the Local Access Data Network DNN. The AMF shall identify the list of tracking areas corresponding to the LADN DNN based on local configuration. | +| presence | PresenceState | C | 0..1 | This IE shall be included when the UE presence in area of interest is reported. When present, this IE contains the status of UE presence within the Area of Interest (IN / OUT / UNKNOWN). | + +## 6.2.6.2.18 Type: AmfUpdateEventOptionItem + +Table 6.2.6.2.18-1: Definition of type AmfUpdateEventOptionItem + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| op | string | M | 1 | This IE indicates the patch operation as defined in IETF RFC 6902 [14] to be performed on resource.
This IE shall support the following values:
Enum: "replace" | | +| path | string | M | 1 | This IE contains a JSON pointer value (as defined in IETF RFC 6901 [40]) that references a location of a resource on which the patch operation shall be performed.

This IE shall contain the JSON pointer to "/options/expiry" attribute of the event subscription resource.

Pattern: "^/optionsV/expiry\$"

To update the notifFlag attribute, this IE shall contain the JSON pointer to "/options/notifFlag" attribute of the event subscription resource.

Pattern: "^/optionsV/notifFlag\$"

To update the mutingExclInstructions attribute, this IE shall contain the JSON pointer to "/options/mutingExclInstructions" attribute of the event subscription resource.

Pattern: "^/optionsV/mutingExclInstructions\$" | | +| value | DateTime | M | 1 | This IE indicates the updated expiry timer value (in UTC) as suggested by the NF service consumer.

For update the notifFlag attribute, it shall contain the Null value. AMF shall ignore the value and not modify the expiry attribute. | | +| notifFlag | Notification Flag | O | 0..1 | Indicates the notification flag, which is used to mute/unmute notifications and to retrieve events stored during a period of muted notifications. | EneNA | +| mutingExclInstructions | MutingExceptionInstructions | O | 0..1 | This IE may be included if the event notifications muting is being activated. It shall be present if the path IE contains a JSON pointer to the mutingExclInstructions IE of the event subscription resource.
When present, it shall indicate the instructions for the subscription and stored events when an exception (e.g. the buffer of stored event reports is full, or the number of stored event reports exceeds a certain number) occurs at AMF while the events notification is muted.
See 3GPP TS 23.288 [38], clause 6.2.7.2. | ENAPH3 | + +## 6.2.6.2.19 Type: 5GsUserInfo + +Table 6.2.6.2.19-1: Definition of type 5GsUserInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|----------------------------------------------------------------------------------| +| 5gsUserInfo | 5GsUserInfo | M | 1 | Describes the 5GS user state of the UE | +| accessType | AccessType | M | 1 | Describes the access type of the UE that applies to the 5GS user state reported. | + +## 6.2.6.2.20 Type: TrafficDescriptor + +Table 6.2.6.2.20-1: Definition of type TrafficDescriptor + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|-----------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| dnn | Dnn | C | 0..1 | This IE shall be present if it is available. When present, it shall indicate the Data Network Name. | +| sNssai | Snssai | C | 0..1 | This IE shall be present if it is available. When present, it shall indicate the associated S-NSSAI for the PDU Session. | +| dddTrafficDescriptorList | array(DddTrafficDescriptor) | C | 1..N | This IE shall be present if it is available. When present, it shall indicate the Traffic Descriptor related to the traffic. | + +## 6.2.6.2.21 Type: UEIdExt + +Table 6.2.6.2.21-1: Definition of type UEIdExt + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| supi | Supi | C | 0..1 | This IE shall be present if available.
When present, this IE identifies the SUPI of the UE associated with the report. | +| gpsi | Gpsi | C | 0..1 | This IE shall be present if available.
When present, this IE identifies the GPSI of the UE associated with the report. | + +## 6.2.6.2.22 Type: AmfEventSubsSyncInfo + +Table 6.2.6.2.22-1: Definition of type AmfEventSubsSyncInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| subscriptionList | array(AmfEventSubscriptionInfo) | M | 1..N | This IE shall contain all active subscriptions in the AMF for the target UE.

Transferred subscriptions that are not authorized by the target AMF shall not be regarded active. Based on local policy, the target AMF may consider that transferred subscriptions containing no or an invalid access token are not authorized. | | + +## 6.2.6.2.23 Type: AmfEventSubscriptionInfo + +Table 6.2.6.2.23-1: Definition of type AmfEventSubscriptionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| subId | Uri | M | 1 | This IE shall contain the URI of the subscription resource of events with Reference Id. | | +| notifyCorrelationId | string | M | 1 | This IE shall contain the notification correlation ID of the subscription. | | +| refIdList | array(ReferenceId) | M | 1..N | This IE shall contain the Reference Ids of the events in the subscription, one Reference Id per event. | | +| oldSubId | Uri | C | 0..1 | This IE shall be present if new event subscription Id is created in the new AMF, i.e. the event subscription has been retrieved from an old AMF in UE context during EPS to 5GS mobility.

When present, this IE shall include the URI of the subscription resource on the source AMF. | | + +## 6.2.6.2.24 Type: TargetArea + +Table 6.2.6.2.24-1: Definition of type TargetArea + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| taList | array(Tai) | C | 1..N | When present, this IE shall contain the list of TAs. (NOTE) | +| taiRangeList | array(TaiRange) | C | 1..N | When present, this IE shall contain range(s) of TAs. (NOTE) | +| anyTa | boolean | C | 0..1 | This IE shall be present if the event subscription is applicable to any TA. Default value "FALSE" is used, if not present (NOTE) | + +NOTE: Either information about taList or taiRangeList or anyTa set to "TRUE" shall be included. + +## 6.2.6.2.25 Type: SnssaiTaiMapping + +Table 6.2.6.2.25-1: Definition of type SnssaiTaiMapping + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reportingArea | TargetArea | M | 1 | This IE shall contain the list of TAs/TAI ranges or anyTa. The taList and taiRangeList shall be absent, and the anyTa shall be set to "TRUE", if the mapping is related to all of the TAs in the AMF. | +| accessTypeList | array(AccessType) | O | 1..N | Describes the access type(s) of the reportingArea. | +| supportedSnssaiList | array(SupportedSnssai) | C | 1..N | This IE shall be present if available.

When present, this IE represents the list of S-NSSAIs (including indication of S-NSSAIs restricted by AMF) at the reportingArea. | + +## 6.2.6.2.26 Type: SupportedSnssai + +Table 6.2.6.2.26-1: Definition of type SupportedSnssai + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sNssai | ExtSnssai | M | 1 | This IE shall contain the supported S-NSSAI. | +| restrictionInd | boolean | O | 0..1 |

If present, this IE shall contain the indication if the S-NSSAI available in sNssai IE is restricted at the AMF.

When present, this IE shall be set as follows:

  • - true: the S-NSSAI available in sNssai IE is restricted at the AMF;
  • - false (default): the S-NSSAI available in sNssai IE is not restricted at the AMF.
| + +## 6.2.6.2.27 Type: UeInAreaFilter + +Table 6.2.6.2.27-1: Definition of type UeInAreaFilter + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ueType | UeType | C | 0..1 |

When present, this IE shall contain the list of UE types.

When this IE is received, The AMF shall report the number of UEs with the indicated UE type in the area.

| +| aerialSrvDnnInd | boolean | C | 0..1 |

When present, this IE shall contain an indication of DNN(s) subject to aerial service.

Default value "FALSE" is used, if not present.

This IE may be set to "TRUE" if the NF service consumer wants to retrieve the number of UEs in the area with established PDU sessions for DNN(s) subject to aerial service.

| +| ueIdOmitInd | boolean | O | 0..1 |

When present, this IE shall indicate whether UE ID(s) should be omitted in the event reports:

  • - true: UE ID(s) to be omitted in report
  • - false (default): UE IDs are not to be omitted in report.
| + +NOTE: When the value of IE ueType is AERIAL\_UE, the IE ueType and IE aerialSrvDnnInd shall be considered with "AND" for filtering. + +## 6.2.6.2.28 Type: IdleStatusIndication + +Table 6.2.6.2.28-1: Definition of type IdleStatusIndication + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|-------------|---|-------------|-----------------------------------------------------|---------------| +| timeStamp | DateTime | O | 0..1 | Point in UTC time when the UE returned to Idle | | +| activeTime | DurationSec | O | 0..1 | Active Time granted to the UE. | | +| subsregTimer | DurationSec | O | 0..1 | Subscribed periodic registration time. | | +| edrxCycleLength | integer | O | 0..1 | Contains the eDRX cycle length in milliseconds. | | +| suggestedNumOfDIPackets | integer | O | 0..1 | Suggested number of downlink packets to be buffered | | + +## 6.2.6.2.29 Type: UeAccessBehaviorReportItem + +Table 6.2.6.2.29-1: Definition of type UeAccessBehaviorReportItem + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| stateTransitionType | AccessStateTransitionType | M | 1 | Indicate the type the state transition behavior. | | +| spacing | DurationSec | M | 1 | Indicates the average and variance of the time interval separating two consecutive occurrences of the state transition as indicated by the stateTransitionType IE. | | +| duration | DurationSec | M | 1 | Indicate the average and variance of duration in the resulting state as indicated by stateTransitionType IE. | | + +## 6.2.6.2.30 Type: UeLocationTrendsReportItem + +Table 6.2.6.2.30-1: Definition of type UeLocationTrendsReportItem + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|------------------------------------------------------------------------------------------------------------------------|---------------| +| tai | Tai | C | 0..1 | Indicates the TAI where the UE arrived.
(NOTE) | | +| ncgi | Ncgi | C | 0..1 | Indicates the NR cell where the UE arrived.
(NOTE) | | +| ecgi | Ecgi | C | 0..1 | Indicates the EUTRAN cell where the UE arrived.
(NOTE) | | +| n3gaLocation | N3gaLocation | C | 0..1 | Indicates the Non-3GPP location where the UE arrived.
(NOTE) | | +| spacing | DurationSec | M | 1 | Indicates the average and variance of the time interval separating two consecutive arrivals at the indicated location. | | +| duration | DurationSec | M | 1 | Indicate the average and variance of duration of stay in the indicated location. | | +| timestamp | DateTime | M | 1 | Indicates the date and time (in UTC) of UE last arrival to the indicated location. | | + +NOTE: At least one of the "tai", "ncgi", "ecgi" and "n3gaLocation" shall be present. + +## 6.2.6.2.31 Type: DispersionArea + +Table 6.2.6.2.31-1: Definition of type DispersionArea + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| tailList | array(Tai) | C | 1..N | Indicates the TAI where the UE information to be counted for Dispersion Analytics.
(NOTE) | | +| ncgiList | array(Ncgi) | C | 1..N | Indicates the NR cells where the UE information to be counted for Dispersion Analytics.
(NOTE) | | +| ecgiList | array(Ecgi) | C | 1..N | Indicates the EUTRAN cells where the UE information to be counted for Dispersion Analytics.
(NOTE) | | +| n3galnd | boolean | C | 0..1 | Indicates whether that the UE information shall be counted for Non-3GPP access or not.

When present, it should be set as following:
- true: The UE information shall be counted for Non-3GPP access.
- false (default): the UE information for Non-3GPP access shall not be counted. | | + +NOTE: One and only one of the "tailList", "ncgiList", "ecgiList" or "n3galnd" shall be present. + +## 6.2.6.2.32 Type: MmTransactionLocationReportItem + +Table 6.2.6.2.32-1: Definition of type MmTransactionLocationReportItem + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|---------------------------------------------------------------------------------|---------------| +| tai | Tai | C | 0..1 | Indicates the TAI where the UE MM transactions are counted.
(NOTE) | | +| ncgi | Ncgi | C | 0..1 | Indicates the NR cell where the UE MM transactions are counted.
(NOTE) | | +| ecgi | Ecgi | C | 0..1 | Indicates the EUTRAN cell where the UE MM transactions are counted.
(NOTE) | | +| n3gaLocation | N3gaLocation | C | 0..1 | Indicates the Non-3GPP location where UE MM transactions are counted.
(NOTE) | | +| timestamp | DateTime | M | 1 | Indicates the timestamp (in UTC) when the UE enters the location. | | +| transactions | integer | M | 1 | Totally number of UE MM Transactions counted within the location. | | + +NOTE: At least one of the "tai", "ncgi" or "ecgi" shall be present. + +## 6.2.6.2.33 Type: MmTransactionSliceReportItem + +**Table 6.2.6.2.33-1: Definition of type MmTransactionSliceReportItem** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | Indicates the S-NSSAI of the slice where the UE MM Transactions are counted. | | +| timestamp | DateTime | M | 1 | Indicates the timestamp (in UTC) when the slice is assigned to the UE.
(NOTE) | | +| transactions | integer | M | 1 | Totally number of UE MM Transactions counted for the indicated slice. | | + +NOTE: The timestamps for assigned slices of a UE are not passed between AMFs, i.e. when a UE moves to a new AMF the timestamps for assigned slices of the UE are set to the date and time when the mobility happened in the new AMF. + +## 6.2.6.3 Simple data types and enumerations + +## 6.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +**Table 6.2.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|-----------------|-------------| +| | | | + +### 6.2.6.3.3 Enumeration: AmfEventType + +**Table 6.2.6.3.3-1: Enumeration AmfEventType** + +| Enumeration value | Description | +|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "LOCATION_REPORT" | A NF subscribes to this event to receive the Last Known Location or the current Location of a UE or a group of UEs, and Updated Location of the UE or any UE in the group when AMF becomes aware of a location change of the UE. | +| "PRESENCE_IN_AOI_REPORT" | A NF subscribes to this event to receive the current present state of a UE in a specific Area of Interest (AOI), and notification when a specified UE enters or leaves the specified area. The area could be identified by a TA list, an area ID or specific interest area name like "LADN". | +| "TIMEZONE_REPORT" | A NF subscribes to this event to receive the current time zone of a UE or a group of UEs, and updated time zone of the UE or any UE in the group when AMF becomes aware of a time zone change of the UE. | +| "ACCESS_TYPE_REPORT" | A NF subscribes to this event to receive the current access type(s) of a UE or a group of UEs, and updated access type(s) of the UE or any UE in the group when AMF becomes aware of the access type change of the UE. | +| "REGISTRATION_STATE_REPORT" | A NF subscribes to this event to receive the current registration state of a UE or a group of UEs, and report for updated registration state of a UE or any UE in the group when AMF becomes aware of a registration state change of the UE. | +| "CONNECTIVITY_STATE_REPORT" | A NF subscribes to this event to receive the current connection management state of a UE or a group of UEs, and report for updated connection management state of a UE or any UE in the group when AMF becomes aware of a connection management state change of the UE. | +| "REACHABILITY_REPORT" | A NF subscribes to this event to receive the current reachability of a UE or a group of UEs, and report for updated reachability of a UE or any UE in the group when AMF becomes aware of a reachability change of the UE. | +| "COMMUNICATION_FAILURE_REPORT" | A NF subscribes to this event to receive the Communication failure report of a UE or group of UEs or any UE. | +| "UES_IN_AREA_REPORT" | A NF subscribes to this event to receive the number of UEs in a specific area. | +| "SUBSCRIPTION_ID_CHANGE" | This event type is used by the AMF to inform the NF service consumer that the subscription Id for the event subscription is changed (e.g. Subscription Id creation at the target AMF for individual UE level event subscriptions, during mobility registration or handover procedures involving an AMF change). This event needs no explicit subscription form an NF service consumer. | +| "SUBSCRIPTION_ID_ADDITION" | This event type is used by the AMF to inform the NF service consumer that a new subscription Id is added (e.g creation of an event subscription for a UE group level event subscription at the target AMF, during mobility registration or handover procedures involving AMF change for a UE belonging to a group Id and when such a UE is the first UE of the group registering at the target AMF). This event needs no explicit subscription form the NF service consumer. | +| "SUBSCRIPTION_TERMINATION" | This event type is used by the AMF to inform the NF service consumer that the subscription is terminated at the AMF, e.g. the AMF inform the UDM that the subscription is terminated because the AMF has identified the subscription is no longer valid at the NEF. | + +| | | +|-----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "LOSS_OF_CONNECTIVITY" | An NF subscribes to this event to receive the event report of a UE or group of UEs when AMF detects that a target UE is no longer reachable for either signalling or user plane communication. Such condition is identified when Mobile Reachable timer expires in the AMF (see 3GPP TS 23.501 [2]), when the UE detaches and when AMF deregisters from UDM for an active UE. If the UE is already not reachable for either signalling or user plane communication when the event is subscribed, the AMF reports the event directly. | +| "5GS_USER_STATE_REPORT" | A NF subscribes to this event to receive the 5GS user state of a UE. | +| "AVAILABILITY_AFTER_DDN_FAILURE" | A NF subscribes to this event to be notified about the Availability of a UE after a DDN failure. | +| "TYPE_ALLOCATION_CODE_REPORT" | A NF subscribes to this event to receive the TAC of a UE or group of UEs. | +| "FREQUENT_MOBILITY_REGISTRATION_REPORT" | A NF subscribes to this event to receive the number of mobility registration procedures during a period of a UE or group of UEs. | +| "SNSSAI_TA_MAPPING_REPORT" | A NF subscribes to this event to receive the related access type and the list of supported S-NSSAIs (including indication of S-NSSAIs restricted by AMF) at the TAI(s). | +| "UE_ACCESS_BEHAVIOR_TRENDS" | A NF subscribes to this event to receive the UE access behavior trends (e.g. access type change, handover, etc.) during a period for a UE or a group of UEs, as specified in clause 4.15.4.2 of 3GPP TS 23.502 [3]. | +| "UE_LOCATION_TRENDS" | A NF subscribes to this event to receive the UE Location Trends within a period for a UE or a group of UEs, as specified in clause 4.15.4.2 of 3GPP TS 23.502 [3]. | +| "UE_MM_TRANSACTION_REPORT" | A NF subscribes to this event to receive the Total Number of Mobility Management transactions during a period for a UE or a group of UEs, as specified in clause 5.2.2.3.1 of 3GPP TS 23.502 [3]. | + +#### 6.2.6.3.4 Enumeration: AmfEventTrigger + +**Table 6.2.6.3.4-1: Enumeration AmfEventTrigger** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "ONE_TIME" | Defines that AMF should generate report for the event only once. After reporting, the subscription to this event will be terminated. | +| "CONTINUOUS" | Defines that AMF should continuously generate reports for the event, until the subscription to this event ends, due to end of report duration or up to the maximum number of reports or the event being unsubscribed explicitly | +| "PERIODIC" | Defines that AMF should periodically generate reports for the event, until the subscription to this event ends, due to end of report duration or up to the maximum number of reports or the event being unsubscribed explicitly. | + +## 6.2.6.3.5 Enumeration: LocationFilter + +**Table 6.2.6.3.5-1: Enumeration LocationFilter** + +| Enumeration value | Description | +|-------------------|------------------------------------------------------------------------------| +| "TAI" | Indicates any change of the TA used by the UE should be reported | +| "CELL_ID" | Indicates any change of the Cell used by the UE should be reported | +| "RAN_NODE" | Indicates any change of the RAN node serving the UE shall be reported. | +| "N3IWF" | Indicates any change of the N3IWF node used by the UE should be reported | +| "UE_IP" | Indicates any change of the UE local IP address should be reported | +| "UDP_PORT" | Indicates any change of local UDP port used by the UE reported | +| "TNAP_ID" | Indicates any change of the TNAP ID used by the UE should be reported | +| "GLI" | Indicates any change of the Global Line Id used by the UE should be reported | +| "TWAP_ID" | Indicates any change of the TWAP ID used by the UE should be reported | + +## 6.2.6.3.6 Void + +## 6.2.6.3.7 Enumeration: UeReachability + +**Table 6.2.6.3.7-1: Enumeration UeReachability** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------------------------------------------------------------| +| "UNREACHABLE" | Indicates the UE is not reachable, e.g. when the Mobile Reachable Timer in AMF expires. | +| "REACHABLE" | Indicates the UE is reachable for services and downlink traffic. | +| "REGULATORY_ONLY" | Indicates the UE is reachable only for Regulatory Prioritized Service as the UE is in Not Allowed Areas. | + +## 6.2.6.3.8 Void + +## 6.2.6.3.9 Enumeration: RmState + +**Table 6.2.6.3.9-1: Enumeration RmState** + +| Enumeration value | Description | +|-------------------|-------------------------------------------| +| "REGISTERED" | Indicates the UE in RM-REGISTERED state | +| "DEREGISTERED" | Indicates the UE in RM-DEREGISTERED state | + +## 6.2.6.3.10 Enumeration: CmState + +**Table 6.2.6.3.10-1: Enumeration CmState** + +| Enumeration value | Description | +|-------------------|-------------------------------------------| +| "IDLE" | Indicates the UE is in CM-IDLE state | +| "CONNECTED" | Indicates the UE is in CM-CONNECTED state | + +## 6.2.6.3.11 Enumeration: 5GsUserState + +**Table 6.2.6.3.11-1: Enumeration 5GsUserState** + +| Enumeration value | Description | +|---------------------------------------------------------------------|-----------------------------------------------------------------------------------------------| +| "DEREGISTERED" | Indicates the UE in RM-DEREGISTERED state | +| "CONNECTED_NOT_REACHABLE_FOR_PAGING" | Indicates the UE is in the RM-REGISTERED state in 5GS and the UE is not reachable for paging. | +| "CONNECTED_REACHABLE_FOR_PAGING" | Indicates the UE is in the RM-REGISTERED state in 5GS and the UE is reachable for paging. | +| "NOT_PROVIDED_FROM_AMF" | Indicates that the 5GS User State cannot be retrieved from the AMF
(NOTE) | +| NOTE: This value is not sent by AMF (it may be sent by UDM to HSS). | | + +## 6.2.6.3.12 Enumeration: LossOfConnectivityReason + +**Table 6.2.6.3.12-1: Enumeration LossOfConnectivityReason** + +| Enumeration value | Description | +|------------------------------|--------------------------------------------------| +| "DEREGISTERED" | Indicates the UE is deregistered. | +| "MAX_DETECTION_TIME_EXPIRED" | Indicates the mobile reachable timer is expired. | +| "PURGED" | Indicates the UE is purged. | +| "UNAVAILABLE_PERIOD" | Indicates the UE reported unavailability period. | + +## 6.2.6.3.13 Enumeration: ReachabilityFilter + +**Table 6.2.6.3.13-1: Enumeration ReachabilityFilter** + +| Enumeration value | Description | +|---------------------------------|-------------------------------------------------------------| +| "UE_REACHABILITY_STATUS_CHANGE" | Indicates subscription for "UE Reachability Status Change". | +| "UE_REACHABLE_DL_TRAFFIC" | Indicates subscription for "UE Reachable for DL Traffic". | + +## 6.2.6.3.14 Enumeration: UeType + +**Table 6.2.6.3.14-1: Enumeration UeType** + +| Enumeration value | Description | +|-------------------|----------------------------------| +| "AERIAL_UE" | Indicates the UE is an Aerial UE | + +### 6.2.6.3.15 Enumeration: AccessStateTransitionType + +**Table 6.2.6.3.15-1: Enumeration AccessStateTransitionType** + +| Enumeration value | Description | +|--------------------------------|--------------------------------------------------------------------------------| +| "ACCESS_TYPE_CHANGE_3GPP" | Indicates that the UE's access type has changed to 3GPP access. | +| "ACCESS_TYPE_CHANGE_N3GPP" | Indicates that the UE's access type has changed to non-3GPP access. | +| "RM_STATE_CHANGE_DEREGISTERED" | Indicates that the UE's RM state has change to RM-DEREGISTERED. | +| "RM_STATE_CHANGE_REGISTERED" | Indicates that the UE's RM state has change to RM-REGISTERED. | +| "CM_STATE_CHANGE_IDLE" | Indicates that the UE's CM state has change to CM-IDLE. | +| "CM_STATE_CHANGE_CONNECTED" | Indicates that the UE's CM state has change to CM-CONNECTED | +| "HANDOVER" | Indicates that the UE has performed a successful handover. | +| "MOBILITY_REGISTRATION_UPDATE" | Indicates that the UE has performed a successful mobility registration update. | + +### 6.2.6.3.16 Enumeration: SubTerminationReason + +**Table 6.2.6.3.16-1: Enumeration SubTerminationReason** + +| Enumeration value | Description | +|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "INVALID_SUBSCRIPTION" | Indicates that the subscription is terminated because the AMF has identified that the subscription is no longer valid on the NF hosting the notification URI. | +| "SUBSCRIPTION_NOT_AUTHORIZED" | Indicates that the subscription is terminated because the AMF identified that the subscription is no longer authorized. This may occur during an inter-AMF mobility, based on local policy of the target AMF, e.g. if the transferred subscription contains no or an invalid access token. | + +## 6.2.6.4 Binary data + +None. + +## 6.2.7 Error Handling + +### 6.2.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +### 6.2.7.2 Protocol Errors + +Protocol Error Handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.2.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Namf\_EventExposure service, and the following application errors listed in Table 6.2.7.3-1 are specific for the Namf\_EventExposure service. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------------------|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UE_NOT_SERVED_BY_AMF | 403 Forbidden | Indicates the creation of a subscription targeting a specific UE has failed due to an application error when the UE is not served by the AMF (i.e. it is not known to the AMF). | +| UNSPECIFIED | 403 Forbidden | The request is rejected due to unspecified reasons. | +| MUTING_EXC_INSTR_NOT_ACCEPTED | 403 Forbidden | Indicates the AMF does not accept the received muting exception instructions. | +| SUBSCRIPTION_NOT_FOUND | 404 Not Found | Indicates the modification of subscription has failed due to an application error when the subscription is not found in the AMF. | + +## 6.2.8 Feature Negotiation + +The feature negotiation mechanism specified in clause 6.6 of 3GPP TS 29.500 [4] shall be used to negotiate the optional features applicable between the AMF and the NF Service Consumer, for the Namf\_EventExposure service, if any. + +The NF Service Consumer shall indicate the optional features it supports for the Namf\_EventExposure service, if any, by including the supportedFeatures attribute in content of the HTTP Request Message for subscription resource creation. + +The AMF shall determine the supported features for the service operations as specified in clause 6.6 of 3GPP TS 29.500 [4] and shall indicate the supported features by including the supportedFeatures attribute in content of the HTTP response for subscription resource creation. + +The syntax of the supportedFeatures attribute is defined in clause 5.2.2 of 3GPP TS 29.571 [6]. + +The following features are defined for the Namf\_EventExposure service: + +**Table 6.2.8-1: Features of supportedFeatures attribute used by Namf\_EventExposure service** + +| Feature Number | Feature | M/O | Description | +|----------------|---------|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ENA | O | Enablers for Network Automation for 5G

An AMF and an NF that support this feature shall support the procedures specified in 3GPP TS 23.288 [38]. | +| 2 | APRA | O | Additional Presence Reporting Area

An AMF that supports this feature shall support subscription of "PRESENCE_IN_AOI_REPORT" event with a Set of Core Network Predefined Presence Reporting Areas and generating event report including both PRA Set ID and additional PRA ID referring to an individual PRA in the Set.

An NF service consumer that supports this feature shall support receiving "PRESENCE_IN_AOI_REPORT" event with additional PRA ID referring to an individual PRA in the Set. | +| 3 | ESSYNC | O | Event Subscription Synchronization

An AMF and UDM that supports this feature shall support the event subscription synchronization procedure, as specified in clause 5.3.2.4.2. | +| 4 | ES3XX | M | Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. NEF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the Namf_EventExposure service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | +| 5 | IERSR | O | Immediate Event Report in Subscription Creation Response for Subscriptions on behalf of another NF

An NF consumer (e.g. UDM) supporting this feature shall be able to handle the immediate event reports in the Subscription Creation Response for subscriptions on behalf of another NF, as specified in clause 5.3.2.2.2. | +| 6 | EneNA | O | Enhancement of Enablers for Network Automation for 5G

An AMF and an NF that support this feature shall support the enhancement of network data analytics specified in 3GPP TS 23.288 [38]. | +| 7 | DGEM | O | Dynamic Group-based Event Monitoring

An AMF supporting this feature shall allow the NF consumer to remove or add list of group member UE(s) for a group-based event monitoring subscription (see clause 5.3.2.2.4). | +| 8 | UARF | O | UEs in Area Report Filter

This feature indicates the support of enhanced filter for UEs-In-Area-Report event. When this feature is supported at the AMF, the AMF shall apply additional filters provided in ueInAreaFilter IE. | +| 9 | MPRA | O | Map type PRA information

Support of this feature implies support of map type presenceInfoList during subscription creation and support of PresenceInfo modification during subscription modification (see clauses 6.2.6.2.3 and 6.2.6.2.14). | +| 10 | STEN | O | Subscription Termination Event Notification

An AMF supporting this feature shall support sending a notification to the NF consumer to inform that the AMF event subscription is terminated if requested by NF consumer; an NF consumer supporting this feature shall support processing the Subscription Termination Event Notification from the AMF, e.g. clean-up the local context for the indicated AMF event subscription. | +| 11 | ENAPH3 | O | Enablers for Network Automation for 5G, Phase 3

An AMF supporting this feature shall support the handling of event muting exception instructions as specified in clause 6.2.7.2 of 3GPP TS 23.288 [38]. | + +| | | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 12 | AOIEF | O |

AOI Event Filters for Subscriptions targeting any UE

An AMF supporting this feature shall support an AMF event subscription targeting any UE including the notifyForSupiList IE or notifyForSnssaiDnnList IE and shall support notifying the NF service consumer about AOI events only if the event is for a UE belonging to the provided list of SUPIs and/or for a UE having a PDU session established with the provided DNN/S-NSSAI. See clause 5.3.1.

| +|

Feature number: The order number of the feature within the supportedFeatures attribute (starting with 1).
Feature: A short name that can be used to refer to the bit and to the feature.
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature.

| | | | + +## 6.2.9 Security + +As indicated in 3GPP TS 33.501 [27], the access to the Namf\_EventExposure API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [28]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [29]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Namf\_EventExposure API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [29], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Namf\_EventExposure service. + +The Namf\_EventExposure API defines scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [27]; it defines a single scope consisting on the name of the service (i.e., "namf-evts"), and it does not define any additional scopes at resource or operation level. + +## 6.2.10 HTTP redirection + +An HTTP request may be redirected to a different AMF service instance, within the same AMF or a different AMF of an AMF set, e.g. when an AMF service instance is part of an AMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See the ES3XX feature in clause 6.2.8. + +An SCP that reselects a different AMF producer instance will return the NF Instance ID of the new AMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an AMF within an AMF set redirects a service request to a different AMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new AMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# 6.3 Namf\_MT Service API + +## 6.3.1 API URI + +The Namf\_MT shall use the Namf\_MT API. + +The API URI of the Namf\_MT API shall be: + +**{apiRoot}/** + +The request URI used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "namf-mt". +- The shall be "v1". +- The shall be set as described in clause 6.3.3. + +## 6.3.2 Usage of HTTP + +### 6.3.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [19], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Namf\_MT service shall comply with the OpenAPI [23] specification contained in Annex A. + +### 6.3.2.2 HTTP standard headers + +#### 6.3.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +#### 6.3.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [8], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 9457 [36]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +### 6.3.2.3 HTTP custom headers + +#### 6.3.2.3.1 General + +In this release of this specification, no custom headers specific to the Namf\_MT service are defined. For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.3.3 Resources + +### 6.3.3.1 Overview + +![Figure 6.3.3.1-1: Resource URI structure of the Namf_MT Service API. The diagram shows a hierarchical tree structure of resource URIs. The root is ///namf-mt/. It branches into /ue-contexts. /ue-contexts branches into / and /enable-group-reachability. / branches into /ue-reachind. /enable-group-reachability is shown with a dashed border.](f609bd3fda53d5be094991a96addbf84_img.jpg) + +``` + +graph TD + Root["///namf-mt/"] --> UEContexts["/ue-contexts"] + UEContexts --> UEContextId["/"] + UEContexts --> EnableGroupReachability["/enable-group-reachability"] + UEContextId --> UEReachInd["/ue-reachind"] + style EnableGroupReachability stroke-dasharray: 5 5 + +``` + +Figure 6.3.3.1-1: Resource URI structure of the Namf\_MT Service API. The diagram shows a hierarchical tree structure of resource URIs. The root is ///namf-mt/. It branches into /ue-contexts. /ue-contexts branches into / and /enable-group-reachability. / branches into /ue-reachind. /enable-group-reachability is shown with a dashed border. + +**Figure 6.3.3.1-1: Resource URI structure of the Namf\_MT Service API** + +Table 6.3.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.3.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------------|----------------------------------------|----------------------------------|---------------------------------------------------------------------| +| ueReachInd | /ue-contexts//ue-reachind | PUT | Update the ueReachInd to UE Reachable | +| ueContext | /ue-contexts/ | GET | Map to following service operation:
- ProvideDomainSelectionInfo | +| ueContexts collection | /ue-contexts/enable-group-reachability | enable-group-reachability (POST) | Update the state of the list of UEs to CM-CONNECTED state | + +### 6.3.3.2 Resource: ueReachInd + +#### 6.3.3.2.1 Description + +This resource represents the ueReachInd for a SUPI. + +This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +#### 6.3.3.2.2 Resource Definition + +Resource URI: {apiRoot}/namf-mt//ue-contexts//ue-reachind + +This resource shall support the resource URI variables defined in table 6.3.3.2.2-1. + +**Table 6.3.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.3.1 | +| apiVersion | string | See clause 6.3.1. | +| ueContextId | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: see pattern of type Supi in 3GPP TS 29.571 [6] | + +### 6.3.3.2.3 Resource Standard Methods + +#### 6.3.3.2.3.1 PUT + +This method shall support the URI query parameters specified in table 6.3.3.2.3.1-1. + +**Table 6.3.3.2.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.3.3.2.3.1-2 and the response data structures and response codes specified in table 6.3.3.2.3.1-3. + +**Table 6.3.3.2.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|----------------------------------------------------------------------| +| EnableUeReachabilityReqData | M | 1 | Contain the State of the UE, the value shall be set to UE Reachable. | + +**Table 6.3.3.2.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------|---|-------------|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EnableUeReachabilityRspData | M | 1 | 200 OK | Indicate the ueReachInd is updated to UE Reachable. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
When the related UE context is not fully available at the target NF Service Producer (e.g. AMF) during a planned maintenance case (e.g. AMF planned maintenance without UDSF case) the "cause" attribute may be used to include the following application error:
- NF_CONSUMER_REDIRECT_ONE_TXN

See table 6.3.7.3-1 for the description of these errors

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetailsEnableUeReachability | O | 0..1 | 403
Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- UNABLE_TO_PAGE_UE
- UNSPECIFIED
- UE_IN_NON_ALLOWED_AREA

See table 6.3.7.3-1 for the description of this error. | +| ProblemDetails | O | 0..1 | 404
Not Found | When the related UE is not found in the NF Service Producer (e.g. AMF) the "cause" attribute shall be set to:
- CONTEXT_NOT_FOUND

See table 6.3.7.3-1 for the description of these errors | +| ProblemDetails | O | 0..1 | 409
Conflict | The "cause" attribute may be used to indicate the following application error:
-

REJECTION_DUE_TO_PAGING_RESTRICTION

See table 6.3.7.3-1 for the description of this error. | +| ProblemDetails | O | 0..1 | 503
Service Unavailable | The "cause" attribute may be used to indicate one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4].

The HTTP header field "Retry-After" shall not be included in this scenario. | +| ProblemDetailsEnableUeReachability | O | 0..1 | 504
Gateway Timeout | The "cause" attribute may be used to indicate one of the following application errors:
- UE_NOT_RESPONDING
- UE_NOT_REACHABLE

See table 6.3.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.3.3.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | The URI of the resource located on an alternative service instance within the same AMF or AMF (service) set to which the request is redirected.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.3.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.3.3.2.4 Resource Custom Operations + +There is no custom operation supported on this resource. + +### 6.3.3.3 Resource: ueContext + +#### 6.3.3.3.1 Description + +This resource represents the UeContext for a UE. + +This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +#### 6.3.3.3.2 Resource Definition + +Resource URI: {apiRoot}/namf-mt//ue-contexts/{ueContextId} + +This resource shall support the resource URI variables defined in table 6.3.3.3.2-1. + +**Table 6.3.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.3.1 | +| apiVersion | string | See clause 6.3.1. | +| ueContextId | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: see pattern of type Supi in 3GPP TS 29.571 [6] | + +#### 6.3.3.3.3 Resource Standard Methods + +##### 6.3.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 6.3.3.3.3.1-1. + +**Table 6.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|--------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| info-class | UeContextInfoClass | M | 1 | Indicates the class of the UE Context information elements to be fetched. | +| supported-features | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.3.8 is supported. | +| old-guami | Guami | C | 0..1 | This IE shall be present during an AMF planned removal procedure when the NF Service Consumer initiates a request towards the target AMF, for a UE associated to an AMF that is unavailable (see clause 5.21.2.2 of 3GPP TS 23.501 [2]). | + +This method shall support the request data structures specified in table 6.3.3.3.1-2 and the response data structures and response codes specified in table 6.3.3.3.1-3. + +**Table 6.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UeContextInfo | M | 1 | 200 OK | This represents the operation is successful and request UE Context information is returned. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
When the related UE context is not fully available at the target NF Service Consumer (e.g. AMF) during a planned maintenance case (e.g. AMF planned maintenance without UDSF case) the "cause" attribute shall be set to:
- NF_CONSUMER_REDIRECT_ONE_TXN
See table 6.3.7.3-1 for the description of these errors

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403
Forbidden | Indicates the operation has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- UNABLE_TO_PAGE_UE
- UE_DEREGISTERED
- UNSPECIFIED

See table 6.3.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 404
Not Found | Indicates the operation has failed due to application error.
The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND

See table 6.3.7.3-1 for the description of these errors | +| ProblemDetails | O | 0..1 | 409
Conflict | This indicates that the request could not be completed due to a temporary conflict with the current state of the target resource.

The cause attribute of the ProblemDetails structure shall be set to:
- TEMPORARY_REJECT_REGISTRATION_ONGOING, if there is an on-going registration procedure. | + +NOTE 1: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | The URI of the resource located on the target NF Service Consumer (e.g. AMF) to which the request is redirected.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.3.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.3.3.3.4 Resource Custom Operations + +There is no custom operation supported on this resource. + +### 6.3.3.4 Resource: ueContexts collection + +#### 6.3.3.4.1 Description + +This resource represents the collection of the individual UeContexts created in the AMF. + +This resource is modelled as the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +#### 6.3.3.4.2 Resource Definition + +Resource URI: {apiRoot}/namf-mt//ue-contexts + +This resource shall support the resource URI variables defined in table 6.3.3.4.2-1. + +**Table 6.3.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|-------------------| +| apiRoot | string | See clause 6.3.1 | +| apiVersion | string | See clause 6.3.1. | + +#### 6.3.3.4.3 Resource Standard Methods + +There is no standard operation supported on this resource. + +#### 6.3.3.4.4 Resource Custom Operations + +##### 6.3.3.4.4.1 Overview + +**Table 6.3.3.4.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|---------------------------|----------------------------------------|--------------------|---------------------------------------------| +| enable-group-reachability | /ue-contexts/enable-group-reachability | POST | Enable Group Reachability service operation | + +##### 6.3.3.4.4.2 Operation: enable-group-reachability + +###### 6.3.3.4.4.2.1 Description + +###### 6.3.3.4.4.2.2 Operation Definition + +This custom operation updates the state of the list of UEs to CM-CONNECTED state. + +This operation shall support the request data structures specified in table 6.3.3.4.4.2.2-1 and the response data structure and response codes specified in table 6.3.3.4.4.2.2-2. + +**Table 6.3.3.4.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------------|---|-------------|-------------------------------------------------------------------------------------| +| EnableGroupReachabilityReqData | M | 1 | Contain the list of UEs involved in the MBS Session identified by the related TMGI. | + +**Table 6.3.3.4.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------------|---|-------------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EnableGroupReachabilityRspData | M | 1 | 200 OK | Successful response indicating the list of UEs in CM-CONNECTED state if any, and indicating the supported features. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | When none of the UEs in the list of UEs are found in the AMF, the "cause" attribute shall be set to:
- CONTEXT_NOT_FOUND
See table 6.3.7.3-1 for the description of these errors | +| ProblemDetails | O | 0..1 | 503 Service Unavailable | The "cause" attribute may be used to indicate one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4]. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.3.3.4.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | The URI of the resource located on an alternative service instance within the same AMF or AMF (service) set to which the request is redirected.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.3.3.4.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.3.4 Custom Operations without associated resources + +There are no custom operations without associated resources supported on Namf\_MT service. + +## 6.3.5 Notifications + +### 6.3.5.1 General + +This clause specifies the notifications provided by the Namf\_MT service. + +**Table 6.3.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------|-------------------------|---------------------------------|---------------------------------| +| UE Reachability Info Notify | {reachabilityNotifyUri} | POST | | + +### 6.3.5.2 UE Reachability Info Notify + +If a NF service consumer has implicitly subscribed to the UE Reachability Info Notify supported by Namf\_MT service, the AMF shall deliver the notification to the call-back URI for the UE(s) which are reachable or do not respond to paging, following Subscribe/Notify mechanism defined in 3GPP TS 29.501 [5]. + +#### 6.3.5.2.1 Notification Definition + +Call-back URI: {callbackUri} + +This callback URI shall be the "reachabilityNotifyUri" provided in the "EnableGroupReachabilityReqData" IE. + +#### 6.3.5.2.3 Notification Standard Methods + +##### 6.3.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.3.5.2.3.1-1 and the response data structures and response codes specified in table 6.3.5.2.3.1-2. + +**Table 6.3.5.2.3.1-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-------------------------------|---|-------------|---------------------------------------------| +| ReachabilityNotification Data | M | 1 | Represents the notification to be delivered | + +**Table 6.3.5.2.3.1-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.3.5.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.3.5.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.3.6 Data Model + +### 6.3.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.3.6.3-1 specifies the data types defined for the Namf\_MT service based interface protocol. + +**Table 6.3.6.3-1: Namf\_MT specific Data Types** + +| Data type | Clause defined | Description | +|------------------------------------|----------------|-------------------------------------------------------------------------------| +| EnableUeReachabilityReqData | 6.3.6.2.2 | Data within the Enable UE Reachability Request | +| EnableUeReachabilityRspData | 6.3.6.2.3 | Data within the Enable UE Reachability Response | +| UeContextInfo | 6.3.6.2.4 | Contains the UE Context Information | +| ProblemDetailsEnableUeReachability | 6.3.6.2.5 | Enable UE Reachability Error Detail | +| AdditionInfoEnableUeReachability | 6.3.6.2.6 | Additional information to be returned in EnableUeReachability error response. | +| EnableGroupReachabilityReqData | 6.3.6.2.7 | Data within the Enable Group Reachability Request | +| EnableGroupReachabilityRspData | 6.3.6.2.8 | Data within the Enable Group Reachability Response | +| UeInfo | 6.3.6.2.9 | list of UEs requested to be made reachable for the MBS Session | +| ReachabilityNotificationData | 6.3.6.2.10 | Data within the UE Reachability Info Notify | +| ReachableUeInfo | 6.3.6.2.11 | Contains the reachable UE Information | +| UeContextInfoClass | 6.3.6.3.3 | Indicates the UE Context information class | + +Table 6.3.6.3-2 specifies data types re-used by the Namf\_MT service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Namf\_MT service based interface. + +**Table 6.3.6.3-2: Namf\_MT re-used Data Types** + +| Data type | Reference | Comments | +|--------------------|--------------------|-------------------------------------------------------------------| +| ProblemDetails | 3GPP TS 29.571 [6] | Common data type used in response bodies | +| supportedFeatures | 3GPP TS 29.571 [6] | Supported Features | +| AccessType | 3GPP TS 29.571 [6] | Access Type | +| RatType | 3GPP TS 29.571 [6] | RAT Type | +| DurationSec | 3GPP TS 29.571 [6] | | +| RedirectResponse | 3GPP TS 29.571 [6] | Response body of the redirect response message. | +| Supi | 3GPP TS 29.571 [6] | SUPI | +| Tmgi | 3GPP TS 29.571 [6] | TMGI | +| PduSessionId | 3GPP TS 29.571 [6] | PDU Session Id | +| Uri | 3GPP TS 29.571 [6] | URI | +| UserLocation | 3GPP TS 29.571 [6] | User Location Information | +| MbsServiceAreaInfo | 3GPP TS 29.571 [6] | MBS Service Area Information for a Location dependent MBS session | +| Qfi | 3GPP TS 29.571 [6] | QoS Flow Identifier | +| UeReachability | 6.2.6.3.7 | Describes the reachability of the UE | +| Ppi | 6.1.6.3.2 | Paging Policy | + +## 6.3.6.2 Structured data types + +### 6.3.6.2.1 Introduction + +Structured data types used in Namf\_MT service are specified in this clause. + +### 6.3.6.2.2 Type: EnableUeReachabilityReqData + +**Table 6.3.6.3.2-1: Definition of type EnableUeReachabilityReqData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reachability | UeReachability | M | 1 | Indicates the desired reachability of the UE | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.3.8 is supported. | +| oldGuami | Guami | C | 0..1 | This IE shall be present during an AMF planned removal procedure when the NF Service Consumer initiates a request towards the target AMF, for a UE associated to an AMF that is unavailable (see clause 5.21.2.2 of 3GPP TS 23.501 [2]). | +| extBufSupport | boolean | C | 0..1 | This IE shall be present and set to "true", if the extended buffering is supported(see clauses 4.24.2 and clause 4.25.5 of 3GPP TS 23.502 [3]),

When present, the IE shall be set as following:
- true: the extended buffering is supported
- false (default): the extended buffering is not supported | +| ppi | Ppi | O | 0..1 | This IE may be included by the SMF during the Network Triggered Connection Resume in RRC Inactive with CN based MT communication handling. When present, it shall contain the Paging policy to be applied. | +| arp | Arp | O | 0..1 | This IE may be included by the SMF during the Network Triggered Connection Resume in RRC Inactive with CN based MT communication handling.

When present, it shall contain the Allocation and Retention Priority of the QoS flow of the PDU session triggering the procedure, e.g., for which DL packets have been received by the UPF. | +| 5qi | 5Qi | O | 0..1 | This IE may be included by the SMF during the Network Triggered Connection Resume in RRC Inactive with CN based MT communication handling.

When present, it shall indicate the 5QI of the QoS flow of the PDU session triggering the procedure, e.g., for which DL packets have been received by the UPF. | +| qfi | Qfi | O | 0..1 | This IE may be included by the SMF during the Network Triggered Connection Resume in RRC Inactive with CN based MT communication handling.

When present, it shall indicate the QFI of the QoS flow of the PDU session triggering the procedure, e.g., for which DL packets have been received by the UPF. | +| pduSessionId | PduSessionId | O | 0..1 | This IE may be included by the SMF during the Network Triggered Connection Resume in RRC Inactive with CN based MT communication handling.

When present, it shall indicate the PDU Session ID of the PDU session triggering the procedure, e.g., for which DL packets have been received by the UPF. | + +## 6.3.6.2.3 Type: EnableUeReachabilityRspData + +**Table 6.3.6.2.3-1: Definition of type EnableUeReachabilityRspData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| reachability | UeReachability | M | 1 | Indicates the current reachability of the UE | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.3.8 is supported. | + +## 6.3.6.2.4 Type: UeContextInfo + +**Table 6.3.6.2.3-1: Definition of type UeContextInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supportVoPS | boolean | C | 0..1 | This IE shall be present when following UE Context Information class are required:
- "TADS"

When present, this IE shall indicate whether or not IMS voice over PS Session is supported in the registration area (s) where the UE is currently registered in 3GPP access. | +| supportVoPSn3gpp | boolean | C | 0..1 | This IE shall be present when the UE is registered in WLAN non 3GPP access and the following UE Context Information class are required:
- "TADS"

When present, this IE shall indicate whether or not IMS voice over PS Session Supported Indication over non-3GPP access is supported in the WLAN where the UE is currently registered. | +| lastActTime | DateTime | C | 0..1 | This IE shall be present when following UE Context Information class are required:
- "TADS"

When present, this IE shall indicate the UTC time stamp of the last radio contact with the UE. | +| accessType | AccessType | C | 0..1 | This IE shall be present when following UE Context Information class are required:
- "TADS"

When present, this IE shall indicate the current access type of the UE. | +| ratType | RatType | C | 0..1 | This IE shall be present when following UE Context Information class are required:
- "TADS"

When present, this IE shall indicate the current RAT type of the UE. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.3.8 is supported. | + +## 6.3.6.2.5 Type: ProblemDetailsEnableUeReachability + +**Table 6.3.6.2.5-1: Definition of type ProblemDetailsEnableUeReachability as a list of to be combined data** + +| Data type | Cardinality | Description | Applicability | +|----------------------------------|-------------|----------------------------------------------------------|---------------| +| ProblemDetails | 1 | Detail information of the problem | | +| AdditionInfoEnableUeReachability | 1 | Additional information to be returned in error response. | | + +## 6.3.6.2.6 Type: AdditionInfoEnableUeReachability + +Table 6.3.6.2.6-1: Definition of type AdditionInfoEnableUeReachability + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|-------------------------------------------------------------------------------------------------------------| +| maxWaitingTime | DurationSec | C | 0..1 | This IE shall contain the estimated maximum wait time (see clauses 4.24.2 and 4.8.2.2b of 3GPP 23.502 [3]). | + +## 6.3.6.2.7 Type: EnableGroupReachabilityReqData + +Table 6.3.6.2.7-1: Definition of type EnableGroupReachabilityReqData + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|---------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ueList | array(UeInfo) | M | 1..N | This IE shall indicate the list of UEs requested to be made reachable for the MBS Session and may indicate the PDU Session Id of the associated PDU Session for the UE(s). | +| tmgi | Tmgi | M | 1 | This IE shall indicate the TMGI of the MBS session. | +| reachabilityNotifyUri | Uri | O | 0..1 | The callback URI on which UEReachabilityInfoNotify is reported. | +| mbsServiceAreaInfoList | array(MbsServiceAreaInfo) | O | 1..N | List of MBS Service Area and related Area Session ID for location dependent content. | +| arp | Arp | O | 0..1 | This IE when present shall indicate the most demanding Allocation and Retention Priority of all MBS QoS Flow within the MBS session. The AMF may use this IE for paging differentiation (see clause 6.12 of 3GPP TS 23.247 [55]). | +| 5qi | 5Qi | O | 0..1 | This IE when present shall indicate the most demanding 5QI of all MBS QoS Flow within the MBS session. The AMF may use this IE for paging differentiation (see clause 6.12 of 3GPP TS 23.247 [55]). | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.3.8 is supported. | + +## 6.3.6.2.8 Type: EnableGroupReachabilityRspData + +Table 6.3.6.2.8-1: Definition of type EnableGroupReachabilityRspData + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ueConnectedList | array(Supi) | C | 1..N | This IE shall be present if there is at least one UE in the list of UEs received in the request that is already in CM-CONNECTED state. When present, this IE shall indicate the list of UEs in CM-CONNECTED state. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.3.8 is supported. | + +## 6.3.6.2.9 Type: UeInfo + +Table 6.3.6.2.9-1: Definition of type UeInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|--------------------------------------------------------------------------------------------| +| ueList | array(Supi) | M | 1..N | This IE shall indicate the list of UEs requested to be made reachable for the MBS Session. | +| pduSessionId | PduSessionId | O | 0..1 | Represents the identifier of the associated PDU Session for the UEs in ueList IE. | + +### 6.3.6.2.10 Type: ReachabilityNotificationData + +**Table 6.3.6.2.10-1: Definition of type ReachabilityNotificationData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|------------------------|---|-------------|-----------------------------------------------------| +| reachableUeList | array(ReachableUeInfo) | C | 1..N | This IE shall indicate the list of reachable UEs. | +| unreachableUeList | array(Supi) | C | 1..N | This IE shall indicate the list of unreachable UEs. | + +### 6.3.6.2.11 Type: ReachableUeInfo + +**Table 6.3.6.2.11-1: Definition of type ReachableUeInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|----------------------------------------------------------------| +| ueList | array(Supi) | M | 1..N | This IE shall indicate the list of reachable UEs. | +| userLocation | UserLocation | C | 0..1 | This IE shall indicate the User Location of the reachable UEs. | + +## 6.3.6.3 Simple data types and enumerations + +### 6.3.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +### 6.3.6.3.2 Simple data types + +The simple data types defined in table 6.3.6.3.2-1 shall be supported. + +**Table 6.3.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|-----------------|-------------| +| | | | + +### 6.3.6.3.3 Enumeration: UeContextInfoClass + +**Table 6.3.6.3.3-1: Enumeration UeContextInfoClass** + +| Enumeration value | Description | +|-------------------|--------------------------------------------------------------------------------------------| +| "TADS" | Defines the UE Context Information for Terminating Domain Selection for IMS Voice over PS. | + +## 6.3.6.4 Binary data + +None. + +## 6.3.7 Error Handling + +### 6.3.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +### 6.3.7.2 Protocol Errors + +Protocol Error Handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.3.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Namf\_MT service, and the following application errors listed in Table 6.3.7.3-1 are specific for the Namf\_MT service. + +**Table 6.3.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NF_CONSUMER_REDIRECT_ONE_TXN | 307
Temporary Redirect | The request has been asked to be redirected to a specified target. | +| UNABLE_TO_PAGE_UE | 403
Forbidden | AMF is unable page the UE, temporarily. | +| UE_IN_NON_ALLOWED_AREA | 403
Forbidden | UE is currently in a non-allowed area and the service request is not for a regulatory prioritized service. | +| UE_DEREGISTERED | 403
Forbidden | The user is in RM-DEREGISTERED state in the AMF. | +| UNSPECIFIED | 403
Forbidden | The request is rejected due to unspecified reasons. | +| CONTEXT_NOT_FOUND | 404
Not Found | The related UE is not found in the NF Service Consumer. | +| TEMPORARY_REJECT_REGISTRATION ONGOING | 409
Conflict | The request fails due to an on-going registration procedure. | +| REJECTION_DUE_TO_PAGING_RESTRICTION | 409
Conflict | If Paging Restriction Information restrict the EnableUEReachability request from causing paging as defined in 3GPP TS 23.501 [2] clause 5.38.5 or if the UE rejects the paging as defined in 3GPP TS 23.501 [2] clause 5.38.4. | +| UE_NOT_RESPONDING | 504
Gateway Timeout | UE is not responding to the request initiated by the network, e.g. Paging. | +| UE_NOT_REACHABLE | 504
Gateway Timeout | The UE is not reachable for paging, e.g., when UE is in MICO mode or the UE has entered the UE has entered Extended DRX in CM-IDLE or Extended DRX for RRC-INACTIVE state. | + +### 6.3.8 Feature Negotiation + +The feature negotiation mechanism specified in clause 6.6 of 3GPP TS 29.500 [4] shall be used to negotiate the optional features applicable between the AMF and the NF Service Consumer, for the Namf\_MT service, if any. + +The NF Service Consumer shall indicate the optional features it supports for the Namf\_MT service, if any, by including the supportedFeatures attribute in content of the HTTP Request Message for following service operations: + +- EnableUEReachability, as specified in clause 5.4.2.2; +- ProvideDomainSelectionInfo, as specified in clause 5.4.2.3; +- EnableGroupReachability, as specified in clause 5.4.2.4. + +The AMF shall determine the supported features for the service operations as specified in clause 6.6 of 3GPP TS 29.500 [4] and shall indicate the supported features by including the supportedFeatures attribute in content of the HTTP response for the service operation. + +The syntax of the supportedFeatures attribute is defined in clause 5.2.2 of 3GPP TS 29.571 [6]. + +The following features are defined for the Namf\_MT service. + +**Table 6.3.8-1: Features of supportedFeatures attribute used by Namf\_MT service** + +| Feature Number | Feature | M/O | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ES3XX | M | Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. SMSF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the Namf_MT service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | +| 2 | GRCAP | O | Group Reachability Capability

An AMF and SMF that supports this feature shall support the EnableGroupReachability and UEReachabilityInfoNotify service operations, as specified in clause 5.4.2.4 and clause 5.4.2.5. | +| Feature number: The order number of the feature within the supportedFeatures attribute (starting with 1).
Feature: A short name that can be used to refer to the bit and to the feature.
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature. | | | | + +### 6.3.9 Security + +As indicated in 3GPP TS 33.501 [27], the access to the Namf\_MT API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [28]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [29]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Namf\_MT API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [29], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Namf\_MT service. + +The Namf\_MT API defines the following scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [27]. + +**Table 6.3.9-1: OAuth2 scopes defined in Namf\_MT API** + +| Scope | Description | +|-------------------------------------|----------------------------------------------------------| +| "namf-mt" | Access to the Namf_MT API. | +| "namf-mt:ue-reachind" | Access to the EnableUeReachability service operation. | +| "namf-mt:enable-group-reachability" | Access to the EnableGroupReachability service operation. | + +### 6.3.10 HTTP redirection + +An HTTP request may be redirected to a different AMF service instance, within the same AMF or a different AMF of an AMF set, e.g. when an AMF service instance is part of an AMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See the ES3XX feature in clause 6.3.8. + +An SCP that reselects a different AMF producer instance will return the NF Instance ID of the new AMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an AMF within an AMF set redirects a service request to a different AMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new AMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.4 Namf\_Location Service API + +### 6.4.1 API URI + +The Namf\_Location shall use the Namf\_Location API. + +The API URI of the Namf\_Location API shall be: + +**{apiRoot}//** + +The request URI used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "namf-loc". +- The shall be "v1". +- The shall be set as described in clause 6.4.3. + +### 6.4.2 Usage of HTTP + +#### 6.4.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [19], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Namf\_Location service shall comply with the OpenAPI [23] specification contained in Annex A. + +#### 6.4.2.2 HTTP standard headers + +##### 6.4.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +#### 6.4.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [8], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 9457 [36]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +#### 6.4.2.3 HTTP custom headers + +##### 6.4.2.3.1 General + +In this release of this specification, no custom headers specific to the Namf\_Location service are defined. For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.4.3 Resources + +#### 6.4.3.1 Overview + +![Diagram showing the resource URI structure of the Namf_Location Service API. A central box labeled '{ueContextId}' branches out to three dashed boxes: '/provide-pos-info', '/provide-loc-info', and '/cancel-pos-info'.](44b5421412b6a548e6e32adda52dfeab_img.jpg) + +``` + +graph LR + A["/{ueContextId}"] --- B[/provide-pos-info] + A --- C[/provide-loc-info] + A --- D[/cancel-pos-info] + style B stroke-dasharray: 5 5 + style C stroke-dasharray: 5 5 + style D stroke-dasharray: 5 5 + +``` + +Diagram showing the resource URI structure of the Namf\_Location Service API. A central box labeled '{ueContextId}' branches out to three dashed boxes: '/provide-pos-info', '/provide-loc-info', and '/cancel-pos-info'. + +**Figure 6.4.3.1-1: Resource URI structure of the Namf\_Location Service API** + +Table 6.4.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.4.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------------|-------------------|---------------------------------|------------------------| +| Individual UE context | /provide-pos-info | provide-pos-info (POST) | ProvidePositioningInfo | +| | /provide-loc-info | provide-loc-info (POST) | ProvideLocationInfo | +| | /cancel-pos-info | cancel-pos-info (POST) | CancelLocation | + +### 6.4.3.2 Resource: Individual UE Context + +#### 6.4.3.2.1 Description + +This resource represents an individual ueContextId. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +#### 6.4.3.2.2 Resource Definition + +Resource URI: {apiRoot}/namf-loc// + +This resource shall support the resource URI variables defined in table 6.4.3.2.2-1. + +**Table 6.4.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.4.1 | +| apiVersion | string | See clause 6.4.1. | +| ueContextId | string | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: see pattern of type Supi in 3GPP TS 29.571 [6]
Or represents the Permanent Equipment Identifier (see 3GPP TS 23.501 [2] clause 5.9.3) pattern: "(imei-[0-9]{15} imeisv-[0-9]{16} .+)" | + +#### 6.4.3.2.3 Resource Standard Methods + +There are no standard methods supported on this resource. + +#### 6.4.3.2.4 Resource Custom Operations + +##### 6.4.3.2.4.1 Overview + +**Table 6.4.3.2.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|------------------|---------------------------------|--------------------|-------------------------------------------------------------------------------------------------------------| +| provide-pos-info | /{ueContextId}/provide-pos-info | POST | Request the positioning information of the UE. It is used for the ProvidePositioningInfo service operation. | +| provide-loc-info | /{ueContextId}/provide-loc-info | POST | Request the Network Provided Location Information of the UE. | +| cancel-pos-info | /{ueContextId}/cancel-pos-info | POST | Cancels periodic or triggered location for the UE. | + +##### 6.4.3.2.4.2 Operation: provide-pos-info (POST) + +###### 6.4.3.2.4.2.1 Description + +This ueContextId identifies the individual ueContext resource is composed by UE's SUPI or PEI. + +###### 6.4.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.4.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.4.3.2.4.2.2-2. + +**Table 6.4.3.2.4.2.2-1: Data structures supported by (POST) the provide-pos-info operation Request Body** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|-------------------------------------------------------------------| +| RequestPosInfo | M | 1 | The information to request the positioning information of the UE. | + +**Table 6.4.3.2.4.2.2-2: Data structures supported by the (POST) provide-pos-info operation Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ProvidePosInfoExt | M | 1 | 200 OK | This case represents a successful query of the UE positioning information, the AMF returns the related information in the response. | +| n/a | | | 204 No Content | Shall return 204 if no information is to be returned | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
  • - USER_UNKNOWN
  • - DETACHED_USER
  • - POSITIONING_DENIED
  • - UNSPECIFIED
  • - REQUESTED_LMF_NOT_AVAILABLE
See table 6.4.7.3-1 for the description of these errors. | +| ProblemDetailsProvidePosInfo | O | 0..1 | 409 Conflict | The request could not be completed due to a conflict with the current state of the resource.
The "cause" attribute may be used to indicate
  • - HO_TO_EPS
See table 6.4.7.3-1 for the description of these errors.
The response should contain the target MME name and realm, if available, and it may contain the location information available from the LMF. | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | The "cause" attribute may be used to indicate one of the following application errors:
  • - POSITIONING_FAILED
See table 6.4.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 504 Gateway Timeout | The "cause" attribute may be used to indicate one of the following application errors:
  • - UNREACHABLE_USER
  • - PEER_NOT_RESPONDING
See table 6.4.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.4.3.2.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.4.3.2.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +6.4.3.2.4.3 Operation: provide-loc-info (POST) + +6.4.3.2.4.3.1 Description + +This ueContextId identifies the individual ueContext resource is composed by UE's SUPI or PEI. + +6.4.3.2.4.3.2 Operation Definition + +This operation shall support the request data structures specified in table 6.4.3.2.4.3.2-1 and the response data structure and response codes specified in table 6.4.3.2.4.3.2-2. + +**Table 6.4.3.2.4.3.2-1: Data structures supported by the (POST) provideLocInfo operation Request Body** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|------------------------------------------------| +| RequestLocInfo | M | 1 | The information to request the NPLI of the UE. | + +**Table 6.4.3.2.4.3.2-2: Data structures supported by the (POST) provide-loc-info operation Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ProvideLocInfo | M | 1 | 200 OK | This case represents a successful query of the NPLI of the target UE, the AMF returns the related information in the response. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403
Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- UNSPECIFIED

See table 6.4.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 404
Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT NOT_FOUND

See table 6.4.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.4.3.2.4.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.4.3.2.4.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**6.4.3.2.4.4 Operation: cancel-pos-info (POST)****6.4.3.2.4.4.1 Description** + +This ueContextId identifies the individual ueContext resource and is composed by UE's SUPI or PEI. + +**6.4.3.2.4.4.2 Operation Definition** + +This operation shall support the request data structures specified in table 6.4.3.2.4.4.2-1 and the response data structure and response codes specified in table 6.4.3.2.4.4.2-2. + +**Table 6.4.3.2.4.4.2-1: Data structures supported by the (POST) cancel-pos-info operation Request Body** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|-------------------------------------------------------------------| +| CancelPosInfo | M | 1 | The information to identify the location session to be cancelled. | + +**Table 6.4.3.2.4.4.2-2: Data structures supported by the (POST) cancel-pos-info operation Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents successful cancellation of location. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
  • - USER_UNKNOWN
  • - LOCATION_SESSION_UNKNOWN
  • - UNSPECIFIED
See table 6.4.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 504 Gateway Timeout | The "cause" attribute may be used to indicate one of the following application errors:
  • - UNREACHABLE_USER
  • - PEER_NOT_RESPONDING
See table 6.4.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.4.3.2.4.4.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.4.3.2.4.4.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.4.4 Custom Operations without associated resources + +There are no custom operations without associated resources supported on Namf\_Location service. + +## 6.4.5 Notifications + +### 6.4.5.1 General + +This clause provides the definition of the EventNotify notification of the Namf\_Location service. + +**Table 6.4.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------|---------------------------|---------------------------------|---------------------------------| +| Event Notify | {locationNotificationUri} | POST | | + +### 6.4.5.2 Event Notify + +#### 6.4.5.2.1 Description + +This resource represents the callback reference of the NF Service Consumer (e.g. GMLC) to receive LCS event notify. + +#### 6.4.5.2.2 Notification Definition + +Callback URI: {locationNotificationUri} + +See clause 5.5.2.3.1 for the description of how the AMF obtains the Callback URI of the NF Service Consumer (e.g. GMLC). + +#### 6.4.5.2.3 Notification Standard Methods + +##### 6.4.5.2.3.1 POST + +This method sends an LCS event notify to the NF Service Consumer. + +This method shall support the request data structures specified in table 6.4.5.2.3.1-1 and the response data structures and response codes specified in table 6.4.5.2.3.1-2. + +**Table 6.4.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|--------------------------------------------| +| NotifiedPosInfoEx
t | M | 1 | Representation of the LCS event(s) notify. | + +**Table 6.4.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents a successful notification of the LCS event. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.4.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.4.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.4.6 Data Model + +### 6.4.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.4.6.1-1 specifies the data types defined for the Namf\_Location service based interface protocol. + +**Table 6.4.6.1-1: Namf\_Location specific Data Types** + +| Data type | Clause defined | Description | +|------------------------------|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RequestPosInfo | 6.4.6.2.2 | Data within Provide Positioning Information Request | +| ProvidePosInfo | 6.4.6.2.3 | Data within Provide Positioning Information Response | +| NotifiedPosInfo | 6.4.6.2.4 | Data within EventNotify notification | +| RequestLocInfo | 6.4.6.2.5 | Data within Provide Location Information Request | +| ProvideLocInfo | 6.4.6.2.6 | Data within Provide Location Information Response | +| CancelPosInfo | 6.4.6.2.7 | Data within a Cancel Location Request | +| ProblemDetailsProvidePosInfo | 6.4.6.2.8 | Detailed problems with positioning information in failure case | +| AddProvidePosInfos | 6.4.6.2.9 | Additional UE positioning information with more than one corresponding UEs | +| AddNotifiedPosInfos | 6.4.6.2.10 | Additional LCS event notify with more than one corresponding UEs. | +| ProvidePosInfoExt | 6.4.6.2.11 | Data within Provide Positioning Information Response in addition to ProvidePosInfo for the UE positioning information with more than one corresponding UEs | +| NotifiedPosInfoExt | 6.4.6.2.12 | Data within EventNotify notification in addition to NotifiedPosInfo for LCS event notify with more than one corresponding UEs. | +| LocationType | 6.4.6.3.3 | Type of location measurement requested | +| LocationEvent | 6.4.6.3.4 | Type of events initiating location procedures | +| LocationPrivacyVerResult | 6.4.6.3.5 | The result of location privacy verification by UE | +| LpHapType | 6.4.6.3.6 | Type of Low Power and/or High Accuracy Positioning | + +Table 6.4.6.1-2 specifies data types re-used by the Namf\_Location service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Namf\_Location service based interface. + +**Table 6.4.6.1-2: Namf\_Location re-used Data Types** + +| Data type | Reference | Comments | +|-------------------------------|---------------------|---------------------------------------------------------------------------| +| Supi | 3GPP TS 29.571 [6] | Subscription Permanent Identifier | +| Gpsi | 3GPP TS 29.571 [6] | General Public Subscription Identifier | +| Pei | 3GPP TS 29.571 [6] | Permanent Equipment Identifier | +| ExternalClientType | 3GPP TS 29.572 [25] | LCS Client Type (Emergency, Lawful Interception ...) | +| LocationQoS | 3GPP TS 29.572 [25] | LCS QoS (accuracy, response time) | +| SupportedGADShapes | 3GPP TS 29.572 [25] | LCS supported GAD shapes | +| GeographicArea | 3GPP TS 29.572 [25] | Estimate of the location of the UE | +| AccuracyFulfilmentIndicator | 3GPP TS 29.572 [25] | Requested accuracy was fulfilled or not | +| AgeOfLocationEstimate | 3GPP TS 29.572 [25] | Age Of Location Estimate | +| PositioningMethodAndUsage | 3GPP TS 29.572 [25] | Usage of each non-GNSS positioning method | +| VelocityEstimate | 3GPP TS 29.572 [25] | Estimate of the velocity of the target UE | +| VelocityRequested | 3GPP TS 29.572 [25] | Indication of the Velocity requirement | +| LcsPriority | 3GPP TS 29.572 [25] | Priority of the LCS client | +| GnssPositioningMethodAndUsage | 3GPP TS 29.572 [25] | Usage of each GNSS positioning method | +| CivicAddress | 3GPP TS 29.572 [25] | Civic address | +| BarometricPressure | 3GPP TS 29.572 [25] | Barometric Pressure | +| Altitude | 3GPP TS 29.572 [25] | Altitude estimate of the UE | +| LocalArea | 3GPP TS 29.572 [25] | Local area specified by different shape | +| MinorLocationQoS | 3GPP TS 29.572 [25] | Minor Location QoS | +| Ecgi | 3GPP TS 29.571 [6] | UE EUTRAN cell information | +| Ncgi | 3GPP TS 29.571 [6] | UE NR cell information | +| SupportedFeatures | 3GPP TS 29.571 [6] | Supported Features | +| RatType | 3GPP TS 29.571 [6] | RAT type | +| TimeZone | 3GPP TS 29.571 [6] | Time Zone | +| DateTime | 3GPP TS 29.571 [6] | Date and Time | +| UserLocation | 3GPP TS 29.571 [6] | User Location | +| LcsServiceType | 3GPP TS 29.572 [25] | The LCS service type | +| LdrType | 3GPP TS 29.572 [25] | The type of LDR for deferred location | +| Uri | 3GPP TS 29.571 [6] | URI | +| LdrReference | 3GPP TS 29.572 [25] | LDR Reference Number for deferred location | +| LirReference | 3GPP TS 29.572 [25] | LIR Reference Number for immediate location | +| PeriodicEventInfo | 3GPP TS 29.572 [25] | Information for periodic event reporting | +| AreaEventInfo | 3GPP TS 29.572 [25] | Information for area event reporting | +| MotionEventInfo | 3GPP TS 29.572 [25] | Information for motion event reporting | +| ExternalClientId | 3GPP TS 29.515 [46] | External LCS client identification | +| NFInstanceId | 3GPP TS 29.571 [6] | Identification of an NF or AF | +| CodeWord | 3GPP TS 29.515 [46] | Codeword for a 5GC-MT-LR or deferred 5GC-MT-LR | +| LMFIdentification | 3GPP TS 29.572 [25] | Identification of a serving LMF for periodic or triggered location | +| TerminationCause | 3GPP TS 29.572 [25] | Termination cause for a deferred location | +| UePrivacyRequirements | 3GPP TS 29.515 [46] | The location related privacy requirements on UE | +| DiameterIdentity | 3GPP TS 29.571 [6] | Diameter Identity | +| ProblemDetails | 3GPP TS 29.571 [6] | Detailed problems in failure case | +| RedirectResponse | 3GPP TS 29.571 [6] | Response body of the redirect response message. | +| E164Number | 3GPP TS 29.503 [35] | The E.164 number. | +| DurationSec | 3GPP TS 29.571 [6] | Duration Second | +| ReportingArea | 3GPP TS 29.572 [25] | Indicates an area for event reporting | +| ReportingInd | 3GPP TS 29.515 [46] | Reporting Indication | +| RangingSIResult | 3GPP TS 29.572 [25] | Indicates result type for ranging and sidelink positioning | +| RelatedUE | 3GPP TS 29.572 [25] | Indicates information for related UE for ranging and sidelink positioning | +| LosNlosMeasureInd | 3GPP TS 29.572 [25] | LOS/NLOS measurement indication | +| IndoorOutdoorInd | 3GPP TS 29.572 [25] | Indicates Indoor Outdoor Indication | +| IntegrityRequirements | 3GPP TS 29.515 [46] | Integrity Requirements | +| HighAccuracyGnssMetrics | 3GPP TS 29.572 [25] | High Accuracy GNSS Metrics | + +| | | | +|----------------------|---------------------|------------------------------------------------------------------------------------| +| UpLocRepInfoAf | 3GPP TS 29.515 [46] | Information for the location reporting over user plane | +| MappedLocationQoSEps | 3GPP TS 29.572 [25] | Mapped Location QoS for EPS | +| RangeDirection | 3GPP TS 29.572 [25] | Represents the range and direction between two points. | +| 2DRelativeLocation | 3GPP TS 29.572 [25] | Represents 2D local co-ordinates with origin corresponding to another known point. | +| 3DRelativeLocation | 3GPP TS 29.572 [25] | Represents 3D local co-ordinates with origin corresponding to another known point. | + +## 6.4.6.2 Structured data types + +### 6.4.6.2.1 Introduction + +Structured data types used in Namf\_Location service are specified in this clause. + +6.4.6.2.2 Type: RequestPosInfo + +**Table 6.4.6.2.2-1: Definition of type RequestPosInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|---------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lcsClientType | ExternalClientType | M | 1 | This IE shall contain the type of LCS client (Emergency, Lawful Interception etc.,) issuing the location request | +| lcsLocation | LocationType | M | 1 | This IE shall contain the type of location measurement requested, such as current location, current or last known location, deferred location, etc.
(NOTE 2) | +| supi | Supi | C | 0..1 | If the SUPI is available, this IE shall be present. | +| gpsi | Gpsi | C | 0..1 | If the GPSI is available, this IE shall be present. | +| requestedRangingSIResult | array(RangingSIResult) | C | 1..N | This IE shall contain the type of result requested for ranging and sidelink positioning, such as absolute locations, relative locations or ranges and directions related to the UEs, etc. | +| relatedUEs | array(RelatedUE) | C | 1..N | This IE contains a list of the information for the related UEs for the ranging and sidelink positioning. | +| lmfId | LMFIdentification | O | 0..1 | LMF identification.
If present, this IE shall indicate the LMF ID that should be used to select the LMF. | +| priority | LcsPriority | O | 0..1 | If present, this IE shall contain the priority of the LCS client issuing the positioning request. | +| lcsQoS | LocationQoS | O | 0..1 | If present, this IE shall contain the quality of service requested, such as the accuracy of the positioning measurement and the response time of the positioning operation.

Multiple QoS Class (lcsQoSClass sets to "MULTIPLE_QOS") shall only be used when AMF support MUTIQOS feature. | +| velocityRequested | VelocityRequested | O | 0..1 | If present, this IE shall contain an indication of whether or not the Velocity of the target UE is requested. | +| lcsSupportedGADShapes | SupportedGADShapes | O | 0..1 | If present, this IE shall contain one GAD shape supported by the LCS client. | +| additionalSuppGADShapes | array(SupportedGADShapes) | C | 1..N | Shall be absent if lcsSupportedGADShapes is absent.
Shall be present if the LCS client supports more than one GAD shape. | +| locationNotificationUri | Uri | O | 0..1 | The callback URI on which location change event notification is reported. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.4.8 is supported. | +| oldGuami | Guami | C | 0..1 | This IE shall be present during an AMF planned removal procedure when the NF Service Consumer initiates a request towards the target AMF, for a UE associated to an AMF that is unavailable (see clause 5.21.2.2 of 3GPP TS 23.501 [2]). | +| pei | Pei | C | 0..1 | This IE shall be present if supi and gpsi are not available. | +| lcsServiceType | LcsServiceType | O | 0..1 | This IE contains the LCS service type for an external client.
(NOTE 1) | +| ldrType | LdrType | C | 0..1 | This IE contains the type of LDR for a deferred location request. This IE shall be present when lcsLocation is set to "DEFERRED_LOCATION". | +| hgmlcCallBackURI | Uri | C | 0..1 | This IE contains the callback URI of the H-GMLC. This IE shall be present when lcsLocation is set to "DEFERRED_LOCATION".

This IE shall also be present for location service in PNI-NPN with signalling optimisation, as specified in 3GPP TS 23.273 [42] clause 6.1.2. | +| lirGmlcCallBackUri | Uri | C | 0..1 | This IE shall be present when the intermediateLocationInd IE is present with the value "true". | + +| | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------| +| | | | | When present, this IE shall contain callback URI of the GMLC to receive the intermediate location reports. | +|--|--|--|--|------------------------------------------------------------------------------------------------------------| + +| | | | | | +|-------------------------|-----------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ldrReference | LdrReference | C | 0..1 | This IE contains the LDR Reference Number.
This IE shall be present when lcsLocation is set to "DEFERRED_LOCATION".

This IE shall be present for location service in PNI-NPN with signalling optimisation, as specified in 3GPP TS 23.273 [42] clause 6.1.2. | +| lirReference | LirReference | C | 0..1 | This IE shall be present when the intermediateLocationInd IE is present with the value "true".

When present, this IE shall contain the LIR Reference Number for a multiple location request | +| periodicEventInfo | PeriodicEventInfo | C | 0..1 | This IE contains information for periodic event reporting for a deferred location request. This IE shall be present when ldrType is set to "PERIODIC". | +| areaEventInfo | AreaEventInfo | C | 0..1 | This IE contains information for area event reporting for a deferred location request. This IE shall be present when ldrType is set to "ENTERING_INTO_AREA", "LEAVING_FROM_AREA" or "BEING_INSIDE_AREA". | +| motionEventInfo | MotionEventInfo | C | 0..1 | This IE contains information for motion event reporting for a deferred location request. This IE shall be present when ldrType is set to "MOTION". | +| externalClientId | ExternalClientId | O | 0..1 | This IE provides the external LCS client identification (e.g. the name of the LCS client).
(NOTE 1) | +| afID | NfInstanceId | O | 0..1 | This IE provides the identification of an AF that initiated the location request.
(NOTE 1) | +| codeWord | CodeWord | O | 0..1 | This IE provides a codeword for a location request which is provided by an external Client or AF and is sent to and verified by a target UE as part of privacy verification.
(NOTE 1) | +| uePrivacyRequirements | UePrivacyRequirements | O | 0..1 | If present, the IE provides the indication of location related notification or verification for the target UE, the indication of codeword check in UE | +| scheduledLocTime | DateTime | O | 0..1 | If present, the IE provides the scheduled UTC time that the UE needs to be located. | +| reliableLocReq | boolean | C | 0..1 | This IE shall be included with the value "true" to indicate that reliable UE location information is required, as specified in 3GPP TS 33.256 [57] clause 5.3.2.

When present, this IE shall be set as following:
- true: the reliable UE location information is required
- false (default): the reliable UE location information is not required | +| intermediateLocationInd | boolean | C | 0..1 | This IE shall be present with the value "true" to indicate the acceptance of intermediate location responses for the NF consumer (i.e., the GMLC), during a 5GC-MT-LR multiple location procedure for the regulatory location service (see clause 6.1.3 and clause 6.10.4 of 3GPP TS 23.273 [42]).

When present, this IE shall indicate the acceptance of intermediate location response at the NF consumer:
- true: intermediate location response acceptable
- false (default): intermediate location response not acceptable | +| maxRespTime | DurationSec | C | 0..1 | This IE shall be present when the intermediateLocationInd IE is present with the value "true". | + +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|---|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | When present, this IE shall contain the maximum response time for the NF consumer to receive the FINAL location response.

The AMF may overwrite the maximum response time when passing it to the LMF, e.g., to avoid timeout of the HTTP service request. | +| ueUnawareInd | boolean | C | 0..1 | This IE shall be included and set to "true", if the UE Unaware Positioning is required, as specified in clause 6.1.1 of 3GPP TS 23.273 [42].

Presence of this IE with false value shall be prohibited. | +| lpHapType | LpHapType | C | 0..1 | This IE shall be included and set to "LOW_POW_HIGH_ACCU_POS" to request low power and high accuracy positioning, as specified in clause 6.1.2 of 3GPP TS 23.273 [42]. | +| evtRptAllowedAreas | array(ReportingArea) | O | 1..250 | If present, this IE shall contain the list of event report allowed areas, where UE is allowed to generate and send the event report to network during the deferred 5GC-MT-LR procedure for UE power saving purpose. | +| reportingInd | ReportingInd | O | 0..1 | This IE may be present if the evtRptAllowedAreas is present.

When present, this IE shall indicate whether the UE is allowed to generate and send the reports inside or outside the event report allowed areas:
- Inside reporting (default)
- Outside reporting
(see 3GPP TS 23.273 [42] clause 5.14 and 6.3.1) | +| integrityRequirements | IntegrityRequirements | O | 0..1 | When present, this IE shall indicate the integrity requirements. | +| upLocRepInfoAf | UpLocRepInfoAf | C | 0..1 | This IE shall be present if the request is for the location reporting over user plane.
When present, the IE may include additional information for the location reporting over user plane. | +| mappedQoSEps | MappedLocationQoSEps | C | 0..1 | This IE may only be present if the Multiple QoS Class is indicated in the locationQoS IE.

When present, this IE shall indicate the mapped Location QoS applicable to EPS ("BEST EFFORT" or "ASSURED") based on the Multiple Location QoS (see clause 6.19 of 3GPP TS 23.273 [42]). | +| NOTE 1: At least one of these IEs should be present when uePrivacyCallSessionUnrelatedClass indicates notification and/or verification for the target UE. | | | | | +| NOTE 2: If the lcsLocation IE is set to value "NOTIFICATION_VERIFICATION_ONLY", then the lcsServiceAuthInfo attribute in the uePrivacyRequirements IE, if present, shall be set to either "NOTIFICATION_ONLY" or "NOTIFICATION_AND_VERIFICATION_ONLY". | | | | | + +## 6.4.6.2.3 Type: ProvidePosInfo + +**Table 6.4.6.2.3-1: Definition of type ProvidePosInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|--------------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| locationEstimate | GeographicArea | O | 0..1 | If present, this IE shall contain an estimate of the location of the UE in universal coordinates and the accuracy of the estimate. | | +| localLocationEstimate | LocalArea | O | 0..1 | When present, this IE shall indicate a local area in reference system. | | +| accuracyFulfilmentIndicator | AccuracyFulfilmentIndicator | O | 0..1 | If present, this IE shall contain an indication of whether the requested accuracy (as indicated in the LcsQoS in the request message) was fulfilled or not. | | +| ageOfLocationEstimate | AgeOfLocationEstimate | O | 0..1 | If present, this IE shall contain an indication of how long ago the location estimate was obtained. | | +| timestampOfLocationEstimate | DateTime | O | 0..1 | When present, this IE shall indicate the estimated UTC time when the location estimate corresponded to the UE location (i.e. when the location estimate and the actual UE location was the same). | | +| velocityEstimate | VelocityEstimate | O | 0..1 | If present, this IE shall contain an estimate of the velocity of the target UE, composed by horizontal speed, vertical speed, and their respective uncertainty. | | +| positioningDataList | array(PositioningMethodAndUsage) | O | 0..9 | If present, this IE shall indicate the usage of each non- GANSS positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. | | +| gnssPositioningDataList | array(GnssPositioningMethodAndUsage) | O | 0..9 | If present, this IE shall indicate the usage of each GANSS positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. | | +| ecgi | Ecgi | O | 0..1 | If present, this IE shall contain the current EUTRAN cell location of the target UE as delivered by the 5G-AN. | | +| ncgi | Ncgi | O | 0..1 | If present, this IE shall contain the current NR cell location of the target UE as delivered by the 5G-AN. | | +| targetServingNode | NfInstanceId | O | 0..1 | If present, this IE shall contain the address of the target side serving node for intra-5GS handover of an IMS Emergency Call. | | +| targetMmeName | DiameterIdentity | C | 0..1 | This IE shall be present for handover of IMS emergency call to EPS, i.e. the target node is an MME.

This IE may also be present for a handover from 5GS to EPS.

When present, this IE shall indicate the Diameter host name of the target MME. | | +| targetMmeRealm | DiameterIdentity | C | 0..1 | This IE shall be present for handover of IMS emergency call to EPS, i.e. the target node is an MME.

This IE may also be present for a handover from 5GS to EPS.

When present, this IE shall indicate the Diameter realm of the target MME. | | +| utranSrvccInd | boolean | C | 0..1 | This IE shall be present with value "true" for 5G-SRVCC to 3GPP UTRAN of IMS emergency call, i.e. target node is an MSC.

When present, this IE shall be set for the | | + +| | | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | following value:
  • - true: IMS emergency call handover to UTRAN
  • - false: No IMS emergency call handover to UTRAN
| | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|---------------------------|--------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| civicAddress | CivicAddress | O | 0..1 | If present, this IE contains a location estimate for the target UE expressed as a Civic address. | | +| barometricPressure | BarometricPressure | O | 0..1 | If present, this IE contains the barometric pressure measurement as reported by the target UE. | | +| altitude | Altitude | O | 0..1 | If present, this IE indicates the altitude of the positioning estimate. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.4.8 is supported. | | +| servingLMFIdentification | LMFIdentification | O | 0..1 | If present, this IE contains the identification of a serving LMF for periodic or triggered location | | +| locationPrivacyVerResult | LocationPrivacyVerResult | O | 0..1 | If present, this IE contains the result of location privacy verification by UE (NOTE) | | +| achievedQoS | MinorLocationQoS | C | 0..1 | When present, this IE shall contain the achieved Location QoS Accuracy of the estimated location.

This IE shall be present if received from LMF. | MUTIQOS | +| directReportInd | boolean | C | 0..1 | When present, this IE shall be set for the following value:
  • - true: location determination will be sent by LMF to GMLC directly
  • - false (default): location determination will not be sent by LMF to GMLC directly
This IE shall be present if received from LMF. | | +| acceptedPeriodicEventInfo | PeriodicEventInfo | C | 0..1 | This IE shall be present if received from LMF.

When present, this IE shall provide the accepted periodic event reporting information. | | +| haGnssMetrics | HighAccuracyGnssMetrics | C | 0..1 | This IE should be included when received from LMF.

When present, this IE shall indicate the high accuracy GNSS metrics for the location estimate. | | +| indoorOutdoorInd | IndoorOutdoorInd | O | 0..1 | When present, this IE shall indicate whether the UE is indoor or outdoor. | | +| losNlosMeasureInd | LosNlosMeasureInd | O | 0..1 | When present, this IE shall indicate whether LOS measurement or NLOS measurement is used. | | +| losNlosMeasureInd | LosNlosMeasureInd | O | 0..1 | When present, this IE shall indicate whether LOS measurement or NLOS measurement is used. | | +| relatedApplicationlayerId | ApplicationlayerId | O | 0..1 | Identifies the application layer ID of the related UE for ranging and sidelink positioning, such as located UE, reference UE, etc. | Ranging_SL | +| rangeDirection | RangeDirection | O | 0..1 | When present, this IE identifies a range and direction from a point A to a point B, comprising a range from point A to point B, an azimuth direction from point A to point B and an elevation direction from point A to point B. | Ranging_SL | +| 2dRelativeLocation | 2DRelativeLocation | O | 0..1 | When present, this IE identifies a relative 2D location with uncertainty ellipse, characterised by a point described in 2D | Ranging_SL | + +| | | | | | | +|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| | | | | local co-ordinates with origin corresponding to another known point, distances r1 and r2 and an angle of orientation A. | | +| 3dRelativeLocation | 3DRelativeLocation | O | 0..1 | When present, this IE identifies a relative 3D location with uncertainty ellipsoid, characterised by a point described in 3D local co-ordinates with origin corresponding to another known point, distances r1 (the "semi-major uncertainty"), r2 (the "semi-minor uncertainty") and r3 (the "vertical uncertainty") and an angle of orientation A (the "angle of the major axis"). | Ranging_SL | +| relativeVelocity | VelocityEstimate | O | 0..1 | When present, this IE identifies UE velocity relative to the UE identified with relatedApplicationLayerId. | Ranging_SL | +| NOTE: | The IE may be included to indicate the result of location privacy verification by UE to (H)GMLC when a location request with notification and privacy verification only indication is sent to the serving AMF by (H)GMLC during location request procedure. | | | | | + +6.4.6.2.4 Type: NotifiedPosInfo + +**Table 6.4.6.2.4-1: Definition of type NotifiedPosInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|--------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| locationEvent | LocationEvent | M | 1 | This IE shall contain the type of event that caused the location procedure to be initiated. | | +| supi | Supi | C | 0..1 | This IE shall contain the SUPI if available (see NOTE 1). | | +| gpsi | Gpsi | C | 0..1 | This IE shall contain the GPSI if available (see NOTE 1). | | +| pei | Pei | C | 0..1 | This IE shall contain the PEI if available (see NOTE 1). | | +| locationEstimate | GeographicArea | O | 0..1 | If present, this IE shall contain an estimate of the location of the UE in universal coordinates and the accuracy of the estimate. | | +| localLocationEstimate | LocalArea | O | 0..1 | When present, this IE shall indicate a local area in reference system. | | +| ageOfLocationEstimate | AgeOfLocationEstimate | O | 0..1 | If present, this IE shall contain an indication of how long ago the location estimate was obtained. | | +| timestampOfLocationEstimate | DateTime | O | 0..1 | When present, this IE shall indicate the estimated UTC time when the location estimate corresponded to the UE location (i.e. when the location estimate and the actual UE location was the same). | | +| velocityEstimate | VelocityEstimate | O | 0..1 | If present, this IE shall contain an estimate of the velocity of the target UE, composed by horizontal speed, vertical speed, and their respective uncertainty. | | +| positioningDataList | array(PositioningMethodAndUsage) | O | 0..9 | If present, this IE shall indicate the usage of each non-GNSS positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. | | +| gnssPositioningDataList | array(GNSSPositioningMethodAndUsage) | O | 0..9 | If present, this IE shall indicate the usage of each GNSS positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. | | +| ecgi | Ecgi | O | 0..1 | If present, this IE shall contain the current EUTRAN cell location of the target UE as delivered by the 5G-AN. | | +| ncgi | Ncgi | O | 0..1 | If present, this IE shall contain the current NR cell location of the target UE as delivered by the 5G-AN. | | +| servingNode | NfInstanceId | O | 0..1 | If present, this IE shall contain the address of the serving node. For intra-5GS handover of an IMS Emergency Call, this IE shall contain the address of the target side serving node. For mobility of a UE with periodic or triggered location, this IE shall contain the address of the new serving node, if available. | | +| targetMmeName | DiameterIdentity | C | 0..1 | This IE shall be present for handover of IMS emergency call to EPS, i.e. the target node is an MME.

When present, this IE shall indicate the Diameter host name of the target MME. | | +| targetMmeRealm | DiameterIdentity | C | 0..1 | This IE shall be present for handover of IMS emergency call to EPS, i.e. the target node is an MME.

When present, this IE shall indicate the Diameter realm of the target MME. | | +| utranSrvccInd | boolean | C | 0..1 | This IE shall be present with value "true" for 5G-SRVCC to 3GPP UTRAN of IMS emergency call, i.e. target node is an MSC.

When present, this IE shall be set for the | | + +| | | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------|--| +| | | | | following value:
true: IMS emergency call handover to
UTRAN
false: No IMS emergency call handover
to UTRAN | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|---------------------------|-------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| civicAddress | CivicAddress | O | 0..1 | If present, this IE contains a location estimate for the target UE expressed as a Civic address. | | +| barometricPressure | BarometricPressure | O | 0..1 | If present, this IE contains the barometric pressure measurement as reported by the target UE. | | +| altitude | Altitude | O | 0..1 | If present, this IE indicates the altitude of the positioning estimate. | | +| hgmlcCallBackURI | Uri | C | 0..1 | This IE contains the callback URI of the H-GMLC
This IE shall be included for a locationEvent related to deferred location when the consumer NF is not the H-GMLC. | | +| ldrReference | LdrReference | C | 0..1 | This IE contains an LDR Reference.
This IE shall be included for a locationEvent related to deferred location. | | +| servingLMFIdentification | LMFIdentification | C | 0..1 | This IE contains the identification of a serving LMF and shall be included for a locationEvent related to deferred location with periodic or triggered location if a serving LMF is used. | | +| terminationCause | TerminationCause | C | 0..1 | This IE indicates a reason for termination and shall be included for a locationEvent related to deferred location if deferred location has been terminated. | | +| achievedQos | MinorLocationQoS | O | 0..1 | When present, this IE shall contain the achieved Location QoS Accuracy of the estimated location.

This IE shall be present if received from LMF. | MUTIQOS | +| mscServerId | E164Number | O | 0..1 | This IE may be sent from AMF to GMLC, during a 5G-SRVCC handover from NG-RAN to UTRAN procedure.
When present, it shall contain the international E.164 number of the MSC Server selected by the MME_SRVCC. | | +| haGnssMetrics | HighAccuracyGnssMetrics | C | 0..1 | This IE should be included when received from LMF.

When present, this IE shall indicate the high accuracy GNSS metrics for the location estimate. | | +| indoorOutdoorInd | IndoorOutdoorInd | O | 0..1 | When present, this IE shall indicate whether the UE is indoor or outdoor. | | +| relatedApplicationlayerId | ApplicationlayerId | O | 0..1 | Identifies the application layer ID of the related UE for ranging and sidelink positioning, such as located UE, reference UE, etc. | Ranging_SL | +| rangeDirection | RangeDirection | O | 0..1 | When present, this IE identifies a range and direction from a point A to a point B, comprising a range from point A to point B, an azimuth direction from point A to point B and an elevation direction from point A to point B. | Ranging_SL | +| 2dRelativeLocation | 2DRelativeLocation | O | 0..1 | When present, this IE identifies a relative 2D location with uncertainty ellipse, characterised by a point described in 2D local co-ordinates with origin corresponding to another known point, distances r1 and r2 and an angle of orientation A. | Ranging_SL | +| 3dRelativeLocation | 3DRelativeLocation | O | 0..1 | When present, this IE identifies a relative 3D location with uncertainty ellipsoid, characterised by a point described in 3D local co-ordinates with origin corresponding to another known point, distances r1 (the "semi-major uncertainty"), r2 (the "semi- | Ranging_SL | + +| | | | | | | +|--------------------------------------------------------------------|------------------|---|------|------------------------------------------------------------------------------------------------------------------------|------------| +| | | | | minor uncertainty") and r3 (the "vertical uncertainty") and an angle of orientation A (the "angle of the major axis"). | | +| relativeVelocity | VelocityEstimate | O | 0..1 | When present, this IE identifies UE velocity relative to the UE identified with relatedApplicationlayerId. | Ranging_SL | +| NOTE 1: At least one of these IEs shall be present in the message. | | | | | | + +#### 6.4.6.2.5 Type: RequestLocInfo + +**Table 6.4.6.2.5-1: Definition of type RequestLocInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| req5gsLoc | boolean | C | 0..1 | This IE shall be present and set to "true", if 5GS location information is requested in NPLI.

When present, the IE shall be set as following:
- true: the location of the UE is requested
- false (default): the location of the UE is not requested | +| reqCurrentLoc | boolean | C | 0..1 | This IE may be present if 5GS location information is requested in NPLI.

When present, the IE shall be set as following:
- true: the current location of the UE is requested
- false (default): the current location of the UE is not requested | +| reqRatType | boolean | C | 0..1 | This IE shall be present and set to "true", if the RAT Type of the UE is requested in NPLI.

When present, the IE shall be set as following:
- true: the RAT type of the UE is requested
- false (default): the RAT type of the UE is not requested | +| reqTimeZone | boolean | C | 0..1 | This IE shall be present and set to "true", if the local timezone of the UE is requested in NPLI.

When present, the IE shall be set as following:
- true: the local timezone of the UE is requested
- false (default): the local timezone of the UE is not requested. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.4.8 is supported. | +| oldGuami | Guami | C | 0..1 | This IE shall be present during an AMF planned removal procedure when the NF Service Consumer initiates a request towards the target AMF, for a UE associated to an AMF that is unavailable (see clause 5.21.2.2 of 3GPP TS 23.501 [2]). | + +## 6.4.6.2.6 Type: ProvideLocInfo + +Table 6.4.6.2.6-1: Definition of type ProvideLocInfo + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| currentLoc | boolean | C | 0..1 | This IE shall be present, if the 5GS location information is requested by the NF Service consumer.

When present, this IE shall be set as following:
- true: the current location of the UE is returned
- false: the last known location of the UE is returned. | +| location | UserLocation | O | 0..1 | If present, this IE shall contain the location information of the UE.

This IE shall convey exactly one of the following:
- E-UTRA user location
- NR user location
- Non-3GPP access user location.

If the additionalLocation IE is present, this IE shall contain either an E-UTRA user location or NR user location. | +| additionalLocation | UserLocation | O | 0..1 | This IE shall be present if the "location IE" is present and the AMF reports both a 3GPP user location and a non-3GPP access user location.

When present, this IE shall convey the non-3GPP access user location. | +| geoInfo | GeographicArea | O | 0..1 | If present, this IE shall contain the geographical information of the UE (see NOTE 1). | +| locationAge | AgeOfLocationEstimate | O | 0..1 | If present, this IE shall contain the age of the location information (see NOTE 2). | +| ratType | RatType | O | 0..1 | If present, this IE shall contain the current RAT type of the UE. | +| timezone | TimeZone | O | 0..1 | If present, this IE shall contain the local time zone of the UE. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.4.8 is supported. | + +NOTE 1: If geographical information is returned by the AMF, it shall be encoded in the "geoInfo" attribute and the "geographicalInformation" attribute within the "location" attribute shall not be used. + +NOTE 2: If age of location estimate is returned by the AMF, it may be provided either in the "locationAge" attribute or in the "ageOfLocationInformation" attribute within the "location" attribute. + +## 6.4.6.2.7 Type: CancelPosInfo + +Table 6.4.6.2.7-1: Definition of type CancelPosInfo + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| supi | Supi | M | 1 | SUPI | +| hGmlcCallbackURI | Uri | M | 1 | Callback URI of the H-GMLC | +| ldrReference | LdrReference | M | 1 | LDR Reference | +| servingLMFIdentification | LMFIdentification | C | 0..1 | Serving LMF identification. This IE shall be included if available. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.4.8 is supported. | + +## 6.4.6.2.8 Type: ProblemDetailsProvidePosInfo + +**Table 6.4.6.2.8-1: Definition of type ProblemDetailsProvidePosInfo as a list of to be combined data types** + +| Data type | Cardinality | Description | Applicability | +|----------------|-------------|---------------------------------------------------------------------------------------------------|---------------| +| ProblemDetails | 1 | Detail information of the problem | | +| ProvidePosInfo | 1 | Additional information to be returned in error response. (See clause 6.19.1 of 3GPP 23.273 [42]). | | + +## 6.4.6.2.9 Type: AddProvidePosInfos + +**Table 6.1.6.2.9-1: Definition of type AddProvidePosInfos** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-----------------------|---|-------------|-----------------------------------|---------------| +| addProvidePosInfos | array(ProvidePosInfo) | O | 1..N | Contains a set of ProvidePosInfo. | | + +## 6.4.6.2.10 Type: AddNotifiedPosInfos + +**Table 6.1.6.2.10-1: Definition of type AddNotifiedPosInfos** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|------------------------|---|-------------|------------------------------------|---------------| +| addNotifiedPosInfos | array(NotifiedPosInfo) | O | 1..N | Contains a set of NotifiedPosInfo. | | + +## 6.4.6.2.11 Type: ProvidePosInfoExt + +**Table 6.4.6.2.11-1: Definition of type ProvidePosInfoExt as a list of data types to be combined** + +| Data type | Cardinality | Description | Applicability | +|--------------------|-------------|------------------------------------|---------------| +| ProvidePosInfo | 1 | Positioning information | | +| AddProvidePosInfos | 1 | Additional positioning information | | + +## 6.4.6.2.12 Type: NotifiedPosInfoExt + +**Table 6.4.6.2.12-1: Definition of type NotifiedPosInfoExt as a list of data types to be combined data** + +| Data type | Cardinality | Description | Applicability | +|---------------------|-------------|----------------------------------------|---------------| +| NotifiedPosInfo | 1 | Positioning event notify | | +| AddNotifiedPosInfos | 1 | Additional positioning event(s) notify | | + +## 6.4.6.3 Simple data types and enumerations + +## 6.4.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 6.4.6.3.2 Simple data types + +The simple data types defined in table 6.4.6.3.2-1 shall be supported. + +**Table 6.4.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|-----------------|-------------| +| | | | + +#### 6.4.6.3.3 Enumeration: LocationType + +The enumeration LocationType represents the type of location measurement requested. + +**Table 6.4.6.3.3-1: Enumeration LocationType** + +| Enumeration value | Description | +|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| "CURRENT_LOCATION" | This value indicates that the current location of the target UE is required. | +| "CURRENT_OR_LAST_KNOWN_LOCATION" | This value indicates that the current location or last known location of the target UE is required. | +| "NOTIFICATION_VERIFICATION_ONLY" | This value indicates that notification or verification of location by the target UE is required but a location estimate shall not be obtained. | +| "DEFERRED_LOCATION" | Deferred Location Request | + +#### 6.4.6.3.4 Enumeration: LocationEvent + +The enumeration LocationEvent represents the type of events initiating location procedures. + +**Table 6.4.6.3.4-1: Enumeration LocationEvent** + +| Enumeration value | Description | +|-------------------------------------|-------------------------------------------------------------------------------| +| "EMERGENCY_CALL_ORIGINATION" | Emergency session initiation | +| "EMERGENCY_CALL_RELEASE" | Emergency session termination | +| "EMERGENCY_CALL_HANDOVER" | Handover of an Emergency session | +| "ACTIVATION_OF_DEFERRED_LOCATION" | Confirmation of activation of periodic or triggered location in the target UE | +| "UE_MOBILITY_FOR_DEFERRED_LOCATION" | Mobility of the target UE to a different NF | +| "CANCELLATION_OF_DEFERRED_LOCATION" | Cancellation of a deferred location request | + +#### 6.4.6.3.5 Enumeration: LocationPrivacyVerResult + +The enumeration LocationPrivacyVerResult represents the type of the result of location privacy verification by UE. + +**Table 6.4.6.3.5-1: Enumeration LocationPrivacyVerResult** + +| Enumeration value | Description | +|------------------------|-------------------------------| +| "LOCATION_ALLOWED" | Location is allowed by UE | +| "LOCATION_NOT_ALLOWED" | Location is not allowed by UE | +| "RESPONSE_TIME_OUT" | UE response times out | + +#### 6.4.6.3.6 Enumeration: LpHapType + +The enumeration LpHapType represents the type of the Low Power and/or High Accuracy Positioning. + +**Table 6.4.6.3.6-1: Enumeration LpHapType** + +| Enumeration value | Description | +|-------------------------|-----------------------------------------| +| "LOW_POW_HIGH_ACCU_POS" | Low Power and High Accuracy Positioning | + +## 6.4.7 Error Handling + +### 6.4.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +### 6.4.7.2 Protocol Errors + +Protocol Error Handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.4.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.501 [5] may also be used for the Namf\_Location service, and the following application errors listed in Table 6.4.7.3-1 are specific for the Namf\_Location service. + +**Table 6.4.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------------|---------------------------|------------------------------------------------------------------------------------| +| USER_UNKNOWN | 403 Forbidden | The user is unknown. | +| DETACHED_USER | 403 Forbidden | The user is detached (i.e. it is in RM-DEREGISTERED state) in the AMF. | +| POSITIONING_DENIED | 403 Forbidden | The positioning procedure was denied. | +| UNSPECIFIED | 403 Forbidden | The request is rejected due to unspecified reasons. | +| LOCATION_SESSION_UNKNOWN | 403 Forbidden | The location session is unknown. | +| REQUESTED_LMF_NOT_AVAILABLE | 403 Forbidden | The request is rejected due to the AMF not being able to access the requested LMF. | +| CONTEXT_NOT_FOUND | 404 Not Found | The requested UE Context does not exist in the AMF. | +| HO_TO_EPS | 409 Conflict | The request is rejected due to a handover from 5GS to EPS. | +| POSITIONING_FAILED | 500 Internal Server Error | The positioning procedure failed. | +| UNREACHABLE_USER | 504 Gateway Timeout | The user could not be reached in order to perform positioning procedure. | +| PEER_NOT_RESPONDING | 504 Gateway Timeout | No response is received from a remote peer, e.g. from the LMF. | + +## 6.4.8 Feature Negotiation + +The feature negotiation mechanism specified in clause 6.6 of 3GPP TS 29.500 [4] shall be used to negotiate the optional features applicable between the AMF and the NF Service Consumer, for the Namf\_Location service, if any. + +The NF Service Consumer shall indicate the optional features it supports for the Namf\_Location service, if any, by including the supportedFeatures attribute in content of the HTTP Request Message for following service operations: + +- ProvidePositioningInfo, as specified in clause 5.5.2.2; +- ProvideLocationInfo, as specified in clause 5.5.2.4; +- CancelLocation, as specified in clause 5.5.2.5 + +The AMF shall determine the supported features for the service operations as specified in clause 6.6 of 3GPP TS 29.500 [4] and shall indicate the supported features by including the supportedFeatures attribute in content of the HTTP response for the service operation. + +The syntax of the supportedFeatures attribute is defined in clause 5.2.2 of 3GPP TS 29.571 [6]. + +The following features are defined for the Namf\_Location service. + +**Table 6.1.8-1: Features of supportedFeatures attribute used by Namf\_Location service** + +| Feature Number | Feature | M/O | Description | +|----------------|------------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ES3XX | M | Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. GMLC) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the Namf_Location service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | +| 2 | MUTIQOS | O | Support of Multiple Location QoSes.

This feature bit indicates whether the AMF support that more than one Location QoSes during consuming location service are required. | +| 3 | Ranging_SL | O | This feature supports the enhanced location exposure service (e.g. location information for ranging and sidelink positioning), and requires the support of eLCS feature.
The feature is not applicable to pre-5G (e.g. 4G). | + +Feature number: The order number of the feature within the supportedFeatures attribute (starting with 1). +Feature: A short name that can be used to refer to the bit and to the feature. +M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O"). +Description: A clear textual description of the feature. + +## 6.4.9 Security + +As indicated in 3GPP TS 33.501 [27], the access to the Namf\_Location API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [28]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [29]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Namf\_Location API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [29], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Namf\_Location service. + +The Namf\_Location API defines scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [27]; it defines a single scope consisting on the name of the service (i.e., "namf-loc"), and it does not define any additional scopes at resource or operation level. + +## 6.4.10 HTTP redirection + +An HTTP request may be redirected to a different AMF service instance, within the same AMF or a different AMF of an AMF set, e.g. when an AMF service instance is part of an AMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See the ES3XX feature in clause 6.4.8. + +An SCP that reselects a different AMF producer instance will return the NF Instance ID of the new AMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an AMF within an AMF set redirects a service request to a different AMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new AMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.5 Namf\_MBSBroadcast Service API + +### 6.5.1 API URI + +The Namf\_MBSBroadcast service shall use the Namf\_MBSBroadcast API. + +The API URI of the Namf\_MBSBroadcast API shall be: + +**{apiRoot}/** + +The request URI used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "namf-mbs-bc". +- The shall be "v1". +- The shall be set as described in clause 6.5.3. + +### 6.5.2 Usage of HTTP + +#### 6.5.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [19], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Namf\_MBSBroadcast service shall comply with the OpenAPI [23] specification contained in Annex A. + +#### 6.5.2.2 HTTP standard headers + +##### 6.5.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.5.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [8], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 9457 [36]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +Multipart messages shall also be supported (see clause 6.5.2.4) using the content type "multipart/related", comprising: + +- one JSON body part with the "application/json" content type; and +- one or more binary body parts with 3gpp vendor specific content subtypes. + +The 3gpp vendor specific content subtypes defined in Table 6.5.2.2.2-1 shall be supported. + +**Table 6.5.2.2.2-1: 3GPP vendor specific content subtypes** + +| content subtype | Description | +|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| vnd.3gpp.ngap | Binary encoded content, encoding NG Application Protocol (NGAP) IEs, as specified in clause 9.3 of 3GPP TS 38.413 [9] (ASN.1 encoded). | +| NOTE: | Using 3GPP vendor content subtypes allows to describe the nature of the opaque content (i.e. NGAP information) without having to rely on metadata in the JSON content. | + +See clause 6.5.2.4 for the binary contents supported in the binary body part of multipart messages. + +## 6.5.2.3 HTTP custom headers + +### 6.5.2.3.1 General + +In this release of this specification, no custom headers specific to the Namf\_MBSBroadcast service are defined. For 3GPP specific HTTP custom headers used across all service-based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.5.2.4 HTTP multipart messages + +HTTP multipart messages shall be supported, to transfer opaque N2 Information in the following service operations (and HTTP messages): + +- ContextCreate Request and Response (POST); +- ContextUpdate Request and Response (POST); +- ContextStatusNotify service operation (POST). + +HTTP multipart messages shall include one JSON body part and one or more binary body parts comprising: + +- N2 payload (see clause 6.1.6.4). + +The JSON body part shall be the "root" body part of the multipart message. It shall be encoded as the first body part of the multipart message. The "Start" parameter does not need to be included. + +The multipart message shall include a "type" parameter (see IETF RFC 2387 [9]) specifying the media type of the root body part, i.e. "application/json". + +- NOTE: The "root" body part (or "root" object) is the first body part the application processes when receiving a multipart/related message, see IETF RFC 2387 [9]. The default root is the first body within the multipart/related message. The "Start" parameter indicates the root body part, e.g. when this is not the first body part in the message. + +For each binary body part in a HTTP multipart message, the binary body part shall include a Content-ID header (see IETF RFC 2045 [10]), and the JSON body part shall include an attribute, defined with the RefToBinaryData type, that contains the value of the Content-ID header field of the referenced binary body part. + +## 6.5.3 Resources + +### 6.5.3.1 Overview + +![Figure 6.5.3.1-1: Resource URI structure of the Namf_MBSBroadcast Service API. The diagram shows a hierarchical tree structure of URI paths. The root is {apiRoot}/namf-mbs-bc/{apiVersion}. It branches to /mbs-contexts. This branches to /{mbsContextRef}. Finally, /{mbsContextRef} branches to /update, which is shown in a dashed box.](f00bfb547ad2bc48f7d04944cbedcb8e_img.jpg) + +``` + +graph TD + Root["{apiRoot}/namf-mbs-bc/{apiVersion}"] --> MBSContexts["/mbs-contexts"] + MBSContexts --> MBSContextRef["/{mbsContextRef}"] + MBSContextRef --> Update["/update"] + style Update stroke-dasharray: 5 5 + +``` + +Figure 6.5.3.1-1: Resource URI structure of the Namf\_MBSBroadcast Service API. The diagram shows a hierarchical tree structure of URI paths. The root is {apiRoot}/namf-mbs-bc/{apiVersion}. It branches to /mbs-contexts. This branches to /{mbsContextRef}. Finally, /{mbsContextRef} branches to /update, which is shown in a dashed box. + +**Figure 6.5.3.1-1: Resource URI structure of the Namf\_MBSBroadcast Service API** + +Table 6.5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.5.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description (service operation) | +|-------------------------------------------|--------------------------------------|---------------------------------|---------------------------------| +| Broadcast MBS session contexts collection | /mbs-contexts | POST | ContextCreate | +| Individual broadcast MBS session context | /mbs-contexts/{mbsContextRef}/update | update (POST) | ContextUpdate | +| | /mbs-contexts/{mbsContextRef} | DELETE | ContextRelease | + +### 6.5.3.2 Resource: Broadcast MBS session contexts collection + +#### 6.5.3.2.1 Description + +This resource represents a collection of Broadcast MBS session contexts created by NF service consumers of the Namf\_MBSBroadcast service. + +This resource is modelled as the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +#### 6.5.3.2.2 Resource Definition + +Resource URI: {apiRoot}/namf-mbs-bc/{apiVersion}/mbs-contexts + +This resource shall support the resource URI variables defined in table 6.5.3.2.2-1. + +**Table 6.5.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|-------------------| +| apiRoot | string | See clause 6.5.1 | +| apiVersion | string | See clause 6.5.1. | + +### 6.5.3.2.3 Resource Standard Methods + +#### 6.5.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.5.3.2.3.1-1. + +**Table 6.5.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.5.3.2.3.1-2 and the response data structures and response codes specified in table 6.5.3.2.3.1-3. + +**Table 6.5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-----------------------------------| +| ContextCreateReqData | M | 1 | Data within ContextCreate Request | + +**Table 6.5.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|---------------------------|------------------------------------------------| +| ContextCreateRspData | M | 1 | 201
Created | Successful creation of a broadcast MBS context | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.5.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/namf-mbs-bc//mbs-contexts/{mbsContextRef} | + +**Table 6.5.3.2.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.5.3.2.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.5.3.2.4 Resource Custom Operations + +None. + +## 6.5.3.3 Resource: Individual broadcast MBS session context + +### 6.5.3.3.1 Description + +This resource represents an Individual broadcast MBS session context created by an NF service consumer of the Namf\_MBSBroadcast service. + +This resource is modelled as the Document resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +### 6.5.3.3.2 Resource Definition + +Resource URI: {apiRoot}/namf-mbs-bc//mbs-contexts/{mbsContextRef} + +This resource shall support the resource URI variables defined in table 6.5.3.3.2-1. + +**Table 6.5.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------------|-----------|----------------------------------------------------------------| +| apiRoot | string | See clause 6.5.1 | +| apiVersion | string | See clause 6.5.1 | +| mbsContextRef | string | String identifying an individual broadcast MBS session context | + +### 6.5.3.3.3 Resource Standard Methods + +#### 6.5.3.3.3.1 DELETE + +This method shall support the URI query parameters specified in table 6.5.3.3.3.1-1. + +**Table 6.5.3.3.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.5.3.3.3.1-2 and the response data structures and response codes specified in table 6.5.3.3.3.1-3. + +**Table 6.5.3.3.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.5.3.3.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------| +| n/a | | | 204 No Content | Successful deletion of a broadcast MBS context | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.5.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.5.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.5.3.3.4 Resource Custom Operations + +### 6.5.3.2.4.1 Overview + +**Table 6.5.3.2.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------|-------------------------------------|--------------------|---------------------------------| +| update | /mbscontexts/{mbsContextRef}/update | POST | ContextUpdate service operation | + +### 6.5.3.2.4.2 Operation: update (POST) + +#### 6.5.3.2.4.2.1 Description + +This {mbsContextRef} identifies the individual broadcast MBS session context to be updated. + +#### 6.5.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.5.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.5.3.2.4.2.2-2. + +**Table 6.5.3.2.4.2.2-1: Data structures supported by (POST) the update operation Request Body** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|---------------------------------------| +| ContextUpdateReqData | M | 1 | Data within the ContextUpdate Request | + +**Table 6.5.3.2.4.2.2-2: Data structures supported by the (POST) update operation Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------| +| ContextUpdateRspData | M | 1 | 200 OK | Successful update of the broadcast MBS session context, with content in the response | +| n/a | | | 204 No Content | Successful update of the broadcast MBS session context, without content in the response | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.5.3.2.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.5.3.2.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.5.4 Custom Operations without associated resources + +There are no custom operations without associated resources supported by the Namf\_MBSBroadcast Service in this release of the specification. + +## 6.5.5 Notifications + +### 6.5.5.1 General + +This clause specifies the notifications provided by the Namf\_MBSBroadcast service. + +**Table 6.5.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|---------------------------------------------------|--------------|---------------------------------|---------------------------------| +| Broadcast MBS Session Context Status Notification | {notifyUri} | POST | ContextStatusNotify | + +## 6.5.5.2 Broadcast MBS Session Context Status Notification + +### 6.5.5.2.1 Description + +The Broadcast MBS session context notification is used by the AMF to report one or several status changes of a Broadcast MBS session context to a NF service consumer. + +### 6.5.5.2.2 Target URI + +The Callback URI "{notifyUri}" shall be used with the callback URI variables defined in table 6.5.5.2.2-1. + +**Table 6.5.5.2.2-1: Callback URI variables** + +| Name | Definition | +|-----------|-----------------------------------------------| +| notifyUri | String formatted as URI with the Callback URI | + +### 6.5.5.2.3 Notification Standard Methods + +#### 6.5.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.5.5.2.3.1-1 and the response data structures and response codes specified in table 6.5.5.2.3.1-2. + +**Table 6.5.5.2.3.1-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|---------------------------------------------| +| ContextStatusNotification | M | 1 | Represents the notification to be delivered | + +**Table 6.5.5.2.3.1-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------|---|-------------|------------------------|-------------------------------------| +| n/a | | | 204 No Content | Successful response without content | +| ContextStatusNotificationResponse | M | 1 | 200 OK | Successful response with content | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.5.5.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.5.5.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.5.6 Data Model + +### 6.5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.5.6.1-1 specifies the data types defined for the Namf\_MBSBroadcast service based interface protocol. + +**Table 6.5.6.1-1: Namf\_MBSBroadcast specific Data Types** + +| Data type | Clause defined | Description | +|-----------------------------------|----------------|------------------------------------------| +| ContextCreateReqData | 6.5.6.2.2 | Data within ContextCreate Request | +| ContextCreateRspData | 6.5.6.2.3 | Data within ContextCreate Response | +| ContextStatusNotification | 6.5.6.2.4 | Data within ContextStatusNotify Request | +| ContextUpdateReqData | 6.5.6.2.5 | Data within ContextUpdate Request | +| ContextUpdateRspData | 6.5.6.2.6 | Data within ContextUpdate Response | +| N2MbsSmlInfo | 6.5.6.2.7 | N2 MBS Session Management Information | +| OperationEvent | 6.5.6.2.8 | Operation Event | +| NgranFailureEvent | 6.5.6.2.9 | NG-RAN failure event | +| ContextStatusNotificationResponse | 6.5.6.2.10 | Data within ContextStatusNotify Response | +| OperationStatus | 6.5.6.3.3 | Operation Status | +| NgapleType | 6.5.6.3.4 | NGAP Information Element Type | +| OpEventType | 6.5.6.3.5 | Operation Event Type | +| NgranFailureIndication | 6.5.6.3.6 | Indication of a NG-RAN failure event | + +Table 6.5.6.1-2 specifies data types re-used by the Namf service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Namf service based interface. + +**Table 6.5.6.1-2: Namf re-used Data Types** + +| Data type | Reference | Comments | +|---------------------|--------------------|-------------------------------------------------------------------| +| MbsSessionId | 3GPP TS 29.571 [6] | MBS Session Id | +| AreaSessionId | 3GPP TS 29.571 [6] | Area Session Id | +| MbsServiceArea | 3GPP TS 29.571 [6] | MBS Service Area | +| RefToBinaryData | 3GPP TS 29.571 [6] | Reference to binary body part | +| Uri | 3GPP TS 29.571 [6] | URI | +| DurationSec | 3GPP TS 29.571 [6] | Duration in seconds | +| MbsServiceAreaInfo | 3GPP TS 29.571 [6] | MBS Service Area Information for a Location dependent MBS session | +| GlobalRanNodeId | 3GPP TS 29.571 [6] | Global RAN Node Identifier | +| AssociatedSessionId | 3GPP TS 29.571 [6] | Associated Session ID | + +## 6.5.6.2 Structured data types + +### 6.5.6.2.1 Introduction + +Structured data types used in Namf\_MBSSroadcast service are specified in this clause. + +### 6.5.6.2.2 Type: ContextCreateReqData + +**Table 6.5.6.2.2-1: Definition of type ContextCreateReqData** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|---------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbsSessionId | MbsSessionId | M | 1 | MBS Session ID | +| mbsServiceArea | MbsServiceArea | C | 1 | MBS Service Area
This IE shall be present if this is a Local broadcast MBS session. (NOTE 1) | +| mbsServiceAreaInfoList | array(MbsServiceAreaInfo) | C | 1..N | List of MBS service areas and their related Area Session IDs.
This IE shall be present if this is a Location dependent broadcast MBS service. (NOTE 1) | +| n2MbsSmInfo | N2MbsSmInfo | M | 1 | This IE shall be present and shall contain N2 MBS Session Management related information.(see clause 6.5.6.4). | +| notifyUri | Uri | M | 1 | This IE shall contain the notification URI where to be notified about the status change of the broadcast MBS session context. | +| maxResponseTime | DurationSec | O | 0..1 | Maximum response time (in seconds) to receive information about the completion of the Broadcast MBS session establishment. | +| snssai | Snssai | M | 1 | This IE shall be included to indicate the S-NSSAI of the MBS session. (NOTE 2). | +| mbsmfId | NfInstanceId | O | 0..1 | This IE may be present to contain the NF Instance ID of the MB-SMF. | +| mbsmfServiceInstanceId | string | O | 0..1 | This IE may be present to contain the NF Service Instance ID within the NF Instance of the MB-SMF. | +| associatedSessionId | AssociatedSessionId | O | 0..1 | Associated Session ID to enable NG-RAN to identify the multiple MBS sessions delivering the same content when AF creates multiple broadcast MBS Sessions via different Core Networks to deliver the same content. | + +NOTE 1: Either the mbsServiceAreaInfoList IE or the mbsServiceArea IE shall be present. +NOTE 2: If an MB-SMF does not receive the S-NSSAI from the NEF/MBSF, the MB-SMF shall include a pre-configured default SNSSAI. + +### 6.5.6.2.3 Type: ContextCreateRspData + +**Table 6.5.6.2.3-1: Definition of type ContextCreateRspData** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbsSessionId | MbsSessionId | M | 1 | MBS session identifier. | +| n2MbsSmInfoList | array(N2MbsSmInfo) | O | 1..10 | When present, this IE shall contain N2 MBS Session Management related information.(see clause 6.5.6.4). | +| operationStatus | OperationStatus | C | 0..1 | This IE shall be present and indicate the completion of the MBS session start operation, if the AMF received the NG-RAN responses from all involved NG-RAN(s). (NOTE) | + +NOTE: If this IE is not present, it indicates either of the following conditions (a) not all response are received from NG-RANs, while the maximum response timer is still running, or (b) the AMF has not received the maximum response timer in the request from the MB-SMF and not all response are received from NG-RANs. + +## 6.5.6.2.4 Type: ContextStatusNotification + +Table 6.5.6.2.4-1: Definition of type ContextStatusNotification + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbsSessionId | MbsSessionId | M | 1 | MBS Session ID | +| areaSessionId | AreaSessionId | C | 0..1 | Area Session ID
This IE shall be present if this is a Location dependent broadcast MBS service. | +| n2MbsSmInfoList | array(N2MbsSmInfo) | O | 1..10 | When present, this IE shall contain N2 MBS Session Management related information.(see clause 6.5.6.4). | +| operationStatus | OperationStatus | C | 0..1 | This IE shall be present and indicate the completion of the MBS session start or update operation, if the NF Service Consumer has requested to establish or update the Broadcast MBS session context and a response has been received from all NG-RANs.

This IE shall be present and indicate the incompletion of the MBS session start or update operation, if the NF Service Consumer has requested to establish or update the Broadcast MBS session context within a maximum response time and the AMF has not received responses from all NG-RANs before the maximum response time elapses.
(NOTE) | +| operationEvents | array(OperationEvent) | O | 1..N | This IE may be present to report a list of operation events related to the Broadcast MBS Session, e.g., when the Broadcast MBS Session is released in one of NG-RANs as required by the NG-RAN, a failure of a NG-RAN. | +| releasedInd | boolean | C | 0..1 | This shall be present and set to "true" if all NG-RANs serving the Broadcast MBS session requested the AMF to release the Broadcast MBS session and the Broadcast MBS session (context) has been released in the AMF. | +| NOTE: | If this IE is not present, it indicates either of the following conditions (a) not all response are received from NG-RANs, while the maximum response timer is still running, or (b) the AMF has not received the maximum response timer in the request from the MB-SMF and not all response are received from NG-RANs. | | | | + +## 6.5.6.2.5 Type: ContextUpdateReqData + +Table 6.5.6.2.5-1: Definition of type ContextUpdateReqData + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------------------------------------------------------------|---------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbsServiceArea | MbsServiceArea | O | 0..1 | MBS Service Area

This IE may be present for a Location independent broadcast MBS session.
(NOTE) | +| mbsServiceAreaInfoList | array(MbsServiceAreaInfo) | O | 1..N | List of MBS service areas and their related Area Session IDs.
This IE may be present for a Local broadcast MBS service.
(NOTE) | +| n2MbsSmInfo | N2MbsSmInfo | O | 0..1 | When present, this IE shall contain N2 MBS Session Management related information.(see clause 6.5.6.4). | +| ranIdList | array(GlobalRanNodeId) | O | 1..N | This IE may be included when the MBS session update is to be performed only in a list of specific NG-RAN(s) as specified in clause 8.3.2.3 of 3GPP TS 23.527 [33]). | +| noNgapSignallingInd | boolean | O | 0..1 | This IE may be present during the restoration procedure to select an alternative AMF for a Broadcast MBS Session at AMF failure as specified in clause 8.3.2.4 of 3GPP TS 23.527 [33]).

When present, this IE shall be set as following:
- true: the AMF may consider to not trigger a NGAP signaling message to any NG-RAN. | +| notifyUri | Uri | O | 0..1 | When present, this IE shall contain the notification URI where to be notified about the status change of the broadcast MBS session context. | +| maxResponseTime | DurationSec | O | 0..1 | Maximum response time (in seconds) to receive information about the completion of the Broadcast MBS session update. | +| n2MbsInfoChangeInd | boolean | O | 0..1 | When present, this IE shall indicate whether the information within the N2 MBS Session Management container has changed or not, as follows:
- true: the information has changed;

- false: the information has not changed. | +| NOTE: Either the mbsServiceAreaInfoList IE or the mbsServiceArea IE may be present. | | | | | + +## 6.5.6.2.6 Type: ContextUpdateRspData + +Table 6.5.6.2.6-1: Definition of type ContextUpdateRspData + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n2MbsSmInfoList | array(N2MbsSmInfo) | O | 1..10 | When present, this IE shall contain N2 MBS Session Management related information.(see clause 6.5.6.4). | +| operationStatus | OperationStatus | C | 0..1 | This IE shall be present and indicate the completion of the MBS session start operation, if the AMF received the NG-RAN responses from all involved NG-RAN(s). (NOTE) | +| NOTE: If this IE is not present, it indicates either of the following conditions (a) not all response are received from NG-RANs, while the maximum response timer is still running, or (b) the AMF has not received the maximum response timer in the request from the MB-SMF and not all response are received from NG-RANs. | | | | | + +## 6.5.6.2.7 Type: N2MbsSmInfo + +Table 6.5.6.2.7-1: Definition of type N2MbsSmInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ngapType | NgapType | M | 1 | This IE shall indicate the NGAP IE type of the ngapData as specified in clause 6.5.6.3.4. | +| ngapData | RefToBinaryData | M | 1 | This IE shall contain the reference to the binary data part carrying the NGAP data. | +| ranId | GlobalRanNodeId | M | 1 |

This IE shall indicate the Global RAN ID of the gNB that generated the N2 MBS Session Management related information, or of the gNB towards which the N2 MBS Session Management related information is to be sent.

The IE shall be present when the N2MbsSmInfo is included in the ContextCreate Response, ContextUpdate Response, or ContextStatusNotify Request messages which are sent from the AMF to the NF service consumer (e.g., MB-SMF).

The IE shall be present when the N2MbsSmInfo is included in the ContextStatusNotify Response messages which are sent from the NF service consumer (e.g., MB-SMF) to the AMF.

| + +## 6.5.6.2.8 Type: OperationEvent + +Table 6.5.6.2.8-1: Definition of type OperationEvent + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|--------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| opEventType | OpEventType | M | 1 | Indicates the event type of an operation event related to the Broadcast MBS Session. | +| amfId | NfInstanceId | C | 0..1 | This IE shall be present to contain the NF Instance ID of the AMF sending the Context Status Notify Request message if the operation event type indicates an AMF change event. | +| ngranFailureEventList | array(NgranFailureEvent) | C | 1..N | This IE shall be present if the event type is related to a NG-RAN. | + +## 6.5.6.2.9 Type: NgranFailureEvent + +Table 6.5.6.2.9-1: Definition of type NgranFailureEvent + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|------------------------|---|-------------|--------------------------------------------------------------------------| +| ngranId | GlobalRanNodeId | M | 1 | Indicates the identity of the RAN node. The IE shall contain the gNB ID. | +| ngranFailureIndication | NgranFailureIndication | M | 1 | This IE shall contain the information related to the NG-RAN failure. | + +### 6.5.6.2.10 Type: ContextStatusNotificationResponse + +**Table 6.5.6.2.10-1: Definition of type ContextStatusNotificationResponse** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------| +| mbsSessionId | MbsSessionId | M | 1 | MBS Session ID | +| areaSessionId | AreaSessionId | C | 0..1 | Area Session ID
This IE shall be present if this is a Location dependent broadcast MBS service. | +| n2MbsSmInfoList | array(N2MbsSmInfo) | O | 1..10 | When present, this IE shall contain N2 MBS Session Management related information.(see clause 6.5.6.4). | + +### 6.5.6.3 Simple data types and enumerations + +#### 6.5.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 6.5.6.3.2 Simple data types + +The simple data types defined in table 6.5.6.3.2-1 shall be supported. + +**Table 6.5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|-----------------|-------------| +| | | | + +#### 6.5.6.3.3 Enumeration: OperationStatus + +The enumeration OperationStatus represents the status of a Broadcast MBS session start or update operation. + +**Table 6.5.6.3.3-1: Enumeration OperationStatus** + +| Enumeration value | Description | +|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "MBS_SESSION_START_COMPLETE" | This value indicates the completion of the Broadcast MBS session establishment, i.e. that the AMF has received a response from all NG-RANs. | +| "MBS_SESSION_START_INCOMPLETE" | This value indicates the incompletion of the Broadcast MBS session establishment because the AMF has not received responses from all NG-RANs before the maximum response time that was indicated in the request elapses. | +| "MBS_SESSION_UPDATE_COMPLETE" | This value indicates the completion of the Broadcast MBS session update, i.e. that the AMF has received a response from all NG-RANs. | +| "MBS_SESSION_UPDATE_INCOMPLETE" | This value indicates incompletion of the Broadcast MBS session update because the AMF has not received responses from all NG-RANs before the maximum response time that was indicated in the request elapses. | + +### 6.5.6.3.4 Enumeration: NgapleType + +**Table 6.5.6.3.4-1: Enumeration NgapleType** + +| Enumeration value | Description | +|-------------------|-----------------------------------------------------| +| "MBS_SES_REQ" | MBS Session Setup or Modification Request Transfer | +| "MBS_SES_RSP" | MBS Session Setup or Modification Response Transfer | +| "MBS_SES_FAIL" | MBS Session Setup or Modification Failure Transfer | +| "MBS_SES_REL_RSP" | MBS Session Release Response Transfer | +| "BC_TRA_REQ" | Broadcast Transport Request Transfer | +| "BC_TRA_RSP" | Broadcast Transport Response Transfer | +| "BC_TRA_FAIL" | Broadcast Transport Failure Transfer | + +### 6.5.6.3.5 Enumeration: OpEventType + +**Table 6.5.6.3.5-1: Enumeration: OpEventType** + +| Enumeration value | Description | +|-------------------|-------------------------------------------------------------------------------------------------------| +| "AMF_CHANGE" | This value indicates that the AMF has taken over of the Broadcast MBS Session. | +| "NG_RAN_EVENT" | This value indicates that an event related to a NG-RAN for the Broadcast MBS Session has taken place. | + +### 6.5.6.3.6 Enumeration: NgranFailureIndication + +The enumeration NgranFailureIndication indicates a NG-RAN failure event. + +**Table 6.5.6.3.6-1: Enumeration NgranFailureIndication** + +| Enumeration value | Description | +|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| "NG_RAN_RESTART_OR_START" | This value indicates that the AMF has detected a (re)start of a NG-RAN. | +| "NG_RAN_FAILURE_WITHOUT_RESTART" | This value indicates that the AMF has detected a NG-RAN failure without a restart. | +| "NG_RAN_NOT_REACHABLE" | This value indicates that the AMF has failed to reach the NG-RAN when sending a NGAP MBS Session Setup/Modification/Release Request message. | +| "NG_RAN_REQUIRED_RELEASE" | This value indicates that the NG-RAN has requested to release the Broadcast MBS Session in the NG-RAN. | + +## 6.5.6.4 Binary data + +### 6.5.6.4.1 Introduction + +This clause defines the binary data that shall be supported in a binary body part in an HTTP multipart message (see clauses 6.5.2.2.2 and 6.5.2.4). + +**Table 6.5.6.4.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|----------------|----------------|---------------| +| N2 Information | 6.5.6.4.3 | vnd.3gpp.ngap | + +#### 6.5.6.4.2 N2 Information + +##### 6.5.6.4.2.1 Introduction + +N2 Information shall encode NG Application Protocol (NGAP) IEs, as specified in clause 9.3.A of 3GPP TS 38.413 [12] (ASN.1 encoded), using the vnd.3gpp.ngap content-type. + +##### 6.5.6.4.2.2 NGAP IEs + +N2 Information may encode following NGAP MB-SMF related IE specified in clause 9.3.5 of 3GPP TS 38.413 [12], as summarized in Table 6.5.6.4.2.2-1. + +**Table 6.5.6.4.2.2-1: N2 Information content for class MBS-SM** + +| NGAP IE | Reference
(3GPP TS 38.413 [12]) | Related NGAP message | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|-----------------------------------------------------------------------------| +| MBS Session Setup or Modification Request Transfer | 9.3.5.3 | BROADCAST SESSION SETUP REQUEST
BROADCAST SESSION MODIFICATION REQUEST | +| MBS Session Setup or Modification Response Transfer | 9.3.5.5 | BROADCAST SESSION SETUP RESPONSE
BROADCAST SESSION MODIFICATION RESPONSE | +| MBS Session Setup or Modification Failure Transfer | 9.3.5.6 | BROADCAST SESSION SETUP FAILURE
BROADCAST SESSION MODIFICATION FAILURE | +| MBS Session Release Response Transfer | 9.3.5.14 | BROADCAST SESSION RELEASE RESPONSE
(NOTE) | +| Broadcast Transport Request Transfer | 9.3.5.x | BROADCAST SESSION TRANSPORT REQUEST | +| Broadcast Transport Response Transfer | 9.3.5.y | BROADCAST SESSION TRANSPORT RESPONSE | +| Broadcast Transport Failure Transfer | 9.3.5.z | BROADCAST SESSION TRANSPORT FAILURE | +| NOTE: An MBS Session Release Response Transfer IE shall only be sent to the MB-SMF during a Broadcast MBS Session Release Require procedure (see clause 7.3.6 of 3GPP TS 23.247 [55]), when unicast transport applies over N3mb, to transfer the DL F-TEID of the NG-RAN node in which the MBS session has been released and towards which the delivery of MBS data shall be stopped. | | | + +### 6.5.7 Error Handling + +#### 6.5.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.5.7.2 Protocol Errors + +Protocol Error Handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.5.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Namf\_MBSSroadcast service, and the following application errors listed in Table 6.5.7.3-1 are specific for the Namf\_MBSSroadcast service. + +**Table 6.5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 6.5.8 Feature Negotiation + +The optional features in table 6.5.8-1 are defined for the Namf\_MBSBroadcast API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.5.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 6.5.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Namf\_MBSBroadcast API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Namf\_MBSBroadcast API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Namf\_MBSBroadcast service. + +The Namf\_MBSBroadcast API defines a single scope "namf-mbs-bc" for the entire service, and it does not define any additional scopes at resource or operation level. + +## 6.5.10 HTTP redirection + +An HTTP request may be redirected to a different AMF service instance, within the same AMF or a different AMF of an AMF set, e.g. when an AMF service instance is part of an AMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different AMF producer instance will return the NF Instance ID of the new AMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an AMF within an AMF set redirects a service request to a different AMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new AMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# 6.6 Namf\_MBSCommunication Service API + +## 6.6.1 API URI + +The Namf\_MBSCommunication service shall use the Namf\_MBSCommunication API. + +The API URI of the Namf\_MBSCommunication API shall be: + +**{apiRoot}/** + +The request URI used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "namf-mbs-comm". +- The shall be "v1". +- The shall be set as described in clause 6.6.3. + +## 6.6.2 Usage of HTTP + +### 6.6.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [19], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Namf\_MBSCommunication service shall comply with the OpenAPI [23] specification contained in Annex A. + +### 6.6.2.2 HTTP standard headers + +#### 6.6.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +#### 6.6.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [8], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 9457 [36]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +Multipart messages shall also be supported (see clause 6.6.2.4) using the content type "multipart/related", comprising: + +- one JSON body part with the "application/json" content type; and +- one binary body part with 3gpp vendor specific content subtypes. + +The 3gpp vendor specific content subtypes defined in Table 6.6.2.2.2-1 shall be supported. + +**Table 6.6.2.2.2-1: 3GPP vendor specific content subtypes** + +| content subtype | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| +| vnd.3gpp.ngap | Binary encoded content, encoding NG Application Protocol (NGAP) IEs, as specified in clause 9.3 of 3GPP TS 38.413 [9] (ASN.1 encoded). | +| NOTE: Using 3GPP vendor content subtypes allows to describe the nature of the opaque content (i.e. NGAP information) without having to rely on metadata in the JSON content. | | + +See clause 6.6.2.4 for the binary contents supported in the binary body part of multipart messages. + +### 6.6.2.3 HTTP custom headers + +#### 6.6.2.3.1 General + +In this release of this specification, no custom headers specific to the Namf\_MBSCommunication service are defined. For 3GPP specific HTTP custom headers used across all service-based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.6.2.4 HTTP multipart messages + +HTTP multipart messages shall be supported, to transfer opaque N2 Information MBS, in the following service operations (and HTTP messages): + +- N2MessageTransfer Request and Response (POST). + +HTTP multipart messages shall include one JSON body part and one binary body part comprising: + +- N2 payload (see clause 6.1.6.4). + +The JSON body part shall be the "root" body part of the multipart message. It shall be encoded as the first body part of the multipart message. The "Start" parameter does not need to be included. + +The multipart message shall include a "type" parameter (see IETF RFC 2387 [9]) specifying the media type of the root body part, i.e. "application/json". + +NOTE: The "root" body part (or "root" object) is the first body part the application processes when receiving a multipart/related message, see IETF RFC 2387 [9]. The default root is the first body within the multipart/related message. The "Start" parameter indicates the root body part, e.g. when this is not the first body part in the message. + +For each binary body part in a HTTP multipart message, the binary body part shall include a Content-ID header (see IETF RFC 2045 [10]), and the JSON body part shall include an attribute, defined with the RefToBinaryData type, that contains the value of the Content-ID header field of the referenced binary body part. + +## 6.6.3 Resources + +### 6.6.3.1 Overview + +Figure 6.6.3.1-1 describes the resource URI structure of the Namf\_MBSCCommunication API. + +![Diagram showing the resource URI structure of the Namf_MBSCCommunication API. The root is {apiRoot}/namf-mbs-comm/{apiVersion}. It branches into /n2-messages, which further branches into /transfer.](e59fc6db8cfc5ea2b861f3c59a03eaf3_img.jpg) + +``` + +graph TD + Root["{apiRoot}/namf-mbs-comm/{apiVersion}"] --> N2["/n2-messages"] + N2 --> Transfer["/transfer"] + +``` + +Diagram showing the resource URI structure of the Namf\_MBSCCommunication API. The root is {apiRoot}/namf-mbs-comm/{apiVersion}. It branches into /n2-messages, which further branches into /transfer. + +**Figure 6.6.3.1-1: Resource URI structure of the Namf\_MBSCCommunication API** + +Table 6.6.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.6.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description (service operation) | +|---------------------------------------|-----------------------|---------------------------------|---------------------------------| +| N2 Message Handler (Custom Operation) | /n2-messages/transfer | transfer (POST) | N2MessageTransfer | + +### 6.6.3.1 Resource: N2 Message Handler (Custom Operation) + +#### 6.6.3.1.1 Description + +This resource represents the N2 Message Handler used to transfer a N2 message related to support a Multicast MBS session towards NG-RANs. + +#### 6.6.3.1.2 Resource Definition + +Resource URI: {apiRoot}/namf-comm//n2-messages + +This resource shall support the resource URI variables defined in table 6.6.3.1.2-1. + +**Table 6.6.3.1.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|------------|-----------|-------------------| +| apiRoot | string | See clause 6.6.1 | +| apiVersion | string | See clause 6.6.1. | + +#### 6.6.3.1.3 Resource Standard Methods + +There are no resource standard methods for the N2 Message Handler resource in this release of this specification + +#### 6.6.3.1.4 Resource Custom Operations + +##### 6.6.3.1.4.1 Overview + +**Table 6.6.3.1.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description (service operation) | +|----------------|-----------------------|--------------------|---------------------------------| +| transfer | /n2-messages/transfer | POST | N2MessageTransfer | + +##### 6.6.3.1.4.2 Operation: transfer + +###### 6.6.3.1.4.2.1 Description + +The /n2-messages/transfer custom operation is used to initiate the transfer of N2 MBS Session Management information to the NG-RAN nodes serving a multicast MBS session. This custom operation uses the HTTP POST method. + +###### 6.6.3.1.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.6.3.1.4.2-1 and the response data structure and response codes specified in table 6.6.3.1.4.2-2. + +**Table 6.6.3.1.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------| +| MbsN2MessageTransferReqData | M | 1 | Representation of the data related to a multicast MBS session to be sent to the NG-RAN node(s) by the AMF. | + +**Table 6.6.3.1.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MbsN2MessageTransferRspData | M | 1 | 200 OK | Indicates that the AMF has successfully initiated the transfer of N2 Information to the AN. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | When the MBS Session ID is not found in the NF Service Producer (i.e. AMF) the "cause" attribute shall be set to:
- MBS_SESSION_NOT_FOUND
See table 6.6.7.3-1 for the description of these errors | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.6.3.1.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.6.3.1.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.6.4 Custom Operations without associated resources + +## 6.6.5 Notifications + +### 6.6.5.1 General + +The notifications provided by the Namf\_MBSCommunication service are specified in this clause. + +**Table 6.6.5.1-1: Callback overview** + +| Notification | Resource URI | HTTP method or custom operation | Description (service operation) | +|--------------|--------------|---------------------------------|---------------------------------| +| Notification | {notifyUri} | POST | Notify | + +## 6.6.5.2 Notification + +### 6.6.5.2.1 Description + +The notification is used by the AMF to report the failure of an MBS related N2 procedure with an NG-RAN node to a NF service consumer. + +### 6.6.5.2.2 Notification Definitionn + +The Callback URI "{notifyUri}" shall be used with the callback URI variables defined in table 6.6.5.2.2-1. + +**Table 6.6.5.2.2-1: Callback URI variables** + +| Name | Definition | +|-----------|-----------------------------------------------| +| notifyUri | String formatted as URI with the Callback URI | + +### 6.6.5.2.3 Notification Standard Methods + +#### 6.6.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.6.5.2.3.1-1 and the response data structures and response codes specified in table 6.6.5.2.3.1-2. + +**Table 6.6.5.2.3.1-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|---------------------------------------------| +| Notification | M | 1 | Represents the notification to be delivered | + +**Table 6.6.5.2.3.1-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.6.5.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.6.5.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.6.6 Data Model + +### 6.6.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.6.6.1-1 specifies the data types defined for the Namf\_MBSCommunication service based interface protocol. + +**Table 6.6.6.1-1: Namf\_MBSCommunication specific Data Types** + +| Data type | Clause defined | Description | +|-----------------------------|----------------|----------------------------------------------| +| MbsN2MessageTransferReqData | 6.6.6.2.2 | Data within MBS N2 Message Transfer Request | +| MbsN2MessageTransferRspData | 6.6.6.2.3 | Data within MBS N2 Message Transfer Response | +| N2MbsSmInfo | 6.6.6.2.4 | N2 MBS Session Management Information | +| Notification | 6.6.6.2.5 | Data within Notify Request | +| RanFailure | 6.6.6.2.6 | Description of an NG RAN failure | +| MbsNgapleType | 6.6.6.3.3 | NGAP Information Element Type for MBS | +| RanFailureIndication | 6.6.6.3.4 | NG RAN failure indication | + +Table 6.6.6.3-2 specifies data types re-used by the Namf\_MBSCommunication service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Namf\_MBSCommunication service based interface. + +**Table 6.6.6.1-2: Namf\_MBSCommunication re-used Data Types** + +| Data type | Reference | Comments | +|-----------------------------|--------------------|------------------------------------------------| +| ProblemDetails | 3GPP TS 29.571 [6] | Common data type used in response bodies | +| supportedFeatures | 3GPP TS 29.571 [6] | Supported Features | +| RedirectResponse | 3GPP TS 29.571 [6] | Response body of the redirect response message | +| MbsSessionId | 3GPP TS 29.571 [6] | MBS Session Identifier | +| NgApCause | 3GPP TS 29.571 [6] | NGAP Cause | +| N2InformationTransferResult | 6.1.6.3.8 | Enumeration N2 Message Transfer Result | + +### 6.6.6.2 Structured data types + +#### 6.6.6.2.1 Introduction + +Structured data types used in Namf\_MBSCommunication service are specified in this clause. + +### 6.6.6.2.2 Type: MbsN2MessageTransferReqData + +**Table 6.6.6.2.2-1: Definition of type MbsN2MessageTransferReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbsSessionId | MbsSessionId | M | 1 | This IE shall be included to identify the MBS session to which the N2 information to be transferred is related. | | +| areaSessionId | AreaSessionId | O | 0..1 | Area Session ID
This IE may be present, if this is a Location dependent multicast MBS session. | | +| n2MbsSmInfo | N2MbsSmInfo | M | 1 | This IE shall contain the N2 MBS Session Information to be transferred to the NG-RAN nodes serving the MBS session and additional information required for the processing of the message by the AMF. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | +| ranNodeIdList | array(GlobalRanNodeId) | O | 1..N | When present, this IE shall contain the list of NG RAN Node IDs towards which the MBS related N2 message is requested to be distributed. | RAN-ID-LIST | +| notifyUri | Uri | O | 0..1 | When present, this IE shall contain the notification URI to be used for receiving notifications about possible failures of the MBS related N2 procedure with an NG RAN node in the ranNodeIdList. | RAN-ID-LIST | +| notifyCorrelationId | string | O | 0..1 | When present, this IE shall contain the notification correlation ID to be sent within notifications. | RAN-ID-LIST | + +### 6.6.6.2.3 Type: MbsN2MessageTransferRspData + +**Table 6.6.6.2.3-1: Definition of type MbsN2MessageTransferRspData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| result | N2InformationTransferResult | M | 1 | This IE shall provide the result of the MBS N2 information transfer processing at the AMF. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | +| failureList | array(RanFailure) | O | 1..N | List of MBS related N2 procedure failures | + +### 6.6.6.2.4 Type: N2MbsSmInfo + +**Table 6.6.6.2.4-1: Definition of type N2MbsSmInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|---------------------------------------------------------------------------------------------| +| ngapType | MbsNgapType | M | 1 | This IE shall indicate the NGAP IE type of the ngapData as specified in clause 6.6.6.4.2.2. | +| ngapData | RefToBinaryData | M | 1 | This IE shall contain the reference the binary data part carrying the NGAP data. | + +### 6.6.6.2.5 Type: Notification + +**Table 6.6.6.2.5-1: Definition of type Notification** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbsSessionId | MbsSessionId | M | 1 | MBS Session ID | +| areaSessionId | AreaSessionId | C | 0..1 | Area Session ID
This IE shall be present, if present in the N2Message Transfer request. | +| failureList | array(RanFailure) | M | 1..N | List of MBS related N2 procedure failures | +| notifyCorrelationId | string | C | 0..1 | This IE shall be present if the same IE is present in the N2Message Transfer request. When present, it shall contain the same value as received in the request. | + +### 6.6.6.2.6 Type: RanFailure + +**Table 6.6.6.2.6-1: Definition of type RanFailure** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------| +| ranId | GlobalRanNodeId | M | 1 | Indicates the identity of the NG RAN node. | +| ranFailureCause | NgApCause | C | 0..1 | When present, this IE shall contain the NGAP failure cause received from the NG-RAN. (NOTE) | +| ranFailureIndication | RanFailureIndication | C | 0..1 | This IE shall be present if the AMF cannot deliver the MBS related N2 message to the NG-RAN node. (NOTE) | + +NOTE: Either the ranFailureCause IE or the ranFailureIndication IE shall be present. + +### 6.6.6.3 Simple data types and enumerations + +#### 6.6.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 6.6.6.3.2 Simple data types + +The simple data types defined in Table 6.6.6.3.2-1 shall be supported. + +#### 6.6.6.3.3 Enumeration: MbsNgapleType + +**Table 6.6.6.3.3-1: Enumeration MbsNgapleType** + +| Enumeration value | Description | +|---------------------|-------------------------------------------------| +| "MBS_SES_ACT_REQ" | Multicast Session Activation Request Transfer | +| "MBS_SES_DEACT_REQ" | Multicast Session Deactivation Request Transfer | +| "MBS_SES_UPD_REQ" | Multicast Session Update Request Transfer | + +#### 6.6.6.3.4 Enumeration: RanFailureIndication + +The enumeration RanFailureIndication indicates a NG-RAN failure event. + +**Table 6.5.6.3.4-1: Enumeration RanFailureIndication** + +| Enumeration value | Description | +|----------------------------------|-------------------------------------------------------------------------------| +| "NG_RAN_FAILURE_WITHOUT_RESTART" | The NG-RAN node failed without restart. | +| "NG_RAN_NOT_REACHABLE" | The AMF cannot reach the NG RAN node when sending the MBS related N2 message. | + +## 6.6.6.4 Binary data + +### 6.6.6.4.1 Introduction + +This clause defines the binary data that shall be supported in a binary body part in an HTTP multipart message (see clauses 6.6.2.2.2 and 6.6.2.4). + +**Table 6.6.6.4.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|---------------------------------------|----------------|---------------| +| N2 MBS Session Management Information | 6.6.6.4.2 | vnd.3gpp.ngap | + +### 6.6.6.4.2 N2 Information + +#### 6.6.6.4.2.1 Introduction + +N2 Information shall encode NG Application Protocol (NGAP) IEs, as specified in clause 9.3.A of 3GPP TS 38.413 [12] (ASN.1 encoded), using the vnd.3gpp.ngap content-type. + +#### 6.6.6.4.2.2 NGAP IEs + +N2 Information may encode following NGAP MB-SMF related IE specified in in clause 9.3.5 of 3GPP TS 38.413 [12], as summarized in Table 6.6.6.4.2.2-1. + +**Table 6.6.6.4.2.2-1: N2 Information content for class MBS-SM** + +| NGAP IE | Reference (3GPP TS 38.413 [12]) | Related NGAP message | +|-------------------------------------------------|---------------------------------|----------------------------------------| +| Multicast Session Activation Request Transfer | 9.3.5.11 | MULTICAST SESSION ACTIVATION REQUEST | +| Multicast Session Deactivation Request Transfer | 9.3.5.12 | MULTICAST SESSION DEACTIVATION REQUEST | +| Multicast Session Update Request Transfer | 9.3.5.13 | MULTICAST SESSION UPDATE REQUEST | + +## 6.6.7 Error Handling + +### 6.6.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +### 6.6.7.2 Protocol Errors + +Protocol Error Handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.6.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Namf\_MBSCCommunication service, and the following application errors listed in Table 6.6.7.3-1 are specific for the Namf\_MBSCCommunication service. + +**Table 6.6.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------|------------------|--------------------------------------------------------------------------------------------------------------| +| MBS_SESSION_NOT_FOUND | 404 Not Found | Indicates the MBS related N2 Message transfer has failed due to the MBS Session ID being unknown to the AMF. | + +### 6.6.8 Feature Negotiation + +The optional features in table 6.6.8-1 are defined for the Namf\_MBSCCommunication API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +The NF Service Consumer shall indicate the optional features it supports for the Namf\_MBSCCommunication service, if any, by including the supportedFeatures attribute in content of the HTTP Request Message for following service operations: + +- N2MessageTransfer, as specified in clause 5.7.2.2. + +The AMF shall determine the supported features for the service operations as specified in clause 6.6 of 3GPP TS 29.500 [4] and shall indicate the supported features by including the supportedFeatures attribute in content of the HTTP response for the service operation. + +The syntax of the supportedFeatures attribute is defined in clause 5.2.2 of 3GPP TS 29.571 [6]. + +The following features are defined for the Namf\_MBSCCommunication service. + +**Table 6.6.8-1: Features of supportedFeatures attribute used by Namf\_MBSCCommunication service** + +| Feature Number | Feature | M/O | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | RAN-ID-LIST | O |

N2 MBS session request distribution with list of NG RAN Node IDs provided by NF Service Consumer to AMF

An NF Service Consumer (e.g. MB-SMF) and an AMF that support this feature shall support:

  • - Namf_MBSCCommunication_N2MessageTransfer Request including the list of NG RAN node IDs towards which the MBS related N2 message is requested to be distributed; and
  • - the AMF notifying an MBS related N2 procedure failure with an NG RAN node in this list, detected by the AMF or reported by the NG-RAN node.

See clause 8.4.1.2 of 3GPP TS 23.527 [33] and clauses 5.7.2.2 and 5.7.2.3.

| +|

Feature number: The order number of the feature within the supportedFeatures attribute (starting with 1).
Feature: A short name that can be used to refer to the bit and to the feature.
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature.

| | | | + +### 6.6.9 Security + +As indicated in 3GPP TS 33.501 [27], the access to the Namf\_MBSCCommunication API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [28]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [29]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Namf\_MBSCCommunication API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [29], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Namf\_MBSCCommunication service. + +The Namf\_MBSCCommunication API defines scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [27]; it defines a single scope consisting on the name of the service (i.e., "namf-mbs-comm"), and it does not define any additional scopes at resource or operation level. + +## 6.6.10 HTTP redirection + +An HTTP request may be redirected to a different AMF service instance, within the same AMF or a different AMF of an AMF set, e.g. when an AMF service instance is part of an AMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different AMF producer instance will return the NF Instance ID of the new AMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an AMF within an AMF set redirects a service request to a different AMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new AMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +--- + +## Annex A (normative): OpenAPI specification + +### A.1 General + +This Annex specifies the API definition of the service provided by AMF in this document. The APIs are defined by OpenAPI 3.0.0 specifications in YAML format, following guidelines in 3GPP TS 29.501 [5]. + +The APIs for specified for following services: + +- Namf\_Communication Service +- Namf\_EventExposure Service +- Namf\_MT Service +- Namf\_Location Service + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE : The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [37] clause 5B). + +--- + +## A.2 Namf\_Communication API + +openapi: 3.0.0 + +info: + +``` + +version: 1.3.0-alpha.5 +title: Namf_Communication +description: | + AMF Communication Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +security: +- {} +- oAuth2ClientCredentials: + - namf-comm + +externalDocs: + description: 3GPP TS 29.518 V18.4.0; 5G System; Access and Mobility Management Services + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/' + +servers: +- url: '{apiRoot}/namf-comm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +paths: + /ue-contexts/{ueContextId}: + put: + summary: Namf_Communication CreateUEContext service Operation + tags: + - Individual ueContext (Document) + operationId: CreateUEContext + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:ue-contexts:mobility + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^((5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+))$' + requestBody: + content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/UeContextCreateData' + binaryDataN2Information: + type: string + format: binary + binaryDataN2InformationExt1: + type: string + format: binary + binaryDataN2InformationExt2: + type: string + format: binary + binaryDataN2InformationExt3: + type: string + format: binary + binaryDataN2InformationExt4: + type: string + format: binary + binaryDataN2InformationExt5: + type: string + format: binary + binaryDataN2InformationExt6: + type: string + format: binary + binaryDataN2InformationExt7: + type: string + format: binary + +``` + +``` +binaryDataN2InformationExt8: + type: string + format: binary +binaryDataN2InformationExt9: + type: string + format: binary +binaryDataN2InformationExt10: + type: string + format: binary +binaryDataN2InformationExt11: + type: string + format: binary +binaryDataN2InformationExt12: + type: string + format: binary +binaryDataN2InformationExt13: + type: string + format: binary +binaryDataN2InformationExt14: + type: string + format: binary +binaryDataN2InformationExt15: + type: string + format: binary +binaryDataN2InformationExt16: + type: string + format: binary +binaryDataN2InformationExt17: + type: string + format: binary +encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt3: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt7: + contentType: application/vnd.3gpp.ngap + headers: +``` + +``` + + Content-Id: + schema: + type: string +binaryDataN2InformationExt8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt11: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt12: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt13: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt14: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt15: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt16: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt17: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +required: true +callbacks: + onN2MessageNotify: + '{ $request.body#/n2NotifyUri }': + post: + summary: Namf_Communication N2 Info Notify (UE Specific) service Operation + tags: + - N2 Info Notify + operationId: N2InfoNotifyHandoverComplete + requestBody: + description: UE Specific N2 Information Notification + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationNotification' + +``` + +``` +responses: + '200': + description: N2 Information Notification Response. + content: + application/json: + schema: + $ref: '#/components/schemas/N2InfoNotificationRspData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/N2InfoNotificationRspData' + binaryDataN2InformationExt1: + type: string + format: binary + binaryDataN2InformationExt2: + type: string + format: binary + binaryDataN2InformationExt3: + type: string + format: binary + binaryDataN2InformationExt4: + type: string + format: binary + binaryDataN2InformationExt5: + type: string + format: binary + binaryDataN2InformationExt6: + type: string + format: binary + binaryDataN2InformationExt7: + type: string + format: binary + binaryDataN2InformationExt8: + type: string + format: binary + binaryDataN2InformationExt9: + type: string + format: binary + binaryDataN2InformationExt10: + type: string + format: binary + binaryDataN2InformationExt11: + type: string + format: binary + binaryDataN2InformationExt12: + type: string + format: binary + binaryDataN2InformationExt13: + type: string + format: binary + binaryDataN2InformationExt14: + type: string + format: binary + binaryDataN2InformationExt15: + type: string + format: binary + binaryDataN2InformationExt16: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2InformationExt1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt3: + contentType: application/vnd.3gpp.ngap +``` + +``` +headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt7: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt11: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt12: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt13: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt14: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt15: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt16: + contentType: application/vnd.3gpp.ngap +``` + +``` + + headers: + Content-Id: + schema: + type: string + '204': + description: Expected response to a successful callback processing + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +responses: + '201': + description: UE context successfully created. + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/namf-comm//ue-contexts/{ueContextId} + required: true + schema: + type: string + 3gpp-Sbi-Producer-Id: + description: > + Indicating the AMF serving the UE Context. This header shall be included when the + UE Context is created in a target AMF other than the initial AMF sending the + response. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextCreatedData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/UeContextCreatedData' + binaryDataN2Information: + type: string + format: binary + binaryDataN2InformationExt1: + type: string + format: binary + binaryDataN2InformationExt2: + type: string + format: binary + binaryDataN2InformationExt3: + type: string + format: binary + binaryDataN2InformationExt4: + type: string + format: binary + binaryDataN2InformationExt5: + type: string + format: binary + +``` + +``` + binaryDataN2InformationExt6: + type: string + format: binary + binaryDataN2InformationExt7: + type: string + format: binary + binaryDataN2InformationExt8: + type: string + format: binary + binaryDataN2InformationExt9: + type: string + format: binary + binaryDataN2InformationExt10: + type: string + format: binary + binaryDataN2InformationExt11: + type: string + format: binary + binaryDataN2InformationExt12: + type: string + format: binary + binaryDataN2InformationExt13: + type: string + format: binary + binaryDataN2InformationExt14: + type: string + format: binary + binaryDataN2InformationExt15: + type: string + format: binary +encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt3: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt7: +``` + +``` + Content-Id: + schema: + type: string +binaryDataN2InformationExt8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt11: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt12: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt13: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt14: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt15: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextCreateError' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextCreateError' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object +``` + +``` + +properties: # Response parts + jsonData: + $ref: '#/components/schemas/UeContextCreateError' + binaryDataN2Information: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextCreateError' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +/ue-contexts/{ueContextId}/release: + post: + summary: Namf_Communication ReleaseUEContext service Operation + tags: + - Individual ueContext (Document) + operationId: ReleaseUEContext + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:ue-contexts:mobility + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^((5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+))$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UEContextRelease' + required: true + responses: + '204': + description: UE Context successfully released + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + +``` + +``` + +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +/ue-contexts/{ueContextId}/assign-ebi: + post: + summary: Namf_Communication EBI Assignment service Operation + tags: + - Individual ueContext (Document) + operationId: EBIAssignment + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:ue-contexts:assign-ebi + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^(5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AssignEbiData' + required: true + responses: + '200': + description: EBI Assignment successfully performed. + content: + application/json: + schema: + $ref: '#/components/schemas/AssignedEbiData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/AssignEbiError' + application/problem+json: # error originated by an SCP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/AssignEbiError' + application/problem+json: # error originated by an SCP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/AssignEbiError' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/AssignEbiError' + application/problem+json: # error originated by an SCP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/ue-contexts/{ueContextId}/transfer: + post: + summary: Namf_Communication UEContextTransfer service Operation + tags: + - Individual ueContext (Document) + operationId: UEContextTransfer + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:ue-contexts:mobility + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^(5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextTransferReqData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/UeContextTransferReqData' + binaryDataN1Message: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1Message: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + required: true + responses: + '200': + +``` + +``` + +description: UE context transfer successfully initiated. +content: + application/json: + schema: + $ref: '#/components/schemas/UeContextTransferRspData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/UeContextTransferRspData' + binaryDataN2Information: + type: string + format: binary + binaryDataN2InformationExt1: + type: string + format: binary + binaryDataN2InformationExt2: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/ue-contexts/{ueContextId}/transfer-update: + post: + summary: Namf_Communication RegistrationStatusUpdate service Operation + tags: + - Individual ueContext (Document) + operationId: RegistrationStatusUpdate + security: + - {} + - oAuth2ClientCredentials: + +``` + +``` + + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:ue-contexts:mobility +parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^((5g-guti-[0-9]{5,6}|[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$)' +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UeRegStatusUpdateReqData' + required: true +responses: + '200': + description: UE context transfer status successfully updated. + content: + application/json: + schema: + $ref: '#/components/schemas/UeRegStatusUpdateRspData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/ue-contexts/{ueContextId}/relocate: + post: + summary: Namf_Communication RelocateUEContext service Operation + tags: + - Individual ueContext (Document) + operationId: RelocateUEContext + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:ue-contexts:mobility + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^((5g-guti-[0-9]{5,6}|[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$)' + requestBody: + content: + +``` + +``` +multipart/related: # message with binary body part(s) +schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/UeContextRelocateData' + binaryDataForwardRelocationRequest: + type: string + format: binary + binaryDataN2Information: + type: string + format: binary + binaryDataN2InformationExt1: + type: string + format: binary + binaryDataN2InformationExt2: + type: string + format: binary + binaryDataN2InformationExt3: + type: string + format: binary + binaryDataN2InformationExt4: + type: string + format: binary + binaryDataN2InformationExt5: + type: string + format: binary + binaryDataN2InformationExt6: + type: string + format: binary + binaryDataN2InformationExt7: + type: string + format: binary + binaryDataN2InformationExt8: + type: string + format: binary + binaryDataN2InformationExt9: + type: string + format: binary + binaryDataN2InformationExt10: + type: string + format: binary + binaryDataN2InformationExt11: + type: string + format: binary + binaryDataN2InformationExt12: + type: string + format: binary + binaryDataN2InformationExt13: + type: string + format: binary + binaryDataN2InformationExt14: + type: string + format: binary + binaryDataN2InformationExt15: + type: string + format: binary + binaryDataN2InformationExt16: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataForwardRelocationRequest: + contentType: application/vnd.3gpp.gtpc + headers: + Content-Id: + schema: + type: string + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt1: + contentType: application/vnd.3gpp.ngap + headers: +``` + +``` + Content-Id: + schema: + type: string +binaryDataN2InformationExt2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt3: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt7: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt11: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt12: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt13: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt14: + contentType: application/vnd.3gpp.ngap + headers: +``` + +``` + + Content-Id: + schema: + type: string + binaryDataN2InformationExt15: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt16: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + required: true + responses: + '201': + description: UE context successfully relocated. + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/namf-comm//ue-contexts/{ueContextId}/relocate' + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextRelocatedData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + /ue-contexts/{ueContextId}/cancel-relocate: + post: + summary: Namf_Communication CancelRelocateUEContext service Operation + tags: + - Individual ueContext (Document) + operationId: CancelRelocateUEContext + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:ue-contexts:mobility + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + +``` + +``` + +pattern: '^((5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+| +imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$' +requestBody: +content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/UeContextCancelRelocateData' + binaryDataGtpcMessage: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataGtpcMessage: + contentType: application/vnd.3gpp.gtpc + headers: + Content-Id: + schema: + type: string + required: true +responses: + '204': + description: UE Context successfully released + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/ue-contexts/{ueContextId}/n1-n2-messages: + post: + summary: Namf_Communication N1N2 Message Transfer (UE Specific) service Operation + tags: + - n1N2Message collection (Collection) + operationId: N1N2MessageTransfer + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:n1-n2-messages + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^((imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|cid-. +{1,255}|.+)$' + requestBody: + content: + +``` + +``` + +application/json: + schema: + $ref: '#/components/schemas/N1N2MessageTransferReqData' +multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/N1N2MessageTransferReqData' + binaryDataN1Message: + type: string + format: binary + binaryDataN2Information: + type: string + format: binary + binaryMtData: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1Message: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryMtData: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + required: true +responses: + '202': + description: N1N2 Message Transfer accepted. + content: + application/json: + schema: + $ref: '#/components/schemas/N1N2MessageTransferRspData' + headers: + Location: + description: > + The URI of the resource located on the AMF In this release, the URI shall only be + used by NF Service Consumer to correlate the possible N1/N2 Message Transfer Failure + Notification With the related N1/N2 Message Transfer Operation. The NF service + consumer shall not send any service requests towards the URI received in the + Location header. + required: true + schema: + type: string + '200': + description: N1N2 Message Transfer successfully initiated. + content: + application/json: + schema: + $ref: '#/components/schemas/N1N2MessageTransferRspData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + description: Conflicts + +``` + +``` + +content: + application/json: + schema: + $ref: '#/components/schemas/N1N2MessageTransferError' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +'504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/N1N2MessageTransferError' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +default: + description: Unexpected error +callbacks: + onN1N2TransferFailure: + '{ $request.body#/n1n2FailureTxfrNotifURI }': + post: + summary: Namf_Communication N1N2Transfer Failure Notification service Operation + tags: + - N1N2 Transfer Failure Notification + operationId: N1N2TransferFailureNotification + requestBody: + description: N1N2Transfer Failure Notification + content: + application/json: + schema: + $ref: '#/components/schemas/N1N2MsgTxfrFailureNotification' + responses: + '204': + description: Expected response to a successful callback processing + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +/ue-contexts/{ueContextId}/n1-n2-messages/subscriptions: + post: + summary: Namf_Communication N1N2 Message Subscribe (UE Specific) service Operation + tags: + - N1N2 Subscriptions Collection for Individual UE Contexts (Collection) + operationId: N1N2MessageSubscribe + +``` + +``` + +security: +- {} +- oAuth2ClientCredentials: +- namf-comm +- oAuth2ClientCredentials: +- namf-comm +- namf-comm:n1-n2-messages +parameters: +- name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^^(imsi-[0-9]{5,15}|nai-\.+\|gli-\.+\|gci-\.+\|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$' +requestBody: +content: + application/json: + schema: + $ref: '#/components/schemas/UeN1N2InfoSubscriptionCreateData' +required: true +responses: +'201': + description: N1N2 Message Subscription successfully created. + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/namf-comm//ue-contexts/{ueContextId}/n1-n2-messages/subscriptions/ +{subscriptionId}' + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/UeN1N2InfoSubscriptionCreatedData' +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +callbacks: + onN1N2MessageNotify: + '{ $request.body#/n1NotifyCallbackUri }': + post: + summary: Namf_Communication N1 Message Notify service Operation + tags: + - N1 Message Notify + operationId: N1MessageNotify + requestBody: + description: N1 Message Notification + content: + multipart/related: # message with binary body part(s) + schema: + type: object + +``` + +``` + +properties: # Request parts + jsonData: + $ref: '#/components/schemas/N1MessageNotification' + binaryDataN1Message: + type: string + format: binary +encoding: + jsonData: + contentType: application/json + binaryDataN1Message: + contentType: application/vnd.3gpp.5gnas +headers: + Content-Id: + schema: + type: string +responses: + '204': + description: Expected response to a successful callback processing + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +'{ $request.body#/n2NotifyCallbackUri }': +post: + summary: Namf_Communication N2 Info Notify (UE Specific) service Operation + tags: + - N2 Info Notify + operationId: N2InfoNotify + requestBody: + description: UE Specific N2 Information Notification + content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/N2InformationNotification' + binaryDataN1Message: + type: string + format: binary + binaryDataN2Information: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1Message: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + +``` + +``` + + schema: + type: string + responses: + '204': + description: Expected response to a successful callback processing + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +/ue-contexts/{ueContextId}/nl-n2-messages/subscriptions/{subscriptionId}: + delete: + summary: Namf_Communication N1N2 Message UnSubscribe (UE Specific) service Operation + tags: + - N1N2 Individual Subscription (Document) + operationId: N1N2MessageUnSubscribe + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:n1-n2-messages + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$' + - name: subscriptionId + in: path + description: Subscription Identifier + required: true + schema: + type: string + responses: + '204': + description: N1N2 Message Subscription successfully removed. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +/non-ue-n2-messages/transfer: + post: + summary: Namf_Communication Non UE N2 Message Transfer service Operation + tags: + - Non UE N2Messages collection (Collection) + operationId: NonUeN2MessageTransfer + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:non-ue-n2-messages + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationTransferReqData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/N2InformationTransferReqData' + binaryDataN2Information: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + required: true + responses: + '200': + description: Non UE N2 Message Transfer successfully initiated. + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationTransferRspData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationTransferError' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationTransferError' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + +``` + +``` + +description: Not Found +content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationTransferError' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationTransferError' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + description: Service Unavailable + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationTransferError' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +default: + description: Unexpected error +/non-ue-n2-messages/subscriptions: + post: + summary: Namf_Communication Non UE N2 Info Subscribe service Operation + tags: + - Non UE N2Messages Subscriptions collection (Collection) + operationId: NonUeN2InfoSubscribe + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:non-ue-n2-messages + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NonUeN2InfoSubscriptionCreateData' + required: true + responses: + '201': + description: Non UE N2 Info Subscription successfully created. + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/namf-comm//non-ue-n2-messages/subscriptions/ +{n2NotifySubscriptionId}' + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/NonUeN2InfoSubscriptionCreatedData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + callbacks: + onN2InfoNotify: + '{$request.body#/n2NotifyCallbackUri}': + post: + summary: Namf_Communication Non UE N2 Info Notify service Operation + tags: + - Non UE N2 Info Notify + operationId: NonUeN2InfoNotify + requestBody: + description: Non UE N2 Information Notification + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationNotification' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/N2InformationNotification' + binaryDataN2Information: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + responses: + '204': + description: Expected response to a successful callback processing + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + +``` + +``` + + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +/non-ue-n2-messages/subscriptions/{n2NotifySubscriptionId}: + delete: + summary: Namf_Communication Non UE N2 Info UnSubscribe service Operation + tags: + - Non UE N2 Message Notification Individual Subscription (Document) + operationId: NonUeN2InfoUnSubscribe + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:non-ue-n2-messages + parameters: + - name: n2NotifySubscriptionId + in: path + description: N2 info Subscription Identifier + required: true + schema: + type: string + responses: + '204': + description: Non UE N2 INfo Subscription successfully removed. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +/subscriptions: + post: + summary: Namf_Communication AMF Status Change Subscribe service Operation + tags: + - subscriptions collection (Collection) + operationId: AMFStatusChangeSubscribe + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + required: true + responses: + '201': + description: N1N2 Message Subscription successfully created. + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/namf-comm//subscriptions/{subscriptionId}' + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + callbacks: + onAmfStatusChange: + '{$request.body#/amfStatusUri}': + post: + summary: Amf Status Change Notify service Operation + tags: + - Amf Status Change Notify + operationId: AmfStatusChangeNotify + requestBody: + description: Amf Status Change Notification + content: + application/json: + schema: + $ref: '#/components/schemas/AmfStatusChangeNotification' + responses: + '204': + description: Expected response to a successful callback processing + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +/subscriptions/{subscriptionId}: + delete: + summary: Namf_Communication AMF Status Change UnSubscribe service Operation + tags: + - individual subscription (Document) + operationId: AMFStatusChangeUnSubscribe + parameters: + - name: subscriptionId + in: path + description: AMF Status Change Subscription Identifier + required: true + schema: + type: string + responses: + +``` + +``` + + '204': + description: N1N2 Message Subscription successfully removed. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +put: + summary: Namf_Communication AMF Status Change Subscribe Modify service Operation + tags: + - individual subscription (Document) + operationId: AMFStatusChangeSubscribeModify + parameters: + - name: subscriptionId + in: path + description: AMF Status Change Subscription Identifier + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + required: true + responses: + '200': + description: Subscription modified successfully + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + '204': + description: Events subscription modification is accepted entirely + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + +``` + +``` + + description: Unexpected error + callbacks: + OnAmfStatusChange: + '{ $request.body#/amfStatusUri }': + post: + summary: Amf Status Change Notify service Operation + tags: + - Amf Status Change Notify + operationId: AmfStatusChangeNotify + requestBody: + description: Amf Status Change Notification + content: + application/json: + schema: + $ref: '#/components/schemas/AmfStatusChangeNotification' + responses: + '204': + description: Expected response to a successful callback processing + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + namf-comm: Access to the Namf_Communication API + namf-comm:ue-contexts:mobility: > + Access to service operations applying to UE context resources, i.e., + UEContextTransfer, RegistrationStatusUpdate, CreateUEContext, ReleaseUEContext, + RelocateUEContext, and CancelRelocateUEContext. + namf-comm:ue-contexts:assign-ebi: > + Access to service operations applying to UE context resources for EBI assignment, + i.e., EBIAssignment. + namf-comm:n1-n2-messages: > + Access to service operations applying to n1-n2-messages resources, i.e., + N1N2MessageSubscribe, N1N2MessageUnSubscribe, N1N2MessageTransfer, N1MessageNotify and + N2InfoNotify + namf-comm:non-ue-n2-messages: > + Access to service operations applying to the non-ue-n2-messages resources, i.e., + NonUeN2MessageTransfer, NonUeN2InfoSubscribe, NonUeN2InfoUnSubscribe, and + NonUeN2InfoNotify + +schemas: +# +# STRUCTURED DATA TYPES +# + SubscriptionData: + description: Data within an AMF Status Change Subscription request and response + type: object + properties: + amfStatusUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + +``` + +``` + guamiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + minItems: 1 + required: + - amfStatusUri +AmfStatusChangeNotification: + description: Data within an AMF Status Change Notification request + type: object + properties: + amfStatusInfoList: + type: array + items: + $ref: '#/components/schemas/AmfStatusInfo' + minItems: 1 + required: + - amfStatusInfoList +AmfStatusInfo: + description: AMF Status Information + type: object + properties: + guamiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + minItems: 1 + statusChange: + $ref: '#/components/schemas/StatusChange' + targetAmfRemoval: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfName' + targetAmfFailure: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfName' + required: + - guamiList + - statusChange +AssignEbiData: + description: Data within an EBI assignment request + type: object + properties: + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + arpList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + minItems: 1 + releasedEbiList: + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 1 + oldGuami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + modifiedEbiList: + type: array + items: + $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/EbiArpMapping' + minItems: 1 + required: + - pduSessionId +AssignedEbiData: + description: Data within a successful response to an EBI assignment request + type: object + properties: + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + assignedEbiList: + type: array + items: + $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/EbiArpMapping' + minItems: 0 + failedArpList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + minItems: 1 + releasedEbiList: +``` + +``` + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 1 + modifiedEbiList: + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 1 + required: + - pduSessionId + - assignedEbiList +AssignEbiFailed: + description: Represents failed assignment of EBI(s) + type: object + properties: + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + failedArpList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + minItems: 1 + required: + - pduSessionId +UEContextRelease: + description: Data within a Release UE Context request + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + unauthenticatedSupi: + type: boolean + default: false + ngapCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + required: + - ngapCause +N2InformationTransferReqData: + description: Data within a N2 Information Transfer request containing the N2 information + requested to be transferred to 5G AN + type: object + properties: + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + ratSelector: + $ref: '#/components/schemas/RatSelector' + globalRanNodeList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + minItems: 1 + n2Information: + $ref: '#/components/schemas/N2InfoContainer' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - n2Information +NonUeN2InfoSubscriptionCreateData: + description: Data within a create subscription request for non-UE specific N2 information + notification + type: object + properties: + globalRanNodeList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + minItems: 1 + anTypeList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + n2InformationClass: + $ref: '#/components/schemas/N2InformationClass' +``` + +``` +n2NotifyCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +notifCorrelationId: + type: string +required: +- n2InformationClass +- n2NotifyCallbackUri +NonUeN2InfoSubscriptionCreatedData: +description: Data for the created subscription for non-UE specific N2 information notification +type: object +properties: + n2NotifySubscriptionId: + type: string + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + n2InformationClass: + $ref: '#/components/schemas/N2InformationClass' +required: +- n2NotifySubscriptionId +UeN1N2InfoSubscriptionCreateData: +description: Data within a create subscription request for UE specific N1 and/or N2 +information notification +type: object +properties: + n2InformationClass: + $ref: '#/components/schemas/N2InformationClass' + n2NotifyCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + n1MessageClass: + $ref: '#/components/schemas/N1MessageClass' + n1NotifyCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + oldGuami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' +UeN1N2InfoSubscriptionCreatedData: +description: Data for the created subscription for UE specific N1 and/or N2 information +notification +type: object +properties: + n1n2NotifySubscriptionId: + type: string + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +required: +- n1n2NotifySubscriptionId +N2InformationNotification: +description: Data within a N2 information notification request +type: object +properties: + n2NotifySubscriptionId: + type: string + n2InfoContainer: + $ref: '#/components/schemas/N2InfoContainer' + toReleaseSessionList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + minItems: 1 + lcsCorrelationId: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CorrelationID' + notifyReason: + $ref: '#/components/schemas/N2InfoNotifyReason' + smfChangeInfoList: + type: array + items: + $ref: '#/components/schemas/SmfChangeInfo' + minItems: 1 + ranNodeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + initialAmfName: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfName' + anN2IPV4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + anN2IPV6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + notifySourceNgRan: + type: boolean + default: false + notifCorrelationId: + type: string + required: + - n2NotifySubscriptionId + +N2InfoContainer: + description: N2 information container + type: object + properties: + n2InformationClass: + $ref: '#/components/schemas/N2InformationClass' + smInfo: + $ref: '#/components/schemas/N2SmInformation' + ranInfo: + $ref: '#/components/schemas/N2RanInformation' + nrppaInfo: + $ref: '#/components/schemas/NrppaInformation' + pwsInfo: + $ref: '#/components/schemas/PwsInformation' + v2xInfo: + $ref: '#/components/schemas/V2xInformation' + proseInfo: + $ref: '#/components/schemas/ProSeInformation' + tssInfo: + $ref: '#/components/schemas/TssInformation' + rslpInfo: + $ref: '#/components/schemas/RslpInformation' + a2xInfo: + $ref: '#/components/schemas/A2xInformation' + required: + - n2InformationClass + +N1MessageNotification: + description: Data within a N1 message notification request + type: object + properties: + n1NotifySubscriptionId: + type: string + n1MessageContainer: + $ref: '#/components/schemas/N1MessageContainer' + lcsCorrelationId: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CorrelationID' + registrationCtxtContainer: + $ref: '#/components/schemas/RegistrationContextContainer' + newLmfIdentification: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + cIoT5GSOptimisation: + type: boolean + default: false + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + tai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + pruInd: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/PruInd' + required: + - n1MessageContainer + +N1MessageContainer: + description: N1 Message container + type: object + properties: + n1MessageClass: + $ref: '#/components/schemas/N1MessageClass' +``` + +``` + + nlMessageContent: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + serviceInstanceId: + type: string + required: + - nlMessageClass + - nlMessageContent + N1N2MessageTransferReqData: + description: Data within a N1/N2 message transfer request + type: object + properties: + nlMessageContainer: + $ref: '#/components/schemas/N1MessageContainer' + n2InfoContainer: + $ref: '#/components/schemas/N2InfoContainer' + mtData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + skipInd: + type: boolean + default: false + lastMsgIndication: + type: boolean + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + lcsCorrelationId: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CorrelationID' + ppi: + $ref: '#/components/schemas/Ppi' + arp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + nln2FailureTxfNotifURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + smfReallocationInd: + type: boolean + default: false + areaOfValidity: + $ref: '#/components/schemas/AreaOfValidity' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + oldGuami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + maAcceptedInd: + type: boolean + default: false + extBufSupport: + type: boolean + default: false + targetAccess: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pruInd: + type: boolean + enum: + - true + + N1N2MessageTransferRspData: + description: Data within a N1/N2 message transfer response + type: object + properties: + cause: + $ref: '#/components/schemas/N1N2MessageTransferCause' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - cause + RegistrationContextContainer: + description: Registration Context Container used to send the UE context information, N1 + message from UE, AN address etc during Registration with AMF re-allocation procedure + type: object + properties: + ueContext: + +``` + +``` +$ref: '#/components/schemas/UeContext' +localTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' +anType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' +anN2ApId: + type: integer +ranNodeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' +initialAmfName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfName' +userLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' +rrcEstCause: + type: string + pattern: '^[0-9a-fA-F]+$' +ueContextRequest: + type: boolean + default: false +initialAmfN2ApId: + type: integer +anN2IPv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +anN2IPv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' +allowedNssai: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/AllowedNssai' +configuredNssai: + type: array + items: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/ConfiguredSnssai' + minItems: 1 +rejectedNssaiInPlmn: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 +rejectedNssaiInTa: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 +selectedPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +iabNodeInd: + type: boolean + default: false +mbsrNodeInd: + type: boolean + default: false +ceModeBInd: + $ref: '#/components/schemas/CeModeBInd' +lteMInd: + $ref: '#/components/schemas/LteMInd' +authenticatedInd: + type: boolean + default: false +npnAccessInfo: + $ref: '#/components/schemas/NpnAccessInfo' +required: +- ueContext +- anType +- anN2ApId +- ranNodeId +- initialAmfName +- userLocation + +AreaOfValidity: + description: Area of validity information for N2 information transfer + type: object + properties: + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 0 + taiRangeList: + type: array +``` + +``` + + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TaiRange' + minItems: 1 + required: + - taiList + UeContextTransferReqData: + description: Data within a UE Context Transfer Request to start transferring of an individual + ueContext resource from old AMF to new AMF + type: object + properties: + reason: + $ref: '#/components/schemas/TransferReason' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + regRequest: + $ref: '#/components/schemas/N1MessageContainer' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - reason + - accessType + UeContextTransferRspData: + description: Data within a successful response to the UE Context Transfer request + type: object + properties: + ueContext: + $ref: '#/components/schemas/UeContext' + ueRadioCapability: + $ref: '#/components/schemas/N2InfoContent' + ueRadioCapabilityForPaging: + $ref: '#/components/schemas/N2InfoContent' + ueNbiotRadioCapability: + $ref: '#/components/schemas/N2InfoContent' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - ueContext + UeContext: + description: Represents an individual ueContext resource + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + supiUnauthInd: + type: boolean + gpsiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + udmGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + ausfGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + pcfGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + routingIndicator: + type: string + hNwPubKeyId: + type: integer + groupList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + drxParameter: + $ref: '#/components/schemas/DrxParameter' + subRfsp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RfspIndex' + pcfRfsp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RfspIndex' + usedRfsp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RfspIndex' + subUeAmbr: + +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' +pcfUeAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' +subUeSliceMbrList: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SliceMbr' + minProperties: 1 + description: A map(list of key-value pairs) where Snssai serves as key. +smfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +seafData: + $ref: '#/components/schemas/SeafData' +5gMmCapability: + $ref: '#/components/schemas/5GMmCapability' +pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +pcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +pcfAmpServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' +pcfUepServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' +pcfBinding: + $ref: '#/components/schemas/SbiBindingLevel' +pcfAmPolicyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +amPolicyReqTriggerList: + type: array + items: + $ref: '#/components/schemas/PolicyReqTrigger' + minItems: 1 +pcfUePolicyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +uePolicyReqTriggerList: + type: array + items: + $ref: '#/components/schemas/PolicyReqTrigger' + minItems: 1 +hpcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +hpcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +restrictedRatList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + minItems: 1 +forbiddenAreaList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Area' + minItems: 1 +serviceAreaRestriction: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceAreaRestriction' +restrictedCoreNwTypeList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CoreNetworkType' + minItems: 1 +eventSubscriptionList: + type: array + items: + $ref: '#/components/schemas/ExtAmfEventSubscription' + minItems: 1 +mmContextList: + type: array + items: + $ref: '#/components/schemas/MmContext' + minItems: 1 + maxItems: 2 +sessionContextList: + type: array + items: + $ref: '#/components/schemas/PduSessionContext' + minItems: 1 +epsInterworkingInfo: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/EpsInterworkingInfo' +``` + +``` +traceData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' +serviceGapExpiryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +stnSr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/StnSr' +cMsisdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CMsisdn' +msClassmark2: + $ref: '#/components/schemas/MSClassmark2' +supportedCodecList: + type: array + items: + $ref: '#/components/schemas/SupportedCodec' + minItems: 1 +smallDataRateStatusInfos: + type: array + items: + $ref: '#/components/schemas/SmallDataRateStatusInfo' + minItems: 1 +restrictedPrimaryRatList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + minItems: 1 +restrictedSecondaryRatList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + minItems: 1 +v2xContext: + $ref: '#/components/schemas/V2xContext' +lteCatMInd: + type: boolean + default: false +redCapInd: + type: boolean + default: false +moExpDataCounter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MoExpDataCounter' +cagData: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/CagData' +managementMdtInd: + type: boolean + default: false +immediateMdtConf: + $ref: '#/components/schemas/ImmediateMdtConf' +ecRestrictionDataWb: + $ref: '#/components/schemas/EcRestrictionDataWb' +ecRestrictionDataNb: + type: boolean + default: false +iabOperationAllowed: + type: boolean +proseContext: + $ref: '#/components/schemas/ProseContext' +analyticsSubscriptionList: + type: array + items: + $ref: '#/components/schemas/AnalyticsSubscription' + minItems: 1 +pcfAmpBindingInfo: + type: string +pcfUepBindingInfo: + type: string +usedServiceAreaRestriction: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceAreaRestriction' +praInAmPolicy: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: A map(list of key-value pairs) where praId serves as key. +praInUePolicy: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 +``` + +``` + + description: A map(list of key-value pairs) where praId serves as key. + updpSubscriptionData: + $ref: '#/components/schemas/UpdpSubscriptionData' + smPolicyNotifyPduList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionInfo' + minItems: 1 + pcfUeCallbackInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PcfUeCallbackInfo' + uePositioningCap: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/UePositioningCapabilities' + astiDistributionIndication: + type: boolean + default: false + tsErrorBudget: + type: integer + snpnOnboardInd: + type: boolean + default: false + smfSelInfo: + $ref: 'TS29507_Npcf_AMPolicyControl.yaml#/components/schemas/SmfSelectionData' + pcfUeSliceMbrList: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SliceMbr' + minProperties: 1 + description: A map(list of key-value pairs) where Snssai serves as key. + smfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + smfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + smfBindingInfo: + type: string + disasterRoamingInd: + type: boolean + default: false + disasterPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + satelliteBackhaulCat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + wlServAreaRes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/WirelineServiceAreaRestriction' + asTimeDisParam: + $ref: 'TS29507_Npcf_AMPolicyControl.yaml#/components/schemas/AsTimeDistributionParam' + amPolicyInfoContainer: + $ref: '#/components/schemas/AmPolicyInfoContainer' + a2xContext: + $ref: '#/components/schemas/A2xContext' + mbsrOperationAllowed: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/MbsrOperationAllowed' + lcsUpContext: + $ref: '#/components/schemas/LcsUpContext' + reconnectInd: + type: boolean + default: false + +N2SmInformation: + description: Represents the session management SMF related N2 information data part + type: object + properties: + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + n2InfoContent: + $ref: '#/components/schemas/N2InfoContent' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + homePlmnSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + iwkSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + subjectToHo: + type: boolean + required: + - pduSessionId + N2InfoContent: + +``` + +``` +description: Represents a transparent N2 information content to be relayed by AMF +type: object +properties: + ngapMessageType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + ngapIeType: + $ref: '#/components/schemas/NgapIeType' + ngapData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' +required: + - ngapData +NrppaInformation: +description: Represents a NRPPa related N2 information data part +type: object +properties: + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nrppaPdu: + $ref: '#/components/schemas/N2InfoContent' + serviceInstanceId: + type: string +required: + - nfId + - nrppaPdu +PwsInformation: +description: Represents a PWS related information data part +type: object +properties: + messageIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16' + serialNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16' + pwsContainer: + $ref: '#/components/schemas/N2InfoContent' + bcEmptyAreaList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + minItems: 1 + sendRanResponse: + type: boolean + default: false + omcId: + $ref: '#/components/schemas/OmcIdentifier' + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +required: + - messageIdentifier + - serialNumber + - pwsContainer +N1N2MsgTxfrFailureNotification: +description: Data within a N1/N2 Message Transfer Failure Notification request +type: object +properties: + cause: + $ref: '#/components/schemas/N1N2MessageTransferCause' + n1n2MsgDataUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + retryAfter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +required: + - cause + - n1n2MsgDataUri +N1N2MessageTransferError: +description: Data within a N1/N2 Message Transfer Error response +type: object +properties: + error: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + errInfo: + $ref: '#/components/schemas/N1N2MsgTxfrErrDetail' +required: + - error +N1N2MsgTxfrErrDetail: +description: N1/N2 Message Transfer Error Details +type: object +properties: +``` + +``` + retryAfter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + highestPrioArp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + maxWaitingTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + N2InformationTransferRspData: + description: Data within a successful response to the N2 Information Transfer request to +transfer N2 Information to the AN + type: object + properties: + result: + $ref: '#/components/schemas/N2InformationTransferResult' + pwsRspData: + $ref: '#/components/schemas/PWSResponseData' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - result + MmContext: + description: Represents a Mobility Management Context in UE Context + type: object + properties: + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + nasSecurityMode: + $ref: '#/components/schemas/NasSecurityMode' + epsNasSecurityMode: + $ref: '#/components/schemas/EpsNasSecurityMode' + nasDownlinkCount: + $ref: '#/components/schemas/NasCount' + nasUplinkCount: + $ref: '#/components/schemas/NasCount' + ueSecurityCapability: + $ref: '#/components/schemas/UeSecurityCapability' + slUeNetworkCapability: + $ref: '#/components/schemas/S1UeNetworkCapability' + allowedNssai: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + nssaiMappingList: + type: array + items: + $ref: '#/components/schemas/NssaiMapping' + minItems: 1 + allowedHomeNssai: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + partiallyAllowedNssai: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PartiallyAllowedSnssai' + minItems: 1 + nsInstanceList: + type: array + items: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsiId' + minItems: 1 + expectedUEbehavior: + $ref: '#/components/schemas/ExpectedUeBehavior' + ueDifferentiationInfo: + $ref: '#/components/schemas/UeDifferentiationInfo' + plmnAssiUeRadioCapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnAssiUeRadioCapId' + manAssiUeRadioCapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ManAssiUeRadioCapId' + ucmfDicEntryId: + type: string + n3IwfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + wagfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + tngfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' +``` + +``` +anN2ApId: + type: integer +nssaaStatusList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NssaaStatus' + minItems: 1 +pendingNssaiMappingList: + type: array + items: + $ref: '#/components/schemas/NssaiMapping' + minItems: 1 +uuaaMmStatus: + $ref: '#/components/schemas/UuaaMmStatus' +required: +- accessType +SeafData: + description: Represents SEAF data derived from data received from AUSF + type: object + properties: + ngKsi: + $ref: '#/components/schemas/NgKsi' + keyAmf: + $ref: '#/components/schemas/KeyAmf' + nh: + type: string + pattern: '^[A-Fa-f0-9]+$' + ncc: + type: integer + minimum: 0 + maximum: 7 + keyAmfChangeInd: + type: boolean + keyAmfHDerivationInd: + type: boolean + required: + - ngKsi + - keyAmf +NasSecurityMode: + description: Indicates the NAS Security Mode + type: object + properties: + integrityAlgorithm: + $ref: '#/components/schemas/IntegrityAlgorithm' + cipheringAlgorithm: + $ref: '#/components/schemas/CipheringAlgorithm' + required: + - integrityAlgorithm + - cipheringAlgorithm +PduSessionContext: + description: Represents a PDU Session Context in UE Context + type: object + properties: + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + smContextRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + selectedDnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + additionalAccessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + allocatedEbiList: + type: array + items: + $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/EbiArpMapping' + minItems: 1 + hsmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + hsmfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + hsmfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' +``` + +``` + +smfBinding: + $ref: '#/components/schemas/SbiBindingLevel' +vsmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +vsmfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +vsmfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' +vsmfBinding: + $ref: '#/components/schemas/SbiBindingLevel' +ismfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +ismfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +ismfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' +ismfBinding: + $ref: '#/components/schemas/SbiBindingLevel' +nsInstance: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsiId' +smfServiceInstanceId: + type: string +maPduSession: + type: boolean + default: false +cnAssistedRanPara: + $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/CnAssistedRanPara' +nrfManagementUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +nrfDiscoveryUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +nrfAccessTokenUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +smfBindingInfo: + type: string +vsmfBindingInfo: + type: string +ismfBindingInfo: + type: string +additionalSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +interPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +pgwFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +pgwIpAddr: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpAddress' +plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +anchorSmfSupportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +anchorSmfOAuth2Required: + type: boolean +hrsboAllowedInd: + type: boolean +required: + - pduSessionId + - smContextRef + - sNssai + - dnn + - accessType +NssaiMapping: + description: Represents the mapping between a S-NSSAI in serving PLMN to a S-NSSAI in home +PLMN + type: object + properties: + mappedSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + hSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + required: + - mappedSnssai + - hSnssai +UeRegStatusUpdateReqData: + description: Data within a UE registration status update request to indicate a completion of +transferring at a target AMF + type: object + properties: + +``` + +``` +transferStatus: + $ref: '#/components/schemas/UeContextTransferStatus' +toReleaseSessionList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + minItems: 1 +pcfReselectedInd: + type: boolean +smfChangeInfoList: + type: array + items: + $ref: '#/components/schemas/SmfChangeInfo' + minItems: 1 +analyticsNotUsedList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 +toReleaseSessionInfo: + type: array + items: + $ref: '#/components/schemas/ReleaseSessionInfo' + minItems: 1 +required: +- transferStatus +UeRegStatusUpdateRspData: + description: Data within a UE registration status update response to provide the status of UE +context transfer status update at a source AMF + type: object + properties: + regStatusTransferComplete: + type: boolean + required: + - regStatusTransferComplete +AssignEbiError: + description: Data within a failure response to the EBI assignment request + type: object + properties: + error: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + failureDetails: + $ref: '#/components/schemas/AssignEbiFailed' + required: + - error + - failureDetails +UeContextCreateData: + description: Data within a request to create an individual ueContext resource + type: object + properties: + ueContext: + $ref: '#/components/schemas/UeContext' + targetId: + $ref: '#/components/schemas/NgRanTargetId' + sourceToTargetData: + $ref: '#/components/schemas/N2InfoContent' + pduSessionList: + type: array + items: + $ref: '#/components/schemas/N2SmInformation' + minItems: 1 + n2NotifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ueRadioCapability: + $ref: '#/components/schemas/N2InfoContent' + ueRadioCapabilityForPaging: + $ref: '#/components/schemas/N2InfoContent' + ngapCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + servingNetwork: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + required: + - ueContext + - targetId + - sourceToTargetData + - pduSessionList +``` + +``` +UeContextCreatedData: + description: Data within a successful response for creating an individual ueContext resource + type: object + properties: + ueContext: + $ref: '#/components/schemas/UeContext' + targetToSourceData: + $ref: '#/components/schemas/N2InfoContent' + pduSessionList: + type: array + items: + $ref: '#/components/schemas/N2SmInformation' + minItems: 1 + failedSessionList: + type: array + items: + $ref: '#/components/schemas/N2SmInformation' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + pcfReselectedInd: + type: boolean + analyticsNotUsedList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + required: + - ueContext + - targetToSourceData + - pduSessionList +UeContextCreateError: + description: Data within a failure response for creating a UE context + type: object + properties: + error: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + ngapCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + targetToSourceFailureData: + $ref: '#/components/schemas/N2InfoContent' + required: + - error +UeContextRelocateData: + description: Data within a Relocate UE Context request + type: object + properties: + ueContext: + $ref: '#/components/schemas/UeContext' + targetId: + $ref: '#/components/schemas/NgRanTargetId' + sourceToTargetData: + $ref: '#/components/schemas/N2InfoContent' + forwardRelocationRequest: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + pduSessionList: + type: array + items: + $ref: '#/components/schemas/N2SmInformation' + minItems: 1 + ueRadioCapability: + $ref: '#/components/schemas/N2InfoContent' + ngapCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - ueContext + - targetId + - sourceToTargetData + - forwardRelocationRequest +UeContextRelocatedData: + description: Data within a Relocate UE Context response + type: object + properties: + ueContext: + $ref: '#/components/schemas/UeContext' + required: +``` + +- ueContext + +UeContextCancelRelocateData: +description: Data structure used for cancellation of UE Context Relocation +type: object +properties: + supi: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/Supi' + relocationCancelRequest: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/RefToBinaryData' +required: +- relocationCancelRequest + +NgRanTargetId: +description: Indicates a NG RAN as target of the handover +type: object +properties: + ranNodeId: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/GlobalRanNodeId' + tai: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/Tai' +required: +- ranNodeId +- tai + +PWSResponseData: +description: Data related PWS included in a N2 Information Transfer response +type: object +properties: + ngapMessageType: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/UInteger' + serialNumber: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/Uint16' + messageId: + type: integer + unknownTaiList: + type: array + items: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + n2PwsSubMissInd: + type: boolean + enum: + - true +required: +- ngapMessageType +- serialNumber +- messageId + +PWSErrorData: +description: Data related to PWS error included in a N2 Information Transfer failure response +type: object +properties: + namfCause: + type: integer +required: +- namfCause + +N2InformationTransferError: +description: Data within a failure response for a non-UE related N2 Information Transfer +type: object +properties: + error: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/ProblemDetails' + pwsErrorInfo: + \$ref: '#/components/schemas/PWSErrorData' +required: +- error + +NgKsi: +description: Represents the ngKSI +type: object +properties: + tsc: + \$ref: '#/components/schemas/ScType' + ksi: + type: integer + minimum: 0 + maximum: 6 +required: +- tsc +- ksi + +KeyAmf: + +``` +description: Represents the Kamf or K'amf +type: object +properties: + keyType: + $ref: '#/components/schemas/KeyAmfType' + keyVal: + type: string +required: +- keyType +- keyVal +ExpectedUeBehavior: +description: Represents the expected UE behavior (e.g. UE moving trajectory) and its validity +period +type: object +properties: + expMoveTrajectory: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + minItems: 1 + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +required: +- expMoveTrajectory +- validityTime +N2RanInformation: +description: Represents the RAN related N2 information data part +type: object +properties: + n2InfoContent: + $ref: '#/components/schemas/N2InfoContent' +required: +- n2InfoContent +N2InfoNotificationRspData: +description: Data within a N2 information notification response +type: object +properties: + secRatDataUsageList: + type: array + items: + $ref: '#/components/schemas/N2SmInformation' + minItems: 1 +SmallDataRateStatusInfo: +description: Represents the small data rate status +type: object +properties: + Snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + Dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + SmallDataRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus' +required: +- Snssai +- Dnn +- SmallDataRateStatus +SmfChangeInfo: +description: SMF change information for PDU session(s) +type: object +properties: + pduSessionIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + minItems: 1 + smfChangeInd: + $ref: '#/components/schemas/SmfChangeIndication' +required: +- pduSessionIdList +- smfChangeInd +V2xContext: +description: Represents the V2X services related parameters +type: object +properties: + nrV2xServicesAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NrV2xAuth' + lteV2xServicesAuth: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/LteV2xAuth' +nrUeSidelinkAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' +lteUeSidelinkAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' +pc5QoSPara: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pc5QoSPara' + +V2xInformation: + description: V2X related N2 information + type: object + properties: + n2Pc5Pol: + $ref: '#/components/schemas/N2InfoContent' + +ProSeInformation: + description: Represents 5G ProSe related N2 information. + type: object + properties: + n2Pc5ProSePol: + $ref: '#/components/schemas/N2InfoContent' + +ImmediateMdtConf: + description: Immediate MDT Configuration + type: object + properties: + jobType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/JobType' + measurementLteList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MeasurementLteForMdt' + minItems: 1 + measurementNrList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MeasurementNrForMdt' + minItems: 1 + reportingTriggerList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ReportingTrigger' + minItems: 1 + reportInterval: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ReportIntervalMdt' + reportIntervalNr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ReportIntervalNrMdt' + reportAmount: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ReportAmountMdt' + eventThresholdRsrp: + type: integer + minimum: 0 + maximum: 97 + eventThresholdRsrq: + type: integer + minimum: 0 + maximum: 34 + eventThresholdRsrpNr: + type: integer + minimum: 0 + maximum: 127 + eventThresholdRsrqNr: + type: integer + minimum: 0 + maximum: 127 + collectionPeriodRmmLte: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CollectionPeriodRmmLteMdt' + collectionPeriodRmmNr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CollectionPeriodRmmNrMdt' + measurementPeriodLte: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MeasurementPeriodLteMdt' + areaScope: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaScope' + positioningMethod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PositioningMethodMdt' + addPositioningMethodList: + type: array + items: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/PositioningMethodMdt' +minItems: 1 +mdtAllowedPlmnIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + maxItems: 16 +sensorMeasurementList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SensorMeasurement' + minItems: 1 +required: +- jobType + +EpsNasSecurityMode: + description: Indicates the EPS NAS Security Mode + type: object + properties: + integrityAlgorithm: + $ref: '#/components/schemas/EpsNasIntegrityAlgorithm' + cipheringAlgorithm: + $ref: '#/components/schemas/EpsNasCipheringAlgorithm' + required: + - integrityAlgorithm + - cipheringAlgorithm + +EcRestrictionDataWb: + description: Enhanced Coverage Restriction Data for WB-N1 mode + type: object + properties: + ecModeARestricted: + type: boolean + default: false + ecModeBRestricted: + type: boolean + required: + - ecModeBRestricted + +ExtAmfEventSubscription: + description: AMF event subscription extended with additional information received for the + subscription + allOf: + - $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/AmfEventSubscription' + - $ref: '#/components/schemas/AmfEventSubscriptionAddInfo' + +AmfEventSubscriptionAddInfo: + description: Additional information received for an AMF event subscription, e.g. binding + indications + type: object + properties: + bindingInfo: + type: array + items: + type: string + minItems: 1 + maxItems: 2 + subscribingNfType: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + eventSyncInd: + type: boolean + nfConsumerInfo: + type: array + items: + type: string + minItems: 1 + aoiStateList: + type: object + description: > + Map of subscribed Area of Interest (AoI) Event State in the old AMF. The JSON pointer to + an AmfEventArea element in the areaList IE (or a PresenceInfo element in + presenceInfoList IE) of the AmfEvent data type shall be the key of the map. + additionalProperties: + $ref: '#/components/schemas/AreaOfInterestEventState' + accessToken: + type: string + description: > +``` + +JWS Compact Serialized representation of JWS signed JSON object (AccessTokenClaims defined in 3GPP TS 29.510) + +``` + +UeDifferentiationInfo: + description: Represents the UE Differentiation Information and its validity time + type: object + properties: + periodicComInd: + $ref: '#/components/schemas/PeriodicCommunicationIndicator' + periodicTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + scheduledComTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationTime' + stationaryInd: + $ref: 'TS29571_CommonData.yaml#/components/schemas/StationaryIndication' + trafficProfile: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TrafficProfile' + batteryInd: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BatteryIndication' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +CeModeBInd: + description: CE-mode-B Support Indicator. + type: object + properties: + ceModeBSupportInd: + type: boolean + required: + - ceModeBSupportInd + +LteMInd: + description: LTE-M Indication. + type: object + properties: + lteCatMInd: + type: boolean + required: + - lteCatMInd + +NpnAccessInfo: + description: NPN Access Information. + type: object + properties: + cellCagInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CagId' + minItems: 1 + +ProseContext: + description: Represents the ProSe services related parameters. + type: object + properties: + directDiscovery: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + directComm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + 12Relay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + 13Relay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + 12Remote: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + 13Remote: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + 12UeRelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + 13UeRelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + 12End: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + 13End: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + multiPathComm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + nrUePc5Ambr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + +``` + +``` +pc5QoSPara: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pc5QoSPara' + +AnalyticsSubscription: + description: Analytics subscriptions created in the NWDAF. + type: object + properties: + nwdafId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nwdafSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + nwdafSubscriptionList: + type: array + items: + $ref: '#/components/schemas/NwdafSubscription' + minItems: 1 + required: + - nwdafSubscriptionList + +NwdafSubscription: + description: Individual NWDAF subscription identified by the subscription Id. + type: object + properties: + nwdafEvtSubsServiceUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nwdafEventsSubscription: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscription' + required: + - nwdafEvtSubsServiceUri + - nwdafEventsSubscription + +UpdpSubscriptionData: + description: UE policy delivery related N1 message notification subscription data. + type: object + properties: + updpNotifySubscriptionId: + type: string + updpNotifyCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + updpCallbackBinding: + type: string + required: + - updpNotifySubscriptionId + - updpNotifyCallbackUri + +ReleaseSessionInfo: + description: PDU session Id(s) and the cause for triggering the release. + type: object + properties: + releaseSessionList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + minItems: 1 + releaseCause: + $ref: '#/components/schemas/ReleaseCause' + required: + - releaseSessionList + - releaseCause + +AreaOfInterestEventState: + description: Event State of AoI event in old AMF + type: object + required: + - presence + properties: + presence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceState' + individualPraiIdList: + type: array + items: + type: string + minItems: 1 + +TssInformation: +``` + +``` + +description: Represents a Tss related N2 information data part +type: object +properties: + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + tssContainer: + $ref: '#/components/schemas/N2InfoContent' +required: + - tssContainer + +RslpInformation: + description: Represents Ranging/SL positioning related N2 information. + type: object + properties: + n2Pc5RslpPol: + $ref: '#/components/schemas/N2InfoContent' + +A2xContext: + description: Represents the A2X services related parameters + type: object + properties: + nrA2xServicesAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NrA2xAuth' + lteA2xServicesAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/LteA2xAuth' + nrUeSidelinkAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + lteUeSidelinkAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + pc5QoSPara: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pc5QoSPara' + +A2xInformation: + description: A2X related N2 information + type: object + properties: + n2Pc5Pol: + $ref: '#/components/schemas/N2InfoContent' + +AmPolicyInfoContainer: + description: AM Policy Information Container + type: object + properties: + sliceUsgCtrlInfoSets: + type: object + description: A map(list of key-value pairs) where Snssai serves as key. + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SliceUsageControlInfo' + minProperties: 1 + +LcsUpContext: + description: Represents the LCS UP related parameters + type: object + properties: + upConnectionStatus: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/UpConnectionStatus' + servingLMFIdentification: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + +# +# SIMPLE DATA TYPES +# + +EpsBearerId: + description: EPS Bearer Identifier + type: integer + minimum: 0 + maximum: 15 +Ppi: + description: Paging Policy Indicator + type: integer + minimum: 0 + maximum: 7 +NasCount: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +5GMmCapability: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' +UeSecurityCapability: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' +SlUeNetworkCapability: + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + DrxParameter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + OmcIdentifier: + description: Represents the OMC Identifier + type: string + MSClassmark2: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + SupportedCodec: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + +# +# ENUMERATIONS +# + + StatusChange: + description: Enumeration for AMF status + anyOf: + - type: string + enum: + - AMF_UNAVAILABLE + - AMF_AVAILABLE + - type: string + N2InformationClass: + description: Enumeration for N2 Information Class + anyOf: + - type: string + enum: + - SM + - NRPPa + - PWS + - PWS-BCAL + - PWS-RF + - RAN + - V2X + - PROSE + - TSS + - RSPP + - A2X + - type: string + N1MessageClass: + description: Enumeration for N1 Message Class + anyOf: + - type: string + enum: + - 5GMM + - SM + - LPP + - SMS + - UPDP + - LCS + - type: string + N1N2MessageTransferCause: + description: Enumeration for N1N2Message Transfer Cause + anyOf: + - type: string + enum: + - ATTEMPTING_TO_REACH_UE + - N1_N2_TRANSFER_INITIATED + - WAITING_FOR_ASYNCHRONOUS_TRANSFER + - UE_NOT_RESPONDING + - N1_MSG_NOT_TRANSFERRED + - N2_MSG_NOT_TRANSFERRED + - UE_NOT_REACHABLE_FOR_SESSION + - TEMPORARY_REJECT_REGISTRATION ONGOING + - TEMPORARY_REJECT_HANDOVER ONGOING + - REJECTION_DUE_TO_PAGING_RESTRICTION + - AN_NOT_RESPONDING + - FAILURE_CAUSE_UNSPECIFIED + - type: string + UeContextTransferStatus: + description: Describes the status of an individual ueContext resource in UE Context Transfer +procedures + anyOf: + - type: string + enum: + - TRANSFERRED + - NOT_TRANSFERRED + - type: string +``` + +N2InformationTransferResult: +description: Describes the result of N2 information transfer by AMF to the AN +anyOf: +- type: string +enum: +- N2\_INFO\_TRANSFER\_INITIATED +- type: string +CipheringAlgorithm: +description: Indicates the supported Ciphering Algorithm +anyOf: +- type: string +enum: +- NEA0 +- NEA1 +- NEA2 +- NEA3 +- type: string +IntegrityAlgorithm: +description: Indicates the supported Integrity Algorithm +anyOf: +- type: string +enum: +- NIA0 +- NIA1 +- NIA2 +- NIA3 +- type: string +SmsSupport: +description: Indicates the supported SMS delivery of a UE +anyOf: +- type: string +enum: +- 3GPP +- NON\_3GPP +- BOTH +- NONE +- type: string +ScType: +description: Indicates the security context type +anyOf: +- type: string +enum: +- NATIVE +- MAPPED +- type: string +KeyAmfType: +description: Indicates the Kamf type +anyOf: +- type: string +enum: +- KAMF +- KPRIMEAMF +- type: string +TransferReason: +description: Indicates UE Context Transfer Reason +anyOf: +- type: string +enum: +- INIT\_REG +- MOBI\_REG +- MOBI\_REG\_UE\_VALIDATED +- type: string +PolicyReqTrigger: +description: Policy Request Triggers +anyOf: +- type: string +enum: +- LOCATION\_CHANGE +- PRA\_CHANGE +- ALLOWED\_NSSAI\_CHANGE +- NWDAF\_DATA\_CHANGE +- PLMN\_CHANGE +- CON\_STATE\_CHANGE +- SMF\_SELECT\_CHANGE +- ACCESS\_TYPE\_CHANGE +- SAT\_BACKHAUL\_CHANGE +- type: string +RatSelector: + +description: Indicates the RAT type for the transfer of N2 information +anyOf: +- type: string +enum: +- E-UTRA +- NR +- type: string + +NgapIeType: +description: Indicates the supported NGAP IE types +anyOf: +- type: string +enum: +- PDU\_RES\_SETUP\_REQ +- PDU\_RES\_REL\_CMD +- PDU\_RES\_MOD\_REQ +- HANDOVER\_CMD +- HANDOVER\_REQUIRED +- HANDOVER\_PREP\_FAIL +- SRC\_TO\_TAR\_CONTAINER +- TAR\_TO\_SRC\_CONTAINER +- TAR\_TO\_SRC\_FAIL\_CONTAINER +- RAN\_STATUS\_TRANS\_CONTAINER +- SON\_CONFIG\_TRANSFER +- NRPFA\_PDU +- UE\_RADIO\_CAPABILITY +- RIM\_INFO\_TRANSFER +- SECONDARY\_RAT\_USAGE +- PC5\_QOS\_PARA +- EARLY\_STATUS\_TRANS\_CONTAINER +- UE\_RADIO\_CAPABILITY\_FOR\_PAGING +- type: string + +N2InfoNotifyReason: +description: N2 Information Notify Reason +anyOf: +- type: string +enum: +- HANDOVER\_COMPLETED +- type: string + +SmfChangeIndication: +description: Indicates the I-SMF or V-SMF change or removal +anyOf: +- type: string +enum: +- CHANGED +- REMOVED +- type: string + +SbiBindingLevel: +description: SBI Binding Level +anyOf: +- type: string +enum: +- NF\_INSTANCE\_BINDING +- NF\_SET\_BINDING +- NF\_SERVICE\_SET\_BINDING +- NF\_SERVICE\_INSTANCE\_BINDING +- type: string + +EpsNasCipheringAlgorithm: +description: Indicates the supported EPS NAS Ciphering Algorithm +anyOf: +- type: string +enum: +- EEA0 +- EEA1 +- EEA2 +- EEA3 +- type: string + +EpsNasIntegrityAlgorithm: +description: Indicates the supported EPS NAS Integrity Algorithm +anyOf: +- type: string +enum: +- EIA0 +- EIA1 +- EIA2 +- EIA3 +- type: string + +``` +PeriodicCommunicationIndicator: + description: Indicates the Periodic Communication Indicator + anyOf: + - type: string + enum: + - PERIODICALLY + - ON_DEMAND + - type: string + +UuamMmStatus: + description: Indicates the UUAM-MM status + anyOf: + - type: string + enum: + - SUCCESS + - PENDING + - FAILED + - type: string + +ReleaseCause: + description: The cause for triggering the release. + anyOf: + - type: string + enum: + - SNPN_SNPN_MOBILITY + - NO_HR_AGREEMENT + - UNSPECIFIED + - type: string +``` + +--- + +## A.3 Namf\_EventExposure API + +openapi: 3.0.0 + +``` +info: + version: 1.3.0-alpha.4 + title: Namf_EventExposure + description: | + AMF Event Exposure Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +security: +- {} +- oAuth2ClientCredentials: + - namf-evts + +externalDocs: + description: 3GPP TS 29.518 V18.4.0; 5G System; Access and Mobility Management Services + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/' + +servers: +- url: '{apiRoot}/namf-evts/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +paths: + /subscriptions: + post: + summary: Namf_EventExposure Subscribe service Operation + tags: + - Subscriptions collection (Collection) + operationId: CreateSubscription + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AmfCreateEventSubscription' + required: true + responses: + '201': + description: Subscription Created + headers: +``` + +``` + + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/namf-evts/{apiVersion}/subscriptions/{subscriptionId}' + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AmfCreatedEventSubscription' +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +callbacks: + onEventReport: + '{ $request.body#/subscription/eventNotifyUri }': + post: + summary: Event Notification Delivery + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AmfEventNotification' + required: true + responses: + '204': + description: Successful acknowledgement + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + +``` + +``` + + default: + description: Unexpected error +onSubscriptionIdChangeEvtReport: + '{ $request.body#/subscription/subsChangeNotifyUri }': + post: + summary: Event Notification Delivery For Subscription Id Change + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AmfEventNotification' + required: true + responses: + '204': + description: Successful acknowledgement + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/subscriptions/{subscriptionId}: + patch: + summary: Namf_EventExposure Subscribe Modify service Operation + tags: + - Individual subscription (Document) + operationId: ModifySubscription + parameters: + - name: subscriptionId + in: path + required: true + description: Unique ID of the subscription to be modified + schema: + type: string + requestBody: + content: + application/json-patch+json: + schema: + oneOf: + - type: array + items: + $ref: '#/components/schemas/AmfUpdateEventSubscriptionItem' + minItems: 1 + - type: array + items: + $ref: '#/components/schemas/AmfUpdateEventOptionItem' + minItems: 1 + maxItems: 1 + required: true + responses: + '200': + description: Subscription modified successfully + content: + application/json: + schema: + $ref: '#/components/schemas/AmfUpdatedEventSubscription' + +``` + +``` +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +delete: + summary: Namf_EventExposure Unsubscribe service Operation + tags: + - Individual subscription (Document) + operationId: DeleteSubscription + parameters: + - name: subscriptionId + in: path + required: true + description: Unique ID of the subscription to be deleted + schema: + type: string + responses: + '204': + description: Subscription deleted successfully + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' +``` + +``` +scopes: + namf-evts: Access to the Namf_EventExposure API +schemas: + AmfEventSubscription: + description: Represents an individual event subscription resource on AMF + type: object + properties: + eventList: + type: array + items: + $ref: '#/components/schemas/AmfEvent' + minItems: 1 + eventNotifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifyCorrelationId: + type: string + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + subsChangeNotifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + subsChangeNotifyCorrelationId: + type: string + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + excludeSupiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + excludeGpsiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + includeSupiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + includeGpsiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + anyUE: + type: boolean + options: + $ref: '#/components/schemas/AmfEventMode' + sourceNFType: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + termNotifyInd: + type: boolean + required: + - eventList + - eventNotifyUri + - notifyCorrelationId + - nfId + + AmfEvent: + description: Describes an event to be subscribed + type: object + properties: + type: + $ref: '#/components/schemas/AmfEventType' + immediateFlag: + type: boolean + default: false + areaList: + type: array + items: + $ref: '#/components/schemas/AmfEventArea' + minItems: 1 +``` + +``` +locationFilterList: + type: array + items: + $ref: '#/components/schemas/LocationFilter' + minItems: 1 + refId: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/ReferenceId' +trafficDescriptorList: + type: array + items: + $ref: '#/components/schemas/TrafficDescriptor' + minItems: 1 +reportUeReachable: + type: boolean + default: false +reachabilityFilter: + $ref: '#/components/schemas/ReachabilityFilter' +udmDetectInd: + type: boolean + default: false +maxReports: + type: integer +presenceInfoList: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: A map(list of key-value pairs) where prId serves as key. +maxResponseTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +targetArea: + $ref: '#/components/schemas/TargetArea' +snssaiFilter: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 +ueInAreaFilter: + $ref: '#/components/schemas/UeInAreaFilter' +minInterval: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +nextReport: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +idleStatusInd: + type: boolean + default: false +dispersionArea: + $ref: '#/components/schemas/DispersionArea' +nextPeriodicReportTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +adjustAoIonRa: + type: boolean + default: false +ranTimingSynchroStatusChange: + type: boolean + default: false +notifyForSupiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 +notifyForSnssaiDnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI_DNNItem' + minItems: 1 +required: +- type +AmfEventNotification: + description: Data within a AMF Event Notification request + type: object + properties: + notifyCorrelationId: + type: string + subsChangeNotifyCorrelationId: + type: string + reportList: + type: array +``` + +``` + items: + $ref: '#/components/schemas/AmfEventReport' + minItems: 1 + eventSubsSyncInfo: + $ref: '#/components/schemas/AmfEventSubsSyncInfo' +AmfEventReport: + description: Represents a report triggered by a subscribed event type + type: object + properties: + type: + $ref: '#/components/schemas/AmfEventType' + state: + $ref: '#/components/schemas/AmfEventState' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + subscriptionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + anyUe: + type: boolean + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + areaList: + type: array + items: + $ref: '#/components/schemas/AmfEventArea' + minItems: 1 + refId: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/ReferenceId' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + location: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + additionalLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + timezone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + accessTypeList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + rmInfoList: + type: array + items: + $ref: '#/components/schemas/RmInfo' + minItems: 1 + cmInfoList: + type: array + items: + $ref: '#/components/schemas/CmInfo' + minItems: 1 + reachability: + $ref: '#/components/schemas/UeReachability' + commFailure: + $ref: '#/components/schemas/CommunicationFailure' + lossOfConnectReason: + $ref: '#/components/schemas/LossOfConnectivityReason' + numberOfUes: + type: integer + 5gsUserStateList: + type: array + items: + $ref: '#/components/schemas/5GsUserStateInfo' + minItems: 1 + typeCode: + type: string + pattern: '^imeitac-[0-9]{8}$' + registrationNumber: + type: integer + maxAvailabilityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + ueIdExt: + type: array + items: + $ref: '#/components/schemas/UEIdExt' + minItems: 1 +``` + +``` +snssaiTaiList: + type: array + items: + $ref: '#/components/schemas/SNSSaiTaiMapping' + minItems: 1 +idleStatusIndication: + $ref: '#/components/schemas/IdleStatusIndication' +ueAccessBehaviorTrends: + type: array + items: + $ref: '#/components/schemas/UeAccessBehaviorReportItem' + minItems: 1 +ueLocationTrends: + type: array + items: + $ref: '#/components/schemas/UeLocationTrendsReportItem' + minItems: 1 +mmTransLocationReportList: + type: array + items: + $ref: '#/components/schemas/MmTransactionLocationReportItem' + minItems: 1 +mmTransSliceReportList: + type: array + items: + $ref: '#/components/schemas/MmTransactionSliceReportItem' + minItems: 1 +termReason: + $ref: '#/components/schemas/SubTerminationReason' +unavailabilityPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +required: +- type +- state +- timeStamp +AmfEventMode: + description: Describes how the reports shall be generated by a subscribed event + type: object + properties: + trigger: + $ref: '#/components/schemas/AmfEventTrigger' + maxReports: + type: integer + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + repPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + sampRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + partitioningCriteria: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PartitioningCriteria' + minItems: 1 + notifFlag: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NotificationFlag' + mutingExcInstructions: + writeOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/MutingExceptionInstructions' + mutingNotSettings: + readOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/MutingNotificationsSettings' + varRepPeriodInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarRepPeriod' + minItems: 1 + required: + - trigger +AmfEventState: + description: Represents the state of a subscribed event + type: object + properties: + active: + type: boolean + remainReports: +``` + +``` + type: integer + remainDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + required: + - active +RmInfo: + description: Represents the registration state of a UE for an access type + type: object + properties: + rmState: + $ref: '#/components/schemas/RmState' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + required: + - rmState + - accessType +CmInfo: + description: Represents the connection management state of a UE for an access type + type: object + properties: + cmState: + $ref: '#/components/schemas/CmState' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + required: + - cmState + - accessType +CommunicationFailure: + description: Describes a communication failure detected by AMF + type: object + properties: + nasReleaseCode: + type: string + ranReleaseCode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' +AmfCreateEventSubscription: + description: Data within a create AMF event subscription request + type: object + properties: + subscription: + $ref: '#/components/schemas/AmfEventSubscription' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + oldGuami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + required: + - subscription +AmfCreatedEventSubscription: + description: Data within a create AMF event subscription response + type: object + properties: + subscription: + $ref: '#/components/schemas/AmfEventSubscription' + subscriptionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + reportList: + type: array + items: + $ref: '#/components/schemas/AmfEventReport' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - subscription + - subscriptionId +AmfUpdateEventSubscriptionItem: + description: Document describing the modification(s) to an AMF Event Subscription + type: object + properties: + op: + type: string + enum: + - add + - remove + - replace + path: + type: string +``` + +``` + + pattern: + '^(/eventList|/|(\|/eventList\|/0\|/eventList\|/[1-9][0-9]*){1}(\|/presenceInfoList\|/0\|/ +presenceInfoList\|/[1-9][0-9]* \|/notifyForSupiList\|/notifyForSnssaiDnnList)?\|/|/excludeSupiList\|/|/ +excludeGpsiList\|/|/includeSupiList\|/|/includeGpsiList$' + value: + $ref: '#/components/schemas/AmfEvent' + presenceInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + excludeSupiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + excludeGpsiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + includeSupiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + includeGpsiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + notifyForSupiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + notifyForSnssaiDnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + minItems: 1 + required: + - op + - path + AmfUpdateEventOptionItem: + description: Document describing the modifications to AMF event subscription options + type: object + properties: + op: + type: string + enum: + - replace + path: + type: string + pattern: '^(/options\|/expiry\|/options\|/notifFlag\|/options\|/mutingExcInstructions)$' + value: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + notifFlag: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NotificationFlag' + mutingExcInstructions: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MutingExceptionInstructions' + required: + - op + - path + - value + AmfUpdatedEventSubscription: + description: Represents a successful update on an AMF Event Subscription + type: object + properties: + subscription: + $ref: '#/components/schemas/AmfEventSubscription' + reportList: + type: array + items: + $ref: '#/components/schemas/AmfEventReport' + minItems: 1 + required: + - subscription + AmfEventArea: + description: Represents an area to be monitored by an AMF event + type: object + +``` + +``` +properties: + presenceInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + ladnInfo: + $ref: '#/components/schemas/LadnInfo' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + nsiId: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsiId' +LadnInfo: + description: LADN Information + type: object + properties: + ladn: + type: string + presence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceState' + required: + - ladn +5GsUserStateInfo: + description: Represents the 5GS User state of the UE for an access type + type: object + properties: + 5gsUserState: + $ref: '#/components/schemas/5GsUserState' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + required: + - 5gsUserState + - accessType +TrafficDescriptor: + description: Represents the Traffic Descriptor + type: object + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + dddTrafficDescriptorList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor' + minItems: 1 +UEIdExt: + description: UE Identity + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' +AmfEventSubsSyncInfo: + description: AMF Event Subscriptions Information for synchronization + type: object + properties: + subscriptionList: + type: array + items: + $ref: '#/components/schemas/AmfEventSubscriptionInfo' + minItems: 1 + required: + - subscriptionList +AmfEventSubscriptionInfo: + description: Individual AMF Event Subscription Information + type: object + properties: + subId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifyCorrelationId: + type: string + refIdList: + type: array + items: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/ReferenceId' + minItems: 1 + oldSubId: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +required: +- subId +- refIdList + +TargetArea: +description: TA list or TAI range list or any TA +type: object +properties: + taList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TaiRange' + minItems: 1 + anyTa: + type: boolean + default: false + +SnssaiTaiMapping: +description: List of restricted or unrestricted S-NSSAIs per TAI(s) +type: object +properties: + reportingArea: + $ref: '#/components/schemas/TargetArea' + accessTypeList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + supportedSnssaiList: + type: array + items: + $ref: '#/components/schemas/SupportedSnssai' + minItems: 1 +required: +- reportingArea + +UeAccessBehaviorReportItem: +description: Report Item for UE Access Behavior Trends event. +type: object +properties: + stateTransitionType: + $ref: '#/components/schemas/AccessStateTransitionType' + spacing: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + duration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +required: +- stateTransitionType +- spacing +- duration + +IdleStatusIndication: +description: Represents the idle status indication. +type: object +properties: + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + activeTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + subsRegTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + edrxCycleLength: + type: integer + suggestedNumOfDLPackets: + type: integer + +UeInAreaFilter: +description: Additional filters for UE in Area Report event +type: object +properties: + ueType: + $ref: '#/components/schemas/UeType' +``` + +``` +aerialSrvDnnInd: + type: boolean + default: false +ueIdOmitInd: + type: boolean + default: false + +SupportedSnssai: + description: Supported S-NSSAIs + type: object + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + restrictionInd: + type: boolean + default: false + required: + - sNssai + +UeLocationTrendsReportItem: + description: Report Item for UE Location Trends event. + type: object + properties: + tai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + n3gaLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/N3gaLocation' + spacing: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + duration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + timestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - spacing + - duration + - timestamp + +DispersionArea: + description: Dispersion Area + type: object + properties: + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + ncgiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + minItems: 1 + ecgiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + minItems: 1 + n3gaInd: + type: boolean + default: false + +MmTransactionLocationReportItem: + description: UE MM Transaction Report Item per Location + type: object + properties: + tai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + n3gaLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/N3gaLocation' + timestamp: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +transactions: + type: integer +required: +- timestamp +- transactions + +MmTransactionSliceReportItem: +description: UE MM Transaction Report Item per Slice +type: object +properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + timestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + transactions: + type: integer +required: +- timestamp +- transactions + +AmfEventType: +description: Describes the supported event types of Namf_EventExposure Service +anyOf: +- type: string + enum: + - LOCATION_REPORT + - PRESENCE_IN_AOI_REPORT + - TIMEZONE_REPORT + - ACCESS_TYPE_REPORT + - REGISTRATION_STATE_REPORT + - CONNECTIVITY_STATE_REPORT + - REACHABILITY_REPORT + - COMMUNICATION_FAILURE_REPORT + - UES_IN_AREA_REPORT + - SUBSCRIPTION_ID_CHANGE + - SUBSCRIPTION_ID_ADDITION + - SUBSCRIPTION_TERMINATION + - LOSS_OF_CONNECTIVITY + - 5GS_USER_STATE_REPORT + - AVAILABILITY_AFTER_DDN_FAILURE + - TYPE ALLOCATION CODE REPORT + - FREQUENT MOBILITY REGISTRATION_REPORT + - SNSSAI TA MAPPING REPORT + - UE_LOCATION_TRENDS + - UE_ACCESS_BEHAVIOR_TRENDS + - UE_MM_TRANSACTION_REPORT +- type: string + +AmfEventTrigger: +description: Describes how AMF should generate the report for the event +anyOf: +- type: string + enum: + - ONE_TIME + - CONTINUOUS + - PERIODIC +- type: string + +LocationFilter : +description: Describes the supported filters of LOCATION_REPORT event type +anyOf: +- type: string + enum: + - TAI + - CELL_ID + - RAN_NODE + - N3IWF + - UE_IP + - UDP_PORT + - TNAP_ID + - GLI + - TWAP_ID +- type: string + +UeReachability: +description: Describes the reachability of the UE +anyOf: +- type: string + enum: + - UNREACHABLE +``` + +- REACHABLE +- REGULATORY\_ONLY +- type: string + +RmState: +description: Describes the registration management state of a UE +anyOf: +- type: string +enum: +- REGISTERED +- DEREGISTERED +- type: string + +CmState: +description: Describes the connection management state of a UE +anyOf: +- type: string +enum: +- IDLE +- CONNECTED +- type: string + +5GsUserState: +description: Describes the 5GS User State of a UE +anyOf: +- type: string +enum: +- DEREGISTERED +- CONNECTED\_NOT\_REACHABLE\_FOR\_PAGING +- CONNECTED\_REACHABLE\_FOR\_PAGING +- NOT\_PROVIDED\_FROM\_AMF +- type: string + +LossOfConnectivityReason: +description: Describes the reason for loss of connectivity +anyOf: +- type: string +enum: +- DEREGISTERED +- MAX\_DETECTION\_TIME\_EXPIRED +- PURGED +- UNAVAILABLE\_PERIOD +- type: string + +ReachabilityFilter: +description: Event filter for REACHABILITY\_REPORT event type +anyOf: +- type: string +enum: +- UE\_REACHABILITY\_STATUS\_CHANGE +- UE\_REACHABLE\_DL\_TRAFFIC +- type: string + +UeType: +description: Describes the type of UEs +anyOf: +- type: string +enum: +- AERIAL\_UE +- type: string + +AccessStateTransitionType: +description: Access State Transition Type. +anyOf: +- type: string +enum: +- ACCESS\_TYPE\_CHANGE\_3GPP +- ACCESS\_TYPE\_CHANGE\_N3GPP +- RM\_STATE\_CHANGE\_DEREGISTERED +- RM\_STATE\_CHANGE\_REGISTERED +- CM\_STATE\_CHANGE\_IDLE +- CM\_STATE\_CHANGE\_CONNECTED +- HANDOVER +- MOBILITY\_REGISTRATION\_UPDATE +- type: string + +SubTerminationReason: +description: Subscription Termination Reason. +anyOf: +- type: string +enum: +- INVALID\_SUBSCRIPTION + +- SUBSCRIPTION\_NOT\_AUTHORIZED +- type: string + +## A.4 Namf\_MT + +``` + +openapi: 3.0.0 + +info: + version: 1.3.0-alpha.4 + title: Namf_MT + description: | + AMF Mobile Terminated Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +security: + - {} + - oAuth2ClientCredentials: + - namf-mt + +externalDocs: + description: 3GPP TS 29.518 V18.4.0; 5G System; Access and Mobility Management Services + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/' + +servers: + - url: '{apiRoot}/namf-mt/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +paths: + '/ue-contexts/{ueContextId}': + get: + summary: Namf_MT Provide Domain Selection Info service Operation + tags: + - ueContext (Document) + operationId: Provide Domain Selection Info + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|.+)$' + - name: info-class + in: query + description: UE Context Information Class + schema: + $ref: '#/components/schemas/UeContextInfoClass' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: old-guami + in: query + description: Old GUAMI + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + + responses: + '200': + description: Requested UE Context Information returned + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextInfo' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + +``` + +``` + +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' +'414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +/ue-contexts/{ueContextId}/ue-reachind: + put: + summary: Namf_MT EnableUeReachability service Operation + tags: + - ueReachInd (Document) + operationId: EnableUeReachability + security: + - {} + - oAuth2ClientCredentials: + - namf-mt + - oAuth2ClientCredentials: + - namf-mt + - namf-mt:ue-reachind + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnableUeReachabilityReqData' + required: true + responses: + '200': + description: UE has become reachable as desired + content: + application/json: + schema: + $ref: '#/components/schemas/EnableUeReachabilityRspData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetailsEnableUeReachability' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + description: Gateway Timeout + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetailsEnableUeReachability' + default: + description: Unexpected error + +/ue-contexts/enable-group-reachability: + post: + summary: Namf_MT EnableGroupReachability service Operation + tags: + - ueContexts (collection) + operationId: EnableGroupReachability + security: + - {} + - oAuth2ClientCredentials: + - namf-mt + - oAuth2ClientCredentials: + - namf-mt + - namf-mt:enable-group-reachability + requestBody: + description: list of UEs requested to be made reachable for the related TMGI + content: + application/json: + schema: + $ref: '#/components/schemas/EnableGroupReachabilityReqData' + required: true + responses: + '200': + description: Successful response. + content: + application/json: + schema: + $ref: '#/components/schemas/EnableGroupReachabilityRspData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + description: Unexpected error + callbacks: + reachabilityNotification: + '{request.body#/reachabilityNotifyUri}': + post: + requestBody: + +``` + +``` + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ReachabilityNotificationData' + responses: + '204': + description: UE reachability notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + namf-mt: Access to the Namf_MT API + namf-mt:ue-reachind: > + Access to the EnableUeReachability service operation + namf-mt:enable-group-reachability: > + Access to the EnableGroupReachability service operation + +schemas: + EnableUeReachabilityReqData: + description: Data within the Enable UE Reachability Request + type: object + properties: + reachability: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/UeReachability' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + oldGuami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + extBufSupport: + type: boolean + default: false + arp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + ppi: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/Ppi' + qfi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + required: + - reachability + EnableUeReachabilityRspData: +``` + +``` +description: Data within the Enable UE Reachability Response +type: object +properties: + reachability: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/UeReachability' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - reachability +UeContextInfo: + description: UE Context Information + type: object + properties: + supportVoPS: + type: boolean + supportVoPSn3gpp: + type: boolean + lastActTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +ProblemDetailsEnableUeReachability: + description: Enable UE Reachability Error Detail + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/AdditionInfoEnableUeReachability' +AdditionInfoEnableUeReachability: + description: Additional information to be returned in EnableUeReachability error response + type: object + properties: + maxWaitingTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +EnableGroupReachabilityReqData: + description: Data within the Enable Group Reachability Request + type: object + properties: + ueInfoList: + type: array + items: + $ref: '#/components/schemas/UeInfo' + minItems: 1 + tmgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tmgi' + reachabilityNotifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + mbsServiceAreaInfoList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceAreaInfo' + minItems: 1 + arp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - ueInfoList + - tmgi +EnableGroupReachabilityRspData: + description: Data within the Enable Group Reachability Response + type: object + properties: + ueConnectedList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +UeInfo: + description: list of UEs requested to be made reachable for the MBS Session + type: object +``` + +``` + +properties: + ueList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' +required: + - ueList + +ReachabilityNotificationData: + description: Data within the UE Reachability Info Notify + type: object + properties: + reachableUeList: + type: array + items: + $ref: '#/components/schemas/ReachableUeInfo' + minItems: 1 + unreachableUeList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + ReachableUeInfo: + description: Contains the reachable UE Information + type: object + properties: + ueList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + userLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + required: + - ueList + +UeContextInfoClass: + description: Indicates the UE Context information class + anyOf: + - type: string + enum: + - TADS + - type: string + +``` + +## A.5 Namf\_Location + +openapi: 3.0.0 + +``` + +info: + version: 1.3.0-alpha.5 + title: Namf_Location + description: | + AMF Location Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +security: + - {} + - oAuth2ClientCredentials: + - namf-loc + +externalDocs: + description: 3GPP TS 29.518 V18.4.0; 5G System; Access and Mobility Management Services + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/' + +servers: + - url: '{apiRoot}/namf-loc/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +paths: + +``` + +``` + +{/ueContextId}/provide-pos-info: + post: + summary: Namf_Location ProvidePositioningInfo service Operation + tags: + - Individual UE context (Document) + operationId: ProvidePositioningInfo + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^((imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+))$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RequestPosInfo' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ProvidePosInfoExt' + '204': + description: Successful accept of location request with no information returned. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + description: Conflict + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetailsProvidePosInfo' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + description: Unexpected error + callbacks: + onUELocationNotification: + "{$request.body#/locationNotificationUri}": + post: + requestBody: + description: UE Location Event Notification + content: + application/json: + schema: + $ref: '#/components/schemas/NotifiedPosInfoExt' + responses: + '204': + description: Expected response to a successful callback processing + +``` + +``` + + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +/{ueContextId}/provide-loc-info: + post: + summary: Namf_Location ProvideLocationInfo service Operation + tags: + - Individual UE context (Document) + operationId: ProvideLocationInfo + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^((imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+))$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RequestLocInfo' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ProvideLocInfo' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueContextId}/cancel-pos-info: + post: + summary: Namf_Location CancelLocation service operation + tags: + - Individual UE context (Document) + operationId: CancelLocation + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^((imsi-[0-9]{5,15}|nai-.+|glici-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+))$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelPosInfo' + required: true + responses: + '204': + description: Expected response to a successful cancellation + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + namf-loc: Access to the Namf_Location API + schemas: + RequestPosInfo: + description: Data within Provide Positioning Information Request + type: object + properties: + lcsClientType: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/ExternalClientType' + lcsLocation: + $ref: '#/components/schemas/LocationType' + supi: + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + requestedRangingSlResult: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RangingSlResult' + minItems: 1 + relatedUEs: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RelatedUE' + minItems: 1 + lmfId: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + priority: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LcsPriority' + lcsQoS: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocationQoS' + velocityRequested: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityRequested' + lcsSupportedGADShapes: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/SupportedGADShapes' + additionalLcsSuppGADShapes: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/SupportedGADShapes' + minItems: 1 + locationNotificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + oldGuami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + lcsServiceType: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LcsServiceType' + ldrType: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LdrType' + hgmlcCallbackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + lirGmlcCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ldrReference: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LdrReference' + lirReference: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LirReference' + periodicEventInfo: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PeriodicEventInfo' + areaEventInfo: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AreaEventInfo' + motionEventInfo: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/MotionEventInfo' + externalClientIdentification: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/ExternalClientIdentification' + afID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + codeWord: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/CodeWord' + uePrivacyRequirements: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/UePrivacyRequirements' + scheduledLocTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + reliableLocReq: + type: boolean + default: false + intermediateLocationInd: + type: boolean + default: false + maxRespTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + ueUnawareInd: + type: boolean + enum: + - true + lpHapType: + $ref: '#/components/schemas/LpHapType' + +``` + +``` + evtRptAllowedAreas: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/ReportingArea' + minItems: 1 + maxItems: 250 + reportingInd: + allOf: + - $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/ReportingInd' + default: INSIDE_REPORTING + integrityRequirements: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/IntegrityRequirements' + upLocRepInfoAf: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/UpLocRepInfoAf' + mappedQoSEps: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/MappedLocationQoSEps' + required: + - lcsClientType + - lcsLocation + +ProvidePosInfoExt: + description: Extended provided positioning information for UEs + allOf: + - $ref: '#/components/schemas/ProvidePosInfo' + - $ref: '#/components/schemas/AddProvidePosInfos' + +ProvidePosInfo: + description: Data within Provide Positioning Information Response + type: object + properties: + locationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + localLocationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocalArea' + accuracyFulfilmentIndicator: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AccuracyFulfilmentIndicator' + ageOfLocationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate' + timestampOfLocationEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + velocityEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' + positioningDataList: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PositioningMethodAndUsage' + minItems: 0 + maxItems: 9 + gnssPositioningDataList: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GnssPositioningMethodAndUsage' + minItems: 0 + maxItems: 9 + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + targetServingNode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + targetMmeName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + targetMmeRealm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + utranSrvcInd: + type: boolean + civicAddress: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' + barometricPressure: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/BarometricPressure' + altitude: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Altitude' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + servingLMFIdentification: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + locationPrivacyVerResult: +``` + +``` + + $ref: '#/components/schemas/LocationPrivacyVerResult' + achievedQos: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/MinorLocationQoS' + directReportInd: + type: boolean + default: false + acceptedPeriodicEventInfo: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PeriodicEventInfo' + haGnssMetrics: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/HighAccuracyGnssMetrics' + indoorOutdoorInd: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/IndoorOutdoorInd' + losNlosMeasureInd: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LosNlosMeasureInd' + relatedApplicationlayerId: + type: string + rangeDirection: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RangeDirection' + 2dRelativeLocation: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/2DRelativeLocation' + 3dRelativeLocation: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/3DRelativeLocation' + relativeVelocity: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' + +NotifiedPosInfoExt: + description: Extended notified positioning information for UEs + allOf: + - $ref: '#/components/schemas/NotifiedPosInfo' + - $ref: '#/components/schemas/AddNotifiedPosInfos' + +NotifiedPosInfo: + description: Data within EventNotify notification + type: object + properties: + locationEvent: + $ref: '#/components/schemas/LocationEvent' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + locationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + localLocationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocalArea' + ageOfLocationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate' + timestampOfLocationEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + velocityEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' + positioningDataList: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PositioningMethodAndUsage' + minItems: 0 + maxItems: 9 + gnssPositioningDataList: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GnssPositioningMethodAndUsage' + minItems: 0 + maxItems: 9 + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + servingNode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + targetMmeName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + targetMmeRealm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + utranSrvccInd: + type: boolean + +``` + +``` + +civicAddress: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' +barometricPressure: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/BarometricPressure' +altitude: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Altitude' +hmlcCallbackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +ldrReference: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LdrReference' +servingLMFIdentification: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' +terminationCause: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/TerminationCause' +achievedQos: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/MinorLocationQoS' +mscServerId: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/E164Number' +haGnssMetrics: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/HighAccuracyGnssMetrics' +indoorOutdoorInd: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/IndoorOutdoorInd' +losNlosMeasureInd: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LosNlosMeasureInd' +relatedApplicationlayerId: + type: string +rangeDirection: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RangeDirection' +2dRelativeLocation: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/2DRelativeLocation' +3dRelativeLocation: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/3DRelativeLocation' +relativeVelocity: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' +required: +- locationEvent + +RequestLocInfo: + description: Data within Provide Location Information Request + type: object + properties: + req5gsLoc: + type: boolean + default: false + reqCurrentLoc: + type: boolean + default: false + reqRatType: + type: boolean + default: false + reqTimeZone: + type: boolean + default: false + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +ProvideLocInfo: + description: Data within Provide Location Information Response + type: object + properties: + currentLoc: + type: boolean + location: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + additionalLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + geoInfo: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + locationAge: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + timezone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + oldGuami: + +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + +CancelPosInfo: + description: Data within a Cancel Location Request + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + hgmlcCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ldrReference: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LdrReference' + servingLMFIdentification: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - supi + - hgmlcCallBackURI + - ldrReference + +ProblemDetailsProvidePosInfo: + description: Handover from 5GS to EPS Error Details. + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/ProvidePosInfo' + +AddNotifiedPosInfos: + type: object + properties: + addProvidePosInfos: + type: array + items: + $ref: '#/components/schemas/NotifiedPosInfo' + minItems: 1 + +AddProvidePosInfos: + type: object + properties: + addProvidePosInfos: + type: array + items: + $ref: '#/components/schemas/ProvidePosInfo' + minItems: 1 + +LocationType: + description: Type of location measurement requested + anyOf: + - type: string + enum: + - CURRENT_LOCATION + - CURRENT_OR_LAST_KNOWN_LOCATION + - NOTIFICATION_VERIFICATION_ONLY + - DEFERRED_LOCATION + - type: string + +LocationEvent: + description: Type of events initiating location procedures + anyOf: + - type: string + enum: + - EMERGENCY_CALL_ORIGINATION + - EMERGENCY_CALL_RELEASE + - EMERGENCY_CALL_HANDOVER + - ACTIVATION_OF_DEFERRED_LOCATION + - UE_MOBILITY_FOR_DEFERRED_LOCATION + - CANCELLATION_OF_DEFERRED_LOCATION + - type: string + +LocationPrivacyVerResult: + description: The result of location privacy verification by UE + anyOf: + - type: string + enum: + - LOCATION_ALLOWED + - LOCATION_NOT_ALLOWED + - RESPONSE_TIME_OUT +``` + +``` + +- type: string + +LpHapType: + description: Type of Low Power and/or High Accuracy Positioning + anyOf: + - type: string + enum: + - LOW_POW_HIGH_ACCU_POS + - type: string + +``` + +## A.6 Namf\_MBSBroadcast API + +openapi: 3.0.0 + +``` + +info: + version: 1.1.0-alpha.3 + title: Namf_MBSBroadcast + description: | + AMF MBSBroadcast Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.518 V18.4.0; 5G System; Access and Mobility Management Services + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/' + +servers: +- url: '{apiRoot}/namf-mbs-bc/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: +- {} +- oAuth2ClientCredentials: + - namf-mbs-bc + +paths: +/mbs-contexts: + post: + summary: Namf_MBSBroadcast ContextCreate service Operation + tags: + - Broadcast MBS session contexts collection (Collection) + operationId: ContextCreate + requestBody: + content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/ContextCreateReqData' + binaryDataN2Information: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + required: true + callbacks: + contextStatusNotification: + '{ $request.body#/notifyUri }': + post: + requestBody: # notification request without binary body part + required: true + content: + application/json: + schema: + +``` + +``` +$ref: '#/components/schemas/ContextStatusNotification' +multipart/related: # notification request with binary body part(s) +schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/ContextStatusNotification' + binaryDataN2Information1: + type: string + format: binary + binaryDataN2Information2: + type: string + format: binary + binaryDataN2Information3: + type: string + format: binary + binaryDataN2Information4: + type: string + format: binary + binaryDataN2Information5: + type: string + format: binary + binaryDataN2Information6: + type: string + format: binary + binaryDataN2Information7: + type: string + format: binary + binaryDataN2Information8: + type: string + format: binary + binaryDataN2Information9: + type: string + format: binary + binaryDataN2Information10: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information3: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information7: + contentType: application/vnd.3gpp.ngap +``` + +``` +headers: + Content-Id: + schema: + type: string +binaryDataN2Information8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2Information9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2Information10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +responses: + '200': + description: successful notification response with content + content: + multipart/related: # notification response with binary body part(s) + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/ContextStatusNotificationResponse' + binaryDataN2Information1: + type: string + format: binary + binaryDataN2Information2: + type: string + format: binary + binaryDataN2Information3: + type: string + format: binary + binaryDataN2Information4: + type: string + format: binary + binaryDataN2Information5: + type: string + format: binary + binaryDataN2Information6: + type: string + format: binary + binaryDataN2Information7: + type: string + format: binary + binaryDataN2Information8: + type: string + format: binary + binaryDataN2Information9: + type: string + format: binary + binaryDataN2Information10: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information3: +``` + +``` + + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information7: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +'204': + description: successful notification +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +responses: + '201': + description: MBS Broadcast context created successfully + +``` + +``` + +headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/namf-mbs-bc/{apiVersion}/mbs-contexts/{mbsContextRef}' + required: true + schema: + type: string +content: + application/json: # message without binary body part(s) + schema: + $ref: '#/components/schemas/ContextCreateRspData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Response parts + jsonData: + $ref: '#/components/schemas/ContextCreateRspData' + binaryDataN2Information1: + type: string + format: binary + binaryDataN2Information2: + type: string + format: binary + binaryDataN2Information3: + type: string + format: binary + binaryDataN2Information4: + type: string + format: binary + binaryDataN2Information5: + type: string + format: binary + binaryDataN2Information6: + type: string + format: binary + binaryDataN2Information7: + type: string + format: binary + binaryDataN2Information8: + type: string + format: binary + binaryDataN2Information9: + type: string + format: binary + binaryDataN2Information10: + type: string + format: binary +encoding: + jsonData: + contentType: application/json + binaryDataN2Information1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information3: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + +``` + +``` + + schema: + type: string + binaryDataN2Information6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information7: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/mbs-contexts/{mbsContextRef}: + delete: + summary: Namf_MBSBroadcast ContextDelete service Operation + tags: + - Individual broadcast MBS session context (Document) + operationId: ContextDelete + parameters: + - name: mbsContextRef + in: path + required: true + description: Unique ID of the broadcast MSB session context to be deleted + schema: + type: string + responses: + '204': + description: successful deletion + '307': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/mbs-contexts/{mbsContextRef}/update: + post: + summary: Namf_MBSBroadcast ContextUpdate service Operation + tags: + - Individual broadcast MBS session context (Document) + operationId: ContextUpdate + parameters: + - name: mbsContextRef + in: path + description: Unique ID of the broadcast MSB session context to be updated + required: true + schema: + type: string + requestBody: + content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/ContextUpdateReqData' + binaryDataN2Information: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + required: true + responses: + '200': + description: MBS Broadcast context updated successfully + content: + application/json: # message without binary body part(s) + schema: + $ref: '#/components/schemas/ContextUpdateRspData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Response parts + jsonData: + $ref: '#/components/schemas/ContextUpdateRspData' + binaryDataN2Information1: + type: string + format: binary + binaryDataN2Information2: + type: string + format: binary + binaryDataN2Information3: + type: string + format: binary + +``` + +``` + binaryDataN2Information4: + type: string + format: binary + binaryDataN2Information5: + type: string + format: binary + binaryDataN2Information6: + type: string + format: binary + binaryDataN2Information7: + type: string + format: binary + binaryDataN2Information8: + type: string + format: binary + binaryDataN2Information9: + type: string + format: binary + binaryDataN2Information10: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information3: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information7: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +``` + +``` + + binaryDataN2Information10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +'204': + description: MBS Broadcast context updated successfully. No Content. +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + namf-mbs-bc: Access to the Namf_MBSBroadcast API + +schemas: + +# +# STRUCTURED DATA TYPES +# + +ContextCreateReqData: + description: Data within ContextCreate Request + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + mbsServiceAreaInfoList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceAreaInfo' + minItems: 1 + mbsServiceArea: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceArea' + n2MbsSmInfo: + $ref: '#/components/schemas/N2MbsSmInfo' + notifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + maxResponseTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + mbsmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + mbsmfServiceInstId: + type: string + associatedSessionId: + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/AssociatedSessionId' + required: + - mbsSessionId + - n2MbsSmInfo + - notifyUri + - snssai + oneOf: + - required: [ mbsServiceArea ] + - required: [ mbsServiceAreaInfoList ] + +ContextCreateRspData: + description: Data within ContextCreate Response + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + n2MbsSmInfoList: + type: array + items: + $ref: '#/components/schemas/N2MbsSmInfo' + minItems: 1 + maxItems: 10 + operationStatus: + $ref: '#/components/schemas/OperationStatus' + required: + - mbsSessionId + +ContextUpdateReqData: + description: Data within ContextUpdate Request + type: object + properties: + mbsServiceArea: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceArea' + mbsServiceAreaInfoList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceAreaInfo' + minItems: 1 + n2MbsSmInfo: + $ref: '#/components/schemas/N2MbsSmInfo' + ranIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + minItems: 1 + noNgapSignallingInd: + type: boolean + enum: + - true + notifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + maxResponseTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + n2MbsInfoChangeInd: + type: boolean + not: + required: [ mbsServiceArea, mbsServiceAreaInfoList ] + +ContextStatusNotification: + description: Data within ContextStatusNotify Request + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + areaSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaSessionId' + n2MbsSmInfoList: + type: array + items: + $ref: '#/components/schemas/N2MbsSmInfo' + minItems: 1 + maxItems: 10 + operationEvents: + type: array + items: + $ref: '#/components/schemas/OperationEvent' + minItems: 1 +``` + +``` + operationStatus: + $ref: '#/components/schemas/OperationStatus' + releasedInd: + type: boolean + enum: + - true + required: + - mbsSessionId + +ContextStatusNotificationResponse: + description: Data within ContextStatusNotify Response + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + areaSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaSessionId' + n2MbsSmInfoList: + type: array + items: + $ref: '#/components/schemas/N2MbsSmInfo' + minItems: 1 + maxItems: 10 + required: + - mbsSessionId + +ContextUpdateRspData: + description: Data within ContextUpdate Response + type: object + properties: + n2MbsSmInfoList: + type: array + items: + $ref: '#/components/schemas/N2MbsSmInfo' + minItems: 1 + maxItems: 10 + operationStatus: + $ref: '#/components/schemas/OperationStatus' + +N2MbsSmInfo: + description: N2 MBS Session Management information + type: object + properties: + ngapIeType: + $ref: '#/components/schemas/NgapIeType' + ngapData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + ranId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + required: + - ngapIeType + - ngapData + +OperationEvent: + description: Operation Event for a Broadcast MBS Session. + type: object + properties: + opEventType: + $ref: '#/components/schemas/OpEventType' + amfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + ngranFailureEventList: + type: array + items: + $ref: '#/components/schemas/NgranFailureEvent' + minItems: 1 + required: + - opEventType + +NgranFailureEvent: + description: NG-RAN failure event for a NG-RAN + type: object + properties: + ngranId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + ngranFailureIndication: +``` + +``` + + $ref: '#/components/schemas/NgranFailureIndication' + required: + - ngranId + - ngranFailureIndication + +# +# SIMPLE DATA TYPES +# + +# +# ENUMERATIONS +# + +OperationStatus: + description: Status of a Broadcast MBS session start or update operation. + anyOf: + - type: string + enum: + - MBS_SESSION_START_COMPLETE + - MBS_SESSION_START_INCOMPLETE + - MBS_SESSION_UPDATE_COMPLETE + - MBS_SESSION_UPDATE_INCOMPLETE + - type: string + +NgapIeType: + description: NGAP Information Element Type + anyOf: + - type: string + enum: + - MBS_SES_REQ + - MBS_SES_RSP + - MBS_SES_FAIL + - MBS_SES_REL_RSP + - BC_TRA_REQ + - BC_TRA_RSP + - BC_TRA_FAIL + - type: string + +OpEventType: + description: Operation Event Type. + anyOf: + - type: string + enum: + - AMF_CHANGE + - NG_RAN_EVENT + - type: string + +NgranFailureIndication: + description: Indicates a NG-RAN failure event. + anyOf: + - type: string + enum: + - NG_RAN_RESTART_OR_START + - NG_RAN_FAILURE_WITHOUT_RESTART + - NG_RAN_NOT_REACHABLE + - NG_RAN_REQUIRED_RELEASE + - type: string + +``` + +## A.7 Namf\_MBSCommunication API + +openapi: 3.0.0 + +info: + +``` + + version: 1.1.0-alpha.1 + title: Namf_MBSCommunication + description: | + AMF Communication Service for MBS. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +``` + +externalDocs: + +``` + + description: 3GPP TS 29.518 V18.0.0; 5G System; Access and Mobility Management Services + +``` + +``` + +url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/' + +servers: + - url: '{apiRoot}/namf-mbs-comm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - namf-mbs-comm + +paths: + /n2-messages/transfer: + post: + summary: Namf_MBSCommunication N2 Message Transfer service Operation + tags: + - N2Messages Handler (custom operation) + operationId: N2MessageTransfer + requestBody: + content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/MbsN2MessageTransferReqData' + binaryDataN2Information: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + required: true + callbacks: + notification: + '{ $request.body#/notifyUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Notification' + responses: + '204': + description: successful notification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +responses: + '200': + description: MBS N2 Message Transfer successfully initiated + content: + application/json: + schema: + $ref: '#/components/schemas/MbsN2MessageTransferRspData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + description: Not Found + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + namf-mbs-comm: Access to the Namf_MBSCommunication API + +schemas: + +# +# STRUCTURED DATA TYPES +# + +MbsN2MessageTransferReqData: + description: Data within MBS N2 Message Transfer Request + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + areaSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaSessionId' + n2MbsSmInfo: + $ref: '#/components/schemas/N2MbsSmInfo' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + ranNodeIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + minItems: 1 + notifyUri: + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifyCorrelationId: + type: string + required: + - mbsSessionId + - n2MbsSmInfo + +MbsN2MessageTransferRspData: + description: Data within MBS N2 Message Transfer Response + type: object + properties: + result: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InformationTransferResult' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + failureList: + type: array + items: + $ref: '#/components/schemas/RanFailure' + minItems: 1 + required: + - result + +N2MbsSmInfo: + description: N2 MBS Session Management information + type: object + properties: + ngapIeType: + $ref: '#/components/schemas/MbsNgapIeType' + ngapData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + required: + - ngapIeType + - ngapData + +Notification: + description: Data within Notify Request + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + areaSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaSessionId' + failureList: + type: array + items: + $ref: '#/components/schemas/RanFailure' + minItems: 1 + notifyCorrelationId: + type: string + required: + - mbsSessionId + - failureList + +RanFailure: + description: Description of an MBS related N2 procedure failure + type: object + properties: + ranId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + ranFailureCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + ranFailureIndication: + $ref: '#/components/schemas/RanFailureIndication' + required: + - ranId + oneOf: + - required: [ ranFailureCause ] + - required: [ ranFailureIndication ] + +``` + +``` + +# +# SIMPLE DATA TYPES +# + +``` + +``` + +# +# ENUMERATIONS +# + +MbsNgapIeType: + description: NGAP Information Element Type + anyOf: + - type: string + enum: + - MBS_SES_ACT_REQ + - MBS_SES_DEACT_REQ + - MBS_SES_UPD_REQ + - type: string + +RanFailureIndication: + description: Indicates a NG-RAN failure event + anyOf: + - type: string + enum: + - NG_RAN_FAILURE_WITHOUT_RESTART + - NG_RAN_NOT_REACHABLE + - type: string + +``` + +--- + +## Annex B (Informative): HTTP Multipart Messages + +### B.1 Example of HTTP multipart message + +#### B.1.1 General + +This clause provides a (partial) example of HTTP multipart message. The example does not aim to be a complete representation of the HTTP message, e.g. additional information or headers can be included. + +This Annex is informative and the normative descriptions in this specification prevail over the description in this Annex if there is any difference. + +#### B.1.2 Example HTTP multipart message with N2 Information binary data + +``` + +POST /example.com/namf-comm/v1/ue-contexts/{ueContextId}/n1-n2-messages HTTP/2 +Content-Type: multipart/related; boundary=-----Boundary +Content-Length: xyz + +-----Boundary +Content-Type: application/json + +{ + "n2InfoContainer": { + "n2InformationClass": "SM", + "smInfo": { + "pduSessionId": 5, + "n2InfoContent": { + "ngapIeType": "PDU_RES_SETUP_REQ", + "ngapData": { + "contentId": "n2msg" + } + } + } + }, + "pduSessionId": 5 +} +-----Boundary + +``` + +Content-Type: application/vnd.3gpp.ngap +Content-Id: n2msg + +{ ... N2 Information binary data ...} +-----Boundary + +--- + +## Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-10 | CT4#80 | C4-175297 | | | | TS Skeleton | 0.1.0 | +| 2017-10 | CT4#80 | C4-175397 | | | | Implementation of pCRs agreed at CT4#80. | 0.2.0 | +| 2017-12 | CT4#81 | C4-176441 | | | | Implementation of pCRs agreed at CT4#81, including C4-176285, C4-176290, C4-176291, C4-176292, C4-176293, C4-176375, C4-176376, C4-176378, C4-176379, C4-176380 and C4-176404. | 0.3.0 | +| 2018-01 | CT4#82 | C4-181393 | | | | Implementation of pCRs agreed at CT4#82, including C4-181090, C4-181091, C4-181258, C4-181259, C4-181260, C4-181269, C4-181270, C4-181311, C4-181312, C4-181313, C4-181314, C4-181352, C4-181353 and C4-181354 | 0.4.0 | +| 2018-03 | CT4#83 | C4-182437 | | | | Implementation of pCRs agreed at CT4#83, including C4-182287, C4-182288, C4-182290, C4-182292, C4-182293, C4-182350, C4-182353, C4-182355, C4-182358, C4-182367, C4-182385, C4-182403, C4-182414, C4-182415 | 0.5.0 | +| 2018-03 | CT#79 | CP-180033 | | | | Presented for information | 1.0.0 | +| 2018-04 | CT4#84 | C4-183518 | | | | Implementation of pCRs agreed at CT4#84, including C4-183048, C4-183054, C4-183055, C4-183064, C4-183073, C4-183074, C4-183161, C4-183166, C4-183171, C4-183345, C4-183347, C4-183351, C4-183354, C4-183356, C4-183357, C4-183359, C4-183360, C4-183361, C4-183362, C4-183406, C4-183407, C4-183408, C4-183409, C4-183410, C4-183411, C4-183412, C4-183413, C4-183414, C4-183415, C4-183417, C4-183434, C4-183435, C4-183436, C4-183437, C4-183439, C4-183445, C4-183460, C4-183461, C4-183462, C4-183463, C4-183464, C4-183493, C4-183494, C4-183495, C4-183502 | 1.1.0 | +| 2018-05 | CT4#85 | C4-184629 | | | | Implementation of pCRs agreed at CT4#85, including: C4-184390, C4-184391, C4-184562, C4-184393, C4-184561, C4-184395, C4-194052, C4-184396, C4-184399, C4-184404, C4-184405, C4-184407, C4-184102, C4-184408, C4-184104, C4-184410, C4-184412, C4-184413, C4-184569, C4-184563, C4-184124, C4-184418, C4-184565, C4-184127, C4-184566, C4-184129, C4-184421, C4-184131, C4-184426, C4-184427, C4-184428, C4-184429, C4-184430, C4-184431, C4-184432, C4-184433, C4-184434, C4-184435, C4-184436, C4-184437, C4-184151, C4-184481, C4-184154, C4-184515, C4-184516, C4-184568, C4-184485, C4-184486, C4-184487, C4-184488 | 1.2.0 | +| 2018-06 | CT#80 | CP-181107 | | | | Presented for approval | 2.0.0 | +| 2018-06 | CT#80 | | | | | Approved in CT#80 | 15.0.0 | +| 2018-09 | CT#81 | CP-182062 | 0001 | 2 | F | RAT Selector for PWS | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0002 | 3 | F | AM Policy Triggers in MM Context | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0003 | 1 | F | Update UE context and MM context as per latest stage 2 agreements | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0004 | 1 | F | Corrections to EBI Assignment | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0005 | 1 | F | Clarify Max number of reports and Max duration of reporting in alignment with stage 2 | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0006 | | F | N1/N2 Message Transfer Temporary Reject | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0008 | | F | Remove AN Type from N1/N2 Message Transfer Request | 15.1.0 | +| 2018-09 | CT#81 | CP-182165 | 0009 | 2 | F | Update SeafData as per agreements in SA3 | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0010 | 1 | F | Include TimeStamp in AMF Event Notification | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0011 | | F | Provide Domain Selection Info | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0012 | 1 | F | RAN UE NGAP ID in RegistrationContextContainer | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0013 | 1 | F | NG-RAN TargetId in RegistrationContextContainer | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0014 | 3 | F | BackUp AMF Info | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0015 | | F | Description of N1N2TransferFailureNotification Operation | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0016 | 1 | F | Add Quotes for Runtime Expression | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0017 | | F | Callback URI for N2InfoNotify during N2 based handover | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0018 | 1 | F | Resolve Editor's Note on regular expression pattern | 15.1.0 | +| 2018-09 | CT#81 | CP-182095 | 0019 | 4 | F | Location Service ProvideLocationInfo | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0020 | 2 | F | Location Service ProvidePositioningInfo | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0021 | 2 | F | N1N2MessageTransfer Rejection due to SAR | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0022 | 3 | F | N2 Content Type Definition | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0023 | | F | Selected TAI in NgRanTargetId | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0024 | 2 | F | Skip Indicator | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0025 | 1 | F | UEContextTransfer Integrity Check Failure | 15.1.0 | +| 2018-09 | CT#81 | CP-182068 | 0026 | 1 | B | Add support for 5G Trace | 15.1.0 | +| 2018-09 | CT#81 | CP-182094 | 0027 | 3 | F | NgApCause Definition | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0028 | 1 | F | N1N2 Transfer Failure Notification | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0029 | | F | N2 Container Data Type During Handover | 15.1.0 | +| 2018-09 | CT#81 | CP-182175 | 0031 | 1 | F | Correction to RegistrationCompleteNotify | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0032 | 3 | F | N1N2MessageTransfer and Notify for PCF | 15.1.0 | +| 2018-09 | CT#81 | CP-182166 | 0033 | 3 | F | Regular expression pattern for UeContextId parameter in OpenAPI | 15.1.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|-------------------------------------------------------------------------|--------| +| 2018-09 | CT#81 | CP-182062 | 0036 | 2 | F | Presence Reporting Area | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0037 | 1 | F | Notification Correlation Id for subscription correlation Id change | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0038 | 1 | F | Default Subscription for Notification to LMF | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0039 | 1 | F | LCS Correlation Identifier in N2Notify | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0040 | 1 | F | Mobility Restriction | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0041 | | F | Not Allowed Slice | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0042 | 1 | F | UE-AMBR | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0044 | 1 | F | Array Attributes | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0045 | 2 | F | Default Response Codes | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0046 | | F | AMF service operations | 15.1.0 | +| 2018-09 | CT#81 | CP-182048 | 0047 | 2 | F | Passing NSSF information in N1MessageNotification | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0049 | 3 | F | Clarification on location information in immediate report | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0050 | 1 | F | Resource Figures | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0051 | | F | Correct reference for Event Report Information | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0052 | | F | Consistent use of "Correlation Id" | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0053 | 1 | F | API version number update | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0054 | 1 | F | Custom Operation Name Correction for EBI Assignment | 15.1.0 | +| 2018-09 | CT#81 | CP-192096 | 0055 | | F | Correction of CorrelationId Reference in OpenAPI | 15.1.0 | +| 2018-12 | CT#82 | CP-183020 | 56 | 1 | F | Editorial Corrections | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 57 | | F | Usage for EnableUEReachability Service Operation | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 58 | 1 | F | Update to SeafData | 15.2.0 | +| 2018-12 | CT#82 | CP-183232 | 60 | 4 | F | Transfer UE Radio Capability between AMFs | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 61 | 2 | F | Notification of the change of the PCF | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 62 | 1 | F | Information in N1MessageNotify | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 63 | | F | Event Exposure | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 64 | | F | Correct the references | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 65 | 5 | F | Subscription lifetime | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 67 | | F | Corrections to TADS Query API | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 69 | 5 | F | Transfer of Group Id Subscriptions | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 70 | 1 | F | Attributes corrections for RegistrationContextContainer and MmContext | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 71 | 1 | F | Correction on tables | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 72 | | F | Mandatory Status Code Correction | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 74 | 1 | F | N2InfoNotify correction for Handover Confirm | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 75 | 1 | F | Naming convention of provideLocInfo and providePosInfo | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 76 | 2 | F | OpenAPI specification alignments | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 77 | 1 | F | Remove Duplicated Common Application Errors | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 78 | | F | Required routingId | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 79 | 1 | F | Resource URIs Alignment | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 80 | | F | Seaf data type correction | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 81 | | F | UeContextId Pattern Complement | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 82 | | F | Use RefToBinaryData from common data types | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 83 | 3 | F | Range Definition in OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 84 | | F | sessionId in N1N2MessageTransferReqData | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 85 | 1 | F | New rejection cause for UE in CM-IDLE state | 15.2.0 | +| 2018-12 | CT#82 | CP-183151 | 86 | 8 | F | Notifying Subscription ID Change | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 87 | 1 | F | SMF Reallocation requested Indication | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 88 | 1 | F | Paging Policy Indicator | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 89 | 1 | F | EPS bearer identity | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 90 | 1 | F | 29518 CR cardinality | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 92 | 1 | F | Editorial Correction to PduSessionContext | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 93 | 1 | F | Global RAN Node ID in RegistrationContextContainer | 15.2.0 | +| 2018-12 | CT#82 | CP-183154 | 97 | 2 | F | Update of Subscription Lifetime | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 98 | 1 | F | EBI Allocation Rejection Cause | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 100 | 2 | F | UE Context Transfer during initial registration via another access type | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 101 | 1 | F | RAN Status Transfer Transparent Container in N2 based handover | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 103 | 1 | F | NgapleType for X2 and N2 based handover | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 104 | | F | Update of N1N2 Message Operations | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 105 | 1 | F | Clarify the handling of EBI assignment | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 106 | | F | Align Usage of Tags | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 107 | 1 | F | Altitude in Provide Positioning Information | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 108 | | F | AmfStatusChangeSubscribe Modify in Resource Table | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 109 | 1 | F | API Root | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 110 | 1 | F | Case Convention | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 111 | 1 | F | Clarification of ProvideLocInfo when CM-CONNECTED | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 118 | 1 | F | N1 N2 Message for Positioning | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 119 | 3 | F | N3GPP DDN handling when UE CM-IDLE on N3GPP | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 121 | 1 | F | Alignment on TADS Query | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 122 | 1 | F | Configuration Transfer procedure over N14 | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 123 | | F | N1N2MessageTransfer Request message | 15.2.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|--------------------------------------------------------------------------------------------|--------| +| 2018-12 | CT#82 | CP-183020 | 124 | 2 | F | UDM group Id | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 125 | | F | Warning Request Transfer Procedure | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 126 | 1 | F | Location Header | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 127 | | F | Remove duplicate references | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 128 | 1 | F | 429 Response Codes | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 129 | | F | API Version | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 130 | 1 | F | Oauth2 correction | 15.2.0 | +| 2018-12 | CT#82 | CP-183191 | 131 | | F | Editorial Correction to AMF Event Type Enumeration | 15.2.0 | +| 2018-12 | CT#82 | CP-183229 | 132 | | F | Correction to OpenAPI definition of UeContextTransferRspData | 15.2.0 | +| 2019-03 | CT#83 | CP-190025 | 133 | 1 | F | OpenAPI correction for HTTP method of EnableUEReachability | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 134 | | F | PDU sessions not accepted by target AMF in N2 based handover | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 135 | 1 | F | Sending Secondary RAT usage over N14 during N2 handover with AMF change | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 136 | | F | SM Context URI in UE context | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 137 | 2 | F | UE policy delivery and control | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 138 | | F | Correct Event Exposure Service Description | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 139 | 2 | F | Simplify N1N2MessageTransfer when UE is in CM-IDLE | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 140 | 2 | F | Update EBIAssignment Service Operation to Align with Stage 2 | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 141 | 1 | F | Corrections to the HTTP methods and URI | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 143 | 1 | F | Correction to Reponse Code for Positioning Failed | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 144 | 1 | F | Essential Clairfication on Event Subscription Creation | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 145 | 1 | F | OpenAPI Syntax Correction | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 146 | 1 | F | Reference Id | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 148 | 1 | F | SMF Service Instance during AMF change | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 149 | 1 | F | GMLC URI for Namf_Location EventNotify | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 150 | 1 | F | Correction of keyAmfChangeInd | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 151 | 1 | F | N2SmInformation in UeContextCreateData & UeContextCreatedData | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 153 | | F | API version update | 15.3.0 | +| 2019-06 | CT#84 | CP-191036 | 154 | | F | ngapCause in UeContextCreatedData | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 160 | | F | Correction N1 N2 Message Transfer when CM-IDLE | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 161 | | F | Correction on CR0021 implementation | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 162 | | F | Event Notify Failure Response | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 164 | | F | UE Identities for Event Notification | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 155 | 1 | F | Content Type | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 163 | 1 | F | LPP Handling | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 165 | 1 | F | AMF Event Alignment | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 166 | 1 | F | Missing Loss Of Connectivity Event | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 171 | 2 | F | Storage of OpenAPI specification files | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 172 | 1 | F | Location header in redirect response | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 173 | 1 | F | LMF Service Instance Id for N1N2MessageTransfer | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 174 | | F | Remove Subscribed-Data-Report event type and SARI data type | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 175 | 1 | F | Correction in PwsInformation Parameter | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 177 | 1 | F | Copyright Note in OpenAPI Spec | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 178 | 1 | F | Correction on EBI in PDU session context | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 179 | 1 | F | Major API version | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 181 | 1 | F | Status code of Namf_EventExposure Unsubscribe service operation | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 187 | | F | 3GPP TS 29.518 API version update | 15.4.0 | +| 2019-06 | CT#84 | CP-191046 | 182 | 2 | F | Corrections of the references to retrieve Callback URI from NRF for N1and N2 notifications | 16.0.0 | +| 2019-06 | CT#84 | CP-191049 | 159 | 2 | B | Updates to CreateUEContext for eNS Support | 16.0.0 | +| 2019-06 | CT#84 | CP-191054 | 168 | 3 | B | Update N2InformationNotification for I-SMF insertion, change and removal | 16.0.0 | +| 2019-06 | CT#84 | CP-191050 | 184 | 3 | B | Add NB-IoT specific UE Radio Access Capability in UE context | 16.0.0 | +| 2019-06 | CT#84 | CP-191050 | 185 | 1 | B | Update to the UEContextTransfer service for adding Gap timer | 16.0.0 | +| 2019-06 | CT#84 | CP-191048 | 186 | | B | 3GPP TS 29.518 API version update | 16.0.0 | +| 2019-09 | CT#85 | CP-192110 | 0189 | 2 | A | Wrong Cardinality of IcsSupportedGADShapes in RequestPosInfo | 16.1.0 | +| 2019-09 | CT#85 | CP-192128 | 0190 | 1 | F | Correction for ngapMessageType | 16.1.0 | +| 2019-09 | CT#85 | CP-192128 | 0191 | 1 | F | NonUeN2InfoUnsubscribe for PWS | 16.1.0 | +| 2019-09 | CT#85 | CP-192188 | 0193 | 1 | B | Transfer 5G SRVCC Parameters between AMFs | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0194 | 1 | B | CreateUEContext – I-SMF and SM Context ID Information | 16.1.0 | +| 2019-09 | CT#85 | CP-192110 | 0197 | 1 | A | Use of ARP value for Priority Paging | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0198 | 1 | B | Correction of the smfChangeIndication | 16.1.0 | +| 2019-09 | CT#85 | CP-192110 | 0200 | | A | Signalling Old GUAMI to target AMF during the AMF planned removal procedure | 16.1.0 | +| 2019-09 | CT#85 | CP-192128 | 0201 | 1 | F | 5GS User State retrieval | 16.1.0 | +| 2019-09 | CT#85 | CP-192128 | 0202 | 1 | F | Forwarding UL N2 message to target AMF during AMF planned removal procedure | 16.1.0 | +| 2019-09 | CT#85 | CP-192128 | 0203 | 1 | F | MT SMS to UE in RRC INACTIVE state with NG-RAN paging failure | 16.1.0 | +| 2019-09 | CT#85 | CP-192128 | 0205 | | F | Corrections to Mapped Service Operations of Namf_Communication service | 16.1.0 | +| 2019-09 | CT#85 | CP-192110 | 0208 | 1 | A | Missing Location header | 16.1.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|-----------------------------------------------------------------------------|--------| +| 2019-09 | CT#85 | CP-192110 | 0210 | 1 | A | Missing status codes | 16.1.0 | +| 2019-09 | CT#85 | CP-192134 | 0211 | | B | Transfer Information of MA PDU Session between AMFs | 16.1.0 | +| 2019-09 | CT#85 | CP-192110 | 0214 | 3 | A | OpenAPI Correction on Location Header | 16.1.0 | +| 2019-09 | CT#85 | CP-192128 | 0215 | | F | Error response of the EBIAssignment | 16.1.0 | +| 2019-09 | CT#85 | CP-192135 | 0216 | | B | Namf_EventExposure service invoked by NWDAF | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0217 | | B | ETSUN_N1N2MessageTransfer Failure due to SM Context relocation needed | 16.1.0 | +| 2019-09 | CT#85 | CP-192132 | 0218 | 1 | F | Service Gap Time | 16.1.0 | +| 2019-09 | CT#85 | CP-192132 | 0221 | 2 | B | HLCom extended buffering in MT Service | 16.1.0 | +| 2019-09 | CT#85 | CP-192132 | 0223 | 2 | B | Small Data Rate Control Status | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0224 | 1 | F | Example of HTTP multipart message | 16.1.0 | +| 2019-09 | CT#85 | CP-192132 | 0225 | 1 | B | Extended Buffering Support in Communication Service | 16.1.0 | +| 2019-09 | CT#85 | CP-192120 | 0227 | | F | 3GPP TS 29.518 API version update | 16.1.0 | +| 2019-10 | | | | | | Corrupted references fixed | 16.1.1 | +| 2019-12 | CT#86 | CP-193051 | 0229 | 1 | B | Target Access type in N1N2MessageTransfer Request for a MA PDU session | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0230 | | F | egiList and ncgiList in N2InformationTransferReqData not needed | 16.2.0 | +| 2019-12 | CT#86 | CP-193056 | 0231 | | B | Event exposure between AMF and SMF | 16.2.0 | +| 2019-12 | CT#86 | CP-193051 | 0233 | 1 | B | MA PDU session accepted indication | 16.2.0 | +| 2019-12 | CT#86 | CP-193031 | 0235 | 1 | A | Source AMF NGAP ID | 16.2.0 | +| 2019-12 | CT#86 | CP-193031 | 0239 | | A | N1N2MessageTransfer request during an on-going handover procedure | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0240 | | B | RIM Information Transfer procedure | 16.2.0 | +| 2019-12 | CT#86 | CP-193046 | 0241 | | B | User location report | 16.2.0 | +| 2019-12 | CT#86 | CP-193055 | 0244 | 4 | B | Update the service operation of AMF | 16.2.0 | +| 2019-12 | CT#86 | CP-193031 | 0246 | | A | Correction to ProvideLocInfo | 16.2.0 | +| 2019-12 | CT#86 | CP-193062 | 0248 | 3 | B | Transferring UE Radio Capability ID between AMFs | 16.2.0 | +| 2019-12 | CT#86 | CP-193031 | 0250 | 1 | A | Reference correction | 16.2.0 | +| 2019-12 | CT#86 | CP-193048 | 0251 | 1 | F | Reference correction | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0253 | 1 | F | Correction on MT Enable UE Reachability | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0254 | | F | Excluding security context in the UE context | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0255 | 1 | B | Adding Rate Control attributes to N1N2messageTransferReq data type | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0256 | 2 | B | Mobile Terminated Data Transfer for Control Plane CIoT 5GS Optimisation | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0257 | 1 | F | PDU Session Release for UE in RRC INACTIVE state with NG-RAN paging failure | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0260 | 2 | F | Add Corresponding OpenAPI descriptions in clause 5.1 | 16.2.0 | +| 2019-12 | CT#86 | CP-193164 | 0261 | 2 | B | Updating support for subscription-based access restriction | 16.2.0 | +| 2019-12 | CT#86 | CP-193166 | 0262 | 2 | B | AMF Location Service Operations for a Commercial and Deferred 5GC-MT-LR | 16.2.0 | +| 2019-12 | CT#86 | CP-193055 | 0263 | 1 | B | LMF identification for LMF change | 16.2.0 | +| 2019-12 | CT#86 | CP-193055 | 0264 | 1 | B | Location Service ProvidePositioningInfo | 16.2.0 | +| 2019-12 | CT#86 | CP-193122 | 0266 | 2 | B | NF/NF Service Set ID in UE Context Transfer | 16.2.0 | +| 2019-12 | CT#86 | CP-193031 | 0268 | 1 | A | Definition of hpcfld | 16.2.0 | +| 2019-12 | CT#86 | CP-193080 | 0270 | 3 | A | Secondary RAT Data Usage Report | 16.2.0 | +| 2019-12 | CT#86 | CP-193055 | 0273 | 1 | B | AMF forwarding Location services messages between UE and LMF | 16.2.0 | +| 2019-12 | CT#86 | CP-193044 | 0275 | | F | 3GPP TS 29.518 API version update | 16.2.0 | +| 2020-03 | CT#87 | CP-200017 | 0276 | 3 | F | SMF change indication during Inter-AMF registration | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0277 | 3 | F | DNN encoding in Namf_Communication API | 16.3.0 | +| 2020-03 | CT#87 | CP-200043 | 0279 | 2 | F | smsSupport attribute in UE context | 16.3.0 | +| 2020-03 | CT#87 | CP-200043 | 0280 | 2 | F | AMF event subscription without the "options" attribute | 16.3.0 | +| 2020-03 | CT#87 | CP-200039 | 0281 | 2 | D | Editorial corrections | 16.3.0 | +| 2020-03 | CT#87 | CP-200043 | 0282 | 1 | F | Correction of typos | 16.3.0 | +| 2020-03 | CT#87 | CP-200043 | 0283 | 2 | F | Class indication in subscription response | 16.3.0 | +| 2020-03 | CT#87 | CP-200043 | 0284 | 3 | F | Cause values for PWS errors detected by AMF | 16.3.0 | +| 2020-03 | CT#87 | CP-200039 | 0285 | 2 | F | Correction - formatting consistency | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0286 | 1 | B | 29518 CR optionality of ProblemDetails | 16.3.0 | +| 2020-03 | CT#87 | CP-200031 | 0287 | 1 | B | Additional Access Type in UE Context Transfer | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0288 | 1 | B | Granularity of the SMF change Indication | 16.3.0 | +| 2020-03 | CT#87 | CP-200179 | 0289 | 1 | B | V2X information in UE Context | 16.3.0 | +| 2020-03 | CT#87 | CP-200178 | 0290 | 1 | B | Availability after DDN Failure | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0294 | 1 | B | Ongoing registration or handover during paging | 16.3.0 | +| 2020-03 | CT#87 | CP-200033 | 0295 | 1 | B | 5G CIoT Attribute in UeContext | 16.3.0 | +| 2020-03 | CT#87 | CP-200030 | 0296 | 2 | B | Event Exposure invoked by NWDAF | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0297 | 1 | F | V-SMF insertion or removal | 16.3.0 | +| 2020-03 | CT#87 | CP-200033 | 0298 | | F | Feature definition for support of CIoT features | 16.3.0 | +| 2020-03 | CT#87 | CP-200033 | 0299 | | F | Mobile Terminated Data | 16.3.0 | +| 2020-03 | CT#87 | CP-200043 | 0300 | | F | UE_IN_NON_ALLOWED_AREA error in EnableUEReachability response | 16.3.0 | +| 2020-03 | CT#87 | CP-200035 | 0302 | 1 | B | SUPI pattern | 16.3.0 | +| 2020-03 | CT#87 | CP-200018 | 0303 | | B | LCS service authorization | 16.3.0 | +| 2020-03 | CT#87 | CP-200018 | 0305 | 3 | B | Cm state exposure | 16.3.0 | +| 2020-03 | CT#87 | CP-200052 | 0306 | | F | 3GPP TS 29.518 API Rel16 API External doc update | 16.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------|--------| +| 2020-06 | CT#88e | CP-201054 | 0307 | | F | Storage of YAML files in ETSI Forge | 16.4.0 | +| 2020-06 | CT#88e | CP-201031 | 0308 | | F | V-SMF and I-SMF service instance Id | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0309 | 1 | F | N1N2Transfer Failure Notification for UEs in RRC Inactive state | 16.4.0 | +| 2020-06 | CT#88e | CP-201045 | 0310 | 1 | B | NPN extensions for Inter-AMF N2 Handover | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0311 | 1 | F | Supported Headers Tables for Response codes 2xx and 3xx | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0312 | 1 | F | Binary Data Types Table | 16.4.0 | +| 2020-06 | CT#88e | CP-201046 | 0313 | 1 | B | Maximum UP resources activation of 2 PDU sessions | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0314 | 1 | F | Add new Notifications Overview Tables | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0315 | | F | subscriptionId in AmfCreatedEventSubscription and AmfEventReport | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0316 | | F | Non-delivery of N1 message to UE due to Xn/N2 handover | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0318 | | F | Reference Corrections | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0319 | 1 | F | Optionality of ProblemDetails in TS29.518 cleanup | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0321 | | F | Default LocationFilter | 16.4.0 | +| 2020-06 | CT#88e | CP-201067 | 0322 | 2 | B | MDT Configuration | 16.4.0 | +| 2020-06 | CT#88e | CP-201043 | 0323 | 2 | B | Update the event subscription and notification on area of interest | 16.4.0 | +| 2020-06 | CT#88e | CP-201047 | 0324 | 2 | B | Authentication and Authorization status | 16.4.0 | +| 2020-06 | CT#88e | CP-201048 | 0325 | 1 | F | Stage 2 procedures for wireline access | 16.4.0 | +| 2020-06 | CT#88e | CP-201048 | 0326 | 1 | F | TWAP ID change reporting | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0328 | 2 | F | Periodic reporting | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0330 | 1 | F | Reasons for loss of connectivity | 16.4.0 | +| 2020-06 | CT#88e | CP-201023 | 0331 | 2 | F | UEContextTransfer - N3IWF/W-AGF/TNGF ID and RAN NGAP ID | 16.4.0 | +| 2020-06 | CT#88e | CP-201018 | 0339 | 2 | A | Binary IE Encoding | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0340 | 1 | F | Broadcast Empty Area List | 16.4.0 | +| 2020-06 | CT#88e | CP-201044 | 0341 | 1 | F | Clarification on EBI Allocation for MAPDU | 16.4.0 | +| 2020-06 | CT#88e | CP-201032 | 0342 | | F | Correct Reference on Location Procedures | 16.4.0 | +| 2020-06 | CT#88e | CP-201046 | 0343 | 4 | B | UE Maximum Availability Time | 16.4.0 | +| 2020-06 | CT#88e | CP-201023 | 0344 | 3 | A | Event of UE Reachability | 16.4.0 | +| 2020-06 | CT#88e | CP-201032 | 0345 | 1 | F | GUAMI in N1/N2 Message Notification | 16.4.0 | +| 2020-06 | CT#88e | CP-201032 | 0346 | 1 | F | LCS Correlation Id for NRPPa Transfer | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0347 | 1 | F | PWS Message Transfer Precedence | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0348 | 1 | F | Data type column in Resource URI variables Table | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0349 | 1 | F | Add custom operation Name | 16.4.0 | +| 2020-06 | CT#88e | CP-201046 | 0350 | 2 | B | Monitoring Event Information | 16.4.0 | +| 2020-06 | CT#88e | CP-201032 | 0351 | 2 | F | LMF indicating access type for transmission of LPP message | 16.4.0 | +| 2020-06 | CT#88e | CP-201032 | 0352 | 1 | F | UePrivacyRequirements for Location Request | 16.4.0 | +| 2020-06 | CT#88e | CP-201044 | 0354 | 1 | F | Condition of MA-PDU Session Context Transfer | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0355 | 1 | F | N2 PDU Session Modification for a UE in CM-IDLE state | 16.4.0 | +| 2020-06 | CT#88e | CP-201032 | 0356 | 1 | F | GMLC authorization in RequestPosInfo | 16.4.0 | +| 2020-06 | CT#88e | CP-201197 | 0357 | 1 | F | PC5 policy container from PCF | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0358 | 2 | F | Maximum number of reports | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0359 | | F | Correction for implementation error | 16.4.0 | +| 2020-06 | CT#88e | CP-201032 | 0362 | 1 | B | Indication of control plane CLoT 5GS optimization to an LMF | 16.4.0 | +| 2020-06 | CT#88e | CP-201043 | 0367 | 1 | F | Sampling ratio for AMF event exposure | 16.4.0 | +| 2020-06 | CT#88e | CP-201032 | 0368 | 1 | F | The result of location verification by UE | 16.4.0 | +| 2020-06 | CT#88e | CP-201043 | 0369 | 2 | F | AMF event exposure for any UE | 16.4.0 | +| 2020-06 | CT#88e | CP-201018 | 0371 | 1 | A | pwdErrorInfo should be pwsErrorInfo in openAPI | 16.4.0 | +| 2020-06 | CT#88e | CP-201073 | 0375 | | F | 29.518 Rel-16 API version and External doc update | 16.4.0 | +| 2020-09 | CT#89e | CP-202097 | 0376 | 2 | F | DAPS Handover information | 16.5.0 | +| 2020-09 | CT#89e | CP-202114 | 0378 | 3 | F | Clarification on hSmfId in PduSessionContext transferred to target AMF | 16.5.0 | +| 2020-09 | CT#89e | CP-202093 | 0379 | 2 | F | Clarification on Max Number of Reports | 16.5.0 | +| 2020-09 | CT#89e | CP-202093 | 0380 | 2 | F | Event Report in Response to AMF Event Subscription Update | 16.5.0 | +| 2020-09 | CT#89e | CP-202109 | 0381 | 1 | F | SNSSAI during mobility procedure | 16.5.0 | +| 2020-09 | CT#89e | CP-202093 | 0382 | | F | Callback URI correction | 16.5.0 | +| 2020-09 | CT#89e | CP-202093 | 0383 | 1 | A | Definition of DRX | 16.5.0 | +| 2020-09 | CT#89e | CP-202093 | 0384 | 2 | A | Cardinality of AmfUpdateEventSubscriptionItem | 16.5.0 | +| 2020-09 | CT#89e | CP-202093 | 0385 | | F | Identifier of the NF service consumer sending an N1 message | 16.5.0 | +| 2020-09 | CT#89e | CP-202093 | 0386 | | F | Clarifications to EBI Assignment procedure | 16.5.0 | +| 2020-09 | CT#89e | CP-202043 | 0388 | | A | Correction of UE Context Transfer payload in case of UE initial registration | 16.5.0 | +| 2020-09 | CT#89e | CP-202043 | 0392 | 1 | A | Registration Status Update for PCF for UE Policy | 16.5.0 | +| 2020-09 | CT#89e | CP-202093 | 0394 | 1 | F | Additional Prald | 16.5.0 | +| 2020-09 | CT#89e | CP-202093 | 0395 | 1 | F | PCF Group Id | 16.5.0 | +| 2020-09 | CT#89e | CP-202040 | 0397 | 1 | A | Selected EPS NAS Security Algorithm Rel16 | 16.5.0 | +| 2020-09 | CT#89e | CP-202112 | 0398 | 1 | F | Removal of EN on CP 5G CLoT Optimisation | 16.5.0 | +| 2020-09 | CT#89e | CP-202112 | 0399 | 1 | F | Correction of Notification or Verification only for UE Positioning | 16.5.0 | +| 2020-09 | CT#89e | CP-202108 | 0400 | 2 | F | Managing RACS ID for mobility across ePLMNs | 16.5.0 | +| 2020-09 | CT#89e | CP-202093 | 0401 | 1 | F | Correction of n2InfoNotifyUrl in figures | 16.5.0 | +| 2020-09 | CT#89e | CP-202112 | 0402 | 2 | F | Add Response Codes on operation provide-pos-info | 16.5.0 | +| 2020-09 | CT#89e | CP-202112 | 0403 | | F | Corrections on N2InformationNotification | 16.5.0 | +| 2020-09 | CT#89e | CP-202096 | 0407 | | F | 29.518 Rel-16 API version and External doc update | 16.5.0 | +| 2020-12 | CT#90e | CP-203050 | 0409 | 1 | F | Broadcast of Assistance Data by an LMF | 16.6.0 | +| 2020-12 | CT#90e | CP-203050 | 0410 | 1 | F | Serving Cell Id in N1MessageNotification | 16.6.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------------------------------------------------------|--------| +| 2020-12 | CT#90e | CP-203080 | 0411 | 3 | F | Supplement to UeContext | 16.6.0 | +| 2020-12 | CT#90e | CP-203030 | 0413 | | F | Clarification on usage of "locationAge" and "geoInfo" in ProvideLocInfo | 16.6.0 | +| 2020-12 | CT#90e | CP-203030 | 0414 | | F | Incorrect NOTE | 16.6.0 | +| 2020-12 | CT#90e | CP-203163 | 0415 | 1 | F | HTTP 3xx redirection | 16.6.0 | +| 2020-12 | CT#90e | CP-203048 | 0417 | 1 | F | IMS AS query for UE IP Reachability | 16.6.0 | +| 2020-12 | CT#90e | CP-203035 | 0418 | 1 | F | UE Reachability Status Change | 16.6.0 | +| 2020-12 | CT#90e | CP-203040 | 0420 | 2 | F | Transfer N2 SM Info Received from SMF to Target AMF | 16.6.0 | +| 2020-12 | CT#90e | CP-203048 | 0421 | 2 | F | Miscellaneous corrections | 16.6.0 | +| 2020-12 | CT#90e | CP-203045 | 0422 | 1 | F | Partial failure of event subscription | 16.6.0 | +| 2020-12 | CT#90e | CP-203054 | 0423 | | F | SBI Binding Level | 16.6.0 | +| 2020-12 | CT#90e | CP-203030 | 0425 | 2 | F | Current location of a UE | 16.6.0 | +| 2020-12 | CT#90e | CP-203030 | 0426 | 1 | F | CreateUEContext Failure | 16.6.0 | +| 2020-12 | CT#90e | CP-203041 | 0430 | 1 | F | Event Subscription Synchronization | 16.6.0 | +| 2020-12 | CT#90e | CP-203054 | 0431 | 1 | F | HPCF Set Id | 16.6.0 | +| 2020-12 | CT#90e | CP-203027 | 0433 | 1 | A | Initial Location | 16.6.0 | +| 2020-12 | CT#90e | CP-203030 | 0437 | 3 | F | Corrections for unused data types and OperationId in OpenAPI | 16.6.0 | +| 2020-12 | CT#90e | CP-203048 | 0438 | | F | User Location | 16.6.0 | +| 2020-12 | CT#90e | CP-203027 | 0439 | | A | Event subscription update | 16.6.0 | +| 2020-12 | CT#90e | CP-203036 | 0441 | | F | 29.518 Rel-16 API version and External doc update | 16.6.0 | +| 2020-12 | CT#90e | CP-203064 | 0412 | 1 | F | Essential corrections | 17.0.0 | +| 2020-12 | CT#90e | CP-203057 | 0424 | 1 | F | EBI and ARP mapping update | 17.0.0 | +| 2020-12 | CT#90e | CP-203057 | 0427 | | F | N51 interface between NEF and AMF | 17.0.0 | +| 2020-12 | CT#90e | CP-203055 | 0442 | | F | 29.518 Rel-17 API version and External doc update | 17.0.0 | +| 2021-03 | CT#91e | CP-210178 | 0443 | 2 | F | Subscription not found inconsistency | 17.1.0 | +| 2021-03 | CT#91e | CP-210021 | 0444 | 2 | B | NF discovery based on SUCI information | 17.1.0 | +| 2021-03 | CT#91e | CP-210177 | 0446 | 2 | A | Handover Reject during EPS to 5GS Handover with AMF Re-allocation | 17.1.0 | +| 2021-03 | CT#91e | CP-210157 | 0448 | 1 | A | Handover Cancel during EPS to 5GS Handover with AMF Re-allocation | 17.1.0 | +| 2021-03 | CT#91e | CP-210159 | 0450 | 1 | A | Encoding of Forward Relocation Request | 17.1.0 | +| 2021-03 | CT#91e | CP-210040 | 0452 | 1 | A | DNN and Selected DNN | 17.1.0 | +| 2021-03 | CT#91e | CP-210037 | 0454 | 1 | A | Binding information of AMF event subscriptions | 17.1.0 | +| 2021-03 | CT#91e | CP-210173 | 0456 | | A | Error Responses for Indirect Communication | 17.1.0 | +| 2021-03 | CT#91e | CP-210043 | 0458 | 1 | A | UE context transfer during Inter-PLMN mobility registration | 17.1.0 | +| 2021-03 | CT#91e | CP-210043 | 0460 | | A | User Location in ProvideLocInfo | 17.1.0 | +| 2021-03 | CT#91e | CP-210059 | 0462 | | A | EBI allocation for Emergency PDU sessions | 17.1.0 | +| 2021-03 | CT#91e | CP-210059 | 0464 | 1 | A | Implementation error | 17.1.0 | +| 2021-03 | CT#91e | CP-210049 | 0468 | 2 | A | Interworking S-NSSAI during EPS to 5GS handover with AMF Relocation | 17.1.0 | +| 2021-03 | CT#91e | CP-210041 | 0470 | 1 | A | Target Node in Location continuity for handover from NG-RAN | 17.1.0 | +| 2021-03 | CT#91e | CP-210030 | 0471 | 1 | F | Wrong Reference for Reachable of Regulatory | 17.1.0 | +| 2021-03 | CT#91e | CP-210043 | 0473 | 1 | A | Corrections on resource and notification URI | 17.1.0 | +| 2021-03 | CT#91e | CP-210043 | 0475 | | A | Storage of YAML files | 17.1.0 | +| 2021-03 | CT#91e | CP-210161 | 0477 | 1 | A | Add the missing MDT parameters for NR | 17.1.0 | +| 2021-03 | CT#91e | CP-210048 | 0479 | 1 | A | Corrections on Enhanced Coverage information | 17.1.0 | +| 2021-03 | CT#91e | CP-210048 | 0481 | 1 | A | UE Differentiation Information | 17.1.0 | +| 2021-03 | CT#91e | CP-210021 | 0482 | 2 | F | Clarification to Communication-Failure-Report | 17.1.0 | +| 2021-03 | CT#91e | CP-210155 | 0483 | 3 | B | PRA Information update | 17.1.0 | +| 2021-03 | CT#91e | CP-210046 | 0485 | | A | 4xx codes during event notification | 17.1.0 | +| 2021-03 | CT#91e | CP-210048 | 0487 | 1 | F | Correction on UE Reachability | 17.1.0 | +| 2021-03 | CT#91e | CP-210046 | 0489 | | A | Support of immediate report | 17.1.0 | +| 2021-03 | CT#91e | CP-210029 | 0490 | | F | 29.518 Rel-17 API version and External doc update | 17.1.0 | +| 2021-06 | CT#92e | CP-211076 | 0493 | | A | Indicating the Serving PLMN ID to the Target AMF during inter-AMF handover | 17.2.0 | +| 2021-06 | CT#92e | CP-211076 | 0495 | | A | PDU session contexts transfer during a UE initial registration | 17.2.0 | +| 2021-06 | CT#92e | CP-211063 | 0497 | 1 | A | LMF using AMF event exposure service | 17.2.0 | +| 2021-06 | CT#92e | CP-211065 | 0499 | 1 | F | PPI mapping | 17.2.0 | +| 2021-06 | CT#92e | CP-211083 | 0502 | 1 | A | Incomplete Implementation of CR | 17.2.0 | +| 2021-06 | CT#92e | CP-211047 | 0503 | 2 | F | RAN Node Level Location Accuracy | 17.2.0 | +| 2021-06 | CT#92e | CP-211054 | 0504 | 2 | F | UE Reachability with Not Allowed Areas | 17.2.0 | +| 2021-06 | CT#92e | CP-211023 | 0507 | 1 | F | hNRF from NSSF in home PLMN | 17.2.0 | +| 2021-06 | CT#92e | CP-211058 | 0508 | | F | OpenAPI Reference | 17.2.0 | +| 2021-06 | CT#92e | CP-211059 | 0511 | | F | NF type of consumer subscribing to AMF event | 17.2.0 | +| 2021-06 | CT#92e | CP-211039 | 0512 | 1 | B | Authorization and QoS data for ProSe services | 17.2.0 | +| 2021-06 | CT#92e | CP-211036 | 0513 | 2 | B | Event Exposure enhancement with Partitioning criteria at AMF | 17.2.0 | +| 2021-06 | CT#92e | CP-211067 | 0515 | 2 | A | Maximum Response Time in the EE subscription request | 17.2.0 | +| 2021-06 | CT#92e | CP-211028 | 0518 | | F | Data Type Description for Namf_MT Service API | 17.2.0 | +| 2021-06 | CT#92e | CP-211028 | 0519 | | F | Data Type Description for Namf_Location Service API | 17.2.0 | +| 2021-06 | CT#92e | CP-211030 | 0521 | 1 | B | New parameter Subscribed-UE-Slice-MBR added | 17.2.0 | +| 2021-06 | CT#92e | CP-211028 | 0522 | 1 | F | Terminating Domain Selection request during on-going Registration | 17.2.0 | +| 2021-06 | CT#92e | CP-211028 | 0523 | 2 | F | Network Triggered Service Request for UE in CM-CONNECTED state outside of the validity area included in N1N2MessageTransfer | 17.2.0 | + +| | | | | | | | | +|--|--|--|--|--|--|---------|--| +| | | | | | | Request | | +|--|--|--|--|--|--|---------|--| + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------------|--------| +| 2021-06 | CT#92e | CP-211065 | 0525 | | A | Network Provided Location Information for non-3GPP access | 17.2.0 | +| 2021-06 | CT#92e | CP-211076 | 0527 | 1 | A | Group subscription transfer during inter-AMF mobility | 17.2.0 | +| 2021-06 | CT#92e | CP-211077 | 0529 | 1 | A | IAB Authorization for Inter-AMF handover | 17.2.0 | +| 2021-06 | CT#92e | CP-211026 | 0530 | 1 | B | GMUC using AMF event exposure service | 17.2.0 | +| 2021-06 | CT#92e | CP-211032 | 0531 | 1 | B | N1N2MessageTransfer supporting MUSIM | 17.2.0 | +| 2021-06 | CT#92e | CP-211026 | 0533 | 1 | B | Add Local location | 17.2.0 | +| 2021-06 | CT#92e | CP-211076 | 0535 | 1 | A | Registration with AMF re-direction | 17.2.0 | +| 2021-06 | CT#92e | CP-211036 | 0536 | 1 | B | Analytics subscription information | 17.2.0 | +| 2021-06 | CT#92e | CP-211036 | 0537 | 1 | B | S-NSSAIs per TA mapping event | 17.2.0 | +| 2021-06 | CT#92e | CP-211059 | 0541 | | A | Redirect Response for Namf_Communication | 17.2.0 | +| 2021-06 | CT#92e | CP-211036 | 0545 | 1 | B | Support of Mute Reporting | 17.2.0 | +| 2021-06 | CT#92e | CP-211059 | 0546 | | A | Redirect Response for Namf_EventExposure | 17.2.0 | +| 2021-06 | CT#92e | CP-211059 | 0548 | | A | Redirect Response for Namf_MT | 17.2.0 | +| 2021-06 | CT#92e | CP-211059 | 0550 | 1 | A | Redirect Response for Namf_Location | 17.2.0 | +| 2021-06 | CT#92e | CP-211059 | 0555 | 1 | A | Missing 307 and 308 for Namf_Communication | 17.2.0 | +| 2021-06 | CT#92e | CP-211028 | 0556 | 1 | F | Data Type Description for Namf_Communication Service API | 17.2.0 | +| 2021-06 | CT#92e | CP-211028 | 0557 | 1 | F | Data Type Description for Namf_EventExposure Service API | 17.2.0 | +| 2021-06 | CT#92e | CP-211028 | 0558 | 1 | F | Corrections on cardinality issues | 17.2.0 | +| 2021-06 | CT#92e | CP-211062 | 0564 | | A | hSmfId in PduSessionContext transferred to target AMF | 17.2.0 | +| 2021-06 | CT#92e | CP-211050 | 0565 | | F | 29.518 Rel-17 API version and External doc update | 17.2.0 | +| 2021-09 | CT#93e | | | | | Broadcast Empty Area List for Write-Replace-Warning Request NG-RAN | | +| | | CP-212026 | 0568 | | C | | 17.3.0 | +| 2021-09 | CT#93e | CP-212026 | 0569 | 1 | F | Corrections to NGAP messages | 17.3.0 | +| 2021-09 | CT#93e | CP-212082 | 0572 | 1 | A | AM Policy Information | 17.3.0 | +| 2021-09 | CT#93e | CP-212051 | 0573 | 1 | F | The maxReports IE in AmfEvent or AmfEventMode | 17.3.0 | +| 2021-09 | CT#93e | CP-212051 | 0574 | | F | Resource archetype correction | 17.3.0 | +| 2021-09 | CT#93e | CP-212041 | 0575 | | B | NF Services consumed by DCCF | 17.3.0 | +| 2021-09 | CT#93e | CP-212051 | 0576 | | F | Binding Indication | 17.3.0 | +| 2021-09 | CT#93e | CP-212026 | 0578 | | F | Missing errors in AMF APIs | 17.3.0 | +| 2021-09 | CT#93e | CP-212034 | 0580 | 1 | B | Add UE Positioning Capabilities | 17.3.0 | +| 2021-09 | CT#93e | CP-212097 | 0582 | | A | 3xx description correction for SCP | 17.3.0 | +| 2021-09 | CT#93e | CP-212034 | 0585 | 1 | B | Multiple QoS Class | 17.3.0 | +| 2021-09 | CT#93e | CP-212037 | 0586 | | B | Dynamic management of group based event monitoring | 17.3.0 | +| 2021-09 | CT#93e | CP-212051 | 0591 | 1 | F | NfInstanceId of CBCF | 17.3.0 | +| 2021-09 | CT#93e | CP-212036 | 0592 | | F | Miscellaneous 5G ProSe related corrections and updates | 17.3.0 | +| 2021-09 | CT#93e | CP-212059 | 0593 | | F | 29.518 Rel-17 API version and External doc update | 17.3.0 | +| 2021-12 | CT#94e | CP-213097 | 0596 | | B | Introduction of new AMF services (MBSBroadcast and MBSSCommunication) to clauses 4.1 and 5.1 | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0597 | | B | MBSBroadcast API - Overview of MBSBroadcast service | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0598 | 4 | B | MBSBroadcast API - ContextCreate service operation | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0599 | 2 | B | MBSBroadcast API - ContextUpdate service operation | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0600 | | B | MBSBroadcast API - ContextRelease service operation | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0601 | | B | MBSBroadcast API - Resources and methods overview | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0602 | | B | MBSBroadcast API - Resource Definition - Broadcast MBS session contexts collection | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0603 | | B | MBSBroadcast API - Resource Definition - Individual broadcast MBS session context | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0604 | 3 | B | MBSBroadcast API - Data Model & OpenAPI for ContextCreate and ContextStatusNotify service operations | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0605 | 3 | B | MBSBroadcast API - Data Model & OpenAPI for ContextUpdate service operation | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0606 | 1 | B | MBSBroadcast API - Data Model & OpenAPI for ContextRelease service operation | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0608 | 1 | B | Namf_MBSSCommunication service description | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0609 | 1 | B | Namf_MBSSCommunication resources and methods | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0610 | 2 | B | Namf_MBSSCommunication data type and openAPI | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0611 | 1 | B | Namf_MBSSCommunication error handling | 17.4.0 | +| 2021-12 | CT#94e | CP-213086 | 0612 | 2 | F | Transfer UE radio capability for paging between AMFs | 17.4.0 | +| 2021-12 | CT#94e | CP-213112 | 0613 | 1 | B | UUAA-MM status indication in UE Context | 17.4.0 | +| 2021-12 | CT#94e | CP-213112 | 0614 | 1 | B | N1N2MessageTransfer update | 17.4.0 | +| 2021-12 | CT#94e | CP-213112 | 0615 | 1 | B | Notification enhancement with additional filtering | 17.4.0 | +| 2021-12 | CT#94e | CP-213102 | 0616 | 1 | B | AMF event correction | 17.4.0 | +| 2021-12 | CT#94e | CP-213100 | 0617 | 2 | B | UEContext for SNPN | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0618 | 1 | B | EnableGroupReachability service procedure | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0619 | 1 | B | EnableGroupReachability resource and OpenAPI definition | 17.4.0 | +| 2021-12 | CT#94e | CP-213101 | 0622 | 1 | B | AM Policy Association modification Time synchronization enhancement | 17.4.0 | +| 2021-12 | CT#94e | CP-213108 | 0623 | 2 | B | Notification for SM Policy Association Events | 17.4.0 | +| 2021-12 | CT#94e | CP-213096 | 0624 | 1 | B | Higher Resolution Timestamp for Location Estimates | 17.4.0 | +| 2021-12 | CT#94e | CP-213096 | 0625 | 1 | F | UE Positioning Capabilities Data Type | 17.4.0 | +| 2021-12 | CT#94e | CP-213085 | 0627 | 1 | F | Correction on MT service | 17.4.0 | +| 2021-12 | CT#94e | CP-213087 | 0628 | 3 | F | S-NSSAI in PDU session context | 17.4.0 | + +| | | | | | | | | +|--|--|--|--|--|--|--|--| +| | | | | | | | | +|--|--|--|--|--|--|--|--| + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------------------|--------| +| 2021-12 | CT#94e | CP-213138 | 0630 | 1 | A | Idle Status Indication | 17.4.0 | +| 2021-12 | CT#94e | CP-213096 | 0633 | | B | Add scheduled location time | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0641 | | B | MBSBroadcast API - ContextStatusNotify service operation | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0642 | | B | MBSBroadcast API – Resource Definition - ContextStatusNotify service operation | 17.4.0 | +| 2021-12 | CT#94e | CP-213117 | 0643 | | F | One time location report when the current location cannot be obtained | 17.4.0 | +| 2021-12 | CT#94e | CP-213087 | 0644 | 1 | B | Minimal Report Interval | 17.4.0 | +| 2021-12 | CT#94e | CP-213117 | 0645 | | F | Event Subscription Modification Pattern | 17.4.0 | +| 2021-12 | CT#94e | CP-213138 | 0647 | 1 | A | Immediate Reporting | 17.4.0 | +| 2021-12 | CT#94e | CP-213138 | 0649 | 1 | A | Resolve EN for Event Subscription Sync | 17.4.0 | +| 2021-12 | CT#94e | CP-213145 | 0651 | 1 | A | 5GS User State Correction | 17.4.0 | +| 2021-12 | CT#94e | CP-213148 | 0654 | 1 | A | Essential Correction on N1N2MessageSubscribe for UE Policy | 17.4.0 | +| 2021-12 | CT#94e | CP-213098 | 0655 | 1 | B | MT_EnableUEReachability supporting MUSIM | 17.4.0 | +| 2021-12 | CT#94e | CP-213098 | 0656 | | F | Update MUSIM references | 17.4.0 | +| 2021-12 | CT#94e | CP-213117 | 0657 | 1 | F | Correcting citation to N1 messages | 17.4.0 | +| 2021-12 | CT#94e | CP-213110 | 0658 | 1 | B | Addition of UEs for group based event subscription | 17.4.0 | +| 2021-12 | CT#94e | CP-213086 | 0659 | | F | 3gpp-Sbi-Consumer-Info in UE Context | 17.4.0 | +| 2021-12 | CT#94e | CP-213087 | 0660 | 1 | F | Corrections related to the description fields in the OpenAPI descriptions | 17.4.0 | +| 2021-12 | CT#94e | CP-213121 | 0661 | | F | 29.518 Rel-17 API version and External doc update | 17.4.0 | +| 2022-03 | CT#95 | CP-220023 | 0664 | | F | New application error for ProvideDomainSelectionInfo (T-ADS) for a deregistered UE | 17.5.0 | +| 2022-03 | CT#95 | CP-220072 | 0665 | | F | Correction to CreateUEContext service operation regarding 5G-SRVCC | 17.5.0 | +| 2022-03 | CT#95 | CP-220081 | 0666 | 1 | A | Release of old access resources during Intra-AMF HO between 3GPP and non-3GPP accesses | 17.5.0 | +| 2022-03 | CT#95 | CP-220084 | 0667 | 1 | A | Secondary RAT data usage reporting over N14 during Inter-AMF handover | 17.5.0 | +| 2022-03 | CT#95 | CP-220034 | 0668 | 1 | B | Schedule location time for AMF | 17.5.0 | +| 2022-03 | CT#95 | CP-220051 | 0669 | | B | RedCap indication in UE context | 17.5.0 | +| 2022-03 | CT#95 | CP-220035 | 0670 | | F | Miscellaneous corrections | 17.5.0 | +| 2022-03 | CT#95 | CP-220048 | 0671 | 1 | F | Correction on time synchronization error budget | 17.5.0 | +| 2022-03 | CT#95 | CP-220055 | 0672 | | F | Essential Clarification for SMF ID in N1 Container | 17.5.0 | +| 2022-03 | CT#95 | CP-220049 | 0673 | 2 | B | UE Access Behavior Trends Event | 17.5.0 | +| 2022-03 | CT#95 | CP-220049 | 0674 | 2 | B | UE Location Trends Event | 17.5.0 | +| 2022-03 | CT#95 | CP-220049 | 0675 | 1 | B | UE MM Transactions Report Event | 17.5.0 | +| 2022-03 | CT#95 | CP-220035 | 0676 | | B | Correct the IEs included in EnableGroupReachability request | 17.5.0 | +| 2022-03 | CT#95 | CP-220035 | 0677 | | B | Service operation definition of UEReachabilityInfoNotify | 17.5.0 | +| 2022-03 | CT#95 | CP-220035 | 0678 | 1 | B | Resource and data types definition of UEReachabilityInfoNotify | 17.5.0 | +| 2022-03 | CT#95 | CP-220024 | 0679 | 1 | F | Rerouted Registration Request message | 17.5.0 | +| 2022-03 | CT#95 | CP-220024 | 0681 | 1 | F | Corrections related to the description fields in the OpenAPI descriptions | 17.5.0 | +| 2022-03 | CT#95 | CP-220025 | 0682 | 1 | B | Inter-PLMN mobility of PDU sessions | 17.5.0 | +| 2022-03 | CT#95 | CP-220035 | 0683 | | F | Miscellaneous corrections to the Namf_MBSBroadcast API | 17.5.0 | +| 2022-03 | CT#95 | CP-220035 | 0684 | | B | N2 MBS Session Management Information in Namf_MBSBroadcast API | 17.5.0 | +| 2022-03 | CT#95 | CP-220035 | 0685 | 1 | B | N2 MBS Session Management Information in Namf_MBSCommunication API | 17.5.0 | +| 2022-03 | CT#95 | CP-220065 | 0693 | | B | Additional Subscribed Policy Request Triggers in 3GPP R17 | 17.5.0 | +| 2022-03 | CT#95 | CP-220084 | 0696 | | A | Essential Correction on Policy Trigger | 17.5.0 | +| 2022-03 | CT#95 | CP-220081 | 0698 | | A | Missing Subscribed Policy Request Triggers in 3GPP R16 | 17.5.0 | +| 2022-03 | CT#95 | CP-220025 | 0699 | 2 | B | SM Context Consistency Validation | 17.5.0 | +| 2022-03 | CT#95 | CP-220076 | 0701 | 1 | A | Add UE triggered policy provisioning procedure in N1MessageNotify operation | 17.5.0 | +| 2022-03 | CT#95 | CP-220079 | 0705 | | A | V-SMF removal during Inter-AMF registration | 17.5.0 | +| 2022-03 | CT#95 | CP-220049 | 0706 | | F | Removal of Editor's Note | 17.5.0 | +| 2022-03 | CT#95 | CP-220025 | 0707 | 1 | F | 204 No Content in subscription modification response | 17.5.0 | +| 2022-03 | CT#95 | CP-220044 | 0709 | 1 | B | Update on AMF exposure events | 17.5.0 | +| 2022-03 | CT#95 | CP-220081 | 0711 | 1 | A | 200 OK in subscription modification response | 17.5.0 | +| 2022-03 | CT#95 | CP-220066 | 0712 | | F | 29.518 Rel-17 API version and External doc update | 17.5.0 | +| 2022-06 | CT#96 | CP-221043 | 0716 | | F | N1MessageNotify for ProSe | 17.6.0 | +| 2022-06 | CT#96 | CP-221023 | 0717 | 1 | F | NGAP MB-SMF related IE | 17.6.0 | +| 2022-06 | CT#96 | CP-221023 | 0718 | 1 | F | MBS Service Area Information for Location dependent MBS session | 17.6.0 | +| 2022-06 | CT#96 | CP-221023 | 0719 | | F | MBS Service Area in Namf_MBSCommunication N2MessageTransfer Request | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0720 | 2 | F | Location dependent MBS broadcast session | 17.6.0 | +| 2022-06 | CT#96 | CP-221043 | 0721 | | F | pc5QoSPara attribute name in ProseContext data type | 17.6.0 | +| 2022-06 | CT#96 | CP-221027 | 0722 | | F | Correction of typos in description fields | 17.6.0 | +| 2022-06 | CT#96 | CP-221023 | 0723 | | F | Paging strategy handling for multicast MBS session | 17.6.0 | +| 2022-06 | CT#96 | CP-221039 | 0724 | | F | Disaster Roaming Registration | 17.6.0 | +| 2022-06 | CT#96 | CP-221027 | 0725 | | F | Query parameters not complying with 29.501 naming conventions | 17.6.0 | +| 2022-06 | CT#96 | CP-221045 | 0726 | 1 | F | Released PDU Sessions during Registration | 17.6.0 | +| 2022-06 | CT#96 | CP-221045 | 0727 | 1 | F | Mobility between HPLMN and VPLMN | 17.6.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|---------------------------------------------------------------------------------|--------| +| 2022-06 | CT#96 | CP-221024 | 0729 | 3 | F | Adding MBS session ID to ContextCreateRspData | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0730 | 2 | F | Adding SNSSAI to ContextCreateReqData | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0733 | 1 | F | Corrections on HTTP Response | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0734 | 1 | F | Broadcast MBS Session Release Require procedure | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0735 | | F | N2 MBS Info Change Indicator | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0736 | 1 | F | Signaling of NG-RAN Node ID from AMF to MB-SMF | 17.6.0 | +| 2022-06 | CT#96 | CP-221061 | 0738 | | A | Updp Subscription Callback Binding | 17.6.0 | +| 2022-06 | CT#96 | CP-221061 | 0740 | 2 | A | Essential Correction for PCF Bindings | 17.6.0 | +| 2022-06 | CT#96 | CP-221033 | 0741 | | F | PCF Provided UE Slice MBR in UE Context | 17.6.0 | +| 2022-06 | CT#96 | CP-221068 | 0743 | | A | SmfSellInfo in UE Context | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0745 | 1 | F | Remove non-existent ngapData in the ContextCreateReqData as required in openAPI | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0746 | 1 | B | Reporting NG-RAN failure to MB-SMF | 17.6.0 | +| 2022-06 | CT#96 | CP-221022 | 0747 | 1 | F | Event Reporting in RRC inactive state | 17.6.0 | +| 2022-06 | CT#96 | CP-221033 | 0748 | 1 | F | Subscribed-UE-Slice-MBR | 17.6.0 | +| 2022-06 | CT#96 | CP-221068 | 0750 | | A | pc5QoSPara attribute name in V2xContext data type | 17.6.0 | +| 2022-06 | CT#96 | CP-221051 | 0751 | | F | 29.518 Rel-17 API version and External doc update | 17.6.0 | +| 2022-09 | CT#97 | CP-222047 | 0754 | 1 | F | Current Location | 17.7.0 | +| 2022-09 | CT#97 | CP-222031 | 0755 | 1 | F | NGAP MB-SMF related IE | 17.7.0 | +| 2022-09 | CT#97 | CP-222026 | 0758 | 1 | F | Handling of N1N2MessageTransfer Failure when UE in Non-Allowed Area | 17.7.0 | +| 2022-09 | CT#97 | CP-222053 | 0760 | | F | Correct the description of the provide-loc-info and the cancel-pos-info | 17.7.0 | +| 2022-09 | CT#97 | CP-222063 | 0764 | 1 | A | MSC Server Identity in Namf_Location_EventNotify during SRVCC handover | 17.7.0 | +| 2022-09 | CT#97 | CP-222031 | 0765 | | F | Corrections for the N2MbsSmInfo data type | 17.7.0 | +| 2022-09 | CT#97 | CP-222031 | 0766 | | F | Correction for the Namf_MBSBroadcast API | 17.7.0 | +| 2022-09 | CT#97 | CP-222061 | 0768 | 1 | A | SMSF Set and Binding Info | 17.7.0 | +| 2022-09 | CT#97 | CP-222043 | 0769 | 1 | F | SMF Security and Capability in PDU Session Context | 17.7.0 | +| 2022-09 | CT#97 | CP-222054 | 0770 | 2 | F | Create UE Context with AMF Relocation | 17.7.0 | +| 2022-09 | CT#97 | CP-222065 | 0772 | 1 | A | Timestamp for Periodic Event Reporting during Mobility | 17.7.0 | +| 2022-09 | CT#97 | CP-222047 | 0774 | 1 | F | EE Subscription Notification Error Handling | 17.7.0 | +| 2022-09 | CT#97 | CP-222068 | 0776 | 1 | A | 409 Response on Xn HO and Intra-AMF N2 HO | 17.7.0 | +| 2022-09 | CT#97 | CP-222053 | 0777 | 1 | F | Essential Clarification for N2 Info Subscription | 17.7.0 | +| 2022-09 | CT#97 | CP-222068 | 0783 | | A | AMF relocation in EPS to 5GS handover | 17.7.0 | +| 2022-09 | CT#97 | CP-222035 | 0785 | 1 | F | Removal of Editor's Note | 17.7.0 | +| 2022-09 | CT#97 | CP-222036 | 0786 | 1 | F | Indication of Network Assisted Positioning method | 17.7.0 | +| 2022-09 | CT#97 | CP-222031 | 0787 | 3 | F | Clarification to OperationStatus | 17.7.0 | +| 2022-09 | CT#97 | CP-222031 | 0788 | 1 | F | Correction to ContextCreateReqData | 17.7.0 | +| 2022-09 | CT#97 | CP-222057 | 0789 | 1 | F | EPS interworking Info in UE Context | 17.7.0 | +| 2022-09 | CT#97 | CP-222058 | 0790 | | F | 29.518 Rel-17 API version and External doc update | 17.7.0 | +| 2022-09 | CT#97 | CP-222232 | 0793 | | F | Inserting missing clarification on Max Number of Reports | 17.7.0 | +| 2022-12 | CT#98 | CP-223057 | 0794 | | F | Feature bit alignment | 17.8.0 | +| 2022-12 | CT#98 | CP-223036 | 0797 | 1 | F | Add MBS Update procedure to the ContextCreate service operation | 17.8.0 | +| 2022-12 | CT#98 | CP-223060 | 0799 | 1 | F | Inter AMF mobility when UE is registered in both 3GPP and non-3GPP | 17.8.0 | +| 2022-12 | CT#98 | CP-223036 | 0801 | 1 | F | Missing clauses for Namf_MBSBroadcast Service | 17.8.0 | +| 2022-12 | CT#98 | CP-223036 | 0802 | 1 | F | Missing clauses for Namf_MBSCommunication Service | 17.8.0 | +| 2022-12 | CT#98 | CP-223099 | 0810 | 3 | A | Area of Interest Event Status from Old AMF | 17.8.0 | +| 2022-12 | CT#98 | CP-223069 | 0812 | 1 | A | Missing IMEISV in N1N2 Message Subscription | 17.8.0 | +| 2022-12 | CT#98 | CP-223051 | 0815 | 1 | F | PLMN with disaster condition | 17.8.0 | +| 2022-12 | CT#98 | CP-223062 | 0817 | 1 | F | Correction of boolean type IEs | 17.8.0 | +| 2022-12 | CT#98 | CP-223066 | 0822 | | F | 29.518 Rel-17 API version and External doc update | 17.8.0 | +| 2022-12 | CT#98 | CP-223030 | 0800 | 1 | B | Inter AMF mobility when UE is registered in SNPN with different access | 18.0.0 | +| 2022-12 | CT#98 | CP-223035 | 0803 | 1 | B | Support of RRC_INACTIVE with long eDRX | 18.0.0 | +| 2022-12 | CT#98 | CP-223036 | 0804 | | B | Multicast MBS session (de)activation or update after an AMF failure | 18.0.0 | +| 2022-12 | CT#98 | CP-223036 | 0805 | | F | MBS session update for Broadcast | 18.0.0 | +| 2022-12 | CT#98 | CP-223028 | 0806 | 1 | F | Missing mandatory status codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98 | CP-223027 | 0808 | 1 | B | Retry Timer for N1N2 Transfer Failure | 18.0.0 | +| 2022-12 | CT#98 | CP-223058 | 0813 | 3 | F | Event Subscription Termination Notification | 18.0.0 | +| 2022-12 | CT#98 | CP-223062 | 0816 | 1 | F | Value of ageOfLocationInformation | 18.0.0 | +| 2022-12 | CT#98 | CP-223033 | 0821 | | F | 29.518 Rel-18 API version and External doc update | 18.0.0 | +| 2023-03 | CT#99 | CP-230039 | 0825 | 1 | B | Support Unavailability Duration in Namf_ EE API | 18.1.0 | +| 2023-03 | CT#99 | CP-230090 | 0830 | | A | Essential Corrections on Resource URI | 18.1.0 | +| 2023-03 | CT#99 | CP-230062 | 0835 | | D | Editorial correction to ContextRelease | 18.1.0 | +| 2023-03 | CT#99 | CP-230036 | 0836 | 1 | B | Protocol support for MBS Session in MOCN | 18.1.0 | +| 2023-03 | CT#99 | CP-230077 | 0838 | 1 | A | Update operation status and event for broadcast session release | 18.1.0 | +| 2023-03 | CT#99 | CP-230049 | 0839 | | F | Miscellaneous Corrections | 18.1.0 | +| 2023-03 | CT#99 | CP-230030 | 0840 | 1 | B | Parameters used to consume Namf_MT_enableUeReachability service | 18.1.0 | +| 2023-03 | CT#99 | CP-230046 | 0841 | 1 | B | Manage Event Muting Impact on NFp | 18.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------------------------|--------| +| 2023-03 | CT#99 | CP-230029 | 0843 | | B | OAuth2 scopes in the Namf_MT API | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0844 | 1 | B | OAuth2 scopes in the Namf_Communication API | 18.1.0 | +| 2023-03 | CT#99 | CP-230032 | 0845 | 1 | B | Local LMF and GMLC selection | 18.1.0 | +| 2023-03 | CT#99 | CP-230077 | 0847 | | A | Incorrect enable-group-reachability operation resource URI in the OpenAPI | 18.1.0 | +| 2023-03 | CT#99 | CP-230088 | 0849 | | A | Add nextPeriodicReportTime IE to Namf_EventExposure OpenAPI | 18.1.0 | +| 2023-03 | CT#99 | CP-230032 | 0852 | 2 | B | Support of Event Report Allowed Area | 18.1.0 | +| 2023-03 | CT#99 | CP-230093 | 0855 | 1 | A | Essential Corrections on AMF Events | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0856 | 2 | B | PWS N2 Subscription Unavailability Indication | 18.1.0 | +| 2023-03 | CT#99 | CP-230094 | 0859 | 1 | A | Missed AM Policy Information in UE Context | 18.1.0 | +| 2023-03 | CT#99 | CP-230031 | 0860 | 1 | B | Multiple location report for MT-LR Immediate Location Request for the regulatory service | 18.1.0 | +| 2023-03 | CT#99 | CP-230032 | 0863 | 1 | B | UE Unaware Positioning | 18.1.0 | +| 2023-03 | CT#99 | CP-230032 | 0864 | 2 | B | Support of low power and high accuracy positioning | 18.1.0 | +| 2023-03 | CT#99 | CP-230032 | 0865 | 1 | B | Location service in PNI-NPN with signalling optimisation | 18.1.0 | +| 2023-03 | CT#99 | CP-230041 | 0867 | 1 | B | Satellite backhaul category change | 18.1.0 | +| 2023-03 | CT#99 | CP-230042 | 0868 | | B | Event exposure subscribed by the TSCTSF | 18.1.0 | +| 2023-03 | CT#99 | CP-230062 | 0869 | 1 | F | Correct the name of the retry after timer | 18.1.0 | +| 2023-03 | CT#99 | CP-230062 | 0870 | 1 | F | Correction on UE Context Release | 18.1.0 | +| 2023-03 | CT#99 | CP-230071 | 0872 | | F | 29.518 Rel-18 API version and External doc update | 18.1.0 | +| 2023-06 | CT#100 | CP-231028 | 0871 | 4 | F | Location header description | 18.2.0 | +| 2023-06 | CT#100 | CP-231043 | 0876 | 1 | B | Presence-In-AOI-Report event with adjustment of the AoI based on the UE's RA | 18.2.0 | +| 2023-06 | CT#100 | CP-231043 | 0877 | 1 | B | Presence-In-AOI-Report event for RAN timing synchronization status change | 18.2.0 | +| 2023-06 | CT#100 | CP-231025 | 0878 | | F | Correct the table of the HTTP status code for N1N2MessageTransfer | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0879 | 1 | B | Location service bi-directional continuity between EPS and 5GS | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0880 | 2 | B | Support of PRUs | 18.2.0 | +| 2023-06 | CT#100 | CP-231047 | 0885 | | F | Correction of Event muting mechanism | 18.2.0 | +| 2023-06 | CT#100 | CP-231064 | 0886 | | F | iwkSnssai in EPS to 5GS handover procedure with AMF relocation | 18.2.0 | +| 2023-06 | CT#100 | CP-231064 | 0887 | | F | Correction on service operations in Namf_Communication service | 18.2.0 | +| 2023-06 | CT#100 | CP-231081 | 0889 | 1 | A | Pattern of path in AmfUpdateEventOptionItem | 18.2.0 | +| 2023-06 | CT#100 | CP-231083 | 0891 | | A | Add group member UE(s) for a group subscription | 18.2.0 | +| 2023-06 | CT#100 | CP-231075 | 0893 | 1 | A | Missing finer periodicities than 1s and an infinite reporting amount | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0894 | 1 | B | PRU Indication in N1N2MessageTransfer | 18.2.0 | +| 2023-06 | CT#100 | CP-231028 | 0895 | 1 | B | Omit UE IDs for Number of UEs in Area Event | 18.2.0 | +| 2023-06 | CT#100 | CP-231064 | 0898 | 3 | B | Support of RACS feature | 18.2.0 | +| 2023-06 | CT#100 | CP-231043 | 0899 | 1 | B | Service Operations for Subscription and management of network timing synchronization status monitoring | 18.2.0 | +| 2023-06 | CT#100 | CP-231043 | 0900 | 1 | B | Data Type for Subscription and management of network timing synchronization status monitoring | 18.2.0 | +| 2023-06 | CT#100 | CP-231030 | 0901 | 1 | B | SMF as the NF consumer of Namf_MT_enableUeReachability service | 18.2.0 | +| 2023-06 | CT#100 | CP-231069 | 0906 | 1 | F | Essential Correction on 202 Location Header of N1N2MessageTransfer | 18.2.0 | +| 2023-06 | CT#100 | CP-231029 | 0908 | 1 | F | Event Synchronization with No EE Subscription Indication via UECM | 18.2.0 | +| 2023-06 | CT#100 | CP-231047 | 0910 | 1 | B | Variable reporting periodicity | 18.2.0 | +| 2023-06 | CT#100 | CP-231083 | 0912 | 1 | A | Correction the name of tailList attribute in TargetArea | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0914 | 2 | B | Add reporting indication | 18.2.0 | +| 2023-06 | CT#100 | CP-231042 | 0915 | 1 | B | Update on ProseContext | 18.2.0 | +| 2023-06 | CT#100 | CP-231069 | 0917 | | F | Correct the data type UeContextTransferReqData name | 18.2.0 | +| 2023-06 | CT#100 | CP-231069 | 0918 | | F | Correct the table in provide-pos-info response | 18.2.0 | +| 2023-06 | CT#100 | CP-231048 | 0919 | 2 | B | Partially allowed Network slice | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0920 | 2 | B | Requested LMF ID is not available | 18.2.0 | +| 2023-06 | CT#100 | CP-231090 | 0923 | 1 | F | Incorrect OpenAPI definition of aoiStateList in AmfEventSubscriptionAddInfo | 18.2.0 | +| 2023-06 | CT#100 | CP-231070 | 0925 | | F | 29.518 Rel-18 API version and External doc update | 18.2.0 | +| 2023-09 | CT#101 | CP-232033 | 0928 | 1 | F | Subscription authorization in Context Transfer | 18.3.0 | +| 2023-09 | CT#101 | CP-232043 | 0930 | 1 | B | Updating N1messageNotification during AMF re-allocation procedure to include partially Allowed NSSAI | 18.3.0 | +| 2023-09 | CT#101 | CP-232036 | 0933 | 1 | B | HR-SBO Allowed indication during intra-PLMN Handover | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 0934 | 1 | F | Event subscription rejection with UE_NOT_SERVED_BY_AMF application error | 18.3.0 | +| 2023-09 | CT#101 | CP-232046 | 0935 | 2 | B | A2X information in UE Context | 18.3.0 | +| 2023-09 | CT#101 | CP-232057 | 0937 | 1 | B | Update the ProseContext data type | 18.3.0 | +| 2023-09 | CT#101 | CP-232035 | 0938 | 1 | F | Correction on Reporting Indication | 18.3.0 | +| 2023-09 | CT#101 | CP-232043 | 0939 | 1 | B | Slice Usage Control Information in UE Context | 18.3.0 | +| 2023-09 | CT#101 | CP-232063 | 0941 | | A | Missed HA GNSS Metrics Support over SBI | 18.3.0 | +| 2023-09 | CT#101 | CP-232053 | 0942 | 4 | B | Support of Mobile Base Station Relay in AMF services | 18.3.0 | +| 2023-09 | CT#101 | CP-232058 | 0944 | 1 | F | Correction of NGAP IE type description in N2InfoContent | 18.3.0 | +| 2023-09 | CT#101 | CP-232058 | 0945 | | F | Correction of Unsubscribe procedure description | 18.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------|--------| +| 2023-09 | CT#101 | CP-232058 | 0946 | | F | Correction of references to the tables in the description | 18.3.0 | +| 2023-09 | CT#101 | CP-232049 | 0949 | 2 | B | PC5 QoS parameters related to RSPP transport over PC5 | 18.3.0 | +| 2023-09 | CT#101 | CP-232035 | 0950 | 1 | B | Support on Indoor/Outdoor indication | 18.3.0 | +| 2023-09 | CT#101 | CP-232062 | 0953 | 1 | A | Add GNSS integrity requirement | 18.3.0 | +| 2023-09 | CT#101 | CP-232058 | 0954 | | F | Correction on the description of DateTime | 18.3.0 | +| 2023-09 | CT#101 | CP-232049 | 0956 | 2 | B | Update on AMF service for MT procedures for ranging_SL | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 0957 | | F | Correcting the definition of the maxRespTime attribute | 18.3.0 | +| 2023-09 | CT#101 | CP-232035 | 0958 | 1 | B | Support on NLOS/LOS measurement indication | 18.3.0 | +| 2023-09 | CT#101 | CP-232060 | 0959 | | F | 29.518 Rel-18 API version and External doc update | 18.3.0 | +| 2023-12 | CT#102 | CP-233037 | 0936 | 2 | B | Periodic or triggered location events via user plane to an LCS Client or AF | 18.4.0 | +| 2023-12 | CT#102 | CP-233036 | 0955 | 3 | B | Updates to support Extended DRX for RRC-INACTIVE state with CN based MT communication handling | 18.4.0 | +| 2023-12 | CT#102 | CP-233028 | 0961 | 1 | B | Event subscription not authorized by the target AMF | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0963 | 2 | B | Add LCS-UP context | 18.4.0 | +| 2023-12 | CT#102 | CP-233044 | 0964 | | F | Incorrect numbering for ExpectedUeBehavior | 18.4.0 | +| 2023-12 | CT#102 | CP-233063 | 0966 | 2 | A | Correct the N2MbsSMinfo in the MBS broadcast service | 18.4.0 | +| 2023-12 | CT#102 | CP-233044 | 0967 | 1 | F | Editorial corrections and adding missing attributes in the procedure description | 18.4.0 | +| 2023-12 | CT#102 | CP-233041 | 0968 | 2 | B | Updates on the RAN Timing Synchronization Status Report related N2 information | 18.4.0 | +| 2023-12 | CT#102 | CP-233044 | 0971 | 1 | F | Missed Service Operations in Tables | 18.4.0 | +| 2023-12 | CT#102 | CP-233045 | 0972 | 2 | F | Clarification on muting mechanism in AMF event exposure service | 18.4.0 | +| 2023-12 | CT#102 | CP-233041 | 0976 | 1 | B | UE reconnection indication in UE context in AMF | 18.4.0 | +| 2023-12 | CT#102 | CP-233041 | 0977 | 1 | B | Update Non-UE N2 subscription and notification | 18.4.0 | +| 2023-12 | CT#102 | CP-233033 | 0978 | 1 | B | Support for resource sharing across multiple broadcast MBS Sessions during network sharing | 18.4.0 | +| 2023-12 | CT#102 | CP-233050 | 0980 | 2 | B | Update on AMF services for ranging_SL | 18.4.0 | +| 2023-12 | CT#102 | CP-233044 | 0981 | 1 | F | Clarification on Unavailability Period | 18.4.0 | +| 2023-12 | CT#102 | CP-233031 | 0983 | 1 | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233031 | 0984 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0986 | 1 | F | Reporting Indication Definition Alignment to Stage 2 | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0987 | 1 | B | Multiple QoS for Deferred Location Service Continuation from 5GS to EPS | 18.4.0 | +| 2023-12 | CT#102 | CP-233031 | 0988 | 2 | B | TAI Range List in AreaOfValidity | 18.4.0 | +| 2023-12 | CT#102 | CP-233041 | 0991 | 1 | F | Network Timing Synchronization Status feature in Table 6.1.8-1 | 18.4.0 | +| 2023-12 | CT#102 | CP-233041 | 0992 | 1 | B | New event filters for Presence-In-AOI-Report event subscription targeting Any UE | 18.4.0 | +| 2023-12 | CT#102 | CP-233077 | 0993 | 2 | B | Broadcast Session Transport procedure support by the ContextStatusNotify service operation | 18.4.0 | +| 2023-12 | CT#102 | CP-233040 | 0995 | 1 | F | UE_NOT_RESPONDING Application Error for 504 Response Missing | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0996 | | F | Update the support of PRU related procedures | 18.4.0 | +| 2023-12 | CT#102 | CP-233056 | 1000 | 2 | F | Corrections to support Extended DRX in CM-IDLE state | 18.4.0 | +| 2023-12 | CT#102 | CP-233050 | 1003 | 1 | B | Update on delivery of N2 information for rangingsl | 18.4.0 | +| 2023-12 | CT#102 | CP-233056 | 1004 | 1 | F | Update on delivery of N2 information for 5G Prose | 18.4.0 | +| 2023-12 | CT#102 | CP-233060 | 1006 | | F | 29.518 Rel-18 API version and External doc update | 18.4.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29537/raw.md b/marked/Rel-18/29_series/29537/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..880ceec5a5295d66b2cdd4780dea04b671a66a1c --- /dev/null +++ b/marked/Rel-18/29_series/29537/raw.md @@ -0,0 +1,2995 @@ + + +# 3GPP TS 29.537 V18.3.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Multicast/Broadcast Policy Control Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, stylized font. Below the 'P' is a red signal wave icon, and below the entire logo is the text 'A GLOBAL INITIATIVE'. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions, symbols and abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Symbols..... | 9 | +| 3.3 Abbreviations ..... | 9 | +| 4 Overview..... | 9 | +| 5 Services offered by the PCF..... | 10 | +| 5.1 Introduction ..... | 10 | +| 5.2 Npcf_MBSPolicyControl Service..... | 11 | +| 5.2.1 Service Description ..... | 11 | +| 5.2.2 Service Operations..... | 11 | +| 5.2.2.1 Introduction..... | 11 | +| 5.2.2.2 Npcf_MBSPoliyControl_Create..... | 11 | +| 5.2.2.2.1 General ..... | 11 | +| 5.2.2.2.2 MBS Policy Association Establishment..... | 11 | +| 5.2.2.3 Npcf_MBSPolicyControl_Update ..... | 14 | +| 5.2.2.3.1 General ..... | 14 | +| 5.2.2.3.2 MBS Policy Association Update..... | 14 | +| 5.2.2.4 Npcf_MBSPolicyControl_Delete ..... | 16 | +| 5.2.2.4.1 General ..... | 16 | +| 5.2.2.4.2 MBS Policy Association Deletion..... | 16 | +| 5.2.3 MBS Policy Decision Management ..... | 16 | +| 5.2.3.1 General..... | 16 | +| 5.2.3.1.1 MBS PCC Rule definition..... | 17 | +| 5.2.3.1.2 MBS QoS Decision..... | 18 | +| 5.2.3.1.3 MBS QoS Characteristics..... | 18 | +| 5.2.3.1.4 MBS Session-AMBR..... | 18 | +| 5.2.3.1.5 MBS Policy Control Request Triggers..... | 19 | +| 5.2.3.2 Provisioning and enforcement of MBS Policy Decisions ..... | 19 | +| 5.2.3.2.1 General ..... | 19 | +| 5.2.3.2.2 Provisioning and enforcement of MBS PCC rules..... | 19 | +| 5.2.3.2.3 Provisioning and enforcement of authorized MBS QoS for an MBS service data flow ..... | 19 | +| 5.2.3.2.4 Provisioning and enforcement of authorized MBS Session-AMBR..... | 20 | +| 5.2.3.2.5 Provisioning and enforcement of MBS Policy Control Request Triggers ..... | 20 | +| 5.2.4 MBS Policy Error Handling ..... | 21 | +| 5.2.4.1 MBS Policy Error Reporting ..... | 21 | +| 5.3 Npcf_MBSPolicyAuthorization Service..... | 22 | +| 5.3.1 Service Description ..... | 22 | +| 5.3.2 Service Operations..... | 22 | +| 5.3.2.1 Introduction..... | 22 | +| 5.3.2.2 Npcf_MBSPoliyAuthorization_Create..... | 22 | +| 5.3.2.2.1 General ..... | 22 | +| 5.3.2.2.2 MBS Application Session Context Establishment..... | 22 | +| 5.3.2.3 Npcf_MBSPoliyAuthorization_Update..... | 24 | +| 5.3.2.3.1 General ..... | 24 | +| 5.3.2.3.2 MBS Application Session Context Update ..... | 24 | +| 5.3.2.4 Npcf_MBSPoliyAuthorization_Delete..... | 25 | +| 5.3.2.4.1 General ..... | 25 | +| 5.3.2.4.2 MBS Application Session Context Deletion..... | 26 | +| 6 API Definitions ..... | 27 | +| 6.1 Npcf_MBSPolicyControl Service API..... | 27 | + +| | | | +|-------------|----------------------------------------------------------------------------------|----| +| 6.1.1 | Introduction ..... | 27 | +| 6.1.2 | Usage of HTTP ..... | 27 | +| 6.1.2.1 | General ..... | 27 | +| 6.1.2.2 | HTTP standard headers ..... | 27 | +| 6.1.2.2.1 | General ..... | 27 | +| 6.1.2.2.2 | Content type ..... | 27 | +| 6.1.2.3 | HTTP custom headers ..... | 27 | +| 6.1.3 | Resources ..... | 28 | +| 6.1.3.1 | Overview ..... | 28 | +| 6.1.3.2 | Resource: MBS Policies ..... | 28 | +| 6.1.3.2.1 | Description ..... | 28 | +| 6.1.3.2.2 | Resource Definition ..... | 28 | +| 6.1.3.2.3 | Resource Standard Methods ..... | 29 | +| 6.1.3.2.3.1 | POST ..... | 29 | +| 6.1.3.2.4 | Resource Custom Operations ..... | 30 | +| 6.1.3.3 | Resource: Individual MBS Policy ..... | 30 | +| 6.1.3.3.1 | Description ..... | 30 | +| 6.1.3.3.2 | Resource Definition ..... | 30 | +| 6.1.3.3.3 | Resource Standard Methods ..... | 30 | +| 6.1.3.3.3.1 | GET ..... | 30 | +| 6.1.3.3.3.2 | DELETE ..... | 31 | +| 6.1.3.3.4 | Resource Custom Operations ..... | 32 | +| 6.1.3.3.4.1 | Overview ..... | 32 | +| 6.1.3.3.4.2 | Operation: Update ..... | 33 | +| 6.1.4 | Custom Operations without associated resources ..... | 34 | +| 6.1.5 | Notifications ..... | 34 | +| 6.1.6 | Data Model ..... | 34 | +| 6.1.6.1 | General ..... | 34 | +| 6.1.6.2 | Structured data types ..... | 35 | +| 6.1.6.2.1 | Introduction ..... | 35 | +| 6.1.6.2.2 | Type: MbsPolicyCtxData ..... | 35 | +| 6.1.6.2.3 | Type: MbsPolicyDecision ..... | 36 | +| 6.1.6.2.4 | Type: MbsPolicyData ..... | 36 | +| 6.1.6.2.5 | Void ..... | 37 | +| 6.1.6.2.6 | Void ..... | 37 | +| 6.1.6.2.7 | Type: MbsPccRule ..... | 37 | +| 6.1.6.2.8 | Type: MbsQosDec ..... | 38 | +| 6.1.6.2.9 | Type: MbsQosChar ..... | 39 | +| 6.1.6.2.10 | Type: MbsErrorReport ..... | 39 | +| 6.1.6.2.11 | Type: MbsPolicyCtxDataUpdate ..... | 39 | +| 6.1.6.2.12 | Type: MbsReport ..... | 40 | +| 6.1.6.3 | Simple data types and enumerations ..... | 40 | +| 6.1.6.3.1 | Introduction ..... | 40 | +| 6.1.6.3.2 | Simple data types ..... | 40 | +| 6.1.6.3.3 | Enumeration: MbsPcrt ..... | 40 | +| 6.1.6.3.4 | Enumeration: MbsFailureCode ..... | 41 | +| 6.1.6.3.5 | Enumeration: MbsPccRuleStatus ..... | 41 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 41 | +| 6.1.6.5 | Binary data ..... | 42 | +| 6.1.6.5.1 | Binary Data Types ..... | 42 | +| 6.1.7 | Error Handling ..... | 42 | +| 6.1.7.1 | General ..... | 42 | +| 6.1.7.2 | Protocol Errors ..... | 42 | +| 6.1.7.3 | Application Errors ..... | 42 | +| 6.1.8 | Feature negotiation ..... | 43 | +| 6.1.9 | Security ..... | 43 | +| 6.2 | Npcf_MBSPolicyAuthorization Service API ..... | 44 | +| 6.2.1 | Introduction ..... | 44 | +| 6.2.2 | Usage of HTTP ..... | 44 | +| 6.2.2.1 | General ..... | 44 | +| 6.2.2.2 | HTTP standard headers ..... | 44 | +| 6.2.2.2.1 | General ..... | 44 | + +| | | | +|------------------------------------------------------------|----------------------------------------------------------------------------------|-----------| +| 6.2.2.2.2 | Content type ..... | 44 | +| 6.2.2.3 | HTTP custom headers..... | 44 | +| 6.2.3 | Resources..... | 45 | +| 6.2.3.1 | Overview..... | 45 | +| 6.2.3.2 | Resource: MBS Application Session Contexts..... | 45 | +| 6.2.3.2.1 | Description ..... | 45 | +| 6.2.3.2.2 | Resource Definition..... | 45 | +| 6.2.3.2.3 | Resource Standard Methods..... | 46 | +| 6.2.3.2.3.1 | POST ..... | 46 | +| 6.2.3.2.4 | Resource Custom Operations..... | 46 | +| 6.2.3.3 | Resource: Individual MBS Application Session Context..... | 47 | +| 6.2.3.3.1 | Description ..... | 47 | +| 6.2.3.3.2 | Resource Definition..... | 47 | +| 6.2.3.3.3 | Resource Standard Methods..... | 47 | +| 6.2.3.3.3.1 | GET ..... | 47 | +| 6.2.3.3.3.2 | PATCH..... | 48 | +| 6.2.3.3.3.3 | DELETE ..... | 49 | +| 6.2.3.3.4 | Resource Custom Operations..... | 51 | +| 6.2.4 | Custom Operations without associated resources ..... | 51 | +| 6.2.5 | Notifications ..... | 51 | +| 6.2.6 | Data Model ..... | 51 | +| 6.2.6.1 | General..... | 51 | +| 6.2.6.2 | Structured data types..... | 51 | +| 6.2.6.2.1 | Introduction ..... | 51 | +| 6.2.6.2.2 | Type: MbsAppSessionCtxt ..... | 52 | +| 6.2.6.2.3 | Type: MbsAppSessionCtxtPatch..... | 53 | +| 6.2.6.2.4 | Type: AcceptableMbsServInfo ..... | 53 | +| 6.2.6.3 | Simple data types and enumerations..... | 53 | +| 6.2.6.3.1 | Introduction ..... | 53 | +| 6.2.6.3.2 | Simple data types ..... | 53 | +| 6.2.6.4 | Data types describing alternative data types or combinations of data types ..... | 54 | +| 6.2.6.4.1 | Type: MbsExtProblemDetails ..... | 54 | +| 6.2.6.5 | Binary data ..... | 54 | +| 6.2.6.5.1 | Binary Data Types..... | 54 | +| 6.2.7 | Error Handling ..... | 54 | +| 6.2.7.1 | General..... | 54 | +| 6.2.7.2 | Protocol Errors ..... | 54 | +| 6.2.7.3 | Application Errors..... | 54 | +| 6.2.8 | Feature negotiation ..... | 55 | +| 6.2.9 | Security..... | 55 | +| Annex A (normative): OpenAPI specification ..... | | 56 | +| A.1 | General..... | 56 | +| A.2 | Npcf_MBSPolicyControl API ..... | 57 | +| A.3 | Npcf_MBSPolicyAuthorization API ..... | 64 | +| Annex B (informative): Withdrawn API versions ..... | | 68 | +| B.1 | General..... | 68 | +| B.2 | Npcf_MBSPolicyControl API ..... | 68 | +| B.3 | Npcf_MBSPolicyAuthorization API ..... | 68 | +| Annex C (informative): Change history..... | | 69 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Service Based Interfaces of the Multicast/Broadcast Policy Control Services. It provides stage 3 protocol definitions and message flows, and specifies the APIs of the Multicast/Broadcast Services provided by the PCF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. The stage 2 architecture and procedures for 5G Multicast/Broadcast Services are specified in 3GPP TS 23.247 [14]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "HTTP/2". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] 3GPP TS 23.247: "Architectural enhancements for 5G multicast-broadcast services; Stage 2". +- [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [16] 3GPP TS 29.532: "5G System; 5G Multicast-Broadcast Session Management Services; Stage 3". +- [17] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [18] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3". +- [19] 3GPP TS 29.214: "Policy and Charging Control over Rx reference point". + +- [20] 3GPP TS 29.519: "5G System; Usage of the Unified Data Repository service for Policy Data, Application Data and Structured Data for Exposure; Stage 3". +- [21] 3GPP TS 29.521: "5G System; Binding Support Management Service; Stage 3". +- [22] IETF RFC 7396: "JSON Merge Patch". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +For the purpose of the present document, the terms and definitions given in clause 3 of 3GPP TS 23.247 [14] also apply, including the ones referencing other specifications. + +## 3.2 Symbols + +None. + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|--------|-------------------------------------------------| +| MBS | Multicast/Broadcast Service | +| MB-SMF | Multicast/Broadcast Session Management Function | +| MBSF | Multicast/Broadcast Service Function | + +# --- 4 Overview + +In the frame of supporting Multicast/Broadcast Services (MBS), the Policy Control Function (PCF) provides services to NF service consumers (e.g. MB-SMF) via the Npcf Service Based Interface. The PCF supports for this purpose the functionalities defined in 3GPP TS 23.247 [14], i.e. MBS related Policy and Charging Control procedures. + +Figures 4-1 and 4-2 depict the Multicast/Broadcast related reference architecture of the PCF respectively in SBI representation and reference point representation. + +![Reference model for the MBS PCF Services – SBI representation diagram showing a central PCF connected to four network functions: MB-SMF, NEF, AF, and MBSF via the Npcf interface.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +graph TD + PCF[PCF] -- Npcf --> MB-SMF[MB-SMF] + PCF -- Npcf --> NEF[NEF] + PCF -- Npcf --> AF[AF] + PCF -- Npcf --> MBSF[MBSF] + style PCF fill:#90EE90 + +``` + +Reference model for the MBS PCF Services – SBI representation diagram showing a central PCF connected to four network functions: MB-SMF, NEF, AF, and MBSF via the Npcf interface. + +Figure 4-1: Reference model for the MBS PCF Services – SBI representation + +![Reference Model for the MBS PCF Services – Reference point representation diagram showing four network functions (MB-SMF, NEF, AF, MBSF) connected to a central PCF via specific reference points: N7mb, N30, N5, and Nmb12.](b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg) + +``` + +graph LR + MB-SMF[MB-SMF] -- N7mb --> PCF[PCF] + NEF[NEF] -- N30 --> PCF + AF[AF] -- N5 --> PCF + MBSF[MBSF] -- Nmb12 --> PCF + style PCF fill:#90EE90 + +``` + +Reference Model for the MBS PCF Services – Reference point representation diagram showing four network functions (MB-SMF, NEF, AF, MBSF) connected to a central PCF via specific reference points: N7mb, N30, N5, and Nmb12. + +Figure 4-2: Reference Model for the MBS PCF Services – Reference point representation + +# 5 Services offered by the PCF + +## 5.1 Introduction + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +Table 5.1-1: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|---------------------------------|--------|----------------------------------|---------------------------------------------------|-------------------------------|-------| +| Npcf_MBSPolicyControl | 5.2 | MBS Policy Control Service | TS29537_Npcf_MBS
SPolicyControl.yaml | npcf-
mbspolicycont
rol | A.2 | +| Npcf_MBSPolicyAuthoriz
ation | 5.3 | MBS Policy Authorization Service | TS29537_Npcf_MBS
SPolicyAuthorization
.yaml | npcf-
mbspolicyauth | A.3 | + +## 5.2 Npcf\_MBSPolicyControl Service + +### 5.2.1 Service Description + +The MBS Session Policy Control Service enables the Policy Control Function (PCF) to provision, update and remove MBS session related policies to NF service consumers (e.g. MB-SMF), i.e.: + +- enable an NF service consumer to request the creation, update and deletion of an MBS Policy Association for an MBS session; and +- enable the PCF to provision/update/remove MBS policies towards an NF service consumer. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +The service operations defined for the Npcf\_MBSPolicyControl Service are shown in table 5.2.2.1-1. + +**Table 5.2.2.1-1: Npcf\_MBSPolicyControl Operations** + +| Service Operation Name | Description | Initiated by | +|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------| +| Npcf_MBSPolicyControl_Create | Request the creation of an MBS Policy Association at the PCF in order to receive MBS policies for an MBS session. | NF service consumer (e.g. MB-SMF) | +| Npcf_MBSPolicyControl_Update | Request the update of an existing MBS Policy Association at the PCF in order to receive the updated MBS policies for an MBS session. | NF service consumer (e.g. MB-SMF) | +| Npcf_MBSPolicyControl_Delete | Request the deletion of an existing MBS Policy Association. | NF service consumer (e.g. MB-SMF) | + +#### 5.2.2.2 Npcf\_MBSPolicyControl\_Create + +##### 5.2.2.2.1 General + +The Npcf\_MBSPolicyControl\_Create service operation enables an NF service consumer (e.g. MB-SMF) to request the creation of an MBS Policy Association at the PCF and the provisioning of MBS policies for a multicast or a broadcast MBS session. + +The following procedures using the Npcf\_MBSPolicyControl\_Create service operation are supported: + +- MBS Policy Association Establishment. + +##### 5.2.2.2.2 MBS Policy Association Establishment + +![Sequence diagram showing the procedure for MBS Policy Association establishment between an NF service consumer and a PCF.](a7079ddb124df3f1ee13ae406c7c8982_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant PCF + Note left of NF service consumer: + NF service consumer->>PCF: 1. POST .../mbs-policies (MbsPolicyCtxtData) + Note right of PCF: + PCF-->>NF service consumer: 2. 201 Created (MbsPolicyData) + +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and a PCF. The first message, labeled '1. POST .../mbs-policies (MbsPolicyCtxtData)', is sent from the NF service consumer to the PCF. The second message, labeled '2. 201 Created (MbsPolicyData)', is sent from the PCF back to the NF service consumer. Vertical lines represent the lifelines of the two entities, and horizontal arrows represent the messages. + +Sequence diagram showing the procedure for MBS Policy Association establishment between an NF service consumer and a PCF. + +**Figure 5.2.2.2.2-1: Procedure for MBS Policy Association establishment** + +1. In order to request the creation of an MBS Policy Association, the NF service consumer (e.g. MB-SMF) shall send an HTTP POST request to the PCF targeting the URI of the "MBS Policies" collection resource, with the request body containing the MbsPolicyCtxData data structure that shall contain: + - the identifier of the concerned MBS Session, within the "mbsSessionId" attribute; + - the MBS Service Information, if available, within the "mbsServInfo" attribute; + - the list of supported features, if feature negotiation needs to take place, within the "suppFeat" attribute; and + - the Area Session Policy ID within the "areaSessPolId" attribute, if the "AreaSessPolicy" feature is supported and the request corresponds to an MBS Session that is an instance of a location-dependent MBS service.and may contain: + - the DNN of the MBS session, within the "dnn" attribute; and + - the S-NSSAI of the MBS session, within the "snssai" attribute. +2. Upon reception of the HTTP POST request from the NF service consumer: + - if MBS Service Information is present within the "mbsServInfo" attribute, the MBS session is an instance of a location-dependent MBS service, and if the "AreaSessPolicy" feature is supported, the Area Session Policy ID is present within the "areaSessPolId" attribute, and the PCF is not already serving this location-dependent MBS service (i.e., there is no MBS Policy Association at the PCF for the MBS Session ID provided within "mbsSessionId" attribute), or if the MBS Service Information is not present, the PCF may interact with the BSF by invoking the Nbsf\_Management\_Register service operation, as specified in clause 4.2.2.4 of 3GPP TS 29.521 [21], to check whether there is already a PCF serving the MBS Session, and if it is not the case, register itself as the PCF serving the MBS session; + +NOTE 1: Interacting with the BSF is not necessary in a deployment with a single PCF. + +- if MBS Service Information is present within the "mbsServInfo" attribute, then: + - the PCF may interact with the UDR to retrieve MBS Session policy control data for the MBS session, as specified in 3GPP TS 29.519 [20]; + +NOTE 2: Interacting with the UDR for MBS Session policy control data retrieval is not necessary in a deployment where MBS Policy Session policy control data is stored locally at the PCF. + +- the PCF shall then perform MBS policy authorization based on the received MBS Service Information, the operator policies that are pre-configured at the PCF and the MBS Session policy control data retrieved from the UDR, if any; +- if MBS policy authorization is successful, the PCF shall derive the required MBS policies (e.g. QoS parameters) and determine whether they are allowed or not; +- if the required MBS policies are allowed: + - the PCF shall store the generated MBS policies for the MBS session together with the corresponding MBS session ID, and if the "AreaSessPolicy" feature is supported and the MBS session is an instance of a location-dependent MBS service, the corresponding Area Session Policy ID; and +- if MBS policy authorization is not successful or the required MBS policies are not allowed, the PCF shall reject the request with an appropriate error response as specified below in this clause; +- otherwise, when MBS Service Information is not present within the "mbsServInfo" attribute and the PCF has previously derived the necessary MBS policies for the MBS session using the procedure defined in clause 5.3.2.2, the PCF shall provide these MBS policies in the response message returned to the NF service consumer (MB-SMF) as described below; +- upon success, the PCF shall: + - create a new "Individual MBS Policy" resource; and + +- respond to the NF service consumer with an HTTP "201 Created" status code including a Location header field containing the URI of the created "Individual MBS Policy" resource, and the response body including the MbsPolicyData data structure that shall contain: + - the received input parameters within the corresponding request body, within the "mbsPolicyCtxtData" attribute; + - the provisioned MBS Policy Decision containing the MBS policies derived by the PCF as defined above in this clause, within the "mbsPolicies" attribute; and + - the list of supported features, if feature negotiation is taking place, within the "suppFeat" attribute; +- if errors occur when processing the HTTP POST request, the PCF shall apply the error handling procedures specified in clause 6.1.7; + +NOTE 3: The PCF also deregisters at the BSF from being the PCF serving the MBS Session using the procedure defined in clause 4.2.3.4 of 3GPP TS 29.521 [21], if the PCF created such MBS Session binding as defined above in this clause. Interacting with the BSF to deregister from being the PCF serving the MBS Session is not necessary in a deployment with a single PCF. + +NOTE 4: For a location-dependent MBS service, the PCF deregisters at the BSF from being the PCF serving the MBS Session as indicated in NOTE 3 above only if it is the last MBS Policy Association associated to the location-dependent MBS service (i.e., associated to the corresponding MBS Session ID). + +- if MBS Service Information is provided but is invalid, incorrect or insufficient for the PCF to perform MBS policy authorization, the PCF shall reject the request with an HTTP "400 Bad Request" response message including the ProblemDetails data structure with the "cause" attribute set to "INVALID\_MBS\_SERVICE\_INFO"; +- if MBS Service Information is provided, but the MBS IP flow(s) description provided within the MBS Service Information cannot be handled by the PCF because the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [19] are not respected, the PCF shall reject the request with an HTTP "400 Bad Request" status code including the ProblemDetails data structure with the "cause" attribute set to "FILTER\_RESTRICTIONS\_NOT\_RESPECTED"; +- if from an application level point of view, the provided set of input parameters is incomplete, erroneous or missing necessary information for the PCF to perform MBS policy control, the PCF shall reject the request with an HTTP "400 Bad Request" response message including the ProblemDetails data structure with the "cause" attribute set to "ERROR\_INPUT\_PARAMETERS"; +- if MBS Service Information is provided but is not authorized, the PCF shall reject the request with an HTTP "403 Forbidden" status code including the MbsExtProblemDetails data structure that shall contain: + - the ProblemDetails data structure with the "cause" attribute set to "MBS\_SERVICE\_INFO\_NOT\_AUTHORIZED"; + +and may contain: + +- the AcceptableMbsServInfo data structure including the MBS Service Information that is acceptable for the PCF; + +and + +- if the PCF denies the creation of the "Individual MBS Policy" resource based on local configuration and/or operator policies, the PCF shall reject the request within an HTTP "403 Forbidden" status code including the "cause" attribute of the ProblemDetails data structure set to "MBS\_POLICY\_CONTEXT\_DENIED". At the reception of this error code and based on the internally configured failure actions, the NF service consumer may reject or allow, by applying local policies, the establishment of the corresponding MBS session. + +#### 5.2.2.3 Npcf\_MBSPolicyControl\_Update + +##### 5.2.2.3.1 General + +The Npcf\_MBSPolicyControl\_Update service operation enables the NF service consumer (e.g. MB-SMF) to request the update of an existing "Individual MBS Policy" resource for a multicast or a broadcast MBS session and/or report MBS Policy Decision installation and/or enforcement failure(s) to the PCF. + +The following procedures using the Npcf\_MBSPolicyControl\_Update service operation are supported: + +- MBS Policy Association Update. + +##### 5.2.2.3.2 MBS Policy Association Update + +![Sequence diagram showing the procedure for MBS Policy Association Update. The NF service consumer sends a POST request to the PCF, and the PCF responds with a 200 OK.](c036e2540a94b31357ceb0002f0cacab_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. POST .../mbs-policies/{mbsPolicyId}/update (MbsPolicyCtxtDataUpdate) + NF service consumer->>PCF: Request + Note left of PCF: 2. 200 OK (MbsPolicyData) + PCF-->>NF service consumer: Response + +``` + +Sequence diagram showing the procedure for MBS Policy Association Update. The NF service consumer sends a POST request to the PCF, and the PCF responds with a 200 OK. + +**Figure 5.2.2.3.2-1: Procedure for MBS Policy Association Update** + +1. In order to request the update of an existing MBS Policy Association, the NF service consumer shall invoke the "Update" resource custom operation by sending an HTTP POST request to the PCF targeting the URI of the corresponding "Individual MBS Policy" resource custom operation, i.e. "{apiRoot}/npcf-mbspolicycontrol//mbs-policies/{mbsPolicyId}/update", with the request body including the MbsPolicyCtxtDataUpdate data structure that may contain: + - the updated MBS Service Information, within the "mbsServInfo" attribute; + - the MBS Policy Control Request Triggers that are met, within the "mbsPerts" attribute, and/or + - the MBS Error reporting containing the MBS Policy Decision installation and/or enforcement failure(s), within the "mbsErrorReport" attribute. + +If the PCF determines that the received HTTP POST request needs to be redirected, the PCF shall respond with an HTTP redirect response, as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +2. Upon reception of the HTTP POST request from the NF service consumer: + - if the MBS Policy Control Request Trigger "MBS\_SESSION\_UPDATE" is triggered and updated MBS Service Information is present within the "mbsServInfo" attribute, then the PCF shall perform MBS policy authorization for the received updated MBS Service Information taking into account the operator policies pre-configured at the PCF and/or the MBS Session policy control data retrieved from the UDR. Then: + - if MBS policy authorization is successful, the PCF shall determine whether updated MBS policies (e.g. QoS parameters) need to be derived and provisioned. If it is the case, the PCF shall derive these required updated MBS policies (e.g. QoS parameters) and determine whether they are allowed or not; + - if updated MBS policies are derived and allowed, the PCF shall store the generated updated MBS policies for the MBS session together with the corresponding MBS session ID; and + - if MBS policy authorization is not successful or the required updated MBS policies, if any, are not allowed, the PCF shall reject the request with an appropriate error response as specified below in this clause; + - if the MBS Policy Control Request Trigger "MBS\_SESSION\_UPDATE" is triggered and no updated MBS Service Information is provided, then the PCF may identify whether there are any updated MBS policies that need to be applied as per the procedure defined in clause 5.3.2.3 and/or based on local configuration; + +NOTE: If updated MBS Service Information is not present in the received request, then the PCF has previously determined and generated the required updated MBS policies for the MBS session as specified in clause 5.3. + +- if MBS error reporting is present in the request and contains a set of MBS Policy Decision installation and/or enforcement failure(s), the PCF may take it into account when deriving the required updated MBS policies as specified in clause 5.2.4.1; +- upon success, the PCF shall: + - update the corresponding "Individual MBS Policy" resource accordingly; and + - respond to the NF service consumer with an HTTP "200 OK" status code with the response body including the MbsPolicyData data structure that shall contain: + - the updated complete list of input parameters, within the "mbsPolicyCtxtData" attribute;and may contain: + - the updated MBS Policy Decision containing the updated, deleted and/or newly provisioned MBS policies, within the "mbsPolicies" attribute; +- if errors occur when processing the HTTP POST request, the PCF shall apply the error handling procedures specified in clause 6.1.7; +- if updated MBS Service Information is provided but is invalid, incorrect or insufficient for the PCF to perform MBS policy authorization, the PCF shall reject the request with an HTTP "400 Bad Request" response message including the ProblemDetails data structure with the "cause" attribute set to "INVALID\_MBS\_SERVICE\_INFO"; +- if updated MBS Service Information is provided, but the MBS IP flow(s) description provided within the MBS Service Information cannot be handled by the PCF because the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [19] are not respected, the PCF shall reject the request with an HTTP "400 Bad Request" status code including the ProblemDetails data structure with the "cause" attribute set to "FILTER\_RESTRICTIONS\_NOT\_RESPECTED"; +- if from an application level point of view, the provided set of input parameters is incomplete, erroneous or missing necessary information for the PCF to perform MBS policy control, the PCF shall reject the request with an HTTP "400 Bad Request" response message including the ProblemDetails data structure with the "cause" attribute set to "ERROR\_INPUT\_PARAMETERS"; +- if updated MBS Service Information is provided but is not authorized, the PCF shall reject the request with an HTTP "403 Forbidden" status code including the MbsExtProblemDetails data structure that shall contain: + - the ProblemDetails data structure with the "cause" attribute set to "MBS\_SERVICE\_INFO\_NOT\_AUTHORIZED";and may contain: + - the AcceptableMbsServInfo data structure including the MBS Service Information that is acceptable for the PCF; +- if the PCF denies the update of the "Individual MBS Policy" resource based on local configuration and/or operator policies, the PCF shall reject the request within an HTTP "403 Forbidden" status code including the ProblemDetails data structure with the "cause" attribute set to "MBS\_POLICY\_CONTEXT\_DENIED". At the reception of this error code and based on the internally configured failure actions, the NF service consumer (MB-SMF) may reject or allow, by applying local policies, the update of the corresponding MBS session; and +- if the targeted "Individual MBS Policy" resource does not exist, the PCF shall reject the request with an HTTP "404 Not Found" status code including the ProblemDetails data structure with the "cause" attribute set to "MBS\_POLICY\_ASSOCIATION\_NOT\_FOUND". + +#### 5.2.2.4 Npcf\_MBSPolicyControl\_Delete + +##### 5.2.2.4.1 General + +The Npcf\_MBSPolicyControl\_Delete service operation enables the NF service consumer (e.g. MB-SMF) to request the deletion of an existing "Individual MBS Policy" resource. + +The following procedures using the Npcf\_MBSPolicyControl\_Delete service operation are supported: + +- MBS Policy Association Deletion. + +##### 5.2.2.4.2 MBS Policy Association Deletion + +![Sequence diagram showing the MBS Policy Association Deletion procedure. An NF service consumer sends a DELETE request to the PCF, and the PCF responds with a 204 No Content.](6f341f415ee0f8c724e5d6daeb1e9b4a_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note left of NF service consumer: + NF service consumer->>PCF: 1. DELETE .../mbs-policies/{mbsPolicyId} + Note right of PCF: + PCF-->>NF service consumer: 2. 204 No Content +``` + +Sequence diagram showing the MBS Policy Association Deletion procedure. An NF service consumer sends a DELETE request to the PCF, and the PCF responds with a 204 No Content. + +**Figure 5.2.2.4.2-1: MBS Policy Association Deletion procedure** + +1. In order to request the deletion of an existing MBS Policy Association, the NF service consumer shall send an HTTP DELETE request to the PCF, targeting the URI of the corresponding "Individual MBS Policy" resource. + +If the PCF determines that the received HTTP DELETE request needs to be redirected, the PCF shall respond with an HTTP redirect response, as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +2. On successful deletion of the targeted MBS Policy Association: + - the PCF may deregister at the BSF from being the PCF serving the MBS Session using the procedure defined in clause 4.2.3.4 of 3GPP TS 29.521 [21], if the PCF created such MBS Session binding during the creation of the MBS Policy Association, and for a location-dependent MBS service, this is the last MBS Policy Association associated to the location-dependent MBS service (i.e., associated to the corresponding MBS Session ID), as specified in clause 5.2.2.2; and + - the PCF shall respond to the NF service consumer (MB-SMF) with an HTTP "204 No Content" status code. + +If errors occur when processing the HTTP DELETE request, the PCF shall apply the error handling procedures specified in clause 6.1.7. + +If the targeted "Individual MBS Policy" resource does not exist, the PCF shall reject the request with an HTTP "404 Not Found" status code including the ProblemDetails data structure with the "cause" attribute set to "MBS\_POLICY\_ASSOCIATION\_NOT\_FOUND". + +### 5.2.3 MBS Policy Decision Management + +#### 5.2.3.1 General + +An MBS Policy Decision enables to provide the necessary MBS policies for controlling an MBS Session. An MBS Policy Decision is encoded via the MbsPolicyDecision data structure defined in clause 6.1.6.2.3 and composed of the following information: + +- MBS PCC rule(s), within the "mbsPccRules" attribute. +- MBS QoS decision(s), which can be referred by MBS PCC rules, within the "mbsQosDecs" attribute. + +- Set(s) of MBS QoS characteristics for non-standardized and non-preconfigured 5QIs, within the "mbsQosChars" attribute. +- The authorized MBS Session-AMBR, within the "authMbsSessAmbr" attribute. +- The MBS Policy Control Request Trigger(s), within the "mbsPerts" attribute. + +The following clauses describe the above components of an MBS Policy Decision. + +##### 5.2.3.1.1 MBS PCC Rule definition + +An MBS PCC rule enables to provide MBS policy control for an MBS service data flow. It is composed of the following information, as defined in table 5.2.3.1.1-1. + +- Information enabling the detection of the MBS service data flow. +- A set of MBS Policy Control parameters to be enforced for the MBS service data flow. + +**Table 5.2.3.1.1-1: Content of an MBS PCC rule** + +| Name | Description | Category | +|----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------| +| MBS PCC Rule identifier | Uniquely identifies the MBS PCC rule, within an MBS Session. It is used between the PCF and the MB-SMF for referencing the MBS PCC rules of an MBS Session. | Mandatory | +| MBS service data flow detection | | | +| Precedence | Determines the order in which the MBS service data flow template of the MBS PCC rule is applied relative to the MBS service data flow templates of the other MBS PCC rules of the MBS session, during MBS service data flow detection and policy enforcement. | Mandatory | +| MBS Service Data Flow Template | The list of MBS service data flow filter(s) for the detection of the MBS service data flow. | Mandatory | +| MBS policy control parameters | | | +| 5QI | Identifier of the authorized set of QoS parameters for the MBS service data flow. | Mandatory | +| ARP | The authorized Allocation and Retention Priority for the MBS service data flow, consisting of the priority level, the pre-emption capability and the pre-emption vulnerability. | Mandatory | +| MBR – Maximum BitRate (DL) | The downlink maximum bitrate authorized for the MBS service data flow. | Optional | +| GBR – Guaranteed BitRate (DL) | The downlink guaranteed bitrate authorized for the MBS service data flow. | Optional | +| Averaging Window | Represents the duration over which the guaranteed and maximum bitrates shall be calculated. | Optional | +| Priority Level | Indicates the level of priority in scheduling resources among MBS QoS flows. | Optional | +| Maximum Data Burst Volume | Denotes the largest amount of data that is required to be transferred within a period of 5G-AN PDB. | Optional | + +NOTE: If the user plane towards the MB-UPF uses a unicast tunnel, the MBS Service Data Flow Template relates to the inner IP layer within the unicast tunnel. + +An MBS PCC rule is encoded via the MbsPccRule data structure defined in clause 6.1.6.2.7 and is composed of the following information: + +- An MBS PCC rule identifier that uniquely identifies the MBS PCC rule within the related MBS Session, within the "mbsPccRuleId" attribute. +- The MBS service data flow template for MBS service data flow detection, within the "mbsDlIpFlowInfo" attribute. +- The precedence information, i.e. the order in which the MBS service data flow template of the MBS PCC rule is applied relative to the MBS service data flow templates of the other MBS PCC rules of the MBS session, during MBS service data flow detection and policy enforcement, within the "precedence" attribute. + +- The MBS authorized QoS to be applied for the MBS service data flow corresponding to the MBS PCC rule, i.e. a reference to an MBS QoS decision instance provisioned by the PCF at MBS Policy Decision level, within the "refMbsQosDec" attribute. + +The following operations are allowed on MBS PCC rule(s): + +- Installation, i.e. to provision MBS PCC rule(s). +- Modification, i.e. to modify MBS PCC rule(s). +- Removal, i.e. to remove MBS PCC rule(s). + +##### 5.2.3.1.2 MBS QoS Decision + +An MBS Policy Decision based on MBS QoS contains the QoS parameters to be applied for an MBS service data flow. It defines the QoS parameters (e.g. 5QI, ARP, maximum/guaranteed bitrates, etc.) to be applied for the corresponding MBS PCC rule. An MBS QoS decision is encoded via the MbsQosDec data structure defined in clause 6.1.6.2.8 and composed of the following information: + +- An identifier of the MBS QoS Decision that uniquely identifies the MBS QoS Decision within the related MBS Session, within the "mbsQosId" attribute. +- The 5QI information, i.e. an identifier of the set of QoS parameters to be applied to an MBS service data flow, within the "5qi" attribute; +- The 5QI Priority Level, within the "priorityLevel" attribute. +- The Allocation and Retention Priority information to be applied for an MBS service data flow, within the "arp" attribute. +- The Maximum Downlink Bit Rate for to be applied for an MBS service data flow, within the "mbrDI" attribute. +- The Guaranteed Downlink Bit Rate to be applied for an MBS service data flow, within the "gbrDI" attribute. +- The averaging window, i.e. the duration over which the guaranteed and maximum bitrates shall be calculated, within the "averWindow" attribute. +- The MBS Maximum Data Burst Volume to be applied for an MBS service data flow, within the "mbsMaxDataBurstVol" attribute. + +##### 5.2.3.1.3 MBS QoS Characteristics + +A set of MBS QoS Characteristics contains the QoS parameters for a non-standardized and non-preconfigured 5QI. It defines the QoS parameters (e.g. 5QI, ARP, maximum/guaranteed bitrates, etc.) to be applied for an MBS PCC rule and the corresponding MBS service data flow. A set of MBS QoS Characteristics is encoded via the MbsQosChars data structure defined in clause 6.1.6.2.9 and composed of the following information: + +- The 5QI information, i.e. an identifier of the set of non-standardized and non-preconfigured QoS parameters for an MBS service data flow, within the "5qi" attribute. It applies at MBS PCC rule level and MBS session level. +- The resource type (i.e. GBR, delay critical GBR or non-GBR), within the "resourceType" attribute. +- The 5QI priority level, within the "priorityLevel" attribute. +- The Packet Delay Budget, within the "packetDelayBudget" attribute. +- The Packet Error Rate, within the "packetErrorRate" attribute. +- The averaging window, within the "averWindow" attribute. +- The MBS Maximum Data Burst Volume, within the "mbsMaxDataBurstVol" attribute. + +##### 5.2.3.1.4 MBS Session-AMBR + +The MBS Session-AMBR contains the Aggregated Maximum Bit Rate to be applied for an MBS session. + +##### 5.2.3.1.5 MBS Policy Control Request Triggers + +The MBS Policy Control Request Triggers identify the conditions based on which the NF service consumer (MB-SMF) shall trigger the MBS Policy Association Update procedure defined in clause 5.2.2.3. They can be either pre-configured at the NF service consumer (MB-SMF), i.e. implicitly subscribed by default by the PCF, or explicitly provisioned by the PCF to the NF service consumer (MB-SMF) during the MBS Policy Association Creation/Update procedures defined in clause 5.2.2. + +The MBS Policy Control Request Triggers are encoded using the MbsPcrt Enumeration data type defined in clause 6.1.6.3.3. The possible values are the following: + +- "MBS\_SESSION\_UPDATE", i.e. MBS Session Update: the MBS policies may need to be updated due to updated MBS Session information. This MBS Policy Control Request Trigger is pre-configured at the NF service consumer (MB-SMF), i.e. implicitly subscribed by the PCF. + +#### 5.2.3.2 Provisioning and enforcement of MBS Policy Decisions + +##### 5.2.3.2.1 General + +MBS Policy Decisions are provided by the PCF to the NF service consumer (MB-SMF) as part of the following service operations: + +- the Npcf\_MBSPolicyControl\_Create service operation defined in clause 5.2.2.2; and +- the Npcf\_MBSPolicyControl\_Update service operation defined in clause 5.2.2.3. + +For the Npcf\_MBSPolicyControl\_Create service operation, the MbsPolicyDecision data structure shall contain the MBS Policy Decision containing a full description of all the MBS policies provisioned by the PCF for the MBS Policy Association. + +For the Npcf\_MBSPolicyControl\_Update service operation for, the MbsPolicyDecision data structure shall contain the updated MBS Policy Decision containing a full description of all the updated MBS policies (if any) provisioned for the MBS Policy Association. + +##### 5.2.3.2.2 Provisioning and enforcement of MBS PCC rules + +The PCF provisions/updates/removes MBS PCC rule(s) via the "mbsPccRules" attribute of the MbsPolicyDecision data structure as part of the provisioning/update/removal of an MBS Policy Decision (cf. clause 5.2.3.2.1). + +- For provisioning or modifying a dynamic PCF-provisioned MBS PCC rule, the corresponding MbsPccRule data structure shall be provided as a map entry value of the "mbsPccRules" attribute within the MbsPolicyDecision data structure representing the related MBS Policy Decision. The corresponding map key shall be set to the value of the "mbsPccRuleId" attribute of the MbsPccRule data structure. +- For removing a previously provisioned MBS PCC rule, the corresponding map entry value shall be set to "NULL" and map key to the value of the "mbsPccRuleId" attribute of the MbsPccRule data structure representing the targeted MBS PCC rule. + +##### 5.2.3.2.3 Provisioning and enforcement of authorized MBS QoS for an MBS service data flow + +The authorized MBS QoS for an MBS service data flow is provisioned along with the corresponding MBS PCC rule, as specified in the clause 5.2.3.2.2. + +The MBS authorized QoS per MBS service data flow shall be provisioned within the MbsQosDec data structure representing the MBS QoS Decision to be applied for the MBS service data flow. For this purpose: + +- the PCF shall include this MBS QoS Decision instance as a map entry within the "mbsQosDecs" attribute of the MbsPolicyDecision data structure of the corresponding MBS Policy Decision, as specified in clause 5.2.3.1.2, and include the reference to this MBS QoS Decision instance within the "refMbsQosDec" attribute of the MbsPccRule data structure representing the corresponding MBS PCC rule; + +- when the PCF provisions a standardized 5QI value, but the Priority Level, the Averaging Window and/or the Maximum Data Burst Volume shall be different from the standardized values defined in the table 5.7.4-1 of 3GPP TS 23.501 [2], the PCF shall include within the corresponding MbsQosDec data structure the required Priority Level within the "priorityLevel" attribute, the Averaging Window within the "averWindow" attribute and/or the MBS Maximum Data Burst Volume within the "mbsMaxDataBurstVol" attribute; +- if the PCF needs to provision dynamically assigned 5QI value(s) (from the non-standardized and non-preconfigured value range) and the associated set(s) of MBS QoS Characteristics, the PCF shall include within the MbsPolicyDecision data structure representing the related MBS Policy Decision the "mbsQosChars" map attribute containing one or more set(s) of MBS QoS Characteristics, with each one of them encoded using the MbsQosChar data structure as specified in clause 5.2.3.1.3. The PCF shall not update nor remove previously provisioned set(s) of MBS QoS Characteristics during the lifetime of the concerned MBS Policy Association; +- when the PCF provisions a dynamically assigned 5QI value (from the non-standardized and non-preconfigured value range) for the MBS PCC rule within the referred MBS QoS Decision instance, then the "5qi" attribute of the corresponding MbsQosDec data structure shall be set to the value of the dynamically assigned 5QI which points to the MBS QoS Characteristics instance containing the related QoS parameters; + +NOTE: Operator configuration is assumed to ensure that a dynamically assigned 5QI value is unique and references at a given time the same set of MBS QoS characteristics within the whole PLMN. + +Upon reception of an MBS PCC rule provisioning including the corresponding authorized MBS QoS information from the PCF, the NF service consumer (MB-SMF) shall perform MBS QoS flow binding as specified in clause 6.10 of 3GPP TS 23.247 [14]. The NF service consumer (MB-SMF) shall also reserve the necessary resources for the guaranteed bitrate of the MBS PCC rule, if provided. For GBR MBS QoS flows, the NF service consumer (MB-SMF) should set the MBS QoS flow's GBR to the sum of the GBR(s) of all the MBS PCC rule(s) that are active/installed and bound to that GBR MBS QoS flow, and the MBS QoS flow's MBR to the sum of the MBR(s) of all the MBS PCC rule(s) that are active/installed and bound to that GBR MBS QoS flow. + +The NF service consumer (MB-SMF) shall assign a new MBS QFI if a new MBS QoS flow needs to be established and derive the MBS QoS profile required towards the Access Network, if applicable, and the MBS QoS information with PDRs towards the MB-UPF. + +During an MBS session policy association update procedure that results in updating all the MBS PCC rule(s) bound to a certain MBS QoS flow, if all these MBS PCC rule(s) are updated with the same values of the QoS parameters (e.g. 5QI, ARP, Priority level, Averaging Window and Maximum Data Burst Volume), the NF service consumer (MB-SMF) should not perform a new MBS QoS flow binding and simply modify this MBS QoS flow with the updated QoS parameters. + +##### 5.2.3.2.4 Provisioning and enforcement of authorized MBS Session-AMBR + +The Provisioning of the authorized MBS Session-AMBR for an MBS session is part of the provisioning of the corresponding MBS Policy Decision, as specified in the clause 5.2.3.2.1. + +Upon reception of the authorized MBS Session-AMBR from the PCF, the NF service consumer (MB-SMF) shall trigger the necessary procedures towards the MB-UPF for the provisioning and enforcement of the MBS Session-AMBR for the concerned MBS session. + +NOTE: For an MBS session, the authorized MBS Session-AMBR is not propagated to neither the access network nor the UE. + +##### 5.2.3.2.5 Provisioning and enforcement of MBS Policy Control Request Triggers + +The PCF may provision one or more MBS Policy Control Request Triggers(s) to the NF service consumer (MB-SMF). In order to do so, the PCF shall include the "mbsPerts" attribute containing one or more MBS Policy Control Request Triggers(s) within the MbsPolicyDecision data structure. + +During the lifetime of the MBS Policy Association, the PCF may update and/or remove previously provisioned MBS Policy Control Request Triggers(s): + +- In order to update a previously subscribed set of MBS Policy Control Request Triggers(s), the PCF shall provide the complete list of the subscribed MBS Policy Control Request Triggers(s) within the "mbsPerts" attribute of the MbsPolicyDecision data structure. + +- In order to remove all the previously subscribed MBS Policy Control Request Triggers(s), the PCF shall provide the "mbsPerts" attribute set to the value "NULL" within the MbsPolicyDecision data structure. Upon reception of a "NULL" value within the "mbsPerts" attribute, the NF service consumer (MB-SMF) shall only trigger the MBS Policy Association Update procedure for the pre-configured MBS Policy Control Request Triggers(s), i.e. the ones implicitly subscribed by the PCF. + +MBS Policy Control Request Triggers(s) may also be pre-configured at the NF service consumer as specified in clause 5.2.3.1.5. In such case, the PCF is implicitly subscribed and does not need to explicitly subscribe to these MBS Policy Control Request Triggers(s) towards the NF service consumer (MB-SMF). A combination of pre-configured MBS Policy Control Request Triggers(s) and explicitly subscribed MBS Policy Control Request Triggers(s) may be present for an MBS Policy Association. + +### 5.2.4 MBS Policy Error Handling + +#### 5.2.4.1 MBS Policy Error Reporting + +Following an MBS Policy Association Creation or Update procedure, as defined in clause 5.2.2.2.2 or 5.2.2.3.2, the NF service consumer (MB-SMF) may report the potentially encountered failure(s) during the installation and/or enforcement of the provisioned MBS Policy Decision, both for MBS Policy Decision level failure(s) (e.g. MBS QoS Decision failure) and MBS PCC rule level failure(s) (e.g. the installation of one or more MBS PCC rule(s) fails or the PCF installed or modified one or more MBS PCC rules but resource allocation for these MBS PCC rule(s) was unsuccessful). + +In order to do so, the NF service consumer (MB-SMF) shall trigger the MBS Policy Association Update procedure defined in clause 5.2.2.3.2 and include within the "mbsErrorReport" attribute of the MbsPolicyCtxtDataUpdate data structure the necessary information on the failure(s) that occurred within one or more MBS Report instance(s), each one of them encoded using the MbsReport data structure that shall include: + +- the failure reason, if available, within the "failureCode" attribute; +- the affected MBS PCC rule(s), if the reported failure is at MBS PCC rule level, within the "mbsPccRuleIds" attribute; and +- the MBS PCC rule status, if the reported failure is at MBS PCC rule level, within the "mbsPccRuleStatus" attribute. + +Depending on the value of the "failureCode" attribute, the PCF may decide on the necessary updates to be applied to the MBS Policy Decision, if any, including whether to retain, re-install, modify or remove the existing MBS PCC rule(s), or any other action applies. + +For MBS PCC rule level failure(s), the following handling shall apply: + +- if the installation of one or more new MBS PCC rule(s) (i.e. MBS PCC rule(s) which were not successfully installed previously) fails, the NF service consumer (MB-SMF) shall set the "mbsPccRuleStatus" attribute to the value "INACTIVE"; +- if one or more MBS PCC rule(s) were successfully installed but can no longer be enforced by the NF service consumer (MB-SMF), the MB-SMF shall set the "mbsPccRuleStatus" attribute to "INACTIVE"; + +NOTE: When the PCF receives the "mbsPccRuleStatus" set to the value "INACTIVE", the PCF does not need to request the MB-SMF to remove the concerned MBS PCC rule(s) within the "mbsPccRuleIds" attribute. + +- if the requested modifications to currently active MBS PCC rule(s) fails, the NF service consumer (MB-SMF) shall: + - retain the targeted existing MBS PCC rule(s) active in their current version (i.e. without any modification), unless the failure reason also impacts the current version of these existing MBS PCC rule(s); and + - report the modification failure to the PCF; + +and + +- the removal of MBS PCC rule(s) shall not fail. The NF service consumer (MB-SMF) shall retain the MBS PCC rule(s) removal request and perform the related necessary actions/procedures in the network when it is possible. + +## 5.3 Npcf\_MBSPolicyAuthorization Service + +### 5.3.1 Service Description + +The MBS Policy Authorization Service enables the Policy Control Function (PCF) to authorize the MBS Service Information provided by an NF service consumer (e.g. AF, NEF, MBSF) and derive the related MBS policies, i.e.: + +- enable an NF service consumer (e.g. AF, NEF, MBSF) to request the creation, update or removal of an MBS Application Session Context, based on the provisioning of MBS Service Information; and +- enable the PCF to authorize the provided MBS Service Information and derive the MBS policies related to the targeted MBS session. + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +The service operations defined for the Npcf\_MBSPolicyAuthorization Service are shown in table 5.3.2.1-1. + +**Table 5.3.2.1-1: Npcf\_MBSPolicyAuthorization Service Operations** + +| Service Operation Name | Description | Initiated by | +|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| Npcf_MBSPolicyAuthorization_Create | Request the creation of an MBS Application Session Context at the PCF, to enable MBS policy authorization for the provided MBS Service Information. | NF service consumer (e.g. NEF, MBSF, AF) | +| Npcf_MBSPolicyAuthorization_Update | Update an existing MBS Application Session Context at the PCF, to enable MBS policy authorization for the provided updated MBS Service Information. | NF service consumer (e.g. NEF, MBSF, AF) | +| Npcf_MBSPolicyAuthorization_Delete | Delete an existing MBS Application Session Context at the PCF. | NF service consumer (e.g. NEF, MBSF, AF) | + +#### 5.3.2.2 Npcf\_MBSPolicyAuthorization\_Create + +##### 5.3.2.2.1 General + +The Npcf\_MBSPolicyAuthorization\_Create service operation enables an NF service consumer (e.g. AF, NEF, MBSF) to request the creation of an MBS Application Session Context at the PCF, for the purpose of requesting MBS policy authorization for a multicast or a broadcast MBS session. + +The following procedures using the Npcf\_MBSPolicyAuthorization\_Create service operation are supported: + +- MBS Application Session Context Establishment. + +##### 5.3.2.2.2 MBS Application Session Context Establishment + +![Sequence diagram showing the MBS Application Session Context establishment procedure between an NF service consumer and a PCF.](3f36a9a4e71c8afdba94d0eb5b2ebab8_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant PCF as PCF + Note left of NF: + NF->>PCF: 1. POST .../contexts (MbsAppSessionCtxt) + Note right of PCF: + PCF-->>NF: 2. 201 Created (MbsAppSessionCtxt) + +``` + +The diagram illustrates a two-step interaction between an NF service consumer and a PCF. In the first step, the NF service consumer sends a POST request to the PCF with the path .../contexts and the payload (MbsAppSessionCtxt). In the second step, the PCF responds with a 201 Created status and the payload (MbsAppSessionCtxt). + +Sequence diagram showing the MBS Application Session Context establishment procedure between an NF service consumer and a PCF. + +**Figure 5.3.2.2.2-1: MBS Application Session Context establishment procedure** + +1. In order to request the creation of a new MBS Application Session Context, the NF service consumer (e.g. AF, NEF, MBSF) shall send an HTTP POST request to the PCF, targeting the URI of the "MBS Application Session Contexts" collection resource, with the request body containing the MbsAppSessionCtxt data structure that shall contain: + - the MBS session identifier, within the "mbsSessionId" attribute; + - the MBS Service Information, if available, within the "mbsServInfo" attribute; and + - the list of supported features, if feature negotiation needs to take place, within the "suppFeat" attribute;and may contain: + - the DNN of the MBS session, within the "dnn" attribute; + - the S-NSSAI of the MBS session, within the "snssai" attribute; and + - the "request for location-dependent MBS session" indication within the "reqForLocDepMbs" attribute, if the "AreaSessPolicy" feature is supported and the request corresponds to an MBS Session that is an instance of a location-dependent MBS service. + +2. Upon reception of the HTTP POST request from the NF service consumer: + +- the PCF may interact with the UDR to retrieve MBS Session policy control data for the MBS session, as specified in clause 5.2.16 of 3GPP TS 29.519 [20]; + +NOTE 1: Interacting with the UDR for MBS Session policy control data retrieval is not necessary in a deployment where MBS Policy Session policy control data is stored locally at the PCF. + +- the PCF shall perform MBS policy authorization based on the MBS Service Information received from the NF service consumer and the operator policies that are pre-configured at the PCF and/or the MBS Session policy control data retrieved from the UDR. Then: + - if MBS policy authorization is successful, the PCF shall derive the required MBS policies (e.g. QoS parameters) and determine whether they are allowed or not; + - if the required MBS policies are allowed: + - if the "AreaSessPolicy" feature is supported and the "request for location dependent MBS session" indication was present within the "reqForLocDepMbs" attribute and set to "true", the PCF shall assign an Area Session Policy ID within the "areaSessPolId" attribute for this MBS Session as an instance of a location-dependent MBS service; + - the PCF shall store the generated MBS policies for the MBS session together with the corresponding MBS session ID, and if applicable and the "AreaSessPolicy" feature is supported, the corresponding Area Session Policy ID for an MBS Session that is an instance of a location-dependent MBS service; + - the PCF shall create a new "Individual MBS Application Session Context" resource and respond to the NF service consumer with an HTTP "201 Created" status code, including an HTTP Location header field containing the URI of the created "Individual MBS Application Session Context" resource and the response body containing a representation of the created resource within the MbsAppSessionCtxt data structure; and + - the PCF may register itself at the BSF as the PCF handling the MBS session as specified in clause 4.2.2.4 of 3GPP TS 29.521 [21]; + +NOTE 2: Registering at the BSF as the PCF serving the MBS Session is not necessary in a deployment with a single PCF. + +- otherwise, when MBS policy authorization is not successful or the required MBS policies are not allowed, the PCF shall reject the request with an appropriate error response as specified below in this clause; +- if errors occur when processing the HTTP POST request, the PCF shall apply the error handling procedures specified in clause 6.2.7; + +- if the provided MBS Service Information is invalid, incorrect or insufficient for the PCF to perform MBS policy authorization, the PCF shall reject the request with an HTTP "400 Bad Request" status code including the ProblemDetails data structure with the "cause" attribute set to "INVALID\_MBS\_SERVICE\_INFO"; +- if the MBS IP flow(s) description provided within the MBS Service Information cannot be handled by the PCF because the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [19] are not respected, the PCF shall reject the request with an HTTP "400 Bad Request" status code including the ProblemDetails data structure with the "cause" attribute set to "FILTER\_RESTRICTIONS\_NOT\_RESPECTED"; and +- if the provided MBS Service Information are not authorized, the PCF shall reject the request with an HTTP "403 Forbidden" status code including the MbsExtProblemDetails data structure that shall contain: + - the ProblemDetails data structure with the "cause" attribute set to "MBS\_SERVICE\_INFO\_NOT\_AUTHORIZED"; + and may contain: + - the AcceptableMbsServInfo data structure including the MBS Service Information that is acceptable for the PCF. + +#### 5.3.2.3 Npcf\_MBSPolicyAuthorization\_Update + +##### 5.3.2.3.1 General + +The Npcf\_MBSPolicyAuthorization\_Update service operation enables an NF service consumer (e.g. AF, NEF, MBSF) to request the update of an existing MBS Application Session Context, for the purpose of requesting the authorization of updated MBS Service Information. + +The following procedures using the Npcf\_MBSPolicyAuthorization\_Update service operation are supported: + +- MBS Application Session Context Update. + +##### 5.3.2.3.2 MBS Application Session Context Update + +![Sequence diagram showing the MBS Application Session Context update procedure. An NF service consumer sends a PATCH request to the PCF, and the PCF responds with a 200 OK or 204 No Content.](d3b5eac55166fc428a223bba5c46961b_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant PCF + Note left of NF service consumer: Request update of MBS Application Session Context + NF service consumer->>PCF: 1. PATCH .../contexts/{contextId} (MbsAppSessionCtxtPatch) + Note right of PCF: Process request + PCF-->>NF service consumer: 2. 200 OK (MbsAppSessionCtxt) / 204 No Content + +``` + +Sequence diagram showing the MBS Application Session Context update procedure. An NF service consumer sends a PATCH request to the PCF, and the PCF responds with a 200 OK or 204 No Content. + +**Figure 5.3.2.3.2-1: MBS Application Session Context update procedure** + +1. In order to request the modification of an existing MBS Application Session Context, the NF service consumer (e.g. AF, NEF, MBSF) shall send an HTTP PATCH request to the PCF, targeting the URI of the corresponding "Individual MBS Application Session Context" resource, with the request body containing the MbsAppSessionCtxtPatch data structure that may contain: + - the requested modifications to the MBS Service Information, within the "mbsServInfo" attribute. +2. Upon reception of the HTTP PATCH request from the NF service consumer: + - the PCF may interact with the UDR to retrieve MBS Session policy control data for the MBS session, as specified in 3GPP TS 29.519 [20]; + - the PCF shall perform MBS policy authorization based on the requested modifications to the MBS Service Information received from the NF service consumer and the operator policies that are pre-configured at the PCF and/or the MBS session policy control data retrieved from the UDR. Then: + +- if MBS policy authorization of the requested modifications to the MBS Service Information is successful, the PCF shall derive the required updated MBS policies (e.g. QoS parameters), if any, and determine whether they are allowed or not; +- if the required updated MBS policies are allowed: + - the PCF shall store the generated updated MBS policies for the MBS session, if any, together with the corresponding MBS session ID; + - the PCF shall update the associated "Individual MBS Application Session Context" resource accordingly and respond to the NF service consumer with either an HTTP "200 OK" status code with the response body containing a representation of the updated resource within the MbsAppSessionCtxt data structure, or an HTTP "204 No Content" status code; and + - if the authorized MBS policies have been changed, the PCF shall include the "contactPcfInd" attribute set to "true" within the returned MbsAppSessionCtxt data structure to indicate that the PCF shall be contacted, i.e. to indicate to the NF service consumer (MB-SMF) that it needs to trigger the MBS Policy Association Update procedure, as defined in clause 5.2.2.3, to receive updated MBS policies from the PCF; +- otherwise, when MBS policy authorization is not successful or the required updated MBS policies are not allowed, the PCF shall reject the request with an appropriate error response as specified below in this clause; +- if errors occur when processing the HTTP PATCH request, the PCF shall apply the error handling procedures specified in clause 6.2.7; +- if the targeted "Individual MBS Application Session Context" resource does not exist, the PCF shall reject the request with an HTTP "404 Not Found" status code including the ProblemDetails data structure with the "cause" attribute set to "MBS\_SESSION\_POL\_AUTH\_CTXT\_NOT\_FOUND"; +- if the provided MBS Service Information is invalid, incorrect or insufficient for the PCF to perform MBS policy authorization, the PCF shall reject the request with an HTTP "400 Bad Request" status code including the ProblemDetails data structure with the "cause" attribute set to "INVALID\_MBS\_SERVICE\_INFO"; +- if the MBS IP flow(s) description provided within the MBS Service Information cannot be handled by the PCF because the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [19] are not respected, the PCF shall reject the request with an HTTP "400 Bad Request" status code including the ProblemDetails data structure with the "cause" attribute set to "FILTER\_RESTRICTIONS\_NOT\_RESPECTED"; and +- if the provided MBS Service Information is not authorized, the PCF shall reject the request with an HTTP "403 Forbidden" status code including the MbsExtProblemDetails data structure that shall contain: + - the ProblemDetails data structure with the "cause" attribute set to "MBS\_SERVICE\_INFO\_NOT\_AUTHORIZED";and may contain: + - the AcceptableMbsServInfo data structure including the MBS Service Information that is acceptable for the PCF. + +#### 5.3.2.4 Npcf\_MBSPolicyAuthorization\_Delete + +##### 5.3.2.4.1 General + +The Npcf\_MBSPolicyAuthorization\_Delete service operation enables an NF service consumer (e.g. AF, NEF, MBSF) to request the deletion of an existing MBS Application Session Context at the PCF. + +The following procedures using the Npcf\_MBSPolicyAuthorization\_Delete service operation are supported: + +- MBS Application Session Context Deletion. + +##### 5.3.2.4.2 MBS Application Session Context Deletion + +![Sequence diagram showing the MBS Application Session Context deletion procedure between an NF service consumer and a PCF.](58f4167687de8d7339594e5f6fbe0bc6_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note left of NF service consumer: + NF service consumer->>PCF: 1. DELETE .../contexts/{contextId} + Note right of PCF: + PCF-->>NF service consumer: 2. 204 No Content +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and a PCF. The NF service consumer sends a DELETE request to the PCF, and the PCF responds with a 204 No Content status code. + +Sequence diagram showing the MBS Application Session Context deletion procedure between an NF service consumer and a PCF. + +**Figure 5.3.2.4.2-1: MBS Application Session Context deletion procedure** + +1. In order to request the deletion of an existing MBS Application Session Context, the NF service consumer (e.g. AF, NEF, MBSF) shall send an HTTP DELETE request to the PCF targeting the URI of the corresponding "Individual MBS Application Session Context" resource. +2. Upon success, the PCF shall respond with an HTTP "204 No Content" status code. + +If errors occur when processing the HTTP DELETE request, the PCF shall apply the error handling procedures specified in clause 6.2.7. + +If the targeted Individual MBS Application Session Context does not exist, the PCF shall reject the request with an HTTP "404 Not Found" status code including the ProblemDetails data structure with the "cause" attribute set to "MBS\_SESSION\_POL\_AUTH\_CTXT\_NOT\_FOUND". + +# 6 API Definitions + +## 6.1 Npcf\_MBSPolicyControl Service API + +### 6.1.1 Introduction + +The Npcf\_MBSPolicyControl Service shall use the Npcf\_MBSPolicyControl API. + +The API URI of the Npcf\_MBSPolicyControl Service shall be: + +**{apiRoot}/** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "npcf-mbspolicycontrol". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Npcf\_MBSPolicyControl API is contained in Annex A.2. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +The "Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9754 [13]. + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +This clause describes the structure for the resource URIs and the resources and methods used for the Npcf\_MBSPolicyControl service. + +Figure 6.1.3.1-1 depicts the resource URIs structure for the Npcf\_MBSPolicyControl API. + +![A hierarchical diagram showing the resource URI structure. The root is {apiRoot}/npcf-mbspolicycontrol/. A line descends from the root to a box containing /mbs-policies. From this box, a line descends to another box containing /{mbsPolicyId}. From this second box, a line descends to a dashed box containing /update.](805c475f0859e607af0530ba43194bf1_img.jpg) + +{apiRoot}/npcf-mbspolicycontrol/ + +``` + +graph TD + Root["{apiRoot}/npcf-mbspolicycontrol/"] --> Policies["/mbs-policies"] + Policies --> PolicyId["/{mbsPolicyId}"] + PolicyId --> Update["/update"] + style Update stroke-dasharray: 5 5 + +``` + +A hierarchical diagram showing the resource URI structure. The root is {apiRoot}/npcf-mbspolicycontrol/. A line descends from the root to a box containing /mbs-policies. From this box, a line descends to another box containing /{mbsPolicyId}. From this second box, a line descends to a dashed box containing /update. + +**Figure 6.1.3.1-1: Resource URI structure of the Npcf\_MBSPolicyControl API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource purpose/name | Resource URI (relative path after API URI) | HTTP method or custom operation | Description (service operation) | +|-----------------------|--------------------------------------------|---------------------------------|----------------------------------------------------------------------| +| MBS Policies | /mbs-policies | POST | Request the creation of a new Individual MBS Policy resource. | +| Individual MBS Policy | /mbs-policies/{mbsPolicyId} | GET | Request the retrieval of an existing Individual MBS Policy resource. | +| | | DELETE | Request the deletion of an existing Individual MBS Policy resource. | +| | | Update (POST) | Request the update of an existing Individual MBS Policy resource. | + +#### 6.1.3.2 Resource: MBS Policies + +##### 6.1.3.2.1 Description + +This resource represents the collection of "Individual MBS Policy" resources managed by the PCF. + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/npcf-mbspolicycontrol//mbs-policies + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|-------------------| +| apiRoot | string | See clause 6.1.1. | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 POST + +This method enables an NF service consumer (e.g. MB-SMF) to request the creation of an MBS Policy Association at the PCF. + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|-------------------------------------------------------------------------------| +| MbsPolicyCtxtData | M | 1 | Contains the parameters to request the creation of an MBS Policy Association. | + +**Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|-----------------------------------------------------------------------------| +| MbsPolicyData | M | 1 | 201 Created | Successful case. An Individual MBS Policy resource is successfully created. | +| n/a | | | 308 Permanent Redirect | Permanent Redirection. Another PCF already serves the MBS Session. | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| MbsExtProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: Failure cases are described in clause 6.1.7. + +**Table 6.1.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/npcf-mbspolicycontrol//mbs-policies/{mbsPolicyId} | + +**Table 6.1.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI (i.e. "apiRoot") of the PCF currently handling the MBS Session and towards which the request is redirected. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Contains the identifier of the PCF (service) instance towards which the request is redirected. | + +##### 6.1.3.2.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +#### 6.1.3.3 Resource: Individual MBS Policy + +##### 6.1.3.3.1 Description + +This resource represents an "Individual MBS Policy" resource managed by the PCF. + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/npcf-mbspolicycontrol//mbs-policies/{mbsPolicyId} + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-----------|---------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1. | +| mbsPolicyId | string | Represents the unique identifier of the "Individual MBS Policy" resource. | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 GET + +This method enables an NF service consumer (e.g. MB-SMF) to retrieve an existing "Individual MBS Policy" resource at the PCF. + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.1.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------| +| MbsPolicyData | M | 1 | 200 OK | Successful case. The requested Individual MBS Policy resource is successfully returned in the response body. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +**Table 6.1.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +###### 6.1.3.3.3.2 DELETE + +This method enables an NF service consumer (e.g. MB-SMF) to request the deletion of an existing "Individual MBS Policy" resource at the PCF. + +This method shall support the URI query parameters specified in table 6.1.3.3.3.2-1. + +**Table 6.1.3.3.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.3.3.2-3. + +Table 6.1.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +Table 6.1.3.3.3.2-3: Data structures supported by the DELETE Response Body on this resource + +| Data type | P | Cardinality | Response Codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful response. The Individual MBS Policy resource was successfully deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 3) | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: Failure cases are described in clause 6.1.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +Table 6.1.3.3.3.2-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +Table 6.1.3.3.3.2-5: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +##### 6.1.3.3.4 Resource Custom Operations + +###### 6.1.3.3.4.1 Overview + +Table 6.1.3.3.4.1-1: Custom operations + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|------------------------------------|--------------------|-----------------------------------------------------------| +| Update | /mbs-policies/{mbsPolicyId}/update | Update (POST) | Request the update of an existing MBS Policy Association. | + +###### 6.1.3.3.4.2 Operation: Update + +###### 6.1.3.3.4.2.1 Description + +This resource custom operation enables an NF service consumer (e.g. MB-SMF) to request the update of an existing MBS Policy Association at the PCF. + +###### 6.1.3.3.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.3.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.3.4.2.2-2. + +**Table 6.1.3.3.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|--------------------------------------------------------------------------------------| +| MbsPolicyCtxtDataUpdate | M | 1 | Contains the parameters to request the update of the Individual MBS Policy resource. | + +**Table 6.1.3.3.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------| +| MbsPolicyData | M | 1 | 200 OK | Successful case. The targeted Individual MBS Policy resource is successfully updated. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 3) | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| MbsExtProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: Failure cases are described in clause 6.1.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.3.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +**Table 6.1.3.3.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +### 6.1.4 Custom Operations without associated resources + +There are no custom operations without associated resources defined for this API in this release of the specification. + +### 6.1.5 Notifications + +There are no notifications defined for this API in this release of the specification. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Npcf\_MBSPolicyControl service based interface protocol. + +**Table 6.1.6.1-1: Npcf\_MBSPolicyControl specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-------------------------|----------------|--------------------------------------------------------------------------------------------------------------------------|---------------| +| MbsErrorReport | 6.1.6.2.10 | Contains the reporting of MBS Policy decision level failure(s) and/or MBS PCC rule level failure(s). | | +| MbsFailureCode | 6.1.6.3.4 | Represents the reason behind the MBS Policy Decision(s) enforcement failure or the MBS PCC rule(s) installation failure. | | +| MbsMaxDataBurstVol | 6.1.6.3.2 | Represents the maximum MBS data burst volume. | | +| MbsPccRule | 6.1.6.2.7 | Represents the parameters constituting an MBS PCC rule. | | +| MbsPprt | 6.1.6.3.3 | Represents an MBS Policy Control Request Trigger. | | +| MbsPolicyCtxtData | 6.1.6.2.2 | Contains the parameters used to request the creation of an Individual MBS Policy resource. | | +| MbsPolicyCtxtDataUpdate | 6.1.6.2.11 | Contains the parameters to update an existing MBS Policy Association. | | +| MbsPolicyData | 6.1.6.2.4 | Contains the MBS policy data of an Individual MBS Policy resource. | | +| MbsPolicyDecision | 6.1.6.2.3 | Contains the parameters constituting an MBS Policy Decision. | | +| MbsPccRuleStatus | 6.1.6.3.5 | Represents the status of an MBS PCC rule. | | +| MbsQosChar | 6.1.6.2.9 | Represents the parameters constituting a set of explicitly signalled QoS Characteristics. | | +| MbsQosDec | 6.1.6.2.8 | Represents the parameters constituting an MBS QoS Decision. | | +| MbsReport | 6.1.6.2.12 | Includes the information about the MBS Policy Decision level failure(s) and/or the MBS PCC rule level failure(s). | | + +Table 6.1.6.1-2 specifies data types re-used by the Npcf\_MBSPolicyControl service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Npcf\_MBSPolicyControl service based interface. + +Table 6.1.6.1-2: Npcf\_MBSPolicyControl re-used Data Types + +| Data type | Reference | Comments | Applicability | +|----------------------|---------------------|----------------------------------------------------------------------------------------------------------------|----------------| +| 5Qi | 3GPP TS 29.571 [15] | Indicates the 5G QoS Identifier. | | +| 5QiPriorityLevel | 3GPP TS 29.571 [15] | Indicates the 5Qi Priority Level. | | +| AreaSessionPolicyId | 3GPP TS 29.571 [15] | Indicates the Area Session Policy Identifier. | AreaSessPolicy | +| Arp | 3GPP TS 29.571 [15] | Indicates the allocation and retention priority. | | +| AverWindow | 3GPP TS 29.571 [15] | Indicates the Averaging Window. | | +| BitRate | 3GPP TS 29.571 [15] | Indicates the Bit Rate. | | +| Dnn | 3GPP TS 29.571 [15] | Identifies a DNN. | | +| FlowDescription | 3GPP TS 29.512 [18] | Represents packet filtering information for an IP flow. | | +| MbsExtProblemDetails | Clause 6.2.6.4.1 | Identifies the MBS related extensions to the ProblemDetails data structure. | | +| MbsServiceInfo | 3GPP TS 29.571 [15] | Represents MBS Service Information. | | +| MbsSessionId | 3GPP TS 29.571 [15] | Represents an MBS Session Identifier. | | +| PacketDelBudget | 3GPP TS 29.571 [15] | Indicates the Packet Delay Budget. | | +| PacketErrRate | 3GPP TS 29.571 [15] | Indicates the Packet Error Rate. | | +| ProblemDetails | 3GPP TS 29.571 [15] | Contains error related additional information. | | +| QosResourceType | 3GPP TS 29.571 [15] | Indicates the QoS resource type. | | +| RedirectResponse | 3GPP TS 29.571 [15] | Contains redirection related information. | | +| Snssai | 3GPP TS 29.571 [15] | Identifies an S-NSSAI. | | +| SupportedFeatures | 3GPP TS 29.571 [15] | Represents the list of supported features. It is used to negotiate the applicability of the optional features. | | +| Uinteger | 3GPP TS 29.571 [15] | Represents an unsigned integer. | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: MbsPolicyCtxtData + +Table 6.1.6.2.2-1: Definition of type MbsPolicyCtxtData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| mbsSessionId | MbsSessionId | M | 1 | Represents the identifier of the MBS Session. | | +| dnn | Dnn | O | 0..1 | Represents the DNN of the MBS session. | | +| snssai | Snssai | O | 0..1 | Represents the S-NSSAI of the MBS session. | | +| areaSessPolId | AreaSessionPolicyId | C | 0..1 | Represents the Area Session Policy ID.
This attribute shall be present if available. | AreaSessPolicy | +| mbsServInfo | MbsServiceInfo | O | 0..1 | Represents the MBS Service Information.
This attribute shall be provided, if available. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of the supported features among the ones defined in clause 6.1.8.
This attribute shall be present when feature negotiation needs to take place. | | + +##### 6.1.6.2.3 Type: MbsPolicyDecision + +Table 6.1.6.2.3-1: Definition of type MbsPolicyDecision + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbsPccRules | map(MbsPccRule) | O | 1..N | A map of MBS PCC rule(s) with the content being the MbsPccRule as described in clause 6.1.6.2.7. The key used in this map for each entry is the "mbsPccRuleId" attribute of the corresponding MbsPccRule instance. | | +| mbsQosDecs | map(MbsQosDec) | O | 1..N | Map of MBS QoS Decision(s). The key used in this map for each entry is the "mbsQosId" attribute of the corresponding MbsQosDec instance.
(NOTE) | | +| mbsQosChars | map(MbsQosChar) | O | 1..N | Map of QoS characteristics for non-standard 5QIs and non-preconfigured 5QIs. The key of the map is the 5QI value within the "5qi" attribute of the corresponding MbsQosChar instance.
(NOTE) | | +| authMbsSessAmbr | BitRate | O | 0..1 | The Authorized MBS Session-AMBR. | | +| mbsPorts | array(MbsPort) | O | 1..N | The MBS Policy Control Request Triggers(s) that the PCF requests to subscribe to. | | + +NOTE: This attribute shall not be removed if it was provisioned. + +##### 6.1.6.2.4 Type: MbsPolicyData + +Table 6.1.6.2.4-1: Definition of type MbsPolicyData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbsPolicyCtxtData | MbsPolicyCtxtData | M | 1 | Contains the parameters used to request MBS Policy Association creation/update. | | +| mbsPolicies | MbsPolicyDecision | C | 0..1 | Contains the provisioned MBS Policy Decision containing the MBS policies authorized by the PCF.

This attribute shall be present in the response to a request to create an MBS Policy Association or a request to retrieve the properties of an existing MBS Policy Association, and may be present in the response to a request to update an existing MBS Policy Association. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of negotiated supported features.

This parameter shall be provided by the PCF in the response to a request in which the NF service consumer provided the list of features that it supports. | | + +6.1.6.2.5 Void + +6.1.6.2.6 Void + +6.1.6.2.7 Type: MbsPccRule + +Table 6.1.6.2.7-1: Definition of type MbsPccRule + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbsPccRuleId | string | M | 1 | Univocally identifies the MBS PCC rule within the related MBS session. | | +| mbsDlIpFlowInfo | array(FlowDescription) | C | 1..N | Contains the MBS downlink IP flow packet filter(s) information.
(NOTE 3) | | +| precedence | UInteger | O | 0..1 | Determines the order in which this MBS PCC rule is applied relative to other MBS PCC rules within the same MBS session.
(NOTE 1) | | +| refMbsQosDec | array(string) | C | 1..N | A reference to the MbsQosDec policy decision type. It contains the value of the "mbsQosId" attribute of the referred MbsQosDec policy decision defined in clause 6.1.6.2.8.
(NOTE 2, NOTE 3) | | + +NOTE 1: The "precedence" attribute is used to specify the precedence of the MBS PCC rule among all MBS PCC rules associated to an MBS session. It includes an integer value in the range of 0 to 255 (decimal). The higher the value of the "precedence" attribute, the lower the precedence of the MBS PCC rule to which it applies. + +NOTE 2: Arrays are only introduced for future compatibility. In this release of the specification, the maximum number of elements in the array is 1. + +NOTE 3: This attribute shall be present in the response to an MBS Policy Association Creation request and may be present in the response to an MBS Policy Association Update request. + +##### 6.1.6.2.8 Type: MbsQosDec + +Table 6.1.6.2.8-1: Definition of type MbsQosDec + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------|---------------| +| mbsQosId | string | M | 1 | Univocally identifies the MBS QoS Decision within the related MBS session. | | +| 5qi | 5Qi | O | 0..1 | Contains the identifier of the authorized QoS parameters for the MBS service data flow.
(NOTE 2) | | +| priorityLevel | 5QiPriorityLevel | O | 0..1 | Indicates a priority in scheduling resources among MBS QoS flows.
(NOTE 1) | | +| mbrDI | BitRate | O | 0..1 | Indicates the maximum bandwidth in downlink. | | +| gbrDI | BitRate | O | 0..1 | Indicates the guaranteed bandwidth in downlink. | | +| arp | Arp | O | 0..1 | Indicates the allocation and retention priority. | | +| averWindow | AverWindow | O | 0..1 | Represents the duration over which the guaranteed and maximum bitrates shall be calculated.
(NOTE 1) | | +| mbsMaxDataBurstVol | MbsMaxDataBurstVol | O | 0..1 | Denotes the largest amount of data that is required to be transferred within a period.
(NOTE 1) | | + +NOTE 1: This attribute is applicable only when a value different from the standardized 5QI values, defined in table 5.7.4-1 3GPP TS 23.501 [2], is provided. + +NOTE 2: When the provided 5QI value is a dynamically assigned 5QI (i.e. from the non-standardized and non-preconfigured value range), the corresponding QoS parameters (e.g. Packet Delay Budget, Packet Error Rate, etc.) are provided in the corresponding MbsQosChar data structure. + +##### 6.1.6.2.9 Type: MbsQosChar + +Table 6.1.6.2.9-1: Definition of type MbsQosChar + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| 5qi | 5Qi | M | 1 | Represents the identifier of the set of non-standardized and non-preconfigured MBS QoS parameters for an MBS service data flow. | | +| resourceType | QosResourceType | M | 1 | Indicates whether the MBS QoS resource type is GBR, delay critical GBR or non-GBR. | | +| priorityLevel | 5QiPriorityLevel | M | 1 | Indicates the 5QI Priority Level within a range of 1 to 127 and encoded as an unsigned integer. | | +| packetDelayBudget | PacketDelBudget | M | 1 | Indicates the packet delay budget expressed in milliseconds and encoded as an unsigned integer. | | +| packetErrorRate | PacketErrRate | M | 1 | Indicates the packet error rate encoded as a string.
Examples:
- A Packer Error Rate of $4 \times 10^{-6}$ shall be encoded as "4E-6".
- A Packer Error Rate of $10^{-2}$ shall be encoded as "1E-2". | | +| averWindow | AverWindow | C | 0..1 | Indicates the averaging window.

This attribute shall be present only for a GBR QoS flow or a Delay Critical GBR QoS flow. | | +| mbsMaxDataBurstVol | MbsMaxDataBurstVol | M | 1 | Indicates the maximum data burst volume, encoded as an unsigned integer. | | + +##### 6.1.6.2.10 Type: MbsErrorReport + +Table 6.1.6.2.11-1: Definition of type MbsErrorReport + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|------------------------------------------------------------------------------------------------------|---------------| +| mbsReports | array(MbsReport) | O | 1..N | Contains the reporting of MBS Policy decision level failure(s) and/or MBS PCC rule level failure(s). | | + +##### 6.1.6.2.11 Type: MbsPolicyCtxtDataUpdate + +Table 6.1.6.2.11-1: Definition of type MbsPolicyCtxtDataUpdate + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|------------------------------------------------------------------------------------------------------|---------------| +| mbsServInfo | MbsServiceInfo | O | 0..1 | Represents the updated MBS Service Information. | | +| mbsPorts | array(MbsPort) | O | 1..N | Represents the list of MBS Policy Control Request Triggers that are met. | | +| mbsErrorReport | MbsErrorReport | O | 0..1 | Contains the reporting of MBS Policy decision level failure(s) and/or MBS PCC rule level failure(s). | | + +##### 6.1.6.2.12 Type: MbsReport + +Table 6.1.6.2.12-1: Definition of type MbsReport + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbsPccRuleIds | array(string) | C | 1..N | Contains the identifier(s) of the affected MBS PCC rule(s).

This attribute shall be present if the reported failure is related to the MBS PCC rule(s) installation.

(NOTE) | | +| mbsPccRuleStatus | MbsPccRuleStatus | C | 0..1 | Indicates the status of the MBS PCC rule(s) identified by the "mbsPccRuleIds" attribute.

This attribute shall be present only if the "mbsPccRuleIds" attribute is present. | | +| failureCode | MbsFailureCode | C | 0..1 | Indicates the reason of the failure of the MBS Policy Decision or the MBS PCC rule(s) identified by the "mbsPccRuleIds" attribute.

This attribute shall be present when available.

(NOTE) | | + +NOTE: If the reported failure is due to MBS Policy Decision failure, then the "mbsPccRuleIds" attribute shall not be present and the "failureCode" attribute indicates the appropriate failure cause illustrating the MBS Policy Decision failure that occurred. + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +Table 6.1.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|--------------------|-----------------|-------------------------------------------------------------------------------------------------|---------------| +| MbsMaxDataBurstVol | Integer | Represents MBS Maximum Data Burst Volume expressed in Bytes.
Minimum = 1. Maximum = 2000000. | | + +##### 6.1.6.3.3 Enumeration: MbsPrt + +The enumeration MbsPrt represents the MBS Policy Control Request Triggers. It shall comply with the provisions defined in table 6.1.6.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration MbsPprt** + +| Enumeration value | Description | Applicability | +|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| MBS_SESSION_UPDATE | Indicates the MBS Session Update policy control request trigger.

This MBS Policy Control Request Trigger is implicitly subscribed by the PCF, i.e. pre-configured at the NF service consumer (MB-SMF). | | + +##### 6.1.6.3.4 Enumeration: MbsFailureCode + +The enumeration MbsFailureCode represents the reason behind the MBS Policy Decision failure. It shall comply with the provisions of table 6.1.6.3.4-1. + +**Table 6.1.6.3.4-1: Enumeration MbsFailureCode** + +| Enumeration value | Description | Applicability | +|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| NF_MALFUNCTION | Indicates that the MBS PCC rule could not be successfully installed due to MB-SMF/MB-UPF malfunction. | | +| NF_RESOURCES_UNAVAILABLE | Indicates that the MBS PCC rule could not be successfully installed due to resources unavailable at the MB-SMF/MB-UPF. | | +| RESOURCE_ALLOCATION_FAILURE | Indicates that the MBS PCC rule could not be successfully installed or maintained since the associated MBS QoS flow establishment/modification failed or the associated MBS QoS flow was released. | | +| MBS_QOS_VALIDATION_FAILURE | Indicate that MBS QoS validation has failed. | | +| NO_MBS_QOS_FLOW | Indicates that there is no MBS QoS flow to which the MB-SMF can bind the MBS PCC rule(s). | | +| MBS_QOS_DECISION_ERROR | Indicates failure in the provisioning of MBS QoS Decision data. | | +| MBS_POLICY_PARAM_ERROR | Indicates that the information related to the provisioned MBS policy parameter(s) is incorrect, incomplete or inconsistent. | | + +##### 6.1.6.3.5 Enumeration: MbsPccRuleStatus + +The enumeration MbsPccRuleStatus represents the status of an MBS PCC rule. It shall comply with the provisions of table 6.1.6.3.5-1. + +**Table 6.1.6.3.5-1: Enumeration MbsPccRuleStatus** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------------------------------|---------------| +| ACTIVE | Indicates that the MBS PCC rule(s) are successfully installed. | | +| INACTIVE | Indicates that the MBS PCC rule(s) are removed. | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +There are no data types describing alternative data types or combinations of data types defined for this API in this release of the specification. + +#### 6.1.6.5 Binary data + +##### 6.1.6.5.1 Binary Data Types + +**Table 6.1.6.5.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|------|----------------|--------------| +| | | | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Npcf\_MBSPolicyControl API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Npcf\_MBSPolicyControl API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Npcf\_MBSPolicyControl service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Npcf\_MBSPolicyControl service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| INVALID_MBS_SERVICE_INFO | 400 Bad Request | The HTTP request is rejected because the provided MBS Service Information is invalid (e.g. invalid QoS reference), incorrect or insufficient for the PCF to perform MBS policy authorization. | +| FILTER_RESTRICTIONS_NOT_RESPECTED | 400 Bad Request | The HTTP request is rejected because the MBS IP flow(s) description provided within the MBS Service Information cannot be handled due to the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [19] not being respected. | +| ERROR_INPUT_PARAMETERS | 400 Bad Request | The HTTP request is rejected because the provided set of input parameters are incomplete, erroneous or missing necessary information for the PCF to perform MBS policy control. | +| MBS_SERVICE_INFO_NOT_AUTHORIZED | 403 Forbidden | The HTTP request is rejected because the provided MBS Service Information is not authorized by the PCF. | +| MBS_POLICY_CONTEXT_DENIED | 403 Forbidden | The HTTP request is rejected because the PCF does not accept the NF service consumer request due to operator policies and/or local configuration. | +| MBS_POLICY_ASSOCIATION_NOT_FOUND | 404 Not Found | The HTTP request is rejected because the targeted MBS Policy Association does not exist at the PCF. | + +### 6.1.8 Feature negotiation + +The optional features listed in table 6.1.8-1 are defined for the Npcf\_MBSPolicyControl API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | AreaSessPolicy |

This feature indicates the support of the Area Session Policy ID related handling for location-dependent MBS services.

The following functionalities are supported:

  • - Support the provisioning of the Area Session Policy ID to the PCF for MBS Sessions that are instances of a location-dependent MBS service.
| + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Npcf\_MBSPolicyControl API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Npcf\_MBSPolicyControl API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Npcf\_MBSPolicyControl service. + +The Npcf\_MBSPolicyControl API defines a single scope "npcf-mbspolicycontrol" for the entire service, and it does not define any additional scopes at resource or operation level. + +## 6.2 Npcf\_MBSPolicyAuthorization Service API + +### 6.2.1 Introduction + +The Npcf\_MBSPolicyAuthorization Service shall use the Npcf\_MBSPolicyAuthorization API. + +The API URI of the Npcf\_MBSPolicyAuthorization Service shall be: + +**{apiRoot}//** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "npcf-mbspolicyauth". +- The shall be "v1". +- The shall be set as described in clause 6.2.3. + +### 6.2.2 Usage of HTTP + +#### 6.2.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Npcf\_MBSPolicyAuthorization API is contained in Annex A.2. + +#### 6.2.2.2 HTTP standard headers + +##### 6.2.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.2.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +JSON object used in the HTTP PATCH request shall be encoded according to "JSON Merge Patch" and shall be signalled by the content type "application/merge-patch+json", as defined in IETF RFC 7396 [22]. + +The "Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9754 [13]. + +#### 6.2.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +### 6.2.3 Resources + +#### 6.2.3.1 Overview + +This clause describes the structure of the resource URIs and the resources and methods used for the Npcf\_MBSPolicyAuthorization service. + +Figure 6.2.3.1-1 depicts the resource URIs structure for the Npcf\_MBSPolicyAuthorization API. + +![Diagram showing the resource URI structure. A line from the root URI branches down to a box containing '/contexts'. From this box, another line branches down to a box containing '{contextId}'.](ff5f89b660edddb67971d7d3d4ce87ef_img.jpg) + +{apiRoot}/npcf-mbspolicyauth/ + +``` + +graph TD + Root["{apiRoot}/npcf-mbspolicyauth/"] --> Contexts["/contexts"] + Contexts --> ContextId["/{contextId}"] + +``` + +Diagram showing the resource URI structure. A line from the root URI branches down to a box containing '/contexts'. From this box, another line branches down to a box containing '{contextId}'. + +**Figure 6.2.3.1-1: Resource URI structure of the Npcf\_MBSPolicyAuthorization API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource purpose/name | Resource URI (relative path after API URI) | HTTP method or custom operation | Description (service operation) | +|--------------------------------------------|--------------------------------------------|---------------------------------|---------------------------------------------------------------------------| +| MBS Application Session Contexts | /contexts | POST | Create a new MBS Application Session Context. | +| Individual MBS Application Session Context | /contexts/{contextId} | GET | Retrieve an existing Individual MBS Application Session Context resource. | +| | | PATCH | Modify an existing Individual MBS Application Session Context resource. | +| | | DELETE | Delete an existing Individual MBS Application Session Context resource. | + +#### 6.2.3.2 Resource: MBS Application Session Contexts + +##### 6.2.3.2.1 Description + +This resource represents the collection of "Individual MBS Application Session Context" resources managed by the PCF. + +##### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/npcf-mbspolicyauth//contexts + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|-------------------| +| apiRoot | string | See clause 6.2.1. | + +##### 6.2.3.2.3 Resource Standard Methods + +###### 6.2.3.2.3.1 POST + +This method enables an NF service consumer (e.g. NEF, MBSF, AF) to request the creation of an MBS Application Session Context at the PCF. + +This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.2.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3. + +**Table 6.2.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------| +| MbsAppSessionCtxt | M | 1 | Contains the parameters to create an Individual MBS Application Session Context for MBS policy authorization. | + +**Table 6.2.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MbsAppSessionCtxt | M | 1 | 201 Created | Successful case. An Individual MBS Application Session Context resource is successfully created and a representation of the created resource is returned in the response body.

A Location header field containing the URI of the created resource is also included. | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| MbsExtProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the HTTP POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: Failure cases are described in clause 6.2.7. + +**Table 6.2.3.2.3.1-4: Headers supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/npcf-mbspolicyauth//contexts/{contextId} | + +##### 6.2.3.2.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +#### 6.2.3.3 Resource: Individual MBS Application Session Context + +##### 6.2.3.3.1 Description + +This resource represents an "Individual MBS Application Session Context" resource managed by the PCF. + +##### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/npcf-mbspolicyauth//contexts/{contextId} + +This resource shall support the resource URI variables defined in table 6.2.3.3.2-1. + +**Table 6.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------|-----------|------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1. | +| contextId | string | Represents the unique identifier of the "Individual MBS Application Session Context" resource. | + +##### 6.2.3.3.3 Resource Standard Methods + +###### 6.2.3.3.3.1 GET + +This method enables an NF service consumer (e.g. NEF, MBSF, AF) to retrieve an existing "Individual MBS Application Session Context" resource at the PCF. + +This method shall support the URI query parameters specified in table 6.2.3.3.3.1-1. + +**Table 6.2.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3. + +**Table 6.2.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------| +| MbsAppSessionCtxt | M | 1 | 200 OK | Successful case. The requested Individual MBS Application Session Context resource is successfully returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the HTTP GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.2.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +**Table 6.2.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +###### 6.2.3.3.3.2 PATCH + +This method enables an NF service consumer (e.g. NEF, MBSF, AF) to request the modification of an existing "Individual MBS Application Session Context" resource at the PCF. + +This method shall support the URI query parameters specified in table 6.2.3.3.3.2-1. + +**Table 6.2.3.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.2-2 and the response data structures and response codes specified in table 6.2.3.3.3.2-3. + +**Table 6.2.3.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------| +| MbsAppSessionCtxtPatch | M | 1 | Contains the parameters to request the modification of an existing Individual MBS Application Session Context resource. | + +**Table 6.2.3.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MbsAppSessionCtxt | M | 1 | 200 OK | Successful case. The corresponding Individual MBS Application Session Context resource is successfully modified and a representation of the updated resource is returned in the response body. | +| n/a | | | 204 No Content | Successful case. The corresponding Individual MBS Application Session Context resource is successfully modified and no content is returned in the response body. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 3) | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| MbsExtProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the HTTP PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: Failure cases are described in clause 6.2.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.2.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +**Table 6.2.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +###### 6.2.3.3.3.3 DELETE + +This method enables an NF service consumer (e.g. NEF, MBSF, AF) to request the deletion of an existing "Individual MBS Application Session Context" resource at the PCF. + +This method shall support the URI query parameters specified in table 6.2.3.3.3.3-1. + +**Table 6.2.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.3-2 and the response data structures and response codes specified in table 6.2.3.3.3.3-3. + +**Table 6.2.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The corresponding Individual MBS Application Session Context resource is successfully deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 3) | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the HTTP DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: Failure cases are described in clause 6.2.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.2.3.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +**Table 6.2.3.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +##### 6.2.3.3.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +### 6.2.4 Custom Operations without associated resources + +There are no custom operations without associated resources defined for this API in this release of the specification. + +### 6.2.5 Notifications + +There are no notifications defined for this API in this release of the specification. + +### 6.2.6 Data Model + +#### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Npcf\_MBSPolicyAuthorization service based interface protocol. + +**Table 6.2.6.1-1: Npcf\_MBSPolicyAuthorization specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|------------------------|----------------|------------------------------------------------------------------------------|---------------| +| AcceptableMbsServInfo | 6.2.6.2.4 | Contains the MBS Service Information that can be accepted by the PCF. | | +| MbsExtProblemDetails | 6.2.6.4.1 | Identifies the MBS related extensions to the ProblemDetails data structure. | | +| MbsAppSessionCtxt | 6.2.6.2.2 | Represents the parameters of an MBS Application Session Context. | | +| MbsAppSessionCtxtPatch | 6.2.6.2.3 | Represents the modifications to an existing MBS Application Session Context. | | + +Table 6.2.6.1-2 specifies data types re-used by the Npcf\_MBSPolicyAuthorization service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Npcf\_MBSPolicyAuthorization service based interface. + +**Table 6.2.6.1-2: Npcf\_MBSPolicyAuthorization re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|---------------------|---------------------|----------------------------------------------------------------------------------------------------------------|----------------| +| AreaSessionPolicyId | 3GPP TS 29.571 [15] | Indicates the Area Session Policy Identifier. | AreaSessPolicy | +| BitRate | 3GPP TS 29.571 [15] | Represents a bit rate. | | +| Dnn | 3GPP TS 29.571 [15] | Identifies a DNN. | | +| MbsMediaComp | 3GPP TS 29.571 [15] | Represents an MBS Media Component. | | +| MbsServiceInfo | 3GPP TS 29.571 [15] | Represents MBS Service Information. | | +| MbsSessionId | 3GPP TS 29.571 [15] | Represents an MBS Session Identifier. | | +| ProblemDetails | 3GPP TS 29.571 [15] | Contains error related additional information. | | +| RedirectResponse | 3GPP TS 29.571 [15] | Contains redirection related information. | | +| Snssai | 3GPP TS 29.571 [15] | Identifies an S-NSSAI. | | +| SupportedFeatures | 3GPP TS 29.571 [15] | Represents the list of supported features. It is used to negotiate the applicability of the optional features. | | + +#### 6.2.6.2 Structured data types + +##### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.2.6.2.2 Type: MbsAppSessionCtxt + +Table 6.2.6.2.2-1: Definition of type MbsAppSessionCtxt + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| mbsSessionId | MbsSessionId | M | 1 | Represents the identifier of the corresponding MBS Session. | | +| mbsServInfo | MbsServiceInfo | C | 0..1 | Represents the MBS Service Information.

This attribute shall be provided, if available. | | +| dnn | Dnn | O | 0..1 | Represents the DNN of the MBS session. | | +| snssai | Snssai | O | 0..1 | Represents the S-NSSAI of the MBS session. | | +| areaSessPolld | AreaSessionPolicyId | C | 0..1 | Contains the Area Session Policy ID.

This attribute may be present only in the response to an MBS Application Session Context creation request.

This attribute shall be present if the "reqForLocDepMbs" attribute was present and set to "true" in the corresponding request. | AreaSessPolicy | +| reqForLocDepMbs | boolean | O | 0..1 | Indicates whether the request corresponds to a location-dependent MBS service, i.e.:
- "true" means that the request corresponds to a location-dependent MBS service.
- "false" means that the request does not correspond to a location-dependent MBS service.
- When this attribute is not present, the default value is "false".

This attribute may be present only in a request to create an MBS Application Session Context. It shall not be present otherwise. | AreaSessPolicy | +| contactPcfInd | boolean | O | 0..1 | Indicates whether the PCF shall be contacted or not, i.e.:
- "true" means that the PCF shall be contacted.
- "false" means that the PCF shall not be contacted.
- When this attribute is not present, the default value is "false".

This attribute may be present only in the response to an MBS Application Session Context update request. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of the supported features (among the ones defined in clause 6.2.8).

This parameter shall be provided if feature negotiation needs to take place. | | + +##### 6.2.6.2.3 Type: MbsAppSessionCtxtPatch + +Table 6.2.6.2.3-1: Definition of type MbsAppSessionCtxtPatch + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|-------------------------------------------------|---------------| +| mbsServInfo | MbsServiceInfo | O | 0..1 | Represents the updated MBS Service Information. | | + +##### 6.2.6.2.4 Type: AcceptableMbsServInfo + +Table 6.2.6.2.4-1: Definition of type AcceptableMbsServInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| accMbsServInfo | map(MbsMediaComp) | C | 1..N | Contains the maximum acceptable bandwidth per media component that can be accepted and authorized by the PCF.

Each map entry encoded using the MbsMediaComp data structure shall only include the "mbsMedCompNum" attribute and the "maxReqMbsBwDI" attribute indicating the maximum acceptable bandwidth.

The key of the map is the "medCompN" attribute of the corresponding MbsMediaComp data structure provided as a map entry.

(NOTE) | | +| accMaxMbsBw | BitRate | C | 0..1 | Contains the maximum acceptable bandwidth.

(NOTE) | | + +NOTE: When the acceptable MBS bandwidth is per MBS media component, only the "accMbsServInfo" attribute shall be present. When the acceptable MBS bandwidth applies to all the MBS media components, only the "accMaxMbsBw" attribute shall be present. + +#### 6.2.6.3 Simple data types and enumerations + +##### 6.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +Table 6.2.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +#### 6.2.6.4 Data types describing alternative data types or combinations of data types + +##### 6.2.6.4.1 Type: MbsExtProblemDetails + +**Table 6.2.6.4.1-1: Definition of type MbsExtProblemDetails as a list of to be combined data types** + +| Data type | Cardinality | Description | Applicability | +|-----------------------|-------------|-------------------------------------------------------------------------------------|---------------| +| ProblemDetails | 1 | Contains the details of the encountered problem, as defined in 3GPP TS 29.571 [15]. | | +| AcceptableMbsServInfo | 0..1 | Contains the MBS Service Information that can be accepted by the PCF. | | + +#### 6.2.6.5 Binary data + +##### 6.2.6.5.1 Binary Data Types + +**Table 6.2.6.5.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|------|----------------|--------------| +| | | | + +### 6.2.7 Error Handling + +#### 6.2.7.1 General + +For the Npcf\_MBSPolicyAuthorization API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Npcf\_MBSPolicyAuthorization API. + +#### 6.2.7.2 Protocol Errors + +No specific procedures for the Npcf\_MBSPolicyAuthorization service are specified. + +#### 6.2.7.3 Application Errors + +The application errors defined for the Npcf\_MBSPolicyAuthorization service are listed in table 6.2.7.3-1. + +Table 6.2.7.3-1: Application errors + +| Application Error | HTTP status code | Description | +|-------------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| INVALID_MBS_SERVICE_INFO | 400 Bad Request | The HTTP request is rejected because the provided MBS Service Information is invalid (e.g. invalid QoS reference), incorrect or insufficient for the PCF to perform MBS policy authorization. | +| FILTER_RESTRICTIONS_NOT_RESPECTED | 400 Bad Request | The HTTP request is rejected because the MBS IP flow(s) description provided within the MBS Service Information cannot be handled due to the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [19] not being respected. | +| MBS_SERVICE_INFO_NOT_AUTHORIZED | 403 Forbidden | The HTTP request is rejected because the provided MBS Service Information is not authorized by the PCF. | +| MBS_SESSION_POL_AUTH_CTXT_NOT_FOUND | 404 Not Found | The HTTP request is rejected because the targeted Individual MBS Application Session Context does not exist at the PCF. | + +### 6.2.8 Feature negotiation + +The optional features listed in table 6.2.8-1 are defined for the Npcf\_MBSPolicyAuthorization API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +Table 6.2.8-1: Supported Features + +| Feature number | Feature Name | Description | +|----------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | AreaSessPolicy |

This feature indicates the support of the Area Session Policy ID related handling for location-dependent MBS services.

The following functionalities are supported:

  • - Support the provisioning of the "request for location dependent MBS session" indication to the PCF for MBS Sessions that are instances of a location-dependent MBS service.
  • - Support that the PCF assigns and returns to the NF service consumer an Area Session Policy ID for an MBS Session that is an instance of a location-dependent MBS service.
| + +### 6.2.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Npcf\_MBSPolicyAuthorization API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Npcf\_MBSPolicyAuthorization API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Npcf\_MBSPolicyAuthorization service. + +The Npcf\_MBSPolicyAuthorization API defines a single scope "npcf-mbspolicyauth" for the entire service, and it does not define any additional scopes at resource or operation level. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5.3.1 of 3GPP TS 29.501 [5] and clause 5B of 3GPP TR 21.900 [7]). + +## A.2 Npcf\_MBSPolicyControl API + +``` +openapi: 3.0.0 + +info: + title: Npcf_MBSPolicyControl API + version: 1.1.0-alpha.3 + description: | + MBS Policy Control Service + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.537 V18.3.0; 5G System; Multicast/Broadcast Policy Control Services. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.537/' + +security: + - {} + - oAuth2ClientCredentials: + - npcf-mbspolicycontrol + +servers: + - url: '{apiRoot}/npcf-mbspolicycontrol/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +paths: + /mbs-policies: + post: + summary: Request the creation of a new MBS Policy Association. + operationId: CreateMBSPolicy + tags: + - MBS Policies (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MbsPolicyCtxtData' + responses: + '201': + description: > + Created. An Individual MBS Policy resource is successfully created. + content: + application/json: + schema: + $ref: '#/components/schemas/MbsPolicyData' + headers: + Location: + description: > + Contains the URI of the newly created Individual MBS Policy resource. + required: true + schema: + type: string + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden. + content: + application/problem+json: + schema: + $ref: 'TS29537_Npcf_MBSPolicyAuthorization.yaml#/components/schemas/MbsExtProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': +$ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': +$ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': +$ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': +$ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': +$ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: +$ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/mbs-policies/{mbsPolicyId}: + parameters: + - name: mbsPolicyId + in: path + description: > + Contains the identifier of the concerned Individual MBS Policy resource. + required: true + schema: + type: string + + get: + summary: Read an Individual MBS Policy resource. + operationId: GetIndMBSPolicy + tags: + - Individual MBS Policy (Document) + responses: + '200': + description: > + OK. The requested Individual MBS Policy resource is successfully returned. + content: + application/json: + schema: + $ref: '#/components/schemas/MbsPolicyData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + delete: + summary: Deletes an existing Individual MBS Policy resource. + operationId: DeleteIndMBSPolicy + tags: + - Individual MBS Policy (Document) + parameters: + - name: mbsPolicyId + in: path + description: > + Contains the identifier of the concerned Individual MBS Policy resource. + required: true + schema: + type: string + responses: + '204': + description: > +``` + +``` + No Content. The concerned Individual MBS Policy resource is successfully deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/mbs-policies/{mbsPolicyId}/update: + post: + summary: Request the update of an existing MBS Policy Association. + operationId: UpdateIndMBSPolicy + tags: + - Individual MBS Policy (Document) + parameters: + - name: mbsPolicyId + in: path + description: > + Contains the identifier of the concerned Individual MBS Policy resource. + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MbsPolicyCtxtDataUpdate' + responses: + '200': + description: > + OK. The targeted Individual MBS Policy resource is successfully updated. + content: + application/json: + schema: + $ref: '#/components/schemas/MbsPolicyData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden. + content: + application/problem+json: + schema: + $ref: 'TS29537_Npcf_MBSPolicyAuthorization.yaml#/components/schemas/MbsExtProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + npcfc-mbspolicycontrol: Access to the Npcf_MBSPolicyControl API + +schemas: + MbsPolicyCtxtData: + description: > + Contains the parameters used to request the creation of an MBS Policy + Association. + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + areaSessPolId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaSessionPolicyId' + mbsServInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceInfo' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - mbsSessionId + + MbsPolicyDecision: + description: > + Represents the parameters constituting an MBS Policy Decision. + type: object + properties: + mbsPccRules: + type: object + additionalProperties: + $ref: '#/components/schemas/MbsPccRule' + minProperties: 1 + description: > + A map of MBS PCC rule(s) with each map entry containing the MbsPccRule data structure. + The key of the map for each entry is the mbsPccRuleId attribute of the corresponding + MbsPccRule data structure. + nullable: true + mbsQosDecs: + type: object + additionalProperties: + $ref: '#/components/schemas/MbsQosDec' + minProperties: 1 + description: > + A map of MBS QoS Decision(s) with each map entry containing the MbsQosDec data structure. + The key of the map for each entry is the mbsQosId attribute of the corresponding + MbsQosDec data structure. + mbsQosChars: + type: object + additionalProperties: + $ref: '#/components/schemas/MbsQosChar' + minProperties: 1 + description: > + A map of MBS QoS Characteristics set(s) with each map entry containing the MbsQosChar data + structure. The key of the map for each entry is the 5QI attribute of the corresponding + MbsQosDec data structure. + authMbsSessAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + mbsPerts: +``` + +``` + type: array + items: + $ref: '#/components/schemas/MbsPprt' + minItems: 1 + nullable: true + +MbsPolicyData: + description: > + Contains the MBS policy data provisioned as part of an MBS Policy Association. + type: object + properties: + mbsPolicyCtxtData: + $ref: '#/components/schemas/MbsPolicyCtxtData' + mbsPolicies: + $ref: '#/components/schemas/MbsPolicyDecision' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - mbsPolicyCtxtData + +MbsPccRule: + description: Represents the parameters constituting an MBS PCC rule. + type: object + properties: + mbsPccRuleId: + type: string + mbsDlIpFlowInfo: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowDescription' + minItems: 1 + precedence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + refMbsQosDec: + type: array + items: + type: string + minItems: 1 + maxItems: 1 + required: + - mbsPccRuleId + +MbsQosDec: + description: Represents the parameters constituting an MBS QoS Decision. + type: object + properties: + mbsQosId: + type: string + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + priorityLevel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5QiPriorityLevel' + mbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + gbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + arp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + averWindow: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindow' + mbsMaxDataBurstVol: + $ref: '#/components/schemas/MbsMaxDataBurstVol' + required: + - mbsQosId + +MbsQosChar: + description: > + Represents the parameters constituting a set of explicitly signalled QoS characteristics. + type: object + properties: + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + priorityLevel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5QiPriorityLevel' + resourceType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/QosResourceType' + packetDelayBudget: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' +``` + +``` + packetErrorRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' + averWindow: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindow' + mbsMaxDataBurstVol: + $ref: '#/components/schemas/MbsMaxDataBurstVol' + required: + - 5qi + - resourceType + - priorityLevel + - packetDelayBudget + - packetErrorRate + - mbsMaxDataBurstVol + +MbsPolicyCtxtDataUpdate: + description: > + Contains the parameters to request the modification of an existing MBS Policy Association. + type: object + properties: + mbsServInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceInfo' + mbsPcrts: + type: array + items: + $ref: '#/components/schemas/MbsPcrT' + minItems: 1 + mbsErrorReport: + $ref: '#/components/schemas/MbsErrorReport' + +MbsErrorReport: + description: > + Represents the reporting of MBS Policy decision level failure(s) and/or MBS PCC rule level + failure(s). + type: object + properties: + mbsReports: + type: array + items: + $ref: '#/components/schemas/MbsReport' + minItems: 1 + +MbsReport: + description: > + Contains information about the MBS Policy Decision level failure(s) and/or the MBS PCC + rule level failure(s). + type: object + properties: + mbsPccRuleIds: + type: array + items: + type: string + minItems: 1 + mbsPccRuleStatus: + $ref: '#/components/schemas/MbsPccRuleStatus' + failureCode: + $ref: '#/components/schemas/MbsFailureCode' + +# Simple data types: + +MbsMaxDataBurstVol: + description: Represents the MBS Maximum Data Burst Volume expressed in Bytes. + type: integer + minimum: 1 + maximum: 2000000 + +# ENUMS: + +MbsPcrT: + anyOf: + - type: string + enum: + - MBS_SESSION_UPDATE + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + description: | + Represents the MBS Policy Control Request Trigger. +``` + +Possible values are: +- MBS\_SESSION\_UPDATE: Indicates the MBS Session Update policy control request trigger. + +### MbsPccRuleStatus: + +##### anyOf: + +- type: string + +#### enum: + +- ACTIVE +- INACTIVE + +- type: string + +##### description: > + +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +#### description: | + +Represents the MBS PCC rule status. + +Possible values are: + +- ACTIVE: Indicates that the MBS PCC rule(s) are successfully installed. +- INACTIVE: Indicates that the MBS PCC rule(s) are removed. + +### MbsFailureCode: + +#### anyOf: + +- type: string + +#### enum: + +- NF\_MALFUNCTION +- NF\_RESOURCES\_UNAVAILABLE +- RESOURCE\_ALLOCATION\_FAILURE +- MBS\_QOS\_VALIDATION\_FAILURE +- NO\_MBS\_QOS\_FLOW +- MBS\_QOS\_DECISION\_ERROR +- MBS\_POLICY\_PARAM\_ERROR + +- type: string + +##### description: > + +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +##### description: | + +Represents the reason for the MBS Policy Decision(s) enforcement failure or the MBS PCC rule(s) installation failure. + +Possible values are: + +- NF\_MALFUNCTION: Indicates that the MBS PCC rule could not be successfully installed due to MB-SMF/MB-UPF malfunction. +- NF\_RESOURCES\_UNAVAILABLE: Indicates that the MBS PCC rule could not be successfully installed due to resources unavailable at the MB-SMF/MB-UPF. +- RESOURCE\_ALLOCATION\_FAILURE: Indicates that the MBS PCC rule could not be successfully installed or maintained since the associated MBS QoS flow establishment/modification failed or the associated MBS QoS flow was released. +- MBS\_QOS\_VALIDATION\_FAILURE: Indicates that MBS QoS validation has failed. +- NO\_MBS\_QOS\_FLOW: Indicates that there is no MBS QoS flow to which the MB-SMF can bind the MBS PCC rule(s). +- MBS\_QOS\_DECISION\_ERROR: Indicates failure in the provisioning of MBS QoS Decision data. +- MBS\_POLICY\_PARAM\_ERROR: Indicates that the information related to the provisioned MBS policy parameter(s) is incorrect, incomplete or inconsistent. + +## A.3 Npcf\_MBSPolicyAuthorization API + +``` +openapi: 3.0.0 +info: + title: Npcf_MBSPolicyAuthorization API + version: 1.1.0-alpha.2 + description: | + MBS Policy Authorization Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.537 V18.3.0; 5G System; Multicast/Broadcast Policy Control Services. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.537/' + +security: + - {} + - oAuth2ClientCredentials: + - npcf-mbspolicyauth + +servers: + - url: '{apiRoot}/npcf-mbspolicyauth/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in subclause 4.4 of 3GPP TS 29.501. + +paths: + /contexts: + post: + summary: Request the creation of a new Individual MBS Application Session Context resource. + operationId: CreateMBSAppSessionCtxt + tags: + - MBS Application Session Contexts (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MbsAppSessionCtxt' + responses: + '201': + description: > + Created. An Individual MBS Application Session Context resource is successfully created + and a representation of the created resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/MbsAppSessionCtxt' + headers: + Location: + description: > + Contains the URI of the newly created Individual MBS Application Session Context + resource. + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/MbsExtProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/contexts/{contextId}: + parameters: + - name: contextId + in: path + description: > + Contains the identifier of the Individual MBS Application Session Context resource. + required: true + schema: + type: string + + get: + summary: Read an existing Individual MBS Application Session Context resource. + operationId: GetMBSAppSessionCtxt + tags: + - Individual MBS Application Session Context (Document) + responses: + '200': + description: > + OK. The requested Individual MBS Application Session Context resource is successfully + returned. + content: + application/json: + schema: + $ref: '#/components/schemas/MbsAppSessionCtxt' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + patch: + summary: Request the modification of an existing Individual MBS Application Session Context +resource. + operationId: ModifyMBSAppSessionCtxt + tags: + - Individual MBS Application Session Context (Document) + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/MbsAppSessionCtxtPatch' + responses: + '200': + description: > + OK. The requested Individual MBS Application Session Context resource is successfully + modified and a representation of the updated resource is returned in the response body. +``` + +``` + +content: + application/json: + schema: + $ref: '#/components/schemas/MbsAppSessionCtxt' +'204': + description: > + No Content. The corresponding Individual MBS Application Session Context resource is + successfully modified and no content is returned in the response body. +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + description: Forbidden. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/MbsExtProblemDetails' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Request the deletion of an existing Individual MBS Application Session Context +resource. + operationId: DeleteMbsAppSessionCtxt + tags: + - Individual MBS Application Session Context (Document) + responses: + '204': + description: > + No Content. The corresponding Individual MBS Application Session Context resource is + successfully deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + +``` + +``` +clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + npcfc-mbspolicyauth: Access to the Npcf_MBSPolicyAuthorization API + +schemas: + MbsAppSessionCtxt: + description: > + Represents the parameter of an MBS Application Session Context. + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + mbsServInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceInfo' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + areaSessPolId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaSessionPolicyId' + reqForLocDepMbs: + type: boolean + default: false + contactPcfInd: + type: boolean + default: false + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - mbsSessionId + + MbsAppSessionCtxtPatch: + description: > + Represents the modifications to an existing MBS Application Session Context resource. + type: object + properties: + mbsServInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceInfo' + + AcceptableMbsServInfo: + description: > + Contains the MBS Service Information that can be accepted by the PCF. + type: object + properties: + accMbsServInfo: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsMediaComp' + minProperties: 1 + accMaxMbsBw: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + oneOf: + - required: [accMbsServInfo] + - required: [accMaxMbsBw] + +# Data types describing alternative data types or combinations of data types: + + MbsExtProblemDetails: + description: Identifies the MBS related extensions to the ProblemDetails data structure. + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/AcceptableMbsServInfo' +``` + +# --- Annex B (informative): Withdrawn API versions + +## B.1 General + +This Annex lists withdrawn API versions of the APIs defined in the present specification. Clause 4.3.1.6 of 3GPP TS 29.501 [5] describes the withdrawal of API versions. + +## --- B.2 Npcf\_MBSPolicyControl API + +The API versions listed in table B.2-1 are withdrawn for the Npcf\_MBSPolicyControl API. + +**Table B.2-1: Withdrawn API versions of the Npcf\_MBSPolicyControl service** + +| API version number | Remarks | +|--------------------|---------| +| | | + +## --- B.3 Npcf\_MBSPolicyAuthorization API + +The API versions listed in table B.3-1 are withdrawn for the Npcf\_MBSPolicyAuthorization API. + +**Table B.3-1: Withdrawn API versions of the Npcf\_MBSPolicyAuthorization service** + +| API version number | Remarks | +|--------------------|---------| +| | | + +# Annex C (informative): Change history + +| Change history | | | | | | | | | +|----------------|--------------|-----------|------|-----|-----|---------------------------------------------------------------------------------------------------------------------------|--|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2022-01 | CT3#119bis-e | C3-220401 | | | | TS Skeleton | | 0.0.0 | +| 2022-01 | CT3#119bis-e | C3-220457 | | | | Inclusion of C3-220113, C3-220114, C3-220115, C3-220116, C3-220402, C3-220403, C3-220404, C3-220491, C3-220492, C3-220493 | | 0.1.0 | +| 2022-04 | CT3#121-e | C3-222483 | | | | Inclusion of C3-222056, C3-222124, C3-222127, C3-222403, C3-222404, C3-222405, C3-222406, C3-222407, C3-222462 | | 0.2.0 | +| 2022-05 | CT3#122-e | C3-223506 | | | | Inclusion of C3-223561, C3-223574, C3-223562, C3-223563, C3-223564, C3-223568, C3-223565, C3-223566, C3-223573, C3-223308 | | 0.3.0 | +| 2022-06 | CT#96 | CP-221097 | | | | Presentation to TSG CT for information | | 1.0.0 | +| 2022-06 | | | | | | Update of info and externalDocs fields in OpenAPI specs by MCC | | 1.0.1 | +| 2022-09 | CT3#123-e | | | | | Inclusion of C3-224644, C3-224645, C3-224646, C3-224709, C3-224710, C3-224711 | | 1.0.2 | +| 2022-09 | CT#97e | CP-222129 | | | | Presentation to TSG CT for approval | | 2.0.0 | +| 2022-09 | CT#97e | CP-222129 | | | | Approved by TSG CT | | 17.0.0 | +| 2022-12 | CT#98e | CP-223167 | 0001 | 1 | F | Attribute corrections in the description and data model clause in Npcf_MBSPolicyControl Service | | 17.1.0 | +| 2022-12 | CT#98e | CP-223166 | 0005 | - | F | Wrong data type for MBS QoS information | | 17.1.0 | +| 2022-12 | CT#98e | CP-223167 | 0006 | 1 | F | Add 404 NOT FOUND for the Npcf_MBSPolicyauthorization update and delete service | | 17.1.0 | +| 2022-12 | CT#98e | CP-223166 | 0007 | - | F | Correction to architecture figure | | 17.1.0 | +| 2022-12 | CT#98e | CP-223167 | 0008 | 1 | F | Correction to content type of Npcf_MBSPolicyAuthorization API | | 17.1.0 | +| 2022-12 | CT#98e | CP-223166 | 0009 | - | F | Correction to Individual MBS Policy | | 17.1.0 | +| 2022-12 | CT#98e | CP-223166 | 0010 | - | F | Correction to MbsAppSessionCtxt | | 17.1.0 | +| 2022-12 | CT#98e | CP-223167 | 0011 | 1 | F | Correction to Npcf_MBSPolicyControl_Create operation | | 17.1.0 | +| 2022-12 | CT#98e | CP-223167 | 0012 | 1 | F | Correction to response of create operation | | 17.1.0 | +| 2022-12 | CT#98e | CP-223166 | 0013 | - | F | Correction to the indication that the PCF has to be contacted | | 17.1.0 | +| 2022-12 | CT#98e | CP-223167 | 0014 | 1 | F | Corrections for Npcf_MBSPolicyControl service | | 17.1.0 | +| 2022-12 | CT#98e | CP-223188 | 0015 | - | F | Update of info and externalDocs fields | | 17.1.0 | +| 2022-12 | CT#98e | CP-223192 | 0003 | - | F | Adding the mandatory error code 502 Bad Gateway | | 18.0.0 | +| 2022-12 | CT#98e | CP-223192 | 0004 | 1 | F | Npcf_MBSPolicyControl API: enumeration definitions in the OpenAPI file | | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0016 | - | F | Update of info and externalDocs fields | | 18.0.0 | +| 2023-03 | CT#99 | CP-230166 | 0017 | - | F | Correction of the description fields in enumerations | | 18.1.0 | +| 2023-03 | CT#99 | CP-230131 | 0019 | 1 | A | Miscellaneous essential corrections to the MBS PCF APIs | | 18.1.0 | +| 2023-03 | CT#99 | CP-230161 | 0021 | - | F | Update of info and externalDocs fields | | 18.1.0 | +| 2023-06 | CT#100 | CP-231131 | 0020 | 3 | F | Corrections to the redirection mechanism description | | 18.2.0 | +| 2023-12 | CT#102 | CP-233228 | 0022 | | F | Updating the obsoleted IETF HTTP RFCs | | 18.3.0 | +| 2023-12 | CT#102 | CP-233229 | 0023 | 1 | F | Updating the obsoleted ProblemDetails IETF HTTP RFC | | 18.3.0 | +| 2023-12 | CT#102 | CP-233247 | 0026 | 1 | F | Clarification regarding the MBS service flow template | | 18.3.0 | +| 2023-12 | CT#102 | CP-233123 | 0028 | 2 | A | Correction to Npcf_MBSPolicyControl API for location dependent MBS service | | 18.3.0 | +| 2023-12 | CT#102 | CP-233238 | 0030 | | F | Update of info and externalDocs fields | | 18.3.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29552/raw.md b/marked/Rel-18/29_series/29552/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..0c8742b2613abe5479f71ccca307c21dd0d12b6d --- /dev/null +++ b/marked/Rel-18/29_series/29552/raw.md @@ -0,0 +1,4469 @@ + + +# 3GPP TS 29.552 V18.3.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Network Data Analytics signalling flows; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a stylized font with a red signal wave icon below the 'G', and the text 'A GLOBAL INITIATIVE' underneath. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis + +Valbonne - FRANCE + +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members + +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|--------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions of terms, symbols and abbreviations..... | 9 | +| 3.1 Terms..... | 9 | +| 3.2 Symbols..... | 9 | +| 3.3 Abbreviations ..... | 9 | +| 4 Reference Architecture for Data Analytics..... | 9 | +| 4.1 General ..... | 9 | +| 4.2 Data Collection..... | 10 | +| 4.3 Analytics Exposure ..... | 11 | +| 4.4 Data Storage and Retrieval..... | 12 | +| 4.5 Roaming architecture for data collection and analytics exposure..... | 12 | +| 5 Signalling Flows for the Network Data Analytics Framework..... | 12 | +| 5.1 General ..... | 12 | +| 5.2 Analytics Exposure Procedures..... | 13 | +| 5.2.1 General ..... | 13 | +| 5.2.2 Network data analytics Subscribe/Unsubscribe/Notify ..... | 13 | +| 5.2.2.1 Analytics Subscribe/Unsubscribe/Notify initiated by 5GC NFs, OAM or AFs ..... | 13 | +| 5.2.2.2 Analytics Subscribe/Unsubscribe/Notify initiated by AFs via the NEF..... | 14 | +| 5.2.3 Network data analytics information request..... | 15 | +| 5.2.3.1 Analytics information request initiated by 5GC NFs, OAM or AFs ..... | 15 | +| 5.2.3.2 Analytics information request initiated by AFs via the NEF..... | 16 | +| 5.2.4 Analytics Exposure via DCCF ..... | 16 | +| 5.2.5 Analytics Exposure via DCCF and MFAF..... | 20 | +| 5.2.6 Procedure for Analytics Exposure in Roaming Case ..... | 25 | +| 5.2.6.1 Analytics Exposure from HPLMN to VPLMN for inbound roaming users ..... | 25 | +| 5.2.6.2 Analytics Exposure from VPLMN to HPLMN for outbound roaming users ..... | 26 | +| 5.3 Analytics Aggregation from Multiple NWDAFs..... | 28 | +| 5.3.1 General ..... | 28 | +| 5.3.2 Analytics aggregation with provisioning of Area of Interest ..... | 28 | +| 5.3.3 Analytics aggregation without provisioning of Area of Interest ..... | 30 | +| 5.4 Procedures for Analytics Transferring ..... | 31 | +| 5.4.1 Analytics context transfer initiated by target NWDAF selected by the NWDAF service consumer..... | 31 | +| 5.4.2 Analytics Subscription Transfer initiated by source NWDAF ..... | 33 | +| 5.4.3 Prepared analytics subscription transfer ..... | 36 | +| 5.5 Data Collection..... | 38 | +| 5.5.1 Procedure for Data Collection from NFs..... | 38 | +| 5.5.1.1 Data Collection from NFs..... | 38 | +| 5.5.2 Data collection profile registration ..... | 39 | +| 5.5.3 Procedure for Data Collection using DCCF ..... | 41 | +| 5.5.3.1 Data Collection via DCCF ..... | 41 | +| 5.5.3.2 Data Collection via Messaging Framework..... | 46 | +| 5.5.4 Procedure for Data Collection in Roaming Case..... | 51 | +| 5.5.4.1 Data Collection by H-RE-NWDAF from V-RE-NWDAF for outbound roaming users ..... | 51 | +| 5.5.4.2 Data Collection by V-RE-NWDAF from H-RE-NWDAF for inbound roaming users ..... | 53 | +| 5.6 ML Model provisioning procedures..... | 54 | +| 5.6.1 General ..... | 54 | +| 5.6.2 ML Model Subscribe/Unsubscribe/Notify procedure ..... | 54 | +| 5.6A ML Model Training procedures ..... | 55 | +| 5.6A.1 General ..... | 55 | +| 5.6A.2 ML Model Training Subscribe/Unsubscribe/Notify procedure..... | 55 | +| 5.7 Procedures for Specific Network Data Analytics ..... | 56 | +| 5.7.1 General ..... | 56 | + +| | | | +|---------------------------------------------------|-------------------------------------------------------------------------------|------------| +| 5.7.2 | Network Slice (Instance) load level Analytics ..... | 56 | +| 5.7.3 | Observed Service Experience Analytics..... | 59 | +| 5.7.4 | NF load Analytics..... | 62 | +| 5.7.5 | Network Performance Analytics ..... | 65 | +| 5.7.6 | UE Mobility Analytics ..... | 67 | +| 5.7.7 | UE Communication Analytics..... | 70 | +| 5.7.8 | Expected UE behavioural Analytics..... | 73 | +| 5.7.9 | Abnormal UE behavioural Analytics ..... | 75 | +| 5.7.10 | User Data Congestion Analytics ..... | 76 | +| 5.7.11 | QoS Sustainability Analytics..... | 79 | +| 5.7.12 | Dispersion Analytics ..... | 80 | +| 5.7.13 | WLAN Performance Analytics ..... | 83 | +| 5.7.14 | Session Management Congestion Control Experience Analytics ..... | 85 | +| 5.7.15 | Redundant Transmission Experience Analytics ..... | 86 | +| 5.7.16 | DN Performance Analytics..... | 89 | +| 5.7.17 | PFD Determination Analytics ..... | 91 | +| 5.7.18 | E2E data volume transfer time analytics ..... | 93 | +| 5.7.19 | PDU Session Traffic Analytics ..... | 96 | +| 5.7.20 | Relative Proximity Analytics ..... | 97 | +| 5.7.21 | Movement Behaviour Analytics..... | 100 | +| 5.8 | Procedures for NWDAF Discovery and Selection..... | 101 | +| 5.8.1 | General ..... | 101 | +| 5.8.2 | Procedures related to NRF..... | 101 | +| 5.8.2.1 | General..... | 101 | +| 5.8.2.2 | NWDAF (De-)Registration in NRF..... | 101 | +| 5.8.2.3 | Consumer discovery and selection of NWDAF in NRF..... | 101 | +| 5.8.3 | Procedures related to UDM..... | 102 | +| 5.8.3.1 | General..... | 102 | +| 5.8.3.2 | NWDAF containing AnLF Registration/Deregistration in UDM ..... | 102 | +| 5.8.3.2.1 | NWDAF containing AnLF Registration in UDM..... | 102 | +| 5.8.3.2.2 | NWDAF containing AnLF Update of Registration in UDM..... | 102 | +| 5.8.3.2.3 | NWDAF containing AnLF De-Registration in UDM..... | 103 | +| 5.8.3.3 | Consumer discovery and selection of NWDAF containing AnLF in UDM..... | 104 | +| 5.8.4 | Procedures for PCF learning NWDAF IDs for served UEs ..... | 104 | +| 5.9 | Analytics Data Repository procedures..... | 105 | +| 5.9.1 | General ..... | 105 | +| 5.9.2 | Historical Data and Analytics Storage/Retrieval/Deletion procedure..... | 105 | +| 5.9.3 | Historical Data and Analytics Storage via Notifications..... | 107 | +| 5.10 | Federated Learning among Multiple NWDAFs..... | 109 | +| 5.10.1 | General ..... | 109 | +| 5.10.2 | Procedures related to Federated Learning ..... | 109 | +| 5.10.2.1 | General Procedure for Federated Learning among Multiple NWDAF Instances ..... | 109 | +| 5.10.2.2 | Preparation Procedure for Federated Learning ..... | 113 | +| 5.10.2.3 | Procedure for Maintenance of Federated Learning Process ..... | 113 | +| Annex A (informative): Change history..... | | 116 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies detailed call flows of Network Data Analytics over the Nnwdaf, Nsmf, Npcf, Nnsacf, Namf, Nnrf, Nnsnf, Nnef, Naf, Ndcf, Nadrf, Nmfa, Nudm, Nupf and Ngmlc service-based interfaces and their relationship with the flow level signalling in 5G system. + +NOTE: The call flows depicted in this Technical Specification do not cover all traffic cases. + +The stage 2 definition and procedures of Network Data Analytics are contained in 3GPP TS 23.288 [2] and 3GPP TS 23.502 [3]. The 5G System Architecture is defined in 3GPP TS 23.501 [4]. + +Detailed definitions of the involved services are provided in 3GPP TS 29.520 [5], 3GPP TS 29.508 [6], 3GPP TS 29.523 [7], 3GPP TS 29.554 [8], 3GPP TS 29.521 [9], 3GPP TS 29.522 [10], 3GPP TS 29.591 [11], 3GPP TS 29.517 [12], 3GPP TS 29.574 [15], 3GPP TS 29.575 [16], 3GPP TS 29.576 [17], 3GPP TS 29.503 [22], 3GPP TS 29.510 [23], 3GPP TS 29.507 [24], 3GPP TS 29.512 [25], 3GPP TS 29.564 [40] and 3GPP TS 29.515 [41]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition of the 5G System are specified in 3GPP TS 29.500 [13] and 3GPP TS 29.501 [14]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [5] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". +- [6] 3GPP TS 29.508: "5G System; Session Management Event Exposure Service; Stage 3". +- [7] 3GPP TS 29.523: "5G System; Policy Control Event Exposure Service; Stage 3". +- [8] 3GPP TS 29.554: "5G System; Background Data Transfer Policy Control Service; Stage 3". +- [9] 3GPP TS 29.521: "5G System; Binding Support Management Service; Stage 3". +- [10] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [11] 3GPP TS 29.591: "5G System; Network Exposure Function Southbound Services; Stage 3". +- [12] 3GPP TS 29.517: "5G System; Application Function Event Exposure Service; Stage 3". +- [13] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [14] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [15] 3GPP TS 29.574: "5G System; Data Collection Coordination Services; Stage 3". + +- [16] 3GPP TS 29.575: "5G System; Analytics Data Repository Services; Stage 3". +- [17] 3GPP TS 29.576: "5G System; Messaging Framework Adaptor Services; Stage 3". +- [18] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". +- [19] 3GPP TS 28.532: "Management and orchestration; Generic management services". +- [20] 3GPP TS 29.536: "5G System: Network Slice Admission Control Services; Stage 3". +- [21] 3GPP TS 29.531: "5G System: Network Slice Selection Services; Stage 3". +- [22] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [23] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [24] 3GPP TS 29.507: "5G System; Access and Mobility Policy Control Service; Stage 3". +- [25] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3". +- [26] 3GPP TS 29.510: "5G System: Network function repository services; Stage 3". +- [27] 3GPP TS 28.552: "Management and orchestration; 5G performance measurements". +- [28] 3GPP TS 28.533: "Management and orchestration; Architecture framework". +- [29] 3GPP TS 37.320: " Radio measurement collection for Minimization of Drive Tests (MDT); Overall description". +- [30] 3GPP TS 28.554: " Management and orchestration; 5G end to end Key Performance Indicators (KPI)". +- [31] 3GPP TS 28.550: "Management and orchestration; Performance assurance". +- [32] Void. +- [33] 3GPP TS 38.331: "NR; Radio Resource Control (RRC) protocol specification". +- [34] 3GPP TS 36.331: "Radio Resource Control (RRC); Protocol specification". +- [35] 3GPP TS 38.215: "NR; Physical layer measurements". +- [36] 3GPP TS 28.310: "Management and orchestration; Energy efficiency of 5G". +- [37] 3GPP TS 28.545: "Management and orchestration; Fault Supervision (FS)". +- [38] 3GPP TS 28.104: "Management and orchestration; Management Data Analytics (MDA)". +- [39] 3GPP TS 29.551: "5G System; Packet Flow Description Management Service; Stage 3". +- [40] 3GPP TS 29.564: "5G System; User Plane Function Services; Stage 3". +- [41] 3GPP TS 29.515: "5G System; Gateway Mobile Location Services; Stage 3". +- [42] 3GPP TS 28.622: "Generic Network Resource Model (NRM)Integration Reference Point (IRP); Information Service (IS)". +- [43] 3GPP TS 32.422: "Subscriber and equipment trace; Trace control and configuration management". +- [44] 3GPP TS 28.537: "Management and orchestration; Management capabilities". + +# 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Symbols + +None. + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|----------|--------------------------------------------| +| ADRF | Analytics Data Repository Function | +| AF | Application Function | +| AMF | Access and Mobility Management Function | +| AnLF | Analytics Logical Function | +| CEF | Charging Enablement Function | +| DCCF | Data Collection Coordination Function | +| FL | Federated Learning | +| GMLC | Gateway Mobile Location Centre | +| LMF | Location Management Function | +| MDAF | Management Data Analytics Function | +| MDT | Minimization of Drive Tests | +| MFAF | Messaging Framework Adaptor Function | +| ML | Machine Learning | +| MTLF | Model Training Logical Function | +| NEF | Network Exposure Function | +| NRF | Network Repository Function | +| NSACF | Network Slice Admission Control Function | +| NSSF | Network Slice Selection Function | +| NWDAF | Network Data Analytics Function | +| OAM | Operation, Administration, and Maintenance | +| PCF | Policy Control Function | +| RE-NWDAF | Roaming Exchange NWDAF | +| SMF | Session Management Function | +| UDM | Unified Data Management | +| UPF | User Plane Function | + +# 4 Reference Architecture for Data Analytics + +## 4.1 General + +For the enablement of network data analytics services, the NWDAF interacts with different entities for different purposes: + +- Data Collection: + - a) collecting Data from OAM, MDAF and/or 5GC NFs (e.g. AMF); + - b) collecting Data from untrusted AF via NEF; and/or + +- c) collecting Analytics and/or Data from 5GC NFs via DCCF or via DCCF together with ADRF and/or MFAF or via NWDAF hosting DCCF i.e. an NWDAF that implements DCCF functionality internally and supports the Nnwdaf\_DataManagement API for collecting data, the Nnwdaf\_EventSubscription API for collecting analytics; +- Analytics Exposure: + - a) Exposing Analytics to 5GC NFs; + - b) Exposing Analytics to untrusted AF via NEF; and/or + - c) Exposing Analytics to 5GC NFs via DCCF or via DCCF together with ADRF and/or MFAF or via NWDAF hosting DCCF and/or ADRF i.e. an NWDAF that implements DCCF and/or ADRF functionality internally and supports the Nnwdaf\_EventSubscription API; +- Storing and Retrieving data in ADRF. + +The entities mentioned above interact also with each other as described in the procedures of clause 5. + +## 4.2 Data Collection + +As depicted in Figure 4.2-1, the 5G System architecture allows NWDAF to collect data from any 5GC NF (e.g. AMF, SMF), OAM and/or MDAF directly or via DCCF, DCCF together with ADRF and/or MFAF, or via NWDAF in non-roaming case. The roaming architecture for data collection is defined in clause 4.5. + +![Figure 4.2-1: Data Collection Architecture diagram showing the NWDAF interacting with various network functions for data collection.](c2fc2621e8206d24427b56bcb2398fc0_img.jpg) + +The diagram illustrates the Data Collection Architecture. On the left is a large box labeled 'NWDAF'. On the right is a large box labeled 'Data Source NF (e.g. AMF)'. In the center, there are four boxes representing different network functions or frameworks: 'DCCF', 'MFAF' (which contains a sub-box 'Messaging Framework'), 'ADRF', and 'NWDAF hosting DCCF'. At the bottom right is a box labeled 'Management Data Source (OAM, MDAF)'. Lines with interface labels connect the NWDAF to these central entities: 'Ndcf' to DCCF, 'Nmfaf' to MFAF, 'Nadrf' to ADRF, and 'Nnwdaf' to NWDAF hosting DCCF. From the central entities, lines with interface labels connect to the Data Source NF: 'Nnf' from DCCF, 'Nnf' from MFAF, 'Nnf' from ADRF, and 'Nnf' from NWDAF hosting DCCF. Finally, a line with the interface label 'MnS' connects the Management Data Source (OAM, MDAF) to the NWDAF. + +Figure 4.2-1: Data Collection Architecture diagram showing the NWDAF interacting with various network functions for data collection. + +Figure 4.2-1: Data Collection Architecture + +When DCCF, ADRF, MFAF or NWDAF hosting DCCF are present in the network, whether the NWDAF directly contacts the Data Source NF or goes via the DCCF, or NWDAF hosting DCCF is based on configuration of the NWDAF. + +The Data Source NF may be AMF, SMF, UDM, UPF, GMLC, AF, NSACF, NRF and/or NEF with the related data collection procedures described in clause 5.5. If the Data Source is OAM, the NWDAF may collect relevant management data from the services in the OAM as configured by the PLMN operator with NG RAN or 5GC performance measurements as defined in TS 28.552 [27] and 5G End to end KPIs as defined in TS 28.554 [30]. The NWDAF may use the OAM services e.g. generic performance assurance and fault supervision management services as defined in TS 28.532 [19], PM (Performance Management) services as defined in TS 28.550 [31] and/or FS (Fault Supervision) services as defined in TS 28.545 [37]. The procedure for data collection from OAM is defined in clause 6.2.3.2 of TS 23.288 [2]. The NWDAF may collect the analysis results from MDAF, e.g. service experience and energy saving state analysis and/or end-to-end latency analysis in TS 28.104 [38]. The procedure for analytics collection from MDAF is defined in clause 6.2.14.2 of TS 23.288 [2]. Before NWDAF requests analytics from the MDA Management Function, the NWDAF firstly discovers the MDAF via the MnS discovery service producer as defined in clause 5 of TS 28.537 [42]. + +For the specific analytics event, the applicable Data Source NF(s) and the related data collection procedures and scope are described in the corresponding analytics event subclause within clause 5.7. + +## 4.3 Analytics Exposure + +As depicted in Figure 4.3-1, the 5G System architecture allows NWDAF to expose data to any 5GC NF (e.g. AMF) directly or via DCCF/MFAF in non-roaming case. For roaming case, the roaming architecture as described in clause 4.5 is added between HPLMN and VPLMN. + +![Figure 4.3-1: Analytics Exposing Architecture. This diagram shows the network architecture for analytics exposure. On the left is the 'Analytics consumer (e.g. AMF)'. On the right is the 'NWDAF'. In the center, there are several network functions: 'DCCF', 'MFAF' (which contains a 'Messaging Framework'), 'ADRF', and 'NWDAF hosting DCCF and/or ADRF'. The Analytics consumer connects to DCCF via 'Ndcdf', to MFAF via 'Nmfaf', to ADRF via 'Nadrf', and to the NWDAF hosting box via 'Nnwdaf'. The DCCF connects to the NWDAF via 'Nnwdaf'. The MFAF connects to the NWDAF via 'Nnwdaf'. The ADRF connects to the NWDAF via 'Nnwdaf' and 'Nadrf'. The NWDAF hosting box connects to the NWDAF via 'Nnwdaf'.](8e14350b4b669119a3bdfca7869110ca_img.jpg) + +Figure 4.3-1: Analytics Exposing Architecture. This diagram shows the network architecture for analytics exposure. On the left is the 'Analytics consumer (e.g. AMF)'. On the right is the 'NWDAF'. In the center, there are several network functions: 'DCCF', 'MFAF' (which contains a 'Messaging Framework'), 'ADRF', and 'NWDAF hosting DCCF and/or ADRF'. The Analytics consumer connects to DCCF via 'Ndcdf', to MFAF via 'Nmfaf', to ADRF via 'Nadrf', and to the NWDAF hosting box via 'Nnwdaf'. The DCCF connects to the NWDAF via 'Nnwdaf'. The MFAF connects to the NWDAF via 'Nnwdaf'. The ADRF connects to the NWDAF via 'Nnwdaf' and 'Nadrf'. The NWDAF hosting box connects to the NWDAF via 'Nnwdaf'. + +**Figure 4.3-1: Analytics Exposing Architecture** + +When DCCF, ADRF, MFAF or NWDAF are present in the network, whether the Analytics consumer directly contacts the NWDAF or goes via the DCCF or via the NWDAF hosting DCCF and/or ADRF is based on configuration of the Analytics consumer. + +The Analytics consumer may be AMF, SMF, NSSF, PCF, LMF, AF, NEF, OAM and/or CEF when directly contacts NWDAF with the related analytics exposure procedures described in clause 5.2.2 and clause 5.2.3. The Analytics consumers may be AMF, SMF, NSSF, PCF, LMF, AF and/or NEF when contacts via the DCCF with the related analytics exposure procedures described in clause 5.2.4 and clause 5.2.5. + +For the specific analytics event, the applicable Analytics consumer(s) and the related analytics exposure procedures and scope are described in the corresponding analytics event subclause within clause 5.7. + +## 4.4 Data Storage and Retrieval + +As depicted in Figure 4.4-1, the 5G System architecture allows the consumer to store and retrieve the collected data in the ADRF directly or via DCCF/MFAF. + +![Figure 4.4-1: Data Storage and Retrieval Architecture. The diagram shows an NF (e.g. NWDAF) on the left connected to a DCCF and an MFAF (which contains a Messaging Framework) in the center, and an ADRF on the right. The NF connects to the DCCF via the Ndcclf interface and to the MFAF via the Nmfaf interface. The DCCF and MFAF are connected to each other via the Nmfaf interface. Both the DCCF and the MFAF connect to the ADRF via the Nadrf interface. There is also a direct connection from the NF to the ADRF.](7f17c430b9598e4d748a8041457810b3_img.jpg) + +Figure 4.4-1: Data Storage and Retrieval Architecture. The diagram shows an NF (e.g. NWDAF) on the left connected to a DCCF and an MFAF (which contains a Messaging Framework) in the center, and an ADRF on the right. The NF connects to the DCCF via the Ndcclf interface and to the MFAF via the Nmfaf interface. The DCCF and MFAF are connected to each other via the Nmfaf interface. Both the DCCF and the MFAF connect to the ADRF via the Nadrf interface. There is also a direct connection from the NF to the ADRF. + +Figure 4.4-1: Data Storage and Retrieval Architecture + +## 4.5 Roaming architecture for data collection and analytics exposure + +Based on operator's policy and local regulations (e.g. privacy), data or analytics may be exchanged between PLMNs (i.e. HPLMN and VPLMN) via RE-NWDAF (i.e. an NWDAF with roaming exchange capability in each PLMN used as exchange point to exchange data and/or analytics with other PLMNs) using the architecture shown in Figure 4.5-1. + +![Figure 4.5-1: Roaming Architecture to exchange Data or Analytics between V-PLMN and H-PLMN. The diagram shows two PLMNs: H-PLMN and V-PLMN. In the H-PLMN, an 'Any NF' is connected to an 'H-RE-NWDAF'. In the V-PLMN, a 'V-RE-NWDAF' is connected to an 'Any NF'. The H-RE-NWDAF and the V-RE-NWDAF are connected to each other via the Nnwdaf interface.](fbfa653853daf5541118a9ddecb92284_img.jpg) + +Figure 4.5-1: Roaming Architecture to exchange Data or Analytics between V-PLMN and H-PLMN. The diagram shows two PLMNs: H-PLMN and V-PLMN. In the H-PLMN, an 'Any NF' is connected to an 'H-RE-NWDAF'. In the V-PLMN, a 'V-RE-NWDAF' is connected to an 'Any NF'. The H-RE-NWDAF and the V-RE-NWDAF are connected to each other via the Nnwdaf interface. + +Figure 4.5-1: Roaming Architecture to exchange Data or Analytics between V-PLMN and H-PLMN + +In roaming scenario, the H-RE-NWDAF is the enforcement point to check user consent. The H-RE-NWDAF retrieves the roaming-related user consent for a user from the UDM. + +# 5 Signalling Flows for the Network Data Analytics Framework + +## 5.1 General + +This clause describes the Network Data Analytics related Signalling Flows, including the procedures for analytics exposure, analytics aggregation from multiple NWDAFs, analytics context and analytics subscription transferring between different NWDAFs, ML model provisioning, data collection, specified Network Data Analytics generation and the NWDAF discovery and selection. The specific NF service operations which are used in these procedures are also provided in the procedure descriptions. + +## 5.2 Analytics Exposure Procedures + +### 5.2.1 General + +The analytics exposure procedures allow the NF service consumers (i.e. NFs, OAM and AFs) to obtain the analytics information from the NWDAF. + +### 5.2.2 Network data analytics Subscribe/Unsubscribe/Notify + +#### 5.2.2.1 Analytics Subscribe/Unsubscribe/Notify initiated by 5GC NFs, OAM or AFs + +This procedure is used in non-roaming case by the NF service consumers (i.e. NFs, OAM and AFs) to subscribe to/unsubscribe from analytics information directly from the NWDAF, it is also used by the NWDAF to notify the observed analytics event(s) to the NF service consumer if subscribed before. + +![Sequence diagram showing the interaction between an NF service consumer and the NWDAF for analytics subscription, notification, and unsubscription.](e9d825d87c5f85c8dba0664eace96ef4_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: + NF service consumer->>NWDAF: 1. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>NF service consumer: 2. Nnwdaf_EventsSubscription_Subscribe response + Note right of NWDAF: + NWDAF->>NF service consumer: 3. Nnwdaf_EventsSubscription_Notify request + NF service consumer-->>NWDAF: 4. Nnwdaf_EventsSubscription_Notify response + Note left of NF service consumer: + NF service consumer->>NWDAF: 5. Nnwdaf_EventsSubscription_Unsubscribe request + NWDAF-->>NF service consumer: 6. Nnwdaf_EventsSubscription_Unsubscribe response +``` + +The diagram illustrates a sequence of six messages between an 'NF service consumer' and the 'NWDAF'. The sequence starts with the consumer sending a 'Nnwdaf\_EventsSubscription\_Subscribe request' (1) to the NWDAF, which responds with a 'Nnwdaf\_EventsSubscription\_Subscribe response' (2). The NWDAF then sends a 'Nnwdaf\_EventsSubscription\_Notify request' (3) to the consumer, which responds with a 'Nnwdaf\_EventsSubscription\_Notify response' (4). Finally, the consumer sends a 'Nnwdaf\_EventsSubscription\_Unsubscribe request' (5) to the NWDAF, which responds with a 'Nnwdaf\_EventsSubscription\_Unsubscribe response' (6). + +Sequence diagram showing the interaction between an NF service consumer and the NWDAF for analytics subscription, notification, and unsubscription. + +**Figure 5.2.2.1-1: Analytics Subscribe/Unsubscribe/Notify initiated by 5GC NFs, OAM or AFs** + +1. In order to subscribe to notification(s) of analytics information from the NWDAF, the NF service consumer invokes Nnwdaf\_EventsSubscription\_Subscribe service operation by sending an HTTP POST request targeting the resource "NWDAF Events Subscriptions". The request includes the subscribed events and may include event filter information. + +In order to update the existing subscription, the NF service consumer invokes Nnwdaf\_EventsSubscription\_Subscribe service operation by sending an HTTP PUT request with Resource URI of the resource "Individual NWDAF Event Subscription". + +2. The NWDAF responds to the Nnwdaf\_EventsSubscription\_Subscribe service operation. Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NWDAF responds to the NF service consumer with "201 Created", and the URI of the created subscription is included in the Location header field. + +Upon receipt of the HTTP PUT request, if the subscription is accepted to be updated, the NWDAF responds to the NF service consumer with "200 OK" or "204 No Content" + +3. If the NWDAF observes the subscribed event(s), the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation to report the event(s) by sending an HTTP POST request with {notificationURI} as Notification URI. When calculating accuracy information for the analytics or the ML model for which analytics feedback information has been received, in addition to comparing predictions of ML model and its corresponding ground truth data, the NWDAF may additionally determine and take into account whether the action(s) taken by the NF service consumer affects the ground truth data corresponding to Analytics ID requested at the time which the prediction refers to as described in the procedures for Analytics Accuracy Monitoring and ML Model Accuracy Monitoring, which may affect the accuracy calculation. + +**Editor's Note:** It is FFS to move the specification of this behaviour to the procedures for Analytics Accuracy Monitoring and ML Model Accuracy Monitoring if the latter are agreed and added to the specification. + +4. The NF service consumer sends an HTTP "204 No Content" response to the NWDAF. +5. In order to unsubscribe to the notification(s) of analytics information from the NWDAF, the NF service consumer invokes Nnwdaf\_EventsSubscription\_Unsubscribe service operation by sending an HTTP DELETE request targeting the resource "Individual NWDAF Event Subscription", to the NWDAF to unsubscribe from analytics information. The request includes the event subscriptionId of the existing subscription that is to be deleted. +6. The NWDAF responds to the Nnwdaf\_EventsSubscription\_Unsubscribe service operation. If the unsubscribe is accepted, the NWDAF responds with "204 No Content". + +NOTE: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify service operations refer to 3GPP TS 29.520 [5]. + +#### 5.2.2.2 Analytics Subscribe/Unsubscribe/Notify initiated by AFs via the NEF + +This procedure is used by the AF to subscribe to/unsubscribe from analytics information from the NWDAF via the NEF, it is also used by the NWDAF to notify the analytics event(s) to the AF via the NEF, if subscribed before. + +![Sequence diagram showing the interaction between NWDAF, NEF, and AF for Analytics Subscribe/Unsubscribe/Notify initiated by AFs via the NEF. The diagram consists of 12 numbered steps: 1. AF sends Nnef_AnalyticsExposure_Subscribe request to NEF; 2. NEF sends Nnwdaf_EventsSubscription_Subscribe request to NWDAF; 3. NWDAF sends Nnwdaf_EventsSubscription_Subscribe response to NEF; 4. NEF sends Nnef_AnalyticsExposure_Subscribe response to AF; 5. NWDAF sends Nnwdaf_EventsSubscription_Notify request to NEF; 6. NEF sends Nnef_AnalyticsExposure_Notify request to AF; 7. AF sends Nnef_AnalyticsExposure_Notify response to NEF; 8. NEF sends Nnwdaf_EventsSubscription_Notify response to NWDAF; 9. AF sends Nnef_AnalyticsExposure_Unsubscribe request to NEF; 10. NEF sends Nnwdaf_EventsSubscription_Unsubscribe request to NWDAF; 11. NWDAF sends Nnwdaf_EventsSubscription_Unsubscribe response to NEF; 12. NEF sends Nnef_AnalyticsExposure_Unsubscribe response to AF.](f6e8acf9f931452d01688d311b5c0364_img.jpg) + +``` + +sequenceDiagram + participant AF + participant NEF + participant NWDAF + Note right of AF: 1. Nnef_AnalyticsExposure_Subscribe request + AF->>NEF: + Note right of NEF: 2. Nnwdaf_EventsSubscription_Subscribe request + NEF->>NWDAF: + Note right of NWDAF: 3. Nnwdaf_EventsSubscription_Subscribe response + NWDAF->>NEF: + Note right of NEF: 4. Nnef_AnalyticsExposure_Subscribe response + NEF->>AF: + Note right of NWDAF: 5. Nnwdaf_EventsSubscription_Notify request + NWDAF->>NEF: + Note right of NEF: 6. Nnef_AnalyticsExposure_Notify request + NEF->>AF: + Note right of AF: 7. Nnef_AnalyticsExposure_Notify response + AF->>NEF: + Note right of NEF: 8. Nnwdaf_EventsSubscription_Notify response + NEF->>NWDAF: + Note right of AF: 9. Nnef_AnalyticsExposure_Unsubscribe request + AF->>NEF: + Note right of NEF: 10. Nnwdaf_EventsSubscription_Unsubscribe request + NEF->>NWDAF: + Note right of NWDAF: 11. Nnwdaf_EventsSubscription_Unsubscribe response + NWDAF->>NEF: + Note right of NEF: 12. Nnef_AnalyticsExposure_Unsubscribe response + NEF->>AF: + +``` + +Sequence diagram showing the interaction between NWDAF, NEF, and AF for Analytics Subscribe/Unsubscribe/Notify initiated by AFs via the NEF. The diagram consists of 12 numbered steps: 1. AF sends Nnef\_AnalyticsExposure\_Subscribe request to NEF; 2. NEF sends Nnwdaf\_EventsSubscription\_Subscribe request to NWDAF; 3. NWDAF sends Nnwdaf\_EventsSubscription\_Subscribe response to NEF; 4. NEF sends Nnef\_AnalyticsExposure\_Subscribe response to AF; 5. NWDAF sends Nnwdaf\_EventsSubscription\_Notify request to NEF; 6. NEF sends Nnef\_AnalyticsExposure\_Notify request to AF; 7. AF sends Nnef\_AnalyticsExposure\_Notify response to NEF; 8. NEF sends Nnwdaf\_EventsSubscription\_Notify response to NWDAF; 9. AF sends Nnef\_AnalyticsExposure\_Unsubscribe request to NEF; 10. NEF sends Nnwdaf\_EventsSubscription\_Unsubscribe request to NWDAF; 11. NWDAF sends Nnwdaf\_EventsSubscription\_Unsubscribe response to NEF; 12. NEF sends Nnef\_AnalyticsExposure\_Unsubscribe response to AF. + +**Figure 5.2.2.2-1: Analytics Subscribe/Unsubscribe/Notify initiated by AFs via the NEF** + +1. In order to subscribe to notification(s) of analytics exposure via the NEF, the AF invokes the Nnef\_AnalyticsExposure\_Subscribe request by sending an HTTP POST request message targeting the resource "Analytics Exposure Subscriptions" as defined in clause 4.4.14.1 of 3GPP TS 29.522 [10]. + +In order to update an existing analytics exposure subscription, the AF shall send an HTTP PUT request message to the NEF to the resource "Individual Analytics Exposure Subscription" requesting to change the subscription. + +2. Upon receipt of the HTTP request from the AF, if the AF is authorized with the requested analytics event(s) and the requested parameters comply with the inbound restriction in the analytics exposure mapping, the NEF shall invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in step 1 in clause 5.2.2.1. + +3. The NWDAF responds to the Nnwdaf\_EventsSubscription\_Subscribe service operation as described in step 2 in clause 5.2.2.1. +4. Upon receipt of the HTTP request response from the NWDAF, the NEF shall invoke the Nnef\_AnalyticsExposure\_Subscribe response message by mapping and forwarding the response to the AF. +5. If the NWDAF observes the subscribed event(s), the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in step 3 in clause 5.2.2.1 to the NEF. When calculating accuracy information for the analytics or the ML model for which analytics feedback information has been received, in addition to comparing predictions of ML model and its corresponding ground truth data, the NWDAF may additionally determine and take into account whether the action(s) taken by the AF affects the ground truth data corresponding to Analytics ID requested at the time which the prediction refers to as described in the procedures for Analytics Accuracy Monitoring and ML Model Accuracy Monitoring, which may affect the accuracy calculation. + +**Editor's Note:** It is FFS to move the specification of this behaviour to the procedures for Analytics Accuracy Monitoring and ML Model Accuracy Monitoring if the latter are agreed and added to the specification. + +6. If the NEF receives an analytics information notification from the NWDAF indicating that the subscribed analytics event has been detected, the NEF shall invoke the Nnef\_AnalyticsExposure\_Notify request by sending HTTP POST request message provide a notification to the AF request including the AnalyticsEventNotification data structure at least with the detected analytics event identified by the notification URI together with the notification correlation identifier received during creation of the Individual Analytics Exposure Subscription. +7. Upon receipt of the analytics event notification, the AF shall respond the NEF with a "204 No Content" status code to confirm the received notification in Nnef\_AnalyticsExposure\_Notify response message. +8. The NEF shall forward the HTTP "204 No Content" response to the NWDAF. +9. In order to delete an existing analytics exposure subscription, the AF shall invoke the Nnef\_AnalyticsExposure\_Unsubscribe request by sending an HTTP DELETE request message to the NEF to the resource "Individual Analytics Exposure Subscription". +10. If the NEF receives an HTTP DELETE request from the AF, the NEF shall invoke the Nnwdaf\_EventsSubscription\_Unsubscribe service operation as described in step 5 in clause 5.2.2.1. +11. The NWDAF responds to the Nnwdaf\_EventsSubscription\_Unsubscribe service operation as described in step 6 in clause 5.2.2.1. +12. The NEF shall forward the HTTP "204 No Content" response to the AF. + +NOTE: Details of AnalyticsExposure API refer to clause 4.4.14 and clause 5.6 of 3GPP TS 29.522 [4]. + +### 5.2.3 Network data analytics information request + +#### 5.2.3.1 Analytics information request initiated by 5GC NFs, OAM or AFs + +This procedure is used in non-roaming case by the NF service consumers (i.e. 5GC NFs, OAM and AFs) to retrieve analytics information directly from the NWDAF. The analytics architecture for analytics exposure is defined in clause 4.5. + +![Sequence diagram showing the Network data analytics info request procedure. An NF service consumer sends a request to the NWDAF, and the NWDAF responds.](70de8885bd7de15723aaad5eb5c5febf_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: + NF service consumer->>NWDAF: 1. Nnwdaf_AnalyticsInfo_Request request + Note right of NWDAF: + NWDAF-->>NF service consumer: 2. Nnwdaf_AnalyticsInfo_Request response +``` + +Sequence diagram showing the Network data analytics info request procedure. An NF service consumer sends a request to the NWDAF, and the NWDAF responds. + +**Figure 5.2.3.1-1: Network data analytics info request procedure** + +1. The NF Service Consumer invokes Nnwdaf\_AnalyticsInfo\_Request service operation by sending an HTTP GET request targeting the resource "NWDAF Analytics", to the NWDAF to request the analytics information. The request includes analytics identifier and related event filter information. +2. The NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation. If the request is accepted, the response includes the requested analytics information with "200 OK". + +NOTE: For details of Nnwdaf\_AnalyticsInfo\_Request service operation refer to 3GPP TS 29.520 [5]. + +#### 5.2.3.2 Analytics information request initiated by AFs via the NEF + +This procedure is used by the AFs to retrieve analytics information from the NWDAF via the NEF. + +![Sequence diagram showing the interaction between NWDAF, NEF, and AF for an analytics request initiated by AFs via the NEF.](cb4cfa42ce34febde7bdb882f3fc3094_img.jpg) + +``` +sequenceDiagram + participant AF + participant NEF + participant NWDAF + Note right of AF: 1. Nnef_AnalyticsExposure_Fetch request + AF->>NEF: 1. Nnef_AnalyticsExposure_Fetch request + Note left of NEF: 2. Nnwdaf_AnalyticsInfo_Request request + NEF->>NWDAF: 2. Nnwdaf_AnalyticsInfo_Request request + Note left of NWDAF: 3. Nnwdaf_AnalyticsInfo_Request response + NWDAF->>NEF: 3. Nnwdaf_AnalyticsInfo_Request response + Note left of NEF: 4. Nnef_AnalyticsExposure_Fetch response + NEF->>AF: 4. Nnef_AnalyticsExposure_Fetch response +``` + +Sequence diagram showing the interaction between NWDAF, NEF, and AF for an analytics request initiated by AFs via the NEF. + +**Figure 5.2.3.2-1: Analytics Request initiated by AFs via the NEF** + +1. In order to fetch analytics information, the AF invoke the Nnef\_AnalyticsExposure\_Fetch request by sending an HTTP POST request message to the NEF to the customized operation URI "{apiRoot}/3gpp-analyticsexposure/v1/fetch" as defined in clause 4.4.14.2 of 3GPP TS 29.522 [10]. +2. Upon receipt of the HTTP request from the AF, if the AF is authorized with the requested analytics event(s) and the requested parameters comply with the inbound restriction in the analytics exposure mapping, the NEF shall invoke the Nnwdaf\_AnalyticsInfo\_Request service operation as described in step 1 in clause 5.2.3.1. +3. The NWDAF responds with the analytics information as described in step 2 in clause 5.2.3.1 to the NEF. +4. The NEF responds with the analytics information to the AF. + +NOTE: Details of AnalyticsExposure API refer to clause 4.4.14 and clause 5.6 of 3GPP TS 29.522 [4]. + +### 5.2.4 Analytics Exposure via DCCF + +This procedure is used by NF service consumer(s) based on local configuration, to subscribe/unsubscribe to NWDAF analytics event(s) via the DCCF, and upon the delivery option "Delivery via DCCF" configured on the DCCF, also used by DCCF to notify the NF service consumer(s) of the analytics information via the DCCF if subscribed before. + +![Sequence diagram showing Analytics Exposure via DCCF. Lifelines: NF service consumer, DCCF, ADRF, NWDAF. The diagram illustrates the interaction for subscribing, fetching data, and unsubscribing to analytics exposure.](8307f6b04df072c9332f9987e034272c_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant DCCF + participant ADRF + participant NWDAF + + Note right of DCCF: 2. Determine whether historical analytics data handling is applicable or not + Note right of DCCF: 3a. Determine whether the analytics requested are already being collected + + Note right of DCCF: 3b. If historical analytics data handling is applicable, and DCCF determine to retrieve analytics data from ADRF Instance + Note right of DCCF: 3c. If historical analytics data handling is applicable, and DCCF determine to retrieve analytics data from NWDAF Instance + + Note left of ADRF: Data Fetch + Note left of ADRF: Unsubscribe + + NF->>DCCF: 1. Ndcf_DataManagement_Subscribe request + DCCF-->>NWDAF: 4a. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>DCCF: 5a. Nnwdaf_EventsSubscription_Subscribe response + DCCF-->>ADRF: 4b. Nadrf_DataManagement_RetrievalSubscribe request + ADRF-->>DCCF: 5b. Nadrf_DataManagement_RetrievalSubscribe response + DCCF-->>NWDAF: 4c. Nnwdaf_EventsSubscription_Subscribe request or Nnwdaf_AnalyticsInfo_Request request + NWDAF-->>DCCF: 5c. Nnwdaf_EventsSubscription_Subscribe response or Nnwdaf_AnalyticsInfo_Request response + DCCF-->>NF: 6. Ndcf_DataManagement_Subscribe response + DCCF-->>NWDAF: 7a. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>DCCF: 8a. Nnwdaf_EventsSubscription_Notify response + DCCF-->>ADRF: 7b. Nadrf_DataManagement_RetrievalNotify request + ADRF-->>DCCF: 8b. Nadrf_DataManagement_RetrievalNotify response + DCCF-->>NWDAF: 7c. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>DCCF: 8c. Nnwdaf_EventsSubscription_Notify response + DCCF-->>NF: 9. Ndcf_DataManagement_Notify request + NF-->>DCCF: 10. Ndcf_DataManagement_Notify response + NF-->>DCCF: 11. Ndcf_DataManagement_Fetch Request + DCCF-->>NF: 12. Ndcf_DataManagement_Fetch response + NF->>DCCF: 13. Ndcf_DataManagement_Unsubscribe request + DCCF-->>NF: 14. Ndcf_DataManagement_Unsubscribe response + DCCF-->>NWDAF: 15a. Nnwdaf_EventsSubscription_Unsubscribe request + NWDAF-->>DCCF: 16a. Nnwdaf_EventsSubscription_Unsubscribe response + DCCF-->>ADRF: 15b. Nadrf_DataManagement_RetrievalUnsubscribe request + ADRF-->>DCCF: 16b. Nadrf_DataManagement_RetrievalUnsubscribe response + +``` + +Sequence diagram showing Analytics Exposure via DCCF. Lifelines: NF service consumer, DCCF, ADRF, NWDAF. The diagram illustrates the interaction for subscribing, fetching data, and unsubscribing to analytics exposure. + +Figure 5.2.4-1: Analytics Exposure via DCCF + +1. In order to subscribe to notification(s) of analytics exposure via the DCCF based on local configuration, the NF service consumer invokes the Ndcf\_DataManagement\_Subscribe service operation by sending an HTTP POST request message targeting the resource "DCCF Analytics Subscriptions", the HTTP POST message shall include the NdcfAnalyticsSubscription data structure as request body with parameters as defined in clause 5.1.6.2.2 of 3GPP TS 29.574 [15]. +2. The DCCF keeps track of the analytics actively being collected for the Analytics Subscription it is coordinating. The NWDAF or ADRF may register the analytics data profile (may include the analytics data related service + +operation, Analytics Specification, NWDAF ID or ADRF ID) with the DCCF. The DCCF may then determine whether certain historical analytics data may be available in the NWDAF or ADRF based on the analytics data profile and the request time window. + +If the historical analytics data handling is not applicable or not supported, the DCCF shall proceed step 3a, skip step 3b, step 4b, step 5b, step 3c, step 4c and step 5c. + +If the historical analytics data is available in an ADRF, the DCCF shall proceed step 3a and step 3b, skip step 3c, step 4c and step 5c. + +If the historical analytics data is available in an NWDAF, the DCCF shall proceed step 3a and step 3c, skip step 3b, step 4b and step 5b. + +3a. The DCCF shall determine whether the analytics requested are already being collected. + +If the requested analytics are already being collected by an NF service consumer, the DCCF adds the new NF service consumer to the list of NF service consumers that are subscribed for these analytics. + +If the DCCF cannot handle the subscription request, shall take the error handling as defined in clause 4.2.2.2.2 of 3GPP TS 29.574 [15] + +If the DCCF determines that no subscriptions need to be created or modified (e.g. because all the data can be made available either via pre-existing subscriptions or because of the historical data handling) then step 4a and step 5a are skipped. + +3aa. The DCCF may respond to the Ndcf\_DataManagement\_Subscribe service operation with HTTP "201 Created" status code with the message body containing a representation of the created subscription if the DCCF add the new NF service consumer to the list of NF service consumers that are subscribed, or if error case happened may respond with corresponding error information. + +4a If the analytics requested at step 1 are not already available yet, the DCCF shall invoke the Nnwdaf\_EventsSubscription\_Subscribe service operation by sending an HTTP POST request message request to the NWDAF targeting the resource "NWDAF Events Subscriptions" to subscribe to a new analytics exposure subscription, or if the analytics subscribed in step 1 partially matches an analytics that is already being collected by the DCCF from an NWDAF, and a modification of this subscription to the NWDAF would satisfy both the existing analytics subscriptions as well as the newly requested analytics, by sending an HTTP PUT request to the resource "Individual Analytics Exposure Subscription" to replace an existing analytics exposure subscription. The request includes the subscribed event(s) and event filter information received from the NF service consumer, mapping to the parameters as defined in clause 5.1 of 3GPP TS 29.520 [5]. + +NOTE: If the NWDAF instance or NWDAF Set is not identified by the NF service consumer, the DCCF determines the NWDAF instances that can provide analytics. If the consumer requested storage of analytics in an ADRF but an ADRF ID is not provided by the NF service consumer, or the collected analytics is to be stored in an ADRF according to configuration on the DCCF, the DCCF selects an ADRF to store the collected analytics data. + +5a The NWDAF responds to the Nnwdaf\_EventsSubscription\_Subscribe service operation. + +Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NWDAF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +Upon receipt of the HTTP PUT request, if the subscription is accepted to be updated, the NWDAF responds to the DCCF with "200 OK" or "204 No Content" status code. + +3b If the historical analytics data handling is applicable, and the DCCF determine to retrieve analytics data from the ADRF, the DCCF shall determine which ADRF instances might provide the analytics. + +4b In order to retrieve the historical analytics data from the ADRF, the DCCF shall invoke the Nadrf\_DataManagement\_RetrievalSubscribe service operation by sending an HTTP POST request message targeting the resource "ADRF Data Retrieval Subscriptions", the HTTP POST message shall include the NadrfDataRetrievalSubscription data structure as request body with parameters as defined in clause 5.1.6 of 3GPP TS 29.575 [16]. + +5b The ADRF responds to the Nadrf\_DataManagement\_RetrievalSubscribe service operation. + +Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the ADRF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +- 3c If the historical analytics data handling is applicable, and the DCCF determine to retrieve analytics data from the NWDAF, the DCCF shall determine which NWDAF instances might provide the analytics as described and proceed step 4c. +- 4c In order to retrieve the historical analytics data from the NWDAF, the DCCF may invoke the Nnwdaf\_EventsSubscription\_Subscribe service operation by sending an HTTP POST request message targeting the resource "NWDAF Events Subscriptions", the HTTP POST message shall include the NnwdafEventsSubscription data structure as request body with parameters as defined in clause 5.1.6 of 3GPP TS 29.520 [5] or Nnwdaf\_AnalyticsInfo\_Request request by sending an HTTP GET request message targeting the resource "NWDAF Analytics" with parameters as defined in clause 5.2.3.2.3.1 of 3GPP TS 29.520 [5]. +- 5c The NWDAF responds to the Nnwdaf\_EventsSubscription\_Subscribe or Nnwdaf\_AnalyticsInfo\_Request service operation. + +Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NWDAF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +6. The DCCF responds to the Ndcf\_DataManagement\_Subscribe service operation with HTTP "201 Created" status code with the message body containing a representation of the created subscription. +- 7a. (conditional) When the analytics are available, the NWDAF invokes the Nnwdaf\_EventsSubscription\_Notify service operation by sending an HTTP POST request message to notify the analytics information to the DCCF. +- 8a. The DCCF responds to the Nnwdaf\_EventsSubscription\_Notify service operation with HTTP "204 No Content" status code. +- 7b. (conditional) When the historical analytics data are available in the ADRF, the ADRF shall invoke the Nadrf\_DataManagement\_RetrievalNotify service operation by sending an HTTP POST request message to notify the historical analytics or Fetch Instructions to the DCCF. +- 8b. The DCCF responds to the Nadrf\_DataManagement\_RetrievalNotify service operation with HTTP "204 No Content" status code. +- 7c. (conditional) When the historical analytics data are available in the NWDAF, the NWDAF may invoke the Nnwdaf\_EventsSubscription\_Notify service operation by sending an HTTP POST request message to notify the historical analytics data to the DCCF. +- 8c. The DCCF responds to the Nnwdaf\_EventsSubscription\_Notify service operation with HTTP "204 No Content" status code. +9. Upon the delivery option "Delivery via DCCF" configured on the DCCF, the DCCF invokes the Ndcf\_DataManagement\_Notify service operation by sending HTTP POST request message(s) to send the analytics data to all notification endpoints indicated in step 1. Analytics sent to notification endpoints may be processed and formatted by the DCCF so they conform to delivery requirements for each NF service consumer or notification endpoint. + +NOTE: According to Formatting Instructions provided by the NF service consumer, multiple notifications from a NWDAF can be combined in a single Ndcf\_DataManagement\_Notify so many notifications from an NWDAF results in fewer notifications (or one notification) to the NF service consumer. Alternatively, a notification can instruct the analytics notification endpoint to fetch the analytics from the DCCF. + +10. The NF service consumer responds to the Ndcf\_DataManagement\_Notify service operation with HTTP "204 No Content" status code. +11. (conditional) The NF service consumer invokes the Ndcf\_DataManagement\_Fetch service operation by sending an HTTP GET request message to fetch the analytics from the DCCF before an expiry time, if received the fetch instruction in NdcfDataManagement\_Notify service operation in step 9. + +12. The NF service consumer responds to the Ndcf\_DataManagement\_Fetch service operation with HTTP "204 No Content" status code. +13. When the NF service consumer no longer need the subscription to the analytics requested in step 1, shall invoke the Ndcf\_DataManagement\_Unsubscribe service operation by sending an HTTP DELETE request message with "{xxx}" as Resource URI, where "{subscriptionId}" is the event subscriptionId of the existing subscription that is to be deleted., using the Subscription Correlation Id received in response to its subscription in step 1. The DCCF removes the NF service consumer from the list of NF service consumers that are subscribed for these analytics. +14. The DCCF responds to the Ndcf\_DataManagement\_Unsubscribe service operation with HTTP "204 No Content" status code, upon removed the NF service consumer from the list of NF service consumers that are subscribed for these analytics +- 15a. If there are no other NF service consumers subscribed to the analytics, the DCCF invokes the Nnwdaf\_EventsSubscription\_Unsubscribe service operation by sending an HTTP DELETE request message to the NWDAF. +- 16a. The NWDAF responds to the Nnwdaf\_EventsSubscription\_Unsubscribe service operation with HTTP "204 No Content" status code, upon the analytics event(s) subscription is removed. +- 15b. If DCCF determines that no other NF service consumers requiring the historical analytics data from the ADRF, the DCCF may invoke the Nadrf\_DataManagement\_RetrievalUnSubscribe service operation by sending an HTTP DELETE request message to the ADRF. +- 16b. The ADRF responds to the Nadrf\_DataManagement\_RetrievalUnSubscribe service operation with HTTP "204 No Content" status code, upon the analytics data retrieval subscription is removed. + +### 5.2.5 Analytics Exposure via DCCF and MFAF + +This procedure is used by NF service consumer(s) based on local configuration, to subscribe/unsubscribe to NWDAF analytics event(s) via the DCCF, and upon the delivery option "Delivery via Messaging Framework " configured on the DCCF, the 3GPP DCCF Adaptor (3da) Data Management service and 3GPP Consumer Adaptor (3ca) Data Management service of the Messaging Framework Adaptor Function (MFAF) are used to interact with the 3GPP Network and the Messaging Framework for analytics information delivery to the NF service consumer(s) subscribed notification endpoint(s). + +![Sequence diagram showing Analytics Exposure via DCCF and Messaging Framework. Lifelines: NF service consumer, DCCF, MFAF, ADRF, NWDAF. The diagram is divided into three main sections: Subscription, Data Fetch, and Unsubscribe. It details the message exchanges between the consumer and the network functions for analytics data handling.](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant DCCF + participant MFAF + participant ADRF + participant NWDAF + + Note left of DCCF: 4. Determine whether historical analytics data handling is applicable or not + Note left of DCCF: 5a. Determine whether the requested analytics data is already being collected + + Note left of DCCF: 5b. If historical analytics data handling is applicable, and DCCF determine to retrieve data from ADRF Instance + Note left of DCCF: 5c. If historical analytics data handling is applicable, and DCCF determine to retrieve analytics data from NWDAF + + Note left of NF: Data Fetch + Note left of NF: Unsubscribe + + NF->>DCCF: 1. Ndccf_DataManagement_Subscribe request + DCCF->>MFAF: 2. Nmfaf_3daDataManagement_Configure request + MFAF-->>DCCF: 3. Nmfaf_3daDataManagement_Configure response + DCCF-->>NWDAF: 6a. Nnwdaf_EventsSubscription request + NWDAF-->>DCCF: 7a. Nnwdaf_EventsSubscription response + DCCF-->>ADRF: 6b. Nadrf_DataManagement_RetrievalSubscribe request + ADRF-->>DCCF: 7b. Nadrf_DataManagement_RetrievalSubscribe response + DCCF-->>NWDAF: 6c. Nnwdaf_EventsSubscription_Subscribe request or Nnwdaf_AnalyticsInfo_Request request + NWDAF-->>DCCF: 7c. Nnwdaf_EventsSubscription_Subscribe response or Nnwdaf_AnalyticsInfo_Request response + DCCF-->>NF: 8. Ndccf_DataManagement_Subscribe response + MFAF-->>NWDAF: 9a. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>MFAF: 10a. Nnwdaf_EventsSubscription_Notify response + MFAF-->>NF: 11a. Nmfaf_3caDataManagement_Notify request + NF-->>MFAF: 12a. Nmfaf_3caDataManagement_Notify response + MFAF-->>ADRF: 9b. Nadrf_DataManagement_RetrievalNotify request + ADRF-->>MFAF: 10b. Nadrf_DataManagement_RetrievalNotify response + MFAF-->>NF: 11b. Nmfaf_3caDataManagement_Notify request + NF-->>MFAF: 12b. Nmfaf_3caDataManagement_Notify response + MFAF-->>NWDAF: 9c. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>MFAF: 10c. Nnwdaf_EventsSubscription_Notify response + MFAF-->>NF: 11c. Nmfaf_3caDataManagement_Notify request + NF-->>MFAF: 12c. Nmfaf_3caDataManagement_Notify response + NF-->>MFAF: 13. Nmfaf_3caDataManagement_Fetch Request + MFAF-->>NF: 14. Nmfaf_3caDataManagement_Fetch response + NF->>DCCF: 15. Ndccf_DataManagement_Unsubscribe request + DCCF-->>NF: 16. Ndccf_DataManagement_Unsubscribe response + DCCF-->>NWDAF: 17a. Nnwdaf_EventsSubscription_Unsubscribe request + NWDAF-->>DCCF: 18a. Nnwdaf_EventsSubscription_Unsubscribe response + DCCF-->>ADRF: 17b. Nadrf_DataManagement_RetrievalUnsubscribe request + ADRF-->>DCCF: 18b. Nadrf_DataManagement_RetrievalUnsubscribe response + DCCF-->>MFAF: 17c. Nmfaf_3daDataManagement_Deconfigure request + MFAF-->>DCCF: 18c. Nmfaf_3daDataManagement_Deconfigure response + +``` + +Sequence diagram showing Analytics Exposure via DCCF and Messaging Framework. Lifelines: NF service consumer, DCCF, MFAF, ADRF, NWDAF. The diagram is divided into three main sections: Subscription, Data Fetch, and Unsubscribe. It details the message exchanges between the consumer and the network functions for analytics data handling. + +Figure 5.2.5-1: Analytics Exposure via DCCF and Messaging Framework + +1. In order to subscribe to notification(s) of analytics exposure via the DCCF based on local configuration, the NF service consumer invokes the Ndcf\_DataManagement\_Subscribe service operation by sending an HTTP POST request message targeting the resource "DCCF Analytics Subscriptions", the HTTP POST message shall include the NdcfAnalyticsSubscription data structure as request body with parameters as defined in clause 5.1.6.2.2 of 3GPP TS 29.574 [15]. +2. Upon the delivery option "Delivery via MFAF" configured on the DCCF, in order to create configuration of mapping data in the MFAF, the DCCF shall invoke the Nmfa\_3daDataManagement\_Configure service operation by sending an HTTP POST request message targeting the resource "MFAF Configurations", the HTTP POST message shall include the MfafConfiguration data structure as request body with parameters as defined in clause 5.1.6 of 3GPP TS 29.576 [17]. +3. The MFAF responds to the Nmfa\_3daDataManagement\_Configure service operation. + +Upon receipt of the HTTP POST request, if the configuration is accepted to be created, the MFAF responds to the DCCF with "201 Created", and the URI of the created configuration is included in the Location header field. + +4. The DCCF keeps track of the analytics actively being collected for the Analytics Subscription it is coordinating. The NWDAF or ADRF may register the analytics data profile (may include the analytics data collection related service operation, Analytics Specification, NWDAF ID or ADRF ID) with the DCCF. The DCCF may then determine whether certain historical analytics data may be available in the NWDAF or ADRF based on the analytics data profile and the request time window. + +If the historical analytics data handling is not applicable or not supported, the DCCF shall proceed step 5a, skip step 5b step 6b, step 7b, step 5c step 6c and step 7c. + +If the historical analytics data is available in an ADRF, the DCCF shall proceed step 5a and step 5b, skip step 5c, step 6c and step 7c. + +If the historical data is available in an NWDAF, the DCCF shall proceed step 5a and step 5c, skip step 5b, step 6b and step 7b. + +- 5a. The DCCF shall determine whether the analytics data requested in step 1 are already being collected. + +If the analytics data requested are already being collected by an NF service consumer, the DCCF adds the NF service consumer to the list of analytics consumers that are subscribed for these data. + +If the DCCF cannot handle the subscription request, shall take the error handling as defined in clause 4.2.2.2.2 of 3GPP TS 29.574 [15] + +If the DCCF determines that no subscriptions need to be created or modified (e.g. because all the data can be made available either via pre-existing subscriptions or because of the historical data handling) then step 6a and step 7a are skipped. + +- 5aa. The DCCF may respond to the Ndcf\_DataManagement\_Subscribe service operation with HTTP "201 Created" status code with the message body containing a representation of the created subscription if the DCCF adds the new NF service consumer to the list of NF service consumers that are subscribed, or if error case happened may respond with corresponding error information. + +- 6a If the requested data at step 1 are not already available yet, the DCCF shall invoke the Nnwda\_EventsSubscription\_Subscribe service operation by sending an HTTP POST request message request to the NWDAF targeting the resource "NWDAF Events Subscriptions" to subscribe to a new analytics exposure subscription, or if the analytics subscribed in step 1 partially matches an analytics that is already being collected by the DCCF from an NWDAF, and a modification of this subscription to the NWDAF would satisfy both the existing analytics subscriptions as well as the newly requested analytics, by sending an HTTP PUT request to the resource "Individual Analytics Exposure Subscription" to replace an existing analytics exposure subscription. The request includes the subscribed event(s) and event filter information received from the NF service consumer, mapping to the parameters as defined in clause 5.1 of 3GPP TS 29.520 [5]. + +NOTE 1: If the NWDAF instance or NWDAF Set is not identified by the NF service consumer, the DCCF determines the NWDAF instances that can provide analytics. If the consumer requested storage of analytics in an ADRF but an ADRF ID is not provided by the NF service consumer, or the collected analytics is to be stored in an ADRF according to configuration on the DCCF, the DCCF selects an ADRF to store the collected data. + +7a The NWDAF responds to the Nnwdaf\_EventsSubscription\_Subscribe service operation. + +Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NWDAF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +Upon receipt of the HTTP PUT request, if the subscription is accepted to be updated, the NWDAF responds to the DCCF with "200 OK" or "204 No Content" status code. + +5b If the historical analytics data handling is applicable, and the DCCF determine to retrieve analytics data from the ADRF, the DCCF shall determine which ADRF instances might provide the analytics. + +6b In order to retrieve the historical analytics data from the ADRF, the DCCF shall invoke the Nadrf\_DataManagement\_RetrievalSubscribe service operation by sending an HTTP POST request message targeting the resource "ADRF Data Retrieval Subscriptions", the HTTP POST message shall include the NadrfDataRetrievalSubscription data structure as request body with parameters as defined in clause 5.1.6 of 3GPP TS 29.575 [16]. + +7b The ADRF responds to the Nadrf\_DataManagement\_RetrievalSubscribe service operation. + +Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the ADRF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +5c If the historical data handling is applicable, and the DCCF determines to retrieve analytics data from the NWDAF, the DCCF shall determine which NWDAF instances might provide the analytics as described and proceed step 6c. + +6c In order to retrieve the historical analytics data from the NWDAF, the DCCF may invoke the Nnwdaf\_EventsSubscription\_Subscribe service operation by sending an HTTP POST request message targeting the resource "NWDAF Events Subscriptions", the HTTP POST message shall include the NnwdafEventsSubscription data structure as request body with parameters as defined in clause 5.1.6 of 3GPP TS 29.520 [5] or Nnwdaf\_AnalyticsInfo\_Request request by sending an HTTP GET request message targeting the resource "NWDAF Analytics" with parameters as defined in clause 5.2.3.2.3.1 of 3GPP TS 29.520 [5]. + +7c The NWDAF responds to the Nnwdaf\_EventsSubscription\_Subscribe or Nnwdaf\_AnalyticsInfo\_Request service operation. + +Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NWDAF responds to the DCCF with "201 Created", and the URI of the created subscription is included in the Location header field. + +8. The DCCF responds to the Ndccf\_DataManagement\_Subscribe service operation with HTTP "201 Created" status code with the message body containing a representation of the created subscription. + +9a. (conditional) When the analytics are available, the NWDAF invokes the Nnwdaf\_EventsSubscription\_Notify service operation by sending an HTTP POST request message to notify the analytics information to the MFAF. + +10a. The MFAF responds to the Nnwdaf\_EventsSubscription\_Notify service operation with HTTP "204 No Content" status code. + +11a. The MFAF invokes the Nmmaf\_3caDataManagement\_Notify service operation by sending HTTP POST request message(s) to send the analytics data to all notification endpoints indicated in step 1. Analytics data sent to notification endpoints may be processed and formatted by the MFAF so that they conform to delivery requirements for each NF service consumer and/or notification endpoint. + +NOTE 2: According to Formatting Instructions provided by the NF service consumer, multiple notifications from the NWDAF can be combined in a single Nmmaf\_3caDataManagement\_Notify so that many notifications from an NWDAF result in fewer notifications (or one notification) to the NF service consumer and/or the subscribed notification endpoint(s). Alternatively, a notification can instruct the analytics data notification endpoint to fetch the analytics data from the MFAF. + +12a. The NF service consumer responds to the Nmmaf\_3caDataManagement\_Notify service operation with HTTP "204 No Content" status code. + +9b. (conditional) When the historical analytics data are available in the ADRF, the ADRF shall invoke the Nadrf\_DataManagement\_RetrievalNotify service operation by sending an HTTP POST request message to notify the historical analytics or Fetch Instructions to the MFAF. + +10b. The MFAF responds to the Nadrf\_DataManagement\_RetrievalNotify service operation with HTTP "204 No Content" status code. + +11b. The MFAF invokes the Nmfaf\_3caDataManagement\_Notify service operation by sending HTTP POST request message(s) to send the analytics data to all notification endpoints indicated in step 1. Analytics data sent to notification endpoints may be processed and formatted by the MFAF so that they conform to delivery requirements for each NF service consumer or notification endpoint. + +NOTE 3: According to Formatting Instructions provided by the NF service consumer, multiple notifications from an ADRF can be combined in a single Nmfaf\_3caDataManagement\_Notify so many notifications from an ADRF results in fewer notifications (or one notification) to the NF service consumer and/or the subscribed notification endpoint(s). Alternatively, a notification can instruct the analytics data notification endpoint to fetch the analytics data from the MFAF. + +12b. The NF service consumer responds to the Nmfaf\_3caDataManagement\_Notify service operation with HTTP "204 No Content" status code. + +9c. (conditional) When the historical analytics data are available in the NWDAF, the NWDAF may invoke the Nnwdaf\_EventsSubscription\_Notify service operation by sending an HTTP POST request message to notify the historical analytics data to the MFAF. + +10c. The MFAF responds to the Nnwdaf\_EventsSubscription\_Notify service operation with HTTP "204 No Content" status code. + +11c. The MFAF invokes the Nmfaf\_3caDataManagement\_Notify service operation by sending HTTP POST request message(s) to send the analytics data to all notification endpoints indicated in step 1. Analytics data sent to notification endpoints may be processed and formatted by the MFAF so they conform to delivery requirements for each NF service consumer or notification endpoint. + +NOTE 4: According to Formatting Instructions provided by the NF service consumer, multiple notifications from a NWDAF can be combined in a single Nmfaf\_3caDataManagement\_Notify so many notifications from a NWDAF results in fewer notifications (or one notification) to the NF service consumer and/or the subscribed notification endpoint(s). Alternatively, a notification can instruct the analytics data notification endpoint to fetch the analytics data from the MFAF. + +12c. The NF service consumer responds to the Nmfaf\_3caDataManagement\_Notify service operation with HTTP "204 No Content" status code. + +13. (conditional) The NF service consumer invoke the Nmfaf\_3caDataManagement\_Fetch service operation by sending an HTTP GET request message to fetch the data from the MFAF before an expiry time, if received the fetch instruction in Nmfaf\_3caDataManagement\_Notify service operation in step 11a, step 11b or step 11c. + +14. The MFAF responds to the Nmfaf\_3caDataManagement\_Fetch service operation with HTTP "200 OK" status code with the message body containing the NmfafResourceRecord data structure. + +15. When the NF service consumer no longer need the subscription to the requested data in step 1, shall invoke the Ndccf\_DataManagement\_Unsubscribe service operation by sending an HTTP DELETE request message with "{apiRoot}/nnwda-f-data-management/v1/subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscriptionId of the existing subscription that is to be deleted., using the Subscription Correlation Id received in response to its subscription in step 1. The DCCF removes the NF service consumer from the list of NF service consumers that are subscribed for these analytics data. + +16. The DCCF responds to the Ndccf\_DataManagement\_Unsubscribe service operation with HTTP "204 No Content" status code, upon removed the NF service consumer from the list of NF service consumers that are subscribed for these analytics data. + +17a. If there are no other NF service consumers subscribed to the analytics data, the DCCF invoke the Nnwdaf\_EventsSubscription\_Unsubscribe service operation by sending an HTTP DELETE request message to the NWDAF. + +- 18a. The DWDAF responds to the Nnwdaf\_EventsSubscription\_Unsubscribe service operation with HTTP "204 No Content" status code, upon the analytics event(s) subscription is removed. +- 17b. If DCCF determines that no other NF service consumers requiring the historical analytics data from the ADRF, the DCCF may invoke the Nadrf\_DataManagement\_RetrievalUnSubscribe service operation by sending an HTTP DELETE request message to the ADRF. +- 18b. The ADRF responds to the Nadrf\_DataManagement\_RetrievalUnSubscribe service operation with HTTP "204 No Content" status code, upon the data retrieval subscription is removed. +- 17c. When DCCF determines that NF service consumer mapping has to be removed from MFAF, the DCCF may invoke the Nmfa\_3daDataManagement\_Deconfigure service operation by sending an HTTP DELETE request message to the MFAF. +- 18c. The MFAF responds to the Nmfa\_3daDataManagement\_Deconfigure service operation with HTTP "204 No Content" status code, upon removing the individual resource linked to the delete request. + +### 5.2.6 Procedure for Analytics Exposure in Roaming Case + +#### 5.2.6.1 Analytics Exposure from HPLMN to VPLMN for inbound roaming users + +The procedure depicted in Figure 5.2.6.1-1 is used by the V-RE-NWDAF as service consumer to subscribe/unsubscribe to notifications about analytics exposure from the HPLMN for inbound roaming users. + +![Sequence diagram showing the procedure for analytics exposure from HPLMN to VPLMN for inbound roaming users. Lifelines: NF in VPLMN, V-RE-NWDAF, H-RE-NWDAF, Other H-NWDAF(s). The process involves subscription requests, data collection in HPLMN, responses, and subsequent data collection in VPLMN.](8d325fc12b494e42c9ea7ed2a7f327a6_img.jpg) + +``` + +sequenceDiagram + participant NF as NF in VPLMN + participant VRE as V-RE-NWDAF + participant HRE as H-RE-NWDAF + participant OtherH as Other H-NWDAF(s) + + Note right of HRE: 3. H-RE-NWDAF collects data in HPLMN and derives analytics + Note right of VRE: 5. V-RE-NWDAF collects data in VPLMN and derives analytics + + NF->>VRE: 1. Nnwdaf_AnalyticsInfo_Request request/ +Nnwdaf_EventsSubscription_Subscribe request + VRE->>HRE: 2. Nnwdaf_RoamingAnalytics_Request request/ +Nnwdaf_RoamingAnalytics_Subscribe request + HRE-->>VRE: 3a1. Nnwdaf_RoamingAnalytics_Request response/ +Nnwdaf_RoamingAnalytics_Subscribe response + VRE-->>NF: 3a2. Nnwdaf_AnalyticsInfo_Request response/ +Nnwdaf_EventsSubscription_Subscribe response + VRE->>OtherH: 3b. Nnwdaf_AnalyticsInfo_Request request/ +Nnwdaf_EventsSubscription_Subscribe request + OtherH-->>VRE: 3c. Nnwdaf_AnalyticsInfo_Request response/ +Nnwdaf_EventsSubscription_Subscribe response/ +Nnwdaf_EventsSubscription_Notify request + HRE-->>VRE: 4. Nnwdaf_RoamingAnalytics_Request response/ +Nnwdaf_RoamingAnalytics_Subscribe response/ +Nnwdaf_RoamingAnalytics_Notify request + VRE-->>NF: 6. Nnwdaf_AnalyticsInfo_Request response/ +Nnwdaf_EventsSubscription_Subscribe response/ +Nnwdaf_EventsSubscription_Notify request + +``` + +Sequence diagram showing the procedure for analytics exposure from HPLMN to VPLMN for inbound roaming users. Lifelines: NF in VPLMN, V-RE-NWDAF, H-RE-NWDAF, Other H-NWDAF(s). The process involves subscription requests, data collection in HPLMN, responses, and subsequent data collection in VPLMN. + +Figure 5.2.6.1-1: Procedure for analytics exposure from HPLMN to VPLMN + +- 1. The consumer NF in VPLMN (e.g. AMF) discovers a V-RE-NWDAF as described in clause 5.2.8.3 and invoke Nnwdaf\_AnalyticsInfo\_Request or Nnwdaf\_EventsSubscription\_Subscribe service operation to the V-RE-NWDAF. For the inbound roaming user(s) indicated in the Target of Analytics Reporting, V-RE-NWDAF + +determines based on operator configuration and the requested analytics whether analytics from the HPLMN are required, or the analytics can be derived locally. + +NOTE 1: It is possible that the Target of Analytics Reporting sent by the Consumer NF to the V-RE-NWDAF includes both inbound roaming user(s) and non-roaming user(s). + +2. The V-RE-NWDAF checks the roaming agreements related to analytics from HPLMN to determine if the roaming analytics request/subscribe can be accepted or must be rejected. If the request is rejected, the following steps are skipped. + +The V-RE-NWDAF discovers a H-RE-NWDAF as described in clause 5.8.2.3 then invoke Nnwdaf\_RoamingAnalytics\_Request or Nnwdaf\_RoamingAnalytics\_Subscribe service operation as described in clause 4.9.2.2 and clause 4.9.2.3 of 3GPP TS 29.520 [5], based on the Analytics request/subscribe received from the Consumer NF in VPLMN. The Target of Analytics Reporting sent by the V-RE-NWDAF to the H-RE-NWDAF only contains the inbound roaming user(s). + +NOTE 2: The inbound roaming user(s) are distinguished by the V-RE-NWDAF according to UE ID(s) (i.e. SUPI(s)). + +3. The H-RE-NWDAF checks the roaming agreements between the HPLMN and the VPLMN, and user consent for analytics if needed, to determine if the roaming analytics request/subscribe can be accepted or must be rejected. If the roaming analytics request/subscribe is rejected, the following steps are skipped. +- 3a If the H-RE-NWDAF supports to generate the requested analytics, it collects data from the NF(s) and/or OAM in HPLMN and derives the requested analytics, respond with Nnwdaf\_RoamingAnalytics\_Request response or Nnwdaf\_RoamingAnalytics\_Subscribe response to the V-RE-NWDAF then responds to the consumer NF; otherwise steps 3b and 3c are executed. +- 3b-3c. [Optional] If the H-RE-NWDAF does not support to generate the requested analytics, it may request/subscribe to other NWDAF(s) in the HPLMN (if available) by invoking Nnwdaf\_AnalyticsInfo\_Request or Nnwdaf\_EventsSubscription\_Subscribe service operation for the analytics and get corresponding response/notification by Nnwdaf\_AnalyticsInfo\_Request response, Nnwdaf\_EventsSubscription\_Subscribe response or Nnwdaf\_EventsSubscription\_Notify service operation. +4. The H-RE-NWDAF sends the HPLMN analytics information to the V-RE-NWDAF using either Nnwdaf\_RoamingAnalytics\_Request response, Nnwdaf\_RoamingAnalytics\_Subscribe response or Nnwdaf\_RoamingAnalytics\_Notify request message as described in clause 4.9.2.2 and clause 4.9.2.3 of 3GPP TS 29.520 [5], depending on the service used in step 2. The H-RE-NWDAF may restrict the exposed analytics information based on HPLMN operator policies. +5. If the Consumer NF also indicates request or subscription of analytics information available in the VPLMN (e.g. via Target of Analytics Reporting) in step 1, the V-RE-NWDAF collects data from the NF(s) and/or OAM in VPLMN and derives the requested analytics. +6. The V-RE-NWDAF sends the HPLMN analytics information received in step 4, or the aggregated analytics information if step 5 are performed, to the Consumer NF in VPLMN using either Nnwdaf\_AnalyticsInfo\_Request response, Nnwdaf\_EventsSubscription\_Subscribe or Nnwdaf\_EventsSubscription\_Notify request message described in clause 4.2.2 of 3GPP TS 29.520 [5] depending on the service used in step 1. + +NOTE 3: The present document describes that the RE-NWDAF may perform analytics aggregation for roaming scenario, but whether and how the RE-NWDAF performs analytics aggregation for roaming scenario are up to implementation. + +NOTE 4: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify, Nnwdaf\_AnalyticsInfo\_Request and/or Nnwdaf\_RoamingAnalytics\_Subscribe/Unsubscribe/Notify/Request service operations refer to 3GPP TS 29.520 [5]. + +#### 5.2.6.2 Analytics Exposure from VPLMN to HPLMN for outbound roaming users + +The procedure depicted in Figure 5.2.6.2-1 is used by the H-RE-NWDAF as service consumer to subscribe/unsubscribe to notifications about analytics exposure from the VPLMN for outbound roaming users. + +![Sequence diagram illustrating the procedure for analytics exposure from VPLMN to HPLMN. Lifelines: NF in HPLMN, H-RE-NWDAF, V-RE-NWDAF, Other V-NWDAF(s).](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +``` + +sequenceDiagram + participant NF as NF in HPLMN + participant H-RE-NWDAF as H-RE-NWDAF + participant V-RE-NWDAF as V-RE-NWDAF + participant OtherV-NWDAF as Other V-NWDAF(s) + + Note right of V-RE-NWDAF: 3a. V-RE-NWDAF collects data in VPLMN and derives analytics + Note right of H-RE-NWDAF: 5. H-RE-NWDAF collects data in HPLMN and derives analytics + + NF->>H-RE-NWDAF: 1. Nnwdaf_AnalyticsInfo_Request request/ +Nnwdaf_EventsSubscription_Subscribe request + H-RE-NWDAF->>V-RE-NWDAF: 2. Nnwdaf_RoamingAnalytics_Request request/ +Nnwdaf_RoamingAnalytics_Subscribe request + V-RE-NWDAF-->>H-RE-NWDAF: 3a1. Nnwdaf_RoamingAnalytics_Request response/ +Nnwdaf_RoamingAnalytics_Subscribe response + H-RE-NWDAF-->>NF: 3a2. Nnwdaf_AnalyticsInfo_Request response/ +Nnwdaf_EventsSubscription_Subscribe response + V-RE-NWDAF->>OtherV-NWDAF: 3b. Nnwdaf_AnalyticsInfo_Request request/ +Nnwdaf_EventsSubscription_Subscribe request + OtherV-NWDAF-->>V-RE-NWDAF: 3c. Nnwdaf_AnalyticsInfo_Request response/ +Nnwdaf_EventsSubscription_Subscribe response/ +Nnwdaf_EventsSubscription_Notify request + V-RE-NWDAF-->>H-RE-NWDAF: 4. Nnwdaf_RoamingAnalytics_Request response/ +Nnwdaf_RoamingAnalytics_Subscribe response/ +Nnwdaf_RoamingAnalytics_Notify request + H-RE-NWDAF-->>NF: 6. Nnwdaf_AnalyticsInfo_Request response/ +Nnwdaf_EventsSubscription_Subscribe response/ +Nnwdaf_EventsSubscription_Notify request + +``` + +Sequence diagram illustrating the procedure for analytics exposure from VPLMN to HPLMN. Lifelines: NF in HPLMN, H-RE-NWDAF, V-RE-NWDAF, Other V-NWDAF(s). + +**Figure 5.2.6.2-1: Procedure for analytics exposure from VPLMN to HPLMN** + +- Upon the Consumer NF is aware that the UE(s) indicated in Target of Analytics Reporting is/are roaming, Consumer NF in HPLMN (e.g. H-PCF) discovers a H-RE-NWDAF as described in clause 5.2.8.3 and invoking a Nnwdaf\_AnalyticsInfo\_Request or a Nnwdaf\_EventsSubscription\_Subscribe service operation. For the outbound roaming user(s) indicated in the Target of Analytics Reporting, the H-RE-NWDAF determines based on operator configuration and the requested analytics whether analytics or input data from the VPLMN are required, or the analytics can be derived locally. + +NOTE 1: It is possible that the Target of Analytics Reporting sent by the Consumer NF to the H-RE-NWDAF includes both outbound roaming user(s) and non-roaming user(s). + +NOTE 2: The H-NWDAF is not depicted in the flow. + +- The H-RE-NWDAF checks user consent and roaming agreements between the HPLMN and the VPLMN to determine if the roaming analytics request/subscription can be accepted or must be rejected. If the request is rejected, the following steps are skipped. + +The H-RE-NWDAF discovers the V-RE-NWDAF as described in clause 5.2.8.3. + +The H-RE-NWDAF invoke a Nnwdaf\_RoamingAnalytics\_Request or a Nnwdaf\_RoamingAnalytics\_Subscribe service operation, based on the Analytics request/subscribe received from the Consumer NF in HPLMN. The Target of Analytics Reporting sent by the H-RE-NWDAF to the V-RE-NWDAF only contains the outbound roaming user(s). + +- The V-RE-NWDAF checks the roaming agreements between the HPLMN and the VPLMN, to determine if the roaming analytics request/subscribe can be accepted or must be rejected. If the roaming analytics request/subscribe is rejected, the following steps are skipped. + +If the V-RE-NWDAF supports to generate the requested analytics, it collects data from the NF(s) serving the roaming UE(s) and/or OAM in VPLMN and derives the analytics; otherwise steps 3b and 3c are executed. + +3a1-3a2 The V-RE-NWDAF may respond with Nnwdaf\_RoamingAnalytics\_Request response or Nnwdaf\_RoamingAnalytics\_Subscribe response to the H-RE-NWDAF then responds to the consumer NF; otherwise steps 3b and 3c are executed. + +3b-3c. If the V-RE-NWDAF does not support to generate the requested analytics, it may request/subscribe to other NWDAF(s) in the VPLMN (if available) for the analytics and get corresponding response/notification(s) by invoking Nnwdaf\_AnalyticsInfo\_Request or Nnwdaf\_EventsSubscription\_Subscribe service operation for the analytics and get corresponding response/notification by Nnwdaf\_AnalyticsInfo\_Request response, Nnwdaf\_EventsSubscription\_Subscribe response or Nnwdaf\_EventsSubscription\_Notify service operation. + +4. The V-RE-NWDAF may send the VPLMN analytics information to the H-RE-NWDAF using either Nnwdaf\_RoamingAnalytics\_Request response, Nnwdaf\_RoamingAnalytics\_Subscribe or Nnwdaf\_RoamingAnalytics\_Notify request message as described in clause 4.9.2.2 and clause 4.9.2.3 of 3GPP TS 29.520 [5], depending on the service used in step 2. The V-RE-NWDAF may restrict the exposed analytics information based on VPLMN operator policies. + +5. If the Consumer NF also indicates request or subscription of analytics information available in the HPLMN (e.g. via Target of Analytics Reporting) in step 1, H-RE-NWDAF collects data from the NF(s) and/or OAM in HPLMN and derives the analytics. These steps can be executed in parallel with steps 3-6. The H-RE-NWDAF may perform analytics aggregation with the analytics information received from the V-RE-NWDAF and analytics information generated by itself, based on the analytics request or subscription. + +6. H-RE-NWDAF sends the VPLMN analytics information received in step 4, or the aggregated analytics information if step 5 are performed, to the Consumer NF in HPLMN using either Nnwdaf\_AnalyticsInfo\_Request response, Nnwdaf\_EventsSubscription\_Subscribe response or Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 4.2.2 of 3GPP TS 29.520 [5] depending on the service used in step 1, depending on the service used in step 1. + +NOTE 3: The present document describes that the RE-NWDAF may perform analytics aggregation for roaming scenario, but whether and how the RE-NWDAF performs analytics aggregation for roaming scenario are up to implementation. + +NOTE 4: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify, Nnwdaf\_AnalyticsInfo\_Request and/or Nnwdaf\_RoamingAnalytics\_Subscribe/Unsubscribe/Notify/Request service operations refer to 3GPP TS 29.520 [5]. + +## 5.3 Analytics Aggregation from Multiple NWDAFs + +### 5.3.1 General + +Analytics Aggregation refers to the case in which an NWDAF with respective capabilities aggregates the analytics provided by other NWDAFs to serve a request from an NF service consumer. + +If multiple NWDAFs are deployed, an NWDAF instance may be specialized to provide Analytics for one or more Analytics event(s). Each NWDAF instance may serve a certain Area of Interest or TAI(s) and multiple NWDAFs may be needed to serve a particular Analytics event collectively. An NWDAF may have the capability to aggregate the Analytics (per Analytics event) received from the other NWDAFs and/or the Analytics generated by itself. Analytics aggregation applies to scenarios where NWDAF service consumer requests or subscribes to analytics with or without provisioning of Area of Interest. + +### 5.3.2 Analytics aggregation with provisioning of Area of Interest + +This procedure is used by the service consumer to request Analytics event(s) for an Area of Interest, in which multiple NWDAFs are required to serve the request collectively. + +![Sequence diagram illustrating Analytics aggregation with provisioning of Area of Interest. The diagram shows interactions between NWDAF Service Consumer, Aggregator NWDAF1, NWDAF2, and NWDAF3. The process involves requests for analytics info and subscriptions, followed by responses and notifications from the aggregator to the consumer, after aggregating data from other NWDAF instances.](28d75f39a24203712ee907b32cf0bbe5_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NWDAF Service Consumer + participant Aggregator as Aggregator NWDAF1 + participant NWDAF2 as NWDAF2 + participant NWDAF3 as NWDAF3 + + Note left of Consumer: 1a. Nnwdaf_AnalyticsInfo_Request request + Note left of Consumer: 1b. Nnwdaf_EventsSubscription_Subscribe request + Note left of Consumer: 1c. Nnwdaf_AnalyticsSubscription_Subscribe response + Consumer-->>Aggregator: 1a. Nnwdaf_AnalyticsInfo_Request request + Consumer-->>Aggregator: 1b. Nnwdaf_EventsSubscription_Subscribe request + Aggregator-->>Consumer: 1c. Nnwdaf_AnalyticsSubscription_Subscribe response + + Note left of Aggregator: 2. Nnwdaf_AnalyticsInfo_Request request + Note left of Aggregator: 3. Nnwdaf_AnalyticsInfo_Request request + Note left of Aggregator: 4a. Nnwdaf_EventsSubscription_Subscribe request + Note left of Aggregator: 4b. Nnwdaf_EventsSubscription_Subscribe response + Note left of Aggregator: 5a. Nnwdaf_EventsSubscription_Subscribe request + Note left of Aggregator: 5b. Nnwdaf_EventsSubscription_Subscribe response + Aggregator->>NWDAF2: 2. Nnwdaf_AnalyticsInfo_Request request + Aggregator->>NWDAF3: 3. Nnwdaf_AnalyticsInfo_Request request + Aggregator->>NWDAF2: 4a. Nnwdaf_EventsSubscription_Subscribe request + NWDAF2-->>Aggregator: 4b. Nnwdaf_EventsSubscription_Subscribe response + Aggregator->>NWDAF3: 5a. Nnwdaf_EventsSubscription_Subscribe request + NWDAF3-->>Aggregator: 5b. Nnwdaf_EventsSubscription_Subscribe response + + Note left of Aggregator: 6. Nnwdaf_AnalyticsInfo_Request Response + Note left of Aggregator: 7. Nnwdaf_AnalyticsInfo_Request response + NWDAF2-->>Aggregator: 6. Nnwdaf_AnalyticsInfo_Request Response + NWDAF3-->>Aggregator: 7. Nnwdaf_AnalyticsInfo_Request response + + Note left of Aggregator: 8a. Nnwdaf_EventsSubscription_Notify request + Note left of Aggregator: 8b. Nnwdaf_EventsSubscription_Notify response + Aggregator->>NWDAF2: 8a. Nnwdaf_EventsSubscription_Notify request + NWDAF2-->>Aggregator: 8b. Nnwdaf_EventsSubscription_Notify response + + Note left of Aggregator: 9a. Nnwdaf_EventsSubscription_Notify request + Note left of Aggregator: 9b. Nnwdaf_EventsSubscription_Notify response + Aggregator->>NWDAF3: 9a. Nnwdaf_EventsSubscription_Notify request + NWDAF3-->>Aggregator: 9b. Nnwdaf_EventsSubscription_Notify response + + Note left of Aggregator: 10. Aggregate Analytics Outputs + Aggregator->>Consumer: 11a. Nnwdaf_AnalyticsInfo_Request Response + Aggregator->>Consumer: 11b. Nnwdaf_EventsSubscription_Notify request + Consumer-->>Aggregator: 11c. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram illustrating Analytics aggregation with provisioning of Area of Interest. The diagram shows interactions between NWDAF Service Consumer, Aggregator NWDAF1, NWDAF2, and NWDAF3. The process involves requests for analytics info and subscriptions, followed by responses and notifications from the aggregator to the consumer, after aggregating data from other NWDAF instances. + +**Figure 5.3.2-1: Analytics aggregation with provisioning of Area of Interest** + +1a-1c. In order to obtain the specific network data analytics, the NF service consumer selects an NWDAF (e.g. NWDAF1) with aggregation capability according to the results returned by NRF or available information obtained by other means. The NWDAF service consumer invokes Nnwdaf\_AnalyticsInfo\_Request or Nnwdaf\_EventsSubscription\_Subscribe service operations as described in clause 5.2.3.1 and clause 5.2.2.1 to the selected NWDAF. + +In the request message, the analytics event, analytics filter information including the Area of Interest (e.g. TAI-1, TAI-2, TAI-n, if available) and the Target of Analytics Reporting are provided. The NWDAF service consumer may indicate the time when the analytics is needed in "timeAnaNeeded" attribute, which needs to be equal or greater than the supported Analytics Delay per Analytics event of the Aggregator NWDAF. + +2-5b. The Aggregator NWDAF selects the other NWDAF instances, which collectively can cover the area of interest indicated in the request, according to the results returned by the NRF and/or the UDM, or available information obtained by other means. The Aggregator NWDAF invokes Nnwdaf\_AnalyticsInfo\_Request or Nnwdaf\_EventsSubscription\_Subscribe service operations to each selected NWDAF (e.g. NWDAF2, NWDAF3) as described in clause 4.2.2.2 or clause 4.3.2.2 of 3GPP TS 29.520 [5]. + +6-9b. The selected NWDAFs send response or notification containing the requested analytics to the Aggregator NWDAF. If the selected NWDAFs (e.g. NWDAF 2 and/or NWDAF 3) cannot reply or notify the requested analytics before the expiry of the time that the Aggregator NWDAF has indicated, they may send an error response or error notification to the Aggregator NWDAF including a "revised waiting time" in "rvWaitTime" attribute. + +10. The Aggregator NWDAF aggregates the analytics received from the selected NWDAFs and the analytics of its own. + +11a-11c. The Aggregator NWDAF sends a response or notification containing the aggregated output analytics for the requested Analytics event(s) to the NWDAF service consumer. + +If the Aggregator NWDAF cannot reply or notify the requested analytics before the expiry of the time that the consumer has indicated in "timeAnaNeeded" attribute, it may sends an error response or error notification to the consumer including a "revised waiting time" in "rvWaitTime" attribute. + +### 5.3.3 Analytics aggregation without provisioning of Area of Interest + +This procedure is used by the service consumer to request Analytics event(s) without providing an Area of Interest, in which multiple NWDAFs are required to serve the request collectively. + +![Sequence diagram for Analytics aggregation without provisioning of Area of Interest. Lifelines: NWDAF Service Consumer, Aggregator NWDAF1, NWDAF2, UDM, AMF. The process involves a request from the consumer to the aggregator, followed by internal steps (2a-4b) involving UDM and AMF, and then a series of dashed boxes (5-8) representing internal processing and redirection by the aggregator.](7fe7bcb3d40736e0b29d9f48ff3cc026_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NWDAF Service Consumer + participant Aggregator as Aggregator NWDAF1 + participant NWDAF2 as NWDAF2 + participant UDM as UDM + participant AMF as AMF + + Note left of Consumer: 1a-1c. Request and subscribe + Consumer-->>Aggregator: 1a. Nnwdaf_AnalyticsInfo_Request request + Consumer-->>Aggregator: 1b. Nnwdaf_EventsSubscription_Subscribe request + Aggregator-->>Consumer: 1c. Nnwdaf_AnalyticsSubscription_Subscribe response + + Note right of Aggregator: 2a-4b. Interaction with UDM and AMF + Aggregator-->>UDM: 2a. Nudm_UECM_Get request + UDM-->>Aggregator: 2b. Nudm_UECM_Get response + Aggregator-->>AMF: 3a. Namf_EventExposure_Subscribe request + AMF-->>Aggregator: 3b. Namf_EventExposure_Subscribe response + Aggregator-->>AMF: 4a. Namf_EventExposure_Notify request + AMF-->>Aggregator: 4b. Namf_EventExposure_Notify response + + Note right of Aggregator: 5. Retrieve NF service area of the data sources + Note right of Aggregator: 6. Query NRF with analytics events and each NF service area or UE location + Note right of Aggregator: 7. Redirect analytics request/Transfer analytics subscription + Note right of Aggregator: 8. Analytics aggregation as specified in steps 2-11c clause 5.3.2 + +``` + +Sequence diagram for Analytics aggregation without provisioning of Area of Interest. Lifelines: NWDAF Service Consumer, Aggregator NWDAF1, NWDAF2, UDM, AMF. The process involves a request from the consumer to the aggregator, followed by internal steps (2a-4b) involving UDM and AMF, and then a series of dashed boxes (5-8) representing internal processing and redirection by the aggregator. + +Figure 5.3.3-1: Analytics aggregation without provisioning of Area of Interest + +1a-1c. In order to obtain the specific network data analytics, the NF service consumer selects an NWDAF (e.g. NWDAF1) with aggregation capability according to the results returned by NRF or available information obtained by other means. The NWDAF service consumer invokes Nnwdaf\_AnalyticsInfo\_Request or Nnwdaf\_EventsSubscription\_Subscribe service operations as described in clause 5.2.3.1 and clause 5.2.2.1 to the + +selected NWDAF. If not, the NWDAF service consumer should select a NWDAF with large serving area from the candidate NWDAFs which supports analytics aggregation, e.g. NWDAF1. + +2a-4b. If the requested analytics requires UE location information, e.g. for the Analytics events "UE\_MOBILITY", "ABNORMAL\_BEHAVIOUR", or "USER\_DATA\_CONGESTION", then: + +- 2a-2b: The Aggregator NWDAF may query UDM to discover the NWDAF serving the UE by invoking Nudm\_UECM\_Get service operation as described in clause 5.3.2.5.12 of 3GPP TS 29.503 [23], if it is supported. + - 3a-4b: The Aggregator NWDAF may determine the AMF serving the UE, then requests UE location information from the AMF by invoking Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18]. The AMF notifies the UE location information by invoking Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. +5. If the requested analytics does not require UE location information, e.g. for the Analytics events "SERVICE\_EXPERIENCE", "NF\_LOAD", or "UE\_COMM", the Aggregator NWDAF can determine the NFs to be contacted for data collection. + 6. With the data obtained in step 3a-5, the Aggregator NWDAF may query the NRF for discovering the required NWDAF, by sending an NF discovery request including UE location or NF serving area as a filter to NRF, and obtains candidates target NWDAF(s) that can provide the required analytics. + 7. If a single target NWDAF (e.g. NWDAF2) can provide the requested analytics data, the Aggregator NWDAF can redirect the Nnwdaf\_AnalyticsInfo\_Request to that target NWDAF or request an analytics subscription transfer to that target NWDAF. + 8. If the Aggregator NWDAF decides to request analytics from one or more target NWDAFs, the steps 2-9b of the analytics aggregation procedure in clause 5.3.2 are executed. + +## 5.4 Procedures for Analytics Transferring + +### 5.4.1 Analytics context transfer initiated by target NWDAF selected by the NWDAF service consumer + +The procedure in below figure is used when an NWDAF service consumer decides to select a new NWDAF instance due to internal or external triggers, e.g. the NWDAF service consumer starts serving a UE with analytics subscription information received upon UE context transfer procedure as described in 3GPP TS 23.502 [3], or the NWDAF service consumer starts to request NF related analytics, or the NWDAF service consumer receives a "Termination Request" for an existing analytics subscription from an NWDAF. The NWDAF service consumer sends to the target NWDAF information about the NWDAF previously used for analytics subscription, if available, in Nnwdaf\_EventsSubscription\_Subscribe service operation. The target NWDAF may initiate the transfer of the analytics context, using the Nnwdaf\_AnalyticsInfo\_ContextTransfer. + +The procedure in below figure is also used when an Aggregator NWDAF, as the NWDAF service consumer, decides to select a new NWDAF to request output analytics for analytics aggregation. For example, upon receiving a Termination Request from one of the NWDAFs that are collectively serving a request for analytics subscription, the Aggregator NWDAF queries the NRF or UDM to select a target NWDAF using information e.g. the UE location, the 5GC NFs (identified by their NF Set IDs or NF types) serving the UE or to be contacted for data collection (if Area of Interest is not provisioned for the requested analytics), or the subset of AoI (if Area of Interest is provisioned for the requested analytics). Then, the Aggregator NWDAF sends information about the NWDAF previously used for analytics subscription, if available, in Nnwdaf\_EventsSubscription\_Subscribe service operation towards the selected target NWDAF. + +![Sequence diagram illustrating the analytics context transfer initiated by target NWDAF selected by the NWDAF service consumer. The diagram shows five lifelines: (old) NWDAF service consumer, (new) NWDAF service consumer, Source NWDAF, Target NWDAF, and Data Source(s). The sequence of messages is: 0. NWDAF service consumer changes (dashed box); 1. Determines to select an NWDAF (dashed box); 2a. Nnwdaf_EventsSubscription_Subscribe request (from new consumer to Target NWDAF); 2b. Nnwdaf_EventsSubscription_Subscribe response (from Target NWDAF to new consumer); 3a. Nnwdaf_AnalyticsInfo_ContextTransfer request (from Target NWDAF to Source NWDAF); 3b. Nnwdaf_AnalyticsInfo_ContextTransfer response (from Source NWDAF to Target NWDAF); 4. The Source NWDAF purges data and if not already done unsubscribes to data source(s) (dashed box); 5. Target NWDAF subscribes to data source(s) (dashed box).](e05b36c0d46549e681ce6581422c66b2_img.jpg) + +Sequence diagram illustrating the analytics context transfer initiated by target NWDAF selected by the NWDAF service consumer. The diagram shows five lifelines: (old) NWDAF service consumer, (new) NWDAF service consumer, Source NWDAF, Target NWDAF, and Data Source(s). The sequence of messages is: 0. NWDAF service consumer changes (dashed box); 1. Determines to select an NWDAF (dashed box); 2a. Nnwdaf\_EventsSubscription\_Subscribe request (from new consumer to Target NWDAF); 2b. Nnwdaf\_EventsSubscription\_Subscribe response (from Target NWDAF to new consumer); 3a. Nnwdaf\_AnalyticsInfo\_ContextTransfer request (from Target NWDAF to Source NWDAF); 3b. Nnwdaf\_AnalyticsInfo\_ContextTransfer response (from Source NWDAF to Target NWDAF); 4. The Source NWDAF purges data and if not already done unsubscribes to data source(s) (dashed box); 5. Target NWDAF subscribes to data source(s) (dashed box). + +**Figure 5.4.1-1: Analytics context transfer initiated by target NWDAF selected by the NWDAF service consumer** + +0. When the NWDAF service consumer (e.g. AMF) changes, the new NWDAF service consumer may receive the old subscription information from the old NWDAF service consumer. +1. The NWDAF service consumer determines to select an NWDAF instance. The NWDAF service consumer discovers and selects the target NWDAF as specified in clause 5.8. +2. To send a request for analytics subscription to the target NWDAF, the NWDAF service consumer invokes Nnwdaf\_EventsSubscription\_Subscribe service operation by sending the HTTP POST request message targeting the resource "NWDAF Events Subscriptions" to the target NWDAF. The NWDAF service consumer includes information on the previous analytics subscription (e.g., NWDAF ID and Subscription ID) which relates to the requested analytics subscription, if available. If the target NWDAF accepts the analytics subscription request, it responds with HTTP "201 Created" to the NWDAF service consumer. Details are described in clause 4.2.2.2 of 3GPP TS 29.520 [5]. + +If the target NWDAF does not receive information of previous analytics subscription in step 2, for UE related Analytics, the target NWDAF may discover previously used NWDAF in UDM as specified in clause 5.8. + +**NOTE:** If the selected target NWDAF instance is the same as the source NWDAF instance (as received from the other consumer in step 0), the new NWDAF service consumer invokes Nnwdaf\_EventsSubscription\_Subscribe service operation by sending the HTTP PUT request message targeting the resource "Individual NWDAF Event Subscription" to the target NWDAF, and the target NWDAF will update the existing analytics subscription to the new NWDAF service consumer. Following steps are skipped. + +3. If the target NWDAF decides to request an analytics context transfer from the previously used NWDAF, it invokes the Nnwdaf\_AnalyticsInfo\_ContextTransfer service operation by sending the HTTP GET request message targeting the resource "NWDAF Context" to the source NWDAF as described in clause 4.3.2.3 of 3GPP TS 29.520 [5]. + +Target NWDAF is now ready to generate analytics information by taking into account the information received in step 3. + +4. [Optional] Source NWDAF may purge analytics context after completion of step 3a, if performed, and if not already done, unsubscribes from the data source(s) and/or model source(s) that are no longer needed for the remaining analytics subscriptions. + +5. [Optional] Target NWDAF may subscribe to relevant data source(s) and/or model source(s), if it is not yet subscribed to the data source(s) and/or model source(s). + +### 5.4.2 Analytics Subscription Transfer initiated by source NWDAF + +The procedure in below figure is used by a source NWDAF instance to request the transfer of analytics subscription(s) to another target NWDAF instance, using the Nnwdaf\_EventsSubscription\_Transfer service operation. + +If the source NWDAF discovers that the NWDAF service consumer may change concurrently to this procedure, the source NWDAF should not perform the procedure. In such a case, the source NWDAF may send a message to indicate to the NWDAF service consumer that it will not serve this subscription anymore. + +- NOTE 1: To discover the possible change of NWDAF service consumer, if the Analytics Event is UE related, the source NWDAF takes actions responding to external trigger (such as UE mobility), for example, checking if the Target of Analytics Reporting is still within the serving area of the analytics consumer, if the serving area information is available. +- NOTE 2: Handling of overload situation or preparation for a graceful shutdown are preferably executed inside an NWDAF Set, when available, therefore, not requiring an analytics subscription transfer as described in this clause. Below procedure is applicable for analytics subscription transfer across NF Sets or if the NWDAF is not deployed in a Set. + +![Sequence diagram for Analytics subscription transfer initiated by source NWDAF. Lifelines: NWDAF service consumer, Source NWDAF, Target NWDAF, Data source. The process involves subscription, determination, discovery, transfer request/response, takeover, notification, context retrieval, subscription to data source, response, unsubscribe, new data derivation, and final notification.](05eb72d372e4bf78e3d6a64949d77bcc_img.jpg) + +``` + +sequenceDiagram + participant NWDAF service consumer + participant Source NWDAF + participant Target NWDAF + participant Data source + + Note over all: 0. NWDAF service consumer subscribes to Analytics from source NWDAF. +Optionally, the source NWDAF subscribes to UE mobility events. + Note right of Source NWDAF: 1. Source NWDAF determines, e.g. caused by UE mobility event notifications, to trigger a prepared analytics subscription transfer to the target NWDAF. + Note right of Source NWDAF: 2. Source NWDAF determines to request an analytics subscription transfer + Note right of Source NWDAF: 3. Source NWDAF discovers and selects target NWDAF. + Source NWDAF->>Target NWDAF: 4a. Nnwdaf_EventsSubscription_Transfer request + Target NWDAF-->>Source NWDAF: 4b. Nnwdaf_EventsSubscription_Transfer response + Note right of Target NWDAF: 5. Takes over Analytics subscription + Target NWDAF->>NWDAF service consumer: 6a. Nnwdaf_EventsSubscription_Notify request + NWDAF service consumer-->>Target NWDAF: 6b. Nnwdaf_EventsSubscription_Notify response + Note right of Target NWDAF: 7. Target NWDAF retrieves analytics context + Note right of Target NWDAF: 8. Target NWDAF subscribes to data source(s) + Target NWDAF-->>Source NWDAF: 9. Nnwdaf_EventsSubscription_Transfer response + Note right of Source NWDAF: 10. Source NWDAF unsubscribes from data source(s) + Note right of Target NWDAF: 11. Target NWDAF receives new input data from data source(s) and derives new analytics. + Target NWDAF->>NWDAF service consumer: 12a. Nnwdaf_EventsSubscription_Notify request + NWDAF service consumer-->>Target NWDAF: 12b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram for Analytics subscription transfer initiated by source NWDAF. Lifelines: NWDAF service consumer, Source NWDAF, Target NWDAF, Data source. The process involves subscription, determination, discovery, transfer request/response, takeover, notification, context retrieval, subscription to data source, response, unsubscribe, new data derivation, and final notification. + +**Figure 5.4.2-1: Analytics subscription transfer initiated by source NWDAF** + +0. The NWDAF service consumer subscribes to analytics from source NWDAF. The NWDAF service consumer may send its NF ID or serving area, enabling the source NWDAF to determine whether the following analytics subscription transfer procedure is applicable. Optionally the source NWDAF subscribes to UE mobility events. + +1. [Optional] Source NWDAF determines, e.g. triggered by a UE mobility event notification, to prepare an analytics subscription transfer to target NWDAF(s) as described in clause 5.4.3 with steps 0-1, 5- 6 will be followed. +2. Source NWDAF determines, e.g. based on the UE location information received and the analytics consumer's serving area either directly received in step 0 or indirectly received via NRF, to perform an analytics subscription transfer to target NWDAF(s). Therefore, the source NWDAF determines the analytics subscription(s) to be transferred to a target NWDAF. +3. Source NWDAF performs an NWDAF discovery and selects the target NWDAF. NWDAF discovery may be skipped if the target NWDAF had already been discovered as part of a prepared analytics subscription transfer. In the case of aggregated analytics from multiple NWDAFs, the source NWDAF may use the set of NWDAF identifiers related to aggregated analytics to preferably select a target NWDAF that is already serving the consumer. +4. Source NWDAF requests, using Nnwdaf\_EventsSubscription\_Transfer service operation, a transfer of the analytics subscription(s) determined in step 2 to the target NWDAF as described in clause 4.2.2.5 of 3GPP TS 29.520 [5], the response message in step 4b is optional. +5. Target NWDAF accepts the analytics subscription transfer and takes over the analytics generation based on the information received from the source NWDAF. + +The ML model related information namely ModelInfo may be provided by the source NWDAF in the Nnwdaf\_EventsSubscription\_Transfer request message. + +- If the instance ID or set ID of NWDAF(s) containing MTLF carried in "modelProvIds" attribute is provided in the Nnwdaf\_EventsSubscription\_Transfer, target NWDAF may request or subscribe to the ML model(s) from the indicated NWDAF(s). + +NOTE 3: If the provided ID(s) of NWDAF(s) containing MTLF carried in "modelProvIds" attribute are not part of the locally configured ID(s) of NWDAFs containing MTLF, the target NWDAF discovers the NWDAF(s) containing MTLF as described in clause 5.8.2.3. + +- When the source NWDAF itself provides the ML models, the address of ML model files may be provided, and the target NWDAF retrieves the ML model(s) from the indicated address. + +Target NWDAF may use the above retrieved ML models and the ML models retrieved from the locally configured NWDAFs containing MTLF for the transferred analytics subscription. + +NOTE 4: If not yet done during a prepared analytics subscription transfer, the target NWDAF allocates a new Subscription ID to the received analytics subscriptions. + +NOTE 5: The target NWDAF might already have received information on some/all of the analytics subscriptions as part of the prepared analytics subscription transfer request received in step 1 and, thus, might already have started to prepare for the analytics generation, e.g. by having already subscribed to relevant event notifications. + +6. Target NWDAF informs the NWDAF service consumer about the successful analytics subscription transfer using a Nnwdaf\_EventsSubscription\_Notify request message. A new Subscription ID, which was assigned by the target NWDAF, is provided in the Subscription ID and the old Subscription Id, which was allocated by the source NWDAF, is provided in the Old Subscription ID parameter of this message. + +NOTE 6: Notification correlation information in the Nnwdaf\_EventsSubscription\_Notify message allows the NWDAF service consumer to correlate the notifications to the initial subscription request made with the source NWDAF in step 0. + +NOTE 7: The existing Analytics context in the source NWDAF is not deleted directly but will be purged first when it was collected by the target NWDAF. + +NOTE 8: If this subscription is used as input for analytics aggregation by the NWDAF service consumer, the NWDAF service consumer may inform the other NWDAFs instance participating in this analytics aggregation that the Set of NWDAF identifiers of NWDAF instances used by the NWDAF service consumer for this analytics aggregation has changed using the Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 4.2.2.2 of 3GPP TS 29.520 [5]. + +7. [Conditional] If "analytics context identifier(s)" had been included in the Nnwdaf\_EventsSubscription\_Transfer Request received in step 4, the target NWDAF requests the "analytics context" by invoking the Nnwdaf\_AnalyticsInfo\_ContextTransfer service operation as described in clause 4.3.2.3 of 3GPP TS 29.520 [5]. +8. [Optional] Target NWDAF subscribes to relevant data source(s), if it is not yet subscribed to the data source(s) for the data required for the Analytics. +9. [Optional] Target NWDAF confirms the analytics subscription transfer to the source NWDAF by sending Nnwdaf\_EventsSubscription\_Transfer response message as described in clause 4.2.2.5 of 3GPP TS 29.520 [5], if the response has not been sent in step 4b. +10. [Optional] Source NWDAF unsubscribes with the data source(s) that are no longer needed for the remaining analytics subscriptions. In addition, Source NWDAF unsubscribes with the NWDAF(s) containing MTLF, if exist, which are no longer needed for the remaining analytics subscriptions. + +NOTE 9: At this point, the analytics subscription transfer is deemed completed, i.e. the source NWDAF can delete all information related to the successfully transferred analytics subscription. + +- 11-12. Target NWDAF at some point derives new output analytics based on new input data and notifies the NWDAF service consumer about the new analytics using a Nnwdaf\_EventsSubscription\_Notify message as described in clause 4.2.2.4 of 3GPP TS 29.520 [5]. + +### 5.4.3 Prepared analytics subscription transfer + +The procedure in below figure is used by a NWDAF instance to request another NWDAF instance for a prepared analytics subscription transfer from the source NWDAF instance, using the Nnwdaf\_EventsSubscription\_Transfer service operation. + +NOTE 1: The source NWDAF might determine that it needs to prepare to transfer analytics to another NWDAF instance, e.g. when the source NWDAF estimates for UE related analytics subscription that the UE might enter an area which is not covered by the source NWDAF (e.g., by subscribing to AMF event exposure service for UE mobility event notifications, by performing UE mobility analytics, or by subscribing to another NWDAF providing UE mobility analytics). If the source NWDAF discovers that the analytics consumer may change concurrently to this procedure, the source NWDAF does not perform the procedure. If the procedure makes use of predictions to determine the candidate NWDAFs, care must be taken with regards to load and signalling cost when sending data to an NWDAF that will not eventually start serving the UE. + +NOTE 2: The source NWDAF might also determine that it needs to prepare to transfer analytics subscriptions to another NWDAF instance, as the source NWDAF wants to resolve an internal load situation or prepare for a graceful shutdown. + +NOTE 3: Handling of overload situation or preparation for a graceful shutdown are preferably executed inside an NWDAF Set, when available. + +![Sequence diagram for Figure 5.4.3-1: Prepared analytics subscription transfer. The diagram shows interactions between four lifelines: NWDAF service consumer, Source NWDAF, Target NWDAF, and Data source. The sequence starts with the consumer subscribing to the source NWDAF (1a, 1b), then receiving a notification (2a, 2b). The source NWDAF then determines to transfer the subscription (3) and discovers a target NWDAF (4). It sends a transfer request to the target (5a, 5b). The target requests context information (6a, 6b). A dashed box indicates the target collecting data from the data source (7). Finally, the source sends another transfer request to the target (8a, 8b).](78ff716475b2f65bf01c3a4d02d89fc4_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NWDAF service consumer + participant SourceNWDAF as Source NWDAF + participant TargetNWDAF as Target NWDAF + participant DataSource as Data source + + Note right of SourceNWDAF: 3. Source NWDAF determines to trigger a prepared analytics subscription transfer to the target NWDAF. + Note right of SourceNWDAF: 4. Source NWDAF discovers and selects target NWDAF. + + Note right of TargetNWDAF: 7. Collect data from the data source + + Consumer->>SourceNWDAF: 1a. Nnwdaf_EventsSubscription_Subscribe request + SourceNWDAF-->>Consumer: 1b. Nnwdaf_EventsSubscription_Subscribe response + SourceNWDAF-->>Consumer: 2a. Nnwdaf_EventsSubscription_Notify request + Consumer-->>SourceNWDAF: 2b. Nnwdaf_EventsSubscription_Notify response + SourceNWDAF->>TargetNWDAF: 5a. Nnwdaf_EventsSubscription_Transfer request + TargetNWDAF-->>SourceNWDAF: 5b. Nnwdaf_EventsSubscription_Transfer response + TargetNWDAF-->>SourceNWDAF: 6a. Nnwdaf_AnalyticsInfo_ContextTransfer Request + SourceNWDAF-->>TargetNWDAF: 6b. Nnwdaf_AnalyticsInfo_ContextTransfer Response + SourceNWDAF->>TargetNWDAF: 8a. Nnwdaf_EventsSubscription_Transfer request + TargetNWDAF-->>SourceNWDAF: 8b. Nnwdaf_EventsSubscription_Transfer response + +``` + +Sequence diagram for Figure 5.4.3-1: Prepared analytics subscription transfer. The diagram shows interactions between four lifelines: NWDAF service consumer, Source NWDAF, Target NWDAF, and Data source. The sequence starts with the consumer subscribing to the source NWDAF (1a, 1b), then receiving a notification (2a, 2b). The source NWDAF then determines to transfer the subscription (3) and discovers a target NWDAF (4). It sends a transfer request to the target (5a, 5b). The target requests context information (6a, 6b). A dashed box indicates the target collecting data from the data source (7). Finally, the source sends another transfer request to the target (8a, 8b). + +**Figure 5.4.3-1: Prepared analytics subscription transfer** + +1a-1b. The NWDAF service consumer subscribes to analytics from source NWDAF by invoking Nnwdaf\_EventsSubscription\_Subscribe service operation. The source NWDAF responds to Nnwdaf\_EventsSubscription\_Subscribe service operation. + +2a-2b. The source NWDAF generates the requested analytics and notify the NWDAF service consumer by invoking the Nnwdaf\_EventsSubscription\_Notify service operation. The NWDAF service consumer responds to the Nnwdaf\_EventsSubscription\_Notify service operation. + +3. The source NWDAF determines that it needs to prepare to transfer the analytics subscription to another NWDAF instance. + +4. The source NWDAF discovers and selects the target NWDAF as described in clause 5.8.2.3. + +5a-5b. The source NWDAF invokes Nnwdaf\_EventsSubscription\_Transfer service operation by sending an HTTP POST request to the target NWDAF and the "transReqType" attribute in the request message is set to "PREPARE". The target NWDAF sends an HTTP "201 Created" to the source NWDAF. + +6a-6b. If analytics context identifier information had been included in the Nnwdaf\_EventsSubscription\_Transfer request message, the target NWDAF requests the analytics context information from the source NWDAF by + +invoking the Nnwdaf\_AnalyticsInfo\_ContextTransfer service operation by sending the HTTP GET request message targeting the resource "NWDAF Context" to the source NWDAF. + +7. The target NWDAF collect the data required for the analytics from the relevant data source(s), if it is not yet collected. + +8a-8b. The source NWDAF invokes the Nnwdaf\_EventsSubscription\_Transfer service operation by sending an HTTP DELETE request to cancel the prepared analytics subscription transfer. The target NWDAF sends response to the source NWDAF and deletes the analytics data that is no longer needed. If the target NWDAF had already subscribed to entities to collect data or ML models during the analytics subscription preparation, it unsubscribes from those entities if the subscriptions are not needed for other active analytics subscriptions. + +## 5.5 Data Collection + +### 5.5.1 Procedure for Data Collection from NFs + +#### 5.5.1.1 Data Collection from NFs + +The procedure in Figure 5.5.1.1-1 is used by NWDAF to subscribe/unsubscribe at NFs in order to be notified for data collection on related event(s), using Event Exposure Services as listed in Table 6.2.2.1-1 defined in TS 23.288 [2] clause 6.2.2. + +![Sequence diagram showing the procedure for Data Collection from NFs. The diagram involves three participants: NWDAF, NF, and UDM. The sequence of messages is as follows: 1a. Nudm_SDM_Get request (NWDAF to UDM), 2a. Nudm_SDM_Get response (UDM to NWDAF), 1b. Nudm_SDM_Subscribe request (NWDAF to UDM), 2b. Nudm_SDM_Subscribe response (UDM to NWDAF), 3. Nnf_EventExposure_Subscribe request (NWDAF to NF), 4. Nnf_EventExposure_Subscribe response (NF to NWDAF), 5. Nnf_EventExposure_Notify request (NF to NWDAF), 6. Nnf_EventExposure_Notify response (NWDAF to NF), 6a. Nudm_SDM_Notification request (NWDAF to UDM), 6b. Nudm_SDM_Notification response (UDM to NWDAF), 6c. Nudm_SDM_Unsubscribe request (NWDAF to UDM), 6d. Nudm_SDM_Unsubscribe response (UDM to NWDAF), 7. Nnf_EventExposure_Unsubscribe request (NWDAF to NF), 8. Nnf_EventExposure_Unsubscribe response (NF to NWDAF).](257c8341b41f1f4a287f27d33227974c_img.jpg) + +``` + +sequenceDiagram + participant NWDAF + participant NF + participant UDM + Note left of NWDAF: 1a. Nudm_SDM_Get request + NWDAF-->>UDM: 1a. Nudm_SDM_Get request + Note right of UDM: 2a. Nudm_SDM_Get response + UDM-->>NWDAF: 2a. Nudm_SDM_Get response + Note left of NWDAF: 1b. Nudm_SDM_Subscribe request + NWDAF-->>UDM: 1b. Nudm_SDM_Subscribe request + Note right of UDM: 2b. Nudm_SDM_Subscribe response + UDM-->>NWDAF: 2b. Nudm_SDM_Subscribe response + Note left of NWDAF: 3. Nnf_EventExposure_Subscribe request + NWDAF->>NF: 3. Nnf_EventExposure_Subscribe request + Note right of NF: 4. Nnf_EventExposure_Subscribe response + NF-->>NWDAF: 4. Nnf_EventExposure_Subscribe response + Note left of NF: 5. Nnf_EventExposure_Notify request + NF->>NWDAF: 5. Nnf_EventExposure_Notify request + Note right of NWDAF: 6. Nnf_EventExposure_Notify response + NWDAF->>NF: 6. Nnf_EventExposure_Notify response + Note left of NWDAF: 6a. Nudm_SDM_Notification request + NWDAF-->>UDM: 6a. Nudm_SDM_Notification request + Note right of UDM: 6b. Nudm_SDM_Notification response + UDM-->>NWDAF: 6b. Nudm_SDM_Notification response + Note left of NWDAF: 6c. Nudm_SDM_Unsubscribe request + NWDAF-->>UDM: 6c. Nudm_SDM_Unsubscribe request + Note right of UDM: 6d. Nudm_SDM_Unsubscribe response + UDM-->>NWDAF: 6d. Nudm_SDM_Unsubscribe response + Note left of NWDAF: 7. Nnf_EventExposure_Unsubscribe request + NWDAF->>NF: 7. Nnf_EventExposure_Unsubscribe request + Note right of NF: 8. Nnf_EventExposure_Unsubscribe response + NF-->>NWDAF: 8. Nnf_EventExposure_Unsubscribe response + +``` + +Sequence diagram showing the procedure for Data Collection from NFs. The diagram involves three participants: NWDAF, NF, and UDM. The sequence of messages is as follows: 1a. Nudm\_SDM\_Get request (NWDAF to UDM), 2a. Nudm\_SDM\_Get response (UDM to NWDAF), 1b. Nudm\_SDM\_Subscribe request (NWDAF to UDM), 2b. Nudm\_SDM\_Subscribe response (UDM to NWDAF), 3. Nnf\_EventExposure\_Subscribe request (NWDAF to NF), 4. Nnf\_EventExposure\_Subscribe response (NF to NWDAF), 5. Nnf\_EventExposure\_Notify request (NF to NWDAF), 6. Nnf\_EventExposure\_Notify response (NWDAF to NF), 6a. Nudm\_SDM\_Notification request (NWDAF to UDM), 6b. Nudm\_SDM\_Notification response (UDM to NWDAF), 6c. Nudm\_SDM\_Unsubscribe request (NWDAF to UDM), 6d. Nudm\_SDM\_Unsubscribe response (UDM to NWDAF), 7. Nnf\_EventExposure\_Unsubscribe request (NWDAF to NF), 8. Nnf\_EventExposure\_Unsubscribe response (NF to NWDAF). + +Figure 5.5.1.1-1: Event Exposure Subscribe/Unsubscribe for NFs + +- 1a. If data is to be collected for a user, i.e. for a SUPI or GPSI, the user consent has not been checked by the data consumer, and local policy and regulations require to check user consent, the NWDAF invokes Nudm\_SDM\_Get service operation by sending an HTTP GET request targeting the resource "AccessAndMobilitySubscriptionData" to the UDM to request the data type "User consent" as described in clause 5.2.2.2 of 3GPP TS 29.503 [22]. Otherwise the procedure begins with step 3. +- 2a. The UDM responds to the Nudm\_SDM\_Get service operation. If the request is accepted, the response includes the requested data with "200 OK". In subsequent steps, the NWDAF excludes the SUPI or GPSI from requests to collect data for users for whom the user consent is not granted. +- 1b. For the users for which the user consent is granted, the NWDAF subscribes to notifications of changes of the user consent by invoking the Nudm\_SDM\_Subscribe service operation by sending an HTTP POST request targeting the resource "SdmSubscriptions" to the UDM as described in clause 5.2.2.3 of 3GPP TS 29.503 [22]. +- 2b. The UDM responds to the Nudm\_SDM\_Subscribe service operation. If the request is accepted, the UDM responds with "201 Created". +3. In order to subscribe to notifications (or to modify subscriptions to notifications) of data events from the data source NF (e.g. UDM, AMF, SMF, NEF, AF), the NWDAF invokes the Nnf\_EventExposure\_Subscribe service operation by sending an HTTP POST (or PUT, for modification) request targeting the resource representing event exposure subscriptions of that NF, e.g. as described in clause 5.5.2.2 of 3GPP TS 29.503 [22] for the UDM, clause 5.3.2.2 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.3 of 3GPP TS 29.508 [6] for the SMF, clause 4.2.2.2 of 3GPP TS 29.591 [11] for the NEF, or clause 4.2.2 of 3GPP TS 29.517 [12] for the AF. +4. The NF responds to the Nnf\_EventExposure\_Subscribe service operation. Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NF responds to the NWDAF with "201 Created", and the URI of the created subscription is included in the Location header field. +5. If the NF observes the subscribed event(s), the NF invokes Nnf\_EventExposure\_Notify service operation to report the event(s) by sending an HTTP POST request, e.g. as described in clause 5.5.2.4 of 3GPP TS 29.503 [22] for the UDM, clause 5.3.2.4 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.2 of 3GPP TS 29.508 [6] for the SMF, clause 4.2.2.4 of 3GPP TS 29.591 [11] for the NEF, or clause 4.2.4 of 3GPP TS 29.517 [12] for the AF. +- 6a. If the user consent changes and the NWDAF has subscribed to UDM to notifications of user consent change for a user, the UDM invokes Nudm\_SDM\_Notification service operation by sending an HTTP POST request as described in clause 5.2.2.5 of 3GPP TS 29.503 [22]. +- 6b. The NWDAF responds to the Nudm\_SDM\_Notification service operation with "204 No Content". +- 6c. The NWDAF may invoke Nudm\_SDM\_Unsubscribe service operation by sending an HTTP DELETE request as described in clause 5.2.2.4 of 3GPP TS 29.503 [22] to unsubscribe from UDM to be notified of user consent change for each user whose user consent is revoked. +- 6d. If the deletion request is accepted, the UDM responds to the Nudm\_SDM\_Unsubscribe service operation with "204 No Content". +7. If the user consent is no longer granted or the data collection is no longer required, the NWDAF unsubscribes to the notifications of data events from the NF. The NWDAF invokes Nnf\_EventExposure\_Unsubscribe service operation by sending an HTTP DELETE request targeting the resource that represents the previously created individual event exposure subscription, e.g. as described in clause 5.5.2.3 of 3GPP TS 29.503 [22] for the UDM, clause 5.3.2.3 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.4 of 3GPP TS 29.508 [6] for the SMF, clause 4.2.2.3 of 3GPP TS 29.591 [11] for the NEF, clause 4.2.3 of 3GPP TS 29.517 [12] for the AF. The request includes the event subscriptionId of the existing subscription that is to be deleted. +8. The NF responds to the Nnf\_EventExposure\_Unsubscribe service operation. If the subscription deletion is accepted, the NF responds with "204 No Content". + +### 5.5.2 Data collection profile registration + +This procedure depicted in Figure 5.5.2-1 is used by NWDAF or ADRF to register/update a data collection profile to the DCCF during/after the procedure of data collection. + +![Sequence diagram illustrating the procedure for the NWDAF or ADRF to register data profile to DCCF. The diagram shows interactions between Data Consumer, DCCF, and ADRF or NWDAF. The process includes: 1. Data collection by ADRF/NWDAF; 2. Register request from ADRF/NWDAF to DCCF; 3. Register response from DCCF to ADRF/NWDAF; 4. Update request from Data Consumer to DCCF; 5. Update response from DCCF to Data Consumer; 6. Subscribe request from Data Consumer to DCCF (labeled 'Data Collection via DCCF'); 7. Deregister request from ADRF/NWDAF to DCCF; 8. Deregister response from DCCF to ADRF/NWDAF.](329c96049bb432e9c2cbda4e224a0c9c_img.jpg) + +``` + +sequenceDiagram + participant DC as Data Consumer + participant DCCF as DCCF + participant AN as ADRF or NWDAF + + Note right of AN: 1. Collect data directly, i.e. not via DCCF + AN->>DCCF: 2. Ndpcf_ContextManagement_Register Request + DCCF-->>AN: 3. Ndpcf_ContextManagement_Register Response + DC->>DCCF: 4. Ndpcf_ContextManagement_Update Request + DCCF-->>DC: 5. Ndpcf_ContextManagement_Update Response + Note left of DCCF: Data Collection via DCCF + DC->>DCCF: 6. Ndpcf_DataManagement_Subscribe + AN->>DCCF: 7. Ndpcf_ContextManagement_Deregister Request + DCCF-->>AN: 8. Ndpcf_ContextManagement_Deregister Response + +``` + +Sequence diagram illustrating the procedure for the NWDAF or ADRF to register data profile to DCCF. The diagram shows interactions between Data Consumer, DCCF, and ADRF or NWDAF. The process includes: 1. Data collection by ADRF/NWDAF; 2. Register request from ADRF/NWDAF to DCCF; 3. Register response from DCCF to ADRF/NWDAF; 4. Update request from Data Consumer to DCCF; 5. Update response from DCCF to Data Consumer; 6. Subscribe request from Data Consumer to DCCF (labeled 'Data Collection via DCCF'); 7. Deregister request from ADRF/NWDAF to DCCF; 8. Deregister response from DCCF to ADRF/NWDAF. + +**Figure 5.5.2-1: Procedure for the NWDAF or ADRF to register data profile to DCCF** + +1. An ADRF or NWDAF instance is collecting or has collected data directly, e.g. from collocated NF. +2. In order to register a data collection profile, the ADRF or NWDAF invokes the `Ndpcf_ContextManagement_Register` service operation by sending an HTTP POST request targeting the resource "DCCF Data Collection Profiles" as described in clause 4.3.2.2 of 3GPP TS 29.574 [15]. +3. The DCCF responds to the `Ndpcf_ContextManagement_Register` service operation. Upon receipt of the HTTP POST request, if the data profile is accepted to be created, the DCCF responds to the ADRF or NWDAF with "201 Created", and the URI of the created profile is included in the Location header field. +4. In order to update a data collection profile, the Data Consumer invokes the `Ndpcf_ContextManagement_Update` service operation by sending an HTTP PUT request targeting the resource "Individual DCCF Data Collection Profile" as described in clause 4.3.2.3 of 3GPP TS 29.574 [15]. +5. The DCCF responds to the `Ndpcf_ContextManagement_Update` service operation. Upon receipt of the HTTP PUT request, if the data profile is accepted to be updated, the DCCF responds to the ADRF or NWDAF with "200 OK" with a response body containing a representation of the updated data profile or "204 No Content". +6. To obtain historical data and if the data consumer is configured to collect data via the DCCF using the `Ndpcf_DataManagement_Subscribe` service operation, the data consumer uses the procedures described in clause 5.5.3. +7. The ADRF or NWDAF requests to delete a registered data collection profile at the DCCF invoking the `Ndpcf_ContextManagement_Deregister` service operation by sending a HTTP DELETE request targeting the "Individual DCCF Data Collection Profile" resource of the DCCF as described in clause 4.3.2.4 of 3GPP TS 29.574 [15]. +8. The DCCF responds to the `Ndpcf_ContextManagement_Deregister` service operation with HTTP "204 No Content" status code, if the data collection profile is successfully removed. + +### 5.5.3 Procedure for Data Collection using DCCF + +#### 5.5.3.1 Data Collection via DCCF + +The procedure depicted in Figure 5.5.3.1-1 is used by a data consumer (e.g. NWDAF) to obtain data and be notified of events via the DCCF using the Ndcf\_DataManagement\_Subscribe service operation. Whether the data consumer directly contacts the Data Source or goes via the DCCF is based on configuration of the data consumer. + +![Sequence diagram for Data Management in 3GPP TS 29.552 V18.3.0. Lifelines: Data Consumer, DCCF, ADRF, NWDAF, Data Source, UDM. The diagram shows the interaction for subscribing, fetching, and unsubscribing to data.](9252ccfbbe9e34cb108f0060f2b563f1_img.jpg) + +``` + +sequenceDiagram + participant DC as Data Consumer + participant DCCF + participant ADRF + participant NWDAF + participant DS as Data Source + participant UDM + + Note left of DC: 1. Ndcf_DataManagement_Subscribe request + DC->>DCCF: 1. Ndcf_DataManagement_Subscribe request + Note right of DCCF: 2a. Nudm_SDM_Get request + DCCF-->>UDM: 2a. Nudm_SDM_Get request + Note right of UDM: 3a. Nudm_SDM_Get response + UDM-->>DCCF: 3a. Nudm_SDM_Get response + Note right of DCCF: 2b. Nudm_SDM_Subscribe request + DCCF-->>UDM: 2b. Nudm_SDM_Subscribe request + Note right of UDM: 3b. Nudm_SDM_Subscribe response + UDM-->>DCCF: 3b. Nudm_SDM_Subscribe response + + Note left of DC: 4. Determine whether historical data handling is applicable + Note left of DC: 5a. Determine whether the requested data is already being collected + + Note right of DCCF: 6a. Nnf_EventExposure_Subscribe request + DCCF-->>DS: 6a. Nnf_EventExposure_Subscribe request + Note right of DS: 7a. Nnf_EventExposure_Subscribe response + DS-->>DCCF: 7a. Nnf_EventExposure_Subscribe response + + Note left of DC: 5b. If historical data handling is applicable, and DCCF determine to retrieve data from ADRF Instance + Note right of DCCF: 6b. Nadrf_DataManagement_RetrievalSubscribe request + DCCF-->>ADRF: 6b. Nadrf_DataManagement_RetrievalSubscribe request + Note right of ADRF: 7b. Nadrf_DataManagement_RetrievalSubscribe response + ADRF-->>DCCF: 7b. Nadrf_DataManagement_RetrievalSubscribe response + + Note left of DC: 5c. If historical data handling is applicable, and DCCF determine to retrieve analytics data from NWDAF Instance + Note right of DCCF: 6c. Nnwdaf_DataManagement_Subscribe request + DCCF-->>NWDAF: 6c. Nnwdaf_DataManagement_Subscribe request + Note right of NWDAF: 7c. Nnwdaf_DataManagement_Subscribe response + NWDAF-->>DCCF: 7c. Nnwdaf_DataManagement_Subscribe response + + Note left of DC: 8. Ndcf_DataManagement_Subscribe response + DCCF-->>DC: 8. Ndcf_DataManagement_Subscribe response + + Note right of DCCF: 9a. Nnf_EventExposure_Notify request + DCCF-->>DS: 9a. Nnf_EventExposure_Notify request + Note right of DS: 10a. Nnf_EventExposure_Notify response + DS-->>DCCF: 10a. Nnf_EventExposure_Notify response + + Note right of DCCF: 9b. Nadrf_DataManagement_RetrievalNotify request + DCCF-->>ADRF: 9b. Nadrf_DataManagement_RetrievalNotify request + Note right of ADRF: 10b. Nadrf_DataManagement_RetrievalNotify response + ADRF-->>DCCF: 10b. Nadrf_DataManagement_RetrievalNotify response + + Note right of DCCF: 9c. Nnwdaf_DataManagement_Notify request + DCCF-->>NWDAF: 9c. Nnwdaf_DataManagement_Notify request + Note right of NWDAF: 10c. Nnwdaf_DataManagement_Notify response + NWDAF-->>DCCF: 10c. Nnwdaf_DataManagement_Notify response + + Note left of DC: 11. Ndcf_DataManagement_Notify request + DCCF-->>DC: 11. Ndcf_DataManagement_Notify request + Note left of DC: 12. Ndcf_DataManagement_Notify response + DC-->>DCCF: 12. Ndcf_DataManagement_Notify response + + Note left of DC: Data Fetch + Note left of DC: 13. Ndcf_DataManagement_Fetch Request + DC->>DCCF: 13. Ndcf_DataManagement_Fetch Request + Note left of DC: 14. Ndcf_DataManagement_Fetch response + DCCF-->>DC: 14. Ndcf_DataManagement_Fetch response + + Note left of DC: Unsubscribe + Note left of DC: 15. Ndcf_DataManagement_Unsubscribe request + DC->>DCCF: 15. Ndcf_DataManagement_Unsubscribe request + Note left of DC: 16. Ndcf_DataManagement_Unsubscribe response + DCCF-->>DC: 16. Ndcf_DataManagement_Unsubscribe response + + Note right of DCCF: 16a. Nudm_SDM_Notification request + DCCF-->>UDM: 16a. Nudm_SDM_Notification request + Note right of UDM: 16b. Nudm_SDM_Notification response + UDM-->>DCCF: 16b. Nudm_SDM_Notification response + + Note right of DCCF: 16c. Nudm_SDM_Unsubscribe request + DCCF-->>UDM: 16c. Nudm_SDM_Unsubscribe request + Note right of UDM: 16d. Nudm_SDM_Unsubscribe response + UDM-->>DCCF: 16d. Nudm_SDM_Unsubscribe response + + Note right of DCCF: 17a. Nnf_EventExposure_Unsubscribe request + DCCF-->>DS: 17a. Nnf_EventExposure_Unsubscribe request + Note right of DS: 18a. Nnf_EventExposure_Unsubscribe response + DS-->>DCCF: 18a. Nnf_EventExposure_Unsubscribe response + + Note right of DCCF: 17b. Nadrf_DataManagement_RetrievalUnsubscribe request + DCCF-->>ADRF: 17b. Nadrf_DataManagement_RetrievalUnsubscribe request + Note right of ADRF: 18b. Nadrf_DataManagement_RetrievalUnsubscribe response + ADRF-->>DCCF: 18b. Nadrf_DataManagement_RetrievalUnsubscribe response + + Note right of DCCF: 17c. Nnwdaf_DataManagement_Unsubscribe request + DCCF-->>NWDAF: 17c. Nnwdaf_DataManagement_Unsubscribe request + Note right of NWDAF: 18c. Nnwdaf_DataManagement_Unsubscribe response + NWDAF-->>DCCF: 18c. Nnwdaf_DataManagement_Unsubscribe response + +``` + +Sequence diagram for Data Management in 3GPP TS 29.552 V18.3.0. Lifelines: Data Consumer, DCCF, ADRF, NWDAF, Data Source, UDM. The diagram shows the interaction for subscribing, fetching, and unsubscribing to data. + +###### **Figure 5.5.3.1-1: Data Collection via DCCF** + +1. In order to subscribe to notification(s) of events exposure via the DCCF based on local configuration, the Data Consumer invokes the Ndcf\_DataManagement\_Subscribe service operation by sending an HTTP POST request targeting the resource "DCCF Data Subscriptions" as described in clause 4.2.2.2.4 of 3GPP TS 29.574 [15]. +- 2a. If data is to be collected for a user, i.e. for a SUPI or GPSI, the user consent has not been checked by the data consumer, and local policy and regulations require to check user consent, the DCCF invokes the Nudm\_SDM\_Get service operation by sending an HTTP GET request targeting the resource "AccessAndMobilitySubscriptionData" at the UDM to request the data type "User consent" as described in clause 5.2.2.2 of 3GPP TS 29.503 [22]. Otherwise the procedure continues with step 4. +- 3a. The UDM responds to the Nudm\_SDM\_Get service operation. If the request is accepted, the response includes the requested data with "200 OK". In subsequent steps, the DCCF excludes the SUPI or GPSI from requests to collect data for users for whom the user consent is not granted. +- 2b. For the users for which the user consent is granted, the DCCF subscribes to notifications of changes of the user consent by invoking the Nudm\_SDM\_Subscribe service operation by sending an HTTP POST request targeting the resource "SdmSubscriptions" at the UDM as described in clause 5.2.2.3 of 3GPP TS 29.503 [22]. +- 3b. The UDM responds to the Nudm\_SDM\_Subscribe service operation. If the request is accepted, the UDM responds with "201 Created" status code. +4. The DCCF determines the NF type(s) and/or OAM to retrieve the data based on the Service Operation requested in step 1. If the NF instance or NF Set ID is not provided by the data consumer. The DCCF determines the NF instances that can provide data as described in TS 23.288 [2] clause 5A.2 and clause 6.2.2.2. If the consumer requested storage of data in an ADRF but the ADRF ID is not provided by the data consumer, or the collected data is to be stored in an ADRF according to configuration on the DCCF, the DCCF selects an ADRF to store the collected data. + +The DCCF keeps track of the data actively being collected from the Data Sources it is coordinating. The NWDAF or ADRF may register the data collection profile (including the data collection related Service Operation, Analytics/Data Specification, NWDAF ID or ADRF ID) with the DCCF. The DCCF may then determine whether certain historical data may be available in the NWDAF or ADRF based on the data collection profile and the request time window. + +If the historical data handling is not applicable or not supported, the DCCF shall proceed with step 5a and skip step 5b, step 6b, step 7b, step 5c, step 6c, and step 7c. + +If the historical data is available in an ADRF, the DCCF shall proceed with step 5a and step 5b, and skip step 5c, step 6c, and step 7c. + +If the historical data is available in an NWDAF, the DCCF shall proceed with step 5a and step 5c, and skip step 5b, step 6b, and step 7b. + +- 5a. The DCCF shall determine whether the data requested in step 1 are already being collected. + +If the data requested are already being collected by a data consumer, the DCCF adds the data consumer to the list of data consumers that are subscribed for these data. + +If the DCCF determines that no subscriptions need to be created or modified (e.g. because all the data can be made available either via pre-existing subscriptions or because of the historical data handling) then step 6a and step 7a are skipped. + +- 6a. If the data requested in step 1 are not yet available, the DCCF shall invoke the Nnf\_EventExposure\_Subscribe service operation by sending an HTTP POST request message request to the NF targeting the resource representing event exposure subscriptions to subscribe to a new event exposure subscription, e.g. as described in clause 5.5.2.2 of 3GPP TS 29.503 [22] for the UDM, clause 5.3.2.2 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.3 of 3GPP TS 29.508 [6] for the SMF, clause 4.2.2.2 of 3GPP TS 29.591 [11] for the NEF, or clause 4.2.2 of 3GPP TS 29.517 [12] for the AF. + +Otherwise, if the requested data subscribed in step 1 partially matches data that is already being collected by the DCCF from an NF, and a modification of this subscription to the NF would satisfy both the existing data subscriptions as well as the newly requested data, the DCCF shall send a request to the individual event exposure subscription resource to update an existing event exposure subscription, e.g. as described in clause 5.5.2.5 of + +3GPP TS 29.503 [22] for the UDM, clause 5.3.2.2.3 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.3.3 of 3GPP TS 29.508 [6] for the SMF, clause 4.2.2.2.3 of 3GPP TS 29.591 [11] for the NEF, or clause 4.2.2.3 of 3GPP TS 29.517 [12] for the AF. + +- 7a. The NF responds to the Nnf\_EventExposure\_Subscribe service operation. + +Upon receipt of an HTTP POST request, if the subscription is accepted to be created, the NF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +Upon receipt of an HTTP PUT request, if the subscription is accepted to be updated, the NF responds to the DCCF with "200 OK" or "204 No Content" status code. + +- 5b. If the historical data handling is applicable, and the DCCF determines to retrieve data from the ADRF, the DCCF shall determine which ADRF instances might provide the data. + +- 6b. In order to retrieve the historical data from the ADRF, the DCCF shall invoke the Nadrf\_DataManagement\_RetrievalSubscribe service operation by sending an HTTP POST request message targeting the resource "ADRF Data Retrieval Subscriptions" as described in clause 4.2.2.6 of 3GPP TS 29.575 [16]. + +- 7b. The ADRF responds to the Nadrf\_DataManagement\_RetrievalSubscribe service operation. + +Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the ADRF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +- 5c. If the historical data handling is applicable, and the DCCF determines to retrieve data from the NWDAF, the DCCF shall determine which NWDAF instances might provide the requested data. + +- 6c. In order to retrieve the historical data from the NWDAF, the DCCF shall invoke the Nnwdaf\_DataManagement\_Subscribe service operation by sending an HTTP POST request message targeting the resource "NWDAF Data Management Subscriptions", as described in clause 4.4.2.2 of 3GPP TS 29.520 [5]. + +- 7c. The NWDAF responds to the Nnwdaf\_DataManagement\_Subscribe service operation. + +Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NWDAF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +8. The DCCF responds to the Ndccf\_DataManagement\_Subscribe service operation with HTTP "204 No Content" status code. + +- 9a. When the data are available, the NF invokes the Nnf\_EventExposure\_Notify service operation by sending an HTTP POST request message to notify the data events to the DCCF, e.g. as described in clause 5.5.2.4 of 3GPP TS 29.503 [22] for the UDM, clause 5.3.2.4 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.2 of 3GPP TS 29.508 [6] for the SMF, clause 4.2.2.4 of 3GPP TS 29.591 [11] for the NEF, or clause 4.2.4 of 3GPP TS 29.517 [12] for the AF. + +- 10a. The DCCF responds to the Nnf\_EventExposure\_Notify service operation with HTTP "204 No Content" status code. + +- 9b. When the historical data are available in the ADRF, the ADRF shall invoke the Nadrf\_DataManagement\_RetrievalNotify service operation by sending an HTTP POST request message to notify the historical data or Fetch Instructions to the DCCF as described in clause 4.2.2.8 of 3GPP TS 29.575 [16]. + +- 10b. The DCCF responds to the Nadrf\_DataManagement\_RetrievalNotify service operation with HTTP "204 No Content" status code. + +- 9c. When the historical data are available in the NWDAF, the NWDAF shall invoke the Nnwdaf\_DataManagement\_Notify service operation by sending an HTTP POST request message to notify the historical data to the DCCF as described in clause 4.4.2.4 of 3GPP TS 29.520 [5]. + +- 10c. The DCCF responds to the Nnwdaf\_DataManagement\_Notify service operation with HTTP "204 No Content" status code. + +11. If the DCCF is configured to deliver the data itself (and not via the MFAF), the DCCF invokes the Ndccf\_DataManagement\_Notify service operation by sending HTTP POST request message(s) to send the data to all notification endpoints indicated in step 1. Data sent to notification endpoints may be processed and formatted by the DCCF, so they conform to delivery requirements for each NF service consumer or notification endpoint. +- NOTE: According to Formatting Instructions provided by the NF service consumer, multiple notifications from a NF can be combined in a single Ndccf\_DataManagement\_Notify so that many notifications from an NF result in fewer notifications (or one notification) to the Data Consumer. Alternatively, a notification can instruct the data notification endpoint to fetch the data from the DCCF. +12. The NF service consumer responds to the Ndccf\_DataManagement\_Notify service operation with HTTP "204 No Content" status code. +13. The Data Consumer invokes the Ndccf\_DataManagement\_Fetch service operation by sending an HTTP GET request message as described in clause 4.2.2.5 of 3GPP TS 29.574 [15] to fetch the data from the DCCF before an expiry time, if the fetch instruction was previously received via the NdccfDataManagement\_Notify service operation in step 11. +14. The DCCF responds to the Ndccf\_DataManagement\_Fetch service operation with HTTP "200 OK" status code with the message body containing the data received earlier from the data source. +15. When the NF service consumer no longer needs the subscription to the requested data in step 1, it shall invoke the Ndccf\_DataManagement\_Unsubscribe service operation by sending an HTTP DELETE request message as described in clause 4.2.2.3.3 of 3GPP TS 29.574 [15]. The DCCF removes the NF service consumer from the list of NF service consumers that are subscribed for these data. +16. The DCCF responds to the Ndccf\_DataManagement\_Unsubscribe service operation with HTTP "204 No Content" status code, if the NF service consumer is successfully removed from the list of NF service consumers that are subscribed for these data. + - 16a. If the user consent changes and the DCCF has subscribed to UDM to notifications of user consent change for a user, the UDM invokes Nudm\_SDM\_Notification service operation by sending an HTTP POST request as described in clause 5.2.2.5 of 3GPP TS 29.503 [22]. + - 16b. The DCCF responds to the Nudm\_SDM\_Notification service operation with "204 No Content". + - 16c. The DCCF may invoke Nudm\_SDM\_Unsubscribe service operation by sending an HTTP DELETE request as described in clause 5.2.2.4 of 3GPP TS 29.503 [22] to unsubscribe from UDM to be notified of user consent change for each user whose user consent is revoked. + - 16d. If the deletion request is accepted, the UDM responds to the Nudm\_SDM\_Unsubscribe service operation with "204 No Content". +- 17a. If there are no other NF service consumers subscribed to the data or the user consent for a user, i.e. for a SUPI or GPSI, is no longer granted, the DCCF invokes the Nnf\_EventExposure\_Unsubscribe service operation by sending an HTTP DELETE request message to the Data Source, e.g. as described in clause 5.5.2.3 of 3GPP TS 29.503 [22] for the UDM, clause 5.3.2.3 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.4 of 3GPP TS 29.508 [6] for the SMF, clause 4.2.2.3 of 3GPP TS 29.591 [11] for the NEF, or clause 4.2.3 in 3GPP TS 29.517 [12] for the AF. +- 18a. The Data Source responds to the Nnf\_EventExposure\_Unsubscribe service operation with HTTP "204 No Content" status code, if the data event(s) subscription is successfully removed. +- 17b. If the DCCF determines that no other NF service consumers require the historical data from the ADRF, the DCCF invokes the Nadrf\_DataManagement\_RetrievalUnsubscribe service operation by sending an HTTP DELETE request message to the ADRF as described in clause 4.2.2.7 of 3GPP TS 29.575 [16]. +- 18b. The ADRF responds to the Nadrf\_DataManagement\_RetrievalUnsubscribe service operation with HTTP "204 No Content" status code, if the data retrieval subscription is successfully removed. +- 17c. If DCCF determines that no other NF service consumers require the historical data from the NWDAF, the DCCF invokes the Nnwdaf\_DataManagement\_Unsubscribe service operation by sending an HTTP DELETE request message to the NWDAF as described in clause 4.4.2.3 of 3GPP TS 29.520 [5]. + +- 18c. The NWDAF responds to the Nnwdaf\_DataManagement\_Unsubscribe service operation with HTTP "204 No Content" status code, if the data subscription is successfully removed. + +#### 5.5.3.2 Data Collection via Messaging Framework + +This procedure depicted in Figure 5.5.3.2-1 is used by a data consumer (e.g. NWDAF) to obtain data and be notified of events using the DCCF and a Messaging Framework. The 3GPP DCCF Adaptor (3da) Data Management service and 3GPP Consumer Adaptor (3ca) Data Management service of the Messaging Framework Adaptor Function (MFAF) are used to interact with the Messaging Framework. Whether the data consumer directly contacts the Data Source or goes via the DCCF is based on configuration. + +![Sequence diagram for Ndcf_DataManagement operations. Lifelines: Data Consumer, DCCF, UDM, MFAF, ADRF, NWDAF, Data Source. The diagram shows the interaction for subscribing, fetching, and unsubscribing to data management services.](be3e5fe8be7cc5a74f67a4b8ac93193d_img.jpg) + +``` + +sequenceDiagram + participant DC as Data Consumer + participant DCCF + participant UDM + participant MFAF + participant ADRF + participant NWDAF + participant DS as Data Source + + Note left of DC: 6. Determine whether historical data handling is applicable or not + Note left of DC: 7a. Determine whether the requested data is already being collected + Note left of DC: 7b. If historical data handling is applicable, and DCCF determine to retrieve data from ADRF Instance + Note left of DC: 7c. If historical data handling is applicable, and DCCF determine to retrieve analytics data from NWDAF Instance + + Note left of DCCF: Data Fetch + Note left of DCCF: Unsubscribe + + DC->>DCCF: 1. Ndcf_DataManagement_Subscribe request + DCCF->>UDM: 2a. Nudm_SDM_Get request + UDM-->>DCCF: 3a. Nudm_SDM_Get response + DCCF->>UDM: 2b. Nudm_SDM_Subscribe request + UDM-->>DCCF: 3b. Nudm_SDM_Subscribe response + DCCF->>MFAF: 4. Nmfaf_3daDataManagement_Configure request + MFAF-->>DCCF: 5. Nmfaf_3daDataManagement_Configure response + + DCCF-->>DS: 8a. Nnf_EventExposure_Subscribe request + DS-->>DCCF: 9a. Nnf_EventExposure_Subscribe response + + DCCF->>ADRF: 8b. Nadrf_DataManagement_RetrievalSubscribe request + ADRF-->>DCCF: 9b. Nadrf_DataManagement_RetrievalSubscribe response + + DCCF->>NWDAF: 8c. Nnwdaf_DataManagement_Subscribe request + NWDAF-->>DCCF: 9c. Nnwdaf_DataManagement_Subscribe response + + DC->>DCCF: 10. Ndcf_DataManagement_Subscribe response + + MFAF->>ADRF: 11a. Nnf_EventExposure_Notify request + ADRF-->>MFAF: 12a. Nnf_EventExposure_Notify response + MFAF->>ADRF: 11b. Nadrf_DataManagement_RetrievalNotify request + ADRF-->>MFAF: 12b. Nadrf_DataManagement_RetrievalNotify response + MFAF->>NWDAF: 11c. Nnwdaf_DataManagement_Notify request + NWDAF-->>MFAF: 12c. Nnwdaf_DataManagement_Notify response + + MFAF->>DC: 13. Nmfaf_3caDataManagement_Notify request + DC-->>MFAF: 14. Nmfaf_3caDataManagement_Notify response + + Note left of DCCF: Data Fetch + DCCF->>MFAF: 15. Nmfaf_3caDataManagement_Fetch request + MFAF-->>DCCF: 16. Nmfaf_3caDataManagement_Fetch response + + Note left of DCCF: Unsubscribe + DC->>DCCF: 17. Ndcf_DataManagement_Unsubscribe request + DC-->>DCCF: 18. Ndcf_DataManagement_Unsubscribe response + + DCCF->>UDM: 18a. Nudm_SDM_Notify request + UDM-->>DCCF: 18b. Nudm_SDM_Notify response + DCCF->>UDM: 18c. Nudm_SDM_Unsubscribe request + UDM-->>DCCF: 18d. Nudm_SDM_Unsubscribe response + + DCCF-->>DS: 19a. Nnf_EventExposure_Unsubscribe request + DS-->>DCCF: 20a. Nnf_EventExposure_Unsubscribe response + DCCF->>ADRF: 19b. Nadrf_DataManagement_RetrievalUnsubscribe request + ADRF-->>DCCF: 20b. Nadrf_DataManagement_RetrievalUnsubscribe response + DCCF->>NWDAF: 19c. Nnwdaf_DataManagement_Unsubscribe request + NWDAF-->>DCCF: 20c. Nnwdaf_DataManagement_Unsubscribe response + + DCCF->>MFAF: 19d. Nmfaf_3daDataManagement_Deconfigure request + MFAF-->>DCCF: 20d. Nmfaf_3daDataManagement_Deconfigure response + +``` + +Sequence diagram for Ndcf\_DataManagement operations. Lifelines: Data Consumer, DCCF, UDM, MFAF, ADRF, NWDAF, Data Source. The diagram shows the interaction for subscribing, fetching, and unsubscribing to data management services. + +###### **Figure 5.5.3.2-1: Data Collection via DCCF and via Messaging Framework** + +1. In order to subscribe to notification(s) of events exposure via the DCCF based on local configuration, the Data Consumer invokes the Ndcf\_DataManagement\_Subscribe service operation by sending an HTTP POST request message targeting the resource "DCCF Data Subscriptions", as described in clause 4.2.2.2.4 of 3GPP TS 29.574 [15]. +- 2a. If data is to be collected for a user, i.e. for a SUPI or GPSI, the user consent has not been checked by the data consumer, and local policy and regulations require to check user consent, the DCCF invokes Nudm\_SDM\_Get service operation by sending an HTTP GET request message targeting the resource "AccessAndMobilitySubscriptionData" at the UDM to request the data type "User consent" as described in clause 5.2.2.2 of 3GPP TS 29.503 [22]. Otherwise the procedure continues with step 4. +- 3a. The UDM responds to the Nudm\_SDM\_Get service operation. If the request is accepted, the response includes the requested data with "200 OK" status code. In subsequent steps, the DCCF excludes the SUPI or GPSI from requests to collect data for users for whom the user consent is not granted. +- 2b. For the users for which the user consent is granted, the DCCF subscribes to notifications of changes of the user consent by invoking the Nudm\_SDM\_Subscribe service operation by sending an HTTP POST request message targeting the resource "SdmSubscriptions" at the UDM as described in clause 5.2.2.3 of 3GPP TS 29.503 [22]. +- 3b. The UDM responds to the Nudm\_SDM\_Subscribe service operation. If the request is accepted, the UDM responds with "201 Created" status code. +4. If the DCCF is configured to perform data delivery via the MFAF, in order to create configuration of mapping data in the MFAF, the DCCF shall invoke the Nmfa\_3daDataManagement\_Configure service operation by sending an HTTP POST request message targeting the resource "MFAF Configurations", as described in clause 4.2.2.2.2 of 3GPP TS 29.576 [17]. + +In order to update configuration of mapping data in the MFAF, the DCCF shall invoke the Nmfa\_3daDataManagement\_Configure service operation by sending an HTTP PUT request message targeting the resource "Individual MFAF Configuration", as described in clause 4.2.2.2.3 of 3GPP TS 29.576 [17]. + +5. The MFAF responds to the Nmfa\_3daDataManagement\_Configure service operation. + +Upon receipt of the HTTP POST request message, if the configuration is accepted to be created, the MFAF responds to the DCCF with "201 Created" status code, and the URI of the created configuration is included in the Location header field. + +Upon receipt of the HTTP PUT request message, if the configuration is accepted to be updated, the MFAF responds to the DCCF with "200 OK" or "204 No Content" status code. + +6. The DCCF determines the NF type(s) and/or OAM to retrieve the data based on the Service Operation requested in step 1. If the NF instance or NF Set ID is not provided by the data consumer, the DCCF determines the NF instances that can provide data as described in TS 23.288 [2] clause 5A.2 and clause 6.2.2.2. If the consumer requested storage of data in an ADRF but the ADRF ID is not provided by the data consumer, or the collected data is to be stored in an ADRF according to configuration on the DCCF, the DCCF selects an ADRF to store the collected data. + +The DCCF keeps track of the data actively being collected from the Data Sources it is coordinating. The NWDAF or ADRF may register the data collection profile (including the data collection related Service Operation, Analytics/Data Specification, NWDAF ID or ADRF ID) with the DCCF. The DCCF may then determine whether certain historical data may be available in the NWDAF or ADRF based on the data collection profile and the request time window. + +If the historical data handling is not applicable or not supported, the DCCF shall proceed with step 7a, and skip step 7b, step 8b, step 9b, step 7c, step 8c, and step 9c. + +If the historical data is available in an ADRF, the DCCF shall proceed with step 7a and step 7b, and skip step 7c, step 8c, and step 9c. + +If the historical data is available in an NWDAF, the DCCF shall proceed with step 7a and step 7c, and skip step 7b, step 8b, and step 9b. + +- 7a. The DCCF shall determine whether the data requested in step 1 are already being collected. + +If the data requested are already being collected by a data consumer, the DCCF adds the data consumer to the list of data consumers that are subscribed for these data. + +If the DCCF determines that no subscriptions need to be created or modified (e.g. because all the data can be made available either via pre-existing subscriptions or because of the historical data handling) then step 8a and step 9a are skipped. + +- 8a. If data requested in step 1 are not available yet, the DCCF shall invoke the Nnf\_EventExposure\_Subscribe service operation by sending an HTTP POST request message to the NF targeting the resource representing event exposure subscriptions to subscribe to a new event exposure subscription, e.g. as described in clause 5.5.2.2 of 3GPP TS 29.503 [22] for the UDM, clause 5.3.2.2 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.3 of 3GPP TS 29.508 [6] for the SMF, clause 4.2.2.2 of 3GPP TS 29.591 [11] for the NEF, or clause 4.2.2 of 3GPP TS 29.517 [12] for the AF. + +Otherwise, if the requested data subscribed in step 1 partially matches data that is already being collected by the DCCF from an NF, and a modification of this subscription to the NF would satisfy both the existing data subscriptions as well as the newly requested data, the DCCF shall send a request to the individual event exposure subscription resource to update an existing event exposure subscription, e.g. as described in clause 5.5.2.5 of 3GPP TS 29.503 [22] for the UDM, clause 5.3.2.2.3 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.3.3 of 3GPP TS 29.508 [6] for the SMF, clause 4.2.2.2.3 of 3GPP TS 29.591 [11] for the NEF, or clause 4.2.2.3 of 3GPP TS 29.517 [12] for the AF. + +- 9a. The NF responds to the Nnf\_EventExposure\_Subscribe service operation. + +Upon receipt of the HTTP POST request message, if the subscription is accepted to be created, the NF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +Upon receipt of the HTTP PUT request message, if the subscription is accepted to be updated, the NF responds to the DCCF with "200 OK" or "204 No Content" status code. + +- 7b. If the historical data handling is applicable, and the DCCF determines to retrieve data from the ADRF, the DCCF shall determine which ADRF instances might provide the data. + +- 8b. In order to retrieve the historical data from the ADRF, the DCCF shall invoke the Nadrf\_DataManagement\_RetrievalSubscribe service operation by sending an HTTP POST request message targeting the resource "ADRF Data Retrieval Subscriptions", as described in clause 4.2.2.6 of 3GPP TS 29.575 [16]. + +- 9b. The ADRF responds to the Nadrf\_DataManagement\_RetrievalSubscribe service operation. + +Upon receipt of the HTTP POST request message, if the subscription is accepted to be created, the ADRF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +- 7c. If the historical data handling is applicable, and the DCCF determines to retrieve data from the NWDAF, the DCCF shall determine which NWDAF instances might provide the data. + +- 8c. In order to retrieve the historical data from the NWDAF, the DCCF shall invoke the Nnwdaf\_DataManagement\_Subscribe service operation by sending an HTTP POST request message targeting the resource "NWDAF Data Management Subscriptions", as described in clause 4.4.2.2 of 3GPP TS 29.520 [5]. + +- 9c. The NWDAF responds to the Nnwdaf\_DataManagement\_Subscribe service operation. + +Upon receipt of the HTTP POST request message, if the subscription is accepted to be created, the NWDAF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +10. The DCCF responds to the Ndccf\_DataManagement\_Subscribe service operation with HTTP "204 No Content" status code. + +- 11a. When the data are available, the NF invokes the Nnf\_EventExposure\_Notify service operation by sending an HTTP POST request message to notify the data events to the MFAF, e.g. as described in clause 5.5.2.4 of 3GPP TS 29.503 [22] for the UDM, clause 5.3.2.4 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.2 of + +3GPP TS 29.508 [6] for the SMF, clause 4.2.2.4 of 3GPP TS 29.591 [11] for the NEF, or clause 4.2.4 of 3GPP TS 29.517 [12] for the AF. + +12a. The MFAF responds to the Nnf\_EventExposure\_Notify service operation with HTTP "204 No Content" status code. + +11b. When the historical data are available in the ADRF, the ADRF shall invoke the Nadrdf\_DataManagement\_RetrievalNotify service operation by sending an HTTP POST request message to notify the historical data or Fetch Instructions to the MFAF as described in clause 4.2.2.8 of 3GPP TS 29.575 [16]. + +12b. The MFAF responds to the Nadrdf\_DataManagement\_RetrievalNotify service operation with HTTP "204 No Content" status code. + +11c. When the historical data are available in the NWDAF, the NWDAF shall invoke the Nnwddf\_DataManagement\_Notify service operation by sending an HTTP POST request message to notify the historical data to the MFAF as described in clause 4.4.2.4 of 3GPP TS 29.520 [5]. + +12c. The MFAF responds to the Nnwddf\_DataManagement\_Notify service operation with HTTP "204 No Content" status code. + +13. The MFAF invokes the Nmfaf\_3caDataManagement\_Notify service operation by sending HTTP POST request message(s) to send the data to all notification endpoints indicated in step 1. Data sent to notification endpoints may be processed and formatted by the MFAF so they conform to delivery requirements for each NF service consumer or notification endpoint. + +NOTE: According to Formatting Instructions provided by the NF service consumer, multiple notifications from a NF can be combined in a single Nmfaf\_3caDataManagement\_Notify so that many notifications from an NF results in fewer notifications (or one notification) to the Data Consumer. Alternatively, a notification can instruct the data notification endpoint to fetch the data from the MFAF. + +14. The NF service consumer responds to the Nmfaf\_3caDataManagement\_Notify service operation with HTTP "204 No Content" status code. + +15. The Data Consumer invokes the Nmfaf\_3caDataManagement\_Fetch service operation by sending an HTTP GET request message as described in clause 4.2.2.5 of 3GPP TS 29.574 [15] to fetch the data from the DCCF before an expiry time, if the fetch instruction was received in Nmfaf\_3caDataManagement\_Notify service operation in step 13. + +16. The MFAF responds to the Nmfaf\_3caDataManagement\_Fetch service operation with HTTP "200 OK" status code with the message body containing the NmfafResourceRecord data structure. + +17. When the NF service consumer no longer needs the subscription to the requested data in step 1, it shall invoke the Ndccf\_DataManagement\_Unsubscribe service operation by sending an HTTP DELETE request message as described in clause 4.2.2.3.3 of 3GPP TS 29.574 [15]. The DCCF removes the NF service consumer from the list of NF service consumers that are subscribed for these data. + +18. The DCCF responds to the Ndccf\_DataManagement\_Unsubscribe service operation with HTTP "204 No Content" status code, if the NF service consumer is successfully removed from the list of NF service consumers that are subscribed for these data. + +18a. If the user consent changes and the DCCF has subscribed to UDM to notifications of user consent change for a user, the UDM invokes Nudm\_SDM\_Notification service operation by sending an HTTP POST request as described in clause 5.2.2.5 of 3GPP TS 29.503 [22]. + +18b. The DCCF responds to the Nudm\_SDM\_Notification service operation with "204 No Content". + +18c. The DCCF may invoke Nudm\_SDM\_Unsubscribe service operation by sending an HTTP DELETE request as described in clause 5.2.2.4 of 3GPP TS 29.503 [22] to unsubscribe from UDM to be notified of user consent change for each user whose user consent is revoked. + +18d. If the deletion request is accepted, the UDM responds to the Nudm\_SDM\_Unsubscribe service operation with "204 No Content". + +- 19a. If there are no other NF service consumers subscribed to the data or the user consent for a user, i.e. for a SUPI or GPSI, is no longer granted, the DCCF invokes the Nnf\_EventExposure\_Unsubscribe service operation by sending an HTTP DELETE request message to the Data Source, e.g. as described in clause 5.5.2.3 of 3GPP TS 29.503 [22] for the UDM, clause 5.3.2.3 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.4 of 3GPP TS 29.508 [6] for the SMF, clause 4.2.2.3 of 3GPP TS 29.591 [11] for the NEF, or clause 4.2.3 in 3GPP TS 29.517 [12] for the AF. +- 20a. The Data Source responds to the Nnf\_EventExposure\_Unsubscribe service operation with HTTP "204 No Content" status code, if the data event(s) subscription is successfully removed. +- 19b. If DCCF determines that no other NF service consumers requiring the historical data from the ADRF, the DCCF may invoke the Nadrf\_DataManagement\_RetrievalUnsubscribe service operation by sending an HTTP DELETE request message to the ADRF as described in clause 4.2.2.7 of 3GPP TS 29.575 [16]. +- 20b. The ADRF responds to the Nadrf\_DataManagement\_RetrievalUnsubscribe service operation with HTTP "204 No Content" status code, upon the data retrieval subscription is removed. +- 19c. If DCCF determines that no other NF service consumers require the historical data from the NWDAF, the DCCF may invoke the Nnwdaf\_DataManagement\_Unsubscribe service operation by sending an HTTP DELETE request message to the NWDAF as described in clause 4.4.2.3 of 3GPP TS 29.520 [5]. +- 20c. The NWDAF responds to the Nnwdaf\_DataManagement\_Unsubscribe service operation with HTTP "204 No Content" status code, upon the data subscription is removed. +- 19d. When the DCCF determines that an NF service consumer mapping has to be removed from MFAF, the DCCF invokes the Nmfaf\_3daDataManagement\_Deconfigure service operation by sending an HTTP DELETE request message to the MFAF as described in clause 4.2.2.3 of 3GPP TS 29.576 [17]. +- 20d. The MFAF responds to the Nmfaf\_3daDataManagement\_Deconfigure service operation with HTTP "204 No Content" status code, if the individual resource linked to the delete request is successfully removed. + +### 5.5.4 Procedure for Data Collection in Roaming Case + +#### 5.5.4.1 Data Collection by H-RE-NWDAF from V-RE-NWDAF for outbound roaming users + +The procedure depicted in Figure 5.5.4.1-1 is used by the H-RE-NWDAF as service consumer to subscribe/unsubscribe to notifications about data event exposure from the VPLMN for outbound roaming users. + +![Sequence diagram illustrating data collection by H-RE-NWDAF from V-RE-NWDAF for outbound roaming users. The diagram shows interactions between HPLMN (H-RE-NWDAF) and VPLMN (V-RE-NWDAF).](40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg) + +``` + +sequenceDiagram + participant H-RE-NWDAF as H-RE-NWDAF + participant V-RE-NWDAF as V-RE-NWDAF + Note left of H-RE-NWDAF: 1. Check user consent + Note left of H-RE-NWDAF: 2. Discover V-RE-NWDAF + H-RE-NWDAF->>V-RE-NWDAF: 3. Nnwdaf_RoamingData_Subscribe request / Nnwdaf_RoamingData_Unsubscribe request + Note right of V-RE-NWDAF: 4a. Authorize request based on operator policy, possibly dependent on HPLMN + V-RE-NWDAF-->>H-RE-NWDAF: 4b. Nnwdaf_RoamingData_Subscribe response / Nnwdaf_RoamingData_Unsubscribe response + Note right of V-RE-NWDAF: 5. collect related data + Note right of V-RE-NWDAF: 6. Apply possible policy to restrict data, possibly dependent on HPLMN + Note right of V-RE-NWDAF: 7a. Nnwdaf_RoamingData_Notify request + Note right of V-RE-NWDAF: 7b. Nnwdaf_RoamingData_Notify response + V-RE-NWDAF-->>H-RE-NWDAF: 7a. Nnwdaf_RoamingData_Notify request + H-RE-NWDAF-->>V-RE-NWDAF: 7b. Nnwdaf_RoamingData_Notify response + +``` + +Sequence diagram illustrating data collection by H-RE-NWDAF from V-RE-NWDAF for outbound roaming users. The diagram shows interactions between HPLMN (H-RE-NWDAF) and VPLMN (V-RE-NWDAF). + +**Figure 5.5.4.1-1: data collection by H-RE-NWDAF from V-RE-NWDAF for outbound roaming users** + +1. For subscription to collected data related to the outbound roaming UE(s), the H-RE-NWDAF checks the user consent of related users. +2. The H-RE-NWDAF of HPLMN discovers V-RE-NWDAF of VPLMN that supports the Nnwdaf\_RoamingData service using the NRF as specified for roaming case in clause 5.8.2.3. + +NOTE 1: The access to the Nnf\_EventExposure services is expected to be restricted to NF service consumers within the same PLMN to prevent bypassing checks based on user consent and operator policy. + +3. The H-RE-NWDAF subscribes/unsubscribes to notifications about data event exposure by invoking the Nnwdaf\_RoamingData\_Subscribe / Nnwdaf\_RoamingData\_Unsubscribe service operation message as described in clause 4.8.2.2 and clause 4.8.2.3 of 3GPP TS 29.520 [5]. +- 4a. The V-RE-NWDAF checks whether the HPLMN is authorised to request the input data based on VPLMN operator policies (that may depend on the HPLMN and may indicate permissible or restricted input data and related parameters). +- 4b. The V-RE-NWDAF responds to the H-RE-NWDAF with Nnwdaf\_RoamingData\_Subscribe / Nnwdaf\_RoamingData\_Unsubscribe service operation message as described in clause 4.8.2.2 and clause 4.8.2.3 of 3GPP TS 29.520 [5]. +5. The V-RE-NWDAF triggers new data collection from NF(s) as described in clause 5.5.1 or clause 5.5.1. +6. The V-RE-NWDAF may restrict the exposed input data based on VPLMN operator policies (that may depend on the HPLMN) and may store them for auditing. +- 7a-7b. The V-RE-NWDAF notifies data to the H-RE-NWDAF as described in clause 4.8.2.4 of 3GPP TS 29.520 [5]. + +NOTE 2: For details of Nnwdaf\_RoamingData\_Subscribe/Unsubscribe/Notify service operations refer to 3GPP TS 29.520 [5]. + +#### 5.5.4.2 Data Collection by V-RE-NWDAF from H-RE-NWDAF for inbound roaming users + +The procedure depicted in Figure 5.5.4.2-1 is used by the V-RE-NWDAF as service consumer to subscribe/unsubscribe to notifications about data event exposure from the HPLMN for inbound roaming users. + +![Sequence diagram showing data collection by V-RE-NWDAF from H-RE-NWDAF for inbound roaming users. The diagram is split into two vertical lanes: VPLMN (left) and HPLMN (right). In the VPLMN lane, there is a box for 'V-RE-NWDAF' and a box for '1. Discover H-RE-NWDAF'. In the HPLMN lane, there is a box for 'H-RE-NWDAF'. The sequence of messages is: 1. A solid line from '1. Discover H-RE-NWDAF' to 'H-RE-NWDAF'. 2. A solid line from 'V-RE-NWDAF' to 'H-RE-NWDAF' labeled '2. Nnwdaf_RoamingData_Subscribe request/ Nnwdaf_RoamingData_Unsubscribe request'. 3. A solid line from 'H-RE-NWDAF' to a box '3a. Authorize request, depending on user consent and operator policy'. 3b. A solid line from this box to 'V-RE-NWDAF' labeled '3b. Nnwdaf_RoamingData_Subscribe response/ Nnwdaf_RoamingData_Unsubscribe response'. 4. A dashed line from 'H-RE-NWDAF' to a box '4. Collect related data'. 5. A dashed line from '4. Collect related data' to a box '5. Apply possible policy to restrict data, possibly dependent on VPLMN'. 6a. A dashed line from 'H-RE-NWDAF' to 'V-RE-NWDAF' labeled '6a. Nnwdaf_RoamingData_Notify request'. 6b. A dashed line from 'V-RE-NWDAF' to 'H-RE-NWDAF' labeled '6b. Nnwdaf_RoamingData_Notify response'.](df1966d80c74bc127f159a48f38b13ee_img.jpg) + +Sequence diagram showing data collection by V-RE-NWDAF from H-RE-NWDAF for inbound roaming users. The diagram is split into two vertical lanes: VPLMN (left) and HPLMN (right). In the VPLMN lane, there is a box for 'V-RE-NWDAF' and a box for '1. Discover H-RE-NWDAF'. In the HPLMN lane, there is a box for 'H-RE-NWDAF'. The sequence of messages is: 1. A solid line from '1. Discover H-RE-NWDAF' to 'H-RE-NWDAF'. 2. A solid line from 'V-RE-NWDAF' to 'H-RE-NWDAF' labeled '2. Nnwdaf\_RoamingData\_Subscribe request/ Nnwdaf\_RoamingData\_Unsubscribe request'. 3. A solid line from 'H-RE-NWDAF' to a box '3a. Authorize request, depending on user consent and operator policy'. 3b. A solid line from this box to 'V-RE-NWDAF' labeled '3b. Nnwdaf\_RoamingData\_Subscribe response/ Nnwdaf\_RoamingData\_Unsubscribe response'. 4. A dashed line from 'H-RE-NWDAF' to a box '4. Collect related data'. 5. A dashed line from '4. Collect related data' to a box '5. Apply possible policy to restrict data, possibly dependent on VPLMN'. 6a. A dashed line from 'H-RE-NWDAF' to 'V-RE-NWDAF' labeled '6a. Nnwdaf\_RoamingData\_Notify request'. 6b. A dashed line from 'V-RE-NWDAF' to 'H-RE-NWDAF' labeled '6b. Nnwdaf\_RoamingData\_Notify response'. + +**Figure 5.5.4.2-1: Data Collection by V-RE-NWDAF from H-RE-NWDAF for inbound roaming users** + +1. The V-RE-NWDAF of VPLMN discovers H-RE-NWDAF of HPLMN that supports the Nnwdaf\_RoamingData service using the NRF as specified in clause 5.8.2.3. + +NOTE 1: The access to the Nnf\_EventExposure services is expected to be restricted to NF service consumers within the same PLMN to prevent bypassing checks based on user consent and operator policy. + +2. The V-RE-NWDAF subscribes/unsubscribes to data event exposure by invoking Nnwdaf\_RoamingData\_Subscribe / Nnwdaf\_RoamingData\_Unsubscribe service operation message as described in clause 4.8.2.2 and clause 4.8.2.3 of 3GPP TS 29.520 [5]. +- 3a. The H-RE-NWDAF checks if the VPLMN is authorised to subscribe to the indicated input data based on HPLMN operator policies (that may depend on the VPLMN and may indicate permissible or restricted input data and related parameters) and user consent of related users. +- 3b. The H-RE-NWDAF responds to the V-RE-NWDAF with Nnwdaf\_RoamingData\_Subscribe / Nnwdaf\_RoamingData\_Unsubscribe service operation message as described in clause 4.8.2.2 and clause 4.8.2.3 of 3GPP TS 29.520 [5]. +4. The H-RE-NWDAF triggers new data collection if needed and monitors the requested input data, using procedures as described in clauses 6.2.1 to 6.2.8. +5. The H-RE-NWDAF may restrict the exposed input data based on HPLMN operator policies (that may depend on the VPLMN) and may store them for auditing. + +6a-6b. The H-RE-NWDAF notifies data event to the V-RE-NWDAF as described in clause 4.8.2.4 of 3GPP TS 29.520 [5]. + +NOTE 2: For details of Nnwdaf\_RoamingData\_Subscribe/Unsubscribe/Notify service operations refer to 3GPP TS 29.520 [5]. + +## 5.6 ML Model provisioning procedures + +### 5.6.1 General + +The ML Model provisioning procedures allow the NF service consumers (i.e. NWDAF (MTLF+AnLF), NWDAF (AnLF)) to obtain the ML model information on the related Analytics from another NWDAF (i.e. an NWDAF containing MTLF). + +### 5.6.2 ML Model Subscribe/Unsubscribe/Notify procedure + +The procedure is used by an NF service consumer to subscribe to/unsubscribe from the ML model information on the related Analytics on NWDAF containing MTLF, and also used by the NWDAF containing MTLF to notify the ML model information to the NF service consumer if it subscribed to the ML model information previously. + +![Sequence diagram of the ML Model Subscribe/Unsubscribe/Notify procedure between an NF Service Consumer and an NWDAF containing MTLF.](e3eebf9854831ba50eca8b26c468f65e_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant NWDAF containing MTLF + Note right of NF Service Consumer: In order to subscribe to ML model information, the NF service consumer invokes Nnwdaf_MLModelProvision_Subscribe service operation by sending an HTTP POST request targeting the resource "NWDAF ML Model Provision Subscriptions", as described in clause 4.5.2.2 of 3GPP TS 29.520 [5]. See 3GPP TS 29.520 [5] clause 5.4 for details. + Note right of NF Service Consumer: In order to modify the existing subscription, the NF service consumer invokes Nnwdaf_MLModelProvision_Subscribe service operation by sending an HTTP PUT request with Resource URI of the resource "Individual NWDAF ML Model Provision Subscription". + Note right of NWDAF containing MTLF: Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NWDAF containing MTLF responds to the NF service consumer with "201 Created", and the URI of the created subscription is included in the Location header field. + Note right of NWDAF containing MTLF: Upon receipt of the HTTP PUT request, if the subscription is accepted to be updated, the NWDAF containing MTLF responds to the NF service consumer an HTTP "200 OK" with a response body containing a representation of the updated subscription or "204 No Content". + NF Service Consumer->>NWDAF containing MTLF: 1. Nnwdaf_MLModelProvision_Subscribe request + NWDAF containing MTLF-->>NF Service Consumer: 2. Nnwdaf_MLModelProvision_Subscribe response + Note right of NWDAF containing MTLF: Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NWDAF containing MTLF notifies the NF service consumer by sending an HTTP NOTIFY request targeting the resource "NWDAF ML Model Provision Subscriptions", as described in clause 4.5.2.2 of 3GPP TS 29.520 [5]. See 3GPP TS 29.520 [5] clause 5.4 for details. + Note right of NWDAF containing MTLF: Upon receipt of the HTTP PUT request, if the subscription is accepted to be updated, the NWDAF containing MTLF notifies the NF service consumer an HTTP NOTIFY request with Resource URI of the resource "Individual NWDAF ML Model Provision Subscription". + NWDAF containing MTLF-->>NF Service Consumer: 3. Nnwdaf_MLModelProvision_Notify request + NF Service Consumer-->>NWDAF containing MTLF: 4. Nnwdaf_MLModelProvision_Notify response + Note right of NF Service Consumer: In order to unsubscribe from ML model information, the NF service consumer invokes Nnwdaf_MLModelProvision_Unsubscribe service operation by sending an HTTP DELETE request targeting the resource "Individual NWDAF ML Model Provision Subscription", as described in clause 4.5.2.2 of 3GPP TS 29.520 [5]. See 3GPP TS 29.520 [5] clause 5.4 for details. + NF Service Consumer->>NWDAF containing MTLF: 5. Nnwdaf_MLModelProvision_Unsubscribe request + NWDAF containing MTLF-->>NF Service Consumer: 6. Nnwdaf_MLModelProvision_Unsubscribe response +``` + +Sequence diagram of the ML Model Subscribe/Unsubscribe/Notify procedure between an NF Service Consumer and an NWDAF containing MTLF. + +Figure 5.6.2-1: ML Model Subscribe/Unsubscribe/Notify procedure + +1. In order to subscribe to ML model information, the NF service consumer invokes Nnwdaf\_MLModelProvision\_Subscribe service operation by sending an HTTP POST request targeting the resource "NWDAF ML Model Provision Subscriptions", as described in clause 4.5.2.2 of 3GPP TS 29.520 [5]. See 3GPP TS 29.520 [5] clause 5.4 for details. + +In order to modify the existing subscription, the NF service consumer invokes Nnwdaf\_MLModelProvision\_Subscribe service operation by sending an HTTP PUT request with Resource URI of the resource "Individual NWDAF ML Model Provision Subscription". + +2. The NWDAF containing MTLF responds to the Nnwdaf\_MLModelProvision\_Subscribe service operation. Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NWDAF containing MTLF responds to the NF service consumer with "201 Created", and the URI of the created subscription is included in the Location header field. + +Upon receipt of the HTTP PUT request, if the subscription is accepted to be updated, the NWDAF containing MTLF responds to the NF service consumer an HTTP "200 OK" with a response body containing a representation of the updated subscription or "204 No Content". + +3. If the NWDAF containing MTLF determines that the subscribed ML model information is available, the NWDAF containing MTLF invokes Nnwdaf\_MLModelProvision\_Notify service operation to report the ML model information by sending an HTTP POST request to the NF service consumer identified by the notification URI received during the creation/modification of the subscriptions, as described in clause 4.5.2.4 of 3GPP TS 29.520 [5]. +4. The NF service consumer responds to the NWDAF containing MTLF with an HTTP "204 No Content" message. +5. In order to unsubscribe from the notification(s) of the ML model information, the NF service consumer invokes Nnwdaf\_MLModelProvision\_Unsubscribe service operation by sending an HTTP DELETE request, which targets the resource "Individual NWDAF ML Model Provision Subscription", to the NWDAF containing MTLF. +6. If the request is accepted, the NWDAF containing MTLF deletes the subscription and responds to the NF service consumer with an HTTP "204 No Content" message. + +NOTE: For details of Nnwdaf\_MLModelProvision\_Subscribe/Unsubscribe/Notify service operations refer to 3GPP TS 29.520 [5]. + +## 5.6A ML Model Training procedures + +### 5.6A.1 General + +The ML Model training procedures allow the NF service consumers (i.e. NWDAF containing MTLF) to subscribe to another NWDAF (i.e. an NWDAF containing MTLF) for a trained ML model and/or the information about ML model training based on the ML model file or ML Model information provided by the consumer and the data for the training. + +### 5.6A.2 ML Model Training Subscribe/Unsubscribe/Notify procedure + +The procedure is used by an NF service consumer to subscribe to/unsubscribe from the ML model training, and also used by the NWDAF containing MTLF to notify the ML model and/or ML model training information to the NF service consumer if it subscribed to the ML model and/or ML model training information previously. + +![Sequence diagram of ML Model Training Subscribe/Unsubscribe/Notify procedure](dc37a040cf9e2add7488c7c37cbf3687_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant NWDAF containing MTLF + Note left of NF Service Consumer: NF Service Consumer + Note right of NWDAF containing MTLF: NWDAF containing MTLF + NF Service Consumer->>NWDAF containing MTLF: 1. Nnwdaf_MLModelTraining_Subscribe request + NWDAF containing MTLF-->>NF Service Consumer: 2. Nnwdaf_MLModelTraining_Subscribe response + Note left of NF Service Consumer: + NWDAF containing MTLF-->>NF Service Consumer: 3. Nnwdaf_MLModelTraining_Notify request + NF Service Consumer-->>NWDAF containing MTLF: 4. Nnwdaf_MLModelTraining_Notify response + Note left of NF Service Consumer: + NF Service Consumer->>NWDAF containing MTLF: 5. Nnwdaf_MLModelTraining_Unsubscribe request + NWDAF containing MTLF-->>NF Service Consumer: 6. Nnwdaf_MLModelTraining_Unsubscribe response +``` + +The diagram illustrates the interaction between an NF Service Consumer and an NWDAF containing MTLF. It consists of six numbered steps: 1. Nnwdaf\_MLModelTraining\_Subscribe request (solid arrow from consumer to NWDAF), 2. Nnwdaf\_MLModelTraining\_Subscribe response (dashed arrow from NWDAF to consumer), 3. Nnwdaf\_MLModelTraining\_Notify request (solid arrow from NWDAF to consumer), 4. Nnwdaf\_MLModelTraining\_Notify response (dashed arrow from consumer to NWDAF), 5. Nnwdaf\_MLModelTraining\_Unsubscribe request (solid arrow from consumer to NWDAF), and 6. Nnwdaf\_MLModelTraining\_Unsubscribe response (dashed arrow from NWDAF to consumer). The consumer initiates the sequence with a subscribe request and ends it with an unsubscribe request. The NWDAF responds to these requests and sends a notify request when available. + +Sequence diagram of ML Model Training Subscribe/Unsubscribe/Notify procedure + +Figure 5.6A.2-1: ML Model Training Subscribe/Unsubscribe/Notify procedure + +1. In order to subscribe to ML model and/or ML model training information, the NF service consumer invokes Nnwdaf\_MLModelTraining\_Subscribe service operation by sending an HTTP POST request targeting the resource "NWDAF ML Model Training Subscriptions", as described in clause 4.6.2.2 of 3GPP TS 29.520 [5]. See 3GPP TS 29.520 [5] clause 5.5 for details. + +In order to modify the existing subscription, the NF service consumer invokes Nnwdaf\_MLModelTraining\_Subscribe service operation by sending an HTTP PUT request or an HTTP PATCH request with Resource URI of the resource "Individual NWDAF ML Model Training Subscription". + +2. The NWDAF containing MTLF responds to the Nnwdaf\_MLModelTraining\_Subscribe service operation. Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NWDAF containing MTLF responds to the NF service consumer with "201 Created", and the URI of the created subscription is included in the Location header field. + +Upon receipt of the HTTP PUT request or the HTTP PATCH request, if the subscription is accepted to be updated, the NWDAF containing MTLF responds to the NF service consumer an HTTP "200 OK" with a response body containing a representation of the updated subscription or "204 No Content". + +3. If the NWDAF containing MTLF determines that the subscribed ML model and/or ML model training information is available, the NWDAF containing MTLF invokes Nnwdaf\_MLModelTraining\_Notify service operation to report the ML model and/or ML model training information by sending an HTTP POST request to the NF service consumer identified by the notification URI received during the creation/modification of the subscriptions, as described in clause 4.6.2.4 of 3GPP TS 29.520 [5]. +4. The NF service consumer responds to the NWDAF containing MTLF with an HTTP "204 No Content" message. +5. In order to unsubscribe from the notification(s) of the ML model and/or ML model training information, the NF service consumer invokes Nnwdaf\_MLModelTraining\_Unsubscribe service operation by sending an HTTP DELETE request, which targets the resource "Individual NWDAF ML Model Training Subscription", to the NWDAF containing MTLF. +6. If the request is accepted, the NWDAF containing MTLF deletes the subscription and responds to the NF service consumer with an HTTP "204 No Content" message. + +NOTE: For details of Nnwdaf\_MLModelTraining\_Subscribe/Unsubscribe/Notify service operations refer to 3GPP TS 29.520 [5]. + +## 5.7 Procedures for Specific Network Data Analytics + +### 5.7.1 General + +### 5.7.2 Network Slice (Instance) load level Analytics + +This procedure is used by the NF to obtain the network slice (instance) load level analytics which are calculated by the NWDAF based on the information collected from the NSACF, NRF, AMF, SMF and/or OAM. If the NF is an AF which is untrusted, the AF will request analytics via the NEF as described in clause 5.2.3.2. + +![Sequence diagram showing the procedure for Network Slice (Instance) load level Analytics. Lifelines: NF, NWDAF, NSACF, NRF, AMF, SMF, NSSF, OAM. The diagram illustrates the interaction between these network functions to collect and derive analytics data.](7ed5d5770331f31ade15439a21c31425_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant NSACF + participant NRF + participant AMF + participant SMF + participant NSSF + participant OAM + + Note left of NF: 1. Analytics requests and subscriptions + 1a. NWDAF->>NF: Nnwdaf_AnalyticsInfo_Request request + 1b. NWDAF->>NF: Nnwdaf_EventsSubscription_Subscribe request + 1c. NF-->>NWDAF: Nnwdaf_EventsSubscription_Subscribe response + + Note left of NWDAF: 2. NRF Discovery + 2a. NWDAF->>NRF: Nnrf_NFDiscovery_Request request + 2b. NRF-->>NWDAF: Nnrf_NFDiscovery_Request response + + Note left of NSACF: 3. NSSF Selection + 3a. NSACF->>NSSF: Nnssf_NSSelection_Get request + 3b. NSSF-->>NSACF: Nnssf_NSSelection_Get response + + Note left of NWDAF: 4-5. NF Management Subscriptions + 4a. NWDAF->>NF: Nnrf_NFManagement_NFStatusSubscribe request + 4b. NF-->>NWDAF: Nnrf_NFManagement_NFStatusSubscribe response + 5a. NWDAF->>NF: Nnrf_NFManagement_NFStatusNotify request + 5b. NF-->>NWDAF: Nnrf_NFManagement_NFStatusNotify response + + Note left of AMF: 6-7. AMF Event Exposure + 6a. NWDAF->>AMF: Namf_EventExposure_Subscribe request + 6b. AMF-->>NWDAF: Namf_EventExposure_Subscribe response + 7a. AMF->>NWDAF: Namf_EventExposure_Notify request + 7b. NWDAF-->>AMF: Namf_EventExposure_Notify response + + Note left of SMF: 8-9. SMF Event Exposure + 8a. NWDAF->>SMF: Nsmf_EventExposure_Subscribe request + 8b. SMF-->>NWDAF: Nsmf_EventExposure_Subscribe response + 9a. SMF->>NWDAF: Nsmf_EventExposure_Notify request + 9b. NWDAF-->>SMF: Nsmf_EventExposure_Notify response + + Note left of OAM: 10. Data collection from OAM + 10. NWDAF->>OAM: Data collection from OAM + + Note left of NSACF: 11-12. Slice Event Exposure + 11a. NSACF->>NWDAF: Nnsacf_SliceEventExposure_Subscribe request + 11b. NWDAF-->>NSACF: Nnsacf_SliceEventExposure_Subscribe response + 12a. NSACF->>NWDAF: Nnsacf_SliceEventExposure_Notify request + 12b. NWDAF-->>NSACF: Nnsacf_SliceEventExposure_Notify response + + Note left of NWDAF: 13. Analytics derivation + 13. NWDAF derives Network Slice (Instance) load level Analytics + + Note left of NF: 14. Analytics responses and notifications + 14a. NWDAF-->>NF: Nnwdaf_AnalyticsInfo_Request response + 14b. NWDAF->>NF: Nnwdaf_EventsSubscription_Notify request + 14c. NF-->>NWDAF: Nnwdaf_EventsSubscription_Notify response + + Note left of NWDAF: 15-16. AMF Notifications + 15a. NWDAF->>AMF: Nnrf_NFManagement_NFStatusNotify request + 15b. AMF-->>NWDAF: Nnrf_NFManagement_NFStatusNotify response + 16a. AMF->>NWDAF: Namf_EventExposure_Notify request + 16b. NWDAF-->>AMF: Namf_EventExposure_Notify response + + Note left of SMF: 17. SMF Notifications + 17a. SMF->>NWDAF: Nsmf_EventExposure_Notify request + 17b. NWDAF-->>SMF: Nsmf_EventExposure_Notify response + + Note left of OAM: 18. Data collection from OAM + 18. NWDAF->>OAM: Data collection from OAM + + Note left of NSACF: 19. Slice Event Notifications + 19a. NSACF->>NWDAF: Nnsacf_SliceEventExposure_Notify request + 19b. NWDAF-->>NSACF: Nnsacf_SliceEventExposure_Notify response + + Note left of NWDAF: 20. Analytics derivation + 20. NWDAF derives Network Slice (Instance) load level Analytics + + Note left of NF: 21. Subscription notifications + 21a. NWDAF->>NF: Nnwdaf_EventsSubscription_Notify request + 21b. NF-->>NWDAF: Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram showing the procedure for Network Slice (Instance) load level Analytics. Lifelines: NF, NWDAF, NSACF, NRF, AMF, SMF, NSSF, OAM. The diagram illustrates the interaction between these network functions to collect and derive analytics data. + +Figure 5.7.2-1: Procedure for Network Slice (Instance) load level Analytics + +- 1a. In order to obtain the network slice (instance) load level analytics, the NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 1b-1c. In order to obtain the network slice (instance) load level analytics, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. +- 2a-2b. If the event is set to "LOAD\_LEVEL\_INFORMATION" or "NSI\_LOAD\_LEVEL", the NWDAF invokes Nnrf\_NFDiscovery\_Request service operation as described in clause 5.3.2.2 of 3GPP TS 29.510 [26] to discover the AMF, SMF and NSSF instance(s) relevant to the analytics filters provided in the subscription request. The NRF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. (Only for "NSI\_LOAD\_LEVEL")The NWDAF may invoke Nnsnf\_NSSelection\_Get service operation as described in clause 5.2.2.2 of 3GPP TS 29.531 [21] to obtain the NSI ID(s) corresponding to the S-NSSAI in the subscription request. The NRF responds to the NWDAF an HTTP "201 Created" response. +- 4a-4b. (Only for "NSI\_LOAD\_LEVEL")The NWDAF may invoke Nnrf\_NFManagement\_NFStatusSubscribe service operation as described in clause 5.2.2.5 of 3GPP TS 29.510 [26] to subscribe to the resource usage information of a network slice instance obtained from its constituent NF instances. The NRF responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. (Only for "NSI\_LOAD\_LEVEL") If step 4a and step 4b are performed, the NRF may invoke Nnrf\_NFManagement\_NFStatusNotify service operation as described in clause 5.2.2.6 of 3GPP TS 29.510 [26]. The NWDAF responds to the NRF an HTTP "204 No Content" response. +- 6a-6b. The NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to subscribe to the notification of individual UE registration/deregistration registered to an S-NSSAI or to an S-NSSAI and NSI ID, or request the total number of UEs served by the AMF per S-NSSAI or per S-NSSAI and NSI ID. The AMF responds to the NWDAF an HTTP "201 Created" response. +- 7a-7b. If step 6a and step 6b are performed, the AMF invokes Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. +- 8a-8b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to subscribe to the notification of individual PDU session established or PDU session released in an S-NSSAI or request the total number of PDU Sessions established in an S-NSSAI. The SMF responds to the NWDAF an HTTP "201 Created" response. +- 9a-9b. If step 8a and step 8b are performed, the SMF may invoke Nsmf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 8a. The NWDAF responds to the SMF an HTTP "204 No Content" response. +10. The NWDAF may collect "Performance measurement" to the OAM to get the mean number of UEs registered as described in clause 5.2.1 of TS 28.552 [27], mean number of PDU sessions established as described in clause 5.3.1 of TS 28.552 [27] and/or the resource usage information of a network slice instance obtained from its constituent NF instances as described in clause 6.2 of TS 28.552 [27]. (Obtaining the resource usage information of a network slice instance is only applicable for "NSI\_LOAD\_LEVEL" event). +- 11a-11b. The NWDAF may invoke Nnsacf\_SliceEventExposure\_Subscribe service operation as described in clause 5.3.2.2 of 3GPP TS 29.536 [20] to request the number of UEs registered to the network slice and/or the number of PDU sessions established to the network slice. +- 12a-12b. The NSACF may invoke Nnsacf\_SliceEventExposure\_Notify service operation as described in clause 5.3.2.4 of 3GPP TS 29.536 [20]. The NWDAF responds to the NSACF an HTTP "204 No Content" response. +13. The NWDAF calculates the network slice (instance) load level analytics based on the data collected from AMF, SMF, NRF, NSACF and/or OAM. +- 14a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 14b-14c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. + +15a-15b. The same as step 5a and step 5b. + +16a-16b. The same as step 7a and step 7b. + +17a-17b. The same as step 9a and step 9b. + +18. The same as step 10. + +19a-19b. The same as step 12a and step 12b. + +20. The same as step 13. + +21a-21b. The same as step 14b and step 14c. + +NOTE 1: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. + +NOTE 2: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.3 Observed Service Experience Analytics + +This procedure is used by the NF to obtain the Service Experience analytics which are calculated by the NWDAF based on the information collected from the AMF, SMF, UPF, GMLC, AF, OAM and/or MDAF. If the NF is an AF which is untrusted, the AF will request analytics via the NEF as described in clause 5.2.3.2. + +![Sequence diagram showing interactions between Network Functions (NFs) in a 5G system. Lifelines: NF, NWDAF, AMF, SMF, UPF, GMLC, NEF, AF, OAM, MDAF. The diagram illustrates various request and response messages for analytics, subscriptions, and location services.](b34c69e1ec326b01c3a485b27b1df5f6_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant AMF + participant SMF + participant UPF + participant GMLC + participant NEF + participant AF + participant OAM + participant MDAF + + Note left of NF: 15. NWDAF derives Service Experience Analytics + Note left of NF: 23. NWDAF derives Service Experience Analytics + + Note right of NF: 1a. Nnwdaf_AnalyticsInfo_Request request + Note right of NF: 1b. Nnwdaf_EventsSubscription_Subscribe request + Note right of NF: 1c. Nnwdaf_EventsSubscription_Subscribe response + Note right of NF: 2a. Namf_EventExposure_Subscribe request + Note right of NF: 2b. Namf_EventExposure_Subscribe response + Note right of NF: 3a. Namf_EventExposure_Notify request + Note right of NF: 3b. Namf_EventExposure_Notify response + Note right of NF: 4a. Nsmf_EventExposure_Subscribe request + Note right of NF: 4b. Nsmf_EventExposure_Subscribe response + Note right of NF: 5a. Nsmf_EventExposure_Notify request + Note right of NF: 5b. Nsmf_EventExposure_Notify response + Note right of NF: 6a. Naf_EventExposure_Subscribe request + Note right of NF: 6b. Naf_EventExposure_Subscribe response + Note right of NF: 7a. Naf_EventExposure_Notify request + Note right of NF: 7b. Naf_EventExposure_Notify response + Note right of NF: 8a. Nnef_EventExposure_Subscribe request + Note right of NF: 8b. Naf_EventExposure_Subscribe request + Note right of NF: 8c. Naf_EventExposure_Subscribe response + Note right of NF: 8d. Nnef_EventExposure_Subscribe response + Note right of NF: 9a. Naf_EventExposure_Notify request + Note right of NF: 9b. Nnef_EventExposure_Notify request + Note right of NF: 9c. Nnef_EventExposure_Notify response + Note right of NF: 9d. Naf_EventExposure_Notify response + Note right of NF: 10a. Nsmf_EventExposure_Subscribe request + Note right of NF: 10a1. Nupf_EventExposure_Subscribe request + Note right of NF: 10a2. Nupf_EventExposure_Subscribe response + Note right of NF: 10b. Nsmf_EventExposure_Subscribe response + Note right of NF: 11a. Nupf_EventExposure_Notify request + Note right of NF: 11b. Nupf_EventExposure_Notify response + Note right of NF: 12a. Ngmlc_Location_ProvideLocation request + Note right of NF: 12b. Ngmlc_Location_ProvideLocation response + Note right of NF: 13a. Ngmlc_Location_EventNotify request + Note right of NF: 13b. Ngmlc_Location_EventNotify response + Note right of NF: 14a. NWDAF collects data from OAM + Note right of NF: 14b. NWDAF collects data from MDAF + Note right of NF: 16a. Nnwdaf_AnalyticsInfo_Request response + Note right of NF: 16b. Nnwdaf_EventsSubscription_Notify request + Note right of NF: 16c. Nnwdaf_EventsSubscription_Notify response + Note right of NF: 17a. Namf_EventExposure_Notify request + Note right of NF: 17b. Namf_EventExposure_Notify response + Note right of NF: 18a. Nsmf_EventExposure_Notify request + Note right of NF: 18b. Nsmf_EventExposure_Notify response + Note right of NF: 19a. Naf_EventExposure_Notify request + Note right of NF: 19b. Naf_EventExposure_Notify response + Note right of NF: 20a. Naf_EventExposure_Notify request + Note right of NF: 20b. Nnef_EventExposure_Notify request + Note right of NF: 20c. Nnef_EventExposure_Notify response + Note right of NF: 20d. Naf_EventExposure_Notify response + Note right of NF: 21a. Nupf_EventExposure_Notify request + Note right of NF: 21b. Nupf_EventExposure_Notify response + Note right of NF: 22a. Ngmlc_Location_EventNotify request + Note right of NF: 22b. Ngmlc_Location_EventNotify response + Note right of NF: 24a. Nnwdaf_EventsSubscription_Notify request + Note right of NF: 24b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram showing interactions between Network Functions (NFs) in a 5G system. Lifelines: NF, NWDAF, AMF, SMF, UPF, GMLC, NEF, AF, OAM, MDAF. The diagram illustrates various request and response messages for analytics, subscriptions, and location services. + +**Figure 5.7.3-1: Procedure for Service Experience Analytics** + +- 1a. In order to obtain the Service Experience analytics, the NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 1b-1c. In order to obtain the Service Experience analytics, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. +- 2a-2b. If the event is set to "SERVICE\_EXPERIENCE", the NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to subscribe to the notification of UE ID and UE location. The AMF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. If step 2a and step 2b are performed, the AMF invokes Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. +- 4a-4b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to subscribe to the notification of QFI, IP filter information, DNAI, UPF information, Application ID, DNN and S-NSSAI. The SMF responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. If step 4a and step 4b are performed, the SMF may invoke Nsmf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a. The NWDAF responds to the SMF an HTTP "204 No Content" response. +- 6a-6b. If the AF is trusted, the NWDAF may invoke Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to request the service data and performance data from AF directly. The AF responds to the NWDAF an HTTP "201 Created" response. +- 7a-7b. If step 6a and step 6b are performed, the AF may invoke Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 6a. The NWDAF responds to the AF an HTTP "204 No Content" response. +- 8a-8d. If the AF is untrusted, the NWDAF may invoke Nnef\_EventExposure\_Subscribe service operation to the NEF by sending an HTTP POST request targeting the resource "Network Exposure Event Subscriptions" and then the NEF invokes Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions". The AF responds to the NEF an HTTP "201 Created" response and then the NEF responds to the NWDAF an HTTP "201 Created" response. +- 9a-9d. If step 8a to step 8d are performed, the AF may invoke Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NEF identified by the notification URI received in step 8b and the NEF invokes Nnef\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 8a. The NWDAF responds to the NEF an HTTP "204 No Content" response and then the NEF responds to the AF an HTTP "204 No Content" response. +- 10a-10b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" as described in 3GPP TS 29.508 [6] to subscribe via the SMF to UPF information for a specific UE. The SMF subscribes to the UPF on behalf of the NWDAF using the Nupf\_EventExposure\_Subscribe service operation as described in 3GPP TS 29.564 [40] and, after having received the successful response from the UPF, it responds to the NWDAF with an HTTP "201 Created" response. +- 11a-11b. If step 10a and step 10b are performed, the UPF may invoke Nupf\_EventExposure\_Notify service operation as described in 3GPP TS 29.564 [40] by sending an HTTP POST request to the NWDAF identified by the notification URI provided in step 6a. The NWDAF responds to the UPF an HTTP "204 No Content" response. +- 12a-12b. If the NF requests fine granularity location analytics information, the NWDAF may invoke Ngmlc\_Location\_ProvideLocation service operation to retrieve UE Location and UE Location Accuracy by sending an HTTP POST request to the URI associated with the "provide-location" custom operation as described in 3GPP TS 29.515 [41] clause 5.2.2.2. The GMLC responds to the NWDAF an HTTP "201 Created" response. + +- 13a-13b. If step 12a and step 12b are performed, the GMLC may invoke Ngmlc\_Location\_EventNotify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a. The NWDAF responds to the GMLC an HTTP "204 No Content" response. +- 14a. The NWDAF may collect Reference Signal Received Power and Reference Signal Received Quality as specified in clause 5.5 of TS 38.331 [33] and clause 5.5.5 of TS 36.331 [34], Signal-to-noise and interference ratio as specified in clause 5.1 of TS 38.215 [35], the mapping information between cell ID and frequency and/or Cell Energy Saving State data as specified in clauses 3.1 and 6.2 of TS 28.310 [36] from OAM. If the NF is AF or NEF requesting per application analytics with UE granularity, the NWDAF may collect the average UL/DL RAN throughput, the UL/DL RAN packet delay and the UL/DL RAN Packet loss rate as described in clause 5.2.1.1 and 5.4.1.1 of TS 37.320 [29]. +- 14b. The NWDAF may collect service experience and energy saving state analysis as specified in clause 8.4.2.1.3 and clause 8.4.4.3 of TS 28.104 [38] from MDAF. The information element of the analysis from MDAF include ServiceExperienceIssueType, AffectedObjects, ServiceExperienceStatistics, ServiceExperiencePredictions, and StatisticsOfCellsEsState. +15. The NWDAF calculates the Service Experience analytics based on the data collected from AMF, SMF, UPF, GMLC, AF, OAM and/or MDAF. +- 16a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 16b-16c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. +- 17a-17b. The same as step 3a and step 3b. +- 18a-18b. The same as step 5a and step 5b. +- 19a-19d. The same as step 7a and step 7b. +- 20a-20d. The same as step 9a and step 9b. +- 21a-21b. The same as step 11a and step 11b. +- 22a-22b. The same as step 13a and step 13b. +23. The same as step 15. +- 24a-24b. The same as step 16b and step 16c. + +NOTE 1: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. + +NOTE 2: For details of Nnef\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.591 [11]. + +NOTE 3: For details of Naf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.517 [12]. + +### 5.7.4 NF load Analytics + +This procedure is used by the NWDAF service consumer (may be an NF, or the OAM) to obtain the NF load analytics which are calculated by the NWDAF based on the information collected from the NRF and/or the OAM, may also collect UE input data via the AF (for the untrusted AF via the NEF). If target NF type is UPF, the NWDA may collect the information from UPF. + +![Sequence diagram for NF load Analytics procedure. Lifelines: Service Consumer, NWDAF, NRF, UPF, NEF, AF, OAM. The diagram shows a series of requests and responses between these entities to collect and analyze network function load data.](fd3cbb53e991f8209ba17b398f426e13_img.jpg) + +``` + +sequenceDiagram + participant Service Consumer + participant NWDAF + participant NRF + participant UPF + participant NEF + participant AF + participant OAM + + Note left of Service Consumer: 1. Initial Requests + Service Consumer->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + Service Consumer->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>Service Consumer: 1c. Nnwdaf_EventsSubscription_Subscribe response + + Note left of NWDAF: 2. NRF Discovery + NWDAF->>NRF: 2a. Nnrf_NFDiscovery_Request request + NRF-->>NWDAF: 2b. Nnrf_NFDiscovery_Request response + + Note left of NWDAF: 3. OAM Data Collection + NWDAF->>OAM: 3. Data collection from OAM + + Note left of NWDAF: 4. NRF Management Subscriptions + NWDAF->>NRF: 4a. Nnrf_NFManagement_NFStatusSubscribe request + NRF-->>NWDAF: 4b. Nnrf_NFManagement_NFStatusSubscribe response + NWDAF->>NRF: 5a. Nnrf_NFManagement_NFStatusNotify request + NRF-->>NWDAF: 5b. Nnrf_NFManagement_NFStatusNotify response + + Note left of NWDAF: 6. UPF Data Collection + NWDAF->>UPF: 6. Data collection from UPF + + Note left of NWDAF: 7. AF Event Exposure Subscription + NWDAF->>AF: 7a. Naf_EventExposure_Subscribe request + AF-->>NWDAF: 7b. Naf_EventExposure_Subscribe response + NWDAF->>AF: 8a. Naf_EventExposure_Notify request + AF-->>NWDAF: 8b. Naf_EventExposure_Notify response + + Note left of NWDAF: 9. NEF Event Exposure Subscription + NWDAF->>NEF: 9a. Nnef_EventExposure_Subscribe request + NEF->>AF: 9b. Naf_EventExposure_Subscribe request + AF-->>NEF: 9c. Naf_EventExposure_Subscribe response + NEF-->>NWDAF: 9d. Nnef_EventExposure_Subscribe response + + Note left of NEF: 10. AF Event Exposure Notification + AF->>NEF: 10a. Naf_EventExposure_Notify request + NEF->>NWDAF: 10b. Nnef_EventExposure_Notify request + NWDAF-->>NEF: 10c. Nnef_EventExposure_Notify response + NEF-->>AF: 10d. Naf_EventExposure_Notify response + + Note left of Service Consumer: 11. NWDAF derives NF load Analytics + Service Consumer->>NWDAF: 12a. Nnwdaf_AnalyticsInfo_Request response + NWDAF->>Service Consumer: 12b. Nnwdaf_EventsSubscription_Notify request + Service Consumer-->>NWDAF: 12c. Nnwdaf_EventsSubscription_Notify response + + Note left of NWDAF: 13. OAM Data Collection + NWDAF->>OAM: 13. Data collection from OAM + + Note left of NWDAF: 14. NRF Management Notifications + NWDAF->>NRF: 14a. Nnrf_NFManagement_NFStatusNotify request + NRF-->>NWDAF: 14b. Nnrf_NFManagement_NFStatusNotify response + + Note left of NWDAF: 15. UPF Data Collection + NWDAF->>UPF: 15. Data collection from UPF + + Note left of NWDAF: 16. AF Event Exposure Notification + NWDAF->>AF: 16a. Naf_EventExposure_Notify request + AF-->>NWDAF: 16b. Naf_EventExposure_Notify response + + Note left of NWDAF: 17. NEF Event Exposure Notification + NWDAF->>NEF: 17a. Nnef_EventExposure_Notify request + NEF->>AF: 17a. Naf_EventExposure_Notify request + AF-->>NEF: 17b. Nnef_EventExposure_Notify request + NEF-->>NWDAF: 17c. Nnef_EventExposure_Notify response + NEF-->>AF: 17d. Naf_EventExposure_Notify response + + Note left of Service Consumer: 18. NWDAF derives NF load Analytics + Service Consumer->>NWDAF: 19a. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>Service Consumer: 19b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram for NF load Analytics procedure. Lifelines: Service Consumer, NWDAF, NRF, UPF, NEF, AF, OAM. The diagram shows a series of requests and responses between these entities to collect and analyze network function load data. + +Figure 5.7.4-1: Procedure for NF load Analytics + +- 1a. In order to obtain the NF load analytics, the NWDAF service consumer may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1, the requested event is set to "NF\_LOAD" with the supported feature "NfLoad". +- 1b-1c. In order to obtain the NF load analytics, the NWDAF service consumer may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1, the subscribed event is set to "NF\_LOAD" with the supported feature "NfLoad". +- 2a-2b. The NWDAF may invoke Nnrf\_NFDiscovery\_Request service operation as described in clause 5.3.2.2 of 3GPP TS 29.510 [26] for each NF, to obtain the initial NF profile which contains NF status and may contains NF load information. The NRF responds to the NWDAF an HTTP "201 Created" response. +3. The NWDAF may collect "Performance measurement" to the OAM to get the NF resource usage information as described in clause 5.7 of 3GPP TS 28.552 [27] and/or may collect the NF resource configuration change information as described in clause 5.2 of 3GPP TS 28.533 [28]. The NWDAF may also collect the MDT data information for UE as described in 3GPP TS 37.320 [29]. +- 4a-4b. The NWDAF may invoke Nnrf\_NFManagement\_NFStatusSubscribe service operation as described in clause 5.2.2.5 of 3GPP TS 29.510 [26] to subscribe to the NF status and/or NF load information. The NRF responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. If step 4a and step 4b are performed, the NRF may invoke Nnrf\_NFManagement\_NFStatusNotify service operation as described in clause 5.2.2.6 of 3GPP TS 29.510 [26]. The NWDAF responds to the NRF an HTTP "204 No Content" response. +6. If the target NF type is UPF, the NWDAF may collect traffic usage report information from UPF. + +NOTE 1: How the NWDAF collects UPF information is not defined in this release of the specification. + +- 7a-7b. If the AF is trusted, the NWDAF may invoke Naf\_EventExposure\_Subscribe service operation to the AF directly by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to collect the Collective Behaviour of UEs. The AF responds to the NWDAF an HTTP "201 Created" response. +- 8a-8b. If step 7a and step 7b are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 7a. The NWDAF responds to the AF an HTTP "204 No Content" response. +- 9a-9d. If the AF is untrusted, the NWDAF may invoke Nnef\_EventExposure\_Subscribe service operation to the NEF by sending an HTTP POST request targeting the resource "Network Exposure Event Subscriptions" and then the NEF invokes Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to collect the Collective Behaviour of UEs. The AF responds to the NEF an HTTP "201 Created" response and then the NEF responds to the NWDAF an HTTP "201 Created" response. +- 10a-10d. If step 9a to step 9d are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NEF identified by the notification URI received in step 9b and the NEF invokes Nnef\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 9a. The NWDAF responds to the NEF an HTTP "204 No Content" response and then the NEF responds to the AF an HTTP "204 No Content" response. + +11. The NWDAF calculates the NF load analytics based on the data collected from NRF, OAM, UPF and/or AF. +- 12a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 12b-12c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. +13. The same as step 3. +- 14a-14b. The same as step 5a and step 5b. +15. The same as step 6. +- 16a-16b. The same as step 8a and step 8b. + +17a-17d. The same as step 10a to step 10d. + +18. The same as step 11. + +19a-19b. The same as step 12b and step 12c. + +NOTE 2: For details of Naf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.517 [12]. + +NOTE 3: For details of Nnef\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.591 [11]. + +NOTE 4: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.5 Network Performance Analytics + +This procedure is used by the NF to obtain the network performance analytics which are calculated by the NWDAF based on the information collected from the AMF, NRF and/or OAM. If the NF is an AF which is untrusted, the AF will request analytics via the NEF as described in clause 5.2.3.2. + +![Sequence diagram for Network Performance Analytics procedure. Lifelines: NF, NWDAF, NRF, AMF, OAM. The diagram shows two parallel procedures for deriving network performance analytics. In the first, the NF sends a request to the NWDAF, which then subscribes to the NRF for NF status and discovery, and to the AMF for event exposure. The NWDAF then sends a response to the NF and notifies the OAM. In the second, the NF sends a subscription to the NWDAF, which similarly interacts with the NRF and AMF, derives analytics, and then notifies the NF and OAM.](fcc757566216206ceddbd6c775e8db02_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant NRF + participant AMF + participant OAM + + Note left of NF: 1a. Nnwdaf_AnalyticsInfo_Request request + NF->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + Note left of NF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NF->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + Note left of NF: 1c. Nnwdaf_EventsSubscription_Subscribe response + NWDAF-->>NF: 1c. Nnwdaf_EventsSubscription_Subscribe response + + Note left of NWDAF: 2a. Nnrf_NFManagement_NFStatusSubscribe request + NWDAF->>NRF: 2a. Nnrf_NFManagement_NFStatusSubscribe request + Note left of NWDAF: 2b. Nnrf_NFManagement_NFStatusSubscribe response + NRF-->>NWDAF: 2b. Nnrf_NFManagement_NFStatusSubscribe response + Note left of NWDAF: 3a. Nnrf_NFManagement_NFStatusNotify request + NWDAF->>NRF: 3a. Nnrf_NFManagement_NFStatusNotify request + Note left of NWDAF: 3b. Nnrf_NFManagement_NFStatusNotify response + NRF-->>NWDAF: 3b. Nnrf_NFManagement_NFStatusNotify response + Note left of NWDAF: 4a. Nnrf_NFDiscovery_Request request + NWDAF->>NRF: 4a. Nnrf_NFDiscovery_Request request + Note left of NWDAF: 4b. Nnrf_NFDiscovery_Request response + NRF-->>NWDAF: 4b. Nnrf_NFDiscovery_Request response + Note left of NWDAF: 5a. Namf_EventExposure_Subscribe request + NWDAF->>AMF: 5a. Namf_EventExposure_Subscribe request + Note left of NWDAF: 5b. Namf_EventExposure_Subscribe response + AMF-->>NWDAF: 5b. Namf_EventExposure_Subscribe response + Note left of NWDAF: 6a. Namf_EventExposure_Notify request + NWDAF->>AMF: 6a. Namf_EventExposure_Notify request + Note left of NWDAF: 6b. Namf_EventExposure_Notify response + AMF-->>NWDAF: 6b. Namf_EventExposure_Notify response + Note left of NWDAF: 7. Performance threshold monitoring service + NWDAF-->>OAM: 7. Performance threshold monitoring service + + Note right of NF: 8. NWDAF derives Network Performance Analytics + Note left of NF: 9a. Nnwdaf_AnalyticsInfo_Request response + NWDAF-->>NF: 9a. Nnwdaf_AnalyticsInfo_Request response + Note left of NF: 9b. Nnwdaf_EventsSubscription_Notify request + NWDAF->>NF: 9b. Nnwdaf_EventsSubscription_Notify request + Note left of NF: 9c. Nnwdaf_EventsSubscription_Notify response + NF-->>NWDAF: 9c. Nnwdaf_EventsSubscription_Notify response + + Note left of NWDAF: 10a. Nnrf_NFManagement_NFStatusNotify request + NWDAF->>NRF: 10a. Nnrf_NFManagement_NFStatusNotify request + Note left of NWDAF: 10b. Nnrf_NFManagement_NFStatusNotify response + NRF-->>NWDAF: 10b. Nnrf_NFManagement_NFStatusNotify response + Note left of NWDAF: 11a. Namf_EventExposure_Notify request + NWDAF->>AMF: 11a. Namf_EventExposure_Notify request + Note left of NWDAF: 11b. Namf_EventExposure_Notify response + AMF-->>NWDAF: 11b. Namf_EventExposure_Notify response + Note left of NWDAF: 12. Performance threshold monitoring service + NWDAF-->>OAM: 12. Performance threshold monitoring service + + Note right of NF: 13. NWDAF derives Network Performance Analytics + Note left of NF: 14a. Nnwdaf_EventsSubscription_Notify request + NWDAF->>NF: 14a. Nnwdaf_EventsSubscription_Notify request + Note left of NF: 14b. Nnwdaf_EventsSubscription_Notify response + NF-->>NWDAF: 14b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram for Network Performance Analytics procedure. Lifelines: NF, NWDAF, NRF, AMF, OAM. The diagram shows two parallel procedures for deriving network performance analytics. In the first, the NF sends a request to the NWDAF, which then subscribes to the NRF for NF status and discovery, and to the AMF for event exposure. The NWDAF then sends a response to the NF and notifies the OAM. In the second, the NF sends a subscription to the NWDAF, which similarly interacts with the NRF and AMF, derives analytics, and then notifies the NF and OAM. + +**Figure 5.7.5-1: Procedure for Network Performance Analytics** + +1a. In order to obtain the network performance analytics, the NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. + +1b-1c. In order to obtain the network performance analytics, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. + +- 2a-2b. If the event is set to "NETWORK\_PERFORMANCE", the NWDAF may invoke Nnrf\_NFManagement\_NFStatusSubscribe service operation as described in clause 5.2.2.5 of 3GPP TS 29.510 [26] to subscribe to NF (e.g. SMF, UPF) load and status information. The NRF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. If step 2a and step 2b are performed, the NRF may invoke Nnrf\_NFManagement\_NFStatusNotify service operation as described in clause 5.2.2.6 of 3GPP TS 29.510 [26]. The NWDAF responds to the NRF an HTTP "204 No Content" response. +- 4a-4b. If the event is set to "NETWORK\_PERFORMANCE" and the type of network performance is set to "NUM\_OF\_UE", the NWDAF invokes Nnrf\_NFDiscovery\_Request service operation as described in clause 5.3.2.2 of 3GPP TS 29.510 [26] to discover the AMF(s) belonging to the AMF Region(s) that include(s) the Area of Interest. The NRF responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. The NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to collect the number of UEs located in the Area of Interest from AMF. The AMF responds to the NWDAF an HTTP "201 Created" response. +- 6a-6b. If step 5a and step 5b are performed, the AMF invokes Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. +7. The NWDAF may collect "Performance measurement" to the OAM to get the status and load information and the performance per Cell Id in the Area of Interest as described in clause 5.1 of TS 28.552 [27]. +8. The NWDAF calculates the network performance analytics based on the data collected from AMF, NRF and/or OAM. +- 9a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 9b-9c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. +- 10a-10b. The same as step 3a and step 3b. +- 11a-11b. The same as step 6a and step 6b. +12. The same as step 7. +13. The same as step 8. +- 14a-14b. The same as step 9b and step 9c. + +NOTE: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.6 UE Mobility Analytics + +This procedure is used by the NF to obtain UE mobility analytics, which is calculated by the NWDAF based on the information collected from the AMF, AF and/or OAM. If the NF is an AF which is untrusted, the AF will request analytics via the NEF as described in clause 5.2.3.2. + +![Sequence diagram showing interactions between NF, NWDAF, AMF, NEF, AF, and OAM. The diagram illustrates various service requests, subscriptions, and notifications related to network analytics and event exposure.](db39acbd11df5eb7e79ab84562fb8f74_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant AMF + participant NEF + participant AF + participant OAM + + Note left of NF: 1. NWDAF derives UE Mobility Analytics + NF->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + NF->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>NF: 1c. Nnwdaf_EventsSubscription_Subscribe response + + Note left of AMF: 2. AMF derives UE Mobility Analytics + AMF->>NWDAF: 2a. Namf_EventExposure_Subscribe request + NWDAF-->>AMF: 2b. Namf_EventExposure_Subscribe response + NWDAF->>AMF: 3a. Namf_EventExposure_Notify request + AMF-->>NWDAF: 3b. Namf_EventExposure_Notify response + + Note left of AF: 4. AF derives UE Mobility Analytics + AF->>NWDAF: 4a. Naf_EventExposure_Subscribe request + NWDAF-->>AF: 4b. Naf_EventExposure_Subscribe response + NWDAF->>AF: 5a. Naf_EventExposure_Notify request + AF-->>NWDAF: 5b. Naf_EventExposure_Notify response + + Note left of NEF: 6. NEF derives UE Mobility Analytics + NEF->>NWDAF: 6a. Nnef_EventExposure_Subscribe request + NEF->>AF: 6b. Naf_EventExposure_Subscribe request + AF-->>NEF: 6c. Naf_EventExposure_Subscribe response + NEF-->>NWDAF: 6d. Nnef_EventExposure_Subscribe response + + Note left of AF: 7. AF derives UE Mobility Analytics + AF->>NEF: 7a. Naf_EventExposure_Notify request + NEF-->>AF: 7b. Nnef_EventExposure_Notify request + NEF->>AF: 7c. Nnef_EventExposure_Notify response + AF-->>NEF: 7d. Naf_EventExposure_Notify response + + Note left of OAM: 8. streaming data reporting service + OAM->>NWDAF: 8. streaming data reporting service reportStreamData + + Note left of OAM: 9. File data reporting service + OAM->>NWDAF: 9. File data reporting service subscribe or listAvailableFiles + + Note left of NWDAF: 10. NWDAF derives UE Mobility Analytics + NWDAF-->>NF: 11a. Nnwdaf_AnalyticsInfo_Request response + NWDAF->>NF: 11b. Nnwdaf_EventsSubscription_Notify request + NF-->>NWDAF: 11c. Nnwdaf_EventsSubscription_Notify response + + Note left of AMF: 12. AMF derives UE Mobility Analytics + AMF->>NWDAF: 12a. Namf_EventExposure_Notify request + NWDAF-->>AMF: 12b. Namf_EventExposure_Notify response + + Note left of AF: 13. AF derives UE Mobility Analytics + AF->>NWDAF: 13a. Naf_EventExposure_Notify request + NWDAF-->>AF: 13b. Naf_EventExposure_Notify response + + Note left of NEF: 14. NEF derives UE Mobility Analytics + NEF->>AF: 14a. Naf_EventExposure_Notify request + AF-->>NEF: 14b. Nnef_EventExposure_Notify request + NEF->>AF: 14c. Nnef_EventExposure_Notify response + AF-->>NEF: 14d. Naf_EventExposure_Notify response + + Note left of OAM: 15. File data reporting service + OAM->>NWDAF: 15. File data reporting service notification request + + Note left of NWDAF: 16. NWDAF derives UE Mobility Analytics + NWDAF-->>NF: 17a. Nnwdaf_EventsSubscription_Notify request + NF-->>NWDAF: 17b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram showing interactions between NF, NWDAF, AMF, NEF, AF, and OAM. The diagram illustrates various service requests, subscriptions, and notifications related to network analytics and event exposure. + +###### **Figure 5.7.6-1: Procedure for UE Mobility analytics** + +- 1a. In order to obtain the UE mobility analytics, the NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 1b-1c. In order to obtain the UE mobility analytics, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. +- 2a-2b. The NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18]. This step may be skipped when e.g. the UE mobility information is available. The AMF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. If step 2a and step 2b are performed, the AMF invokes Namf\_EventExposure\_Notify service operation as described in clause 5.3.2.4 of 3GPP TS 29.518 [18]. The NWDAF responds to the AMF an HTTP "204 No Content" response. +- 4a-4b. If the AF is trusted, the NWDAF may invoke Naf\_EventExposure\_Subscribe service operation to the AF directly by sending an HTTP POST request targeting the resource "Application Event Subscriptions". The AF responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. If step 4a and step 4b are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a. The NWDAF responds to the AF an HTTP "204 No Content" response. +- 6a-6d. If the AF is untrusted, the NWDAF may invoke Nnef\_EventExposure\_Subscribe service operation to the NEF by sending an HTTP POST request targeting the resource "Network Exposure Event Subscriptions" and then the NEF invokes Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions". The AF responds to the NEF an HTTP "201 Created" response and then the NEF responds to the NWDAF an HTTP "201 Created" response. +- 7a-7d. If step 6a to step 6d are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NEF identified by the notification URI received in step 6b and the NEF invokes Nnef\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 6a. The NWDAF responds to the NEF an HTTP "204 No Content" response and then the NEF responds to the AF an HTTP "204 No Content" response. +8. The NWDAF may invoke "streaming data reporting service reportStreamData" service operation to the OAM as described in clause 12.5.1.1.5 of 3GPP TS 28.532 [19]. +9. The NWDAF may invoke the "File data reporting service subscribe" service operation to the OAM as described in clause 12.6.1.1.3 of 3GPP TS 28.532 [19] or invoke "File data reporting service listAvailableFiles" service operation to the OAM as described in clause 12.6.1.1.2 of 3GPP TS 28.532 [19]. +10. The NWDAF calculates the requested UE mobility analytics based on the data collected from AMF, AF and/or OAM. +- 11a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 11b-11c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. +- 12a-12b. The same as step 3a and step 3b. +- 13a-13b. The same as step 5a and step 5b. +- 14a-14d. The same as step 7a and step 7d. +15. The same as step 9. +16. The same as step 10. +- 17a-17b. The same as step 11b and step 11c. + +NOTE 1: For details of Naf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.517 [12]. + +NOTE 2: For details of Nnef\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.591 [11]. + +NOTE 3: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.7 UE Communication Analytics + +This procedure is used by the NF to obtain UE communication analytics, which is calculated by the NWDAF based on the information collected from the AMF, SMF, UPF, and/or AF. If the NF is an AF which is untrusted, the AF will request analytics via the NEF as described in clause 5.2.3.2. + +![Sequence diagram showing network function interactions for UE Communication Analytics. Lifelines: NF, NWDAF, AMF, SMF, UPF, NEF, AF. The diagram details the flow of requests and responses for analytics information and event subscriptions between these functions.](5e9af8986a5845504f251d3079da8078_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant AMF + participant SMF + participant UPF + participant NEF + participant AF + + Note right of NWDAF: 12. NWDAF derives UE Communication Analytics + + Note right of NWDAF: 19. NWDAF derives UE Communication Analytics + + Note right of AMF: 3GPP + +``` + +The sequence diagram illustrates the following interactions: + +- 1a. Nnwdaf\_AnalyticsInfo\_Request**: NF to NWDAF +- 1b. Nnwdaf\_EventsSubscription\_Subscribe**: NF to NWDAF +- 1c. Nnwdaf\_EventsSubscription\_Subscribe response**: NWDAF to NF +- 2a. Namf\_EventExposure\_Subscribe**: NWDAF to AMF +- 2b. Namf\_EventExposure\_Subscribe response**: AMF to NWDAF +- 3a. Namf\_EventExposure\_Notify**: AMF to NWDAF +- 3b. Namf\_EventExposure\_Notify response**: NWDAF to AMF +- 4a. Nsmf\_EventExposure\_Subscribe**: NWDAF to SMF +- 4b. Nsmf\_EventExposure\_Subscribe response**: SMF to NWDAF +- 5a. Nsmf\_EventExposure\_Notify**: SMF to NWDAF +- 5b. Nsmf\_EventExposure\_Notify response**: NWDAF to SMF +- 6a. Nsmf\_EventExposure\_Subscribe**: NWDAF to SMF +- 6a1. Nupf\_EventExposure\_Subscribe**: SMF to UPF +- 6a2. Nupf\_EventExposure\_Subscribe response**: UPF to SMF +- 6b. Nsmf\_EventExposure\_Subscribe response**: SMF to NWDAF +- 7a. Nupf\_EventExposure\_Notify**: UPF to SMF +- 7b. Nupf\_EventExposure\_Notify response**: SMF to UPF +- 8a. Naf\_EventExposure\_Subscribe**: NWDAF to AF +- 8b. Naf\_EventExposure\_Subscribe response**: AF to NWDAF +- 9a. Naf\_EventExposure\_Notify**: AF to NWDAF +- 9b. Naf\_EventExposure\_Notify response**: NWDAF to AF +- 10a. Nnef\_EventExposure\_Subscribe**: NWDAF to NEF +- 10b. Naf\_EventExposure\_Subscribe**: NEF to AF +- 10c. Naf\_EventExposure\_Subscribe response**: AF to NEF +- 10d. Nnef\_EventExposure\_Subscribe response**: NEF to NWDAF +- 11a. Naf\_EventExposure\_Notify**: AF to NEF +- 11b. Nnef\_EventExposure\_Notify**: NEF to NWDAF +- 11c. Nnef\_EventExposure\_Notify response**: NWDAF to NEF +- 11d. Naf\_EventExposure\_Notify response**: NEF to AF +- 12. NWDAF derives UE Communication Analytics**: (Internal NWDAF process) +- 13a. Nnwdaf\_AnalyticsInfo\_Request response**: NWDAF to NF +- 13b. Nnwdaf\_EventsSubscription\_Notify**: NWDAF to NF +- 13c. Nnwdaf\_EventsSubscription\_Notify response**: NF to NWDAF +- 14a. Namf\_EventExposure\_Notify**: AMF to NWDAF +- 14b. Namf\_EventExposure\_Notify response**: NWDAF to AMF +- 15a. Nsmf\_EventExposure\_Notify**: SMF to NWDAF +- 15b. Nsmf\_EventExposure\_Notify response**: NWDAF to SMF +- 16a. Nupf\_EventExposure\_Notify**: UPF to NWDAF +- 16b. Nupf\_EventExposure\_Notify response**: NWDAF to UPF +- 17a. Naf\_EventExposure\_Notify**: AF to NWDAF +- 17b. Naf\_EventExposure\_Notify response**: NWDAF to AF +- 18a. Naf\_EventExposure\_Notify**: AF to NEF +- 18b. Nnef\_EventExposure\_Notify**: NEF to NWDAF +- 18c. Nnef\_EventExposure\_Notify response**: NWDAF to NEF +- 18d. Naf\_EventExposure\_Notify response**: NEF to AF +- 19. NWDAF derives UE Communication Analytics**: (Internal NWDAF process) +- 20a. Nnwdaf\_EventsSubscription\_Notify**: NWDAF to NF +- 20b. Nnwdaf\_EventsSubscription\_Notify response**: NF to NWDAF + +Sequence diagram showing network function interactions for UE Communication Analytics. Lifelines: NF, NWDAF, AMF, SMF, UPF, NEF, AF. The diagram details the flow of requests and responses for analytics information and event subscriptions between these functions. + +###### **Figure 5.7.7-1: Procedure for UE Communication analytics** + +- 1a. In order to obtain the UE communication analytics, the NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 1b-1c. In order to obtain the UE communication analytics, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. +- 2a-2b. The NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to retrieve one or more Type Allocation codes, UE connection management state, UE access behaviour trends and UE location trends from AMF. The AMF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. If step 2a and step 2b are performed, the AMF may invoke Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. +- 4a-4b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to request the information of the UE and/or N4 session related data to calculate the analytics. The SMF responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. If step 4a and step 4b are performed, the SMF may invoke Nsmf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a. The NWDAF responds to the SMF an HTTP "204 No Content" response. +- 6a-6b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" as described in 3GPP TS 29.508 [6] to subscribe via the SMF to UPF information for a specific UE. The SMF subscribes to the UPF on behalf of the NWDAF using the Nupf\_EventExposure\_Subscribe service operation as described in 3GPP TS 29.564 [40] and, after having received the successful response from the UPF, it responds to the NWDAF with an HTTP "201 Created" response. +- 7a-7b. If step 6a and step 6b are performed, the UPF may invoke Nupf\_EventExposure\_Notify service operation as described in 3GPP TS 29.564 [40] by sending an HTTP POST request to the NWDAF identified by the notification URI provided in step 6a. The NWDAF responds to the UPF an HTTP "204 No Content" response. +- 8a-8b. If the AF is trusted, the NWDAF may invoke Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to request the service data from AF directly. The AF responds to the NWDAF an HTTP "201 Created" response. +- 9a-9b. If step 8a and step 8b are performed, the AF may invoke Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 8a. The NWDAF responds to the AF an HTTP "204 No Content" response. +- 10a-10d. If the AF is untrusted, the NWDAF may invoke Nnef\_EventExposure\_Subscribe service operation to the NEF by sending an HTTP POST request targeting the resource "Network Exposure Event Subscriptions" and then the NEF invokes Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions". The AF responds to the NEF an HTTP "201 Created" response and then the NEF responds to the NWDAF an HTTP "201 Created" response. +- 11a-11d. If step 10a to step 10d are performed, the AF may invoke Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NEF identified by the notification URI received in step 8b and the NEF invokes Nnef\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 8a. The NWDAF responds to the NEF an HTTP "204 No Content" response and then the NEF responds to the AF an HTTP "204 No Content" response. +12. The NWDAF calculates the requested UE communication analytics based on the data collected from AMF, SMF, UPF and/or AF. +- 13a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 13b-13c. If step 1b and step 1c are performed, the NWDAF may invoke Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. + +14a-14b. The same as step 3a and step 3b. + +15a-15b. The same as step 5a and step 5b. + +16a-16b. The same as step 7a and step 7b. + +17a-17b. The same as step 9a and step 9b. + +18a-18d. The same as step 11a and step 11d. + +19. The same as step 12. + +20a-20b. The same as step 13b and step 13c. + +NOTE 1: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. + +NOTE 2: For details of Naf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.517 [12]. + +NOTE 3: For details of Nnef\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.591 [11]. + +NOTE 4: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.8 Expected UE behavioural Analytics + +This procedure is used by the NF to obtain the expected UE behavioural parameters, which are calculated by the NWDAF based on the information collected from the AMF, SMF, AF and/or OAM. If the NF is an AF which is untrusted, the AF will request analytics via the NEF as described in clause 5.2.3.2. + +![Sequence diagram for Expected behavioural Analytics procedure involving NF, NWDAF, AMF, SMF, NEF, AF, and OAM.](694df81535f89c7bfb9ef0df6f130dc0_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant AMF + participant SMF + participant NEF + participant AF + participant OAM + + NF->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + NF->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>NF: 1c. Nnwdaf_EventsSubscription_Subscribe response + + Note over AMF, OAM: 2a. NWDAF collects data as described in clause 5.7.6 from step 2a to step 9 + Note over AMF, OAM: 2b. NWDAF collects data as described in clause 5.7.7 from step 2a to step 9d + + Note over NWDAF: 3. NWDAF derives Expected UE +behavioural Analytics + + NWDAF-->>NF: 4a. Nnwdaf_AnalyticsInfo_Request response + NWDAF->>NF: 4b. Nnwdaf_EventsSubscription_Notify request + NF-->>NWDAF: 4c. Nnwdaf_EventsSubscription_Notify response + + Note over AMF, OAM: 5a. NWDAF receives data as described in clause 5.7.6 from step 12a to step 15 + Note over AMF, OAM: 5b. NWDAF receives data as described in clause 5.7.7 from step 12a to step 15d + + Note over NWDAF: 6. NWDAF derives Expected UE +behavioural Analytics + + NWDAF->>NF: 7a. Nnwdaf_EventsSubscription_Notify request + NF-->>NWDAF: 7b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram for Expected behavioural Analytics procedure involving NF, NWDAF, AMF, SMF, NEF, AF, and OAM. + +**Figure 5.7.8-1: Procedure for Expected behavioural Analytics** + +- 1a. In order to obtain the expected UE behavioural parameters, the NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 1b-1c. In order to obtain expected UE behavioural parameters, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. +- 2a. If the event is set to "UE\_MOBILITY", the NWDAF collects data from AMF, AF and/or OAM as described in clause 5.7.6 from step 2a to step 9. +- 2b. If the event is set to "UE\_COMM", the NWDAF collects data from AMF, SMF and/or AF as described in clause 5.7.7 from step 2a to step 9d. +3. The NWDAF calculates the expected UE behavioural parameters based on the collected data from AMF, SMF, AF and/or OAM. +- 4a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 4b-4c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. +- 5a-5b. The AMF, SMF, AF and/or OAM send the notifications to the NWDAF if it has subscribed to the related events in step 2a or step 2b. +6. The same as step 3. + +7a-7b. The same as step 4b and step 4c. + +NOTE: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.9 Abnormal UE behavioural Analytics + +This procedure is used by the NF to obtain the abnormal UE behavioural analytics which are calculated by the NWDAF based on the information collected from the AMF, SMF, AF and/or OAM. If the NF is an AF which is untrusted, the AF will request analytics via the NEF as described in clause 5.2.3.2. + +![Sequence diagram for Abnormal UE behavioural Analytics procedure. Lifelines: NF, NWDAF, AMF, SMF, NEF, AF, OAM. The diagram shows the interaction between the NF and NWDAF, with NWDAF collecting data from AMF, SMF, AF, and OAM. The process involves Nnwdaf_AnalyticsInfo_Request, Nnwdaf_EventsSubscription_Subscribe, and Nnwdaf_EventsSubscription_Notify operations.](0f7871077bba48a2c97f7859a5edda0d_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant AMF + participant SMF + participant NEF + participant AF + participant OAM + + Note right of AMF: 2a. NWDAF collects data as described in clause 5.7.6 from step 2a to step 9 + Note right of AMF: 2b. NWDAF collects data as described in clause 5.7.7 from step 2a to step 9d + Note right of AMF: 5a. NWDAF receives data as described in clause 5.7.6 from step 12a to step 15 + Note right of AMF: 5b. NWDAF receives data as described in clause 5.7.7 from step 12a to step 15d + + NF->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + NWDAF-->>NF: 1c. Nnwdaf_EventsSubscription_Subscribe response + Note left of AMF: 3. NWDAF derives Abnormal UE behaviour Analytics + NWDAF-->>NF: 4a. Nnwdaf_AnalyticsInfo_Request response + NWDAF-->>NF: 4b. Nnwdaf_EventsSubscription_Notify request + NF-->>NWDAF: 4c. Nnwdaf_EventsSubscription_Notify response + Note left of AMF: 6. NWDAF derives Abnormal UE behaviour Analytics + NWDAF-->>NF: 7a. Nnwdaf_EventsSubscription_Notify request + NF-->>NWDAF: 7b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram for Abnormal UE behavioural Analytics procedure. Lifelines: NF, NWDAF, AMF, SMF, NEF, AF, OAM. The diagram shows the interaction between the NF and NWDAF, with NWDAF collecting data from AMF, SMF, AF, and OAM. The process involves Nnwdaf\_AnalyticsInfo\_Request, Nnwdaf\_EventsSubscription\_Subscribe, and Nnwdaf\_EventsSubscription\_Notify operations. + +Figure 5.7.9-1: Procedure for Abnormal UE behavioural Analytics + +1a. In order to obtain the abnormal UE behavioural parameters, the NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. + +1b-1c. In order to obtain abnormal UE behavioural parameters, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. + +2a. If the event is set to "ABNORMAL\_BEHAVIOUR" and the expected UE analytics type is set to "MOBILITY" or "MOBILITY\_AND\_COMMUN", or the list of exception IDs includes "UNEXPECTED\_UE\_LOCATION", "PING\_PONG\_ACROSS\_CELLS", "UNEXPECTED\_RADIO\_LINK\_FAILURES", or "UNEXPECTED\_WAKEUP", the NWDAF collects data from AMF, AF and/or OAM as described in clause 5.7.6 from step 2a to step 9. + +- 2b. If the event is set to "ABNORMAL\_BEHAVIOUR" and the expected UE analytics type is set to "COMMUN" or "MOBILITY\_AND\_COMMUN", or the list of exception IDs includes "SUSPICION\_OF\_DDOS\_ATTACK", "UNEXPECTED\_LONG\_LIVE\_FLOW", "UNEXPECTED\_LARGE\_RATE\_FLOW", "WRONG\_DESTINATION\_ADDRESS", "TOO\_FREQUENT\_SERVICE\_ACCESS" or "UNEXPECTED\_WAKEUP", the NWDAF collects data from AMF, SMF and/or AF as described in clause 5.7.7 from step 2a to step 9d. +3. The NWDAF calculates the abnormal UE behavioural parameters based on the collected data from AMF, SMF, AF and/or OAM. +- 4a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 4b-4c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. +- 5a-5b. The AMF, SMF, AF and/or OAM send the notifications to the NWDAF if it has subscribed to the related events in step 2a or step 2b. +6. The same as step 3. +- 7a-7b. The same as step 4b and step 4c. + +NOTE: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.10 User Data Congestion Analytics + +This procedure is used by the NWDAF service consumer (may be an NF e.g. NEF, AF, or PCF) to obtain the User Data Congestion analytics which are calculated by the NWDAF based on the information collected from the AMF, OAM, UPF and/or AF. + +![Sequence diagram showing the procedure for User Data Congestion Analytics. Lifelines: Service Consumer, NWDAF, AMF, UPF, NEF, AF, OAM. The diagram illustrates the interaction between these entities to collect and analyze user data congestion analytics.](ffb6acd27b8e3a54392840948a75869f_img.jpg) + +``` + +sequenceDiagram + participant Service Consumer + participant NWDAF + participant AMF + participant UPF + participant NEF + participant AF + participant OAM + + Note left of Service Consumer: 1. Service Consumer requests analytics + Service Consumer->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + Service Consumer->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>Service Consumer: 1c. Nnwdaf_EventsSubscription_Subscribe response + + Note left of NWDAF: 2. NWDAF subscribes to AMF + NWDAF->>AMF: 2a. Namf_EventExposure_Subscribe request + AMF-->>NWDAF: 2b. Namf_EventExposure_Subscribe response + + Note left of NWDAF: 3. NWDAF receives notifications from AMF + AMF->>NWDAF: 3a. Namf_EventExposure_Notify request + NWDAF-->>AMF: 3b. Namf_EventExposure_Notify response + + Note left of NWDAF: 4. Data collection from OAM + NWDAF->>OAM: 4. Data collection from OAM + + Note left of NWDAF: 5. Data collection from UPF + NWDAF->>UPF: 5. Data collection from UPF + + Note left of NWDAF: 6. NWDAF subscribes to AF + NWDAF->>AF: 6a. Naf_EventExposure_Subscribe request + AF-->>NWDAF: 6b. Naf_EventExposure_Subscribe response + + Note left of NWDAF: 7. NWDAF receives notifications from AF + AF->>NWDAF: 7a. Naf_EventExposure_Notify request + NWDAF-->>AF: 7b. Naf_EventExposure_Notify response + + Note left of NWDAF: 8. NWDAF subscribes to NEF + NWDAF->>NEF: 8a. Nnef_EventExposure_Subscribe request + NEF->>AF: 8b. Naf_EventExposure_Subscribe request + AF-->>NEF: 8c. Naf_EventExposure_Subscribe response + NEF-->>NWDAF: 8d. Nnef_EventExposure_Subscribe response + + Note left of NWDAF: 9. NWDAF receives notifications from NEF + NEF->>AF: 9a. Naf_EventExposure_Notify request + AF->>NEF: 9b. Nnef_EventExposure_Notify request + NEF-->>AF: 9c. Nnef_EventExposure_Notify response + AF-->>NEF: 9d. Naf_EventExposure_Notify response + + Note left of Service Consumer: 10. NWDAF derives User Data Congestion Analytics + Service Consumer->>NWDAF: 11a. Nnwdaf_AnalyticsInfo_Request response + Service Consumer->>NWDAF: 11b. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>Service Consumer: 11c. Nnwdaf_EventsSubscription_Notify response + + Note left of NWDAF: 12. NWDAF receives notifications from AMF + AMF->>NWDAF: 12a. Namf_EventExposure_Notify request + NWDAF-->>AMF: 12b. Namf_EventExposure_Notify response + + Note left of NWDAF: 13. Data collection from OAM + NWDAF->>OAM: 13. Data collection from OAM + + Note left of NWDAF: 14. Data collection from UPF + NWDAF->>UPF: 14. Data collection from UPF + + Note left of NWDAF: 15. NWDAF receives notifications from AF + AF->>NWDAF: 15a. Naf_EventExposure_Notify request + NWDAF-->>AF: 15b. Naf_EventExposure_Notify response + + Note left of NWDAF: 16. NWDAF receives notifications from NEF + NEF->>AF: 16a. Naf_EventExposure_Notify request + AF->>NEF: 16b. Nnef_EventExposure_Notify request + NEF-->>AF: 16c. Nnef_EventExposure_Notify response + AF-->>NEF: 16d. Naf_EventExposure_Notify response + + Note left of Service Consumer: 17. NWDAF derives User Data Congestion Analytics + Service Consumer->>NWDAF: 18a. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>Service Consumer: 18b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram showing the procedure for User Data Congestion Analytics. Lifelines: Service Consumer, NWDAF, AMF, UPF, NEF, AF, OAM. The diagram illustrates the interaction between these entities to collect and analyze user data congestion analytics. + +Figure 5.7.10-1: Procedure for User Data Congestion Analytics + +- 1a. In order to obtain the User Data Congestion analytics, the NWDAF service consumer may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1, the requested event is set to "USER\_DATA\_CONGESTION" with the supported feature "UserDataCongestion". + - 1b-1c. In order to obtain the User Data Congestion analytics, the NWDAF service consumer may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1, the subscribed event is set to "USER\_DATA\_CONGESTION" with the supported feature "UserDataCongestion". + - 2a-2b. The NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to retrieve the UE location information. The AMF responds to the NWDAF an HTTP "201 Created" response. + - 3a-3b. If step 2a and step 2b are performed, the AMF may invoke Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. + 4. The NWDAF may collect "Performance measurement" to the OAM to get the Performance Measurements that will be used by the NWDAF to determine congestion levels. Performance Measurements are related to information transfer over the user plane and/or the control plane (e.g. UE Throughput, DRB Setup Management, RRC Connection Number, PDU Session Management, and Radio Resource Utilization as defined in 3GPP TS 28.552 [27]). The NWDAF may obtain measurements by invoking management services that are defined in 3GPP TS 28.532 [19] and 3GPP TS 28.550 [31]. + 5. The NWDAF may collect data related to User Data Congestion analytics information from UPF. +- NOTE 1: How the NWDAF collects UPF information is not defined in this release of the specification. +- 6a-6b. If the AF is trusted, the NWDAF may invoke Naf\_EventExposure\_Subscribe service operation to the AF directly by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to collect the data related to User Data Congestion analytics information. The AF responds to the NWDAF an HTTP "201 Created" response. + - 7a-7b. If step 6a and step 6b are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 6a. The NWDAF responds to the AF an HTTP "204 No Content" response. + - 8a-8d. If the AF is untrusted, the NWDAF may invoke Nnef\_EventExposure\_Subscribe service operation to the NEF by sending an HTTP POST request targeting the resource "Network Exposure Event Subscriptions" and then the NEF invokes Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to collect the data related to User Data Congestion analytics information. The AF responds to the NEF an HTTP "201 Created" response and then the NEF responds to the NWDAF an HTTP "201 Created" response. + - 9a-9d. If step 8a to step 8d are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NEF identified by the notification URI received in step 8b and the NEF invokes Nnef\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 8a. The NWDAF responds to the NEF an HTTP "204 No Content" response and then the NEF responds to the AF an HTTP "204 No Content" response. +10. The NWDAF calculates the User Data Congestion analytics based on the data collected from AMF, OAM, UPF and/or AF. + - 11a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. + - 11b-11c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. + - 12a-12b. The same as step 3a and step 3b. + 13. The same as step 4. + 14. The same as step 5. + - 15a-15b. The same as step 7a and step 7b. + +16a-16d. The same as step 9a to step 9d. + +17. The same as step 10. + +18a-18b. The same as step 11b and step 11c. + +NOTE 2: For details of Naf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.517 [12]. + +NOTE 3: For details of Nnef\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.591 [11]. + +NOTE 4: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.11 QoS Sustainability Analytics + +This procedure is used by the NWDAF service consumer (maybe an NF, e.g. AF) to obtain the QoS Sustainability analytics, which are calculated by the NWDAF based on the information collected from the OAM, for a path of interest or for an area of interest with coarse granularity (i.e. TAIs or Cell IDs). + +![Sequence diagram illustrating the procedure for QoS Sustainability Analytics. The diagram shows interactions between a Service Consumer, NWDAF, and OAM. The Service Consumer sends requests to the NWDAF (1a, 1b, 1c). The NWDAF then interacts with the OAM (2, 5) to collect data. The NWDAF derives QoS Sustainability Analytics (3, 6) and sends responses/notifications to the Service Consumer (4a, 4b, 4c, 7a, 7b).](5492fadb32a8df1ee9f2528a053c9862_img.jpg) + +``` + +sequenceDiagram + participant Service Consumer + participant NWDAF + participant OAM + + Note right of NWDAF: 3. NWDAF derives QoS Sustainability Analytics + Note right of NWDAF: 6. NWDAF derives QoS Sustainability Analytics + + Service Consumer->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + Service Consumer->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>Service Consumer: 1c. Nnwdaf_EventsSubscription_Subscribe response + NWDAF->>OAM: 2. Data collection from OAM + Note right of NWDAF: 3. NWDAF derives QoS Sustainability Analytics + NWDAF-->>Service Consumer: 4a. Nnwdaf_AnalyticsInfo_Request response + NWDAF-->>Service Consumer: 4b. Nnwdaf_EventsSubscription_Notify request + Service Consumer-->>NWDAF: 4c. Nnwdaf_EventsSubscription_Notify response + NWDAF->>OAM: 5. Data collection from OAM + Note right of NWDAF: 6. NWDAF derives QoS Sustainability Analytics + NWDAF-->>Service Consumer: 7a. Nnwdaf_EventsSubscription_Notify request + Service Consumer-->>NWDAF: 7b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram illustrating the procedure for QoS Sustainability Analytics. The diagram shows interactions between a Service Consumer, NWDAF, and OAM. The Service Consumer sends requests to the NWDAF (1a, 1b, 1c). The NWDAF then interacts with the OAM (2, 5) to collect data. The NWDAF derives QoS Sustainability Analytics (3, 6) and sends responses/notifications to the Service Consumer (4a, 4b, 4c, 7a, 7b). + +**Figure 5.7.11-1: Procedure for QoS Sustainability Analytics** + +1a. In order to obtain the QoS sustainability analytics, the NWDAF service consumer may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1, the requested event is sent to "QOS\_SUSTAINABILITY" with the supported feature "QoSSustainability". + +1b-1c. In order to obtain the QoS sustainability analytics, the NWDAF service consumer may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1, the subscribed event is set to "QOS\_SUSTAINABILITY" with the supported feature "QoSSustainability". + +2. The NWDAF may collect "Performance measurement" to the OAM to get the RAN UE Throughput in clause 6.3.6 of 3GPP TS 28.554 [30], QoS flow Retainability information as described in clause 6.5.1 of 3GPP TS 28.554 [30]. If the "QoSSustainabilityExt\_eNA" feature is supported, the NWDAF may collect the average UL/DL packet transmission delay through RAN part to the UE as described in clause 6.3.1.2 of + +3GPP TS 28.554 [30], the UL/DL packet delay on GTP path on N3 for non-GBR traffic, the UL/DL capacity measurement from UPF to NG-RAN or from UE to UPF based on GTP path, and the UL/DL available capacity measurement from UPF to NG-RAN or from UE to UPF based on GTP path as described in clause 5.1 and clause 5.4 of 3GPP TS 28.552 [27]. + +3. The NWDAF calculates the QoS sustainability analytics based on the data collected from OAM. +- 4a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 4b-4c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. +5. The same as step 2. +6. The same as step 3. +- 7a-7b. The same as step 4b and step 4c. + +NOTE: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.12 Dispersion Analytics + +This procedure is used by the NWDAF service consumer to obtain the dispersion analytics which are calculated by the NWDAF based on the information collected from the AMF, SMF, UPF and/or AF. + +![Sequence diagram showing interactions between Service Consumer, NWDAF, AMF, SMF, UPF, NEF, and AF. The diagram illustrates various subscription and notification messages for analytics and events.](2f587210e4f97c32758c5972e2e83d20_img.jpg) + +``` + +sequenceDiagram + participant SC as Service Consumer + participant NWDAF as NWDAF + participant AMF as AMF + participant SMF as SMF + participant UPF as UPF + participant NEF as NEF + participant AF as AF + + Note left of SC: 1. NWDAF derives Dispersion Analytics + SC->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + NWDAF-->>SC: 1b. Nnwdaf_EventsSubscription_Subscribe request + SC-->>NWDAF: 1c. Nnwdaf_EventsSubscription_Subscribe response + + Note left of SC: 2. NWDAF derives Dispersion Analytics + NWDAF->>AMF: 2a. Namf_EventExposure_Subscribe request + AMF-->>NWDAF: 2b. Namf_EventExposure_Subscribe response + AMF->>NWDAF: 3a. Namf_EventExposure_Notify request + NWDAF-->>AMF: 3b. Namf_EventExposure_Notify response + + Note left of SC: 4. NWDAF derives Dispersion Analytics + NWDAF->>SMF: 4a. Nsmf_EventExposure_Subscribe request + SMF-->>NWDAF: 4b. Nsmf_EventExposure_Subscribe response + SMF->>NWDAF: 5a. Nsmf_EventExposure_Notify request + NWDAF-->>SMF: 5b. Nsmf_EventExposure_Notify response + + Note left of SC: 6. NWDAF derives Dispersion Analytics + NWDAF->>SMF: 6a1. Nsmf_EventExposure_Subscribe request + SMF->>UPF: 6a2. Nupf_EventExposure_Subscribe request + UPF-->>SMF: 6a3. Nupf_EventExposure_Subscribe response + SMF-->>NWDAF: 6a4. Nsmf_EventExposure_Subscribe response + NWDAF->>UPF: 6b1. Nupf_EventExposure_Subscribe request + UPF-->>NWDAF: 6b2. Nupf_EventExposure_Subscribe response + UPF->>NWDAF: 6c1. Nupf_EventExposure_Notify request + NWDAF-->>UPF: 6c2. Nupf_EventExposure_Notify response + + Note left of SC: 7. NWDAF derives Dispersion Analytics + NWDAF->>AF: 7a. Naf_EventExposure_Subscribe request + AF-->>NWDAF: 7b. Naf_EventExposure_Subscribe response + AF->>NWDAF: 8a. Naf_EventExposure_Notify request + NWDAF-->>AF: 8b. Naf_EventExposure_Notify response + + Note left of SC: 9. NWDAF derives Dispersion Analytics + NWDAF->>NEF: 9a. Nnef_EventExposure_Subscribe request + NEF->>AF: 9b. Naf_EventExposure_Subscribe request + AF-->>NEF: 9c. Naf_EventExposure_Subscribe response + NEF-->>NWDAF: 9d. Nnef_EventExposure_Subscribe response + NEF->>AF: 10a. Naf_EventExposure_Notify request + AF-->>NEF: 10b. Nnef_EventExposure_Notify request + NEF-->>AF: 10c. Nnef_EventExposure_Notify response + AF-->>NEF: 10d. Naf_EventExposure_Notify response + + Note left of SC: 11. NWDAF derives Dispersion Analytics + NWDAF-->>SC: 12a. Nnwdaf_AnalyticsInfo_Request response + NWDAF->>SC: 12b. Nnwdaf_EventsSubscription_Notify request + SC-->>NWDAF: 12c. Nnwdaf_EventsSubscription_Notify response + + Note left of SC: 13. NWDAF derives Dispersion Analytics + NWDAF->>AMF: 13a. Namf_EventExposure_Notify request + AMF-->>NWDAF: 13b. Namf_EventExposure_Notify response + AMF->>NWDAF: 14a. Nsmf_EventExposure_Notify request + NWDAF-->>AMF: 14b. Nsmf_EventExposure_Notify response + + Note left of SC: 15. NWDAF derives Dispersion Analytics + NWDAF->>UPF: 15a. Nupf_EventExposure_Subscribe request + UPF-->>NWDAF: 15b. Nupf_EventExposure_Subscribe response + UPF->>NWDAF: 16a. Naf_EventExposure_Notify request + NWDAF-->>UPF: 16b. Naf_EventExposure_Notify response + + Note left of SC: 17. NWDAF derives Dispersion Analytics + NWDAF->>NEF: 17b. Nnef_EventExposure_Notify request + NEF->>AF: 17a. Naf_EventExposure_Notify request + AF-->>NEF: 17c. Nnef_EventExposure_Notify response + NEF-->>AF: 17d. Naf_EventExposure_Notify response + + Note left of SC: 18. NWDAF derives Dispersion Analytics + NWDAF-->>SC: 19a. Nnwdaf_EventsSubscription_Notify request + SC-->>NWDAF: 19b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram showing interactions between Service Consumer, NWDAF, AMF, SMF, UPF, NEF, and AF. The diagram illustrates various subscription and notification messages for analytics and events. + +###### **Figure 5.7.12-1: Procedure for Dispersion Analytics** + +- 1a. In order to obtain the Dispersion analytics, the NWDAF service consumer may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1, the requested event is set to "DISPERSION" with the supported feature "Dispersion". +- 1b-1c. In order to obtain the Dispersion analytics, the NWDAF service consumer may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1, the subscribed event is set to "DISPERSION" with the supported feature "Dispersion". +- 2a-2b. The NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to retrieve the location and/or slice based UE transactions dispersion information. The AMF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. If step 2a and step 2b are performed, the AMF may invoke Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. +- 4a-4b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to subscribe to the notification of UE transactions dispersion information which may be slice based. The SMF responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. If step 4a and step 4b are performed, the SMF may invoke Nsmf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a. The NWDAF responds to the SMF an HTTP "204 No Content" response. +- 6a-6c. The NWDAF may subscribe to collect UE data volume dispersion information from the serving UPF either via the SMF (by performing steps 6a1, 6a2, 6a3, and 6a4, which are the same as steps 3a, 4a, 4b, and 3b of clause 5.7.17) or directly to the UPF (by performing steps 6b1, 6b2, which are the same as steps 5a and 5b of clause 5.7.17). Then, the UPF may invoke the Nupf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI provided in step 6a1 or step 6b1 and the NWDAF responds to the UPF with an HTTP "204 No Content" response as described in 3GPP TS 29.564 [40]. + +NOTE 1: How the NWDAF collects UPF information is not defined in this release of the specification. + +- 7a-7b. If the AF is trusted, the NWDAF may invoke Naf\_EventExposure\_Subscribe service operation to the AF directly by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to collect the UE data volume dispersion information. The AF responds to the NWDAF an HTTP "201 Created" response. +- 8a-8b. If step 7a and step 7b are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 7a. The NWDAF responds to the AF an HTTP "204 No Content" response. +- 9a-9d. If the AF is untrusted, the NWDAF may invoke Nnef\_EventExposure\_Subscribe service operation to the NEF by sending an HTTP POST request targeting the resource "Network Exposure Event Subscriptions" and then the NEF invokes Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to collect the UE data volume dispersion information. The AF responds to the NEF an HTTP "201 Created" response and then the NEF responds to the NWDAF an HTTP "201 Created" response. +- 10a-10d. If step 9a to step 9d are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NEF identified by the notification URI received in step 8b and the NEF invokes Nnef\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 9a. The NWDAF responds to the NEF an HTTP "204 No Content" response and then the NEF responds to the AF an HTTP "204 No Content" response. +11. The NWDAF calculates the Dispersion analytics based on the data collected from AMF, SMF, UPF and/or AF. +- 12a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 12b-12c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. + +13a-13b. The same as step 3a and step 3b. + +14a-14b. The same as step 5a and step 5b. + +15a-15b. The same as step 6c1 and step 6c2. + +16a-16b. The same as step 8a and step 8b. + +17a-17d. The same as step 10a to step 10d. + +18. The same as step 11. + +19a-19b. The same as step 12b and step 12c. + +NOTE 2: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. + +NOTE 3: For details of Naf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.517 [12]. + +NOTE 4: For details of Nnef\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.591 [11]. + +NOTE 5: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.13 WLAN Performance Analytics + +This procedure is used by the NWDAF service consumer to obtain the WLAN performance analytics which are calculated by the NWDAF based on the information collected from the SMF, UPF and/or OAM. If the NF is an AF which is untrusted, the AF will request analytics via the NEF as described in clause 5.2.3.2. + +![Sequence diagram for WLAN Performance Analytics procedure involving Service Consumer, NWDAF, SMF, UPF, and OAM.](4806f9f95fff13a30d6523bd6ffeac63_img.jpg) + +``` + +sequenceDiagram + participant SC as Service Consumer + participant NWDAF + participant SMF + participant UPF + participant OAM + + Note right of NWDAF: 6. NWDAF derives WLAN Performance Analytics + + Note right of NWDAF: 11. NWDAF derives WLAN Performance Analytics + + SC->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + SC->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>SC: 1c. Nnwdaf_EventsSubscription_Subscribe response + + NWDAF->>SMF: 2a. Nsmf_EventExposure_Subscribe request + SMF-->>NWDAF: 2b. Nsmf_EventExposure_Subscribe response + + NWDAF->>SMF: 3a. Nsmf_EventExposure_Notify request + SMF-->>NWDAF: 3b. Nsmf_EventExposure_Notify response + + NWDAF->>SMF: 4a1. Nsmf_EventExposure_Subscribe request + SMF->>UPF: 4a2. Nupf_EventExposure_Subscribe request + UPF-->>SMF: 4a3. Nupf_EventExposure_Subscribe response + SMF-->>NWDAF: 4a4. Nsmf_EventExposure_Subscribe response + + NWDAF->>UPF: 4b1. Nupf_EventExposure_Subscribe request + UPF-->>NWDAF: 4b2. Nupf_EventExposure_Subscribe response + + NWDAF->>UPF: 4c1. Nupf_EventExposure_Notify request + UPF-->>NWDAF: 4c2. Nupf_EventExposure_Notify response + + NWDAF->>OAM: 5. Data collection from OAM + + Note right of NWDAF: 6. NWDAF derives WLAN Performance Analytics + + SC->>NWDAF: 7a. Nnwdaf_AnalyticsInfo_Request response + SC->>NWDAF: 7b. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>SC: 7c. Nnwdaf_EventsSubscription_Notify response + + NWDAF->>SMF: 8a. Nsmf_EventExposure_Notify request + SMF-->>NWDAF: 8b. Nsmf_EventExposure_Notify response + + NWDAF->>UPF: 9a. Nupf_EventExposure_Notify request + UPF-->>NWDAF: 9b. Nupf_EventExposure_Notify response + + NWDAF->>OAM: 10. Data collection from OAM + + Note right of NWDAF: 11. NWDAF derives WLAN Performance Analytics + + SC->>NWDAF: 12a. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>SC: 12b. Nnwdaf_EventsSubscription_Notify response + +``` + +The sequence diagram illustrates the procedure for WLAN Performance Analytics. It involves five main participants: Service Consumer, NWDAF, SMF, UPF, and OAM. The process begins with the Service Consumer sending three initial messages to the NWDAF: 1a. Nnwdaf\_AnalyticsInfo\_Request request, 1b. Nnwdaf\_EventsSubscription\_Subscribe request, and 1c. Nnwdaf\_EventsSubscription\_Subscribe response. The NWDAF then interacts with the SMF via 2a. Nsmf\_EventExposure\_Subscribe request and 2b. Nsmf\_EventExposure\_Subscribe response. It also receives 3a. Nsmf\_EventExposure\_Notify request and 3b. Nsmf\_EventExposure\_Notify response from the SMF. The NWDAF sends 4a1. Nsmf\_EventExposure\_Subscribe request to the SMF, which in turn sends 4a2. Nupf\_EventExposure\_Subscribe request to the UPF, receiving 4a3. Nupf\_EventExposure\_Subscribe response. The SMF then sends 4a4. Nsmf\_EventExposure\_Subscribe response to the NWDAF. The NWDAF sends 4b1. Nupf\_EventExposure\_Subscribe request to the UPF, receiving 4b2. Nupf\_EventExposure\_Subscribe response. It also sends 4c1. Nupf\_EventExposure\_Notify request to the UPF, receiving 4c2. Nupf\_EventExposure\_Notify response. The NWDAF performs data collection from the OAM (5. Data collection from OAM). A note indicates that the NWDAF derives WLAN Performance Analytics (6. NWDAF derives WLAN Performance Analytics). The Service Consumer receives 7a. Nnwdaf\_AnalyticsInfo\_Request response, sends 7b. Nnwdaf\_EventsSubscription\_Notify request, and receives 7c. Nnwdaf\_EventsSubscription\_Notify response. The NWDAF sends 8a. Nsmf\_EventExposure\_Notify request to the SMF, receiving 8b. Nsmf\_EventExposure\_Notify response. It also sends 9a. Nupf\_EventExposure\_Notify request to the UPF, receiving 9b. Nupf\_EventExposure\_Notify response. The NWDAF performs another data collection from the OAM (10. Data collection from OAM). Another note indicates that the NWDAF derives WLAN Performance Analytics (11. NWDAF derives WLAN Performance Analytics). Finally, the Service Consumer sends 12a. Nnwdaf\_EventsSubscription\_Notify request and receives 12b. Nnwdaf\_EventsSubscription\_Notify response from the NWDAF. + +Sequence diagram for WLAN Performance Analytics procedure involving Service Consumer, NWDAF, SMF, UPF, and OAM. + +Figure 5.7.13-1: Procedure for WLAN Performance Analytics + +- 1a. In order to obtain the WLAN performance analytics, the NWDAF service consumer may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1, the requested event is set to "WLAN\_PERFORMANCE" with the supported feature "WlanPerformance". +- 1b-1c. In order to obtain the WLAN performance analytics, the NWDAF service consumer may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1, the subscribed event is set to "WLAN\_PERFORMANCE" with the supported feature "WlanPerformance". +- 2a-2b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to subscribe to the notification of Information on PDU Session for WLAN. The SMF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. If step 2a and step 2b are performed, the SMF may invoke Nsmf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 2a. The NWDAF responds to the SMF an HTTP "204 No Content" response. +4. The NWDAF may subscribe to collect UE communications information for WLAN from the UPF either via the SMF (by performing steps 6a1, 6a2, 6a3, and 6a4, which are the same as steps 3a, 4a, 4b, and 3b of clause 5.7.17) or directly to the UPF (by performing steps 6b1, 6b2, which are the same as steps 5a and 5b of clause 5.7.17). Then, the UPF may invoke the Nupf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI provided in step 6a1 or step 6b1 and the NWDAF responds to the UPF with an HTTP "204 No Content" response as described in 3GPP TS 29.564 [40]. +5. The NWDAF may collect WLAN measurement results from the OAM. The WLAN measurement data from OAM is collected via MDT and aligned with the WLAN measurement reporting list described in clause 5.1.1.3.3 of TS 37.320 [29]. +6. The NWDAF calculates the WLAN performance analytics based on the data collected from SMF, UPF and/or OAM. +- 7a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 7b-7c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. +- 8a-8b. The same as step 3a and step 3b. +- 9a-9b. The same as step 4c1 and step 6c2. +10. The same as step 5. +11. The same as step 6. +- 12a-12b. The same as step 7b and step 7c. + +NOTE 1: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. + +NOTE 2: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.14 Session Management Congestion Control Experience Analytics + +This procedure is used by the NWDAF service consumer e.g. SMF to obtain the Session Management Congestion Control Experience Analytics which are calculated by the NWDAF based on the information collected from the SMF. + +![Sequence diagram illustrating the procedure for Session Management Congestion Control Experience Analytics. The diagram shows interactions between Service Consumer, NWDAF, and SMF. The Service Consumer sends requests to the NWDAF. The NWDAF then sends a subscribe request to the SMF. The SMF responds, and the NWDAF derives analytics. Finally, the NWDAF sends responses and notifications back to the Service Consumer.](9c45844d796e85ae05505870a54e4eb4_img.jpg) + +``` + +sequenceDiagram + participant SC as Service Consumer + participant NWDAF as NWDAF + participant SMF as SMF + + Note right of NWDAF: 4. NWDAF derives Session Management Congestion Control Experience Analytics + + SC->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + SC->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>SC: 1c. Nnwdaf_EventsSubscription_Subscribe response + NWDAF->>SMF: 2a. Nsmf_EventExposure_Subscribe request + SMF-->>NWDAF: 2b. Nsmf_EventExposure_Subscribe response + SMF->>NWDAF: 3a. Nsmf_EventExposure_Notify request + NWDAF-->>SMF: 3b. Nsmf_EventExposure_Notify response + Note right of NWDAF: 4. NWDAF derives Session Management Congestion Control Experience Analytics + NWDAF-->>SC: 5a. Nnwdaf_AnalyticsInfo_Request response + NWDAF->>SC: 5b. Nnwdaf_EventsSubscription_Notify request + SC-->>NWDAF: 5c. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram illustrating the procedure for Session Management Congestion Control Experience Analytics. The diagram shows interactions between Service Consumer, NWDAF, and SMF. The Service Consumer sends requests to the NWDAF. The NWDAF then sends a subscribe request to the SMF. The SMF responds, and the NWDAF derives analytics. Finally, the NWDAF sends responses and notifications back to the Service Consumer. + +**Figure 5.7.14-1: Procedure for Session Management Congestion Control Experience Analytics** + +- 1a. In order to obtain the SMCCE (Session Management Congestion Control Experience) analytics, the NWDAF service consumer may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1, the requested event is set to "SM\_CONGESTION" with the supported feature "SMCCE". +- 1b-1c. In order to obtain the SMCCE (Session Management Congestion Control Experience) analytics, the NWDAF service consumer may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1, the subscribed event is set to "SM\_CONGESTION" with the supported feature "SMCCE". +- 2a-2b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to subscribe to the notification of Information on UE ID and SMCC experience for PDU Session. The SMF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. If step 2a and step 2b are performed, the SMF may invoke Nsmf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 2a. The NWDAF responds to the SMF an HTTP "204 No Content" response. +4. The NWDAF calculates the Session Management Congestion Control Experience analytics based on the data collected from SMF. +- 5a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 5b-5c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. + +NOTE 1: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. + +NOTE 2: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify and Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.15 Redundant Transmission Experience Analytics + +This procedure is used by the NWDAF service consumer (may be an NF e.g. SMF) to obtain the Redundant Transmission Experience Analytics which are calculated by the NWDAF based on the information collected from the AMF, AF, SMF, UPF OAM and/or MDAF. + +![Sequence diagram showing the procedure for Redundant Transmission Experience Analytics. Lifelines: Service Consumer, NWDAF, AMF, SMF, UPF, NEF, AF, OAM, MDAF. The diagram illustrates the flow of requests and responses for analytics collection, including steps for deriving redundant transmission experience analytics at the NWDAF.](49fe8fe978c0f7e73112d231feb377eb_img.jpg) + +``` + +sequenceDiagram + participant SC as Service Consumer + participant NWDAF as NWDAF + participant AMF as AMF + participant SMF as SMF + participant UPF as UPF + participant NEF as NEF + participant AF as AF + participant OAM as OAM + participant MDAF as MDAF + + Note left of SC: 12. NWDAF derives Redundant Transmission Experience Analytics + Note left of SC: 20. NWDAF derives Redundant Transmission Experience Analytics + + Note right of NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + Note right of NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + Note right of NWDAF: 1c. Nnwdaf_EventsSubscription_Subscribe response + Note right of NWDAF: 2a. Namf_EventExposure_Subscribe request + Note right of NWDAF: 2b. Namf_EventExposure_Subscribe response + Note right of NWDAF: 3a. Namf_EventExposure_Notify request + Note right of NWDAF: 3b. Namf_EventExposure_Notify response + Note right of NWDAF: 4a. Nsmf_EventExposure_Subscribe request + Note right of NWDAF: 4b. Nsmf_EventExposure_Subscribe response + Note right of NWDAF: 5a. Nsmf_EventExposure_Notify request + Note right of NWDAF: 5b. Nsmf_EventExposure_Notify response + Note right of NWDAF: 6a1. Nsmf_EventExposure_Subscribe request + Note right of AMF: 6a2. Nupf_EventExposure_Subscribe request + Note right of UPF: 6a3. Nupf_EventExposure_Subscribe response + Note right of NWDAF: 6a4. Nsmf_EventExposure_Subscribe response + Note right of NWDAF: 6b1. Nupf_EventExposure_Subscribe request + Note right of UPF: 6b2. Nupf_EventExposure_Subscribe response + Note right of NWDAF: 6c1. Nupf_EventExposure_Notify request + Note right of UPF: 6c2. Nupf_EventExposure_Notify response + Note right of NWDAF: 7a. Data collection from OAM + Note right of NWDAF: 7b. Data collection from MDAF + Note right of NWDAF: 8a. Naf_EventExposure_Subscribe request + Note right of AF: 8b. Naf_EventExposure_Subscribe response + Note right of NWDAF: 9a. Naf_EventExposure_Notify request + Note right of AF: 9b. Naf_EventExposure_Notify response + Note right of NWDAF: 10a. Nnef_EventExposure_Subscribe request + Note right of NEF: 10b. Naf_EventExposure_Subscribe request + Note right of AF: 10c. Naf_EventExposure_Subscribe response + Note right of NWDAF: 10d. Nnef_EventExposure_Subscribe response + Note right of NEF: 11a. Naf_EventExposure_Notify request + Note right of NWDAF: 11b. Nnef_EventExposure_Notify request + Note right of NEF: 11c. Nnef_EventExposure_Notify response + Note right of AF: 11d. Naf_EventExposure_Notify response + Note right of NWDAF: 13a. Nnwdaf_AnalyticsInfo_Request response + Note right of NWDAF: 13b. Nnwdaf_EventsSubscription_Notify request + Note right of NWDAF: 13c. Nnwdaf_EventsSubscription_Notify response + Note right of NWDAF: 14a. Namf_EventExposure_Notify request + Note right of AMF: 14b. Namf_EventExposure_Notify response + Note right of NWDAF: 15a. Nsmf_EventExposure_Notify request + Note right of SMF: 15b. Nsmf_EventExposure_Notify response + Note right of NWDAF: 16a. Nupf_EventExposure_Notify request + Note right of UPF: 16b. Nupf_EventExposure_Notify response + Note right of NWDAF: 17. Data collection from OAM + Note right of NWDAF: 18a. Naf_EventExposure_Notify request + Note right of AF: 18b. Naf_EventExposure_Notify response + Note right of NWDAF: 19a. Naf_EventExposure_Notify request + Note right of NEF: 19b. Nnef_EventExposure_Notify request + Note right of NEF: 19c. Nnef_EventExposure_Notify response + Note right of AF: 19d. Naf_EventExposure_Notify response + Note right of NWDAF: 21a. Nnwdaf_EventsSubscription_Notify request + Note right of NWDAF: 21b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram showing the procedure for Redundant Transmission Experience Analytics. Lifelines: Service Consumer, NWDAF, AMF, SMF, UPF, NEF, AF, OAM, MDAF. The diagram illustrates the flow of requests and responses for analytics collection, including steps for deriving redundant transmission experience analytics at the NWDAF. + +Figure 5.7.15-1: Procedure for Redundant Transmission Experience Analytics + +- 1a. In order to obtain the Redundant Transmission Experience Analytics, the NWDAF service consumer may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1, the requested event is set to "RED\_TRANS\_EXP" with the supported feature "RedundantTransmissionExp". +- 1b-1c. In order to obtain the Redundant Transmission Experience Analytics, the NWDAF service consumer may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1, the subscribed event is set to "RED\_TRANS\_EXP" with the supported feature "RedundantTransmissionExp". +- 2a-2b. The NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to retrieve the UE Mobility information. The AMF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. If step 2a and step 2b are performed, the AMF may invoke Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. +- 4a-4b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to subscribe to the notification of Information related to PDU Session established with redundant transmission. The SMF responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. If step 4a and step 4b are performed, the SMF may invoke Nsmf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a. The NWDAF responds to the SMF an HTTP "204 No Content" response. +6. The NWDAF may collect data related to packet delay measurement information from UPF either via the SMF (by performing steps 6a1, 6a2, 6a3, and 6a4, which are the same as steps 3a, 4a, 4b, and 3b of clause 5.7.17) or directly to the UPF (by performing steps 6b1, 6b2, which are the same as steps 5a and 5b of clause 5.7.17). Then, the UPF may invoke the Nupf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI provided in step 6a1 or step 6b1 and the NWDAF responds to the UPF with an HTTP "204 No Content" response as described in 3GPP TS 29.564 [40]. +- 7a. The NWDAF may collect "Performance measurement" to the OAM to get the UL/DL packet drop rate on GTP path on N3, UL/DL packet delay measurement on GTP path on N3 and/or UL/DL packet drop/loss rate of RAN part measurement refer to clause 5.1 of TS 28.552 [27] for the performance measurement in NG-RAN. +- 7b. The NWDAF may collect end-to-end analysis as specified in clause 8.4.2.4.3 of TS 28.104 [38] from MDAF. The information element of the analysis from MDAF include E2ELatencyIssueType and AffectedObjects. +- 8a-8b. If the AF is trusted, the NWDAF may invoke Naf\_EventExposure\_Subscribe service operation to the AF directly by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to collect the service data related to UE mobility information. The AF responds to the NWDAF an HTTP "201 Created" response. +- 9a-9b. If step 8a and step 8b are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 8a. The NWDAF responds to the AF an HTTP "204 No Content" response. +- 10a-10d. If the AF is untrusted, the NWDAF may invoke Nnef\_EventExposure\_Subscribe service operation to the NEF by sending an HTTP POST request targeting the resource "Network Exposure Event Subscriptions" and then the NEF invokes Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to collect the service data related to UE mobility information. The AF responds to the NEF an HTTP "201 Created" response and then the NEF responds to the NWDAF an HTTP "201 Created" response. +- 11a-11d. If step 10a to step 10d are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NEF identified by the notification URI received in step 10b and the NEF invokes Nnef\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 10a. The NWDAF responds to the NEF an HTTP "204 No Content" response and then the NEF responds to the AF an HTTP "204 No Content" response. +12. The NWDAF calculates the Redundant Transmission Experience Analytics based on the data collected from AMF, AF SMF, UPF OAM and/or MDAF. + +- 13a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 13b-13c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. +- 14a-14b. The same as step 3a and step 3b. +- 15a-15b. The same as step 5a and step 5b. +- 16a-16b. The same as step 6c1 and step 6c2. +17. The same as step 7. +- 18a-18b. The same as step 9a and step 9b. +- 19a-19d. The same as step 11a and step 11d. +20. The same as step 12. +- 21a-21b. The same as step 13b and step 13c. + +NOTE 1: For details of Naf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.517 [12]. + +NOTE 2: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. + +NOTE 3: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.16 DN Performance Analytics + +This procedure is used by the NF to obtain DN performance analytics, which is calculated by the NWDAF based on the information collected from the AMF, SMF, AF, UPF and/or OAM. If the NF is an AF which is untrusted, the AF will request analytics via the NEF as described in clause 5.2.3.2. + +![Sequence diagram for DN Performance Analytics procedure. Lifelines: NF, NWDAF, AMF, SMF, NEF, AF, UPF, OAM. The diagram shows the interaction between these entities to collect and derive DN performance analytics. Steps include service requests (Nnwdaf_AnalyticsInfo_Request, Nnwdaf_EventsSubscription_Subscribe), event exposures (Namf_EventExposure, Nsmf_EventExposure), data collection from UPF and OAM, and final analytics derivation and notification.](f61d0925551545b5938b3a4d1bbf63c3_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant AMF + participant SMF + participant NEF + participant AF + participant UPF + participant OAM + + Note left of NF: 1a. Nnwdaf_AnalyticsInfo_Request request + NF-->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + Note left of NF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NF-->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + Note left of NF: 1c. Nnwdaf_EventsSubscription_Subscribe response + NWDAF-->>NF: 1c. Nnwdaf_EventsSubscription_Subscribe response + Note left of NWDAF: 2a. Namf_EventExposure_Subscribe request + NWDAF-->>AMF: 2a. Namf_EventExposure_Subscribe request + Note left of NWDAF: 2b. Namf_EventExposure_Subscribe response + AMF-->>NWDAF: 2b. Namf_EventExposure_Subscribe response + Note left of NWDAF: 3a. Namf_EventExposure_Notify request + NWDAF-->>AMF: 3a. Namf_EventExposure_Notify request + Note left of NWDAF: 3b. Namf_EventExposure_Notify response + AMF-->>NWDAF: 3b. Namf_EventExposure_Notify response + Note left of NWDAF: 4a. Nsmf_EventExposure_Subscribe request + NWDAF-->>SMF: 4a. Nsmf_EventExposure_Subscribe request + Note left of NWDAF: 4b. Nsmf_EventExposure_Subscribe response + SMF-->>NWDAF: 4b. Nsmf_EventExposure_Subscribe response + Note left of NWDAF: 5a. Nsmf_EventExposure_Notify request + NWDAF-->>SMF: 5a. Nsmf_EventExposure_Notify request + Note left of NWDAF: 5b. Nsmf_EventExposure_Notify response + SMF-->>NWDAF: 5b. Nsmf_EventExposure_Notify response + + Note right of NWDAF: 6. NWDAF collects data as described in clause 5.7.7 from step 6a to step 9d + Note right of NWDAF: 7. NWDAF collects data from UPF + NWDAF-->>UPF: 7. NWDAF collects data from UPF + Note right of NWDAF: 8. Data collection from OAM + NWDAF-->>OAM: 8. Data collection from OAM + + Note left of NF: 9. NWDAF derives DN Performance Analytics + Note left of NF: 10a. Nnwdaf_AnalyticsInfo_Request response + NWDAF-->>NF: 10a. Nnwdaf_AnalyticsInfo_Request response + Note left of NF: 10b. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>NF: 10b. Nnwdaf_EventsSubscription_Notify request + Note left of NF: 10c. Nnwdaf_EventsSubscription_Notify response + NF-->>NWDAF: 10c. Nnwdaf_EventsSubscription_Notify response + + Note left of NWDAF: 11a. Namf_EventExposure_Notify request + NWDAF-->>AMF: 11a. Namf_EventExposure_Notify request + Note left of NWDAF: 11b. Namf_EventExposure_Notify response + AMF-->>NWDAF: 11b. Namf_EventExposure_Notify response + Note left of NWDAF: 12a. Nsmf_EventExposure_Notify request + NWDAF-->>SMF: 12a. Nsmf_EventExposure_Notify request + Note left of NWDAF: 12b. Nsmf_EventExposure_Notify response + SMF-->>NWDAF: 12b. Nsmf_EventExposure_Notify response + + Note right of NWDAF: 13. NWDAF collects data as described in clause 5.7.7 from step 14a to step 15d + Note left of NF: 14. NWDAF derives DN Performance Analytics + Note left of NF: 15a. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>NF: 15a. Nnwdaf_EventsSubscription_Notify request + Note left of NF: 15b. Nnwdaf_EventsSubscription_Notify response + NF-->>NWDAF: 15b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram for DN Performance Analytics procedure. Lifelines: NF, NWDAF, AMF, SMF, NEF, AF, UPF, OAM. The diagram shows the interaction between these entities to collect and derive DN performance analytics. Steps include service requests (Nnwdaf\_AnalyticsInfo\_Request, Nnwdaf\_EventsSubscription\_Subscribe), event exposures (Namf\_EventExposure, Nsmf\_EventExposure), data collection from UPF and OAM, and final analytics derivation and notification. + +Figure 5.7.16-1: Procedure for DN Performance Analytics + +1a. In order to obtain the DN performance analytics, the NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. + +1b-1c. In order to obtain the DN performance analytics, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. + +2a-2b. The NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to retrieve the UE location information and SUPI(s) from AMF. The AMF responds to the NWDAF an HTTP "201 Created" response. + +3a-3b. If step 2a and step 2b are performed, the AMF may invoke Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. + +4a-4b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to request DNN, S-NSSAI, application ID, UPF info, DNAI, IP filter information and QFI. The SMF responds to the NWDAF an HTTP "201 Created" response. + +5a-5b. If step 4a and step 4b are performed, the SMF may invoke Nsmf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a. The NWDAF responds to the SMF an HTTP "204 No Content" response. + +6. The NWDAF may collect performance data from AF as described in clause 5.7.7 from step 6a to step 9d. + +7. The NWDAF may collect QoS flow bit rate, QoS flow packet delay, packet transmission and packet retransmission information from UPF. + +NOTE 1: How NWDAF collects UE communication related data from UPF is not defined in this Release of the specification. + +8. The NWDAF may collect Reference Signal Received Power and Reference Signal Received Quality as specified in clause 5.5 of TS 38.331 [33] and clause 5.5.5 of TS 36.331 [34], Signal-to-noise and interference ratio as specified in clause 5.1 of TS 38.215 [35], the mapping information between cell ID and frequency and Cell Energy Saving State data as specified in clauses 3.1 and 6.2 of TS 28.310 [36] from OAM. + +9. The NWDAF calculates the DN performance analytics based on the data collected from AMF, SMF, AF, UPF and/or OAM. + +10a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. + +10b-10c. If step 1b and step 1c are performed, the NWDAF may invoke Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. + +11a-11b. The same as step 3a and step 3b. + +12a-12b. The same as step 5a and step 5b. + +13. The same as step 6. + +14. The same as step 9. + +15a-15b. The same as step 10b and step 10c. + +NOTE 2: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. + +NOTE 3: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.17 PFD Determination Analytics + +This procedure is used by the NWDAF service consumer e.g. NEF(PFDF) to obtain PFD determination analytics for the know application(s), which is calculated by the NWDAF based on the information collected from the UPF and the NEF(PFDF). + +![Sequence diagram for PFD Determination Analytics procedure. Lifelines: Consumer (NEF(PFDF)), NWDAF, SMF, UPF. The diagram shows two main paths for data collection: Option 1 (Indirect subscription via SMF) and Option 2 (Direct subscription).](38d82ffe820e339811b396206f40a201_img.jpg) + +``` + +sequenceDiagram + participant Consumer as Consumer (NEF(PFDF)) + participant NWDAF + participant SMF + participant UPF + + Note left of Consumer: 1a. Nnwdaf_AnalyticsInfo_Request request + Consumer->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + Note left of Consumer: 1b. Nnwdaf_EventsSubscription_Subscribe request + Consumer->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + Note left of Consumer: 1c. Nnwdaf_EventsSubscription_Subscribe response + NWDAF-->>Consumer: 1c. Nnwdaf_EventsSubscription_Subscribe response + Note left of Consumer: 2a. Nnef_PFDManagement_Fetch request + Consumer->>NWDAF: 2a. Nnef_PFDManagement_Fetch request + Note left of Consumer: 2b. Nnef_PFDManagement_Fetch response + NWDAF-->>Consumer: 2b. Nnef_PFDManagement_Fetch response + + Note right of NWDAF: 3. Determine whether it needs to collect data and then select the related SMF/UPF + NWDAF->>NWDAF: 3. Determine whether it needs to collect data and then select the related SMF/UPF + + Note right of NWDAF: Option 1: Indirect subscription via SMF + Note right of NWDAF: 3a. Nsmf_EventExposure_Subscribe request + NWDAF->>SMF: 3a. Nsmf_EventExposure_Subscribe request + Note right of SMF: 4a. Nupf_EventExposure_Subscribe request + SMF->>UPF: 4a. Nupf_EventExposure_Subscribe request + Note right of SMF: 4b. Nupf_EventExposure_Subscribe response + UPF-->>SMF: 4b. Nupf_EventExposure_Subscribe response + Note right of NWDAF: 3b. Nsmf_EventExposure_Subscribe response + SMF-->>NWDAF: 3b. Nsmf_EventExposure_Subscribe response + + Note right of NWDAF: Option 2: Direct subscription + Note right of NWDAF: 5a. Nupf_EventExposure_Subscribe request + NWDAF->>UPF: 5a. Nupf_EventExposure_Subscribe request + Note right of NWDAF: 5b. Nupf_EventExposure_Subscribe response + UPF-->>NWDAF: 5b. Nupf_EventExposure_Subscribe response + + Note right of NWDAF: 6a. Nupf_EventExposure_Notify request + NWDAF->>UPF: 6a. Nupf_EventExposure_Notify request + Note right of NWDAF: 6b. Nupf_EventExposure_Notify response + UPF-->>NWDAF: 6b. Nupf_EventExposure_Notify response + + Note right of NWDAF: 7. NWDAF derives PFD Determination Analytics + NWDAF->>NWDAF: 7. NWDAF derives PFD Determination Analytics + + Note left of Consumer: 8a. Nnwdaf_AnalyticsInfo_Request response + NWDAF-->>Consumer: 8a. Nnwdaf_AnalyticsInfo_Request response + Note left of Consumer: 8b. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>Consumer: 8b. Nnwdaf_EventsSubscription_Notify request + Note left of Consumer: 8c. Nnwdaf_EventsSubscription_Notify response + Consumer-->>NWDAF: 8c. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram for PFD Determination Analytics procedure. Lifelines: Consumer (NEF(PFDF)), NWDAF, SMF, UPF. The diagram shows two main paths for data collection: Option 1 (Indirect subscription via SMF) and Option 2 (Direct subscription). + +**Figure 5.7.17-1: Procedure for PFD Determination Analytics** + +- 1a. In order to obtain the PFD determination analytics, the consumer NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 1b-1c. In order to obtain the PFD determination analytics, the consumer NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. +- 2a-2b. The NWDAF invokes Nnef\_PFDManagement\_Fetch service operation as described in clause 4.2.2 of 3GPP TS 29.551 [39] by sending an HTTP POST request targeting the resource "Individual application PFD" to retrieve PFDs for an Application Identifier(s) from the NEF (PFDF). The NEF (PFDF) responds to the NWDAF an HTTP "200 OK" response, with the content containing a representation of an "Individual application PFD" resource or a "PFD of applications" resource for the requested application identifier(s). +3. The NWDAF determines whether it needs to collect data and, if needed, it collects the data either directly from the UPF or indirectly via the SMF and identifies the SMF(s) and/or UPF(s) to retrieve the data. + +- 3a-3b. [Option 1] The NWDAF invokes Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to retrieve the IP flow related information for the application. The SMF responds to the NWDAF an HTTP "201 Created" response. +- 4a-4b. The SMF invokes Nupf\_EventExposure\_Subscribe service operation as described in clause 5.2.2.2 of 3GPP TS 29.564 [40] to retrieve the IP flow related information for the application from UPF. The UPF responds to the SMF an HTTP "201 Created" response. +- 5a-5b. [Option 2] The NWDAF directly invokes Nupf\_EventExposure\_Subscribe service operation as described in clause 5.2.2.2 of 3GPP TS 29.564 [40] to retrieve the IP flow related information for the application from UPF. The UPF responds to the NWDAF an HTTP "201 Created" response. +- 6a-6b. The UPF invokes Nupf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a or step 5a. The NWDAF responds to the UPF an HTTP "204 No Content" response. +7. The NWDAF calculates the PFD determination analytics based on the data collected from UPF and NEF (PFDf). +- 8a. If step 1a is performed, the NWDAF sends the Nnwdaf\_AnalyticsInfo\_Request response as described in clause 5.2.3.1, with HTTP "204 No Content" response if the NWDAF decides no PFD data to be updated or newly reported; or with HTTP "200 OK" response containing the PFD determination analytics in the case that the NWDAF decides the PFD information for the existing Application ID is new or to be updated. +- 8b-8c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1 containing the PFD determination analytics information in the case that the NWDAF decides the PFD information for the existing Application ID is new or to be updated. +- NOTE 1: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. +- NOTE 2: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. +- NOTE 3: For details of Nnef\_PFDManagement\_Fetch service operation refer to 3GPP TS 29.551 [39]. +- NOTE 4: For details of Nupf\_EventExposure\_Subscribe/Unsubscribe/Notify service operations refer to 3GPP TS 29.564 [40]. + +### 5.7.18 E2E data volume transfer time analytics + +This procedure is used by the NWDAF service consumer (may be an NF e.g. AF or NEF) to obtain E2E (end-to-end) data volume transfer time analytics, which is calculated by the NWDAF based on the information collected from the AMF, SMF, AF, and/or OAM. If the NF is an AF which is untrusted, the AF will request analytics via the NEF as described in clause 5.2.3.2. + +![Sequence diagram for E2E data volume transfer time analytics procedure. Lifelines: NF, NWDAF, AMF, SMF, NEF, AF, OAM. The procedure involves multiple steps of requests and responses between these entities to collect data and derive analytics.](1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant AMF + participant SMF + participant NEF + participant AF + participant OAM + + Note left of NF: 11. NWDAF derives End-to-end data volume transfer Analytics + + NF->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + NWDAF-->>NF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NF-->>NWDAF: 1c. Nnwdaf_EventsSubscription_Subscribe response + NWDAF->>AMF: 2a. Namf_EventExposure_Subscribe request + AMF-->>NWDAF: 2b. Namf_EventExposure_Subscribe response + NWDAF->>AMF: 3a. Namf_EventExposure_Notify request + AMF-->>NWDAF: 3b. Namf_EventExposure_Notify response + NWDAF->>SMF: 4a. Nsmf_EventExposure_Subscribe request + SMF-->>NWDAF: 4b. Nsmf_EventExposure_Subscribe response + NWDAF->>SMF: 5a. Nsmf_EventExposure_Notify request + SMF-->>NWDAF: 5b. Nsmf_EventExposure_Notify response + NWDAF->>AF: 6a. Naf_EventExposure_Subscribe request + AF-->>NWDAF: 6b. Naf_EventExposure_Subscribe response + NWDAF->>AF: 7a. Naf_EventExposure_Notify request + AF-->>NWDAF: 7b. Naf_EventExposure_Notify response + NWDAF->>NEF: 8a. Nnef_EventExposure_Subscribe request + NEF->>AF: 8b. Naf_EventExposure_Subscribe request + AF-->>NEF: 8c. Naf_EventExposure_Subscribe response + NEF-->>NWDAF: 8d. Nnef_EventExposure_Subscribe response + NEF->>AF: 9a. Naf_EventExposure_Notify request + NWDAF->>NEF: 9b. Nnef_EventExposure_Notify request + NEF-->>NWDAF: 9c. Nnef_EventExposure_Notify response + NEF-->>AF: 9d. Naf_EventExposure_Notify response + AF->>OAM: 10. Data collection from OAM + OAM-->>AF: + Note left of NF: 11. NWDAF derives End-to-end data volume transfer Analytics + NF-->>NWDAF: 12a. Nnwdaf_AnalyticsInfo_Request response + NF-->>NWDAF: 12b. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>NF: 12c. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram for E2E data volume transfer time analytics procedure. Lifelines: NF, NWDAF, AMF, SMF, NEF, AF, OAM. The procedure involves multiple steps of requests and responses between these entities to collect data and derive analytics. + +**Figure 5.7.17-1: Procedure for E2E data volume transfer time analytics** + +1a. In order to obtain the E2E data volume transfer time analytics, the NWDAF service consumer may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. + +1b-1c. In order to obtain the E2E data volume transfer time analytics, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. + +- 2a-2b. The NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to retrieve the UE location information and SUPI(s) from AMF. The AMF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. If step 2a and step 2b are performed, the AMF may invoke Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. +- 4a-4b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to request DNN, S-NSSAI, application ID, QoS flow packet delay, and QFI. The SMF responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. If step 4a and step 4b are performed, the SMF may invoke Nsmf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a. The NWDAF responds to the SMF an HTTP "204 No Content" response. +- 6a-6b. If the AF is trusted, the NWDAF may invoke Naf\_EventExposure\_Subscribe service operation to the AF directly by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to collect the End-to-end data volume transfer time information. The AF responds to the NWDAF an HTTP "201 Created" response. +- 7a-7b. If step 6a and step 6b are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 7a. The NWDAF responds to the AF an HTTP "204 No Content" response. +- 8a-8d. If the AF is untrusted, the NWDAF may invoke Nnef\_EventExposure\_Subscribe service operation to the NEF by sending an HTTP POST request targeting the resource "Network Exposure Event Subscriptions" and then the NEF invokes Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to collect the E2E data volume transfer time information. The AF responds to the NEF an HTTP "201 Created" response and then the NEF responds to the NWDAF an HTTP "201 Created" response. +- 9a-9d. If step 8a to step 8d are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NEF identified by the notification URI received in step 8b and the NEF invokes Nnef\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 9a. The NWDAF responds to the NEF an HTTP "204 No Content" response and then the NEF responds to the AF an HTTP "204 No Content" response. +10. The NWDAF may collect RAN part delay in clause 6.3.1.2, and 6.3.1.7 of TS 28.554 [30], RAN Throughput for DL and UL in clauses 5.2.1.1 and 5.4.1.1 of TS 37.320 [29], RAN Packet delay for DL and UL per QCI per UE packet delay as specified in clauses 5.2.1.1 of TS 37.320 [29] and and per DRB per UE packet delay as specified in clauses 5.4.1.1 of TS 37.320 [29]. RAN Packet loss rate for DL and UL including the per QCI per UE packet loss rate as specified in clauses 5.2.1.1 of TS 37.320 [29] and the per DRB per UE packet loss rate as specified in clauses 5.4.1.1 of TS 37.320 [29], the distribution of UL/DL/round trip packet delay between PSA UPF and UE as captured in TS 28.552 [27]. from OAM. +11. The NWDAF calculates the End-to-end data volume transfer time analytics based on the data collected from AMF, SMF, AF, and/or OAM. +- 12a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 12b-12c. If step 1b and step 1c are performed, the NWDAF may invoke Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. + +NOTE 1: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. + +NOTE 2: For details of Naf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.517 [12]. + +NOTE 3: For details of Nnef\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.591 [11]. + +NOTE 4: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.19 PDU Session Traffic Analytics + +This procedure is used by the NWDAF service consumer (e.g. PCF) to subscribe or request PDU Session Traffic analytics statistics on whether traffic of UEs via one or multiple PDU sessions is according to the information provided by the service consumer. + +![Sequence diagram illustrating the procedure for PDU Session Traffic Analytics. The diagram shows interactions between NWDAF service consumer, NWDAF, SMF, and UPF. The process starts with the service consumer sending requests to the NWDAF. The NWDAF then determines the data source and either subscribes indirectly via the SMF or directly to the UPF. The UPF provides data to the SMF, which then provides it to the NWDAF. Finally, the NWDAF derives the analytics and responds to the service consumer.](a4eb9fe011f0e6dc8405f777c5f3f766_img.jpg) + +``` + +sequenceDiagram + participant SC as NWDAF service consumer + participant NWDAF + participant SMF + participant UPF + + Note right of NWDAF: 2. Determine whether it needs to collect data and then select the related SMF/UPF + + Note right of NWDAF: Option 1: Indirect subscription via SMF + Note right of NWDAF: Option 2: Direct subscription + + Note right of NWDAF: 7. NWDAF derives PDU Session Traffic analytics + + SC->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + SC->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>SC: 1c. Nnwdaf_EventsSubscription_Subscribe response + + NWDAF->>SMF: 3a. Nsmf_EventExposure_Subscribe request + Note right of SMF: 4a. Nupf_EventExposure_Subscribe request + Note right of SMF: 4b. Nupf_EventExposure_Subscribe response + SMF-->>NWDAF: 3b. Nsmf_EventExposure_Subscribe response + + Note right of NWDAF: 5a. Nupf_EventExposure_Subscribe request + Note right of NWDAF: 5b. Nupf_EventExposure_Subscribe response + + Note right of NWDAF: 6a. Nupf_EventExposure_Notify request + Note right of NWDAF: 6b. Nupf_EventExposure_Notify response + + NWDAF-->>SC: 8a. Nnwdaf_AnalyticsInfo_Request response + NWDAF-->>SC: 8b. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>SC: 8c. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram illustrating the procedure for PDU Session Traffic Analytics. The diagram shows interactions between NWDAF service consumer, NWDAF, SMF, and UPF. The process starts with the service consumer sending requests to the NWDAF. The NWDAF then determines the data source and either subscribes indirectly via the SMF or directly to the UPF. The UPF provides data to the SMF, which then provides it to the NWDAF. Finally, the NWDAF derives the analytics and responds to the service consumer. + +**Figure 5.7.19-1: Procedure for PDU Session Traffic Analytics** + +1a. In order to obtain the PDU Session Traffic analytics, the NWDAF service consumer (e.g. PCF) may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. + +1b-1c. In order to obtain the PDU Session Traffic analytics, the NWDAF service consumer (e.g. PCF) may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. + +2. The NWDAF determines whether it needs to collect the data and, if needed, it collects the data either directly from the UPF or indirectly via the SMF and identifies the SMF(s) and/or UPF(s) to retrieve the data. + +3a-3b. [Option 1] The NWDAF invokes Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to retrieve "UserDataUsageMeasures" UPF event for the S-NSSAI/DNN and SUPI(s). The SMF responds to the NWDAF an HTTP "201 Created" response. + +4a-4b. The SMF invokes Nupf\_EventExposure\_Subscribe service operation as described in clause 5.2.2.2 of 3GPP TS 29.564 [40] to retrieve "UserDataUsageMeasures" UPF event for the S-NSSAI/DNN and SUPI(s) from the UPF. The UPF responds to the SMF an HTTP "201 Created" response. + +- 5a-5b. [Option 2] The NWDAF directly invokes Nupf\_EventExposure\_Subscribe service operation as described in clause 5.2.2.2 of 3GPP TS 29.564 [40] to retrieve "UserDataUsageMeasures" UPF event for the S-NSSAI/DNN and SUPI(s) from the UPF. The UPF responds to the NWDAF an HTTP "201 Created" response. +- 6a-6b. The UPF invokes Nupf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a or step 5a. The NWDAF responds to the UPF an HTTP "204 No Content" response. +7. The NWDAF derives analytics indicating a list of UEs and the traffic they route according to the provided information provided by the consumer (i.e. Traffic Descriptor, S-NSSAI and DNN), including its volume and the traffic they route and a list of UEs which route traffic that it is not expected according to the information provided by the consumer (i.e. Traffic Descriptor, S-NSSAI and DNN) including its volume.). +- 8a. If step 1a is performed, the NWDAF sends the Nnwdaf\_AnalyticsInfo\_Request response containing the PDU Session Traffic analytics as described in clause 5.2.3.1. +- 8b-8c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation containing the PDU Session Traffic analytics as described in clause 5.2.2.1. +- NOTE 1: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. +- NOTE 2: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. + +### 5.7.20 Relative Proximity Analytics + +This procedure is used by the NWDAF service consumer e.g. NEF or AF to obtain Relative Proximity Analytics among UEs provided by NWDAF to assist more accurately localize a cluster (or a set) of UEs via provisioning statistics and/or prediction information related to their relative proximity. + +![Sequence diagram for Relative Proximity Analytics procedure involving NF, NWDAF, AMF, GMLC, NEF, AF, and OAM.](ffe0fef452a0ae9a20253c319c54e13c_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant AMF + participant GMLC + participant NEF + participant AF + participant OAM + + Note left of NWDAF: 11. NWDAF derives Relative Proximity Analytics + Note left of NWDAF: 18. NWDAF derives Relative Proximity Analytics + + Note right of NF: 1a. Nnwdaf_AnalyticsInfo_Request request + Note right of NF: 1b. Nnwdaf_EventsSubscription_Subscribe request + Note right of NF: 1c. Nnwdaf_EventsSubscription_Subscribe response + Note right of NF: 2a. Namf_EventExposure_Subscribe request + Note right of NF: 2b. Namf_EventExposure_Subscribe response + Note right of NF: 3a. Namf_EventExposure_Notify request + Note right of NF: 3b. Namf_EventExposure_Notify response + Note right of NF: 4a. Ngmlc_Location_ProvideLocation request + Note right of NF: 4b. Ngmlc_Location_ProvideLocation response + Note right of NF: 5a. Ngmlc_Location_EventNotify request + Note right of NF: 5b. Ngmlc_Location_EventNotify response + Note right of NF: 6a. Naf_EventExposure_Subscribe request + Note right of NF: 6b. Naf_EventExposure_Subscribe response + Note right of NF: 7a. Naf_EventExposure_Notify request + Note right of NF: 7b. Naf_EventExposure_Notify response + Note right of NF: 8a. Nnef_EventExposure_Subscribe request + Note right of NF: 8b. Naf_EventExposure_Subscribe request + Note right of NF: 8c. Naf_EventExposure_Subscribe response + Note right of NF: 8d. Nnef_EventExposure_Subscribe response + Note right of NF: 9a. Naf_EventExposure_Notify request + Note right of NF: 9b. Nnef_EventExposure_Notify request + Note right of NF: 9c. Nnef_EventExposure_Notify response + Note right of NF: 9d. Naf_EventExposure_Notify response + Note right of NF: 10. NWDAF collects data from OAM + Note right of NF: 12a. Nnwdaf_AnalyticsInfo_Request response + Note right of NF: 12b. Nnwdaf_EventsSubscription_Notify request + Note right of NF: 12c. Nnwdaf_EventsSubscription_Notify response + Note right of NF: 13a. Namf_EventExposure_Notify request + Note right of NF: 13b. Namf_EventExposure_Notify response + Note right of NF: 14a. Ngmlc_Location_EventNotify request + Note right of NF: 14b. Ngmlc_Location_EventNotify response + Note right of NF: 15a. Naf_EventExposure_Notify request + Note right of NF: 15b. Naf_EventExposure_Notify response + Note right of NF: 16a. Naf_EventExposure_Notify request + Note right of NF: 16b. Nnef_EventExposure_Notify request + Note right of NF: 16c. Nnef_EventExposure_Notify response + Note right of NF: 16d. Naf_EventExposure_Notify response + Note right of NF: 17. NWDAF collects data from OAM + Note right of NF: 19a. Nnwdaf_EventsSubscription_Notify request + Note right of NF: 19b. Nnwdaf_EventsSubscription_Notify response + +``` + +The sequence diagram illustrates the procedure for Relative Proximity Analytics. It begins with the NF sending three requests to the NWDAF: 1a. Nnwdaf\_AnalyticsInfo\_Request, 1b. Nnwdaf\_EventsSubscription\_Subscribe, and 1c. Nnwdaf\_EventsSubscription\_Subscribe response. The NWDAF then sends a series of requests and responses to the AMF (2a-3b), GMLC (4a-5b), and AF (6a-7b). The NEF sends a request to the AF (8a), which in turn sends a request to the AF (8b) and receives a response (8c). The NEF then sends a response to the NWDAF (8d). The AF sends a request to the NEF (9a), which sends a request to the NWDAF (9b) and receives a response (9c). The NEF then sends a response to the AF (9d). The NWDAF collects data from the OAM (10). The NWDAF then derives Relative Proximity Analytics (11). The NF receives three responses from the NWDAF: 12a. Nnwdaf\_AnalyticsInfo\_Request response, 12b. Nnwdaf\_EventsSubscription\_Notify request, and 12c. Nnwdaf\_EventsSubscription\_Notify response. The NWDAF then sends a series of requests and responses to the AMF (13a-13b), GMLC (14a-14b), and AF (15a-15b). The NEF sends a request to the AF (16a), which sends a request to the NWDAF (16b) and receives a response (16c). The NEF then sends a response to the AF (16d). The NWDAF collects data from the OAM (17). The NWDAF then derives Relative Proximity Analytics (18). The NF receives two responses from the NWDAF: 19a. Nnwdaf\_EventsSubscription\_Notify request and 19b. Nnwdaf\_EventsSubscription\_Notify response. + +Sequence diagram for Relative Proximity Analytics procedure involving NF, NWDAF, AMF, GMLC, NEF, AF, and OAM. + +Figure 5.7.20-1: Procedure for Relative Proximity Analytics + +- 1a. In order to obtain the Relative Proximity Analytics, the NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 1b-1c. In order to subscribe to the Relative Proximity Analytics, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. +- 2a-2b. If the event is set to "RELATIVE\_PROXIMITY" and the subscription/request is authorized, the NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to subscribe to the notification of UE ID and UE location. The AMF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. If step 2a and step 2b are performed, the AMF invokes Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. +- 4a-4b. The NWDAF may invoke Ngmlc\_Location\_ProvideLocation service operation to retrieve UE Location and UE Location Accuracy by sending an HTTP POST request to the URI associated with the "provide-location" custom operation as described in 3GPP TS 29.515 [41] clause 5.2.2.2. The GMLC responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. If step 4a and step 4b are performed, the GMLC may invoke Ngmlc\_Location\_EventNotify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a. The NWDAF responds to the GMLC an HTTP "204 No Content" response. +- 6a-6b. If the AF is trusted, the NWDAF may invoke Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to subscribe the Proximity attributes and/or Proximity related input data of UE(s) from AF directly. The AF responds to the NWDAF an HTTP "201 Created" response. +- 7a-7b. If step 6a and step 6b are performed, the AF may invoke Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 6a. The NWDAF responds to the AF an HTTP "204 No Content" response. +- 8a-8d. If the AF is untrusted, the NWDAF may invoke Nnef\_EventExposure\_Subscribe service operation to the NEF by sending an HTTP POST request targeting the resource "Network Exposure Event Subscriptions" and then the NEF invokes Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions". The AF responds to the NEF an HTTP "201 Created" response and then the NEF responds to the NWDAF an HTTP "201 Created" response. +- 9a-9d. If step 8a to step 8d are performed, the AF may invoke Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NEF identified by the notification URI received in step 8b and the NEF invokes Nnef\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 8a. The NWDAF responds to the NEF an HTTP "204 No Content" response and then the NEF responds to the AF an HTTP "204 No Content" response. +10. The NWDAF may collect Per UE information of Speed and Orientation related input data as specified in clause 4.3.30 of TS 28.622 [42], clause 11.1 of TS 28.532 [19] and clause 5.10.29 of TS 32.422 [43]. +11. The NWDAF derives the Relative Proximity Analytics based on the data collected from AMF, GMLC, (DC)AF, and/or OAM. +- 12a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 12b-12c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. +- 13a-13b. The same as step 3a and step 3b. +- 14a-14b. The same as step 5a and step 5b. +- 15a-15b. The same as step 7a and step 7b. +- 16a-16d. The same as step 9a and step 9b. +17. The same as step 10. + +18. The same as step 11. + +19a-19b. The same as step 12b and step 12c. + +NOTE 1: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +NOTE 2: For details of Nnef\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.591 [11]. + +NOTE 3: For details of Naf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.517 [12]. + +### 5.7.21 Movement Behaviour Analytics + +This procedure is used by the NWDAF service consumer e.g. NEF or AF to obtain Movement Behaviour Analytics provided by NWDAF regarding the location, direction and velocity of UEs during an analytics target period in a target area. + +![Sequence diagram for Movement Behaviour Analytics procedure. Lifelines: NF, NWDAF, AMF, GMLC. The sequence starts with NF sending 1a. Nnwdaf_AnalyticsInfo_Request request to NWDAF. 1b. Nnwdaf_EventsSubscription_Subscribe request to NWDAF. 1c. Nnwdaf_EventsSubscription_Subscribe response from NWDAF to NF. 2a. Namf_EventExposure_Subscribe request from NWDAF to AMF. 2b. Namf_EventExposure_Subscribe response from AMF to NWDAF. 3a. Namf_EventExposure_Notify request from AMF to NWDAF. 3b. Namf_EventExposure_Notify response from NWDAF to AMF. 4a. Ngmlc_Location_ProvideLocation request from NWDAF to GMLC. 4b. Ngmlc_Location_ProvideLocation response from GMLC to NWDAF. 5a. Ngmlc_Location_EventNotify request from GMLC to NWDAF. 5b. Ngmlc_Location_EventNotify response from NWDAF to GMLC. A box labeled '6. NWDAF derives Movement Behaviour Analytics' is shown. 7a. Nnwdaf_AnalyticsInfo_Request response from NWDAF to NF. 7b. Nnwdaf_EventsSubscription_Notify request from NWDAF to NF. 7c. Nnwdaf_EventsSubscription_Notify response from NF to NWDAF.](ffd8c2986aabedc8b6db2d8f2ed7a994_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant AMF + participant GMLC + Note right of NWDAF: 6. NWDAF derives Movement Behaviour Analytics + NF->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + NF->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>NF: 1c. Nnwdaf_EventsSubscription_Subscribe response + NWDAF->>AMF: 2a. Namf_EventExposure_Subscribe request + AMF-->>NWDAF: 2b. Namf_EventExposure_Subscribe response + AMF->>NWDAF: 3a. Namf_EventExposure_Notify request + NWDAF-->>AMF: 3b. Namf_EventExposure_Notify response + NWDAF->>GMLC: 4a. Ngmlc_Location_ProvideLocation request + GMLC-->>NWDAF: 4b. Ngmlc_Location_ProvideLocation response + GMLC->>NWDAF: 5a. Ngmlc_Location_EventNotify request + NWDAF-->>GMLC: 5b. Ngmlc_Location_EventNotify response + Note right of NWDAF: 6. NWDAF derives Movement Behaviour Analytics + NWDAF-->>NF: 7a. Nnwdaf_AnalyticsInfo_Request response + NWDAF->>NF: 7b. Nnwdaf_EventsSubscription_Notify request + NF-->>NWDAF: 7c. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram for Movement Behaviour Analytics procedure. Lifelines: NF, NWDAF, AMF, GMLC. The sequence starts with NF sending 1a. Nnwdaf\_AnalyticsInfo\_Request request to NWDAF. 1b. Nnwdaf\_EventsSubscription\_Subscribe request to NWDAF. 1c. Nnwdaf\_EventsSubscription\_Subscribe response from NWDAF to NF. 2a. Namf\_EventExposure\_Subscribe request from NWDAF to AMF. 2b. Namf\_EventExposure\_Subscribe response from AMF to NWDAF. 3a. Namf\_EventExposure\_Notify request from AMF to NWDAF. 3b. Namf\_EventExposure\_Notify response from NWDAF to AMF. 4a. Ngmlc\_Location\_ProvideLocation request from NWDAF to GMLC. 4b. Ngmlc\_Location\_ProvideLocation response from GMLC to NWDAF. 5a. Ngmlc\_Location\_EventNotify request from GMLC to NWDAF. 5b. Ngmlc\_Location\_EventNotify response from NWDAF to GMLC. A box labeled '6. NWDAF derives Movement Behaviour Analytics' is shown. 7a. Nnwdaf\_AnalyticsInfo\_Request response from NWDAF to NF. 7b. Nnwdaf\_EventsSubscription\_Notify request from NWDAF to NF. 7c. Nnwdaf\_EventsSubscription\_Notify response from NF to NWDAF. + +**Figure 5.7.21-1: Procedure for Movement Behaviour Analytics** + +1a. In order to obtain the Movement Behaviour Analytics, the NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. + +1b-1c. In order to subscribe to the Movement Behaviour Analytics, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. + +2a-2b. If the event is set to "MOVEMENT\_BEHAVIOUR" and the subscription/request is authorized, the NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to subscribe to the notification of UE ID and UE positions. The AMF responds to the NWDAF an HTTP "201 Created" response. + +- 3a-3b. If step 2a and step 2b are performed, the AMF invokes Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. +- 4a-4b. The NWDAF may invoke Ngmlc\_Location\_ProvideLocation service operation to retrieve UE Fine granularity locations by sending an HTTP POST request to the URI associated with the "provide-location" custom operation as described in 3GPP TS 29.515 [41] clause 5.2.2.2. The GMLC responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. If step 4a and step 4b are performed, the GMLC may invoke Ngmlc\_Location\_EventNotify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a. The NWDAF responds to the GMLC an HTTP "204 No Content" response. +- 6. The NWDAF derives the Movement Behaviour Analytics based on the data collected from AMF and/or GMLC. +- 7a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 7b-7c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. + +NOTE: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +## 5.8 Procedures for NWDAF Discovery and Selection + +### 5.8.1 General + +NWDAF may be deployed in multiple configuration options. Not all these configurations require the same registration, discovery and selection procedures. The discovery and selection may depend on the NWDAF deployment option and the types of analytics it procedures, (i.e., whether it is related to Network Functions or to UEs) or the data that is able to collect from NFs. + +### 5.8.2 Procedures related to NRF + +#### 5.8.2.1 General + +#### 5.8.2.2 NWDAF (De-)Registration in NRF + +NWDAF (de-)registers in NRF as a regular network function. See TS 29.510 [23] for details. + +#### 5.8.2.3 Consumer discovery and selection of NWDAF in NRF + +A consumer of analytics services may use the NRF for discovering an NWDAF containing AnLF or MTLF. + +If the NWDAF service consumer needs to discover an NWDAF containing AnLF that is able to collect data from particular data sources identified by their NF Set IDs or NF types, the consumer may query NRF with the Nnrf\_NFDiscovery\_NFDiscover service operation, providing the NF Set IDs (serving-nf-set-id attribute) or NF types (serving-nf-type attribute) in the discovery request. See 3GPP TS 29.510 [23] for details. + +If the NWDAF service consumer (NWDAF containing MTLF) needs to discover an NWDAF containing MTLF that support Federated Learning identified by their FL capability (i.e. FL server or FL client), the consumer may query NRF with the Nnrf\_NFDiscovery\_NFDiscover service operation for discovery of FL Server NWDAF (NWDAF containing MTLF) or FL Client NWDAF (NWDAF containing MTLF). See 3GPP TS 29.510 [23] for details. + +If the NWDAF service consumer needs to discover an NWDAF containing MTLF that is able to provide ML model provisioning services with trained ML models available for one or more Analytics ID(s), the consumer may query NRF with the Nnrf\_NFDiscovery\_NFDiscover service operation for discovery of NWDAF containing the required trained ML model. See 3GPP TS 29.510 [23] for details. + +In the roaming architecture, a consumer in the same PLMN as the RE-NWDAF discovers the RE-NWDAF by querying for an NWDAF where the roaming exchange capability is indicated in its NRF profile. A consumer in a peer PLMN (i.e. RE-NWDAF) discovers the RE-NWDAF by querying for an NWDAF in the target PLMN that is supporting the specific services defined for roaming. A RE-NWDAF discovers the RE-NWDAF in a different PLMN (i.e. HPLMN or VPLMN) using the procedure defined in clause 4.17.5 (if delegated discovery is not used) or clause 4.17.10 (if delegated discovery is used) of TS 23.502 [3], where the detailed parameters are determined based on the analytics request or subscription from the consumer 5GC NF, operator policy, user consent and/or local configuration. See 3GPP TS 29.510 [23] for details. + +### 5.8.3 Procedures related to UDM + +#### 5.8.3.1 General + +#### 5.8.3.2 NWDAF containing AnLF Registration/Deregistration in UDM + +##### 5.8.3.2.1 NWDAF containing AnLF Registration in UDM + +For UE-related analytics or for analytics that involve UE-related data collection, an NWDAF containing AnLF may register in UDM using the Nudm\_UECM\_Register service operation (see TS 29.503 [22] clause 5.3.2.2.8). This is useful especially in scenarios of co-location of the NWDAF containing AnLF with other network functions (e.g., AMF, SMF) and in certain deployment models. Figure 5.8.3.2.1-1 illustrates the signalling flow. + +![Sequence diagram illustrating the NWDAF containing AnLF registration in UDM. The diagram shows two lifelines: NWDAF containing AnLF and UDM. The process starts with the NWDAF containing AnLF triggering a registration in UDM. It then sends a Nudm_UECM_Registration request to the UDM, which responds with a Nudm_UECM_Registration response.](1069cea91549f4b971298888e7982f53_img.jpg) + +``` +sequenceDiagram + participant NWDAF as NWDAF containing AnLF + participant UDM as UDM + Note left of NWDAF: 1. Trigger to register in UDM + NWDAF->>UDM: 2. Nudm_UECM_Registration request + UDM-->>NWDAF: 3. Nudm_UECM_Registration response +``` + +Sequence diagram illustrating the NWDAF containing AnLF registration in UDM. The diagram shows two lifelines: NWDAF containing AnLF and UDM. The process starts with the NWDAF containing AnLF triggering a registration in UDM. It then sends a Nudm\_UECM\_Registration request to the UDM, which responds with a Nudm\_UECM\_Registration response. + +**Figure 5.8.3.2.1-1: NWDAF containing AnLF registration in UDM** + +1. NWDAF containing AnLF triggers a registration in UDM, e.g. based on local configuration in the NWDAF containing AnLF, the reception of a new Analytics subscription request, start of collection of UE related data or an OAM configuration action. +2. The NWDAF containing AnLF registers into UDM for the served UE, by sending Nudm\_UECM\_Registration request (UE ID of the served user, NWDAF Instance ID, NF Set ID, Analytics ID(s)). +3. UDM sends a response to NWDAF containing AnLF. A successful response consists of a "200 OK" or "201 Created". If the operation is unsuccessful, UDM responds with proper error response code. See TS 29.503 [22] for details. + +##### 5.8.3.2.2 NWDAF containing AnLF Update of Registration in UDM + +If an NWDAF containing AnLF has previously registered in UDM for one or more analytics IDs for a given UE, the NWDAF containing AnLF may modify the registration at any time. This may be due to, e.g., the NWDAF containing AnLF adds one or more Analytic IDs for the UE, or the NWDAF containing AnLF removes one or more Analytics IDs, but keep registered in UDM for at least one Analytic ID. The NWDAF containing AnLF sends an Nudm\_UECM\_Update service operation (NWDAF registration ID, added or removed Analytics ID(s)), see TS 29.503 [22] clause 5.3.2.6.4. Figure 5.8.3.2.2-1 illustrates the signalling flow. + +![Sequence diagram for NWDAF containing AnLF registration update in UDM](fc3e2b49a9f850951570e502393b697f_img.jpg) + +``` +sequenceDiagram + participant NWDAF as NWDAF containing AnLF + participant UDM + Note left of NWDAF: 1. Trigger to update registration in UDM + NWDAF->>UDM: 2. Nudm_UECM_Update request + UDM-->>NWDAF: 3. Nudm_UECM_Update response +``` + +The diagram illustrates the signaling flow for a registration update. It starts with a box labeled 'NWDAF containing AnLF' with a sub-box '1. Trigger to update registration in UDM'. An arrow labeled '2. Nudm\_UECM\_Update request' points from the NWDAF to a box labeled 'UDM'. A return arrow labeled '3. Nudm\_UECM\_Update response' points from the UDM back to the NWDAF. + +Sequence diagram for NWDAF containing AnLF registration update in UDM + +**Figure 5.8.3.2.2-1: NWDAF containing AnLF registration update in UDM** + +1. If an NWDAF containing AnLF has previously registered one or more Analytics IDs for a UE in UDM, the NWDAF containing AnLF triggers an update of the registration in UDM, e.g. based on the NWDAF containing AnLF serving the UE of one or more additional Analytic ID(s) or based on the NWDAF containing AnLF not serving the UE for one or more Analytic ID(s) but serving the UE for at least one Analytic ID. +2. The NWDAF containing AnLF updates its registration in UDM for the served UE, by sending Nudm\_UECM\_Update request (NWDAF Registration Id, added or removed Analytic ID(s)). +3. Upon success UDM sends a "204 No Content" response to the NWDAF containing AnLF. If the operation is unsuccessful, UDM responds with proper error response code. See TS 29.503 [22] for details. + +##### 5.8.3.2.3 NWDAF containing AnLF De-Registration in UDM + +If an NWDAF containing AnLF has previously registered in UDM for one or more analytics ID for a given UE, when the NWDAF containing AnLF no longer serves the UE, e.g., it does not collect data for the UE for that Analytics ID or does no keep produce analytic reports or does not keep any data related to the UE, the NWDAF containing AnLF should de-register from UDM by invoking the Nudm\_UECM\_Deregistration service operation (NWDAF registration ID, Analytics ID(s)), see TS 29.503 [22] clause 5.3.2.4.8). Figure 5.8.3.2.3-1 illustrates the signalling flow. + +![Sequence diagram for NWDAF containing AnLF deregistration from UDM](2957154f4dc666a6cafb7b4d2d882910_img.jpg) + +``` +sequenceDiagram + participant NWDAF as NWDAF containing AnLF + participant UDM + Note left of NWDAF: 1. Trigger to de-register from UDM + NWDAF->>UDM: 2. Nudm_UECM_Deregistration request + UDM-->>NWDAF: 3. Nudm_UECM_Deregistration response +``` + +The diagram illustrates the signaling flow for a deregistration. It starts with a box labeled 'NWDAF containing AnLF' with a sub-box '1. Trigger to de-register from UDM'. An arrow labeled '2. Nudm\_UECM\_Deregistration request' points from the NWDAF to a box labeled 'UDM'. A return arrow labeled '3. Nudm\_UECM\_Deregistration response' points from the UDM back to the NWDAF. + +Sequence diagram for NWDAF containing AnLF deregistration from UDM + +**Figure 5.8.3.2.3-1: NWDAF containing AnLF deregistration from UDM** + +1. If an NWDAF containing AnLF has previously registered one or more Analytics IDs for a UE in UDM, the NWDAF containing AnLF triggers a complete deregistration from UDM, e.g. based on the NWDAF containing AnLF not collecting data any longer for the UE, or the NWDAF containing AnLF not producing analytics reports for the UE, or the NWDAF containing AnLF not keeping analytics data for the UE. +2. The NWDAF containing AnLF deregisters from UDM for the served UE, by sending Nudm\_UECM\_Deregistration request (NWDAF Registration Id). +3. UDM sends a "204 No Content" response to the NWDAF containing AnLF. See TS 29.503 [22] for details. + +#### 5.8.3.3 Consumer discovery and selection of NWDAF containing AnLF in UDM + +For UE related analytics, if the NWDAF service consumer needs to discover an NWDAF containing AnLF that is serving or holds data for a UE, the NWDAF serving consumer may query UDM with the target SUPI and the Analytics ID. If the response from UDM indicates multiple candidate NWDAFs, the NWDAF service consumer may, e.g., determine an instance of an NWDAF containing AnLF that has registered in UDM (registrationTime attribute) around the time of interest of the data or analytics, and may also query NRF, as specified in clause 5.8.2.3 in order to determine the capabilities of these NWDAFs and select the most appropriate one. Figure 5.8.3.3-1 illustrates the signalling flow. + +![Sequence diagram showing the discovery of an NWDAF containing AnLF in UDM. The NWDAF Service Consumer sends a Nudm_UECM_Get request to the UDM, and the UDM responds with a Nudm_UECM_Get response.](ff1a293f8118c0f00dbfeb0ab843d6e6_img.jpg) + +``` +sequenceDiagram + participant NWDAF Service Consumer + participant UDM + Note left of NWDAF Service Consumer: 1. Nudm_UECM_Get request + NWDAF Service Consumer->>UDM: 1. Nudm_UECM_Get request + Note right of UDM: 2. Nudm_UECM_Get response + UDM-->>NWDAF Service Consumer: 2. Nudm_UECM_Get response +``` + +Sequence diagram showing the discovery of an NWDAF containing AnLF in UDM. The NWDAF Service Consumer sends a Nudm\_UECM\_Get request to the UDM, and the UDM responds with a Nudm\_UECM\_Get response. + +**Figure 5.8.3.3-1: Discovery of NWDAF containing AnLF in UDM** + +1. The NWDAF service consumer sends an Nudm\_UECM\_Get request to the UDM (UE ID, Analytics ID(s), NF type = NWDAF). +2. Upon success, UDM sends a "200 OK" response to the service consumer including the NWDAF information registered for the UE ID. If the operation is unsuccessful, UDM responds with proper error response code. See TS 29.503 [22] for details. + +### 5.8.4 Procedures for PCF learning NWDAF IDs for served UEs + +PCF may receive from AMF and SMF the IDs of the NWDAFs containing AnLF that are used by AMF, SMF, and UPF, so that the PCF may select the same NWDAF containing AnLF being used for a specific UE. + +When the AMF creates or updates an Access and Mobility Policy Association for a UE, the AMF may include the IDs of the NWDAF containing AnLF that are used by the AMF, along with their Analytic ID(s), in the Npcf\_AMPolicyControl\_Create/Update service operations, as illustrated in Figure 5.8.4-1. See details in TS 29.507 [24]. + +![Sequence diagram showing the PCF learning from AMF NWDAFs containing AnLF. The AMF sends an Npcf_AMPolicyControl_Create/Update request to the PCF, and the PCF responds with an Npcf_AMPolicyControl_Create/Update response.](8198a1ee0b1f6ef1c5f1bf702dc74eca_img.jpg) + +``` +sequenceDiagram + participant AMF + participant PCF + Note left of AMF: 1. Npcf_AMPolicyControl_Create/Update request + AMF->>PCF: 1. Npcf_AMPolicyControl_Create/Update request + Note right of PCF: 2. Npcf_AMPolicyControl_Create/Update response + PCF-->>AMF: 2. Npcf_AMPolicyControl_Create/Update response +``` + +Sequence diagram showing the PCF learning from AMF NWDAFs containing AnLF. The AMF sends an Npcf\_AMPolicyControl\_Create/Update request to the PCF, and the PCF responds with an Npcf\_AMPolicyControl\_Create/Update response. + +**Figure 5.8.4-1: PCF leaning from AMF NWDAFs containing AnLF** + +The PCF may select those NWDAF instances discovered through the Npcf\_AMPolicyControl\_Create/Update request as the ones to use for their associated analytic ID(s) for the UE for which those AM Policy Associations are related to. + +When the SMF creates or updates a Session Management Policy Association for a UE, the SMF may include the IDs of the NWDAF containing AnLF that are used by the SMF and UPF, along with their Analytic ID(s), in the Npcf\_SMPolicyControl\_Create/Update service operations, as illustrated in Figure 5.8.4-2. See details in TS 29.512 [25]. + +![Sequence diagram showing the interaction between SMF and PCF. The SMF sends a '1. Npcf_SMPolicyControl_Create/Update request' to the PCF, and the PCF responds with '2. Npcf_SMPolicyControl_Create/Update response'.](c00d3fb4f9d9609639a6e7d7a356afd3_img.jpg) + +``` +sequenceDiagram + participant SMF + participant PCF + Note left of SMF: SMF + Note right of PCF: PCF + SMF->>PCF: 1. Npcf_SMPolicyControl_Create/Update request + PCF-->>SMF: 2. Npcf_SMPolicyControl_Create/Update response +``` + +Sequence diagram showing the interaction between SMF and PCF. The SMF sends a '1. Npcf\_SMPolicyControl\_Create/Update request' to the PCF, and the PCF responds with '2. Npcf\_SMPolicyControl\_Create/Update response'. + +**Figure 5.8.4-2: PCF leaning from SMF and UPF NWDAFs containing AnLF** + +The PCF may select those NWDAF instances discovered through the Npcf\_SMPolicyControl\_Create/Update request as the ones to subscribe for their associated analytic ID(s) for the UE for which those SM Policy Associations are related to. + +## 5.9 Analytics Data Repository procedures + +### 5.9.1 General + +The Analytics Data Repository procedures allow the NF service consumers (e.g. NWDAF, DCCF or MFAF) to store, retrieve or delete collected data and analytics in the ADRF. + +### 5.9.2 Historical Data and Analytics Storage/Retrieval/Deletion procedure + +The procedure is used by an NF service consumer (e.g. NWDAF, DCCF or MFAF) to store, retrieve or delete historical data and/or analytics, i.e. data and/or analytics related to past time period that has been obtained by the consumer. + +![Sequence diagram illustrating the Historical Data and Analytics storage/deletion procedure. The diagram shows four lifelines: NWDAF, DCCF, MFAF, and ADRF. The procedure consists of three main parts: storage, retrieval, and deletion. 1. Storage: NWDAF sends a Nadrf_DataManagement_StorageRequest Request to ADRF via DCCF and MFAF. ADRF stores the data (step 2) and returns a Nadrf_DataManagement_StorageRequest Response (step 3) back through MFAF and DCCF to NWDAF. 2. Retrieval: NWDAF sends a Nadrf_DataManagement_RetrievalRequest Request to ADRF via DCCF and MFAF. ADRF returns a Nadrf_DataManagement_RetrievalRequest Response (step 5) back through MFAF and DCCF to NWDAF. 3. Deletion: NWDAF sends a Nadrf_DataManagement_Delete Request to ADRF via DCCF and MFAF. ADRF deletes the data (step 7) and returns a Nadrf_DataManagement_Delete Response (step 8) back through MFAF and DCCF to NWDAF.](e18841eb4a995df8354a793459e12fd0_img.jpg) + +``` + +sequenceDiagram + participant NWDAF + participant DCCF + participant MFAF + participant ADRF + + Note right of ADRF: 2. ADRF stores data + + Note right of ADRF: 7. ADRF deletes stored data + + NWDAF->>ADRF: 1. Nadrf_DataManagement_StorageRequest Request + ADRF-->>NWDAF: 3. Nadrf_DataManagement_StorageRequest Response + Note right of ADRF: 2. ADRF stores data + NWDAF->>ADRF: 4. Nadrf_DataManagement_RetrievalRequest Request + ADRF-->>NWDAF: 5. Nadrf_DataManagement_RetrievalRequest Response + NWDAF->>ADRF: 6. Nadrf_DataManagement_Delete Request + ADRF-->>NWDAF: 8. Nadrf_DataManagement_Delete Response + Note right of ADRF: 7. ADRF deletes stored data + +``` + +Sequence diagram illustrating the Historical Data and Analytics storage/deletion procedure. The diagram shows four lifelines: NWDAF, DCCF, MFAF, and ADRF. The procedure consists of three main parts: storage, retrieval, and deletion. 1. Storage: NWDAF sends a Nadrf\_DataManagement\_StorageRequest Request to ADRF via DCCF and MFAF. ADRF stores the data (step 2) and returns a Nadrf\_DataManagement\_StorageRequest Response (step 3) back through MFAF and DCCF to NWDAF. 2. Retrieval: NWDAF sends a Nadrf\_DataManagement\_RetrievalRequest Request to ADRF via DCCF and MFAF. ADRF returns a Nadrf\_DataManagement\_RetrievalRequest Response (step 5) back through MFAF and DCCF to NWDAF. 3. Deletion: NWDAF sends a Nadrf\_DataManagement\_Delete Request to ADRF via DCCF and MFAF. ADRF deletes the data (step 7) and returns a Nadrf\_DataManagement\_Delete Response (step 8) back through MFAF and DCCF to NWDAF. + +**Figure 5.9.2-1: Historical Data and Analytics storage/deletion procedure** + +1. In order to store data or analytics, the NF service consumer invokes Nadrf\_DataManagement\_StorageRequest service operation by sending an HTTP POST request targeting the resource "ADRF Data Store Records" in clause 4.2.2.2 of 3GPP TS 29.575 [16]. +2. The ADRF stores the data or analytics sent by the consumer. The ADRF may, based on implementation, determines whether the same data or analytics is already stored or being stored based on the information sent in step 1 by the consumer and, if the data or analytics is already stored or being stored in the ADRF, the ADRF decides to not store again the data or analytics sent by the consumer. +3. If the data or analytics is stored, the ADRF sends Nadrf\_DataManagement\_StorageRequest Response message to the consumer with HTTP "201 Created" status code including a representation of the created record. +4. In order to retrieve the stored data or analytics from the ADRF, the NF service consumer shall invoke the Nadrf\_DataManagement\_RetrievalRequest service operation by sending an HTTP GET request targeting the resource "ADRF Data Store Records" as described in clause 4.2.2.5 of 3GPP TS 29.575 [16]. +5. If the requested data is found, the ADRF sends Nadrf\_DataManagement\_RetrievalRequest Response message to the consumer with HTTP "200 OK" status code including a representation of the matched record. +6. In order to delete the specified data or analytics from the ADRF, the NF service consumer shall invoke the Nadrf\_DataManagement\_Delete service operation by sending an HTTP DELETE request targeting the resource "Individual ADRF Data Store Record" as described in clause 4.2.2.9 of 3GPP TS 29.575 [16] if the NF service consumer delete the resource including the transaction identifier, or by sending an HTTP POST request including the time window in which the data to be deleted was collected and data or analytics specification. +7. The ADRF deletes the specified stored data or analytics requested by the consumer. +8. If the deletion is successfully processed, the ADRF sends Nadrf\_DataManagement\_Delete Response message to the consumer with HTTP "204 No Content" status code. + +### 5.9.3 Historical Data and Analytics Storage via Notifications + +The procedure is used by an NF service consumer (e.g. NWDAF, DCCF) to store received notifications in the ADRF. + +![Sequence diagram illustrating the Historical Data and Analytics storage/deletion procedure. Lifelines: Data or Analytics Consumer, NWDAF, DCCF, MFAF, ADRF. The process involves subscription, determination of storage, request to ADRF, response, and subsequent notification handling.](346324c08906e6d9320f632ab916f73e_img.jpg) + +``` + +sequenceDiagram + participant Consumer as Data or Analytics Consumer + participant NWDAF + participant DCCF + participant MFAF + participant ADRF + + Consumer->>DCCF: 1a. Ndccf_DataManagement_Subscribe + Consumer->>NWDAF: 1b. Nnwdaf_DataManagement_Subscribe + + Note over NWDAF: 2b. NWDAF Determines Data +and/or Analytics is to be +stored in ADRF + Note over DCCF: 2a. DCCF Determines Data +and/or Analytics is to be +stored in ADRF + + DCCF->>ADRF: 3. Nadrf_DataManagement_StorageSubscriptionRequest + + Note over ADRF: 4. ADRF Determines Data and/or +Analytics are already stored or +being stored + + ADRF->>DCCF: 5. Nadrf_DataManagement_StorageSubscriptionRequest Response + + ADRF->>DCCF: 6a. Ndccf_DataManagement_Subscribe + ADRF->>NWDAF: 6b. Nnwdaf_DataManagement_Subscribe + + DCCF->>ADRF: 7a. Ndccf_DataManagement_Subscribe Response + NWDAF->>ADRF: 7b. Nnwdaf_DataManagement_Subscribe Response + + rect rgb(255, 255, 255) + Note over Consumer, ADRF: 8. Notifications Stored in ADRF + end + + Note over NWDAF: 9a. NWDAF Determines Data no +longer is to be stored in ADRF + Note over DCCF: 9b. DCCF Determines Data is no +longer to be stored in ADRF + + DCCF->>ADRF: 10. Nadrf_DataManagement_StorageSubscriptionRemoval request + ADRF->>DCCF: 11. Nadrf_DataManagement_StorageSubscriptionRemoval Response + + ADRF->>DCCF: 12a. Ndccf_DataManagement_Unsubscribe + ADRF->>NWDAF: 12b. Nnwdaf_DataManagement_Unsubscribe + + DCCF->>ADRF: 13a. Ndccf_DataManagement_Unsubscribe Response + NWDAF->>ADRF: 13b. Nnwdaf_DataManagement_Unsubscribe Response + +``` + +Sequence diagram illustrating the Historical Data and Analytics storage/deletion procedure. Lifelines: Data or Analytics Consumer, NWDAF, DCCF, MFAF, ADRF. The process involves subscription, determination of storage, request to ADRF, response, and subsequent notification handling. + +**Figure 5.9.3-1: Historical Data and Analytics storage/deletion procedure** + +- 1-2. Based on provisioning or based on reception of a DataManagement subscription request (e.g. see clause 5.5.3.1), the NF service consumer (e.g. DCCF or NWDAF) determines that notifications are to be stored in the ADRF. +3. The NF service consumer invokes Nadrf\_DataManagement\_StorageSubscriptionRequest service operation by sending an HTTP POST request in clause 4.2.2.3 of 3GPP TS 29.575 [16]. +4. The ADRF may, based on implementation, determines whether the same data or analytics is already stored or being stored based on the information sent in step 3 by the consumer. +5. If the request is successfully processed and accepted, the ADRF sends Nadrf\_DataManagement\_StorageSubscriptionRequest Response message to the consumer with HTTP "200 OK" status code including a transaction reference identifier. If the data and/or analytics is already stored or being stored in the ADRF, the ADRF sends Nadrf\_DataManagement\_StorageSubscriptionRequest Response message to the consumer indicating that data or analytics is stored. +- 6a. ADRF invokes Ndccf\_DataManagement\_Subscribe service operation to subscribe to the DCCF to receive notifications by sending an HTTP POST request message targeting the resource "DCCF Analytics" + +Subscriptions", the HTTP POST message shall include notification endpoint address and a notification correlation ID as defined in clause 5.1.6.2.2 of 3GPP TS 29.574 [15]. + +- 6b. ADRF invokes Nnwdaf\_DataManagement\_Subscribe service operation to subscribe to the NWDAF to receive notifications by sending an HTTP POST request message targeting the resource "NWDAF Data Management Subscriptions", the HTTP POST message shall include notification endpoint address and a notification correlation ID as defined in clause 4.4.2.2 of 3GPP TS 29.520 [5]. +- 7a If the Subscription is successfully processed and accepted, the DCCF sends Ndccf\_DataManagement\_Subscribe Response message to the consumer with HTTP "201 Created" status code with the message body containing a representation of the created subscription. +- 7b If the Subscription is successfully processed and accepted, the NWDAF sends Nnwdaf\_DataManagement\_Subscribe Response message to the consumer with HTTP "201 Created" status code with the message body containing a representation of the created subscription. +8. The NF service consumer (e.g. DCCF, MFAF or NWDAF) sends Analytics or Data notifications containing the notification correlation ID provided by the ADRF to ADRF notification endpoint address when the historical analytics data are available. + +If the NWDAF is the service consumer in step 7, the NWDAF invokes Nnwdaf\_DataManagement\_Notify service operation as defined in clause 4.4.2.4 of 3GPP TS 29.520 [5]. The ADRF stores the notifications and responses to the Nnwdaf\_DataManagement\_Notify service operation with HTTP "204 No Content" status code. + +If the DCCF is used for data collection in step 7, the DCCF invokes Ndccf\_DataManagement\_Notify service operation as defined in clause 4.2.2.4 of 3GPP TS 29.574 [15]. The ADRF stores the notifications and responses to the Ndccf\_DataManagement\_Notify service operation with HTTP "204 No Content" status code. + +If the Messaging Framework is used for data collection in step 7, the procedure defined in clause 5.5.3.2 is applicable. + +9. The NF service consumer determines that notifications no longer need to be stored in the ADRF. +10. In order to request the ADRF to delete the specified data or analytics subscription, the NF service consumer shall invoke the Nadrf\_DataManagement\_StorageSubscriptionRemoval service operation by sending an HTTP POST request as described in clause 4.2.2.4 of 3GPP TS 29.575 [16], including the transaction reference identifier. +11. If the deletion is successfully processed, the ADRF sends Nadrf\_DataManagement\_StorageSubscriptionRemoval Response message with HTTP "204 No Content" status code to the consumer. +- 12a. ADRF invokes Ndccf\_DataManagement\_Unsubscribe service operation to subscribe to the DCCF to receive notifications by sending an HTTP DELETE request message targeting the resource "Individual DCCF Analytics Subscription", the HTTP URI shall include identifier of the existing analytics subscription that is to be deleted as defined in clause 4.2.2.3.2 of 3GPP TS 29.574 [15]. +- 12b. ADRF invokes Nnwdaf\_DataManagement\_Unsubscribe service operation to subscribe to the NWDAF to receive notifications by sending an HTTP DELETE request message targeting the resource "Individual NWDAF Data Management Subscription", the HTTP DELETE URI shall include identifier of the existing analytics subscription that is to be deleted as defined in clause 4.4.2.3.2 of 3GPP TS 29.520 [5]. +- 13a If the removal of the corresponding subscription is successfully processed and accepted, the DCCF sends Ndccf\_DataManagement\_Unsubscribe Response message to the consumer with HTTP "204 No Content" status code. +- 13b If the removal of the corresponding subscription is successfully processed and accepted, the NWDAF sends Nnwdaf\_DataManagement\_Unsubscribe Response message to the consumer with HTTP "204 No Content" status code. + +## 5.10 Federated Learning among Multiple NWDAFs + +### 5.10.1 General + +The NWDAF containing MTLF can leverage Federated Learning (FL) technique to train an ML model. To apply FL technique for ML model training, there is no need for input data transfer (e.g. centralized into one NWDAF) but only need for cooperation among multiple NWDAFs (MTLF) distributed in different areas, i.e. sharing of ML model(s) and of the learning results among multiple NWDAFs (MTLF). + +The NWDAF containing MTLF determines to train an ML model either based on local configuration or when it receives the request from NWDAF containing AnLF as described in clause 5.3 of 3GPP TS 23.288 [17]. If the NWDAF containing MTLF can act as an FL server for the ML model training, then FL procedure is initiated by the NWDAF containing MTLF as FL server NWDAF directly, otherwise, the NWDAF containing MTLF should discover an FL server NWDAF as described in clause 5.3.2.2 of 3GPP TS 29.510 [26] and request the FL server NWDAF to provide the trained ML model as described in clause 5.10.2.1. + +### 5.10.2 Procedures related to Federated Learning + +#### 5.10.2.1 General Procedure for Federated Learning among Multiple NWDAF Instances + +This procedure is used by the NWDAF containing MTLF (FL Server NWDAF) to trigger FL among multiple NWDAF instances, by the multiple NWDAF containing MTLF (the FL Server NWDAF and FL Client NWDAF(s)) to execute Federated Learning in FL execution phase. + +![Sequence diagram showing the general procedure for Federated Learning (FL) among Multiple NWDAF. The diagram involves four lifelines: Consumer, FL Server NWDAF, FL Client NWDAF(s), and NF (data provider). The process starts with a subscription request from the Consumer to the FL Server NWDAF. The FL Server NWDAF then selects FL Client NWDAF(s) and initiates a training subscription with them. The FL Client NWDAF(s) subscribe to events from the NF and notify the FL Server NWDAF. The FL Server NWDAF performs model aggregation and notifies the Consumer. A repeat loop involves the Consumer resubscribing, the FL Server NWDAF repeating the training subscription, and the FL Client NWDAF(s) updating their local models. Finally, the FL Client NWDAF(s) unsubscribe from the NF, and the Consumer unsubscribes from the FL Server NWDAF.](a5404b7275b06497eecf9b5883604753_img.jpg) + +``` + +sequenceDiagram + participant Consumer + participant FL Server NWDAF + participant FL Client NWDAF(s) + participant NF as NF (data provider) + + Note right of FL Server NWDAF: 0e. FL Client NWDAF(s) selection as described in clause 5.10.2.2 + + Note right of FL Server NWDAF: Federated Learning Training + + Consumer->>FL Server NWDAF: 0a. Nnwdaf_MLModelProvision_Subscribe request + FL Server NWDAF-->>Consumer: 0b. Nnwdaf_MLModelProvision_Subscribe response + + FL Server NWDAF->>FL Client NWDAF(s): 1a. Nnwdaf_MLModelTraining_Subscribe request + FL Client NWDAF(s)-->>FL Server NWDAF: 1b. Nnwdaf_MLModelTraining_Subscribe response + + FL Client NWDAF(s)->>NF: 2a. Nnf_EventExposure_Subscribe request + NF-->>FL Client NWDAF(s): 2b. Nnf_EventExposure_Subscribe response + + FL Client NWDAF(s)->>NF: 3a. Nnf_EventExposure_Notify request + NF-->>FL Client NWDAF(s): 3b. Nnf_EventExposure_Notify response + + FL Client NWDAF(s)->>FL Server NWDAF: 4a. Nnwdaf_MLModelTraining_Notify request + FL Server NWDAF-->>FL Client NWDAF(s): 4b. Nnwdaf_MLModelTraining_Notify response + + Note right of FL Server NWDAF: 4c. Same as steps 1a-1b + + Note right of FL Server NWDAF: 5. Model aggregation + + FL Server NWDAF->>Consumer: 6aa. Nnwdaf_MLModelProvision_Notify request + Consumer-->>FL Server NWDAF: 6ab. Nnwdaf_MLModelProvision_Notify response + + Note right of Consumer: 6ba. Same as steps 0a-0b + Note right of Consumer: 6bb. Same as steps 11a-11b + + Note right of FL Server NWDAF: 6c. Update or terminate the FL training process + + Note right of FL Server NWDAF: 7. Same as steps 1a-1b + + Note right of FL Client NWDAF(s): 8. Update the local model based on the aggregated model information + + Note right of FL Client NWDAF(s): Repeat + + FL Client NWDAF(s)->>NF: 9a. Nnf_EventExposure_Unsubscribe request + NF-->>FL Client NWDAF(s): 9b. Nnf_EventExposure_Unsubscribe response + + Note right of Consumer: 10. Same as steps 6aa-6ab + + Consumer->>FL Server NWDAF: 11a. Nnwdaf_MLModelProvision_Unsubscribe request + FL Server NWDAF-->>Consumer: 11b. Nnwdaf_MLModelProvision_Unsubscribe response + +``` + +Sequence diagram showing the general procedure for Federated Learning (FL) among Multiple NWDAF. The diagram involves four lifelines: Consumer, FL Server NWDAF, FL Client NWDAF(s), and NF (data provider). The process starts with a subscription request from the Consumer to the FL Server NWDAF. The FL Server NWDAF then selects FL Client NWDAF(s) and initiates a training subscription with them. The FL Client NWDAF(s) subscribe to events from the NF and notify the FL Server NWDAF. The FL Server NWDAF performs model aggregation and notifies the Consumer. A repeat loop involves the Consumer resubscribing, the FL Server NWDAF repeating the training subscription, and the FL Client NWDAF(s) updating their local models. Finally, the FL Client NWDAF(s) unsubscribe from the NF, and the Consumer unsubscribes from the FL Server NWDAF. + +**Figure 5.10.2.1-1: General procedure for FL among Multiple NWDAF** + +0a-0b. To send a request for ML model analytics events subscription to the NWDAF containing MTLF (the FL Server NWDAF), the NWDAF service consumer (NWDAF containing AnLF or NWDAF containing MTLF) invokes the Nnwdaf\_MLModelProvision\_Subscribe service operation by sending an HTTP POST request targeting the resource "NWDAF ML Model Provision Subscriptions". + +The FL Server NWDAF responds to the Nnwdaf\_MLModelProvision\_Subscribe service operation. Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the FL Server NWDAF responds + +to the NWDAF service consumer with "201 Created", and the URI of the created subscription is included in the Location header field. Details are described in clause 4.5.2.2 of 3GPP TS 29.520 [5]. + +NOTE 1: The ML model accuracy threshold can be used to indicate the target ML Model Accuracy of the training process, and the FL Server NWDAF may stop the training process when the ML model accuracy threshold is achieved during the training process. + +If the consumer (i.e. the NWDAF containing AnLF or NWDAF containing MTLF) provides the Time when the ML model is needed, the FL Server NWDAF can take this information into account to decide the maximum response time for its FL Client NWDAFs. + +0e. The FL Server NWDAF selects NWDAF(s) containing MTLF (FL Client NWDAF(s)) as described in clause 5.10.2.2. + +1a-1b. To request the selected NWDAF containing MTLF (the FL Client NWDAF) to perform the local model training, the FL Server NWDAF may invoke Nnwdaf\_MLModelTraining\_Subscribe service operation by sending an HTTP POST request targeting the resource "NWDAF ML Model Training Subscriptions". The FL Client NWDAF responses to the Nnwdaf\_MLModelTraining\_Subscribe service operation with an HTTP "201 Created" status code to the FL Server NWDAF, as defined in clause 4.6.2.2 of 3GPP TS 29.520 [5]. + +2a-2b. To subscribe to notification (or to modify subscriptions to notifications) of data events from the data source NF, each FL Client NWDAF may invoke the Nnf\_EventExposure\_Subscribe service operation by sending an HTTP POST (or PUT, for modification) request targeting the resource representing event exposure subscriptions of that NF. + +The data source NF responds to the Nnf\_EventExposure\_Subscribe service operation. Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NF responds to the FL Client NWDAF with "201 Created", and the URI of the created subscription is included in the Location header field. + +3a-3b. If the data source NF observes the subscribed event(s), the NF invokes the Nnf\_EventExposure\_Notify service operation to report the event(s) by sending an HTTP POST request. + +On success, the FL Client NWDAF sends an HTTP "204 No Content" response to the NF. + +4. During FL training process, each FL Client NWDAF further trains the retrieved ML model from the FL Server NWDAF based on its own/collected data, and reports interim local ML model information to the FL Server NWDAF before the maximum response time elapses. Each FL Client NWDAF also computes local model metric and reports it to the FL Server NWDAF. The ML model information are exchanged between the FL Client NWDAF(s) and the FL Server NWDAF during the FL training process. + +4a-4b. To report the ML model training information, the FL Client NWDAF may invoke Nnwdaf\_MLModelTraining\_Notify service operation as defined in clause 4.6.2.4 of 3GPP TS 29.520 [5]. The FL Server NWDAF stores the notification and responds to the Nnwdaf\_MLModelTraining\_Notify service operation with an HTTP "204 No Content" status code to the FL Client NWDAF. + +4c. [Optional] If FL Server NWDAF receives notification that the FL Client NWDAF is not able to complete the training within the maximum response time, the FL Server NWDAF may send to the FL Client NWDAF an new maximum response time by invoking Nnwdaf\_MLModelTraining\_Subscribe, before which the FL Client NWDAF shall report the interim local ML model information to the FL Server NWDAF. Otherwise, the FL Server NWDAF may indicate FL Client NWDAF to skip reporting for this iteration. + +5. The FL Server NWDAF aggregates all the local ML model information retrieved at step 4, to update the global ML model. The FL Server NWDAF may also compute the global model metric. + +- If the FL Server NWDAF provides the maximum response time for the FL Client NWDAFs to provide the interim local ML model information in step 1 or the new maximum response time in step 4, the FL Server NWDAF decides either to wait for the FL Client NWDAFs which have not yet provided their interim local ML model within the new maximum response time or to aggregate only the retrieved local ML model information instances to update global ML model. The FL Server NWDAF makes this decision, considering the notification from the FL Client NWDAF or, if the notification is not received, based on local configuration. + +6a. [Optional] Based on the NWDAF service consumer request, the FL Server NWDAF updates the global ML model metric to the NWDAF service consumer periodically or dynamically when some pre-determined status (e.g. ML model accuracy threshold) is achieved. + +6aa-6ab. To report the ML model training information, the FL Server NWDAF invokes Nnwdaf\_MLModelProvision\_Notify service operation as defined in clause 4.5.2.4 of 3GPP TS 29.520 [5]. The NWDAF service consumer stores the notification and responds to the Nnwdaf\_MLModelProvision\_Notify service operation with an HTTP "204 No Content" status code to the FL Server NWDAF. + +6b. [Optional] The NWDAF service consumer decides whether the current model can fulfil the requirement. The NWDAF service consumer modifies subscription (stops or continues the training process) according to the NWDAF service consumer decision. + +6ba. To modify the existing subscription, the NWDAF service consumer invokes Nnwdaf\_MLModelProvision\_Subscribe service operation by sending an HTTP PUT request with Resource URI of the resource "Individual NWDAF ML Model Provision Subscription". The FL Server NWDAF responds to the NWDAF service consumer with an HTTP "200 OK" or "204 No Content" status code, as defined in clause 4.5.2.2.3 of 3GPP TS 29.520 [5]. + +6bb. To unsubscribe the ML model, the NWDAF service consumer invokes Nnwdaf\_MLModelProvision\_Unsubscribe service operation by sending an HTTP DELETE request which targets the resource "Individual NWDAF ML Model Provision Subscription", to the FL Server NWDAF, as defined in clause 4.5.2.3 of 3GPP TS 29.520 [5]. If the request is accepted, the FL Server NWDAF deletes the subscription and responds to the NWDAF service consumer with an HTTP "204 No Content" message. + +6c. [Optional] According to the request from the NWDAF service consumer, the FL Server NWDAF updates or terminates the current FL training process. If it terminates the current FL training process, steps 7 and 8 are skipped. + +7. If the FL procedure continues, the FL Server NWDAF sends the aggregated ML model information to each FL Client NWDAF for next round model training. + +To modify the existing subscription, the FL Server NWDAF invokes Nnwdaf\_MLModelTraining\_Subscribe service operation by sending an HTTP PUT request or an HTTP PATCH request with Resource URI of the resource "Individual NWDAF ML Model Training Subscription". The FL Client NWDAF responds to the FL Server NWDAF an HTTP "200 OK" or "204 No Content" status code, as defined in clauses 4.6.2.2.3 and 4.6.2.2.4 of 3GPP TS 29.520 [5]. + +8. Each FL Client NWDAF updates its own ML model based on the aggregated ML model information distributed by the FL Server NWDAF at step 7. + +NOTE 2: The steps 4-8 should be repeated until the training termination condition (e.g. maximum number of iterations, or the result of loss function is lower than a threshold) is reached. + +9a-9b. To unsubscribe to the notifications of data events from the data source NF, the FL Client NWDAF invokes the Nnf\_EventExposure\_Unsubscribe service operation by sending an HTTP DELETE request targeting the resource that represents the previously created individual event exposure subscription. + +The data source NF responds to the Nnf\_EventExposure\_Unsubscribe service operation. If the subscription deletion is accepted, the NF responds with "204 No Content". + +10. If the FL Server NWDAF determines that the subscribed ML model information is available, the FL Server NWDAF may invoke the Nnwdaf\_MLModelProvision\_Notify service operation or the Nnwdaf\_MLModelTraining\_Notify service operation to report the ML model information by sending an HTTP POST request to the NWDAF service consumer identified by the notification URI received during the creation/modification of the subscriptions. The NWDAF service consumer responds to the FL Server NWDAF with an HTTP "204 No Content" message. + +11a-11b. To unsubscribe from the notification(s) of the ML model information, the NWDAF service consumer invokes the Nnwdaf\_MLModelProvision\_Unsubscribe service operation by sending an HTTP DELETE request, which targets the resource "Individual NWDAF ML Model Provision Subscription", to the FL Server NWDAF, as defined in clause 4.5.2.3 of 3GPP TS 29.520 [5]. + +If the request is accepted, the FL Server NWDAF deletes the subscription and responds to the NWDAF service consumer with an HTTP "204 No Content" message. + +#### 5.10.2.2 Preparation Procedure for Federated Learning + +This procedure is used by the NWDAF containing MTTF (as FL Server NWDAF or FL Client NWDAF(s)) to register into NRF, discover the FL Server NWDAF and select FL Client NWDAF(s) for Federated Learning (FL). + +![Sequence diagram illustrating the Preparation procedure for Federated Learning. The diagram shows three lifelines: FL Server NWDAF, FL Client NWDAF(s), and NRF. Step 1: FL Server NWDAF and FL Client NWDAF(s) discover each other via NRF. Step 2: FL Server NWDAF sends a 'Nnwdaf_MLModelTraining_Subscribe' request to FL Client NWDAF(s). FL Client NWDAF(s) then decides whether to join or not (Step 2b). FL Server NWDAF receives a response (Step 2c). Step 3: FL Server NWDAF selects the FL Client NWDAF(s).](8edfc370769207831f060f44d2281084_img.jpg) + +``` + +sequenceDiagram + participant FL Server NWDAF + participant FL Client NWDAF(s) + participant NRF + Note over FL Server NWDAF, FL Client NWDAF(s), NRF: 1. Discover FL Server and Client NWDAFs via NRF + FL Server NWDAF->>FL Client NWDAF(s): 2a. Nnwdaf_MLModelTraining_Subscribe request + Note right of FL Client NWDAF(s): 2b. Decide to join or not + FL Client NWDAF(s)->>FL Server NWDAF: 2c. Nnwdaf_MLModelTraining_Subscribe response + Note left of FL Server NWDAF: 3. Select FL Client NWDAF(s) + +``` + +Sequence diagram illustrating the Preparation procedure for Federated Learning. The diagram shows three lifelines: FL Server NWDAF, FL Client NWDAF(s), and NRF. Step 1: FL Server NWDAF and FL Client NWDAF(s) discover each other via NRF. Step 2: FL Server NWDAF sends a 'Nnwdaf\_MLModelTraining\_Subscribe' request to FL Client NWDAF(s). FL Client NWDAF(s) then decides whether to join or not (Step 2b). FL Server NWDAF receives a response (Step 2c). Step 3: FL Server NWDAF selects the FL Client NWDAF(s). + +**Figure 5.10.2.2-1: Preparation procedure for Federated Learning** + +The NWDAF containing MTTF as FL Server NWDAF or FL Client NWDAF(s) registered to NRF its NF profiles. Details are described in clause 5.2.2.2 of 3GPP TS 29.510 [26]. + +1. The FL Server NWDAF and FL Client NWDAF(s) are discovered via NRF. Details are described in clause 5.3.2.2 of 3GPP TS 29.510 [26]. +2. The Nnwdaf\_MLModelTraining service may be used for the preparation information exchange between the FL Server NWDAF and the FL Client NWDAF(s). + - 2a. The FL Server NWDAF invokes Nnwdaf\_MLModelTraining\_Subscribe service operation by sending an HTTP POST request targeting the resource "NWDAF ML Model Training Subscriptions", The request shall include the "mLPreFlag" attribute and set to "true". Details are described in clause 4.6.2.2 of 3GPP TS 29.520 [5]. + - 2b. The FL Client NWDAF(s) checks if it meets the ML model training requirement as described in clause 5.5.6.2.2 of 3GPP TS 29.520 [5] and/or can successfully download the model if the model information is provided in the request, and decides whether to join the FL process based on operator policy (e.g. pre-configured list of ML models) and/or implementation. + - 2c. The FL Client NWDAF responds or notifies to the Nnwdaf\_MLModelTraining\_Subscribe request to indicate its decision. Upon receipt of the HTTP POST request, if the preparation request is accepted, the FL Client NWDAF responds to the FL Server NWDAF with "201 Created", otherwise, responds with "403 Forbidden" as described in 3GPP TS 29.520 [5]. + +NOTE: Step 2 can be skipped if the FL Server NWDAF can decide that the FL Client NWDAF(s) supports the FL procedure to be performed, e.g. based on information acquired from previous FL procedures or from the NRF, or based on local configuration. + +3. The FL Server NWDAF determines the final list of FL Client NWDAF(s) to be involved in the FL procedures based on the information received in step 1 and other information received in step 2 (if available). + +#### 5.10.2.3 Procedure for Maintenance of Federated Learning Process + +This procedure is used by the NWDAF containing MTTF (the FL Server NWDAF) to maintain a FL process in FL execution phase, including: the FL Server NWDAF triggers reselection, addition, or removal of FL Client NWDAF(s), discovery of new FL Client NWDAF(s) via NRF, and FL Client NWDAF(s) joins or leaves FL process dynamically. + +In FL execution phase, the FL Server NWDAF monitors the status changes of FL Client NWDAF(s), and may reselect the FL Client NWDAF(s) based on the received information of status changes. + +NOTE: The FL Server NWDAF checks if there is a need to carry on the FL execution phase and then reselects FL members for the next iteration if needed. + +![Sequence diagram illustrating the procedure for maintenance of Federated Learning Process in FL Execution Phase. The diagram shows interactions between FL Client NWDAF(s), FL Server NWDAF, NRF, and New FL Client NWDAF(s). The process includes getting updated status, handling notify requests, dynamically getting new client information, subscribing for analytics, determining re-selection, and performing reselection if needed.](57134800ac3a97b6212b27b93aa196ac_img.jpg) + +``` + +sequenceDiagram + participant FL Client NWDAF(s) + participant FL Server NWDAF + participant NRF + participant New FL Client NWDAF(s) + + Note right of FL Server NWDAF: 1. Get updated status of the current FL Client NWDAF(s) via NRF + FL Server NWDAF-->>NRF: 1. Get updated status of the current FL Client NWDAF(s) via NRF + Note left of FL Client NWDAF(s): 2a. Nnwdaf_MLModelTraining_Notify request + FL Client NWDAF(s)-->>FL Server NWDAF: 2a. Nnwdaf_MLModelTraining_Notify request + Note right of FL Server NWDAF: 2b. Nnwdaf_MLModelTraining_Notify response + FL Server NWDAF-->>FL Client NWDAF(s): 2b. Nnwdaf_MLModelTraining_Notify response + Note right of FL Server NWDAF: 3. FL Server NWDAF may get the information of the new FL Client NWDAF(s) dynamically via NRF + FL Server NWDAF-->>NRF: 3. FL Server NWDAF may get the information of the new FL Client NWDAF(s) dynamically via NRF + Note right of FL Server NWDAF: 4a. FL Server NWDAF subscribes to other NWDAF for analytics of FL Client NWDAF(s) + FL Server NWDAF-->>NRF: 4a. FL Server NWDAF subscribes to other NWDAF for analytics of FL Client NWDAF(s) + Note right of FL Server NWDAF: 4b. FL Server NWDAF subscribes to FL Client NWDAF(s) for analytics of FL Client NWDAF(s) + FL Server NWDAF-->>FL Client NWDAF(s): 4b. FL Server NWDAF subscribes to FL Client NWDAF(s) for analytics of FL Client NWDAF(s) + Note left of FL Client NWDAF(s): 5a. Nnwdaf_MLModelTraining_Notify request + FL Client NWDAF(s)-->>FL Server NWDAF: 5a. Nnwdaf_MLModelTraining_Notify request + Note right of FL Server NWDAF: 5b. Nnwdaf_MLModelTraining_Notify response + FL Server NWDAF-->>FL Client NWDAF(s): 5b. Nnwdaf_MLModelTraining_Notify response + Note right of FL Server NWDAF: 6. Determine whether re-selection is needed + FL Server NWDAF-->>FL Server NWDAF: 6. Determine whether re-selection is needed + Note right of FL Server NWDAF: 7. FL Client NWDAF(s) reselection + FL Server NWDAF-->>FL Client NWDAF(s): 7. FL Client NWDAF(s) reselection + Note left of FL Client NWDAF(s): 8a. Nnwdaf_MLModelTraining_Unsubscribe request + FL Client NWDAF(s)-->>FL Server NWDAF: 8a. Nnwdaf_MLModelTraining_Unsubscribe request + Note right of FL Server NWDAF: 8b. Nnwdaf_MLModelTraining_Unsubscribe response + FL Server NWDAF-->>FL Client NWDAF(s): 8b. Nnwdaf_MLModelTraining_Unsubscribe response + + Note right of New FL Client NWDAF(s): During FL process + +``` + +Sequence diagram illustrating the procedure for maintenance of Federated Learning Process in FL Execution Phase. The diagram shows interactions between FL Client NWDAF(s), FL Server NWDAF, NRF, and New FL Client NWDAF(s). The process includes getting updated status, handling notify requests, dynamically getting new client information, subscribing for analytics, determining re-selection, and performing reselection if needed. + +**Figure 5.10.2.3-1: Procedure for Maintenance of Federated Learning Process in FL Execution Phase** + +The FL Server NWDAF registered to NRF by invoking the Nnrf\_NFManagement\_NFRegister\_request service operation about the FL process, which includes Analytics ID. + +1. The FL Server NWDAF may get the updated status of the current FL Client NWDAF(s) via NRF by using the Nnrf\_NFManagement service in the FL execution phase. Details are described in clauses 5.2.2.5 and 5.2.2.6 of 3GPP TS 29.510 [26]. +2. The current FL Client NWDAF(s) may inform the FL Server NWDAF to leave the FL process. The FL Client NWDAF(s) invokes Nnwdaf\_MLModelTraining\_Notify service operation by sending an HTTP POST request to the FL Server NWDAF identified by the notification URI received during the creation/modification of the subscriptions. The request shall include "termTrainReq" attribute and with the "termTrainCause" attribute in data type "TermMLModelTrainInfo" being provided. Details are described in clause 4.6.2.4 of 3GPP TS 29.520 [5]. The FL Server NWDAF responds to the Nnwdaf\_MLModelTraining\_Notify service operation with an HTTP "204 No Content" status code to the FL Client NWDAF(s). +3. The FL Server NWDAF may get the information of the new FL Client NWDAF(s) dynamically via NRF. Details are described in clauses 5.2.2.5 and 5.2.2.6 of 3GPP TS 29.510 [26]. +4. The FL Server NWDAF may subscribe to other NWDAF (Assist NWDAF) or the FL Client NWDAF(s) for analytics of the FL Client NWDAF(s), as defined in clauses 4.2.2.2 and 4.2.2.4 of 3GPP TS 29.520 [5]. +5. The FL Client NWDAF(s) may send Status report of FL training and Global ML Model Accuracy Information. The FL Client NWDAF(s) invokes Nnwdaf\_MLModelTraining\_Notify service operation to the FL Server + +NWDAF. The FL Server NWDAF stores the notification and responds to the Nnwdaf\_MLModelTraining\_Notify service operation with an HTTP "204 No Content" status code to the FL Client NWDAF(s). Details are described in clause 4.6.2.4 of 3GPP TS 29.520 [5]. + +6. The FL Server NWDAF checks the FL Client NWDAF(s) status based on the received information, determines whether reselection of the FL Client NWDAF(s) for the next round(s) of FL is needed. The checking and determination are made according to the updated status of the FL Client NWDAF(s) received in steps 1-5. + 7. If re-selection is needed as determined in step 6 and if step 3 is not performed, the FL Server NWDAF may discover new candidate FL Client NWDAF(s) via NRF by using the Nnrf\_NFDiscovery services as described in clause 5.3.2.2 of 3GPP TS 29.510 [26]. The FL Server NWDAF reselects the FL Client NWDAF(s) from the current FL Client NWDAF(s) and the new candidate FL Client NWDAF(s). + 8. The FL Server NWDAF sends termination request to the FL Client NWDAF(s) which will be removed from the FL process, and optionally indicating the reason. The FL Client NWDAF(s) terminates FL operations when receives a termination request from the FL Server NWDAF and may perform further action to be qualified in participation of FL training in the next cycles. +- 8a-8b. To send the termination request, the FL Server NWDAF may invoke the Nnwdaf\_MLModelTraining\_Unsubscribe service operation by sending an HTTP DELETE request, which targets the resource "Individual NWDAF ML Model Training Subscription", to the FL Client NWDAF(s). If the request is accepted, the FL Client NWDAF deletes the subscription and responds to the FL Server NWDAF service consumer with an HTTP "204 No Content" message. Details are described in clause 4.6.2.3 of 3GPP TS 29.520 [5]. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|--------------|-----------|------|-----|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2021-04 | CT3#115e | | | | | TS skeleton for TS 29.552. | 0.0.0 | +| 2021-04 | CT3#115e | | | | | Inclusion of documents agreed in CT3#115e:
C3-212120, C3-212389 | 0.1.0 | +| 2021-05 | CT3#116e | | | | | Inclusion of document agreed in CT3#116e:
C3-213373 | 0.2.0 | +| 2021-08 | CT3#117e | | | | | Inclusion of document agreed in CT3#117e:
C3-214475, C3-214476, C3-214162 | 0.3.0 | +| 2021-10 | CT3#118e | | | | | Inclusion of document agreed in CT3#118e:
C3-215481, C3-215482, C3-215220, C3-215221. | 0.4.0 | +| 2021-11 | CT3#119e | | | | | Inclusion of document agreed in CT3#119e:
C3-216463, C3-216428, C3-216241, C3-216242, C3-216243, C3-216244, C3-216464 | 0.5.0 | +| 2022-01 | CT3#119bis-e | | | | | Inclusion of document agreed in CT3#119bis-e:
C3-220495, C3-220356, C3-220090, C3-220091, C3-220336, C3-220332, C3-220333, C3-220357, C3-220358, C3-220338. | 0.6.0 | +| 2022-02 | CT3#120e | | | | | Inclusion of document agreed in CT3#120e:
C3-221470, C3-221477, C3-221481, C3-221622, C3-221623, C3-221624, C3-221625, C3-221591, C3-221285, C3-221680, C3-221296, C3-221683, C3-221685. | 0.7.0 | +| 2022-03 | CT#95e | CP-220158 | | | | Presentation to TSG CT for approval | 1.0.0 | +| 2022-03 | CT#95e | CP-220158 | | | | Approved by TSG CT | 17.0.0 | +| 2022-06 | CT#96 | CP-221132 | 0001 | 1 | F | Adding "Prepared analytics subscription transfer" signalling flows. | 17.1.0 | +| 2022-06 | CT#96 | CP-221131 | 0002 | 1 | F | Correction Nnwdaf_MLModelProvision Service notification | 17.1.0 | +| 2022-06 | CT#96 | CP-221132 | 0003 | 1 | B | Update procedure for Analytics Exposure via DCCF | 17.1.0 | +| 2022-06 | CT#96 | CP-221130 | 0004 | 1 | B | Update Data Collection Reference Architecture | 17.1.0 | +| 2022-06 | CT#96 | CP-221130 | 0005 | 1 | B | Update Analytics Exposure Reference Architecture | 17.1.0 | +| 2022-06 | CT#96 | CP-221130 | 0006 | 1 | B | Resolve editor's note in Analytics Exposure via DCCF | 17.1.0 | +| 2022-06 | CT#96 | CP-221130 | 0007 | 1 | B | Resolve editor's note in Analytics Exposure via DCCF and MFAF | 17.1.0 | +| 2022-06 | CT#96 | CP-221132 | 0010 | 1 | F | Update Analytics Exposure via DCCF | 17.1.0 | +| 2022-06 | CT#96 | CP-221132 | 0011 | 1 | F | Update Analytics Exposure via DCCF and MFAF | 17.1.0 | +| 2022-06 | CT#96 | CP-221133 | 0012 | 1 | F | Update Analytics context transfer initiated by target NWDAF | 17.1.0 | +| 2022-06 | CT#96 | CP-221133 | 0013 | 1 | F | Update Analytics aggregation with provisioning of Area of Interest | 17.1.0 | +| 2022-06 | CT#96 | CP-221132 | 0014 | 1 | F | Update Data Collection via DCCF | 17.1.0 | +| 2022-06 | CT#96 | CP-221132 | 0015 | 1 | F | Update Data Collection via Messaging Framework | 17.1.0 | +| 2022-06 | CT#96 | CP-221132 | 0016 | 1 | B | SMCCE analytics supports Nnwdaf_EventsSubscription_Subscribe service operation | 17.1.0 | +| 2022-06 | CT#96 | CP-221130 | 0017 | | B | Remove the redundant description for discovery and selection of NWDAF containing AnLF | 17.1.0 | +| 2022-06 | CT#96 | CP-221131 | 0018 | 1 | B | Introducing the Analytics Data Repository procedures | 17.1.0 | +| 2022-06 | CT#96 | CP-221136 | 0020 | 1 | F | Update of transferring ML model during analytics transfer | 17.1.0 | +| 2022-06 | CT#96 | CP-221134 | 0021 | | B | Remove the ENs about when the DCCF sends the response to the consumer | 17.1.0 | +| 2022-06 | CT#96 | CP-221135 | 0022 | 1 | B | Update the Analytics context transfer and Analytics Subscription transfer | 17.1.0 | +| 2022-06 | CT#96 | CP-221135 | 0023 | 1 | F | Correction to Analytics context transfer initiated by target NWDAF | 17.1.0 | +| 2022-09 | CT#97e | CP-222103 | 0025 | 1 | F | Remove EN about using Nadrf_DataManagement_RetrievalRequest in DCCF procedures | 17.2.0 | +| 2022-09 | CT#97e | CP-222102 | 0026 | 1 | F | Add NSACF to the data source list of the NWDAF | 17.2.0 | +| 2022-09 | CT#97e | CP-222102 | 0027 | 1 | F | Support prepared analytics subscription transfer | 17.2.0 | +| 2022-09 | CT#97e | CP-222102 | 0030 | 1 | F | Update the content of Nadrf_DataManagement_RetrievalNotify | 17.2.0 | +| 2022-12 | CT#98e | CP-223173 | 0031 | 1 | F | User consent corrections in data collection procedures | 17.3.0 | +| 2022-12 | CT#98e | CP-223172 | 0037 | | F | Update historical data and analytics storage via Notifications | 17.3.0 | +| 2023-03 | CT#99 | CP-230146 | 0042 | 2 | F | Update for Analytics Exposure via DCCF procedure | 17.4.0 | +| 2023-03 | CT#99 | CP-230148 | 0043 | 1 | F | Support of user consent change for data collection procedures | 18.0.0 | +| 2023-06 | CT#100 | CP-231126 | 0045 | 4 | B | Procedures for Federated Learning among Multiple NWDAFs in 5GC | 18.1.0 | +| 2023-06 | CT#100 | CP-231124 | 0046 | 2 | B | Procedures related to NRF for Federated Learning | 18.1.0 | +| 2023-06 | CT#100 | CP-231124 | 0047 | 2 | B | Updates to ML Model Provisioning Procedures for FL and Model Sharing | 18.1.0 | +| 2023-06 | CT#100 | CP-231124 | 0049 | 2 | B | Update to Reference Architecture for Data Collection from MDAF | 18.1.0 | +| 2023-06 | CT#100 | CP-231124 | 0050 | 2 | B | Support Data Collection from MDAF/MDAS for Service Experience Analytics | 18.1.0 | + +| | | | | | | | | +|---------|---------|-----------|------|---|---|------------------------------------------------------------------------------------|--------| +| 2023-06 | CT#100 | CP-231124 | 0051 | 2 | B | Support Data Collection from MDAF for Redundant Transmission Experience Analytics | 18.1.0 | +| 2023-06 | CT#100 | CP-231137 | 0052 | 1 | F | Addition of Abbreviations | 18.1.0 | +| 2023-06 | CT#100 | CP-231124 | 0053 | | B | Enhancements on QoS Sustainability analytics with coarse granularity | 18.1.0 | +| 2023-06 | CT#100 | CP-231125 | 0055 | 1 | B | Support of PFD determination analytics | 18.1.0 | +| 2023-06 | CT#100 | CP-231137 | 0056 | 1 | B | Updates to Procedures for NWDAF Discovery and Selection | 18.1.0 | +| 2023-06 | CT#100 | CP-231137 | 0057 | 1 | B | Update NRF procedure for NWDAF discovery supporting ML model provisioning | 18.1.0 | +| 2023-06 | CT#100 | CP-231127 | 0058 | | B | Enhancements on service experience analytics | 18.1.0 | +| 2023-06 | CT#100 | CP-231159 | 0060 | 1 | A | Correcting the NF that validates the user consent | 18.1.0 | +| 2023-06 | CT#100 | CP-231128 | 0061 | 1 | B | Signalling flow Support of End-to-end data volume transfer time analytics | 18.1.0 | +| 2023-06 | CT#100 | CP-231126 | 0062 | 1 | B | Preparation and Maintenance Procedures for Federated Learning in 5GC | 18.1.0 | +| 2023-06 | CT#100 | CP-231125 | 0063 | 1 | F | Remove Detail Parameters in ML Model Provisioning Procedures | 18.1.0 | +| 2023-09 | CT3#101 | CP-232082 | 0064 | 1 | B | Adding GMLC to the possible data sources for analytics | 18.2.0 | +| 2023-09 | CT3#101 | CP-232095 | 0065 | | B | Adding UPF to the possible data sources for analytics | 18.2.0 | +| 2023-09 | CT3#101 | CP-232082 | 0066 | 1 | B | Update to the General Procedure for Federated Learning | 18.2.0 | +| 2023-09 | CT3#101 | CP-232082 | 0067 | 1 | B | Update to the Preparation Procedure for Federated Learning | 18.2.0 | +| 2023-09 | CT3#101 | CP-232081 | 0068 | | B | Enhancement of Redundant Transmission Experience analytics for NWDAF-assisted URSP | 18.2.0 | +| 2023-09 | CT3#101 | CP-232082 | 0069 | 1 | B | Procedures for PDU Session Traffic Analytics | 18.2.0 | +| 2023-12 | CT#102 | CP-233224 | 0070 | 1 | B | Analytics feedback information handing at the NWDAF | 18.3.0 | +| 2023-12 | CT#102 | CP-233249 | 0071 | 1 | B | Using UPF Exposure in UE communications procedure | 18.3.0 | +| 2023-12 | CT#102 | CP-233249 | 0072 | 1 | B | Using UPF Exposure in Dispersion analytics procedure | 18.3.0 | +| 2023-12 | CT#102 | CP-233225 | 0073 | 2 | B | Updates to PFD Determination Analytics | 18.3.0 | +| 2023-12 | CT#102 | CP-233225 | 0074 | 1 | B | Procedures for Relative Proximity Analytics | 18.3.0 | +| 2023-12 | CT#102 | CP-233225 | 0075 | 1 | B | Procedures for Movement Behaviour Analytics | 18.3.0 | +| 2023-12 | CT#102 | CP-233226 | 0076 | 2 | F | Update to Procedures for Federated Learning | 18.3.0 | +| 2023-12 | CT#102 | CP-233225 | 0077 | 2 | B | Update to ML Model Training Procedures | 18.3.0 | +| 2023-12 | CT#102 | CP-233249 | 0078 | 1 | B | Updates with UPF Exposure | 18.3.0 | +| 2023-12 | CT#102 | CP-233236 | 0079 | 1 | B | Updates to WLAN Performance Analytics | 18.3.0 | +| 2023-12 | CT#102 | CP-233226 | 0080 | 1 | B | Updates to Service Experience Analytics | 18.3.0 | +| 2023-12 | CT#102 | CP-233226 | 0081 | 1 | B | Updates to Analytics Data Collection from MDAF | 18.3.0 | +| 2023-12 | CT#102 | CP-233226 | 0082 | 1 | B | Data Collection in Roaming Case | 18.3.0 | +| 2023-12 | CT#102 | CP-233226 | 0083 | 1 | B | Analytics Exposure in Roaming Case | 18.3.0 | +| 2023-12 | CT#102 | CP-233246 | 0084 | 1 | F | Corrections to data collection from OAM procedures | 18.3.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29555/raw.md b/marked/Rel-18/29_series/29555/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..3fec7056ad4995f1abebba750a1478dd7b134852 --- /dev/null +++ b/marked/Rel-18/29_series/29555/raw.md @@ -0,0 +1,3030 @@ + + +# 3GPP TS 29.555 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; 5G Direct Discovery Name Management Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- ***Copyright Notification*** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Overview..... | 8 | +| 5 Services offered by the 5G DDNMF ..... | 9 | +| 5.1 Introduction ..... | 9 | +| 5.2 N5g-ddnmf_Discovery Service..... | 10 | +| 5.2.1 Service Description ..... | 10 | +| 5.2.2 Service Operations..... | 10 | +| 5.2.2.1 Introduction..... | 10 | +| 5.2.2.2 AnnounceAuthorize ..... | 10 | +| 5.2.2.2.1 General ..... | 10 | +| 5.2.2.2.2 Obtain the authorization to announce for a UE ..... | 10 | +| 5.2.2.3 AnnounceUpdate ..... | 11 | +| 5.2.2.3.1 General ..... | 11 | +| 5.2.2.3.2 Update the authorization for announcing for a UE ..... | 11 | +| 5.2.2.4 MonitorAuthorize ..... | 12 | +| 5.2.2.4.1 General ..... | 12 | +| 5.2.2.4.2 Obtain the authorization to monitor for a UE ..... | 12 | +| 5.2.2.5 MonitorUpdate..... | 13 | +| 5.2.2.5.1 General ..... | 13 | +| 5.2.2.5.2 Update the authorization for monitoring for a UE ..... | 13 | +| 5.2.2.6 MonitorUpdateResult..... | 13 | +| 5.2.2.6.1 General ..... | 13 | +| 5.2.2.6.2 Monitor Update Result Notification..... | 13 | +| 5.2.2.7 DiscoveryAuthorize ..... | 14 | +| 5.2.2.7.1 General ..... | 14 | +| 5.2.2.7.2 Obtain the authorization for a discoverer UE to operate Model B restricted discovery ..... | 14 | +| 5.2.2.8 MatchReport ..... | 15 | +| 5.2.2.8.1 General ..... | 15 | +| 5.2.2.8.2 Obtain the information about the indicated discovery code..... | 15 | +| 5.2.2.9 MatchInformation ..... | 15 | +| 5.2.2.9.1 General ..... | 15 | +| 5.2.2.9.2 Match Information Notification ..... | 16 | +| 6 API Definitions ..... | 16 | +| 6.1 N5g-ddnmf_Discovery Service API ..... | 16 | +| 6.1.1 Introduction ..... | 16 | +| 6.1.2 Usage of HTTP..... | 16 | +| 6.1.2.1 General..... | 16 | +| 6.1.2.2 HTTP standard headers..... | 17 | +| 6.1.2.2.1 General ..... | 17 | +| 6.1.2.2.2 Content type ..... | 17 | +| 6.1.2.3 HTTP custom headers..... | 17 | +| 6.1.3 Resources..... | 17 | +| 6.1.3.1 Overview..... | 17 | +| 6.1.3.2 Resource: AnnounceData ..... | 19 | +| 6.1.3.2.1 Description ..... | 19 | +| 6.1.3.2.2 Resource Definition..... | 19 | +| 6.1.3.2.3 Resource Standard Methods..... | 19 | +| 6.1.3.3 Resource: MonitorData..... | 22 | + +| | | | +|------------|----------------------------------------------------------------------------------|----| +| 6.1.3.3.1 | Description ..... | 22 | +| 6.1.3.3.2 | Resource Definition..... | 22 | +| 6.1.3.3.3 | Resource Standard Methods..... | 22 | +| 6.1.3.4 | Resource: DiscoveryData ..... | 25 | +| 6.1.3.4.1 | Description ..... | 25 | +| 6.1.3.4.2 | Resource Definition..... | 25 | +| 6.1.3.4.3 | Resource Standard Methods..... | 25 | +| 6.1.3.5 | Resource: UeData (Custom operation)..... | 27 | +| 6.1.3.5.1 | Description ..... | 27 | +| 6.1.3.5.2 | Resource Definition..... | 27 | +| 6.1.3.5.3 | Resource Standard Methods..... | 27 | +| 6.1.3.5.4 | Resource Custom Operations..... | 27 | +| 6.1.4 | Custom Operations without associated resources ..... | 29 | +| 6.1.5 | Notifications ..... | 29 | +| 6.1.5.1 | General..... | 29 | +| 6.1.5.2 | MonitorUpdateResult..... | 29 | +| 6.1.5.2.1 | Description ..... | 29 | +| 6.1.5.2.2 | Target URI..... | 30 | +| 6.1.5.2.3 | Standard Methods..... | 30 | +| 6.1.5.3 | MatchInformation ..... | 31 | +| 6.1.5.3.1 | Description ..... | 31 | +| 6.1.5.3.2 | Target URI..... | 31 | +| 6.1.5.3.3 | Standard Methods..... | 31 | +| 6.1.6 | Data Model ..... | 32 | +| 6.1.6.1 | General..... | 32 | +| 6.1.6.2 | Structured data types..... | 34 | +| 6.1.6.2.1 | Introduction ..... | 34 | +| 6.1.6.2.2 | Type: AnnounceAuthData..... | 34 | +| 6.1.6.2.3 | Void..... | 35 | +| 6.1.6.2.4 | Type: AnnounceDiscDataForOpen..... | 35 | +| 6.1.6.2.5 | Type: AnnounceDiscDataForRestricted ..... | 35 | +| 6.1.6.2.6 | Type: AnnounceUpdateData ..... | 36 | +| 6.1.6.2.7 | Type: MonitorAuthReqData ..... | 36 | +| 6.1.6.2.8 | Type: MonitorAuthRespData..... | 37 | +| 6.1.6.2.9 | Type: MonitorDiscDataForOpen ..... | 37 | +| 6.1.6.2.10 | Type: MonitorDiscDataForRestricted..... | 37 | +| 6.1.6.2.11 | Type: MonitorAuthDataForOpen..... | 38 | +| 6.1.6.2.12 | Type: MonitorAuthDataForRestricted ..... | 38 | +| 6.1.6.2.13 | Type: MonitorUpdateData ..... | 38 | +| 6.1.6.2.14 | Type: DiscoveryAuthReqData ..... | 39 | +| 6.1.6.2.15 | Type: DiscoveryAuthRespData..... | 39 | +| 6.1.6.2.16 | Type: DiscDataForRestricted..... | 39 | +| 6.1.6.2.17 | Type: AuthDataForRestricted ..... | 39 | +| 6.1.6.2.18 | Type: MatchReportReqData ..... | 40 | +| 6.1.6.2.19 | Type: MatchReportRespData..... | 40 | +| 6.1.6.2.20 | Type: MonitorUpdateResult..... | 41 | +| 6.1.6.2.21 | Type: MatchInformation ..... | 41 | +| 6.1.6.2.22 | Type: MatchInfoForOpen ..... | 41 | +| 6.1.6.2.23 | Type: MatchInfoForRestricted..... | 42 | +| 6.1.6.2.24 | Type: RestrictedCodeSuffixPool..... | 42 | +| 6.1.6.2.25 | Type: RestrictedCodeSuffixRange..... | 42 | +| 6.1.6.2.26 | Type: ProseApplicationCodeSuffixPool ..... | 42 | +| 6.1.6.2.27 | Type: ProseAppCodeSuffixRange..... | 43 | +| 6.1.6.2.28 | Type: MonitorUpdateDataForOpen ..... | 43 | +| 6.1.6.2.29 | Type: MonitorUpdateDataForRestricted..... | 43 | +| 6.1.6.3 | Simple data types and enumerations..... | 43 | +| 6.1.6.3.1 | Introduction ..... | 43 | +| 6.1.6.3.2 | Simple data types ..... | 43 | +| 6.1.6.3.3 | Enumeration: DiscoveryType ..... | 44 | +| 6.1.6.3.4 | Void..... | 44 | +| 6.1.6.3.5 | Enumeration: RevocationResult..... | 44 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 45 | + +| | | | +|-------------------------------|------------------------------------|-----------| +| 6.1.6.5 | Binary data ..... | 45 | +| 6.1.7 | Error Handling ..... | 45 | +| 6.1.7.1 | General ..... | 45 | +| 6.1.7.2 | Protocol Errors ..... | 45 | +| 6.1.7.3 | Application Errors ..... | 45 | +| 6.1.8 | Feature negotiation ..... | 45 | +| 6.1.9 | Security ..... | 46 | +| 6.1.10 | HTTP redirection ..... | 46 | +| Annex A (normative): | OpenAPI specification ..... | 47 | +| A.1 | General ..... | 47 | +| A.2 | N5g-ddnmf_Discovery API ..... | 47 | +| Annex B (informative): | Change history ..... | 63 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the N5g-ddnmf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the 5G DDNMF as specified in 3GPP TS 23.304 [4]. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [5] and 3GPP TS 29.501 [6]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 23.304: "Proximity based Services (ProSe) in the 5G System (5GS)". +- [5] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [6] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [7] OpenAPI : "OpenAPI Specification Version 3.0.0", . +- [8] IETF RFC 9113: "HTTP/2". +- [9] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [10] IETF RFC 9457: "Problem Details for HTTP APIs". +- [11] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [12] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [13] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [14] 3GPP TR 21.900: "Technical Specification Group working methods". + +- [15] IETF RFC 7396: "JSON Merge Patch". +- [16] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [17] 3GPP TS 23.003: "Numbering, addressing and identification". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**5G DDNMF:** The 5G DDNMF is the logical function handling network related actions required for dynamic ProSe Direct Discovery. The 5G DDNMF in the HPLMN may interact with the 5G DDNMF in a VPLMN or Local PLMN in order to manage the ProSe Direct Discovery service. + +**ProSe Direct Discovery:** A procedure employed by a ProSe-enabled UE to discover other ProSe-enabled UEs in its vicinity based on direct radio transmissions between the two UEs with NR technology. + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|----------|---------------| +| | | +|----------|---------------| + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|----------|----------------------------------------------| +| 5G DDNMF | 5G Direct Discovery Name Management Function | +| 5G ProSe | 5G Proximity-based Services | +| RPAUID | Restricted ProSe Application User ID | +| PDUID | ProSe Discovery UE ID | + +# --- 4 Overview + +The 5G Direct Discovery Name Management Function (5G DDNMF) is the network entity in the 5G Core Network (5GC) supporting Direct Discovery Services. Within the 5GC, the 5G DDNMF in HPLMN invokes services provided by the 5G DDNMF in Local PLMN and/or in VPLMN via the N5g-ddnmf service based interface (see 3GPP TS 23.304 [4]). + +Figure 4-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the 5G DDNMF: + +![Figure 4-1: Reference model – 5G DDNMF. The diagram shows the network architecture involving a UE, ProSe Application Server, 5G DDNMF, PCF, and UDM across Local PLMN, HPLMN, and VPLMN domains. The UE is connected to the ProSe Application Server via PC1 and PC3a. The ProSe Application Server is connected to the 5G DDNMF in the HPLMN via Npc2 and Naf. The 5G DDNMF in the HPLMN is connected to the 5G DDNMF in the Local PLMN via Npc6 and N5g-ddnmf. The 5G DDNMF in the HPLMN is also connected to the PCF via Npc8 and to the UDM via Npc4. The 5G DDNMF in the VPLMN is connected to the 5G DDNMF in the HPLMN via Npc7 and N5g-ddnmf.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +Figure 4-1: Reference model – 5G DDNMF. The diagram shows the network architecture involving a UE, ProSe Application Server, 5G DDNMF, PCF, and UDM across Local PLMN, HPLMN, and VPLMN domains. The UE is connected to the ProSe Application Server via PC1 and PC3a. The ProSe Application Server is connected to the 5G DDNMF in the HPLMN via Npc2 and Naf. The 5G DDNMF in the HPLMN is connected to the 5G DDNMF in the Local PLMN via Npc6 and N5g-ddnmf. The 5G DDNMF in the HPLMN is also connected to the PCF via Npc8 and to the UDM via Npc4. The 5G DDNMF in the VPLMN is connected to the 5G DDNMF in the HPLMN via Npc7 and N5g-ddnmf. + +Figure 4-1: Reference model – 5G DDNMF + +The functionalities supported by the 5G DDNMF are listed in clause 4.3.2 of 3GPP TS 23.304 [4]. + +NOTE: Only service based interfaces between 5G DDNMFs will be covered in this TS, other interfaces won't be covered for the time being. + +# 5 Services offered by the 5G DDNMF + +## 5.1 Introduction + +The table 5.1-1 shows the 5G DDNMF Services and 5G DDNMF Service Operations: + +Table 5.1-1: List of 5G DDNMF Services + +| Service Name | Service Operations | Operation Semantics | Example Consumer(s) | +|---------------------|---------------------|---------------------|---------------------| +| N5g-ddnmf_Discovery | AnnounceAuthorize | Request/Response | 5G DDNMF | +| | AnnounceUpdate | Request/Response | 5G DDNMF | +| | MonitorAuthorize | Request/Response | 5G DDNMF | +| | MonitorUpdate | Request/Response | 5G DDNMF | +| | MonitorUpdateResult | Notify | 5G DDNMF | +| | DiscoveryAuthorize | Request/Response | 5G DDNMF | +| | MatchReport | Request/Response | 5G DDNMF | +| | MatchInformation | Notify | 5G DDNMF | + +Table 5.1-2 summarizes the corresponding APIs defined for this specification. + +Table 5.1-2: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|---------------------|--------|-----------------------------|----------------------------------|---------------|-------| +| N5g-ddnmf_Discovery | 6.1 | N5g-ddnmf Discovery Service | TS29555_N5g-ddnmf_Discovery.yaml | n5gddnmf-disc | A.2 | + +## 5.2 N5g-ddnmf\_Discovery Service + +### 5.2.1 Service Description + +The N5g-ddnmf\_Discovery service enables an NF or SCP to manage inter-PLMN ProSe Direct Discovery operations for a target UE. The following are the key functionalities of this NF service. + +- Allow the consumer NF to obtain the authorization from the 5G DDNMF for announcing in the PLMN. +- Allow the consumer NF to update or revoke the authorization from the 5G DDNMF for announcing in the PLMN. +- Allow the consumer NF to obtain the authorization from the 5G DDNMF for monitoring in the PLMN. +- Allow the consumer NF to update or revoke the authorization for the indicated UE to monitor in the PLMN. +- Allow the consumer NF to inform the 5G DDNMF of the monitoring revocation results. +- Allow the consumer NF to obtain the authorization from the 5G DDNMF for a discoverer UE in the PLMN to operate Model B restricted discovery. +- Allow the consumer NF to obtain the information about the indicated discovery code from the 5G DDNMF. +- Allow the consumer NF to receive from the 5G DDNMF of a matching result, and the information can be used for charging purpose. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +This clause introduces the service operations defined for the N5g-ddnmf\_Discovery services as follows: + +- AnnounceAuthorize +- AnnounceUpdate +- MonitorAuthorize +- MonitorUpdate +- MonitorUpdateResult +- DiscoveryAuthorize +- MatchReport +- MatchInformation + +#### 5.2.2.2 AnnounceAuthorize + +##### 5.2.2.2.1 General + +The AnnounceAuthorize service operation shall be used by the NF Service consumer to obtain the authorization to announce for a UE from the 5G DDNMF in the PLMN. The following procedures are supported using the AnnounceAuthorize service operation: + +- Discovery Request procedures (see 3GPP TS 23.304 [4], clause 6.3.1.4) +- Announcing Alert Procedures for restricted discovery (see 3GPP TS 23.304 [4], clause 6.3.1.6) +- Direct Discovery Update Procedures (see 3GPP TS 23.304 [4], clause 6.3.1.7) + +##### 5.2.2.2.2 Obtain the authorization to announce for a UE + +The AnnounceAuthorize service operation is invoked by a NF Service Consumer, e.g. HPLMN 5G DDNMF, towards the 5G DDNMF (e.g. VPLMN 5G DDNMF or Local PLMN 5G DDNMF) to request to obtain the authorization from + +the 5G DDNMF for announcing for a target UE. See Figure 5.2.2.2.2-1. The request contains the UE's identity (`/{ueId}`) which shall be a SUPI or GPSI and the discovery Entry ID (`/{discEntryId}`) which is used to identify the discovery entry related to this request. + +![Sequence diagram for Figure 5.2.2.2.2-1: Obtain the authorization to announce for a UE. The diagram shows an NF Service Consumer sending a PUT request to a 5G DDNMF. The request is '1. PUT .../{ueId}/announce-authorize/{discEntryId} (AnnounceAuthData)'. The 5G DDNMF responds with '2a. 201 Created', '2b. 204 No Content', or '2c. 4xx/5xx (ProblemDetails) Or 3xx'.](d26959f4514c26ca19c3d6f00da85956_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant 5G DDNMF + Note right of NF Service Consumer: 1. PUT .../{ueId}/announce-authorize/{discEntryId} +(AnnounceAuthData) + NF Service Consumer->>5G DDNMF: Request + Note right of 5G DDNMF: 2a. 201 Created +2b. 204 No Content +2c. 4xx/5xx (ProblemDetails) Or 3xx + 5G DDNMF-->>NF Service Consumer: Response + +``` + +Sequence diagram for Figure 5.2.2.2.2-1: Obtain the authorization to announce for a UE. The diagram shows an NF Service Consumer sending a PUT request to a 5G DDNMF. The request is '1. PUT .../{ueId}/announce-authorize/{discEntryId} (AnnounceAuthData)'. The 5G DDNMF responds with '2a. 201 Created', '2b. 204 No Content', or '2c. 4xx/5xx (ProblemDetails) Or 3xx'. + +Figure 5.2.2.2.2-1: Obtain the authorization to announce for a UE + +1. The NF Service Consumer shall send an HTTP PUT request to the resource representing the authorization to announce for a UE to obtain the authorization to announce for this UE. The request shall include the Discovery Type, if the Discovery Type is OPEN the Announce Authorisation Data for open discovery shall be included, and if the Discovery Type is RESTRICTED the Announce Authorisation Data for restricted discovery shall be included in the HTTP PUT request body. +- 2a. If the context indicated by the discEntryId doesn't exist, the 5G DDNMF shall create the new resource, and upon success of creation of the resource, "201 created" shall be returned. +- 2b. If the context indicated by the discEntryId already exists, the 5G DDNMF shall replace the stored data using the received data, and upon success of the update of the resource, "204 No Content" shall be returned. +- 2c. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.3.1-3 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.2.3.1-3. + +#### 5.2.2.3 AnnounceUpdate + +##### 5.2.2.3.1 General + +The AnnounceUpdate service operation shall be used by the NF Service consumer to update or revoke the authorization from the 5G DDNMF for announcing in the PLMN. The following procedures are supported using the AnnounceUpdate service operation: + +- Direct Discovery Update Procedures (see 3GPP 3GPP TS 23.304 [4], clause 6.3.1.7) + +##### 5.2.2.3.2 Update the authorization for announcing for a UE + +The AnnounceUpdate service operation is invoked by a NF Service Consumer, e.g. HPLMN 5G DDNMF, towards the 5G DDNMF (e.g. VPLMN 5G DDNMF or Local PLMN 5G DDNMF) to request to update the authorization for announcing in the PLMN from the 5G DDNMF for a target UE. See Figure 5.2.2.3.2-1. The request contains the UE's identity (`/{ueId}`) which shall be a SUPI or GPSI and the discovery Entry ID (`/{discEntryId}`) which is used to identify the discovery entry related to this request. + +![Sequence diagram for Figure 5.2.2.3.2-1: Update the authorization for announcing for a UE. The diagram shows an NF Service Consumer sending a PATCH request to a 5G DDNMF. The request is '1. PATCH .../{ueId}/announce-authorize/{discEntryId} (AnnounceUpdateData)'. The 5G DDNMF responds with '2a. 204 No Content' or '2b. 4xx/5xx (ProblemDetails) Or 3xx'.](f14e75bd1c6e2f234db4775dbf0dbf1a_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant 5G DDNMF + Note right of NF Service Consumer: 1. PATCH .../{ueId}/announce-authorize/{discEntryId} +(AnnounceUpdateData) + NF Service Consumer->>5G DDNMF: Request + Note right of 5G DDNMF: 2a. 204 No Content +2b. 4xx/5xx (ProblemDetails) Or 3xx + 5G DDNMF-->>NF Service Consumer: Response + +``` + +Sequence diagram for Figure 5.2.2.3.2-1: Update the authorization for announcing for a UE. The diagram shows an NF Service Consumer sending a PATCH request to a 5G DDNMF. The request is '1. PATCH .../{ueId}/announce-authorize/{discEntryId} (AnnounceUpdateData)'. The 5G DDNMF responds with '2a. 204 No Content' or '2b. 4xx/5xx (ProblemDetails) Or 3xx'. + +Figure 5.2.2.3.2-1: Update the authorization for announcing for a UE + +1. The NF Service Consumer shall send an HTTP PATCH request to the resource representing the authorization to announce for a UE to update or revoke the authorization from the 5G DDNMF for announcing in the PLMN. The request shall include Discovery Type, the Validity Timer, and the ProSe Application Code if the ProSe Application Code is changed in the HTTP PATCH request body. If the Validity Timer sets to a full zero, it indicates to revoke the authorization for the announcing in the PLMN. +- 2a. On success, "204 No Content" shall be returned. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.3.2-3 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.2.3.2-3. + +#### 5.2.2.4 MonitorAuthorize + +##### 5.2.2.4.1 General + +The MonitorAuthorize service operation shall be used by the NF Service consumer to obtain the authorization from the 5G DDNMF for monitoring for an UE in the PLMN. The following procedures are supported using the MonitorAuthorize service operation: + +- Discovery Request procedures (see 3GPP 3GPP TS 23.304 [4], clause 6.3.1.4). + +##### 5.2.2.4.2 Obtain the authorization to monitor for a UE + +The MonitorAuthorize service operation is invoked by a NF Service Consumer, e.g. HPLMN 5G DDNMF, towards the 5G DDNMF (e.g. VPLMN 5G DDNMF or Local PLMN 5G DDNMF) to request to obtain the authorization from the 5G DDNMF for monitoring for a target UE. See Figure 5.2.2.4.2-1. The request contains the UE's identity (/{ueId}) which shall be a SUPI or GPSI and the discovery Entry ID (/{discEntryId}) which is used to identify the discovery entry related to this request. + +![Sequence diagram showing the interaction between an NF Service Consumer and a 5G DDNMF to obtain authorization to monitor for a UE. The consumer sends a PUT request to .../{ueId}/monitor-authorize/{discEntryId} with MonitorAuthReqData. The DDNMF responds with 201 Created (MonitorAuthRespData), 204 No Content, or a 4xx/5xx (ProblemDetails) or 3xx status code.](af6be343f0c0a8f155f965dcf337b8af_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant 5G DDNMF + Note right of NF Service Consumer: 1. PUT .../{ueId}/monitor-authorize/{discEntryId} +(MonitorAuthReqData) + NF Service Consumer->>5G DDNMF: Request + Note left of 5G DDNMF: 2a. 201 Created (MonitorAuthRespData) +2b. 204 No Content +2c. 4xx/5xx (ProblemDetails) Or 3xx + 5G DDNMF-->>NF Service Consumer: Response + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and a 5G DDNMF to obtain authorization to monitor for a UE. The consumer sends a PUT request to .../{ueId}/monitor-authorize/{discEntryId} with MonitorAuthReqData. The DDNMF responds with 201 Created (MonitorAuthRespData), 204 No Content, or a 4xx/5xx (ProblemDetails) or 3xx status code. + +**Figure 5.2.2.4.2-1: Obtain the authorization to monitor for a UE** + +1. The NF Service Consumer shall send an HTTP PUT request to the resource representing the authorization to monitor for a UE to obtain the authorization to monitor for this UE. The request shall include the Discovery Type, if the Discovery Type is OPEN the Monitor Authorisation Data for open discovery shall be included, and if the Discovery Type is RESTRICTED the Monitor Authorisation Data for restricted discovery shall be included in the HTTP PUT request body. +- 2a. If the context indicated by the discEntryId doesn't exist, the 5G DDNMF shall create the new resource, and upon success of creation of the resource, "201 created" shall be returned. The response body shall contain the parameters related to the determined authorization data to monitor for the UE. +- 2b. If the context indicated by the discEntryId already exists, the 5G DDNMF shall replace the stored data using the received data, and upon success of the update of the resource, "204 No Content" shall be returned. +- 2c. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.3.3.1-3 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.3.3.1-3. + +#### 5.2.2.5 MonitorUpdate + +##### 5.2.2.5.1 General + +The MonitorUpdate service operation shall be used by the NF Service consumer to update or revoke the authorization for the indicated UE to monitor in the PLMN. The following procedures are supported using the MonitorUpdate service operation: + +- Direct Discovery Update Procedures (see 3GPP 3GPP TS 23.304 [4], clause 6.3.1.7). + +##### 5.2.2.5.2 Update the authorization for monitoring for a UE + +The MonitorUpdate service operation is invoked by a NF Service Consumer, e.g. HPLMN 5G DDNMF, towards the 5G DDNMF (e.g. VPLMN 5G DDNMF or Local PLMN 5G DDNMF) to request to update the authorization for monitoring in the PLMN from the 5G DDNMF for a target UE. See Figure 5.2.2.5.2-1. The request contains the UE's identity (/{ueId}) which shall be a SUPI or GPSI and the discovery Entry ID (/{discEntryId}) which is used to identify the discovery entry related to this request. + +![Sequence diagram showing the interaction between an NF Service Consumer and a 5G DDNMF for updating authorization. The consumer sends a PATCH request to .../{ueId}/monitor-authorize/{discEntryId} with MonitorUpdateData. The DDNMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection).](e9d825d87c5f85c8dba0664eace96ef4_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant 5G DDNMF + Note right of NF Service Consumer: 1. PATCH .../{ueId}/monitor-authorize/{discEntryId} +(MonitorUpdateData) + NF Service Consumer->>5G DDNMF: Request + Note left of 5G DDNMF: 2a. 204 No Content +2b. 4xx/5xx (ProblemDetails) Or 3xx + 5G DDNMF-->>NF Service Consumer: Response + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and a 5G DDNMF for updating authorization. The consumer sends a PATCH request to .../{ueId}/monitor-authorize/{discEntryId} with MonitorUpdateData. The DDNMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection). + +**Figure 5.2.2.5.2-1: Update the authorization for monitoring for a UE** + +1. The NF Service Consumer shall send an HTTP PATCH request to the resource representing the authorization to monitor for a UE to update or revoke the authorization for the indicated UE to monitor in the PLMN. The request shall include Discovery Type, if the Discovery Type indicates "RESTRICTED", the ProSe Application ID Name, and the TTL shall be included in the HTTP PATCH request body. And if the value of TTL in the request sets to zero, it indicates to revoke the previously authorized monitoring to the given Discovery Entry ID, if the Discovery Type indicates "OPEN", ProSe Restricted Code, Application ID, Banned RPAUID, and Banned PDUID shall be included in the HTTP PATCH request body, and monitorUpdateResultCallbackRef may be included in the request body if the NF Service Consumer expects to receive the monitoring revocation results +- 2a. On success, "204 No Content" shall be returned. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.3.2-3 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.3.2-3. + +#### 5.2.2.6 MonitorUpdateResult + +##### 5.2.2.6.1 General + +The MonitorUpdateResult service operation shall be used by the 5G DDNMF to notify the NF Service consumer of the monitoring revocation results. The following procedures are supported using the MonitorUpdateResult service operation: + +- Direct Discovery Update Procedures (see 3GPP 3GPP TS 23.304 [4], clause 6.3.1.7). + +##### 5.2.2.6.2 Monitor Update Result Notification + +The MonitorUpdateResult service operation notifies the NF service consumer (e.g. HPLMN 5G DDNMF) serving the user about the monitoring revocation results for the user. The request contains the monitorUpdateResultCallbackRef URI. See Figure 5.2.2.6.2-1. + +![Sequence diagram for Figure 5.2.2.6.2-1: Monitor Update Result Notification. The diagram shows two lifelines: 'NF service consumer' on the left and '5G DDNMF' on the right. The interaction consists of three steps: 1. A POST request from 5G DDNMF to NF service consumer with the body {monitorUpdateResultCallbackRef} (MonitorUpdateResult). 2a. A 204 No Content response from NF service consumer to 5G DDNMF. 2b. A 4xx/5xx (ProblemDetails) or 3xx response from NF service consumer to 5G DDNMF.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` + +sequenceDiagram + participant 5G DDNMF + participant NF service consumer + Note right of 5G DDNMF: 1. POST {monitorUpdateResultCallbackRef} +(MonitorUpdateResult) + 5G DDNMF->>NF service consumer: 1. POST {monitorUpdateResultCallbackRef} +(MonitorUpdateResult) + Note left of NF service consumer: 2a. 204 No Content + NF service consumer-->>5G DDNMF: 2a. 204 No Content + Note left of NF service consumer: 2b. 4xx/5xx (ProblemDetails) Or 3xx + NF service consumer-->>5G DDNMF: 2b. 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram for Figure 5.2.2.6.2-1: Monitor Update Result Notification. The diagram shows two lifelines: 'NF service consumer' on the left and '5G DDNMF' on the right. The interaction consists of three steps: 1. A POST request from 5G DDNMF to NF service consumer with the body {monitorUpdateResultCallbackRef} (MonitorUpdateResult). 2a. A 204 No Content response from NF service consumer to 5G DDNMF. 2b. A 4xx/5xx (ProblemDetails) or 3xx response from NF service consumer to 5G DDNMF. + +**Figure 5.2.2.6.2-1: Monitor Update Result Notification** + +1. The 5G DDNMF sends a POST request to the monitorUpdateResultCallbackRef to notify the NF service consumer about the monitoring revocation results for the user. The request shall the Discovery Type, the ProSe Restricted Code, the Application ID, the Banned RPAUID, the Banned PDUID, and the monitoring revocation results. +- 2a. On success, the NF service consumer responds with "204 No Content". +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.5.2.3.1-3 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.5.2.3.1-3. + +#### 5.2.2.7 DiscoveryAuthorize + +##### 5.2.2.7.1 General + +The DiscoveryAuthorize service operation shall be used by the NF Service consumer to obtain the authorization from the 5G DDNMF for a discoverer UE in the PLMN to operate Model B restricted discovery. The following procedures are supported using the DiscoveryAuthorize service operation: + +- Discovery Request procedures (see 3GPP 3GPP TS 23.304 [4], clause 6.3.1.4). + +##### 5.2.2.7.2 Obtain the authorization for a discoverer UE to operate Model B restricted discovery + +The DiscoveryAuthorize service operation is invoked by a NF Service Consumer, e.g. HPLMN 5G DDNMF, towards the 5G DDNMF (e.g. VPLMN 5G DDNMF or Local PLMN 5G DDNMF) to request to obtain the authorization from the 5G DDNMF for a discoverer UE in the PLMN to operate Model B restricted discovery. See Figure 5.2.2.7.2-1. The request contains the UE's identity (/ueId) which shall be a SUPI or GPSI and the discovery Entry ID (/discEntryId) which is used to identify the discovery entry related to this request. + +![Sequence diagram for Figure 5.2.2.7.2-1: Obtain the authorization for a discoverer UE to operate Model B restricted discovery. The diagram shows two lifelines: 'NF Service Consumer' on the left and '5G DDNMF' on the right. The interaction consists of three steps: 1. A PUT request from NF Service Consumer to 5G DDNMF with the body {ueId}/discovery-authorize/{discEntryId} (DiscoveryAuthReqData). 2a. A 201 Created (DiscoveryAuthRespData) response from 5G DDNMF to NF Service Consumer. 2b. A 204 No Content response from 5G DDNMF to NF Service Consumer. 2c. A 4xx/5xx (ProblemDetails) or 3xx response from 5G DDNMF to NF Service Consumer.](66c2bf11a8f117cddf67eff92d4c736c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant 5G DDNMF + Note right of NF Service Consumer: 1. PUT .../{ueId}/discovery-authorize/{discEntryId} +(DiscoveryAuthReqData) + NF Service Consumer->>5G DDNMF: 1. PUT .../{ueId}/discovery-authorize/{discEntryId} +(DiscoveryAuthReqData) + Note left of 5G DDNMF: 2a. 201 Created (DiscoveryAuthRespData) + 5G DDNMF-->>NF Service Consumer: 2a. 201 Created (DiscoveryAuthRespData) + Note left of 5G DDNMF: 2b. 204 No Content + 5G DDNMF-->>NF Service Consumer: 2b. 204 No Content + Note left of 5G DDNMF: 2c. 4xx/5xx (ProblemDetails) Or 3xx + 5G DDNMF-->>NF Service Consumer: 2c. 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram for Figure 5.2.2.7.2-1: Obtain the authorization for a discoverer UE to operate Model B restricted discovery. The diagram shows two lifelines: 'NF Service Consumer' on the left and '5G DDNMF' on the right. The interaction consists of three steps: 1. A PUT request from NF Service Consumer to 5G DDNMF with the body {ueId}/discovery-authorize/{discEntryId} (DiscoveryAuthReqData). 2a. A 201 Created (DiscoveryAuthRespData) response from 5G DDNMF to NF Service Consumer. 2b. A 204 No Content response from 5G DDNMF to NF Service Consumer. 2c. A 4xx/5xx (ProblemDetails) or 3xx response from 5G DDNMF to NF Service Consumer. + +**Figure 5.2.2.7.2-1: Obtain the authorization for a discoverer UE to operate Model B restricted discovery** + +1. The NF Service Consumer shall send an HTTP PUT request to the resource representing the authorization for a discoverer UE to obtain the authorization for a discoverer UE to operate Model B restricted discovery. The request shall include the Discovery Type, authorisation data for restricted discovery in the HTTP PUT request body. +- 2a. If the context indicated by the discEntryId doesn't exist, the 5G DDNMF shall create the new resource, and upon success of creation of the resource, "201 created" shall be returned. The response body shall contain the + +parameters related to the determined authorization data for the discoverer UE to operate Model B restricted discovery. + +- 2b. If the context indicated by the discEntryId already exists, the 5G DDNMF shall replace the stored data using the received data, and upon success of the update of the resource, "204 No Content" shall be returned. +- 2c. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.4.3.1-3 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.4.3.1-3. + +#### 5.2.2.8 MatchReport + +##### 5.2.2.8.1 General + +The MatchReport service operation shall be used by the NF Service consumer to obtain the information about the indicated discovery code from the 5G DDNMF. The following procedures are supported using the MatchReport service operation: + +- Discovery Reporting procedures (see 3GPP 3GPP TS 23.304 [4], clause 6.3.1.5). + +##### 5.2.2.8.2 Obtain the information about the indicated discovery code + +The MatchReport service operation is invoked by a NF Service Consumer, e.g. HPLMN 5G DDNMF, towards the 5G DDNMF (e.g. VPLMN 5G DDNMF or Local PLMN 5G DDNMF) to request to obtain the information about the indicated discovery code from the 5G DDNMF. See Figure 5.2.2.8.2-1. The request contains the UE's identity (/ueId) which shall be a SUPI or GPSI, the type of request (/match-report). + +![Sequence diagram showing the interaction between an NF Service Consumer and a 5G DDNMF to obtain information about a discovery code. The consumer sends a POST request to /ueId/match-report, and the DDNMF responds with either a 200 OK (MatchReportRespData) or a 4xx/5xx (ProblemDetails) or 3xx status code.](3f1987804d7d78bc3b3bc560e974280a_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant 5G DDNMF + Note left of NF Service Consumer: Request discovery info + NF Service Consumer->>5G DDNMF: 1. POST .../ueId/match-report + Note right of 5G DDNMF: Response + 5G DDNMF-->>NF Service Consumer: 2a. 200 OK (MatchReportRespData) + Note right of 5G DDNMF: Failure/Redirection + 5G DDNMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and a 5G DDNMF to obtain information about a discovery code. The consumer sends a POST request to /ueId/match-report, and the DDNMF responds with either a 200 OK (MatchReportRespData) or a 4xx/5xx (ProblemDetails) or 3xx status code. + +**Figure 5.2.2.8.2-1: Obtain the information about the indicated discovery code** + +1. The NF Service Consumer shall send an HTTP POST request to the resource representing the information about the indicated discovery code to obtain the information about the indicated discovery code. The request shall include the Discovery Type, the ProSe Application Codes if the discovery type is OPEN in the HTTP POST request body, and optionally includes Monitored PLMN ID in the HTTP POST request body. +- 2a. On success, "200 OK" shall be returned. The response body shall contain the parameters related to the information about the indicated discovery code. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.5.3.1-3 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.5.3.1-3. + +#### 5.2.2.9 MatchInformation + +##### 5.2.2.9.1 General + +The MatchInformation service operation shall be used by the 5G DDNMF to notify the NF Service consumer of a matching result, and the information that can be used for charging purpose. The following procedures are supported using the MatchInformation service operation: + +- Discovery Reporting procedures (see 3GPP 3GPP TS 23.304 [4], clause 6.3.1.5) + +##### 5.2.2.9.2 Match Information Notification + +The MatchInformation service operation notifies the NF service consumer (e.g. VPLMN 5G DDNMF or Local PLMN 5G DDNMF) about match information including a matching result, and the information can be used for charging purpose. The request contains the matchInfoCallbackRef URI. See Figure 5.2.2.9.2-1. + +![Sequence diagram illustrating the Match Information Notification. The NF service consumer sends a POST request to the 5G DDNMF. The 5G DDNMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) response.](a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant 5G DDNMF + Note left of NF service consumer: POST {matchInfoCallbackRef} (MatchInformation) + NF service consumer->>5G DDNMF: 1. POST {matchInfoCallbackRef} (MatchInformation) + Note right of 5G DDNMF: 2a. 204 No Content + Note right of 5G DDNMF: 2b. 4xx/5xx (ProblemDetails) Or 3xx + 5G DDNMF-->>NF service consumer: 2a. 204 No Content + 5G DDNMF-->>NF service consumer: 2b. 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram illustrating the Match Information Notification. The NF service consumer sends a POST request to the 5G DDNMF. The 5G DDNMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) response. + +Figure 5.2.2.9.2-1: Match Information Notification + +1. The 5G DDNMF sends a POST request to the matchInfoCallbackRef URI to notify the NF service consumer about match information including a matching result, and the information can be used for charging purpose. The request shall include the Discovery Type, match report information for open discovery type if match report information for open discovery type is OPEN, and match report information for restricted discovery type if match report information for open discovery type is RESTRICTED +- 2a. On success, the NF service consumer responds with "204 No Content". +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.5.3.3.1-3 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.5.3.3.1-3. + +# 6 API Definitions + +## 6.1 N5g-ddnmf\_Discovery Service API + +### 6.1.1 Introduction + +The N5g-ddnmf\_Discovery shall use the N5g-ddnmf\_Discovery API. + +The API URI of the N5g-ddnmf\_Discovery API shall be: + +**{apiRoot}** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [6], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [6]. +- The shall be "n5g-ddnmf-disc". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [5]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [5]. + +The OpenAPI [7] specification of HTTP messages and content bodies for the n5g-ddnmf-disc API is contained in Annex A.2. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [5] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [9], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [5]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [10]. + +JSON Merge Patch, as defined in IETF RFC 7396 [15], signalled by the content type "application/merge-patch+json". + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [5] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.1.3.1-1 depicts the resource URIs structure for the N5g-ddnmf\_Discovery API. + +![Figure 6.1.3.1-1: Resource URI structure of the N5g-ddnmf_Discovery API. The diagram shows a hierarchical tree of URI paths. The root is {apiRoot}/n5g-ddnmf-disc/. It branches into /{ueId}, which further branches into /announce-authorize, /monitor-authorize, /discovery-authorize, and /match-report. The first three branches further branch into /{discEntryId}. The /match-report branch is shown with a dashed box.](4356776ca004ecba5d599667a155d7d4_img.jpg) + +``` + +graph TD + Root["{apiRoot}/n5g-ddnmf-disc/"] --> ueId["/{ueId}"] + ueId --> announce["/announce-authorize"] + ueId --> monitor["/monitor-authorize"] + ueId --> discovery["/discovery-authorize"] + ueId --> match["/match-report"] + announce --> discEntryId1["/{discEntryId}"] + monitor --> discEntryId2["/{discEntryId}"] + discovery --> discEntryId3["/{discEntryId}"] + match -.-> matchDashed["[ ]"] + +``` + +Figure 6.1.3.1-1: Resource URI structure of the N5g-ddnmf\_Discovery API. The diagram shows a hierarchical tree of URI paths. The root is {apiRoot}/n5g-ddnmf-disc/. It branches into /{ueId}, which further branches into /announce-authorize, /monitor-authorize, /discovery-authorize, and /match-report. The first three branches further branch into /{discEntryId}. The /match-report branch is shown with a dashed box. + +**Figure 6.1.3.1-1: Resource URI structure of the N5g-ddnmf\_Discovery API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------|-------------------------------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------| +| AnnounceData | /{ueId}/announce-authorize/{discEntryId} | PUT | Obtain the authorization to announce for a UE from the 5G DDNMF in the PLMN. | +| | | PATCH | Update or revoke the authorization from the 5G DDNMF for announcing in the PLMN. | +| MonitorData | /{ueId}/monitor-authorize/{discEntryId} | PUT | Obtain the authorization from the 5G DDNMF for monitoring for an UE in the PLMN. | +| | | PATCH | Update or revoke the authorization for the indicated UE to monitor in the PLMN. | +| DiscoveryData | /{ueId}/discovery-authorize/{discEntryId} | PUT | Obtain the authorization from the 5G DDNMF for a discoverer UE in the PLMN to operate Model B restricted discovery. | +| UeData | /{ueId}/match-report | match-report (POST) | Obtain the information about the indicated discovery code from the 5G DDNMF. | + +#### 6.1.3.2 Resource: AnnounceData + +##### 6.1.3.2.1 Description + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/n5g-ddnmf-disc//{ueId}/announce-authorize/{discEntryId} + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [16] | +| discEntryId | DiscoveryEntryId | Represents Discovery Entry Id. | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 PUT + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|----------------------------------------------------------------------------------------------| +| AnnounceAuthData | M | 1 | Contains the Announce Authorization Data for the indicated UE and indicated discovery entry. | + +**Table 6.1.3.2.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AnnounceAuthData | | | 201 Created | Upon success of creation of the resource, a response body shall be returned.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| n/a | | | 204 No Content | Upon success of the update of the resource, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- PROSE_SERVICE_UNAUTHORIZED

See table 6.1.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +**Table 6.1.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/n5g-ddnmf-disc>///announce-authorize/{discEntryId} | + +**Table 6.1.3.2.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +###### 6.1.3.2.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.1.3.2.3.2-1. + +**Table 6.1.3.2.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.2-2 and the response data structures and response codes specified in table 6.1.3.2.3.2-3. + +**Table 6.1.3.2.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|--------------------------------------------------------------------------------------------------------| +| AnnounceUpdate Data | M | 1 | Contains the Announce Authorization Data to update for the indicated UE and indicated discovery entry. | + +**Table 6.1.3.2.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 3) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND

See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 422 Unprocessable Entity | The "cause" attribute may be used to indicate one of the following application errors:
- UNPROCESSABLE REQUEST | + +NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +NOTE 3: If all the modification instructions in the PATCH request have been implemented, the 5G DDNMF shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the 5G DDNMF shall respond with PatchResult. + +**Table 6.1.3.2.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.3 Resource: MonitorData + +##### 6.1.3.3.1 Description + +This resource represents the Monitor data. + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/n5g-ddnmf-disc//{ueId}/monitor-authorize/{discEntryId} + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [16] | +| discEntryId | DiscoveryEntryId | Represents Discovery Entry Id. | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.1.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|---------------------------------------------------------------------------------------------| +| MonitorAuthReqData | M | 1 | Contains the Monitor Authorization Data for the indicated UE and indicated discovery entry. | + +Table 6.1.3.3.1-3: Data structures supported by the PUT Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MonitorAuthResp Data | M | 1 | 201 Created | Upon success of creation of the resource, a response body containing a representation of the authorized data to monitor for the UE shall be returned.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| n/a | | | 204 No Content | Upon success of the update of the resource, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- PROSE_SERVICE_UNAUTHORIZED

See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- APPLICATION_NOT_FOUND

See table 6.1.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +Table 6.1.3.3.1-4: Headers supported by the 201 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/n5g-ddnmf-disc/{/ueId}/monitor-authorize/{discEntryId} | + +Table 6.1.3.3.1-5: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +###### 6.1.3.3.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.1.3.3.3.2-1. + +**Table 6.1.3.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.3.3.2-3. + +**Table 6.1.3.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------| +| MonitorUpdateData | M | 1 | Contains the Monitor Authorization Data to update for the indicated UE and indicated discovery entry. | + +**Table 6.1.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 3) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND

See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 422 Unprocessable Entity | The "cause" attribute may be used to indicate one of the following application errors:
- UNPROCESSABLE REQUEST | + +NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +NOTE 3: If all the modification instructions in the PATCH request have been implemented, the 5G DDNMF shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the 5G DDNMF shall respond with PatchResult. + +**Table 6.1.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.4 Resource: DiscoveryData + +##### 6.1.3.4.1 Description + +This resource represents the Discovery Data. + +##### 6.1.3.4.2 Resource Definition + +Resource URI: {apiRoot}/n5g-ddnmf-disc//{ueId}/discovery-authorize/{discEntryId} + +This resource shall support the resource URI variables defined in table 6.1.3.4.2-1. + +**Table 6.1.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [16] | +| discEntryId | DiscoveryEntryId | Represents Discovery Entry Id. | + +##### 6.1.3.4.3 Resource Standard Methods + +###### 6.1.3.4.3.1 PUT + +This method shall support the URI query parameters specified in table 6.1.3.4.3.1-1. + +**Table 6.1.3.4.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.4.3.1-2 and the response data structures and response codes specified in table 6.1.3.4.3.1-3. + +**Table 6.1.3.4.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|----------------------------------------------------------------------------------------------------------| +| DiscoveryAuthReq Data | M | 1 | Contains the Discovery Authorization Data for the indicated discoverer UE and indicated discovery entry. | + +**Table 6.1.3.4.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DiscoveryAuthRespData | M | 1 | 201 Created | Upon success of creation of the resource, a response body containing a representation of the authorized data for the discoverer UE in the PLMN to operate Model B restricted discovery shall be returned.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| n/a | | | 204 No Content | Upon success of the update of the resource, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- PROSE_SERVICE_UNAUTHORIZED
- ANNOUNCING_UNAUTHORIZED_IN_PLMN

See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- APPLICATION_NOT_FOUND

See table 6.1.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +**Table 6.1.3.4.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/n5g-ddnmf-disc>///discovery - authorize/} | + +**Table 6.1.3.4.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.4.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.5 Resource: UeData (Custom operation) + +##### 6.1.3.5.1 Description + +This resource represents the UE Data. + +##### 6.1.3.5.2 Resource Definition + +Resource URI: {apiRoot}/n5g-ddnmf-disc//{ueId} + +This resource shall support the resource URI variables defined in table 6.1.3.5.2-1. + +**Table 6.1.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [16] | + +##### 6.1.3.5.3 Resource Standard Methods + +##### 6.1.3.5.4 Resource Custom Operations + +No Standard Methods are supported for this resource. + +###### 6.1.3.5.4.1 Overview + +**Table 6.1.3.5.4.1-1: Custom operations** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------|--------------------|------------------------------------------------------------------------------| +| match-report | /{ueid}/match-report | POST | Obtain the information about the indicated discovery code from the 5G DDNMF. | + +###### 6.1.3.5.4.2 Operation: match-report + +###### 6.1.3.5.4.2.1 Description + +This operation is used to request the 5G DDNMF to resolve a matched ProSe Discovery Code(s) (ProSe Application Code for open discovery) and obtain the corresponding ProSe Application ID Name(s) and additional information, e.g. metadata. + +###### 6.1.3.5.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.5.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.5.4.2.2-2. + +**Table 6.1.3.5.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|----------------------------------------| +| MatchReportReqData | M | 1 | Contains the Match Report information. | + +**Table 6.1.3.5.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MatchReportRespData | M | 1 | 200 OK | Upon success, a response body containing a representation of the Match Report Acknowledgement shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- PROSE_SERVICE_UNAUTHORIZED
- ANNOUNCING_UNAUTHORIZED_IN_PLMN
- INVALID_APPLICATION_CODE

See table 6.1.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +**Table 6.1.3.5.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.5.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the N5g-ddnmf\_Discovery Service. + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [5] and clause 4.6.2.3 of 3GPP TS 29.501 [6]. + +**Table 6.1.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|---------------------|----------------------------------|---------------------------------|-------------------------------------------------------------| +| MonitorUpdateResult | {monitorUpdateResultCallbackRef} | POST | Report the monitoring revocation results. | +| MatchInformation | {matchInfoCallbackRef} | POST | Report an observed matching result to a NF service consumer | + +#### 6.1.5.2 MonitorUpdateResult + +##### 6.1.5.2.1 Description + +The MonitorUpdateResult is used by the 5G DDNMF to report the monitoring revocation results (e.g. 5G DDNMF) + +##### 6.1.5.2.2 Target URI + +The Callback URI "{monitorUpdateResultCallbackRef}" shall be used with the callback URI variables defined in table 6.1.5.2.2-1. + +**Table 6.1.5.2.2-1: Callback URI variables** + +| Name | Definition | +|--------------------------------|-----------------------------------------------| +| monitorUpdateResultCallbackRef | String formatted as URI with the Callback Uri | + +##### 6.1.5.2.3 Standard Methods + +###### 6.1.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.2.3.1-1 and the response data structures and response codes specified in table 6.1.5.2.3.1-1. + +**Table 6.1.5.2.3.1-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|--------------------------------------------------------------------------| +| MonitorUpdateResult | M | 1 | The MonitorUpdateResult shall contain the monitoring revocation results. | + +**Table 6.1.5.2.3.1-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND

See table 6.1.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +**Table 6.1.5.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of another NF service consumer to which the notification should be sent.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.5.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of another NF service consumer to which the notification should be sent.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.5.3 MatchInformation + +##### 6.1.5.3.1 Description + +The POST method is used by the 5G DDNMF to report an observed matching result to a NF service consumer (e.g. 5G DDNMF). + +##### 6.1.5.3.2 Target URI + +The Callback URI "{matchInfoCallbackRef}" shall be used with the callback URI variables defined in table 6.1.5.3.2-1. + +**Table 6.1.5.3.2-1: Callback URI variables** + +| Name | Definition | +|----------------------|-----------------------------------------------| +| matchInfoCallbackRef | String formatted as URI with the Callback Uri | + +##### 6.1.5.3.3 Standard Methods + +###### 6.1.5.3.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.3.3.1-1 and the response data structures and response codes specified in table 6.1.5.3.3.1-1. + +**Table 6.1.5.3.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------| +| MatchInformation | M | 1 | The MatchInformation shall contain a matching result of the corresponding operation. | + +**Table 6.1.5.3.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND

See table 6.1.7.3-1 for the description of these errors. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +**Table 6.1.5.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of another NF service consumer to which the notification should be sent.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.5.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of another NF service consumer to which the notification should be sent.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the N5g-ddnmf service based interface protocol. + +Table 6.1.6.1-1: N5g-ddnmf specific Data Types + +| Data type | Clause defined | Description | Applicability | +|--------------------------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| AnnounceAuthData | 6.1.6.2.2 | Represents Data used to request the authorization to announce for a UE | | +| AnnounceDiscDataForOpen | 6.1.6.2.4 | Represents Data for open discovery used to request the authorization to announce for a UE | | +| AnnounceDiscDataForRestricted | 6.1.6.2.5 | Represents Data for restricted discovery used to request the authorization to announce for a UE | | +| AnnounceUpdateData | 6.1.6.2.6 | Represents Announce Authorize Data to update. | | +| MonitorAuthReqData | 6.1.6.2.7 | Represents Data used to request the authorization to monitor for a UE | | +| MonitorAuthRespData | 6.1.6.2.8 | Represents the obtained Monitor Authorize Data for a UE | | +| MonitorDiscDataForOpen | 6.1.6.2.9 | Represents Data for open discovery used to request the authorization to monitor for a UE | | +| MonitorDiscDataForRestricted | 6.1.6.2.10 | Represents Data for restricted discovery used to request the authorization to monitor for a UE | | +| MonitorAuthDataForOpen | 6.1.6.2.11 | Represents the obtained Announce Authorize Data for open discovery for a UE | | +| MonitorAuthDataForRestricted | 6.1.6.2.12 | Represents the obtained Announce Authorize Data for restricted discovery for a UE | | +| MonitorUpdateData | 6.1.6.2.13 | Represents Monitor Authorize Data to update. | | +| DiscoveryAuthReqData | 6.1.6.2.14 | Represents Data used to request the authorization for a discoverer UE | | +| DiscoveryAuthRespData | 6.1.6.2.15 | Represents the obtained authorization Data for a discoverer UE. | | +| DiscDataForRestricted | 6.1.6.2.16 | Represents Data for restricted discovery used to request the authorization for a discoverer UE | | +| AuthDataForRestricted | 6.1.6.2.17 | Represents obtained authorization Data for restricted discovery for a discoverer UE | | +| MatchReportReqData | 6.1.6.2.18 | Represents the Match Report information | | +| MatchReportRespData | 6.1.6.2.19 | Represents Match Report Acknowledgement | | +| MonitorUpdateResult | 6.1.6.2.20 | Represents the monitoring revocation results. | | +| MatchInformation | 6.1.6.2.21 | Represents a report including a matching result, and the information that can be used for charging purpose | | +| MatchInfoForOpen | 6.1.6.2.22 | Represents a report including a matching result, and the information that can be used for charging purpose for the open discovery type. | | +| MatchInfoForRestricted | 6.1.6.2.23 | Represents a report including a matching result, and the information that can be used for charging purpose for the restricted discovery type. | | +| RestrictedCodeSuffixPool | 6.1.6.2.24 | Contains the Restricted Code Suffix Pool. | | +| RestrictedCodeSuffixRange | 6.1.6.2.25 | Contains a range of the Restricted Code Suffixes which are consecutive. | | +| ProseApplicationCodeSuffixPool | 6.1.6.2.26 | Contains the Prose Application Code Suffix Pool. | | +| ProseAppCodeSuffixRange | 6.1.6.2.27 | Contains a range of the Prose Application Code Suffixes which are | | + +| | | | | +|--------------------------------|------------|---------------------------------------------------------------------|--| +| | | consecutive. | | +| MonitorUpdateDataForOpen | 6.1.6.2.28 | Represents Monitor Update Data for the Discovery Type "OPEN" | | +| MonitorUpdateDataForRestricted | 6.1.6.2.29 | Represents Monitor Update Data for the Discovery Type "RESTRICTED". | | +| DiscoveryType | 6.1.6.3.3 | Represents Discovery Type for ProSe Service | | +| AuthorizationResult | 6.1.6.3.4 | Represents Authorization Result Type for ProSe Service | | +| RevocationResult | 6.1.6.3.5 | Represents the monitoring Revocation Result for ProSe Service | | + +Table 6.1.6.1-2 specifies data types re-used by the N5g-ddnmf service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the N service based interface. + +**Table 6.1.6.1-2: N5g-ddnmf re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------|---------------------|-------------------------------------|---------------| +| VarUeld | 3GPP TS 29.571 [16] | String represents the SUPI or GPSI. | | +| DateTime | 3GPP TS 29.571 [16] | DateTime | | +| PlmnId | 3GPP TS 29.571 [16] | Plmn ID | | +| Supi | 3GPP TS 29.571 [16] | SUPI | | +| Uri | 3GPP TS 29.571 [16] | URI | | +| ProblemDetails | 3GPP TS 29.571 [16] | | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: AnnounceAuthData + +**Table 6.1.6.2.2-1: Definition of type AnnounceAuthData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| discType | DiscoveryType | M | 1 | This IE shall contain the discovery type for ProSe Service. | | +| openDiscData | AnnounceDiscDataForOpen | C | 0..1 | This IE shall contain the input data of announce authorisation for open discovery when present.

If the value of discType is "OPEN", this IE shall be present. | | +| restrictedDiscData | AnnounceDiscDataForRestricted | C | 0..1 | This IE shall contain the input data of announce authorisation for restricted discovery when present.

If the value of discType is "RESTRICTED", this IE shall be present. | | + +6.1.6.2.3 Void + +6.1.6.2.4 Type: AnnounceDiscDataForOpen + +**Table 6.1.6.2.4-1: Definition of type AnnounceDiscDataForOpen** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|--------------------------------|---|-------------|-------------------------------------------------------------------------------------------------|---------------| +| proseAppId | ProseApplicationId | M | 1 | This IE shall contain the ProSe Application ID. | | +| validityTime | DateTime | M | 1 | This IE shall contain validity timer up to which the ProSe Application Code is going to expire. | | +| proseAppCode | ProseApplicationCode | C | 0..1 | When present, this IE shall contain the ProSe Application Code.
(NOTE) | | +| proseAppCodePrefix | ProseApplicationPrefix | C | 0..1 | When present, this IE shall contain the ProSe Application Code Prefix.
(NOTE) | | +| proseAppCodeSuffixPool | ProseApplicationCodeSuffixPool | O | 0..1 | This IE shall contain the ProSe Application Code Suffix pool when present. | | +| metaData | MetaData | O | 0..1 | This IE shall contain the metadata when present. | | + +NOTE: Either attribute proseAppCode or attribute proseAppCodePrefix shall be present. + +6.1.6.2.5 Type: AnnounceDiscDataForRestricted + +**Table 6.1.6.2.5-1: Definition of type AnnounceDiscDataForRestricted** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|--------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| rpauid | Rpauid | M | 1 | This IE shall contain the RPAUID. | | +| appId | ApplicationId | M | 1 | This IE shall contain the Application ID | | +| validityTime | DateTime | M | 1 | This IE shall contain validity timer up to which the ProSe Restricted Code is going to expire.

If the value sets to a full zero (i.e., 0000-00-00T00:00:00), it indicates to removes the resources indicated by the Discovery Entry ID for the UE. | | +| proseRestrictedCode | ProseRestrictedCode | C | 0..1 | This IE shall contain the ProSe Restricted Code when present.
(NOTE) | | +| proseRestrictedPrefix | ProseRestrictedPrefix | C | 0..1 | This IE shall contain the ProSe Restricted Code Prefix when present.
(NOTE) | | +| codeSuffixPool | RestrictedCodeSuffixPool | O | 0..1 | This IE shall contain the Restricted Code Suffix pool when present. | | + +NOTE: Either attribute proseRestrictedCode or attribute proseRestrictedPrefix shall be present. + +##### 6.1.6.2.6 Type: AnnounceUpdateData + +Table 6.1.6.2.6-1: Definition of type AnnounceUpdateData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| discType | DiscoveryType | M | 1 | This IE shall contain the discovery type for ProSe Service, only value "OPEN" is allowed. | | +| validityTime | DateTime | M | 1 | This IE shall contain validity timer up to which the ProSe Application Code is going to expire.
If the value sets to a full zero (i.e., 0000-00-00T00:00:00), it indicates to revoke the authorization for the announcing in the PLMN. | | +| proseAppCode | ProseApplicationCode | C | 0..1 | This IE shall contain the ProSe Application Code when present.
If the ProSe Application Code is changed, this IE shall be present.
If the value of attribute is a full zero, this IE shall be absent. | | + +##### 6.1.6.2.7 Type: MonitorAuthReqData + +Table 6.1.6.2.7-1: Definition of type MonitorAuthReqData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| discType | DiscoveryType | M | 1 | This IE shall contain the discovery type for ProSe Service. | | +| openDiscData | MonitorDiscDataForOpen | C | 0..1 | This IE shall contain the input data of monitor authorisation for open discovery when present.

If the value of discType is "OPEN", this IE shall be present. | | +| restrictedDiscData | MonitorDiscDataForRestricted | C | 0..1 | This IE shall contain the input data of monitor authorisation for restricted discovery when present.

If the value of discType is "RESTRICTED", this IE shall be present. | | + +##### 6.1.6.2.8 Type: MonitorAuthRespData + +Table 6.1.6.2.8-1: Definition of type MonitorAuthRespData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| authDataOpen | MonitorAuthDataForOpen | C | 0..1 | This IE shall contain a list of the ProSe Application Codes when present.

If the discovery type is "OPEN", this IE shall be present. | | +| authDataRestricted | MonitorAuthDataForRestricted | C | 0..1 | This IE shall contain the Prose Application Prefix when present.

If the discovery type in request is "RESTRICTED", this IE shall be present. | | + +##### 6.1.6.2.9 Type: MonitorDiscDataForOpen + +Table 6.1.6.2.9-1: Definition of type MonitorDiscDataForOpen + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------------------|---|-------------|-------------------------------------------------------------|---------------| +| proseAppIdNames | array(ProseApplicationIdName) | M | 1..N | This IE shall contain a list of ProSe Application ID names. | | + +##### 6.1.6.2.10 Type: MonitorDiscDataForRestricted + +Table 6.1.6.2.10-1: Definition of type MonitorDiscDataForRestricted + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|------------------------------------------|---------------| +| rpauid | Rpauid | M | 1 | This IE shall contain the RPAUID. | | +| targetPduid | Pduid | M | 1 | This IE shall contain the Target PDUID. | | +| appid | ApplicationId | M | 1 | This IE shall contain the Application ID | | +| targetRpauid | Rpauid | M | 1 | This IE shall contain the Target RPAUID. | | + +##### 6.1.6.2.11 Type: MonitorAuthDataForOpen + +Table 6.1.6.2.11-1: Definition of type MonitorAuthDataForOpen + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------| +| proseAppCodes | array(ProseApplicationCode) | C | 1..N | This IE shall contain a list of the ProSe Application Codes.
(NOTE) | | +| proseAppPrefix | ProseApplicationPrefix | C | 0..1 | This IE shall contain the Prose Application Prefix.
(NOTE) | | +| proseAppMasks | array(ProseApplicationMask) | M | 1..N | This IE shall contain a list of the ProSe Application Masks. | | +| ttl | integer | M | 1 | This IE shall contain the TTL.
If the value sets to zero, it indicates to revoke the authorization for the monitoring in the PLMN. | | + +NOTE: Either attribute proseAppCodes or proseAppPrefix proseRestrictedPrefix shall be present if the discovery type is open. + +##### 6.1.6.2.12 Type: MonitorAuthDataForRestricted + +Table 6.1.6.2.12-1: Definition of type MonitorAuthDataForRestricted + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------|---|-------------|-------------------------------------------------------------------------------------------------|---------------| +| proseRestrictedCode | ProseRestrictedCode | M | 1 | This IE shall contain the ProSe Restricted Code. | | +| validityTime | DateTime | M | 1 | This IE shall contain validity timer up to which the ProSe Application Code is going to expire. | | + +##### 6.1.6.2.13 Type: MonitorUpdateData + +Table 6.1.6.2.13-1: Definition of type MonitorUpdateData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|--------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| discType | DiscoveryType | M | 1 | This IE shall contain the discovery type for ProSe Service. | | +| openUpdateData | MonitorUpdateDataForOpen | C | 0..1 | This IE shall contain the Monitor Update Data for open discovery when present.

If the value of discType is "OPEN", this IE shall be present. | | +| restrictedUpdateData | MonitorUpdateDataForRestricted | C | 0..1 | This IE shall contain the Monitor Update Data for restricted discovery when present.

If the value of discType is "RESTRICTED", this IE shall be present. | | + +##### 6.1.6.2.14 Type: DiscoveryAuthReqData + +Table 6.1.6.2.14-1: Definition of type DiscoveryAuthReqData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| discType | DiscoveryType | M | 1 | This IE shall contain the discovery type for ProSe Service.
Only value "RESTRICTED" is allowed. | | +| restrictedDiscData | DiscDataForRestricted | C | 0..1 | This IE shall contain the input data of authorisation for restricted discovery when present.

If the value of discType is "RESTRICTED", this IE shall be present. | | + +##### 6.1.6.2.15 Type: DiscoveryAuthRespData + +Table 6.1.6.2.15-1: Definition of type DiscoveryAuthRespData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| authDataRestricted | AuthDataForRestricted | C | 0..1 | This IE shall contain the authorized data for restricted discovery when present.

If the discovery type in request is "RESTRICTED", this IE shall be present. | | + +##### 6.1.6.2.16 Type: DiscDataForRestricted + +Table 6.1.6.2.16-1: Definition of type DiscDataForRestricted + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|------------------------------------------|---------------| +| rpauid | Rpauid | M | 1 | This IE shall contain the RPAUID. | | +| targetPduid | Pduid | M | 1 | This IE shall contain the Target PDUID. | | +| appld | ApplicationId | M | 1 | This IE shall contain the Application ID | | +| targetRpauid | Rpauid | M | 1 | This IE shall contain the Target RPAUID. | | + +##### 6.1.6.2.17 Type: AuthDataForRestricted + +Table 6.1.6.2.17-1: Definition of type AuthDataForRestricted + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------|---------------| +| proseQueryCodes | array(ProseQueryCode) | M | 1..N | This IE shall contain a list of the authorised ProSe Restricted Code. | | +| proseRespCode | ProseResponse Code | M | 1 | This IE shall contain the authorised ProSe Respond Code. | | +| validityTime | DateTime | M | 1 | This IE shall contain validity timer up to which the ProSe Application Code is going to expire. | | + +##### 6.1.6.2.18 Type: MatchReportReqData + +Table 6.1.6.2.18-1: Definition of type MatchReportReqData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| discType | DiscoveryType | M | 1 | This IE shall contain the discovery type for ProSe Service.
Only value "OPEN" is allowed. | | +| proseAppCodes | array(ProseApplicationCode) | C | 1..N | This IE shall contain a list of the ProSe Application Codes when present.

If the value of DiscoveryType is "OPEN", this IE shall be present. | | +| monitoredPlmnId | PlmnId | C | 0..1 | This IE shall contain the Monitored PLMN ID when present. | | + +##### 6.1.6.2.19 Type: MatchReportRespData + +Table 6.1.6.2.19-1: Definition of type MatchReportRespData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| proseAppIdNames | array(ProseApplicationIdName) | C | 1..N | This IE shall contain a list of ProSe Application ID names when present.

If the discovery type in the request is "OPEN", this IE shall be present. | | +| validityTime | DateTime | C | 0..1 | This IE shall contain validity timer up to which the ProSe Application Code is going to expire when present.

If the discovery type in the request is "OPEN", this IE shall be present. | | +| metaData | MetaData | O | 0..1 | This IE shall contain the metadata when present. | | +| metaDataIndexMasks | array(MetaDataIndexMask) | O | 1..N | This IE shall contain a list of the Meta Data Index Masks when present. | | + +6.1.6.2.20 Type: MonitorUpdateResult + +**Table 6.1.6.2.20-1: Definition of type MonitorUpdateResult** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------|---|-------------|----------------------------------------------------------------------------------------------------|---------------| +| discType | DiscoveryType | M | 1 | This IE shall contain the discovery type for ProSe Service.
Only value "RESTRICTED" is allowed. | | +| proseRestrictedCode | ProseRestrictedCode | M | 1 | This IE shall contain the ProSe Restricted Code. | | +| appId | ApplicationId | M | 1 | This IE shall contain the Application ID | | +| bannedRpauid | Rpauid | M | 1 | This IE shall contain the Banned RPAUID. | | +| bannedPduid | Pduid | M | 1 | This IE shall contain the Banned PDUID. | | +| revocationResult | RevocationResult | M | 1 | This IE shall contain the monitoring revocation results. | | + +6.1.6.2.21 Type: MatchInformation + +**Table 6.1.6.2.21-1: Definition of type MatchInformation** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| discType | DiscoveryType | M | 1 | This IE shall contain the discovery type for ProSe Service. | | +| openMatchInfoForOpen | MatchInfoForOpen | C | 0..1 | This IE shall contain the match report information for open discovery type when present.

If the value of discType is "OPEN", this IE shall be present. | | +| restrictedMatchInfo | MatchInfoForRestricted | C | 0..1 | This IE shall contain the match report information for restricted discovery when present.

If the value of discType is "RESTRICTED", this IE shall be present. | | + +6.1.6.2.22 Type: MatchInfoForOpen + +**Table 6.1.6.2.22-1: Definition of type MatchInfoForOpen** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|------------------------------------------------------|---------------| +| supi | Supi | M | 1 | This IE shall contain the SUPI of UE. | | +| appId | array(ApplicationId) | M | 1 | This IE shall contain a list of the Application IDs. | | + +##### 6.1.6.2.23 Type: MatchInfoForRestricted + +Table 6.1.6.2.23-1: Definition of type MatchInfoForRestricted + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------|---|-------------|--------------------------------------------------|---------------| +| supi | Supi | M | 1 | This IE shall contain the SUPI of UE. | | +| rpauid | Rpauid | M | 1 | This IE shall contain the RPAUID. | | +| targetRpauid | Rpauid | M | 1 | This IE shall contain the Target RPAUID. | | +| proseRestrictedCode | ProseRestrictedCode | M | 1 | This IE shall contain the ProSe Restricted Code. | | + +##### 6.1.6.2.24 Type: RestrictedCodeSuffixPool + +Table 6.1.6.2.24-1: Definition of type RestrictedCodeSuffixPool + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------------------------|----------------------------------|---|-------------|-----------------------------------------------------------------------|---------------| +| codeSuffixList | array(RestrictedCodeSuffix) | C | 1..N | This IE shall contain a list of the Restricted Code Suffixes | | +| codeSuffixRangeList | array(RestrictedCodeSuffixRange) | C | 1..N | This IE shall contain a list of ranges of the Restricted Code Suffix. | | +| NOTE: At least one of attributes codeSuffixList and codeSuffixRangeList shall be present. | | | | | | + +##### 6.1.6.2.25 Type: RestrictedCodeSuffixRange + +Table 6.1.6.2.25-1: Definition of type RestrictedCodeSuffixRange + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------|---------------| +| beginningSuffix | RestrictedCodeSuffix | M | 1 | This IE shall contain the lowest ProSe Restricted Code Suffix in a consecutive sequence of ProSe Restricted Code suffixes. | | +| endingSuffix | RestrictedCodeSuffix | M | 1 | This IE shall contain the highest ProSe Restricted Code Suffix in a consecutive sequence of ProSe Restricted Code suffixes. | | + +##### 6.1.6.2.26 Type: ProseApplicationCodeSuffixPool + +Table 6.1.6.2.26-1: Definition of type ProseApplicationCodeSuffixPool + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------------------------------------------------------------|-------------------------|---|-------------|-----------------------------------------------------------------------|---------------| +| codeSuffix | ProseAppCodeSuffix | C | 0..1 | This IE shall contain the ProSe Application Code Suffix. | | +| codeSuffixRange | ProseAppCodeSuffixRange | C | 0..1 | This IE shall contain the range of the ProSe Application Code Suffix. | | +| NOTE: At least one of attributes codeSuffix and codeSuffixRange shall be present. | | | | | | + +6.1.6.2.27 Type: ProseAppCodeSuffixRange + +**Table 6.1.6.2.27-1: Definition of type ProseAppCodeSuffixRange** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------|---------------| +| beginningSuffix | ProseAppCode Suffix | M | 1 | This IE shall contain the lowest ProSe Restricted Code Suffix in a consecutive sequence of ProSe Restricted Code suffixes. | | +| endingSuffix | ProseAppCode Suffix | M | 1 | This IE shall contain the highest ProSe Restricted Code Suffix in a consecutive sequence of ProSe Restricted Code suffixes. | | + +6.1.6.2.28 Type: MonitorUpdateDataForOpen + +**Table 6.1.6.2.28-1: Definition of type MonitorUpdateDataForOpen** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------|---------------| +| proseAppIdName | ProseApplicationIdName | M | 1 | This IE shall contain the ProSe Application ID Name. | | +| ttl | integer | M | 1 | This IE shall contain the TTL.

If it sets to zero, it indicates to revoke the previously authorized monitoring. | | + +6.1.6.2.29 Type: MonitorUpdateDataForRestricted + +**Table 6.1.6.2.29-1: Definition of type MonitorUpdateDataForRestricted** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------|---------------| +| proseRestrictedCode | ProseRestricted Code | M | 1 | This IE shall contain the ProSe Restricted Code. | | +| appId | ApplicationId | M | 1 | This IE shall contain the Application ID | | +| bannedRpauid | Rpauid | M | 1 | This IE shall contain the Banned RPAUID. | | +| bannedPduid | Pduid | M | 1 | This IE shall contain the Banned PDUID. | | +| monitorUpdateResultCallbackRef | Uri | O | 0..1 | A URI provided by 5G DDNMF to receive (implicitly subscribed) notifications on the monitoring revocation results. | | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|------------------------|-----------------|--------------------------------------------------------------------------------------------------------------|---------------| +| DiscoveryEntryId | string | Discovery Entry ID | | +| ProseApplicationId | string | ProSe Application ID, the format of ProSe Application ID is defined in 3GPP TS 23.003 [17] | | +| ProseApplicationCode | string | ProSe Application Code, the format of ProSe Application Code is defined in 3GPP TS 23.003 [17] | | +| RpauId | string | RPAUID | | +| ApplicationId | string | Application ID | | +| ProseRestrictedCode | string | ProSe Restricted Code, the format of ProSe Restricted Code is defined in 3GPP TS 23.003 [17] | | +| ProseRestrictedPrefix | string | ProSe Restricted Code Prefix, the format of ProSe Restricted Code Prefix is defined in 3GPP TS 23.003 [17] | | +| MetaData | string | metadata | | +| ProseApplicationIdName | string | ProSe Application ID name, the format of ProSe Application ID name is defined in 3GPP TS 23.003 [17] | | +| PduId | string | PDUID | | +| ProseApplicationPrefix | string | Prose Application Code Prefix, the format of Prose Application Code Prefix is defined in 3GPP TS 23.003 [17] | | +| ProseApplicationMask | string | Prose Application Mask | | +| ProseQueryCode | string | ProSe Query Code, the format of ProSe Query Code is defined in 3GPP TS 23.003 [17] | | +| ProseResponseCode | string | ProSe Response Code, the format of ProSe Response Code is defined in 3GPP TS 23.003 [17] | | +| MetaDataIndexMask | string | Meta Data Index Mask | | +| RestrictedCodeSuffix | string | ProSe Restricted Code Suffix, the format of ProSe Restricted Code Suffix is defined in 3GPP TS 23.003 [17] | | +| ProseAppCodeSuffix | string | ProSe Application Code Suffix, the format of ProSe Restricted Code Suffix is defined in 3GPP TS 23.003 [17] | | + +##### 6.1.6.3.3 Enumeration: DiscoveryType + +The enumeration DiscoveryType represents Discovery Type for ProSe Service. It shall comply with the provisions defined in table 6.1.6.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration DiscoveryType** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------|---------------| +| "OPEN" | Discovery type is "open". | | +| "RESTRICTED" | Discovery type is "restricted". | | + +##### 6.1.6.3.4 Void + +##### 6.1.6.3.5 Enumeration: RevocationResult + +The enumeration RevocationResult represents the monitoring Revocation Result for ProSe Service. It shall comply with the provisions defined in table 6.1.6.3.5-1. + +**Table 6.1.6.3.5-1: Enumeration RevocationResult** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------|---------------| +| "SUCCESSFUL" | The Monitoring Revocation is successful. | | +| "FAILED" | The Monitoring Revocation is failed. | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +None. + +#### 6.1.6.5 Binary data + +None. + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the N5g-ddnmf\_Discovery API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [6]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [5] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [5]. + +In addition, the requirements in the following clauses are applicable for the N5g-ddnmf\_Discovery API. + +#### 6.1.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [5]. + +#### 6.1.7.3 Application Errors + +The application errors defined for the N5g-ddnmf\_Discovery service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PROSE_SERVICE_UNAUTHORIZED | 403 Forbidden | It is used when the requested ProSe service is not authorized for this UE Identity. | +| ANNOUNCING_UNAUTHORIZED_IN_PLMN | 403 Forbidden | It is used when the ProSe Application Code received is not authorized to be announced in the indicated monitored/announcing PLMN for the specified PC5 radio technology | +| INVALID_APPLICATION_CODE | 403 Forbidden | It is used when none of the requested ProSe Application Code(s) is valid | +| CONTEXT_NOT_FOUND | 404 Not Found | It is used when no corresponding context exists. | +| APPLICATION_NOT_FOUND | 404 Not Found | It is used when the requested ProSe Application doesn't exist | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the N5g-ddnmf\_Discovery API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [5]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | PatchReport | If some of the modifications included in the PATCH request are not successfully implemented, the 5G DDNMF reports the result of PATCH request execution to the consumer. See clause 5.2.7.2 of 3GPP TS 29.500 [5]. | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [11] and 3GPP TS 29.500 [5], the access to the N5g-ddnmf\_Discovery API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [12]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [13]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the N5g-ddnmf\_Discovery API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [13], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the N5g-ddnmf\_Discovery service. + +The N5g-ddnmf\_Discovery API defines the following scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [11]: + +**Table 6.1.9-1: OAuth2 scopes defined in N5g-ddnmf\_Discovery API** + +| Scope | Description | +|---------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| +| "n5g-ddnmf-disc" | Access to the Npanf_ProseKey API. | +| "n5g-ddnmf-disc:announce-authorize:modify" | Access to modify the authorization to announce for a UE in the PLMN. | +| "n5g-ddnmf-disc:monitor-authorize:modify" | Access to modify the authorization for monitoring for an UE in the PLMN | +| "n5g-ddnmf-disc:discovery-authorize:modify" | Access to modify the authorization from the 5G DDNMF for a discoverer UE in the PLMN to operate Model B restricted discovery | +| "n5g-ddnmf-disc:match-report:invoke" | Access to invoke the information about the indicated discovery code | + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different 5G DDNMF service instance, within the same 5G DDNMF or a different 5G DDNMF of an 5G DDNMF set, e.g. when an 5G DDNMF service instance is part of an 5G DDNMF (service) set or when using indirect communications (see 3GPP TS 29.500 [5]). + +An SCP that reselects a different 5G DDNMF producer instance will return the NF Instance ID of the new 5G DDNMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [5]. + +If an 5G DDNMF within an 5G DDNMF set redirects a service request to a different 5G DDNMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new 5G DDNMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5.3.1 of 3GPP TS 29.501 [6] and clause 5B of 3GPP TR 21.900 [14]). + +## A.2 N5g-ddnmf\_Discovery API + +``` +openapi: 3.0.0 + +info: + title: N5g-ddnmf_Discovery API + version: '1.1.0-alpha.3' + description: | + N5g-ddnmf_Discovery Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.555 V18.4.0; 5G System; 5G Direct Discovery Name Management Services; + Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.555/ + +servers: + - url: '{apiRoot}/n5g-ddnmf-disc/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + +paths: + /{ueId}/announce-authorize/{discEntryId}: + put: + summary: Obtain the authorization to announce for a UE + operationId: ObtainAnnounceAuth + tags: + - Obtain the authorization to announce for a UE + security: + - {} + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - n5g-ddnmf-disc:announce-authorize:modify + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +``` + +``` + +- name: discEntryId + in: path + description: Discovery Entry Id + required: true + schema: + $ref: '#/components/schemas/DiscoveryEntryId' +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnnounceAuthData' + required: true +responses: + '201': + description: Successful creation of the resource + content: + application/json: + schema: + $ref: '#/components/schemas/AnnounceAuthData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/n5g-ddnmf-disc>/{apiVersion>}/{ueId}/announce-authorize/{discEntryId} + required: true + schema: + type: string + '204': + description: Successful update of the resource. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +patch: + summary: Update the authorization for announcing for a UE + operationId: UpdateAnnounceAuth + tags: + - Update the authorization for announcing for a UE + security: + - {} + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - n5g-ddnmf-disc:announce-authorize:modify + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: discEntryId + in: path + +``` + +``` + description: Discovery Entry Id + required: true + schema: + $ref: '#/components/schemas/DiscoveryEntryId' + requestBody: + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/AnnounceUpdateData' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Expected response to a valid request + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '422': + description: Unprocessable Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/monitor-authorize/{discEntryId}: + put: + summary: Obtain the authorization to monitor for a UE + operationId: ObtainMonitorAuth + tags: + - Obtain the authorization to monitor for a UE + security: + - {} + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - n5g-ddnmf-disc:monitor-authorize:modify + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: discEntryId + in: path + description: Discovery Entry Id + required: true +``` + +``` + schema: + $ref: '#/components/schemas/DiscoveryEntryId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MonitorAuthReqData' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/MonitorAuthRespData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/n5g-ddnmf-disc>///monitor-authorize/{discEntryId} + required: true + schema: + type: string + '204': + description: Successful update of the resource. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +patch: + summary: Update the authorization for monitoring for a UE + operationId: UpdateMonitorAuth + tags: + - Update the authorization for monitoring for a UE + security: + - {} + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - n5g-ddnmf-disc:monitor-authorize:modify + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: discEntryId + in: path + description: Discovery Entry Id + required: true + schema: + $ref: '#/components/schemas/DiscoveryEntryId' +``` + +``` +requestBody: + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/MonitorUpdateData' + required: true +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Expected response to a valid request + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '422': + description: Unprocessable Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +callbacks: + onMonitorUpdateResult: + '{request.body#/monitorUpdateResultCallbackRef}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MonitorUpdateResult' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +``` + +``` + + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +onMatchInformation: + '{request.body#/matchInfoCallbackRef}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MatchInformation' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/discovery-authorize/{discEntryId}: + put: + summary: Obtain the authorization from the 5G DDNMF for a discoverer UE in the PLMN to operate +Model B restricted discovery + operationId: ObtainDiscAuth + tags: + - Obtain the authorization for a discoverer UE + security: + - {} + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - n5g-ddnmf-disc:discovery-authorize:modify + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: discEntryId + in: path + description: Discovery Entry Id + +``` + +``` + required: true + schema: + $ref: '#/components/schemas/DiscoveryEntryId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DiscoveryAuthReqData' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/DiscoveryAuthRespData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/n5g-ddnmf-disc>///discovery-authorize/ + required: true + schema: + type: string + '204': + description: Successful update of the resource. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + callbacks: + onMatchInformation: + '{request.body#/matchInfoCallbackRef}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MatchInformation' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/match-report: + post: + summary: Obtain the information about the indicated discovery code from the 5G DDNMF + operationId: MatchReport + tags: + - Obtain the information about the indicated discovery code + security: + - {} + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - n5g-ddnmf-disc:match-report:modify + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MatchReportReqData' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/MatchReportRespData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: +``` + +``` + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oAuth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + n5g-ddnmf-disc: Access to the N5g-ddnmf_Discovery API + n5g-ddnmf-disc:announce-authorize:modify: Access to modify the authorization to announce +for a UE in the PLMN + n5g-ddnmf-disc:monitor-authorize:modify: Access to modify the authorization for +monitoring for an UE in the PLMN + n5g-ddnmf-disc:discovery-authorize:modify: Access to modify the authorization from the +5G DDNMF for a discoverer UE in the PLMN to operate Model B restricted discovery + n5g-ddnmf-disc:match-report:invoke: Access to invoke the information about the indicated +discovery code + +schemas: + +# COMPLEX TYPES: + +AnnounceAuthData: + type: object + description: Represents Data used to request the authorization to announce for a UE + required: + - discType + properties: + discType: + $ref: '#/components/schemas/DiscoveryType' + openDiscData: + $ref: '#/components/schemas/AnnounceDiscDataForOpen' + restrictedDiscData: + $ref: '#/components/schemas/AnnounceDiscDataForRestricted' + +AnnounceDiscDataForOpen: + type: object + description: Represents Data for open discovery used to request the authorization to announce +for a UE + required: + - proseAppId + - validityTime + properties: + proseAppId: + $ref: '#/components/schemas/ProseApplicationId' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + proseAppCode: + $ref: '#/components/schemas/ProseApplicationCode' + proseAppCodePrefix: + $ref: '#/components/schemas/ProseApplicationPrefix' + proseAppCodeSuffixPool: + $ref: '#/components/schemas/ProseApplicationCodeSuffixPool' + metaData: + $ref: '#/components/schemas/MetaData' + +AnnounceDiscDataForRestricted: + type: object + description: Represents Data for restricted discovery used to request the authorization to +announce for a UE + required: + - rpauid + - appId + - validityTime + properties: + rpauid: + $ref: '#/components/schemas/Rpauid' + appId: + $ref: '#/components/schemas/ApplicationId' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + proseRestrictedCode: + $ref: '#/components/schemas/ProseRestrictedCode' + proseRestrictedPrefix: + $ref: '#/components/schemas/ProseRestrictedPrefix' + codeSuffixPool: +``` + +``` +$ref: '#/components/schemas/RestrictedCodeSuffixPool' + +AnnounceUpdateData: + type: object + description: Represents Announce Authorize Data to update + required: + - discType + - validityTime + properties: + discType: + $ref: '#/components/schemas/DiscoveryType' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + proseAppCode: + $ref: '#/components/schemas/ProseApplicationCode' + +MonitorAuthReqData: + type: object + description: Represents Data used to request the authorization to monitor for a UE + required: + - discType + properties: + discType: + $ref: '#/components/schemas/DiscoveryType' + openDiscData: + $ref: '#/components/schemas/MonitorDiscDataForOpen' + restrictedDiscData: + $ref: '#/components/schemas/MonitorDiscDataForRestricted' + +MonitorAuthRespData: + type: object + description: Represents the obtained Monitor Authorize Data for a UE + properties: + authDataOpen: + $ref: '#/components/schemas/MonitorAuthDataForOpen' + authDataRestricted: + $ref: '#/components/schemas/MonitorAuthDataForRestricted' + +MonitorDiscDataForOpen: + type: object + description: Represents Data for open discovery used to request the authorization to monitor +for a UE + required: + - proseAppIdNames + properties: + proseAppIdNames: + type: array + items: + $ref: '#/components/schemas/ProseApplicationIdName' + minItems: 1 + +MonitorDiscDataForRestricted: + type: object + description: Represents Data for restricted discovery used to request the authorization to +monitor for a UE + required: + - rpauid + - targetPduid + - appId + - targetRpauid + properties: + rpauid: + $ref: '#/components/schemas/Rpauid' + targetPduid: + $ref: '#/components/schemas/Pduid' + appId: + $ref: '#/components/schemas/ApplicationId' + targetRpauid: + $ref: '#/components/schemas/Rpauid' + +MonitorAuthDataForOpen: + type: object + description: Represents the obtained Announce Authorize Data for open discovery for a UE + required: + - proseAppMasks + - ttl + properties: + proseAppCodes: +``` + +``` + type: array + items: + $ref: '#/components/schemas/ProseApplicationCode' + minItems: 1 + proseAppPrefix: + $ref: '#/components/schemas/ProseApplicationPrefix' + proseAppMasks: + type: array + items: + $ref: '#/components/schemas/ProseApplicationMask' + minItems: 1 + ttl: + type: integer + +MonitorAuthDataForRestricted: + type: object + description: Represents the obtained Announce Authorize Data for restricted discovery for a UE + required: + - proseRestrictedCode + - validityTime + properties: + proseRestrictedCode: + $ref: '#/components/schemas/ProseRestrictedCode' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +MonitorUpdateData: + type: object + description: Represents Monitor Authorize Data to update. + required: + - discType + properties: + discType: + $ref: '#/components/schemas/DiscoveryType' + openUpdateData: + $ref: '#/components/schemas/MonitorUpdateDataForOpen' + restrictedUpdateData: + $ref: '#/components/schemas/MonitorUpdateDataForRestricted' + +DiscoveryAuthReqData: + type: object + description: Represents Data used to request the authorization for a discoverer UE. + required: + - discType + properties: + discType: + $ref: '#/components/schemas/DiscoveryType' + restrictedDiscData: + $ref: '#/components/schemas/DiscDataForRestricted' + +DiscoveryAuthRespData: + type: object + description: Represents the obtained authorization Data for a discoverer UE + properties: + authDataRestricted: + $ref: '#/components/schemas/AuthDataForRestricted' + +DiscDataForRestricted: + type: object + description: Represents Data for restricted discovery used to request the authorization for a discoverer UE + required: + - rpauid + - targetPduid + - appId + - targetRpauid + properties: + rpauid: + $ref: '#/components/schemas/Rpauid' + targetPduid: + $ref: '#/components/schemas/Pduid' + appId: + $ref: '#/components/schemas/ApplicationId' + targetRpauid: + $ref: '#/components/schemas/Rpauid' + +AuthDataForRestricted: + type: object +``` + +UE + +description: Represents obtained authorization Data for restricted discovery for a discoverer + +required: + +- proseQueryCodes +- proseRespCode +- validityTime + +properties: + +- proseQueryCodes: + - items: + - \$ref: '#/components/schemas/ProseQueryCode' + - minItems: 1 +- proseRespCode: + - \$ref: '#/components/schemas/ProseResponseCode' +- validityTime: + - \$ref: 'TS29571\_CommonData.yaml#/components/schemas/DateTime' + +MatchReportReqData: + +type: object + +description: Represents the Match Report information + +required: + +- discType + +properties: + +- discType: + - \$ref: '#/components/schemas/DiscoveryType' +- proseAppCodes: + - items: + - \$ref: '#/components/schemas/ProseApplicationCode' + - minItems: 1 +- moniteredPlmnId: + - \$ref: 'TS29571\_CommonData.yaml#/components/schemas/PlmnId' + +MatchReportRespData: + +type: object + +description: Represents Match Report Acknowledgement + +properties: + +- proseAppIdNames: + - items: + - \$ref: '#/components/schemas/ProseApplicationIdName' + - minItems: 1 +- validityTime: + - \$ref: 'TS29571\_CommonData.yaml#/components/schemas/DateTime' +- metaData: + - \$ref: '#/components/schemas/MetaData' +- metaDataIndexMasks: + - items: + - \$ref: '#/components/schemas/MetaDataIndexMask' + - minItems: 1 + +MonitorUpdateResult: + +type: object + +description: Represents the monitoring revocation results. + +required: + +- discType +- proseRestrictedCode +- appId +- bannedRpauid +- bannedPduid +- revocationResult + +properties: + +- discType: + - \$ref: '#/components/schemas/DiscoveryType' +- proseRestrictedCode: + - \$ref: '#/components/schemas/ProseRestrictedCode' +- appId: + - \$ref: '#/components/schemas/ApplicationId' +- bannedRpauid: + - \$ref: '#/components/schemas/Rpauid' +- bannedPduid: + - \$ref: '#/components/schemas/Pduid' +- revocationResult: + - \$ref: '#/components/schemas/RevocationResult' + +MatchInformation: + +type: object + +description: > + +Represents a report including a matching result, and the information that can be used for charging purpose. + +required: + +``` + - discType +properties: + discType: + $ref: '#/components/schemas/DiscoveryType' + openMatchInfoForOpen: + $ref: '#/components/schemas/MatchInfoForOpen' + restrictedMatchInfo: + $ref: '#/components/schemas/MatchInfoForRestricted' + +MatchInfoForOpen: + type: object + description: > + Represents a report including a matching result, and the information that + can be used for charging purpose for the open discovery type. + required: + - supi + - appId + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + appId: + items: + $ref: '#/components/schemas/ApplicationId' + minItems: 1 + +MatchInfoForRestricted: + type: object + description: > + Represents a report including a matching result, and the information that + can be used for charging purpose for the restricted discovery type. + required: + - supi + - rpauid + - targetRpauid + - proseRestrictedCode + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + rpauid: + $ref: '#/components/schemas/Rpauid' + targetRpauid: + $ref: '#/components/schemas/Rpauid' + proseRestrictedCode: + $ref: '#/components/schemas/ProseRestrictedCode' + +RestrictedCodeSuffixPool: + type: object + description: Contains the Restricted Code Suffix Pool. + anyOf: + - required: [ codeSuffixList ] + - required: [ codeSuffixRangeList ] + properties: + codeSuffixList: + type: array + items: + $ref: '#/components/schemas/RestrictedCodeSuffix' + minItems: 1 + codeSuffixRangeList: + type: array + items: + $ref: '#/components/schemas/RestrictedCodeSuffixRange' + minItems: 1 + +RestrictedCodeSuffixRange: + type: object + description: Contains a range of the Restricted Code Suffixes which are consecutive. + required: + - beginningSuffix + - endingSuffix + properties: + beginningSuffix: + $ref: '#/components/schemas/RestrictedCodeSuffix' + endingSuffix: + $ref: '#/components/schemas/RestrictedCodeSuffix' + +ProseApplicationCodeSuffixPool: + type: object + description: Contains the Prose Application Code Suffix Pool. +``` + +``` +anyOf: + - required: [ codeSuffix ] + - required: [ codeSuffixRange ] +properties: + codeSuffix: + $ref: '#/components/schemas/ProseAppCodeSuffix' + codeSuffixRange: + $ref: '#/components/schemas/ProseAppCodeSuffixRange' + +ProseAppCodeSuffixRange: + type: object + description: Contains a range of the Prose Application Code Suffixes which are consecutive. + required: + - beginningSuffix + - endingSuffix + properties: + beginningSuffix: + $ref: '#/components/schemas/ProseAppCodeSuffix' + endingSuffix: + $ref: '#/components/schemas/ProseAppCodeSuffix' + +MonitorUpdateDataForOpen: + type: object + description: Represents Monitor Update Data for the Discovery Type "OPEN". + required: + - proseAppIdName + - ttl + properties: + proseAppIdName: + $ref: '#/components/schemas/ProseApplicationIdName' + ttl: + type: integer + minimum: 0 + +MonitorUpdateDataForRestricted: + type: object + description: Represents Monitor Update Data for the Discovery Type "RESTRICTED". + required: + - proseRestrictedCode + - appId + - bannedRpauid + - bannedPduid + properties: + proseRestrictedCode: + $ref: '#/components/schemas/ProseRestrictedCode' + appId: + $ref: '#/components/schemas/ApplicationId' + bannedRpauid: + $ref: '#/components/schemas/Rpauid' + bannedPduid: + $ref: '#/components/schemas/Pduid' + monitorUpdateResultCallbackRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + +# SIMPLE TYPES: +DiscoveryEntryId: + description: Contains the Discovery Entry ID. + type: string + +ProseApplicationId: + description: Contains the ProSe Application ID. + type: string + +ProseApplicationCode: + description: Contains the ProSe Application Code. + type: string + +Rpauid: + description: Contains the RPAUID. + type: string + +ApplicationId: + description: Contains the Application ID. + type: string + +ProseRestrictedCode: +``` + +description: Contains the ProSe Restricted Code. +type: string + +ProseRestrictedPrefix: +description: Contains the ProSe Restricted Code Prefix. +type: string + +MetaData: +description: Contains the metadata. +type: string + +ProseApplicationIdName: +description: Contains the ProSe Application ID name. +type: string + +Pduid: +description: Contains the PDUID. +type: string + +ProseApplicationPrefix: +description: Contains the Prose Application Code Prefix. +type: string + +ProseApplicationMask: +description: Contains the Prose Application Mask. +type: string + +ProseQueryCode: +description: Contains the ProSe Query Code. +type: string + +ProseResponseCode: +description: Contains the ProSe Response Code. +type: string + +MetaDataIndexMask: +description: Contains the Meta Data Index Mask. +type: string + +RestrictedCodeSuffix: +description: Contains the ProSe Restricted Code Suffix. +type: string + +ProseAppCodeSuffix: +description: Contains the ProSe Application Code Suffix. +type: string + +###### # ENUMS: + +DiscoveryType: +anyOf: +- type: string +enum: +- OPEN +- RESTRICTED +- type: string +description: > +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. +description: > +Possible values are +- OPEN: Discovery type is "open". +- RESTRICTED: Discovery type is "restricted". + +RevocationResult: +anyOf: +- type: string +enum: +- SUCCESSFUL +- FAILED +- type: string +description: > +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. +description: > + +Possible values are + +- SUCCESSFUL: The Monitoring Revocation is successful. +- FAILED: The Monitoring Revocation is failed. + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|---------------|-----------|------|-----|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2021-04 | C4#103-e | C4-212597 | | | | Implementation of pCRs agreed in CT4 # 103-e including C4-212149, C4-212151, C4-212455. | | 0.1.0 | +| 2021-06 | C4#104-e | C4-213528 | | | | Implementation of pCRs agreed in CT4#104-e including C4-213188, C4-213207, C4-213338, C4-213340, C4-213341, C4-213342, C4-213455, C4-213457, C4-213463. | | 0.2.0 | +| 2021-09 | C4#105-e | C4-214757 | | | | Implementation of pCRs agreed in CT4#105-e including C4-214266, C4-214267, C4-214268, C4-214269, C4-214433, C4-214435, C4-214436, C4-214437, C4-214438, C4-214439, C4-214441, C4-214442, C4-214604, C4-214605, C4-214830, C4-214832. | | 0.3.0 | +| 2021-10 | C4#105-e | C4-215521 | | | | Implementation of pCRs agreed in CT4#106-e including C4-215097, C4-215353, C4-215448, C4-215449. | | 0.4.0 | +| 2021-12 | CT#94e | CP-213159 | | | | V1.0.0 presented for information | | 1.0.0 | +| 2022-01 | CT4#107-bis-e | C4-220455 | | | | Implementation of pCRs agreed in CT4#107-bis-e including C4-220281 | | 1.1.0 | +| 2022-03 | CT4#108-e | C4-221593 | | | | Implementation of pCRs agreed in CT4#108-e including C4-221337, C4-221349 | | 1.2.0 | +| 2022-03 | CT#95e | CP-220108 | | | | TS presented for information | | 2.0.0 | +| 2022-03 | CT#95e | | | | | TS approved | | 17.0.0 | +| 2022-06 | CT#96 | CP-221043 | 0001 | 1 | F | Correction on the description of RevocationResult | | 17.1.0 | +| 2022-06 | CT#96 | CP-221029 | 0002 | 1 | F | Remove the apiVersion placeholder from the resource URI variables table | | 17.1.0 | +| 2022-06 | CT#96 | CP-221299 | 0003 | 1 | F | 29.555 0003 Rel-17 API version and External doc update | | 17.1.0 | +| 2022-12 | CT#98-e | CP-223028 | 0005 | 1 | F | Missing Mandatory Status Codes in OpenAPI | | 18.0.0 | +| 2022-12 | CT#98-e | CP-223033 | 0006 | - | F | 29.555 Rel-18 API version and External doc update | | 18.0.0 | +| 2023-03 | CT#99 | CP-230067 | 0008 | - | F | Patch Report feature in 5G DDNMF | | 18.1.0 | +| 2023-06 | CT#100 | CP-231026 | 0007 | 3 | F | Location header description | | 18.2.0 | +| 2023-06 | CT#100 | CP-231026 | 0010 | - | B | OAuth2 scopes in the N5g-ddnmf_Discovery API | | 18.2.0 | +| 2023-06 | CT#100 | CP-231070 | 0011 | - | F | 29.555 Rel-18 API version and External doc update | | 18.2.0 | +| 2023-09 | CT#101 | CP-232058 | 0012 | - | F | validityTimer attribute correction | | 18.3.0 | +| 2023-12 | CT#102 | CP-233028 | 0013 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9113 | | 18.4.0 | +| 2023-12 | CT#102 | CP-233030 | 0015 | - | F | ProblemDetails RFC 7807 obsoleted by 9457 | | 18.4.0 | +| 2023-12 | CT#102 | CP-233062 | 0017 | 1 | A | Corrections on Announce Auth | | 18.4.0 | +| 2023-12 | CT#102 | CP-233060 | 0018 | - | F | 29.555 Rel-18 API version and External doc update | | 18.4.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29562/raw.md b/marked/Rel-18/29_series/29562/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..cc5cca5cafbce98e88960ee08aa1145340a6295a --- /dev/null +++ b/marked/Rel-18/29_series/29562/raw.md @@ -0,0 +1,15165 @@ + + +# 3GPP TS 29.562 V18.3.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Home Subscriber Server (HSS) Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, stylized font with a red signal wave icon below the 'P', and the text 'A GLOBAL INITIATIVE' underneath. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------------|----| +| Foreword..... | 12 | +| 1 Scope..... | 13 | +| 2 References..... | 13 | +| 3 Definitions of terms, symbols and abbreviations..... | 15 | +| 3.1 Terms..... | 15 | +| 3.2 Symbols..... | 16 | +| 3.3 Abbreviations..... | 16 | +| 4 Overview..... | 16 | +| 4.1 Introduction..... | 16 | +| 5 Services offered by the HSS..... | 17 | +| 5.1 Introduction..... | 17 | +| 5.2 Nhss_imsUEContextManagement Service..... | 18 | +| 5.2.1 Service Description..... | 18 | +| 5.2.2 Service Operations..... | 18 | +| 5.2.2.1 Introduction..... | 18 | +| 5.2.2.2 Registration..... | 19 | +| 5.2.2.2.1 General..... | 19 | +| 5.2.2.2.2 S-CSCF Registration..... | 19 | +| 5.2.2.3 DeregistrationNotification..... | 20 | +| 5.2.2.3.1 General..... | 20 | +| 5.2.2.3.2 HSS initiated Deregistration..... | 20 | +| 5.2.2.4 Deregistration..... | 21 | +| 5.2.2.4.1 General..... | 21 | +| 5.2.2.4.2 S-CSCF deregistration..... | 21 | +| 5.2.2.5 Authorize..... | 21 | +| 5.2.2.5.1 General..... | 21 | +| 5.2.2.5.2 Authorization request..... | 22 | +| 5.2.2.6 RestorationInfoGet..... | 22 | +| 5.2.2.6.1 General..... | 22 | +| 5.2.2.6.2 Restoration Information Retrieval..... | 22 | +| 5.2.2.7 RestorationInfoUpdate..... | 23 | +| 5.2.2.7.1 General..... | 23 | +| 5.2.2.7.2 Restoration Information Update..... | 23 | +| 5.2.2.8 RestorationInfoDelete..... | 24 | +| 5.2.2.8.1 General..... | 24 | +| 5.2.2.8.2 Restoration Information Delete..... | 24 | +| 5.3 Nhss_imsSubscriberDataManagement Service..... | 25 | +| 5.3.1 Service Description..... | 25 | +| 5.3.2 Service Operations..... | 25 | +| 5.3.2.1 Introduction..... | 25 | +| 5.3.2.2 Get..... | 26 | +| 5.3.2.2.1 General..... | 26 | +| 5.3.2.2.2 Identity Data..... | 26 | +| 5.3.2.2.3 IMS Location Data and Status..... | 29 | +| 5.3.2.2.4 IMS Profile Data..... | 31 | +| 5.3.2.2.5 Access Data..... | 34 | +| 5.3.2.2.6 SRVCC Data..... | 38 | +| 5.3.2.2.7 Service Data..... | 38 | +| 5.3.2.2.8 Repository Data..... | 40 | +| 5.3.2.2.9 Shared Subscription Data..... | 41 | +| 5.3.2.3 Subscribe..... | 42 | +| 5.3.2.3.1 General..... | 42 | +| 5.3.2.3.2 Subscription to notifications of data change..... | 42 | +| 5.3.2.3.3 Subscription to notifications of shared data change..... | 43 | +| 5.3.2.3.4 Subscriptions to notification of UE Reachability for IP..... | 43 | + +| | | | +|-----------|----------------------------------------------------------------------------|----| +| 5.3.2.4 | Unsubscribe..... | 44 | +| 5.3.2.4.1 | General..... | 44 | +| 5.3.2.4.2 | Unsubscribe to notifications of data change..... | 44 | +| 5.3.2.4.3 | Unsubscribe to notifications of shared data change..... | 45 | +| 5.3.2.4.4 | Unsubscribe to notification of UE Reachability for IP..... | 46 | +| 5.3.2.5 | ModifySubscription..... | 46 | +| 5.3.2.5.1 | General..... | 46 | +| 5.3.2.5.2 | Modification of a subscription to notifications of data change..... | 46 | +| 5.3.2.5.3 | Modification of a subscription to notifications of shared data change..... | 47 | +| 5.3.2.5.4 | Modification of a subscription to notifications of data change..... | 48 | +| 5.3.2.6 | Notification..... | 48 | +| 5.3.2.6.1 | General..... | 48 | +| 5.3.2.6.2 | Data Change Notification To NF..... | 48 | +| 5.3.2.6.3 | UE Reachability for IP Notification to NF..... | 49 | +| 5.3.2.7 | Update..... | 49 | +| 5.3.2.7.1 | General..... | 49 | +| 5.3.2.7.2 | Repository Data Creation or Update..... | 50 | +| 5.3.2.7.3 | Repository Data Deletion..... | 50 | +| 5.3.2.7.4 | STN-SR update..... | 51 | +| 5.3.2.7.5 | PSI activation state update..... | 52 | +| 5.3.2.7.6 | SMS Registration Information Creation or Update..... | 52 | +| 5.3.2.7.7 | SMS Registration Information Deletion..... | 53 | +| 5.3.2.7.8 | DSAI tag activation state update..... | 53 | +| 5.4 | Nhss_imsUEAuthentication Service..... | 54 | +| 5.4.1 | Service Description..... | 54 | +| 5.4.2 | Service Operations..... | 54 | +| 5.4.2.1 | Introduction..... | 54 | +| 5.4.2.2 | Get..... | 54 | +| 5.4.2.2.1 | General..... | 54 | +| 5.4.2.2.2 | Authentication Information Retrieval..... | 55 | +| 5.5 | Nhss_gbaSubscriberDataManagement Service..... | 55 | +| 5.5.1 | Service Description..... | 55 | +| 5.5.2 | Service Operations..... | 55 | +| 5.5.2.1 | Introduction..... | 55 | +| 5.5.2.2 | Get..... | 56 | +| 5.5.2.2.1 | General..... | 56 | +| 5.5.2.2.2 | Retrieval of GBA subscriber data..... | 56 | +| 5.5.2.3 | Subscribe..... | 56 | +| 5.5.2.3.1 | General..... | 56 | +| 5.5.2.3.2 | Subscription to changes on the GBA subscriber data..... | 56 | +| 5.5.2.4 | Unsubscribe..... | 57 | +| 5.5.2.4.1 | General..... | 57 | +| 5.5.2.4.2 | Unsubscribe to changes on the GBA subscriber data..... | 57 | +| 5.5.2.5 | Modification of Subscription..... | 58 | +| 5.5.2.5.1 | General..... | 58 | +| 5.5.2.5.2 | Modification of Subscription to changes on the GBA subscriber data..... | 58 | +| 5.5.2.5 | Notify..... | 59 | +| 5.5.2.5.1 | General..... | 59 | +| 5.5.2.5.2 | Notification of changes on the GBA subscriber data..... | 59 | +| 5.6 | Nhss_gbaUEAuthentication Service..... | 59 | +| 5.6.1 | Service Description..... | 59 | +| 5.6.2 | Service Operations..... | 59 | +| 5.6.2.1 | Introduction..... | 59 | +| 5.6.2.2 | Get..... | 60 | +| 5.6.2.2.1 | General..... | 60 | +| 5.6.2.2.2 | Request UE authentication data..... | 60 | +| 6 | API Definitions..... | 60 | +| 6.1 | Nhss_imsUEContextManagement Service API..... | 60 | +| 6.1.1 | Introduction..... | 60 | +| 6.1.2 | Usage of HTTP..... | 61 | +| 6.1.2.1 | General..... | 61 | + +| | | | +|------------|---------------------------------------------------------------------------------|----| +| 6.1.2.2 | HTTP standard headers..... | 61 | +| 6.1.2.2.1 | General..... | 61 | +| 6.1.2.2.2 | Content type..... | 61 | +| 6.1.2.3 | HTTP custom headers..... | 61 | +| 6.1.2.3.1 | General..... | 61 | +| 6.1.3 | Resources..... | 62 | +| 6.1.3.1 | Overview..... | 62 | +| 6.1.3.2 | Resource: Scscf Registration..... | 62 | +| 6.1.3.2.1 | Description..... | 62 | +| 6.1.3.2.2 | Resource Definition..... | 62 | +| 6.1.3.2.3 | Resource Standard Methods..... | 63 | +| 6.1.3.2.4 | Resource Custom Operations..... | 64 | +| 6.1.3.3 | Resource: Scscf Restoration Information..... | 64 | +| 6.1.3.3.1 | Description..... | 64 | +| 6.1.3.3.2 | Resource Definition..... | 64 | +| 6.1.3.3.3 | Resource Standard Methods..... | 65 | +| 6.1.4 | Custom Operations without associated resources..... | 68 | +| 6.1.4.1 | Overview..... | 68 | +| 6.1.4.2 | Operation: Authorize..... | 68 | +| 6.1.4.2.1 | Description..... | 68 | +| 6.1.4.2.2 | Operation Definition..... | 68 | +| 6.1.5 | Notifications..... | 69 | +| 6.1.5.1 | General..... | 69 | +| 6.1.5.2 | Deregistration Notification..... | 69 | +| 6.1.6 | Data Model..... | 70 | +| 6.1.6.1 | General..... | 70 | +| 6.1.6.2 | Structured data types..... | 71 | +| 6.1.6.2.1 | Introduction..... | 71 | +| 6.1.6.2.2 | Type: AuthorizationRequest..... | 72 | +| 6.1.6.2.3 | Type: AuthorizationResponse..... | 72 | +| 6.1.6.2.4 | Type: ScscfRestorationInfo..... | 72 | +| 6.1.6.2.5 | Type: ScscfRestorationInfoRequest..... | 73 | +| 6.1.6.2.6 | Type: ScscfRestorationInfoResponse..... | 73 | +| 6.1.6.2.7 | Type: RestorationInfo..... | 73 | +| 6.1.6.2.8 | Type: UeSubscriptionInfo..... | 73 | +| 6.1.6.2.9 | Type: PscsfSubscriptionInfo..... | 74 | +| 6.1.6.2.10 | Type: ScscfRegistration..... | 75 | +| 6.1.6.2.11 | Type: ExtendedProblemDetails..... | 77 | +| 6.1.6.2.12 | Type: AdditionalInfo..... | 77 | +| 6.1.6.2.13 | Type: DeregistrationData..... | 78 | +| 6.1.6.2.14 | Type: DeregistrationReason..... | 78 | +| 6.1.6.2.15 | Type: EmergencyRegisteredIdentity..... | 78 | +| 6.1.6.3 | Simple data types and enumerations..... | 78 | +| 6.1.6.3.1 | Introduction..... | 78 | +| 6.1.6.3.2 | Simple data types..... | 78 | +| 6.1.6.3.3 | Enumeration: AuthorizationType..... | 79 | +| 6.1.6.3.4 | Enumeration: AuthorizationResult..... | 79 | +| 6.1.6.3.5 | Enumeration: ImsRegistrationType..... | 79 | +| 6.1.6.3.6 | Enumeration: LooseRouteIndication..... | 79 | +| 6.1.6.3.7 | Enumeration: DeregistrationReasonCode..... | 80 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types..... | 80 | +| 6.1.7 | Error Handling..... | 81 | +| 6.1.7.1 | General..... | 81 | +| 6.1.7.2 | Protocol Errors..... | 81 | +| 6.1.7.3 | Application Errors..... | 81 | +| 6.1.8 | Feature negotiation..... | 81 | +| 6.1.9 | Security..... | 81 | +| 6.1.10 | HTTP redirection..... | 82 | +| 6.2 | Nhss_imsSubscriberDataManagement Service API..... | 82 | +| 6.2.1 | API URI..... | 82 | +| 6.2.2 | Usage of HTTP..... | 82 | + +| | | | +|------------|----------------------------------------------------|-----| +| 6.2.2.1 | General..... | 82 | +| 6.2.2.2 | HTTP standard headers..... | 82 | +| 6.2.2.2.1 | General..... | 82 | +| 6.2.2.2.2 | Content type..... | 82 | +| 6.2.2.3 | HTTP custom headers..... | 83 | +| 6.2.2.3.1 | General..... | 83 | +| 6.2.3 | Resources..... | 84 | +| 6.2.3.1 | Overview..... | 84 | +| 6.2.3.2 | Resource: IMS Associated Identities..... | 87 | +| 6.2.3.2.1 | Description..... | 87 | +| 6.2.3.2.2 | Resource Definition..... | 88 | +| 6.2.3.2.3 | Resource Standard Methods..... | 88 | +| 6.2.3.3 | Resource: MSISDNS..... | 89 | +| 6.2.3.3.1 | Description..... | 89 | +| 6.2.3.3.2 | Resource Definition..... | 89 | +| 6.2.3.3.3 | Resource Standard Methods..... | 89 | +| 6.2.3.4 | Resource: S-CSCF Capabilities..... | 90 | +| 6.2.3.4.1 | Description..... | 90 | +| 6.2.3.4.2 | Resource Definition..... | 91 | +| 6.2.3.4.3 | Resource Standard Methods..... | 91 | +| 6.2.3.5 | Resource: IMS Profile Data..... | 92 | +| 6.2.3.5.1 | Description..... | 92 | +| 6.2.3.5.2 | Resource Definition..... | 92 | +| 6.2.3.5.3 | Resource Standard Methods..... | 92 | +| 6.2.3.6 | Resource: Subscriptions..... | 94 | +| 6.2.3.6.1 | Description..... | 94 | +| 6.2.3.6.2 | Resource Definition..... | 94 | +| 6.2.3.6.3 | Resource Standard Methods..... | 94 | +| 6.2.3.7 | Resource: Individual subscription..... | 95 | +| 6.2.3.7.1 | Description..... | 95 | +| 6.2.3.7.2 | Resource Definition..... | 96 | +| 6.2.3.7.3 | Resource Standard Methods..... | 96 | +| 6.2.3.8 | Resource: SharedDataSubscriptions..... | 98 | +| 6.2.3.8.1 | Description..... | 98 | +| 6.2.3.8.2 | Resource Definition..... | 98 | +| 6.2.3.8.3 | Resource Standard Methods..... | 99 | +| 6.2.3.9 | Resource: Shared Data Individual subscription..... | 100 | +| 6.2.3.9.1 | Description..... | 100 | +| 6.2.3.9.2 | Resource Definition..... | 100 | +| 6.2.3.9.3 | Resource Standard Methods..... | 100 | +| 6.2.3.10 | Resource: IMS Registration Status..... | 102 | +| 6.2.3.10.1 | Description..... | 102 | +| 6.2.3.10.2 | Resource Definition..... | 103 | +| 6.2.3.10.3 | Resource Standard Methods..... | 103 | +| 6.2.3.11 | Resource: Service Priority Information..... | 104 | +| 6.2.3.11.1 | Description..... | 104 | +| 6.2.3.11.2 | Resource Definition..... | 104 | +| 6.2.3.11.3 | Resource Standard Methods..... | 104 | +| 6.2.3.12 | Resource: Initial Filter Criteria..... | 105 | +| 6.2.3.12.1 | Description..... | 105 | +| 6.2.3.12.2 | Resource Definition..... | 105 | +| 6.2.3.12.3 | Resource Standard Methods..... | 106 | +| 6.2.3.13 | Resource: IMS Location Data..... | 107 | +| 6.2.3.13.1 | Description..... | 107 | +| 6.2.3.13.2 | Resource Definition..... | 107 | +| 6.2.3.13.3 | Resource Standard Methods..... | 107 | +| 6.2.3.14 | Resource: Service Level Trace Information..... | 108 | +| 6.2.3.14.1 | Description..... | 108 | +| 6.2.3.14.2 | Resource Definition..... | 108 | +| 6.2.3.14.3 | Resource Standard Methods..... | 109 | +| 6.2.3.15 | Resource: PS location Information..... | 110 | + +| | | | +|------------|--------------------------------------------------------|-----| +| 6.2.3.15.1 | Description..... | 110 | +| 6.2.3.15.2 | Resource Definition..... | 110 | +| 6.2.3.15.3 | Resource Standard Methods..... | 110 | +| 6.2.3.16 | Resource: CS location Information..... | 112 | +| 6.2.3.16.1 | Description..... | 112 | +| 6.2.3.16.2 | Resource Definition..... | 112 | +| 6.2.3.16.3 | Resource Standard Methods..... | 113 | +| 6.2.3.17 | Resource: SRVCC data..... | 114 | +| 6.2.3.17.1 | Description..... | 114 | +| 6.2.3.17.2 | Resource Definition..... | 114 | +| 6.2.3.17.3 | Resource Standard Methods..... | 115 | +| 6.2.3.18 | Resource: PSI activation state..... | 117 | +| 6.2.3.18.1 | Description..... | 117 | +| 6.2.3.18.2 | Resource Definition..... | 118 | +| 6.2.3.18.3 | Resource Standard Methods..... | 118 | +| 6.2.3.19 | Resource: Repository Data..... | 120 | +| 6.2.3.19.1 | Description..... | 120 | +| 6.2.3.19.2 | Resource Definition..... | 120 | +| 6.2.3.19.3 | Resource Standard Methods..... | 121 | +| 6.2.3.20 | Resource: SharedData..... | 125 | +| 6.2.3.20.1 | Description..... | 125 | +| 6.2.3.20.2 | Resource Definition..... | 125 | +| 6.2.3.20.3 | Resource Standard Methods..... | 125 | +| 6.2.3.21 | Resource: ImeiSvInformation..... | 126 | +| 6.2.3.21.1 | Description..... | 126 | +| 6.2.3.21.2 | Resource Definition..... | 126 | +| 6.2.3.21.3 | Resource Standard Methods..... | 126 | +| 6.2.3.22 | Resource: IP Address..... | 128 | +| 6.2.3.22.1 | Description..... | 128 | +| 6.2.3.22.2 | Resource Definition..... | 128 | +| 6.2.3.22.3 | Resource Standard Methods..... | 128 | +| 6.2.3.23 | Resource: T-ADS Info..... | 129 | +| 6.2.3.23.1 | Description..... | 129 | +| 6.2.3.23.2 | Resource Definition..... | 129 | +| 6.2.3.23.3 | Resource Standard Methods..... | 130 | +| 6.2.3.24 | Resource: UeReachabilitySubscriptions..... | 131 | +| 6.2.3.24 | Description..... | 131 | +| 6.2.3.24.2 | Resource Definition..... | 131 | +| 6.2.3.24.3 | Resource Standard Methods..... | 131 | +| 6.2.3.25 | Resource: UE reachability Individual subscription..... | 133 | +| 6.2.3.25.1 | Description..... | 133 | +| 6.2.3.25.2 | Resource Definition..... | 133 | +| 6.2.3.25.3 | Resource Standard Methods..... | 133 | +| 6.2.3.26 | Resource: PS User State..... | 136 | +| 6.2.3.26.1 | Description..... | 136 | +| 6.2.3.26.2 | Resource Definition..... | 136 | +| 6.2.3.26.3 | Resource Standard Methods..... | 136 | +| 6.2.3.27 | Resource: CS User State..... | 137 | +| 6.2.3.27.1 | Description..... | 137 | +| 6.2.3.27.2 | Resource Definition..... | 137 | +| 6.2.3.27.3 | Resource Standard Methods..... | 138 | +| 6.2.3.28 | Resource: Csrn..... | 139 | +| 6.2.3.28.1 | Description..... | 139 | +| 6.2.3.28.2 | Resource Definition..... | 139 | +| 6.2.3.28.3 | Resource Standard Methods..... | 139 | +| 6.2.3.29 | Resource: ReferenceAccessLocation..... | 141 | +| 6.2.3.29.1 | Description..... | 141 | +| 6.2.3.29.2 | Resource Definition..... | 141 | +| 6.2.3.29.3 | Resource Standard Methods..... | 141 | +| 6.2.3.30 | Resource: SMSRegistrationInfo..... | 143 | +| 6.2.3.30.1 | Description..... | 143 | + +| | | | +|------------|--------------------------------------------------------|-----| +| 6.2.3.30.2 | Resource Definition..... | 143 | +| 6.2.3.30.3 | Resource Standard Methods..... | 143 | +| 6.2.3.31 | Resource: Dsai..... | 147 | +| 6.2.3.31.1 | Description..... | 147 | +| 6.2.3.31.2 | Resource Definition..... | 147 | +| 6.2.3.31.3 | Resource Standard Methods..... | 148 | +| 6.2.3.32 | Resource: Private Identities..... | 150 | +| 6.2.3.32.1 | Description..... | 150 | +| 6.2.3.32.2 | Resource Definition..... | 150 | +| 6.2.3.32.3 | Resource Standard Methods..... | 151 | +| 6.2.3.33 | Resource: S-CSCF Selection Assistance Information..... | 152 | +| 6.2.3.33.1 | Description..... | 152 | +| 6.2.3.33.2 | Resource Definition..... | 152 | +| 6.2.3.33.3 | Resource Standard Methods..... | 152 | +| 6.2.3.34 | Resource: Charging Information..... | 153 | +| 6.2.3.34.1 | Description..... | 153 | +| 6.2.3.34.2 | Resource Definition..... | 153 | +| 6.2.3.34.3 | Resource Standard Methods..... | 154 | +| 6.2.3.35 | Resource: Repository Data List..... | 154 | +| 6.2.3.35.1 | Description..... | 154 | +| 6.2.3.35.2 | Resource Definition..... | 154 | +| 6.2.3.35.3 | Resource Standard Methods..... | 155 | +| 6.2.5 | Notifications..... | 156 | +| 6.2.5.1 | General..... | 156 | +| 6.2.5.2 | Data Change Notification..... | 156 | +| 6.2.6 | Data Model..... | 157 | +| 6.2.6.1 | General..... | 157 | +| 6.2.6.2 | Structured data types..... | 160 | +| 6.2.6.2.1 | Introduction..... | 160 | +| 6.2.6.2.2 | Type: ScscfCapabilityList..... | 160 | +| 6.2.6.2.3 | Type: Capabilities..... | 161 | +| 6.2.6.2.4 | Type: ImsProfileData..... | 161 | +| 6.2.6.2.5 | Type: SharedData..... | 161 | +| 6.2.6.2.6 | Type: ImsDataSets..... | 161 | +| 6.2.6.2.7 | Type: RepositoryData..... | 161 | +| 6.2.6.2.8 | Type: MsisdnList..... | 162 | +| 6.2.6.2.9 | Type: PublicIdentities..... | 162 | +| 6.2.6.2.10 | Type: PublicIdentity..... | 162 | +| 6.2.6.2.11 | Type: ImsSdmSubscription..... | 162 | +| 6.2.6.2.12 | Type: ImsRegistrationStatus..... | 163 | +| 6.2.6.2.13 | Type: PriorityLevels..... | 163 | +| 6.2.6.2.14 | Type: Ifcs..... | 163 | +| 6.2.6.2.15 | Type: Ifc..... | 163 | +| 6.2.6.2.16 | Type: TriggerPoint..... | 164 | +| 6.2.6.2.17 | Type: Spt..... | 164 | +| 6.2.6.2.18 | Type: HeaderSipRequest..... | 165 | +| 6.2.6.2.19 | Type: SdpDescription..... | 165 | +| 6.2.6.2.20 | Type: ApplicationServer..... | 165 | +| 6.2.6.2.21 | Type: ImsLocationData..... | 165 | +| 6.2.6.2.22 | Type: ServiceLevelTraceInformation..... | 166 | +| 6.2.6.2.23 | Type: PsLocation..... | 166 | +| 6.2.6.2.24 | Type: SgsnLocationData..... | 166 | +| 6.2.6.2.25 | Type: MmeLocationData..... | 166 | +| 6.2.6.2.26 | Type: AmfLocationData..... | 167 | +| 6.2.6.2.27 | Type: TwanLocationData..... | 167 | +| 6.2.6.2.28 | Type: CsLocation..... | 167 | +| 6.2.6.2.29 | Type: CsgInformation..... | 168 | +| 6.2.6.2.30 | Type: SrvccData..... | 168 | +| 6.2.6.2.31 | Type: PsiActivationState..... | 168 | +| 6.2.6.2.32 | Type: ImsServiceProfile..... | 168 | +| 6.2.6.2.33 | Type: PublicIdentifier..... | 169 | + +| | | | +|------------|------------------------------------------------|-----| +| 6.2.6.2.34 | Type: ImeiSvInformation..... | 169 | +| 6.2.6.2.35 | Void..... | 169 | +| 6.2.6.2.36 | Type: TadsInformation..... | 169 | +| 6.2.6.2.37 | Type: UeReachabilitySubscription..... | 169 | +| 6.2.6.2.38 | Type: UeReachabilityNotification..... | 170 | +| 6.2.6.2.39 | Type: PsUserState..... | 170 | +| 6.2.6.2.40 | Type: CsUserState..... | 170 | +| 6.2.6.2.41 | Type: Csrn..... | 170 | +| 6.2.6.2.42 | Type: ReferenceLocationInformation..... | 170 | +| 6.2.6.2.43 | Type: SmsRegistrationInfo..... | 171 | +| 6.2.6.2.44 | Type: IpSmGwAddress..... | 171 | +| 6.2.6.2.45 | Type: ImsAssociatedIdentities..... | 171 | +| 6.2.6.2.46 | Type: DsaiTagInformation..... | 171 | +| 6.2.6.2.47 | Type: DsaiTagStatus..... | 171 | +| 6.2.6.2.48 | Type: CreatedUeReachabilitySubscription..... | 172 | +| 6.2.6.2.49 | Type: PrivateIdentities..... | 172 | +| 6.2.6.2.50 | Type: PrivateIdentity..... | 172 | +| 6.2.6.2.51 | Type: SscfSelectionAssistanceInformation..... | 172 | +| 6.2.6.2.52 | Type: ChargingInfo..... | 172 | +| 6.2.6.2.53 | Type: RepositoryDataList..... | 173 | +| 6.2.6.2.54 | Type: CoreNetworkServiceAuthorization..... | 173 | +| 6.2.6.3 | Simple data types and enumerations..... | 173 | +| 6.2.6.3.1 | Introduction..... | 173 | +| 6.2.6.3.2 | Simple data types..... | 173 | +| 6.2.6.3.3 | Enumeration: DataSetName..... | 174 | +| 6.2.6.3.4 | Enumeration: IdentityType..... | 174 | +| 6.2.6.3.5 | Enumeration: ImsRegistrationState..... | 175 | +| 6.2.6.3.6 | Enumeration: TypeOfCondition..... | 175 | +| 6.2.6.3.7 | Enumeration: RegistrationType..... | 175 | +| 6.2.6.3.8 | Enumeration: RequestDirection..... | 175 | +| 6.2.6.3.9 | Enumeration: ServiceInformation..... | 176 | +| 6.2.6.3.10 | Enumeration: RequestedNode..... | 176 | +| 6.2.6.3.11 | Enumeration: SrvccCapability..... | 176 | +| 6.2.6.3.12 | Enumeration: ActivationState..... | 176 | +| 6.2.6.3.13 | Enumeration: ImsVoiceOverPsSessionSupport..... | 177 | +| 6.2.6.3.14 | Enumeration: AccessType..... | 177 | +| 6.2.6.3.15 | Enumeration: UserStatePs..... | 177 | +| 6.2.6.3.16 | Enumeration: UserStateCs..... | 177 | +| 6.2.6.3.17 | Enumeration: PrivateIdentityType..... | 178 | +| 6.2.7 | Error Handling..... | 178 | +| 6.2.7.1 | General..... | 178 | +| 6.2.7.2 | Protocol Errors..... | 178 | +| 6.2.7.3 | Application Errors..... | 178 | +| 6.2.8 | Feature negotiation..... | 178 | +| 6.2.9 | Security..... | 179 | +| 6.2.10 | HTTP redirection..... | 180 | +| 6.3 | Nhss_imsUEAuthentication Service API..... | 181 | +| 6.3.1 | API URI..... | 181 | +| 6.3.2 | Usage of HTTP..... | 181 | +| 6.3.2.1 | General..... | 181 | +| 6.3.2.2 | HTTP standard headers..... | 181 | +| 6.3.2.2.1 | General..... | 181 | +| 6.3.2.2.2 | Content type..... | 181 | +| 6.3.2.3 | HTTP custom headers..... | 181 | +| 6.3.2.3.1 | General..... | 181 | +| 6.3.3 | Resources..... | 182 | +| 6.3.3.1 | Overview..... | 182 | +| 6.3.3.2 | Resource: SecurityInformation..... | 182 | +| 6.3.3.2.1 | Description..... | 182 | +| 6.3.3.2.2 | Resource Definition..... | 182 | +| 6.3.3.2.3 | Resource Standard Methods..... | 183 | + +| | | | +|-----------|-----------------------------------------------------|-----| +| 6.3.3.2.4 | Resource Custom Operations..... | 183 | +| 6.3.4 | Custom Operations without associated resources..... | 184 | +| 6.3.5 | Notifications..... | 184 | +| 6.3.6 | Data Model..... | 184 | +| 6.3.6.1 | General..... | 184 | +| 6.3.6.2 | Structured data types..... | 185 | +| 6.3.6.2.1 | Introduction..... | 185 | +| 6.3.6.2.2 | Type: SipAuthenticationInfoRequest..... | 185 | +| 6.3.6.2.3 | Type: SipAuthenticationInfoResult..... | 185 | +| 6.3.6.2.4 | Type: ResynchronizationInfo..... | 186 | +| 6.3.6.2.5 | Type: 3GAkaAv..... | 186 | +| 6.3.6.2.6 | Type: DigestAuthentication..... | 186 | +| 6.3.6.2.7 | Void..... | 186 | +| 6.3.6.3 | Simple data types and enumerations..... | 186 | +| 6.3.6.3.1 | Introduction..... | 186 | +| 6.3.6.3.2 | Simple data types..... | 186 | +| 6.3.6.3.3 | Enumeration: SipAuthenticationScheme..... | 186 | +| 6.3.6.3.4 | Enumeration: SipDigestAlgorithm..... | 187 | +| 6.3.6.3.5 | Enumeration: SipDigestQop..... | 187 | +| 6.3.7 | Error Handling..... | 187 | +| 6.3.7.1 | General..... | 187 | +| 6.3.7.2 | Protocol Errors..... | 187 | +| 6.3.7.3 | Application Errors..... | 187 | +| 6.3.8 | Feature Negotiation..... | 188 | +| 6.3.9 | Security..... | 188 | +| 6.3.10 | HTTP redirection..... | 188 | +| 6.4 | Nhss_gbaSubscriberDataManagement Service API..... | 188 | +| 6.4.1 | API URI..... | 188 | +| 6.4.2 | Usage of HTTP..... | 188 | +| 6.4.2.1 | General..... | 188 | +| 6.4.2.2 | HTTP standard headers..... | 189 | +| 6.4.2.2.1 | General..... | 189 | +| 6.4.2.2.2 | Content type..... | 189 | +| 6.4.2.3 | HTTP custom headers..... | 189 | +| 6.4.2.3.1 | General..... | 189 | +| 6.4.3 | Resources..... | 189 | +| 6.4.3.1 | Overview..... | 189 | +| 6.4.3.2 | Resource: GBA Subscriber Data..... | 190 | +| 6.4.3.2.1 | Description..... | 190 | +| 6.4.3.2.2 | Resource Definition..... | 190 | +| 6.4.3.2.3 | Resource Standard Methods..... | 190 | +| 6.4.3.3 | Resource: Subscriptions..... | 191 | +| 6.4.3.3.1 | Description..... | 191 | +| 6.4.3.3.2 | Resource Definition..... | 191 | +| 6.4.3.3.3 | Resource Standard Methods..... | 192 | +| 6.4.3.4 | Resource: Individual subscription..... | 193 | +| 6.4.3.4.1 | Description..... | 193 | +| 6.4.3.4.2 | Resource Definition..... | 193 | +| 6.4.3.4.3 | Resource Standard Methods..... | 193 | +| 6.4.4 | Custom Operations without associated resources..... | 195 | +| 6.4.5 | Notifications..... | 195 | +| 6.4.5.1 | General..... | 195 | +| 6.4.5.2 | Data Change Notification..... | 196 | +| 6.4.6 | Data Model..... | 197 | +| 6.4.6.1 | General..... | 197 | +| 6.4.6.2 | Structured data types..... | 197 | +| 6.4.6.2.1 | Introduction..... | 197 | +| 6.4.6.2.2 | Type: GbaSubscriberData..... | 197 | +| 6.4.6.2.3 | Type: Guss..... | 197 | +| 6.4.6.2.4 | Type: BsfInfo..... | 198 | +| 6.4.6.2.5 | Type: GbaSdmSubscription..... | 198 | + +| | | | +|-----------|-------------------------------------------------------|-----| +| 6.4.6.3 | Simple data types and enumerations..... | 198 | +| 6.4.6.3.1 | Introduction..... | 198 | +| 6.4.6.3.2 | Simple data types..... | 198 | +| 6.4.6.3.3 | Enumeration: UiccType..... | 198 | +| 6.4.7 | Error Handling..... | 199 | +| 6.4.7.1 | General..... | 199 | +| 6.4.7.2 | Protocol Errors..... | 199 | +| 6.4.7.3 | Application Errors..... | 199 | +| 6.4.8 | Feature Negotiation..... | 199 | +| 6.4.9 | Security..... | 199 | +| 6.4.10 | HTTP redirection..... | 200 | +| 6.5 | Nhss_gbaUEAuthentication Service API..... | 200 | +| 6.5.1 | API URI..... | 200 | +| 6.5.2 | Usage of HTTP..... | 200 | +| 6.5.2.1 | General..... | 200 | +| 6.5.2.2 | HTTP standard headers..... | 200 | +| 6.5.2.2.1 | General..... | 200 | +| 6.5.2.2.2 | Content type..... | 200 | +| 6.5.2.3 | HTTP custom headers..... | 200 | +| 6.5.2.3.1 | General..... | 200 | +| 6.5.3 | Resources..... | 201 | +| 6.5.3.1 | Overview..... | 201 | +| 6.5.3.2 | Resource: SecurityInformation (Custom Operation)..... | 201 | +| 6.5.3.2.1 | Description..... | 201 | +| 6.5.3.2.2 | Resource Definition..... | 201 | +| 6.5.3.2.3 | Resource Standard Methods..... | 201 | +| 6.5.3.2.3 | Resource Custom Operations..... | 202 | +| 6.5.5 | Notifications..... | 203 | +| 6.5.6 | Data Model..... | 203 | +| 6.5.6.1 | General..... | 203 | +| 6.5.6.2 | Structured data types..... | 203 | +| 6.5.6.2.1 | Introduction..... | 203 | +| 6.5.6.2.2 | Type: AuthenticationInfoRequest..... | 204 | +| 6.5.6.2.3 | Type: AuthenticationInfoResult..... | 204 | +| 6.5.6.2.4 | Void..... | 204 | +| 6.5.6.2.5 | Void..... | 204 | +| 6.5.6.2.6 | Type: DigestAuthentication..... | 204 | +| 6.5.6.3 | Simple data types and enumerations..... | 204 | +| 6.5.6.3.1 | Introduction..... | 204 | +| 6.5.6.3.2 | Simple data types..... | 204 | +| 6.5.6.3.3 | Enumeration: AuthenticationScheme..... | 204 | +| 6.5.6.3.4 | Enumeration: DigestAlgorithm..... | 205 | +| 6.5.6.3.5 | Enumeration: DigestQop..... | 205 | +| 6.5.7 | Error Handling..... | 205 | +| 6.5.7.1 | General..... | 205 | +| 6.5.7.2 | Protocol Errors..... | 205 | +| 6.5.7.3 | Application Errors..... | 205 | +| 6.5.8 | Feature Negotiation..... | 205 | +| 6.5.9 | Security..... | 206 | +| 6.5.10 | HTTP redirection..... | 206 | + +| | | | +|-------------------------------|------------------------------------|------------| +| Annex A (normative): | OpenAPI specification..... | 207 | +| A.1 | General..... | 207 | +| A.2 | Nhss_imsUECM API..... | 207 | +| A.3 | Nhss_imsSDM API..... | 216 | +| A.4 | Nhss_imsUEAU API..... | 270 | +| A.5 | Nhss_gbaSDM API..... | 273 | +| A.6 | Nhss_gbaUEAU API..... | 279 | +| Annex B (informative): | Withdrawn API versions..... | 282 | +| B.1 | General..... | 282 | +| Annex C (informative): | Change history..... | 283 | + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +--- + +## 1 Scope + +The present document specifies the stage 3 protocol, including message flows and API specification details, for the Nhss services, as part of the 5G Service-Based Architecture, offered by the HSS. + +The HSS services specified in the present document include: + +- Services for interworking with the IP Multimedia Subsystem (IMS) +- Services for interworking with the Generic Bootstrapping Architecture (GBA) + +NOTE: The HSS services for Interworking with the Unified Data Management (UDM) Network Function are specified in 3GPP TS 29.563 [39]. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The IP Multimedia Subsystem (IMS) stage 2 architecture and procedures are specified in 3GPP TS 23.228 [6]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +The stage 2 architecture and procedures of SBA-enabled GBA is specified in 3GPP TS 33.220 [40] and 3GPP TS 33.223 [41]. + +--- + +## 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [7] 3GPP TS 29.335: "User Data Repository Access Protocol over the Ud interface; Stage 3". + +- [8] IETF RFC 9113: "HTTP/2". +- [9] OpenAPI Initiative, "OpenAPI Specification Version 3.0.0", . +- [10] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [11] IETF RFC 9457: "Problem Details for HTTP APIs". +- [12] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". +- [13] 3GPP TS 23.003: "Numbering, addressing and identification". +- [14] 3GPP TS 33.203: "Access security for IP-based services". +- [15] 3GPP TS 29.503: "Unified Data Management Services; Stage 3". +- [16] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [17] IETF RFC 4740: "Diameter Session Initiation Protocol (SIP) Application". +- [18] 3GPP TS 24.229: "IP multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [19] IETF RFC 4412: "Communications Resource Priority for the Session Initiation Protocol". +- [20] 3GPP TS 29.228: "IP Multimedia (IM) Subsystem Cx and Dx interfaces; Signalling flows and message contents". +- [21] 3GPP TS 29.218: "IP Multimedia (IM) session handling; IM call model; Stage 2". +- [22] IETF RFC 3261: "SIP: Session Initiation Protocol". +- [23] IETF RFC 8497: "Marking SIP messages to be logged". +- [24] 3GPP TS 24.323: "3GPP IP Multimedia Subsystem (IMS) service level tracing Management Object (MO)". +- [25] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description; Stage 2". +- [26] 3GPP TS 29.273: "Evolved Packet System (EPS); 3GPP EPS AAA interfaces". +- [27] IETF RFC 4776: "Dynamic Host Configuration Protocol (DHCPv4 and DHCPv6) Option for Civic Addresses Configuration Information". +- [28] IETF RFC 2045: "Multipart Internet Mail Extensions(MIME) Part One: Format of Internet Message Bodies". +- [29] ETSI ES 283 034: "Network Attachment Sub-System (NASS); e4 interface based on the DIAMETER protocol". +- [30] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [31] 3GPP TS 23.078: "Customised Applications for Mobile network Enhanced Logic (CAMEL) Phase 3 - Stage 2". +- [32] 3GPP TS 29.272: "Evolved Packet System; MME and SGSN Related Interfaces Based on Diameter Protocol". +- [33] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". +- [34] 3GPP TR 21.900: "Technical Specification Group working methods". +- [35] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [36] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [37] 3GPP TS 23.380: "IP Multimedia Subsystem (IMS); IMS Restoration Procedures". + +- [38] 3GPP TS 29.328: "IP Multimedia (IM) Subsystem Sh interface; Signalling flows and message contents". +- [39] 3GPP TS 29.563: "Home Subscriber Server (HSS) services for interworking with Unified Data Management (UDM); Stage 3". +- [40] 3GPP TS 33.220: "Generic Authentication Architecture (GAA); Generic Bootstrapping Architecture (GBA)". +- [41] 3GPP TS 33.223: "Generic Authentication Architecture (GAA); Generic Bootstrapping Architecture (GBA) Push function". +- [42] 3GPP TS 29.309: "Bootstrapping Server Function (GBA BSF) Services; Stage 3". +- [43] 3GPP TS 23.218: "IP Multimedia (IM) session handling; IM call model; Stage 2". + +--- + +## 3 Definitions of terms, symbols and abbreviations + +### 3.1 Terms + +The following terms and definitions given in TS 23.003 [13] apply: + +**Distinct Public Service Identity** + +**Distinct Public User Identity** + +**Public Service Identity** + +**Public User Identity** + +**Wildcarded Public Service Identity** + +**Wildcarded Public User Identity** + +In the present document, the following terms and definitions apply. + +**Common Part** (of a user profile): Contains Initial Filter Criteria instances that should be evaluated both for registered and unregistered Public User Identities, or for unregistered Public Service Identities in the S-CSCF. + +**Complete user profile**: Contains the Initial Filter Criteria instances of all three different user profile parts; registered part, unregistered part and common part. + +**IP Multimedia session**: IP Multimedia session and IP Multimedia call are treated as equivalent in this specification. + +**Authentication pending flag**: A flag that indicates that the authentication of a Public User Identity - Private User Identity pair is pending and waiting for confirmation. + +**Implicitly registered Public User Identity set**: A set of Public User Identities, which are registered and de-registered simultaneously when any of the Public User Identities belonging to that set is registered or de-registered. + +**Not Registered State**: Public Identity is not Registered and has no S-CSCF assigned. + +**Private Identity**: Either a Private User Identity or a Private Service Identity. + +**Public Identity**: Either a Public User Identity or a Public Service Identity. + +**Registered State**: Public User Identity is Registered at the request of the user and has an S-CSCF assigned. + +**Unregistered State**: Public Identity is not Registered but has a serving S-CSCF assigned to execute Unregistered state services as a consequence of a terminating request, or an originating request from an AS on behalf of a user, or there is an S-CSCF keeping the user profile stored. + +**User information**: The user related data that the S-CSCF requests from the HSS or HSS pushes to the S-CSCF, e.g. user profile, charging information, allowed WAF and/or WWSF identities and authentication information. + +**User profile:** Data that is sent in the resource associated to the complete user's subscription data. + +**IP Multimedia session:** IP Multimedia session and IP Multimedia call are treated as equivalent in this specification. + +**Transparent data:** Data that is understood syntactically but not semantically by the HSS. It is data that an AS may store in the HSS to support its service logic. One example is data that an AS stores in the HSS, using it as a repository. + +**Non-transparent data:** Data that is understood both syntactically and semantically by the HSS. + +**AS (Application Server):** a term used to denote either of a SIP Application Server or an OSA Service Capability Server. + +## 3.2 Symbols + +Void + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|--------|------------------------------------------------| +| 5GC | 5G Core Network | +| AS | Application Server | +| AMF | Access and Mobility Management Function | +| CSCF | Call Session Control Function | +| CSG | Closed Subscriber Group | +| DCSF | Data Channel Signalling Function | +| FQDN | Fully Qualified Domain Name | +| GIBA | GPRS-IMS-Bundled-Authentication | +| GPSI | Generic Public Subscription Identifier | +| HSS | Home Subscriber Server | +| IMS | IP Multimedia Subsystem | +| I-CSCF | Interrogating CSCF | +| JSON | Javascript Object Notation | +| MPS | Multimedia Priority Service | +| NAI | Network Access Identifier | +| NRF | Network Repository Function | +| NSSAI | Network Slice Selection Assistance Information | +| NWDAF | Network Data Analytics Function | +| P-CSCF | Proxy CSCF | +| SBI | Service Based Interface | +| SIP | Session Initiation Protocol | +| SPT | Service Point Trigger | +| S-CSCF | Serving CSCF | +| UDR | Unified Data Repository | + +--- + +## 4 Overview + +### 4.1 Introduction + +Within the 5GC, the HSS offers services to the S-CSCF, I-CSCF, IMS-AS and DCSF (on the IP Multimedia Subsystem) and GBA BSF via the Nhss service based interface (see 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]). + +Figure 4.1-1 provides the reference model in service-based interface representation with focus on the HSS. + +![Figure 4.1-1: Reference model – HSS. The diagram shows an IMS (IP Multimedia Subsystem) box containing S-CSCF, I-CSCF, IMS-AS, and DCSF. Below the IMS box is a GBA BSF. All these components are connected to a central HSS (Home Subscriber Server) box via a common interface labeled 'Nhss'.](4356776ca004ecba5d599667a155d7d4_img.jpg) + +Figure 4.1-1: Reference model – HSS. The diagram shows an IMS (IP Multimedia Subsystem) box containing S-CSCF, I-CSCF, IMS-AS, and DCSF. Below the IMS box is a GBA BSF. All these components are connected to a central HSS (Home Subscriber Server) box via a common interface labeled 'Nhss'. + +Figure 4.1-1: Reference model – HSS + +## 5 Services offered by the HSS + +### 5.1 Introduction + +The SBI capable HSS offers the following services via the Nhss\_ims interface: + +- Nhss\_imsUEContextManagement Service +- Nhss\_imsSubscriberDataManagement Service +- Nhss\_imsUEAuthentication Service +- Nhss\_gbaSubscriberDataManagement Service +- Nhss\_gbaUEAuthentication Service + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +Table 5.1-1: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|----------------------------------|--------|-------------------------------------------------|----------------------------|---------------|-------| +| Nhss_imsUEContextManagement | 6.1 | Nhss UE Context Management Service for IMS | TS29562_Nhss_imsUECM.yaml | nhss-ims-uecm | A.2 | +| Nhss_imsSubscriberDataManagement | 6.2 | Nhss Subscriber Data Management Service for IMS | TS29562_Nhss_imsSDM.yaml | nhss-ims-sdm | A.3 | +| Nhss_imsUEAuthentication | 6.3 | Nhss UE Authentication Service for IMS | TS29562_Nhss_imsUEAU.yaml | nhss-ims-ueau | A.4 | +| Nhss_gbaSubscriberDataManagement | 6.4 | Nhss Subscriber Data Management Service for GBA | TS29562_Nhss_gbaSDM.yaml | nhss-gba-sdm | A.5 | +| Nhss_gbaUEAuthentication | 6.5 | Nhss UE Authentication Service for GBA | TS29562_Nhss_gbaUEAU.yaml | nhss-gba-ueau | A.6 | + +All scenarios shown in the following clauses assume that the SBI capable HSS is stateful and stores information in local memory. However, the SBI capable HSS may be stateless and store information externally in the UDR. If so, the stateless SBI capable HSS may use Ud interface as specified in 3GPP TS 29.335 [7] to retrieve required data from the UDR and store them locally before processing an incoming request. Processing the incoming request may then include updating data in the UDR. After processing the incoming request, the SBI capable HSS may delete the locally stored data. When data stored in UDR is then shared among the different SBI capable HSS instances of the same group, as identified by HSS Group ID (see 3GPP TS 23.501 [2], clause 6.2.6), bulk subscriptions, as described in clause 4.15.3.2.4 of 3GPP TS 23.502 [3], are not applicable, i.e. an NF consumer (e.g. IMS-AS) only subscribes towards one of the SBI capable HSS instances within the group. + +**Editor's Note:** It is FFS if an informative Annex needs to be included to show how an IMS-AS/I-CSCF/S-CSCF can interact with a group of stateless SBI capable HSS instances. + +## 5.2 Nhss\_imsUEContextManagement Service + +### 5.2.1 Service Description + +See 3GPP TS 23.228 [6], clause AA.2.1.2. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +For the Nhss\_imsUEContextManagement service the following service operations are defined: + +- Registration +- DeregistrationNotification +- Deregistration +- Authorize +- Update +- RestorationInfoGet +- RestorationInfoUpdate +- RestorationInfoDelete + +IMS restoration procedures are specified in 3GPP TS 23.380 [37]. + +The Nhss\_imsUEContextManagement Service is used by Consumer NFs (I-CSCF/S-CSCF) to: + +- register at the HSS by means of the Registration service operation (S-CSCF) +- get notified by means of the DeregistrationNotification service operation when HSS decides to deregister the registered consumer NF (S-CSCF) +- deregister from the HSS by means of the Deregistration service operation (S-CSCF) +- request registration authorization from HSS by means of the Authorize service operation (I-CSCF) +- update registration information stored at the HSS by means of the Update service operation (S-CSCF) +- retrieve Restoration Information stored at the HSS by means of the RestorationInfoGet service operation (S-CSCF) +- update Restoration Information stored at the HSS by means of the RestorationInfoUpdate service operation (S-CSCF) + +- delete Restoration Information stored at the HSS by means of the RestorationInfoDelete service operation (S-CSCF) + +## 5.2.2.2 Registration + +### 5.2.2.2.1 General + +The Registration service operation is invoked by a NF that has been selected to provide service to the UE to store related IMS UE Context Management information in HSS. + +NF Consumer is S-CSCF. + +As part of this procedure, the HSS updates the registration state of the requested IMS Public Identity and IMS Private Identity. The state of the IMS Public Identities in the same Implicit Registration Set is also updated. + +The following procedures using the Registration service operation are supported: + +- S-CSCF registration + +### 5.2.2.2.2 S-CSCF Registration + +Figure 5.2.2.2.2-1 shows a scenario where the S-CSCF sends a request to register at the HSS (see also 3GPP TS 23.228 [6] clause 5.2). The request contains the IMS UE's identity (/imsUeId) which shall be an IMPU, the S-CSCF Registration Information and the Registration Type. + +![Sequence diagram showing S-CSCF registration. The S-CSCF sends a PUT request to the HSS for the resource ^imsUeId/scscf-registration. The HSS responds with one of the following status codes: 2a. 204 No Content, 2b. 201 Created, 2c. 403 Forbidden, or 2d. 3xx Redirect.](5c6787bac31274e2dc992efeca74b303_img.jpg) + +``` + +sequenceDiagram + participant S-CSCF + participant HSS + Note right of HSS: 1. PUT « ^imsUeId/scscf-registration (ScscfRegistration) + S-CSCF->>HSS: Request + Note right of HSS: 2a. 204 No Content +2b. 201 Created +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>S-CSCF: Response + +``` + +Sequence diagram showing S-CSCF registration. The S-CSCF sends a PUT request to the HSS for the resource ^imsUeId/scscf-registration. The HSS responds with one of the following status codes: 2a. 204 No Content, 2b. 201 Created, 2c. 403 Forbidden, or 2d. 3xx Redirect. + +Figure 5.2.2.2.2-1: S-CSCF registration + +1. The S-CSCF sends a PUT request to the resource representing the UE's S-CSCF registration to update or create S-CSCF registration information. The S-CSCF shall check whether there is a reg-id parameter in the Contact header in the SIP REGISTER message. If a reg-id parameter exists, the S-CSCF shall indicate to the HSS that the registration is related to a multiple registration as specified in clause 4.2.3 of 3GPP TS 23.380 [37]. If the S-CSCF received a S-CSCF reselection indicator from the I-CSCF, the S-CSCF shall include that indicator to the HSS. +- 2a. If the resource already exists, and if the S-CSCF registered is the same or if another S-CSCF is registered and S-CSCF reselection indication is received, the HSS updates the scscfRegistration resource by replacing it with the received resource information (e.g. S-CSCF name, state of the related IMS public identity based on the imsRegistrationType received) and responds with "204 No Content" or "200 OK" with the updated resource information and HSS supported features. + +Additionally, if the S-CSCF is reselected, the HSS shall invoke the Deregistration Notification service operation towards the old S-CSCF using the callback URI provided by the old S-CSCF with deregistration reason set to "NEW SERVER ASSIGNED". + +When receiving the "200 OK" response and if a multiple registration indicator has indicated to the HSS, the S-CSCF shall retrieve and update the restoration information as specified in clause 5.2.2.6 and clause 5.2.2.7. + +- 2b. If the resource does not exist (there is no previous S-CSCF information stored in HSS), HSS stores the received S-CSCF registration data and responds with HTTP Status Code "201 created". A response body is included with the created resource and the features supported by HSS. + +- 2c. If the operation is not authorized due to e.g. received IMS identities do not exist or do not match, or a different S-CSCF is registered and S-CSCF reselection is not authorized, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.2.2.3 DeregistrationNotification + +#### 5.2.2.3.1 General + +The following procedure using the DeregistrationNotification service operation is supported: + +- HSS initiated Deregistration + +#### 5.2.2.3.2 HSS initiated Deregistration + +Figure 5.2.2.3.2-1 shows a scenario where the HSS notifies the registered NF about the deregistration of one or more IMS Public Identities (see also 3GPP TS 23.228 [6] clause 5.3.2.2.1). The request contains the callback URI for deregistration notification as received by the HSS during registration, and Deregistration Data. + +![Sequence diagram showing HSS initiated NF Deregistration. The diagram shows two lifelines: NF Consumer and HSS. The HSS sends a POST request to the NF Consumer. The NF Consumer responds with either 2a. 204 No Content, 2b. 4xx/5xx Client or Server Error, or 2c. 3xx Redirect.](35127fe87029df6f5f0b2ee85f6193f1_img.jpg) + +``` + +sequenceDiagram + participant NF Consumer + participant HSS + Note right of HSS: 1. POST {callbackReference} (DeregistrationData) + HSS->>NF Consumer: 1. POST {callbackReference} (DeregistrationData) + Note left of NF Consumer: 2a. 204 No Content +2b. 4xx/5xx Client or Server Error +2c. 3xx Redirect + NF Consumer-->>HSS: 2a. 204 No Content +2b. 4xx/5xx Client or Server Error +2c. 3xx Redirect + +``` + +Sequence diagram showing HSS initiated NF Deregistration. The diagram shows two lifelines: NF Consumer and HSS. The HSS sends a POST request to the NF Consumer. The NF Consumer responds with either 2a. 204 No Content, 2b. 4xx/5xx Client or Server Error, or 2c. 3xx Redirect. + +**Figure 5.2.2.3.2-1: HSS initiated NF Deregistration** + +1. The HSS determines the need to deregister one or more public identities and sends a POST request to the callbackReference as provided by the NF service consumer (S-CSCF) during the registration. + +NOTE: The callbackReference identifies a public identity or an IRS or a Wildcarded PSI that shall be deregistered. + +HSS includes DeregistrationData with the Deregistration Reason that triggered the notification and additional information about the public identities that shall be deregistered such as: + +- Private Identity of the public identity to be deregistered, +- if several Private Identities with all associated Public Identities need to be deregistered, the Associated Private Identities. + +- 2a. On success, the NF service consumer responds with "204 No Content" or with "200 OK" including additional information about the deregistration result such as: + +- Associated Private Identities: it contains all Private Identities that have been deregistered together with the one in the Private User Identity received in the request, +- Identities with Emergency Registration: This information element indicates a list of pairs of private and public user identities which have not been de-registered due to emergency registration. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the NF Service Consumer shall return 3xx status code, which shall contain a Location header with an URI pointing to an alternative notification endpoint. + +## 5.2.2.4 Deregistration + +### 5.2.2.4.1 General + +The following procedures using the Deregistration service operation are supported: + +- S-CSCF deregistration + +### 5.2.2.4.2 S-CSCF deregistration + +Figure 5.2.2.4.2-1 shows a scenario where the S-CSCF sends a request to the HSS to deregister a user (see also 3GPP TS 23.228 [6] clause 5.3.1). The request contains the IMS UE's identity (`{imsUeId}`) which shall be an IMPI or an IMPU and the deregistration information. + +![Sequence diagram showing S-CSCF sending a PUT request to HSS for deregistration, with a response box containing 2a. 204 No Content, 2b. 403 Forbidden / 404 Not Found, and 2c. 3xx Redirect.](04dc3838022e96d8d5548bb1b777b38c_img.jpg) + +``` + +sequenceDiagram + participant S-CSCF + participant HSS + Note right of HSS: 2a. 204 No Content +2b. 403 Forbidden / 404 Not Found +2c. 3xx Redirect + S-CSCF->>HSS: 1. PUT « ^imsUeId}/scscf-registration (ScscfRegistration) + HSS-->>S-CSCF: + +``` + +Sequence diagram showing S-CSCF sending a PUT request to HSS for deregistration, with a response box containing 2a. 204 No Content, 2b. 403 Forbidden / 404 Not Found, and 2c. 3xx Redirect. + +**Figure 5.2.2.4.2-1: S-CSCF deregistering** + +1. The S-CSCF sends a PUT request to the resource representing the UE's CSCF registration. +- 2a. The HSS shall check whether the received S-CSCF name matches the stored S-CSCF. If the S-CSCF name is different, the HSS shall check whether the S-CSCF reassignment is allowed (i.e. S-CSCF reassignment pending flag is set). + +If an IMPI is received as ImsUeId, HSS shall deregister all IMPUs associated to that IMPI. + +If an IMPU is received as ImsUeId, HSS shall deregister the IMPU and related IMPUs in the Implicit Registration Set for the related IMPI. + +On success, HSS shall respond "204 No Content" or "200 OK". + +- 2b. Otherwise the HSS responds with "403 Forbidden" (e.g. S-CSCF is not the current S-CSCF assigned) or "404 Not Found" (e.g. IMPU or IMPI do not exist). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.2.2.5 Authorize + +### 5.2.2.5.1 General + +The Authorize service operation is invoked by a NF to request UE authorization to register or establish terminating/originating sessions in the IMS network. + +NF Consumer is I-CSCF for IMS service. + +As part of this procedure, the HSS authorizes or rejects the subscriber to use the IMS service based on the authorization information provided in the request and subscription data (e.g. roaming restrictions, barrings). + +The following procedures using the Authorize service operation are supported: + +- Authorization request + +#### 5.2.2.5.2 Authorization request + +Figure 5.2.2.5.2-1 shows a scenario where the I-CSCF sends a request to the HSS to authorize the UE to register in a given PLMN's P-CSCF or initiate a session for unregistered services (see also 3GPP TS 23.228 [6] clause 5.2.2.3 or 5.12.2). The request contains the IMS UE's identity (`{imsUId}`) which shall be an IMPU, and the `AuthorizationRequest`. + +![Sequence diagram showing the Authorization request procedure between I-CSCF and HSS. The I-CSCF sends a POST request to the HSS. The HSS responds with either 2a. 403 Forbidden, 2b. 200 OK (AuthorizationResponse), or 2c. 3xx Redirect.](6f31cdb576d2f15c35c3f266e5f59211_img.jpg) + +``` + +sequenceDiagram + participant I-CSCF + participant HSS + Note right of HSS: 2a. 403 Forbidden +2b. 200 OK (AuthorizationResponse) +2c. 3xx Redirect + I-CSCF->>HSS: 1. POST « ^imsUId}/authorize (AuthorizationRequest) + HSS-->>I-CSCF: 2a. 403 Forbidden +2b. 200 OK (AuthorizationResponse) +2c. 3xx Redirect + +``` + +Sequence diagram showing the Authorization request procedure between I-CSCF and HSS. The I-CSCF sends a POST request to the HSS. The HSS responds with either 2a. 403 Forbidden, 2b. 200 OK (AuthorizationResponse), or 2c. 3xx Redirect. + +**Figure 5.2.2.5.2-1: Authorization** + +1. The I-CSCF sends a POST request (custom method: authorize) to request for UE's authorization to register or establish an originating/terminating session. +- 2a. If the operation cannot be authorized due to e.g. UE does not have required subscription data, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). +- 2b. If successful, HSS responds with HTTP Status Code "200 OK" and may provide the S-CSCF identity which is serving the user, if any. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.2.2.6 RestorationInfoGet + +##### 5.2.2.6.1 General + +The RestorationInfoGet service operation is invoked by a NF to retrieve restoration information in HSS. + +NF Consumer is S-CSCF. + +The following procedures using the RestorationInfoGet service operation are supported: + +- Restoration Information Retrieval + +##### 5.2.2.6.2 Restoration Information Retrieval + +Figure 5.2.2.6.2-1 shows a scenario where the NF service consumer (S-CSCF) sends a request to the HSS to retrieve the information related to a specific registration for a registered user (e.g. during a registration procedure, during an originating request procedure or during a terminating request procedure). The request contains the IMS UE's identity (`{imsUId}`) which shall be an IMPU. + +![Sequence diagram for Restoration Information Retrieval. S-CSCF sends a GET request to HSS for restoration info. HSS responds with 200 OK, 404 Not Found, or 3xx Redirect.](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +``` + +sequenceDiagram + participant S-CSCF + participant HSS + Note left of S-CSCF: 1. GET « ^imsUeId}/scscf-registration/scscf-restoration-info + S-CSCF->>HSS: Request + Note right of HSS: 2a. 200 OK (ScscfRestorationInfo) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>S-CSCF: Response + +``` + +Sequence diagram for Restoration Information Retrieval. S-CSCF sends a GET request to HSS for restoration info. HSS responds with 200 OK, 404 Not Found, or 3xx Redirect. + +**Figure 5.2.2.6.2-1: Restoration Information Retrieval** + +1. The NF service consumer (S-CSCF) sends a GET request to the resource representing the UE's S-CSCF restoration information. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's S-CSCF restoration information. The S-CSCF shall send a request to the HSS to retrieve the UE's IMS profile as specified in clause 5.3.2.2.4. +- 2b. If there is no valid restoration data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.2.2.7 RestorationInfoUpdate + +### 5.2.2.7.1 General + +The RestorationInfoUpdate service operation is invoked by a NF to update restoration information in HSS. + +NF Consumer is S-CSCF. + +The following procedures using the RestorationInfoUpdate service operation are supported: + +- Restoration Information Update + +### 5.2.2.7.2 Restoration Information Update + +S-CSCF backup and update of S-CSCF restoration information in HSS is specified in clause 4.6 of 3GPP TS 23.380 [37]. + +Figure 5.2.2.7.2-1 shows a scenario where the S-CSCF sends a request to update restoration information at the HSS (see also 3GPP TS 23.228 [6] clause 4.24). The request contains the IMS UE's identity (/ {imsUeId}) which shall be an IMPU. + +![Sequence diagram for Restoration Information Update. S-CSCF sends a PUT request to HSS to update restoration info. HSS responds with 200 OK / 204 No Content, 201 Created, 403 Forbidden, or 3xx Redirect.](ea49c15f36ffb089d44f1d793f013778_img.jpg) + +``` + +sequenceDiagram + participant S-CSCF + participant HSS + Note left of S-CSCF: 1. PUT « ^imsUeId}/scscf-registration/scscf-restoration-info + S-CSCF->>HSS: Request + Note right of HSS: 2a. 200 OK / 204 No Content +2b. 201 Created +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>S-CSCF: Response + +``` + +Sequence diagram for Restoration Information Update. S-CSCF sends a PUT request to HSS to update restoration info. HSS responds with 200 OK / 204 No Content, 201 Created, 403 Forbidden, or 3xx Redirect. + +**Figure 5.2.2.7.2-1: Restoration Information Update** + +1. The S-CSCF sends a PUT request to the resource representing the UE's S-CSCF restoration information to update or create S-CSCF restoration information. +- 2a. If there are S-CSCF restoration information related to the IMS Public Identity stored in the HSS, the HSS updates the Scscf Restoration Information resource by replacing it with the received restoration information and responds with "200 OK" or "204 No Content". +- 2b. If the resource does not exist (there is no previous S-CSCF restoration information stored in HSS for that user), HSS stores the received S-CSCF restoration data and responds with HTTP Status Code "201 created". +- 2c. If the request can't be accepted (e.g. the S-CSCF is not allowed to create/update the restoration information), HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.2.2.8 RestorationInfoDelete + +### 5.2.2.8.1 General + +The RestorationInfoDelete service operation is invoked by a NF to delete restoration information in HSS. + +NF Consumer is S-CSCF. + +The S-CSCF consumes the RestorationInfoDelete service operation as a consequence of subscriber deregistration (TIMEOUT\_DEREGISTRATION, USER\_DEREGISTRATION, ADMINISTRATIVE\_DEREGISTRATION). In restoration scenarios, the new S-CSCF after successful retrieval of restoration data, consumes the RestorationInfoDelete service operation to delete the restoration data stored by the old S-CSCF. + +The following procedures using the RestorationInfoDelete service operation are supported: + +- Restoration Information Delete + +### 5.2.2.8.2 Restoration Information Delete + +Figure 5.2.2.Z.2-1 shows a scenario where the S-CSCF sends a request to delete restoration information at the HSS. The request contains the IMS UE's identity (/imsUeId) which shall be an IMPU. + +![Sequence diagram showing the Restoration Information Delete procedure between S-CSCF and HSS. The S-CSCF sends a DELETE request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 403 Forbidden, 2c. 404 Not Found, or 2d. 3xx Redirect.](88a6d9692a52989caa6b208a1ba70dc0_img.jpg) + +``` + +sequenceDiagram + participant S-CSCF + participant HSS + Note right of HSS: 2a. 204 No Content +2b. 403 Forbidden +2c. 404 Not Found +2d. 3xx Redirect + S-CSCF->>HSS: 1. DELETE « ^imsUeId}/scscf-registration/scscf-restoration-info + HSS-->>S-CSCF: Response (2a-2d) + +``` + +Sequence diagram showing the Restoration Information Delete procedure between S-CSCF and HSS. The S-CSCF sends a DELETE request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 403 Forbidden, 2c. 404 Not Found, or 2d. 3xx Redirect. + +**Figure 5.2.2.8.2-1: Restoration Information Delete** + +1. The S-CSCF sends a DELETE request to the resource representing the UE's S-CSCF restoration information to delete S-CSCF restoration information. +- 2a. If there are S-CSCF restoration information related to the IMS Public Identity stored in the HSS, the HSS deletes the Scscf Restoration Information resource by replacing it with the received restoration information and responds with "204 No Content". + +- 2b. If the request can't be accepted (e.g. the S-CSCF is not allowed to delete the restoration information), HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If there is no valid S-CSCF restoration information, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.3 Nhss\_imsSubscriberDataManagement Service + +### 5.3.1 Service Description + +See 3GPP TS 23.228 [6], clause AA.2.1.3. + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +For the Nhss\_imsSubscriberDataManagement service the following service operations are defined: + +- Get +- Subscribe to notification of data changes and UE reachability for IP +- Unsubscribe to notification of data changes and UE reachability for IP +- Notification of data changes and UE reachability for IP +- Update + +The Nhss\_imsSubscriberDataManagement Service is used by Consumer NFs (S-CSCF, IMS-AS and DCSF) to retrieve the UE's individual subscription data relevant to the consumer NF, or by I-CSCF to retrieve S-CSCF capabilities or the assigned S-CSCF, from the SBI capable HSS by means of the Get service operation. If the consumer NF supports the feature "sharedData", the retrieved individual subscription data for the UE may contain shared data identifier identifying additional parts of subscription data shared by several UEs. If so, the Nhss\_imsSubscriberDataManagement Service is also used by Consumer NFs to: + +- retrieve shared subscription data from the HSS by means of the Get service operation. + +The Nhss\_imsSubscriberDataManagement Service is also used by Consumer NFs to: + +- subscribe to notifications of data change by means of the Subscribe service operation. If the consumer NF supports the feature "sharedData", the consumer NF may also subscribe to notifications of shared data change by means of the Subscribe service operation. +- to unsubscribe from notifications of data changes by means of the Unsubscribe service operation. If the feature "sharedData" is supported, it may also be used to unsubscribe from notifications of shared data changes by means of the Unsubscribe service operation. +- get notified by means of the Notification service operation when HSS decides to modify the subscribed data. If the feature "sharedData" is supported by the consumer NF and the consumer NF has previously subscribed to notifications of shared data change, it is also used by the consumer NF to get notified by means of the Notification service operation when the HSS decides to modify the subscribed shared data. + +It is also used by Consumer NFs to: + +- provide the information about the status of the subscription data management procedures. + +- update information (e.g. transparent data) associated to the subscription data management. + +## 5.3.2.2 Get + +### 5.3.2.2.1 General + +The following procedures using the Get service operation are supported: + +- Repository Data Retrieval +- IMS Identity Data (e.g. IMS associated identities including Implicit Registration Set and Alias Group) Retrieval +- IMS Profile Data (e.g. IFCs) Retrieval +- IMS Location Data Retrieval +- IMS Registration Status Data Retrieval +- Access Data (e.g. T-ADS) Retrieval +- SRVCC Data (e.g. STN-SR) Retrieval +- Service Data (e.g. DSAI) Retrieval +- Retrieval Of Multiple Data Sets +- Shared Subscription Data Retrieval +- Trace Data Retrieval +- PSI Activation State Retrieval +- DSAI information Retrieval +- S-CSCF Selection Assistance Information Retrieval + +When the feature SharedData is supported and the retrieved UE-individual data (i.e. data other than Shared Subscription Data) contain SharedDataIds, the NF service consumer shall also retrieve the shared data identified by the received shared data Ids unless the identified shared data are already available at the NF service consumer. The order of sequence of sharedDataIds within UE-individual data is significant: Individual data take precedence over shared data; shared data "SharedDataX" identified by a sharedDataId X takes precedence over shared data "SharedDataY" identified by a sharedDataId Y if X appears before Y within the list of SharedDataIds in the UE-individual data. + +### 5.3.2.2.2 Identity Data + +#### 5.3.2.2.2.1 IMS Identity Data Retrieval + +Figure 5.3.2.2.2.1-1 shows a scenario where the NF service consumer (IMS-AS) sends a request to the HSS to receive the UE's IMS Identity Data for the IMS associated Identities (IRS and Alias group information). The request contains the UE's identity (/{imsUeId}), the type of the requested information (/identities/ims-associated-identities) and query parameters (e.g. supported-features). + +![Sequence diagram for IMS Identity Data Retrieval. The diagram shows a request from IMS-AS to HSS and a response from HSS to IMS-AS. The request is a GET request to the resource ^imsUeld}/identities/ims-associated-identities. The response can be 200 OK, 404 Not Found, or 3xx Redirect.](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +``` + +sequenceDiagram + participant IMS-AS + participant HSS + Note right of HSS: 1. GET « ^imsUeld}/identities/ims-associated-identities + HSS-->>IMS-AS: 2a. 200 OK (ImplicitRegistrationSet, AliasGroupInformation) + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect + +``` + +Sequence diagram for IMS Identity Data Retrieval. The diagram shows a request from IMS-AS to HSS and a response from HSS to IMS-AS. The request is a GET request to the resource ^imsUeld}/identities/ims-associated-identities. The response can be 200 OK, 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.2.1-1: IMS Identity Data Retrieval** + +1. The NF service consumer (IMS-AS) sends a GET request to the resource representing the UE's Identity Data for the IMS associated identities with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's Implicit Registration Set (if any) and the Alias Group information (if any) which the UE's identity belongs to as relevant for the requesting NF service consumer. Additional information (e.g. distinct or wildcarded type of identity, registration state of the IRS) is also included in the response. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.2.2 MSISDN(s) Retrieval + +Figure 5.3.2.2.2.2-1 shows a scenario where the NF service consumer (IMS-AS) sends a request to the HSS to receive the UE's MSISDN(s). The request contains the UE's identity (/imsUeld}), the type of the requested information (/identities/msisdns) and query parameters (e.g. supported-features). + +![Sequence diagram for MSISDN(s) Retrieval. The diagram shows a request from IMS-AS to HSS and a response from HSS to IMS-AS. The request is a GET request to the resource ^imsUeld}/identities/msisdns. The response can be 200 OK, 404 Not Found, or 3xx Redirect.](7a02de7ed198501f7a4f6ca37c3f28c5_img.jpg) + +``` + +sequenceDiagram + participant IMS-AS + participant HSS + Note right of HSS: 1. GET « ^imsUeld}/identities/msisdns + HSS-->>IMS-AS: 2a. 200 OK (MsisdnList) + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect + +``` + +Sequence diagram for MSISDN(s) Retrieval. The diagram shows a request from IMS-AS to HSS and a response from HSS to IMS-AS. The request is a GET request to the resource ^imsUeld}/identities/msisdns. The response can be 200 OK, 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.2.2-1: MSISDN(s) Retrieval** + +1. The NF service consumer (IMS-AS) sends a GET request to the resource representing the UE's MSISDN(s) with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's MSISDN(s) as relevant for the requesting NF service consumer. The type of MSISDN (basic/C-MSISDN or additional MSISDN) is included in the response. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.2.3 Private Identities Retrieval + +Figure 5.3.2.2.2.3-1 shows a scenario where the NF service consumer (IMS-AS) sends a request to the HSS to receive the UE's Private Identities (IMS Private User Identity, IMSI). The request contains the UE's identity (/{imsUId}), the type of the requested information (/identities/private-identities) and query parameters (e.g. supported-features). + +![Sequence diagram for Private Identities Retrieval. The IMS-AS sends a GET request to the HSS. The HSS responds with 200 OK (PrivateIdentities), 404 Not Found, or 3xx Redirect.](f0a97d0d3818a253c1d2a009966081b1_img.jpg) + +``` + +sequenceDiagram + participant IMS-AS + participant HSS + Note left of IMS-AS: 1. GET « ^imsUId}/identities/private-identities + IMS-AS->>HSS: Request + Note right of HSS: 2a. 200 OK (PrivateIdentities) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>IMS-AS: Response + +``` + +Sequence diagram for Private Identities Retrieval. The IMS-AS sends a GET request to the HSS. The HSS responds with 200 OK (PrivateIdentities), 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.2.3-1: Private Identities Retrieval** + +1. The NF service consumer (IMS-AS) sends a GET request to the resource representing the UE's Private Identities with query optional parameters indicating the supported-features and/or impi. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's Private Identities as relevant for the requesting NF service consumer. The type of Private Identity (e.g. IMPI, IMSI) is included in the response. If an impi was provided as query parameter in the GET request, only the Private Identity of type IMSI that is associated with the provided impi shall be returned. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.2.4 IMEI(SV) Retrieval + +Figure 5.3.2.2.2.4-1 shows a scenario where the NF service consumer (e.g. IMS AS) sends a request to the HSS to receive the IMEI(SV) for the UE. The request contains the UE's identity (/{imsUId}), the type of the requested information (/identities/imeisv) and query parameters (e.g. supported-features). + +![Sequence diagram for IMEI(SV) Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with 200 OK (ImeiSvInformation), 404 Not Found, or 3xx Redirect.](745261f385368efa3f2259c8681874e9_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUId}/identities/imeisv + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (ImeiSvInformation) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for IMEI(SV) Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with 200 OK (ImeiSvInformation), 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.2.4-1: IMEI(SV) Retrieval** + +1. The NF service consumer (e.g. IMS AS) sends a GET request to the resource representing the UE's IMEI(SV) information with query parameters indicating the supported-features. + +- 2a. On success, the HSS responds with "200 OK" with the message body containing the last known IMEI(SV) associated to the UE. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.2.3 IMS Location Data and Status + +#### 5.3.2.2.3.1 S-CSCF Capabilities Retrieval + +Figure 5.3.2.2.3.1-1 shows a scenario where the NF service consumer (I-CSCF), after authorization information has been performed without obtaining an S-CSCF name, sends a request to the HSS to receive the UE's S-CSCF capabilities (mandatory and/or optional). The request contains the UE's identity (/{imsUeId}), the type of the requested information (/ims-data/location-data/scscf-capabilities) and query parameters (e.g. supported-features). + +![Sequence diagram for S-CSCF Capabilities Retrieval. The diagram shows two participants: I-CSCF and HSS. A dashed vertical line extends from each participant. 1. A solid horizontal arrow points from the I-CSCF line to the HSS line, labeled '1. GET « ^imsUeId}/ims-data/location-data/scscf-capabilities'. 2. A return arrow points from the HSS line back to the I-CSCF line. This return path is represented by a dashed line leading to a light gray rectangular box. Inside the box, the text '2a. 200 OK (ScscfCapabilityList)', '2b. 404 Not Found', and '2c. 3xx Redirect' are listed vertically. From the bottom of this box, a solid horizontal arrow points back to the I-CSCF line.](7fe7bcb3d40736e0b29d9f48ff3cc026_img.jpg) + +``` +sequenceDiagram + participant I-CSCF + participant HSS + Note right of HSS: 2a. 200 OK (ScscfCapabilityList) +2b. 404 Not Found +2c. 3xx Redirect + I-CSCF->>HSS: 1. GET « ^imsUeId}/ims-data/location-data/scscf-capabilities + HSS-->>I-CSCF: 2a. 200 OK (ScscfCapabilityList) +2b. 404 Not Found +2c. 3xx Redirect +``` + +Sequence diagram for S-CSCF Capabilities Retrieval. The diagram shows two participants: I-CSCF and HSS. A dashed vertical line extends from each participant. 1. A solid horizontal arrow points from the I-CSCF line to the HSS line, labeled '1. GET « ^imsUeId}/ims-data/location-data/scscf-capabilities'. 2. A return arrow points from the HSS line back to the I-CSCF line. This return path is represented by a dashed line leading to a light gray rectangular box. Inside the box, the text '2a. 200 OK (ScscfCapabilityList)', '2b. 404 Not Found', and '2c. 3xx Redirect' are listed vertically. From the bottom of this box, a solid horizontal arrow points back to the I-CSCF line. + +**Figure 5.3.2.2.3.1-1: S-CSCF Capabilities Retrieval** + +1. The NF service consumer (I-CSCF) sends a GET request to the resource representing the UE's S-CSCF capabilities with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's S-CSCF capabilities relevant for the requesting NF service consumer. The type of S-CSCF capabilities (mandatory and/or optional) is included in the response. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.3.2 Server Name Retrieval + +Figure 5.3.2.2.3.2-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the Server Name (S-CSCF name) associated to the UE. The request contains the UE's identity (/{imsUeId}), the type of the requested information (ims-data/location-data/server-name) and query parameters (e.g. supported-features). + +![Sequence diagram for Server Name Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (ImLocationData), 2b. 404 Not Found, or 2c. 3xx Redirect.](00504fc688ebcf131ccbeff94dfc9939_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeId}/ims-data/location-data/server-name + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (ImLocationData) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for Server Name Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (ImLocationData), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.3.2-1: Server Name Retrieval** + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's IMS location information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the IMS location information (S-CSCF name) as relevant for the service consumer. +- 2b. If there is no valid data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.2.3.3 IMS Registration Status Retrieval + +Figure 5.3.2.2.3.3-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to IMS registration status of a user. The request contains the UE's identity (/{imsUeId}), the type of the requested information (ims-data/registration-status) and query parameters (e.g. supported-features). + +![Sequence diagram for IMS Registration Status Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (ImRegistrationStatus), 2b. 404 Not Found, or 2c. 3xx Redirect.](f64e1e0997695248c0cd4122c5b1a170_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeId}/ims-data/registration-status + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (ImRegistrationStatus) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for IMS Registration Status Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (ImRegistrationStatus), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.3.3-1: IMS Registration Status Retrieval** + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's IMS registration status with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the IMS registration status (e.g. unregistered) as relevant for the service consumer. +- 2b. If there is no valid data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.3.4 S-CSCF Selection Assistance Information Retrieval + +Figure 5.3.2.2.3.4-1 shows a scenario where the NF service consumer (I-CSCF), sends a request to the HSS to receive the UE's S-CSCF Selection Assistance Information. The request contains the UE's identity (`{imsUId}`), the type of the requested information (`/ims-data/location-data/scscf-selection-assistance-info`) and query parameters (e.g. supported-features). + +![Sequence diagram for S-CSCF Selection Assistance Information Retrieval. The diagram shows two lifelines: I-CSCF and HSS. The I-CSCF sends a GET request to the HSS for the resource ^imsUId}/ims-data/location-data/scscf-selection-assistance-info. The HSS responds with one of three possible status codes: 2a. 200 OK (containing SscfSelectionAssistanceInformation), 2b. 404 Not Found, or 2c. 3xx Redirect.](933ecd14c858bf3fc919222d8e357bc8_img.jpg) + +``` + +sequenceDiagram + participant I-CSCF + participant HSS + Note right of I-CSCF: 1. GET « ^imsUId}/ims-data/location-data/scscf-selection-assistance-info + I-CSCF->>HSS: Request + Note right of HSS: 2a. 200 OK (SscfSelectionAssistanceInformation) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>I-CSCF: Response + +``` + +Sequence diagram for S-CSCF Selection Assistance Information Retrieval. The diagram shows two lifelines: I-CSCF and HSS. The I-CSCF sends a GET request to the HSS for the resource ^imsUId}/ims-data/location-data/scscf-selection-assistance-info. The HSS responds with one of three possible status codes: 2a. 200 OK (containing SscfSelectionAssistanceInformation), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**5.3.2.2.3.4-1: S-CSCF Selection assistance Information Retrieval** + +1. The NF service consumer (I-CSCF) sends a GET request to the resource representing the UE's S-CSCF Selection Assistance Information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's S-CSCF Selection Assistance Information. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.4 IMS Profile Data + +##### 5.3.2.2.4.1 IMS User Profile Retrieval + +Figure 5.3.2.2.4.1-1 shows a scenario where the NF service consumer (S-CSCF) sends a request to the HSS to receive the UE's IMS profile data. The request contains the UE's identity (`{imsUId}`), the type of the requested information (`/ims-data/profile-data`) and query parameters (e.g. supported-features). + +![Sequence diagram for IMS User Profile Retrieval. The diagram shows two lifelines: NF Service Consumer and HSS. The NF Service Consumer sends a GET request to the HSS for the resource ^imsUId}/ims-data/profile-data. The HSS responds with one of three possible status codes: 2a. 200 OK (containing ImsProfileData), 2b. 404 Not Found, or 2c. 3xx Redirect.](0977b81510f7649846289ee785d20e74_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of NF Service Consumer: 1. GET « ^imsUId}/ims-data/profile-data + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (ImsProfileData) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for IMS User Profile Retrieval. The diagram shows two lifelines: NF Service Consumer and HSS. The NF Service Consumer sends a GET request to the HSS for the resource ^imsUId}/ims-data/profile-data. The HSS responds with one of three possible status codes: 2a. 200 OK (containing ImsProfileData), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.4.1-1: IMS User Profile Retrieval** + +1. The NF service consumer (S-CSCF) sends a GET request to the resource representing the UE's IMS profile with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's Profile Data as relevant for the requesting NF service consumer. The Initial Filter Criteria (IFC) is included in the response. + +Additional information (e.g. service priority information, chargingInfo, serviceLevelTraceInfo, maxAllowedSimulReg), if any, may also be included. + +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.4.2 Service Priority Level Information Retrieval + +Figure 5.3.2.2.4.2-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the Service Priority levels allowed for the UE. The request contains the UE's identity (/imsUeId), the type of the requested information (ims-data/profile-data/priority-levels) and query parameters (e.g. supported-features). + +![Sequence diagram for Service Priority Level Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (PriorityLevels), 2b. 404 Not Found, or 2c. 3xx Redirect.](dfaa8b98082261913dac00eae86b2889_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeId}/ims-data/profile-data/priority-levels + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (PriorityLevels) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for Service Priority Level Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (PriorityLevels), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.4.2-1: Service Priority Level Information Retrieval** + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's Service Priority Level with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the Namespaces and priority levels allowed for the user. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.4.3 Initial Filter Criteria Retrieval + +Figure 5.3.2.2.4.3-1 shows a scenario where the NF service consumer (e.g. AS, S-CSCF) sends a request to the HSS to receive the UE's Initial Filter Criteria. The request contains the UE's identity (/imsUeId), the type of the requested information (ims-data/profile-data/ifcs) and query parameters (e.g. supported-features). + +![Sequence diagram for Initial Filter Criteria Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (Ifcs), 2b. 404 Not Found, or 2c. 3xx Redirect.](05eb72d372e4bf78e3d6a64949d77bcc_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeId}/ims-data/profile-data/ifcs » + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (Ifcs) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for Initial Filter Criteria Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (Ifcs), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.4.3-1: Initial Filter Criteria Retrieval** + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's IMS profile with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's Initial Filter Criteria (possibly containing S-CSCF-Specific IFC Set Identifiers, if supported and configured in S-CSCF) as relevant for the requesting NF service consumer. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.4.4 Service Trace Level Information Retrieval + +Figure 5.3.2.2.4.4-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the UE's IMS service level trace information associated to the UE. The request contains the UE's identity (/{imsUeId}), the type of the requested information (ims-data/profile-data/ service-level-trace-info) and query parameters (e.g. supported-features). + +![Sequence diagram for Service Trace Level Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (ServiceLevelTraceInformation), 2b. 404 Not Found, or 2c. 3xx Redirect.](f732d3320afe06d979aabbd366184254_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeId}/ims-data/profile-data/service-level-trace-info » + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (ServiceLevelTraceInformation) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for Service Trace Level Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (ServiceLevelTraceInformation), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.4.4-1: Service Trace Level Information Retrieval** + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's IMS service level trace information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the IMS service level trace information (see 3GPP TS 24.323 [24]) so that the service consumer performs logging at IMS service level as described in IETF RFC 8497 [23]. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.4.5 Charging Information Retrieval + +Figure 5.3.2.2.4.5-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the UE's charging information. The request contains the UE's identity (`/{imsUeId}`), the type of the requested information (`ims-data/profile-data/charging-info`) and query parameters (e.g. `supported-features`). + +![Sequence diagram for Charging Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with 200 OK (ChargingInfo), 404 Not Found, or 3xx Redirect.](a5b9392ecb96e6b5e0b4ee0664210f72_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of NF Service Consumer: 1. GET « ^imsUeId}/ims-data/profile-data/charging-info + NF Service Consumer->>HSS: Request + Note left of HSS: 2a. 200 OK (ChargingInfo) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for Charging Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with 200 OK (ChargingInfo), 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.4.5-1: Charging Information Retrieval** + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's charging information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the ChargingInfo. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.5 Access Data + +##### 5.3.2.2.5.1 Location Information Retrieval for CS/PS Domains + +Figure 5.3.2.2.5.1-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the Location Information associated to the UE. The request contains the UE's identity (`/{imsUeId}`), the type of the requested information, the domain (`cs-domain` or `ps-domain`) requested (e.g. `ims-data/access-data/ps-domain/location-data`) and query parameters (e.g. `supported-features`, `requested-nodes`). + +![Sequence diagram for Location Information Retrieval for CS/PS Domains. The NF Service Consumer sends two possible GET requests to the HSS. The HSS responds with 200 OK (PsLocation), 200 OK (CsLocation), 404 Not Found, or 3xx Redirect.](10d81b2cc455e3563e3e562a7f451124_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of NF Service Consumer: 1a. GET « ^imsUeId}/access-data/ps-domain/location-data +1b. GET « ^imsUeId}/access-data/cs-domain/location-data + NF Service Consumer->>HSS: Request + Note left of HSS: 2a. 200 OK (PsLocation) +2b. 200 OK (CsLocation) +2c. 404 Not Found +2d. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for Location Information Retrieval for CS/PS Domains. The NF Service Consumer sends two possible GET requests to the HSS. The HSS responds with 200 OK (PsLocation), 200 OK (CsLocation), 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.5.1-1: Location Information Retrieval for CS/PS Domains** + +- 1a. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's location information at PS domain with query parameters indicating the supported-features and optionally the requested nodes (e.g. MME, AMF) +- 1b. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's location information at CS domain with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the location information for the requested domain (PS) and the requested nodes or all nodes (if no requested nodes were present in the request) +- 2b. On success, the HSS responds with "200 OK" with the message body containing the location information for the requested domain (CS). +- 2c. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.5.2 IP Address Information Retrieval + +Figure 5.3.2.2.5.2-1 shows a scenario where the NF service consumer (e.g. SCC-AS) sends a request to the HSS to receive the IP Address of the UE. The request contains the UE's identity (`{imsUeId}`), the type of the requested information (`/access-data/ps-domain/ip-address`) and query parameters (e.g. supported-features). + +![Sequence diagram for IP Address Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (IpAddress), 2b. 404 Not Found, or 2c. 3xx Redirect.](409498e57b1f988b2b604d12cd997002_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeId}/access-data/ps-domain/ip-address + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (IpAddress) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for IP Address Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (IpAddress), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.5.2-1: IP Address Information Retrieval** + +1. The NF service consumer (e.g. SCC-AS) sends a GET request to the resource representing the UE's IP address information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing either an IPv4 address, IPv6 address or IPv6 prefix and/or IPv6 interface identifier. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.5.3 T-ADS Information Retrieval + +Figure 5.3.2.2.5.3-1 shows a scenario where the NF service consumer (e.g. SCC-AS) sends a request to the HSS to receive the T-ADS information for the UE. The request contains the UE's identity (`{imsUeId}`), the type of the requested information (`/access-data/ps-domain/tads-info`) and query parameters (e.g. supported-features). + +![Sequence diagram for T-ADS Information Retrieval. An NF Service Consumer sends a GET request to an HSS. The HSS responds with one of three options: 2a. 200 OK (TadsInformation), 2b. 404 Not Found, or 2c. 3xx Redirect.](78ff716475b2f65bf01c3a4d02d89fc4_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUId}/access-data/ps-domain/tads-info + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (TadsInformation) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for T-ADS Information Retrieval. An NF Service Consumer sends a GET request to an HSS. The HSS responds with one of three options: 2a. 200 OK (TadsInformation), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.5.3-1: T-ADS Information Retrieval** + +1. The NF service consumer (e.g. SCC-AS) sends a GET request to the resource representing the UE's T-ADS information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the most recent IMS Voice over PS Sessions support indication as indicated by the serving nodes for the user. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.5.4 User State Retrieval for CS/PS Domains + +Figure 5.3.2.2.5.4-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the User State associated to the UE. The request contains the UE's identity (`{imsUId}`), the type of the requested information, the domain (cs-domain or ps-domain) requested (e.g. `ims-data/access-data/ps-domain/user-state`) and query parameters (e.g. supported-features, requested-nodes). + +![Sequence diagram for User State Retrieval for CS/PS Domains. An NF Service Consumer sends two possible GET requests to an HSS. The HSS responds with one of four options: 2a. 200 OK (PsUserState), 2b. 200 OK (CsUserState), 2c. 404 Not Found, or 2d. 3xx Redirect.](02d0c8a07c481d880b73a25d02050fad_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1a. GET « ^imsUId}/access-data/ps-domain/user-state +1b. GET « ^imsUId}/access-data/cs-domain/user-state + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (PsUserState) +2b. 200 OK (CsUserState) +2c. 404 Not Found +2d. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for User State Retrieval for CS/PS Domains. An NF Service Consumer sends two possible GET requests to an HSS. The HSS responds with one of four options: 2a. 200 OK (PsUserState), 2b. 200 OK (CsUserState), 2c. 404 Not Found, or 2d. 3xx Redirect. + +**Figure 5.3.2.2.5.4-1: User State Retrieval for CS/PS Domains** + +- 1a. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's user state information at PS domain with query parameters indicating the supported-features and optionally the requested nodes (e.g. MME, AMF) +- 1b. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's User State information at CS domain with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the User State information for the requested domain (PS) and the requested nodes or all nodes (if no requested nodes were present in the request) +- 2b. On success, the HSS responds with "200 OK" with the message body containing the User State information for the requested domain (CS). + +- 2c. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.5.5 CSRN Retrieval + +Figure 5.3.2.2.5.5-1 shows a scenario where the NF service consumer (e.g. SCC-AS) sends a request to the HSS to receive a CS Domain Routing Number (CSRN, see 3GPP TS 23.003 [13]) for the UE. The request contains the UE's identity (/{imsUeId}), the type of the requested information (/access-data/cs-domain/csrn) and query parameters (e.g. supported-features, pre-paging). + +![Sequence diagram for CSRN Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (Csrn), 2b. 404 Not Found, or 2c. 3xx Redirect.](d8698aacaeead6dfed9a1e448670a2e4_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeId}/access-data/cs-domain/csrn + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (Csrn) + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect + HSS-->>NF Service Consumer: Response +``` + +Sequence diagram for CSRN Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (Csrn), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.5.5-1: T-ADS Information Retrieval** + +1. The NF service consumer (e.g. SCC-AS) sends a GET request to the resource representing the UE's CSRN information with query parameters indicating the supported-features and/or pre-paging indication. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the CSRN as provided by the MSC/VLR. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.5.6 Reference Location Information Retrieval + +Figure 5.3.2.2.5.6-1 shows a scenario where the NF service consumer (e.g. IMS-AS) sends a request to the HSS to receive the reference location information for the UE. The request contains the UE's identity (/{imsUeId}), the type of the requested information (/access-data/wireline-domain/reference-location) and query parameters (e.g. supported-features). + +![Sequence diagram for Reference Location Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with 200 OK, 404 Not Found, or 3xx Redirect.](9f6dec4d4e9fde40bce018861ef1278e_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of NF Service Consumer: 1. GET « ^imsUeId}/access-data/wireline-domain/reference-location + NF Service Consumer->>HSS: 1. GET + Note right of HSS: 2a. 200 OK (ReferenceLocationInformation) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: 2a/2b/2c + +``` + +Sequence diagram for Reference Location Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with 200 OK, 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.5.6-1: Reference Location Information Retrieval** + +1. The NF service consumer (e.g. IMS-AS) sends a GET request to the resource representing the UE's reference location information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the access type and/or the access info and associated value (line identifier in fixed access networks). +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.3.2.2.6 SRVCC Data + +### 5.3.2.2.6.1 SRVCC Data Retrieval + +Figure 5.3.2.2.6.1-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to retrieve the SRVCC data for the UE. The request contains the UE's identity (/imsUeId), the type of the requested information (/srvcc-data) and query parameters (e.g. supported-features). + +![Sequence diagram for SRVCC Data Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with 200 OK, 404 Not Found, or 3xx Redirect.](f10dc32e3673e1392029a49e958a9d6c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of NF Service Consumer: 1. GET « ^imsUeId}/srvcc-data + NF Service Consumer->>HSS: 1. GET + Note right of HSS: 2a. 200 OK (SrvccData) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: 2a/2b/2c + +``` + +Sequence diagram for SRVCC Data Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with 200 OK, 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.6.2-1: SRVCC Data Retrieval** + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's SRVCC data information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the STN-SR and the UE SRVCC capability for the user. +- 2b. If there is no valid SRVCC data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.2.7 Service Data + +#### 5.3.2.2.7.1 PSI Activation State Retrieval + +Figure 5.3.2.2.7.1-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to retrieve the PSI activation state. The request contains the Public Service Identity (/{imsUeId}), the type of the requested information (/service-data/psi-status) and query parameters (e.g. supported-features). + +![Sequence diagram for PSI Activation State Retrieval](26e334e61dd059cff029338a2a604d8d_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of HSS: 1. GET « ^imsUeId}/service-data/psi-status + HSS->>NF Service Consumer: 2a. 200 OK (PsiActivationState) + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect +``` + +The diagram illustrates the interaction for PSI Activation State Retrieval. It starts with the NF Service Consumer sending a GET request to the HSS for the resource ^imsUeId}/service-data/psi-status. The HSS responds with one of three possible outcomes: 2a. 200 OK (PsiActivationState), 2b. 404 Not Found, or 2c. 3xx Redirect. + +Sequence diagram for PSI Activation State Retrieval + +**Figure 5.3.2.2.7.1-1: PSI Activation State Retrieval** + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the PSI activation state with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the PSI activation state (active or inactive). +- 2b. If there is no valid activation state for the PSI, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.7.2 SMS Registration Information retrieval + +Figure 5.3.2.2.7.2-1 shows a scenario where the NF service consumer (e.g. IP-SM-GW) sends a request to the HSS to retrieve the SMS registration information associated to a UE. The request contains the UE identity (/{imsUeId}), the type of the requested information (/service-data/sms-registration-info) and query parameters (e.g. supported-features). + +![Sequence diagram for SMS Registration Information Retrieval](8a8517bfa4f6191c52c47697716255a9_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of HSS: 1. GET « ^imsUeId}/service-data/sms-registration-info + HSS->>NF Service Consumer: 2a. 200 OK (SmsRegistrationInfo) + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect +``` + +The diagram illustrates the interaction for SMS Registration Information Retrieval. It starts with the NF Service Consumer sending a GET request to the HSS for the resource ^imsUeId}/service-data/sms-registration-info. The HSS responds with one of three possible outcomes: 2a. 200 OK (SmsRegistrationInfo), 2b. 404 Not Found, or 2c. 3xx Redirect. + +Sequence diagram for SMS Registration Information Retrieval + +**Figure 5.3.2.2.7.2-1: SMS Registration Information Retrieval** + +1. The NF service consumer (e.g. IP-SM-GW) sends a GET request to the resource representing the SMS registration information with query parameters indicating the supported-features. + +- 2a. On success, the HSS responds with "200 OK" with the message body containing the IP-SM-GW number and optionally the SC address. +- 2b. If there is no valid SMS registration information, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.7.3 DSAI Information retrieval + +Figure 5.3.2.2.7.3-1 shows a scenario where the NF service consumer (e.g. IMS-AS) sends a request to the HSS to retrieve the DSAI information associated to an Application Server. The request contains the UE identity (/{imsUeId}), the type of the requested information (/service-data/dsai) and query parameters (e.g. Application Server Name). + +![Sequence diagram for DSAI Information Retrieval. The diagram shows two participants: NF Service Consumer and HSS. The NF Service Consumer sends a GET request to the HSS with the path ^imsUeId/service-data/dsai. The HSS responds with one of three possible status codes: 2a. 200 OK (DsaiTagInformation), 2b. 404 Not Found, or 2c. 3xx Redirect.](4669a2ca9d019b9c2de9a9d9a0c4e644_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeId/service-data/dsai » + NF Service Consumer->>HSS: 1. GET « ^imsUeId/service-data/dsai » + Note right of HSS: 2a. 200 OK (DsaiTagInformation) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: 2a. 200 OK (DsaiTagInformation) +2b. 404 Not Found +2c. 3xx Redirect + +``` + +Sequence diagram for DSAI Information Retrieval. The diagram shows two participants: NF Service Consumer and HSS. The NF Service Consumer sends a GET request to the HSS with the path ^imsUeId/service-data/dsai. The HSS responds with one of three possible status codes: 2a. 200 OK (DsaiTagInformation), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.7.3-1: DSAI Information Retrieval** + +1. The NF service consumer (e.g. IMS-AS) sends a GET request to the resource representing the DSAI information with query parameter indicating the Application Server Name. Additional query parameters (e.g. supported-features) may be included. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the DSAI tags and their respective status associated to the received Application Server Name. +- 2b. If there are no DSAI tags for the Application Server, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.8 Repository Data + +##### 5.3.2.2.8.1 Repository Data Retrieval + +Figure 5.3.2.2.8.1-1 shows a scenario where the NF service consumer (IMS-AS or DCSF) sends a request to the HSS to receive the UE's Repository Data for a given Service Indication. The request contains the UE's identity (/{imsUeId}), the type of the requested information (/repository-data/{serviceIndication}) and query parameters (e.g. supported-features). + +![Sequence diagram for Repository Data Retrieval](9252ccfbbe9e34cb108f0060f2b563f1_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of HSS: 1. GET « /{imsUeId}/repository-data/{serviceIndication} » + HSS->>NF Service Consumer: 2a. 200 OK (RepositoryData) + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect +``` + +The diagram illustrates a sequence of interactions between an NF Service Consumer and an HSS. The consumer sends a GET request to the HSS for repository data. The HSS responds with one of three possible outcomes: a 200 OK with the data, a 404 Not Found error, or a 3xx Redirect. + +Sequence diagram for Repository Data Retrieval + +**Figure 5.3.2.2.8.1-1: Repository Data Retrieval** + +1. The NF service consumer sends a GET request to the resource representing the UE's Repository Data for a given Service Indication, with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's Repository Data for the requested Service Indication as relevant for the requesting NF service consumer. +- 2b. If there is no valid subscription data or Repository Data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.8.2 + +#### Repository Data Retrieval for multiple service indications + +Figure 5.3.2.2.8.2-1 shows a scenario where the NF service consumer (IMS-AS or DCSF) sends a request to the HSS to receive the UE's Repository Data for multiple Service Indications. The request contains the UE's identity (/{imsUeId}), the type of the requested information (/repository-data) and query parameters (e.g. list of service indications, supported-features). + +![Sequence diagram for Repository Data Retrieval for multiple service indications](4c9ba399ca7df11cbe9b6322cd9aee0a_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of HSS: 1. GET « /{imsUeId}/repository-data ?service-indications » + HSS->>NF Service Consumer: 2a. 200 OK (RepositoryDataList) + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect +``` + +The diagram illustrates a sequence of interactions between an NF Service Consumer and an HSS. The consumer sends a GET request to the HSS for repository data for multiple service indications. The HSS responds with one of three possible outcomes: a 200 OK with a list of repository data, a 404 Not Found error, or a 3xx Redirect. + +Sequence diagram for Repository Data Retrieval for multiple service indications + +**Figure 5.3.2.2.8.2-1: Repository Data Retrieval for multiple service indications** + +1. The NF service consumer sends a GET request to the resource representing the UE's Repository Data, with query parameters indicating the supported-features and list of service indications. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's Repository Data for the requested Service Indications as relevant for the requesting NF service consumer. +- 2b. If there is no valid subscription data or Repository Data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.2.9 Shared Subscription Data + +#### 5.3.2.2.9.1 Shared Subscription Data Retrieval + +Figure 5.3.2.2.9.1-1 shows a scenario where the NF service consumer (e.g. S-CSCF) sends a request to the HSS to receive the shared subscription data. The request contains the type of the requested information (/shared-data) and query parameters (supportedFeatures, shared-data-id). + +![Sequence diagram for Shared Subscription Data Retrieval. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDM' on the right. A solid arrow labeled '1. GET « shared-data?shared-data-id=, ' points from the consumer to the UDM. A return arrow points from the UDM back to the consumer, with a box containing three possible response options: '2a. 200 OK (SharedData)', '2b. 404 Not Found', and '2c. 3xx Redirect'.](3b00a61116faef21d3a6009fd350b46a_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note right of UDM: 2a. 200 OK (SharedData) +2b. 404 Not Found +2c. 3xx Redirect + NF service consumer->>UDM: 1. GET « shared-data?shared-data-id=, + UDM-->>NF service consumer: 2a. 200 OK (SharedData) +2b. 404 Not Found +2c. 3xx Redirect + +``` + +Sequence diagram for Shared Subscription Data Retrieval. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDM' on the right. A solid arrow labeled '1. GET « shared-data?shared-data-id=, ' points from the consumer to the UDM. A return arrow points from the UDM back to the consumer, with a box containing three possible response options: '2a. 200 OK (SharedData)', '2b. 404 Not Found', and '2c. 3xx Redirect'. + +**Figure 5.3.2.2.9.1-1: Shared Subscription Data Retrieval** + +1. The NF service consumer (e.g. S-CSCF) sends a GET request to the resource representing the SharedData, with query parameters indicating the supportedFeatures and shared-data-id. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the SharedData. +- 2b. If there is no valid shared data for one or more of the shared-data-ids, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.3 Subscribe + +#### 5.3.2.3.1 General + +The following procedures using the Subscribe service operation are supported: + +- Subscription to notification of data change +- Subscription to notification of UE reachability for IP + +#### 5.3.2.3.2 Subscription to notifications of data change + +Figure 5.3.2.3.2-1 shows a scenario where the NF service consumer (e.g. S-CSCF) sends a request to the HSS to subscribe to notifications of data change. The request contains a callback URI and the URI of the monitored resource. + +![Sequence diagram showing the NF service consumer subscribing to notifications. The consumer sends a POST request to the HSS. The HSS responds with one of the following: 2a. 201 Created (ImsSdmSubscription), 2b. 404 Not Found, 2c. 501 Not Implemented, or 2d. 3xx Redirect.](32ff77da4286b58c4778033acaa10836_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + NF service consumer->>HSS: 1. POST « ^{imsUeId}/subscriptions (ImsSdmSubscription) + HSS-->>NF service consumer: 2a. 201 Created (ImsSdmSubscription) + HSS-->>NF service consumer: 2b. 404 Not Found + HSS-->>NF service consumer: 2c. 501 Not Implemented + HSS-->>NF service consumer: 2d. 3xx Redirect + +``` + +Sequence diagram showing the NF service consumer subscribing to notifications. The consumer sends a POST request to the HSS. The HSS responds with one of the following: 2a. 201 Created (ImsSdmSubscription), 2b. 404 Not Found, 2c. 501 Not Implemented, or 2d. 3xx Redirect. + +**Figure 5.3.2.3.2-1: NF service consumer subscribes to notifications** + +1. The NF service consumer sends a POST request to the parent resource (collection of subscriptions) (.../{imsUeId}/sdm-subscriptions), to create a subscription as present in message body. +- 2a. On success, the HSS responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the UE subscription data exist, but the requested subscription to data change notification cannot be created (e.g. due to an invalid/unsupported data reference to be monitored, contained in the ImsSdmSubscription parameter), HTTP status code "501 Not Implemented" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.3.3 Subscription to notifications of shared data change + +Figure 5.3.2.3.3-1 shows a scenario where the NF service consumer sends a request to the HSS to subscribe to notifications of shared data change. The request contains a callback URI and the URI of the monitored resource. + +![Sequence diagram showing the NF service consumer subscribing to notifications of shared data change. The consumer sends a POST request to the HSS. The HSS responds with one of the following: 2a. 201 Created (ImsSdmSubscription), 2b. 4xx/5xx Client or Server Error, or 2c. 3xx Redirect.](8d8c758885b4f754ff071bf3b572ab3c_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + NF service consumer->>HSS: 1. POST « shared-data-subscriptions (ImsSdmSubscription) + HSS-->>NF service consumer: 2a. 201 Created (ImsSdmSubscription) + HSS-->>NF service consumer: 2b. 4xx/5xx Client or Server Error + HSS-->>NF service consumer: 2c. 3xx Redirect + +``` + +Sequence diagram showing the NF service consumer subscribing to notifications of shared data change. The consumer sends a POST request to the HSS. The HSS responds with one of the following: 2a. 201 Created (ImsSdmSubscription), 2b. 4xx/5xx Client or Server Error, or 2c. 3xx Redirect. + +**Figure 5.3.2.3.3-1: NF service consumer subscribes to notifications of shared data change** + +1. The NF service consumer sends a POST request to the parent resource (collection of subscriptions) (.../shared-data-subscriptions), to create a subscription as present in message body. +- 2a. On success, the HSS responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.3.4 Subscriptions to notification of UE Reachability for IP + +Figure 5.3.2.3.4-1 shows a scenario where the NF service consumer (e.g. IP-SM-GW) sends a request to the HSS to subscribe to UE reachability for IP. The request contains the UE's identity (/{imsUeId}), the resource to be monitored (/access-data/ps-domain/ue-reach-subscriptions), an expiry time, a callback URI and query parameters (e.g. supported-features). + +Subscriptions to notification on UE Reachability for IP are requests for a one-time notification, i.e. after notification the subscription becomes invalid. + +![Sequence diagram showing the subscription process between an NF Service Consumer and an HSS. The consumer sends a POST request to the HSS. The HSS responds with either a 201 Created status (with subscription details), a 404 Not Found status, or a 3xx Redirect status.](1e8c50ad4fca7f315a407347dd5091cc_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. POST « ^imsUeId}/access-data/ps-domain/ue-reach-subscriptions (UeReachabilitySubscription) + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 201 Created (UeReachabilitySubscription) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram showing the subscription process between an NF Service Consumer and an HSS. The consumer sends a POST request to the HSS. The HSS responds with either a 201 Created status (with subscription details), a 404 Not Found status, or a 3xx Redirect status. + +**Figure 5.3.2.3.4-1: Subscription to notification of UE reachability for IP** + +1. The NF service consumer (e.g. IP-SM-GW) sends a POST request to the parent resource (collection of UE reachability subscriptions) (.../{ueIdentity}/ue-reach-subscriptions), to create a subscription to UE reachability for IP. The request contains an expiry time, suggested by the NF Service Consumer, representing the time upto which the subscription is desired to be kept active and the time after which the UE reachability event shall not generate a notification. +- 2a. On success, the HSS sets the URRP flag for the relevant serving nodes and may contact UDM (see 3GPP TS 23.632, clause 5.4.5). The HSS responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription. + +The response contains the expiry time, as determined by the HSS (possible based on operator policy) after which the subscription becomes invalid. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the HSS. The NF Service Producer shall not provide the same expiry time for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. + +- 2b. If the user does not exist, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.4 Unsubscribe + +#### 5.3.2.4.1 General + +The following procedures using the Unsubscribe service operation are supported: + +- Unsubscribe to notification of data change +- Unsubscribe to notification of UE reachability for IP + +#### 5.3.2.4.2 Unsubscribe to notifications of data change + +Figure 5.3.2.4.2-1 shows a scenario where the NF service consumer (e.g. S-CSCF) sends a request to the HSS to unsubscribe from notifications of data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram for Figure 5.3.2.4.2-1: NF service consumer unsubscribes to notifications. The diagram shows a DELETE request from the NF service consumer to the HSS, and the HSS responding with 204 No Content, 404 Not Found, or 3xx Redirect.](b44f89b176c971c7dd264c07bfef2c2a_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant HSS + Note right of HSS: 1. DELETE « ^imsUeId}/subscriptions/{subscriptionId} + HSS-->>NF service consumer: 2a. 204 No Content + HSS-->>NF service consumer: 2b. 404 Not Found + HSS-->>NF service consumer: 2c. 3xx Redirect +``` + +Sequence diagram for Figure 5.3.2.4.2-1: NF service consumer unsubscribes to notifications. The diagram shows a DELETE request from the NF service consumer to the HSS, and the HSS responding with 204 No Content, 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.4.2-1: NF service consumer unsubscribes to notifications** + +1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.4.3 Unsubscribe to notifications of shared data change + +Figure 5.3.2.4.3-1 shows a scenario where the NF service consumer sends a request to the HSS to unsubscribe from notifications of shared data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram for Figure 5.3.2.4.3-1: NF service consumer unsubscribes to notifications for shared data. The diagram shows a DELETE request from the NF service consumer to the HSS, and the HSS responding with 204 No Content, 404 Not Found, or 3xx Redirect.](4767b6e106f34fe8b63a6838810bf913_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant HSS + Note right of HSS: 1. DELETE « shared-data-subscriptions/{subscriptionId} + HSS-->>NF service consumer: 2a. 204 No Content + HSS-->>NF service consumer: 2b. 404 Not Found + HSS-->>NF service consumer: 2c. 3xx Redirect +``` + +Sequence diagram for Figure 5.3.2.4.3-1: NF service consumer unsubscribes to notifications for shared data. The diagram shows a DELETE request from the NF service consumer to the HSS, and the HSS responding with 204 No Content, 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.4.3-1: NF service consumer unsubscribes to notifications for shared data** + +1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.4.4 Unsubscribe to notification of UE Reachability for IP + +Figure 5.3.2.4.4-1 shows a scenario where the NF service consumer (e.g. IP-SM-GW) sends a request to the HSS to unsubscribe from notifications of UE Reachability for IP. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram showing the Unsubscribe to notification of UE reachability for IP process. The NF service consumer sends a DELETE request to the HSS. The HSS responds with one of three options: 2a. 204 No Content, 2b. 404 Not Found, or 2c. 3xx Redirect.](052543d8c9c0643b05b3ce45c6decca1_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + Note right of NF service consumer: 1. DELETE ^imsUeId}/access-data/ps-domain/ue-reach-subscriptions/{subscriptionId} + NF service consumer->>HSS: 1. DELETE request + Note right of HSS: 2a. 204 No Content +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF service consumer: 2. Response + +``` + +Sequence diagram showing the Unsubscribe to notification of UE reachability for IP process. The NF service consumer sends a DELETE request to the HSS. The HSS responds with one of three options: 2a. 204 No Content, 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.4.4-1: Unsubscription to notification of UE reachability for IP** + +1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.5 ModifySubscription + +##### 5.3.2.5.1 General + +The following procedures using the ModifySubscription service operation are supported: + +- Modification of a Subscription to notification of data change (for UE individual data) +- Modification of a Subscription to notification of shared data change +- Modification of a Subscription to notification of UE Reachability for IP + +The ModifySubscription service operation can be used for the following purpose: + +- Extend the expiry time of ImsSdmSubscription; +- Extend the expiry time of UeReachabilitySubscription; +- Modify the resource URIs to be monitored, e.g. add/remove resource URIs to/from the monitored resource URI list. + +### 5.3.2.5.2 Modification of a subscription to notifications of data change + +Figure 5.3.2.5.2-1 shows a scenario where the NF service consumer sends a request to the HSS to modify a subscription to notifications of data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram for Figure 5.3.2.5.2-1: NF service consumer modifies a subscription to notifications. The diagram shows a PATCH request from the NF service consumer to the HSS, and the corresponding response options.](73b28b0f5e3be628bb5a3d6bd1d79d21_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note right of HSS: 1. PATCH « ^imsUeld}/subscriptions/{subscriptionId} ([PatchItems]) + HSS->>NF: 2a. 200 OK (PatchResult) / 204 No Content + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect + +``` + +Sequence diagram for Figure 5.3.2.5.2-1: NF service consumer modifies a subscription to notifications. The diagram shows a PATCH request from the NF service consumer to the HSS, and the corresponding response options. + +**Figure 5.3.2.5.2-1: NF service consumer modifies a subscription to notifications** + +1. The NF service consumer sends a PATCH request to the resource identified by the URI previously received during subscription creation. + +The NF service consumer may include "monitoredResourceUris" to replace the existing monitored resource URIs, e.g. to add/remove specific resource URIs from the monitored resource URI list. + +- 2a. On success, the HSS responds with "200 OK" or "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.5.3 Modification of a subscription to notifications of shared data change + +Figure 5.3.2.5.3-1 shows a scenario where the NF service consumer sends a request to the HSS to modify a subscription to notifications of shared data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram for Figure 5.3.2.5.3-1: NF service consumer modifies a subscription to notifications for shared data. The diagram shows a PATCH request from the NF service consumer to the HSS, and the corresponding response options.](ca1fca41d037482ce500c69cf727b8aa_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note right of HSS: 1. PATCH « shared-data-subscriptions/{subscriptionId} ([PatchItems]) + HSS->>NF: 2a. 200 OK (PatchResult) / 204 No Content + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect + +``` + +Sequence diagram for Figure 5.3.2.5.3-1: NF service consumer modifies a subscription to notifications for shared data. The diagram shows a PATCH request from the NF service consumer to the HSS, and the corresponding response options. + +**Figure 5.3.2.5.3-1: NF service consumer modifies a subscription to notifications for shared data** + +1. The NF service consumer sends a PATCH request to the resource identified by the URI previously received during subscription creation. + +The NF service consumer may include "monitoredResourceUris" to replace the existing monitored resource URIs, e.g. for the purposes to add/remove specific resource URIs from the monitored resource URI list. + +- 2a. On success, the HSS responds with "200 OK" or "204 No Content". + +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.5.4 Modification of a subscription to notifications of data change + +Figure 5.3.2.5.4-1 shows a scenario where the NF service consumer sends a request to the HSS to modify a subscription to notifications of data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS for modifying a subscription. The consumer sends a PATCH request to a specific URI. The HSS responds with one of three possible status codes: 200 OK, 204 No Content, 404 Not Found, or a 3xx Redirect.](772cc583a60eeb058cc19de48269ad22_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + Note right of NF service consumer: 1. PATCH< ^imsUeId>/access-data/ps-domain/ue-reach-subscriptions/{subscriptionId} ([PatchItems]) + NF service consumer->>HSS: Request + Note left of HSS: 2a. 200 OK (PatchResult) / 204 No Content +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF service consumer: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and an HSS for modifying a subscription. The consumer sends a PATCH request to a specific URI. The HSS responds with one of three possible status codes: 200 OK, 204 No Content, 404 Not Found, or a 3xx Redirect. + +**Figure 5.3.2.5.4-1: NF service consumer modifies a subscription to notifications** + +1. The NF service consumer sends a PATCH request to the resource identified by the URI previously received during subscription creation. + +The NF service consumer includes a new expiry time, e.g. to extend the monitoring time of the event. + +- 2a. On success, the HSS responds with "200 OK" or "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.6 Notification + +##### 5.3.2.6.1 General + +The following procedures using the Notification service operation are supported: + +- Data change notification to NF; +- UE Reachability for IP notification to NF. + +##### 5.3.2.6.2 Data Change Notification To NF + +Figure 5.3.2.6.2-1 shows a scenario where the HSS notifies the NF service consumer (that has subscribed to receive such notification) about subscription data change. The request contains the callbackReference URI as previously received in the ImsSdmSubscription. + +![Sequence diagram for Subscription Data Change Notification. The HSS sends a POST {callbackReference} (Notification) to the NF service consumer. The NF service consumer responds with 2a. 204 No Content, 2b. 4xx/5xx Client or Server Error, or 2c. 3xx Redirect.](3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg) + +``` + +sequenceDiagram + participant HSS + participant NF as NF service consumer + Note right of HSS: 1. POST {callbackReference} (Notification) + HSS->>NF: 1. POST {callbackReference} (Notification) + Note left of NF: 2a. 204 No Content +2b. 4xx/5xx Client or Server Error +2c. 3xx Redirect + NF-->>HSS: 2a. 204 No Content + +``` + +Sequence diagram for Subscription Data Change Notification. The HSS sends a POST {callbackReference} (Notification) to the NF service consumer. The NF service consumer responds with 2a. 204 No Content, 2b. 4xx/5xx Client or Server Error, or 2c. 3xx Redirect. + +**Figure 5.3.2.6.2-1: Subscription Data Change Notification** + +1. The HSS sends a POST request to the callbackReference as provided by the NF service consumer during the subscription. +2. The NF service consumer responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the NF Service Consumer shall return 3xx status code, which shall contain a Location header with an URI pointing to an alternative notification endpoint. + +### 5.3.2.6.3 UE Reachability for IP Notification to NF + +Figure 5.3.2.6.3-1 shows a scenario where the HSS notifies the NF service consumer (that has subscribed to receive such notification) about subscription data change. The request contains the callbackReference URI as previously received in the UeReachabilitySubscription. + +![Sequence diagram for UE Reachability for IP Notification. The HSS sends a POST {callbackReference} (UeReachabilityNotification) to the NF service consumer. The NF service consumer responds with 2a. 204 No Content, 2b. 4xx/5xx Client or Server Error, or 2c. 3xx Redirect.](042af54276c75e7b7b48a3af1f0a84e5_img.jpg) + +``` + +sequenceDiagram + participant HSS + participant NF as NF service consumer + Note right of HSS: 1. POST {callbackReference} (UeReachabilityNotification) + HSS->>NF: 1. POST {callbackReference} (UeReachabilityNotification) + Note left of NF: 2a. 204 No Content +2b. 4xx/5xx Client or Server Error +2c. 3xx Redirect + NF-->>HSS: 2a. 204 No Content + +``` + +Sequence diagram for UE Reachability for IP Notification. The HSS sends a POST {callbackReference} (UeReachabilityNotification) to the NF service consumer. The NF service consumer responds with 2a. 204 No Content, 2b. 4xx/5xx Client or Server Error, or 2c. 3xx Redirect. + +**Figure 5.3.2.6.3-1: UE Reachability for IP Notification** + +1. The HSS sends a POST request to the callbackReference as provided by the NF service consumer during the subscription. The notification includes information about UE reachability for IP event detected. +2. The NF service consumer responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the NF Service Consumer shall return 3xx status code, which shall contain a Location header with an URI pointing to an alternative notification endpoint. + +## 5.3.2.7 Update + +### 5.3.2.7.1 General + +The following procedures using the Update service operation are supported: + +- Repository Data Create/Update/Delete + +- STN-SR update +- SMS registration information Create/Update/Delete +- PSI activation state Update +- DSAI-tag activation state Update + +### 5.3.2.7.2 Repository Data Creation or Update + +Figure 5.3.2.7.2-1 shows a scenario where the NF service consumer (IMS AS or DCSF) sends a request to the HSS to create or update the repository data for a given service indication. The request contains the UE's identity (/{imsUeId}) which shall be an IMS Public Identity, the service indication and repository data with the associated version (sequence number). + +![Sequence diagram showing the interaction between an NF Service Consumer and an HSS for repository data creation or update. The consumer sends a PUT request to the HSS, and the HSS responds with various HTTP status codes.](753e6cc5dcad1a478caa2c7ec3a6c0a3_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of NF Service Consumer: 1. PUT «/{ueId}/repository-data/{serviceIndication} (RepositoryData)» + NF Service Consumer->>HSS: Request + Note left of HSS: 2a. 200 OK / 204 No Content +2b. 201 Created +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an HSS for repository data creation or update. The consumer sends a PUT request to the HSS, and the HSS responds with various HTTP status codes. + +**Figure 5.3.2.7.2-1: Creating or updating repository data** + +1. The NF service consumer sends a PUT request to the resource representing the UE's Repository Data for a requested Service Indication. + +The NF service consumer may request the creation of the Repository Data (sequence number equal to zero) or may request the update of the Repository Data (sequence number greater than zero) + +- 2a. On success, the HSS updates the RepositoryData resource by replacing it with the received resource information, and responds with "200 OK" or "204 No Content". +- 2b. If the resource does not exist (there is no repository data associated to the requested service indication), HSS stores the received Repository Data and responds with HTTP Status Code "201 created". A response body may be included to convey additional information to the NF consumer (e.g., features supported by HSS). +- 2c. If the operation is not authorized due to e.g the NF service consumer does not have the required permissions for the service indication and the operation requested, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.7.3 Repository Data Deletion + +Figure 5.3.2.7.3-1 shows a scenario where the NF service consumer sends a request to the HSS to delete the repository data for a given service indication. The request contains the UE's identity (/{imsUeId}) which shall be an IMS Public Identity and the service indication. + +![Sequence diagram for deleting repository data. An NF Service Consumer sends a DELETE request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect.](40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of HSS: 1. DELETE « /{ueId}/repository-data/{serviceIndication} » + NF Service Consumer->>HSS: 1. DELETE request + Note left of NF Service Consumer: 2a. 204 No Content +2b. 404 Not Found +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for deleting repository data. An NF Service Consumer sends a DELETE request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect. + +**Figure 5.3.2.7.3-1: Deleting repository data** + +1. The NF service consumer sends a DELETE request to the resource representing the UE's Repository Data for a requested Service Indication. +- 2a. On success, the HSS deletes the resource and responds with "204 No Content". +- 2b. If the repository data does not exist in the HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the operation is not authorized due to e.g the NF service consumer does not have the required permissions for the service indication and operation requested, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.7.4 STN-SR update + +Figure 5.3.2.7.4-1 shows a scenario where the IMS-AS sends a request to the HSS to update the STN-SR. The request contains the UE's identity (`/{imsUeId}`) which shall be an IMS Public Identity or a Private Identity and an instruction to modify the STN-SR. + +![Sequence diagram for IMS AS updating STN-SR. An IMS AS sends a PATCH request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect.](ddfa5b18550d1a022a941e3c31843814_img.jpg) + +``` + +sequenceDiagram + participant IMS AS + participant HSS + Note right of HSS: 1. PATCH « ^imsUeId}/srvcc-data (Modification instruction) » + IMS AS->>HSS: 1. PATCH request + Note left of IMS AS: 2a. 204 No Content +2b. 404 Not Found +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>IMS AS: Response + +``` + +Sequence diagram for IMS AS updating STN-SR. An IMS AS sends a PATCH request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect. + +**Figure 5.3.2.7.4-1: IMS AS updating STN-SR** + +1. The IMS AS sends a PATCH request to the resource representing the UE's SRVCC Data. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If the resource does not exist (i.e. the user is not subscribed to SRVCC), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +- 2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions for the operation requested, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.7.5 PSI activation state update + +Figure 5.3.2.7.5-1 shows a scenario where the IMS-AS sends a request to the HSS to update the PSI activation state. The request contains the Public Service Identity (/{imsUeId}) and an instruction to modify the activation state. + +![Sequence diagram for PSI activation state update. IMS AS sends a PATCH request to HSS. HSS responds with 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect.](c5a20f7bae219fc4c31f7376b7eb11e1_img.jpg) + +``` + +sequenceDiagram + participant IMS AS + participant HSS + Note right of IMS AS: 1. PATCH « ^ ueld}/service-data/psi-state (Modification instruction) » + IMS AS->>HSS: 1. PATCH request + Note right of HSS: 2a. 204 No Content +2b. 404 Not Found +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>IMS AS: Response + +``` + +Sequence diagram for PSI activation state update. IMS AS sends a PATCH request to HSS. HSS responds with 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect. + +**Figure 5.3.2.7.5-1: IMS AS updating a PSI activation state** + +1. The IMS AS sends a PATCH request to the resource representing the PSI activation state. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If the resource does not exist (i.e. the service does not exist), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions for the operation requested, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.7.6 SMS Registration Information Creation or Update + +Figure 5.3.2.7.6-1 shows a scenario where the IMS-AS sends a request to the HSS to create or update the SMS registration information. The request contains the UE's identity (/{imsUeId}) which shall be an IMS Public Identity and the SMS registration information (IP-SM-GW number). + +![Sequence diagram for SMS Registration Information Creation or Update. IMS AS sends a PUT request to HSS. HSS responds with 2a. 200 OK / 204 No Content, 2b. 201 Created, 2c. 403 Forbidden, or 2d. 3xx Redirect.](34e9ca4d52796527c375f4bc187080f8_img.jpg) + +``` + +sequenceDiagram + participant IMS AS + participant HSS + Note right of IMS AS: 1. PUT « ^ ueld}/service-data/sms-registration-info (lpSmGwAddress) » + IMS AS->>HSS: 1. PUT request + Note right of HSS: 2a. 200 OK / 204 No Content +2b. 201 Created +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>IMS AS: Response + +``` + +Sequence diagram for SMS Registration Information Creation or Update. IMS AS sends a PUT request to HSS. HSS responds with 2a. 200 OK / 204 No Content, 2b. 201 Created, 2c. 403 Forbidden, or 2d. 3xx Redirect. + +**Figure 5.3.2.7.6-1: IMS AS creating or updating the SMS registration information** + +1. The IMS AS sends a PUT request to the resource representing the UE's SMS registration information. The request contains the IP-SM-GW number and, if s6c is supported, the Diameter Identity and Diameter Realm of the IP-SM-GW. + +If the IP-SM-GW supports SBI-based MT SM transmit, the "SBI support indication" of the IP-SM-GW shall be included in the SMS Registration Information. + +- 2a. On success, the HSS updates the SMS registration information resource by replacing it with the received resource information and responds with "200 OK" or "204 No Content". +- 2b. If the resource does not exist (there is no IP-SM-GW number associated to the user), HSS stores the received SMS registration information and responds with HTTP Status Code "201 created". A response body may be included to convey additional information to the NF consumer (e.g., features supported by HSS). +- 2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions or the IP-SM-GW number is pre-configured and cannot be overwritten, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.7.7 SMS Registration Information Deletion + +Figure 5.3.2.7.7-1 shows a scenario where the IMS-AS sends a request to the HSS to delete the SMS registration information. The request contains the UE's identity (/{imsUeId}) which shall be an IMS Public Identity. + +![Sequence diagram showing the IMS AS sending a DELETE request to the HSS for SMS registration information. The request is labeled '1. DELETE « ^ ueld}/service-data/sms-registration-info'. The HSS responds with a list of possible status codes: '2a. 204 No Content', '2b. 404 Not Found', '2c. 403 Forbidden', and '2d. 3xx Redirect'.](e3eebf9854831ba50eca8b26c468f65e_img.jpg) + +``` + +sequenceDiagram + participant IMS AS + participant HSS + Note right of HSS: 2a. 204 No Content +2b. 404 Not Found +2c. 403 Forbidden +2d. 3xx Redirect + IMS AS->>HSS: 1. DELETE « ^ ueld}/service-data/sms-registration-info + HSS-->>IMS AS: Response + +``` + +Sequence diagram showing the IMS AS sending a DELETE request to the HSS for SMS registration information. The request is labeled '1. DELETE « ^ ueld}/service-data/sms-registration-info'. The HSS responds with a list of possible status codes: '2a. 204 No Content', '2b. 404 Not Found', '2c. 403 Forbidden', and '2d. 3xx Redirect'. + +**Figure 5.3.2.7.7-1: IMS AS deleting SMS registration information** + +1. The IMS AS sends a DELETE request to the resource representing the UE's SMS registration information. +- 2a. On success, the HSS deletes the resource and responds with "204 No Content". +- 2b. If the SMS registration information does not exist in the HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions or the IP-SM-GW number is pre-configured and cannot be deleted, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.7.8 DSAI tag activation state update + +Figure 5.3.2.7.8-1 shows a scenario where the IMS-AS sends a request to the HSS to update the DSAI tag activation state. The request contains the Public Service Identity (/{imsUeId}) and an instruction to modify the activation state of DSAI tag. + +![Sequence diagram showing IMS AS sending a PATCH request to HSS for DSAI tag activation state update, and HSS responding with various HTTP status codes.](9e8ebf03cae78f4f81b697548c2d7250_img.jpg) + +``` + +sequenceDiagram + participant IMS AS + participant HSS + Note right of IMS AS: 1. PATCH « ^ueld}/service-data/dsai +(Modification instruction) + IMS AS->>HSS: 1. PATCH request + Note left of HSS: 2a. 204 No Content +2b. 404 Not Found +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>IMS AS: Response + +``` + +Sequence diagram showing IMS AS sending a PATCH request to HSS for DSAI tag activation state update, and HSS responding with various HTTP status codes. + +**Figure 5.3.2.7.8-1: IMS AS updating DSAI tag activation state** + +1. The IMS AS sends a PATCH request to the resource representing the DSAI tag activation state. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If the resource does not exist (i.e. the service does not exist), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions for the operation requested, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.4 Nhss\_imsUEAuthentication Service + +### 5.4.1 Service Description + +See 3GPP TS 23.228 [6], clause AA.2.1.4. + +### 5.4.2 Service Operations + +#### 5.4.2.1 Introduction + +For the Nhss\_imsUEAuthentication service the following service operation is defined: + +- Get + +The Nhss\_imsUEAuthentication Service is used by the S-CSCF to request the SBI capable HSS to select an authentication method, calculate a fresh authentication vector (AV) if required for the selected method, and provide it to the S-CSCF by means of the Get service operation. + +#### 5.4.2.2 Get + +##### 5.4.2.2.1 General + +The following procedures using the Get service operation are supported: + +- Authentication Information Retrieval + +#### 5.4.2.2.2 Authentication Information Retrieval + +Figure 5.4.2.2.2-1 shows a scenario where the NF service consumer (S-CSCF) retrieves authentication information for the UE from the HSS. The request contains the UE's identity (IMS Private Identity) and the SIP authentication scheme and may contain resynchronization info. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS for authentication information retrieval. The consumer sends a POST request to the HSS, and the HSS responds with a 200 OK, 403 Forbidden, or 3xx Redirect.](cc6f9dbfc36aa5821d9749ca84861f93_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + Note right of NF service consumer: 1. POST « {impi}/security-information/generate-sip-auth-data (SipAuthenticationInfoRequest) » + NF service consumer->>HSS: 1. POST « {impi}/security-information/generate-sip-auth-data (SipAuthenticationInfoRequest) » + Note left of HSS: 2a. 200 OK (SipAuthenticationInfoResult) +2b. 403 Forbidden +2c. 3xx Redirect + HSS-->>NF service consumer: 2a. 200 OK (SipAuthenticationInfoResult) +2b. 403 Forbidden +2c. 3xx Redirect + +``` + +Sequence diagram showing the interaction between an NF service consumer and an HSS for authentication information retrieval. The consumer sends a POST request to the HSS, and the HSS responds with a 200 OK, 403 Forbidden, or 3xx Redirect. + +**Figure 5.4.2.2.2-1: NF service consumer requesting authentication information** + +1. The NF service consumer sends a POST request (custom method: generate-sip-auth-data) to the resource representing the UE's security information. The content shall contain the S-CSCF name, SIP authentication scheme and the resynchronization info. +- 2a. The HSS responds with "200 OK" with the message body containing the authentication data information. +- 2b. If the operation cannot be authorized due to e.g UE does not have required subscription data, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.5 Nhss\_gbaSubscriberDataManagement Service + +#### 5.5.1 Service Description + +See 3GPP TS 33.220 [6], clause X.2.1.2. + +#### 5.5.2 Service Operations + +##### 5.5.2.1 Introduction + +For the Nhss\_gbaSubscriberDataManagement service the following service operations are defined: + +- Get +- Subscribe +- Unsubscribe +- Modification of subscription +- Notification + +The Nhss\_gbaSubscriberDataManagement Service is used by Consumer NFs (GBA BSF) to: + +- fetch the GBA subscriber data for the UE + +- subscribe/unsubscribe, and to be notified, when data previously requested have changed + +## 5.5.2.2 Get + +### 5.5.2.2.1 General + +The following procedures using the Get service operation are supported: + +- Retrieval of GBA subscriber data + +### 5.5.2.2.2 Retrieval of GBA subscriber data + +Figure 5.5.2.2.2-1 shows a scenario where the GBA BSF sends a request to the HSS to retrieve the GBA subscriber data. The request contains the UE's identity (`/{ueId}`) which shall be one of IMSI, MSISDN, IMPI, IMPU. + +![Sequence diagram showing the retrieval of GBA subscriber data. The GBA BSF sends a GET request to the HSS. The HSS responds with one of the following: 2a. 200 OK (GbaSubscriberData), 2b. 403 Forbidden, 2c. 404 Not Found, or 2d. 3xx Redirect.](42c65f5cb106938992fc73c05c8713d2_img.jpg) + +``` + +sequenceDiagram + participant GBA BSF + participant HSS + Note right of HSS: 2a. 200 OK (GbaSubscriberData) +2b. 403 Forbidden +2c. 404 Not Found +2d. 3xx Redirect + GBA BSF->>HSS: 1. GET « ^ueId}/gba-subscriber-data + HSS-->>GBA BSF: 2a. 200 OK (GbaSubscriberData) +2b. 403 Forbidden +2c. 404 Not Found +2d. 3xx Redirect + +``` + +Sequence diagram showing the retrieval of GBA subscriber data. The GBA BSF sends a GET request to the HSS. The HSS responds with one of the following: 2a. 200 OK (GbaSubscriberData), 2b. 403 Forbidden, 2c. 404 Not Found, or 2d. 3xx Redirect. + +**Figure 5.5.2.2.2-1: Retrieval of GBA subscriber data** + +1. The GBA BSF sends a GET request to the resource representing the UE's GBA subscriber data. +- 2a. Upon success, the HSS responds with "200 OK" with the GBA subscriber data (containing, e.g. the GBA User Security Settings, GUSS) in the response body, and HSS supported features. +- 2b. If the operation is not authorized due to, e.g. received UE identity not being allowed for GBA services, or the requesting node not being authorized to fetch the requested data, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). +- 2c. If the UE identity is not found in HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.5.2.3 Subscribe + +### 5.5.2.3.1 General + +The following procedures using the Subscribe service operation are supported: + +- Subscription to changes on the GBA subscriber data + +### 5.5.2.3.2 Subscription to changes on the GBA subscriber data + +Figure 5.5.2.3.2-1 shows a scenario where the GBA BSF sends a request to the HSS to subscribe to changes on a previously retrieved GBA subscriber data. The request contains the UE's identity (`/{ueId}`) which shall be one of IMSI, MSISDN, IMPI, IMPU. + +![Sequence diagram for Figure 5.5.2.3.2-1: Subscription to changes on the GBA subscriber data. The diagram shows a GBA BSF sending a POST request to an HSS. The request is '1. POST « ^{ueId}/subscriptions (GbaSdmSubscription)'. The HSS responds with a list of possible status codes: '2a. 200 OK (GbaSdmSubscription)', '2b. 403 Forbidden', '2c. 404 Not Found', and '2d. 3xx Redirect'.](3337af75dfee8af7687b4f49914d6c93_img.jpg) + +``` + +sequenceDiagram + participant GBA BSF + participant HSS + GBA BSF->>HSS: 1. POST « ^{ueId}/subscriptions (GbaSdmSubscription) + Note over GBA BSF, HSS: 2a. 200 OK (GbaSdmSubscription) +2b. 403 Forbidden +2c. 404 Not Found +2d. 3xx Redirect + HSS-->>GBA BSF: + +``` + +Sequence diagram for Figure 5.5.2.3.2-1: Subscription to changes on the GBA subscriber data. The diagram shows a GBA BSF sending a POST request to an HSS. The request is '1. POST « ^{ueId}/subscriptions (GbaSdmSubscription)'. The HSS responds with a list of possible status codes: '2a. 200 OK (GbaSdmSubscription)', '2b. 403 Forbidden', '2c. 404 Not Found', and '2d. 3xx Redirect'. + +**Figure 5.5.2.3.2-1: Subscription to changes on the GBA subscriber data** + +1. The GBA BSF sends a POST request to the collection resource representing the subscriptions to changes on the UE's GBA subscriber data. The request body contains a URI where subsequent notification shall be sent by HSS. +- 2a. Upon success, the HSS responds with "200 OK" with the GBA SDM subscription data in the response body, and HSS supported features. +- 2b. If the operation is not authorized due to, e.g. received UE identity not being allowed for GBA services, or the requesting node not being authorized to subscribe to changes on GBA subscriber data, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). +- 2c. If the UE identity is not found in HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.5.2.4 Unsubscribe + +### 5.5.2.4.1 General + +The following procedures using the Unsubscribe service operation are supported: + +- Unsubscribe to changes on the GBA subscriber data + +### 5.5.2.4.2 Unsubscribe to changes on the GBA subscriber data + +Figure 5.5.2.4.2-1 shows a scenario where the GBA BSF sends a request to the HSS to unsubscribe to changes on a previously retrieved GBA subscriber data. The request contains the UE's identity (/ {ueId}) which shall be one of IMSI, MSISDN, IMPI, IMPU. + +![Sequence diagram for Figure 5.5.2.4.2-1: Deletion of a subscription to changes on the GBA subscriber data. The diagram shows a GBA BSF sending a DELETE request to an HSS. The request is '1. DELETE « ^{ueId}/subscriptions/{subscriptionId}'. The HSS responds with a list of possible status codes: '2a. 204 No Content', '2b. 403 Forbidden', '2c. 404 Not Found', and '2d. 3xx Redirect'.](818a57b74294582a480f23f82d95815f_img.jpg) + +``` + +sequenceDiagram + participant GBA BSF + participant HSS + GBA BSF->>HSS: 1. DELETE « ^{ueId}/subscriptions/{subscriptionId} + Note over GBA BSF, HSS: 2a. 204 No Content +2b. 403 Forbidden +2c. 404 Not Found +2d. 3xx Redirect + HSS-->>GBA BSF: + +``` + +Sequence diagram for Figure 5.5.2.4.2-1: Deletion of a subscription to changes on the GBA subscriber data. The diagram shows a GBA BSF sending a DELETE request to an HSS. The request is '1. DELETE « ^{ueId}/subscriptions/{subscriptionId}'. The HSS responds with a list of possible status codes: '2a. 204 No Content', '2b. 403 Forbidden', '2c. 404 Not Found', and '2d. 3xx Redirect'. + +**Figure 5.5.2.4.2-1: Deletion of a subscription to changes on the GBA subscriber data** + +1. The GBA BSF sends a DELETE request to the resource representing the individual subscription (subscriptionID) to changes on the UE's GBA subscriber data. +- 2a. Upon success, the HSS responds with "204 No Content". + +- 2b. If the operation is not authorized due to, e.g. received UE identity not being allowed for GBA services, or the requesting node not being authorized to subscribe/unsubscribe to changes on GBA subscriber data, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). +- 2c. If the UE identity is not found in HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.5.2.5 Modification of Subscription + +### 5.5.2.5.1 General + +The following procedures using the Modification of Subscription service operation are supported: + +- Modification of Subscription to changes on the GBA subscriber data + +### 5.5.2.5.2 Modification of Subscription to changes on the GBA subscriber data + +Figure 5.5.2.5.2-1 shows a scenario where the GBA BSF sends a request to the HSS to modify a subscription to changes (e.g. to extend its expiration lifetime) on a previously retrieved GBA subscriber data. The request contains the UE's identity (/ {ueId}) which shall be one of IMSI, MSISDN, IMPI, IMPU. + +![Sequence diagram showing the interaction between GBA BSF and HSS for modifying a subscription. The GBA BSF sends a PATCH request to the HSS. The HSS responds with one of the following status codes: 2a. 200 OK, 2b. 204 No Content, 2c. 403 Forbidden, 2d. 404 Not Found, or 2e. 3xx Redirect.](d4ed35f72863013455b8f015e0f2e47e_img.jpg) + +``` + +sequenceDiagram + participant GBA BSF + participant HSS + Note right of HSS: 2a. 200 OK +2b. 204 No Content +2c. 403 Forbidden +2d. 404 Not Found +2e. 3xx Redirect + GBA BSF->>HSS: 1. PATCH « ^ ueId}/subscriptions/{subscriptionId} + HSS-->>GBA BSF: Response + +``` + +Sequence diagram showing the interaction between GBA BSF and HSS for modifying a subscription. The GBA BSF sends a PATCH request to the HSS. The HSS responds with one of the following status codes: 2a. 200 OK, 2b. 204 No Content, 2c. 403 Forbidden, 2d. 404 Not Found, or 2e. 3xx Redirect. + +**Figure 5.5.2.5.2-1: Modification of Subscription to changes on the GBA subscriber data** + +1. The GBA BSF sends a PATCH request to the resource representing the individual subscription to changes on the UE's GBA subscriber data (identified by its subscriptionID). +- 2a. Upon success, if some of the changes, but not all, have been accepted, the HSS responds with "200 OK" with the new GBA SDM subscription data in the response body. +- 2b. Upon success, if all the changes have been accepted, the HSS responds with "204 No Content". +- 2c. If the operation is not authorized due to the requesting node not being authorized to modify the subscription to changes on GBA subscriber data, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). +- 2d. If the subscriptionId is not found in HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.5.2.5 Notify + +### 5.5.2.5.1 General + +The following procedures using the Notify service operation are supported: + +- Notification of changes on the GBA subscriber data + +### 5.5.2.5.2 Notification of changes on the GBA subscriber data + +Figure 5.5.2.5.2-1 shows a scenario where the HSS sends a notification to the GBA BSF to inform of changes on a previously retrieved GBA subscriber data. + +![Sequence diagram showing the notification process between GBA BSF and HSS. The GBA BSF sends a POST request to the HSS. The HSS responds with one of three options: 2a. 204 No Content, 2b. 404 Not Found, or 2c. 3xx Redirect.](b5987d63203a5fa601921039922ac520_img.jpg) + +``` + +sequenceDiagram + participant GBA BSF + participant HSS + Note right of HSS: 1. POST {notificationUri} (ModificationNotification) + HSS->>GBA BSF: 2a. 204 No Content + Note right of GBA BSF: 2b. 404 Not Found + Note right of GBA BSF: 2c. 3xx Redirect + +``` + +Sequence diagram showing the notification process between GBA BSF and HSS. The GBA BSF sends a POST request to the HSS. The HSS responds with one of three options: 2a. 204 No Content, 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.5.2.5.2-1: Subscription to changes on of GBA User Security data** + +1. The GBA BSF sends a POST request to the notification URI previously provided by the GBA BSF during the subscription request (see clause 5.5.2.3.1). +- 2a. Upon success, the HSS responds with "204 No Content". +- 2b. If the UE identity contained in the NotificationData is not found in GBA BSF, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). + +In the case of redirection, the GBA BSF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another GBA BSF instance capable of handling the notification request. + +## 5.6 Nhss\_gbaUEAuthentication Service + +### 5.6.1 Service Description + +See 3GPP TS 33.220 [6], clause X.2.1.3. + +### 5.6.2 Service Operations + +#### 5.6.2.1 Introduction + +For the Nhss\_gbaUEAuthentication service the following service operations are defined: + +- Get + +The Nhss\_gbaUEAuthentication Service is used by Consumer NFs (GBA BSF) to: + +- request the authentication data of the UE + +## 5.6.2.2 Get + +### 5.6.2.2.1 General + +The following procedures using the Get service operation are supported: + +- Request UE authentication data + +### 5.6.2.2.2 Request UE authentication data + +Figure 5.6.2.2.2-1 shows a scenario where the GBA BSF sends a request to the HSS to retrieve UE authentication data (authentication vectors) for GBA. The request contains the UE's identity (`{ueId}`) which shall be one of IMSI, MSISDN, IMPI, IMPU. + +![Sequence diagram showing the request for UE authentication data. The GBA BSF sends a POST request to the HSS. The HSS responds with a 200 OK, 403 Forbidden, 404 Not Found, or 3xx Redirect.](8afb16b644b2fe89d5c34251c3e6bf0c_img.jpg) + +``` + +sequenceDiagram + participant GBA BSF + participant HSS + Note right of GBA BSF: 1. POST « ^ueId}/security-information/generate-auth-data +(AuthenticationInfoRequest) + GBA BSF->>HSS: 1. POST request + Note left of HSS: 2a. 200 OK (AuthenticationInfoResult) +2b. 403 Forbidden +2c. 404 Not Found +2d. 3xx Redirect + HSS-->>GBA BSF: Response + +``` + +Sequence diagram showing the request for UE authentication data. The GBA BSF sends a POST request to the HSS. The HSS responds with a 200 OK, 403 Forbidden, 404 Not Found, or 3xx Redirect. + +**Figure 5.6.2.2.2-1: Request UE authentication data** + +1. The GBA BSF sends a POST request (custom method: generate-auth-data) to the HSS. +- 2a. Upon success, the HSS responds with "200 OK" with the AuthenticationInfoResult data structure (containing authentication vectors) in the response body, and HSS supported features. +- 2b. If the operation is not authorized due to, e.g. received UE identity not being allowed for GBA services, or the requesting node not being authorized to fetch the requested data, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). +- 2c. If the UE identity is not found in HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 6 API Definitions + +### 6.1 Nhss\_imsUEContextManagement Service API + +#### 6.1.1 Introduction + +URIs of this API shall have the following root: + +`{apiRoot}/{apiName}/{apiVersion}/` + +where "apiRoot" is defined in clause 4.4.1 of 3GPP TS 29.501 [5], the "apiName" shall be set to "nhss-ims-uecm" and the "apiVersion" shall be set to "v1" for the current version of this specification. + +## 6.1.2 Usage of HTTP + +### 6.1.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nhss\_imsUECM service shall comply with the OpenAPI [9] specification contained in Annex A.2. + +### 6.1.2.2 HTTP standard headers + +#### 6.1.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +#### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [10], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 9457 [11]) signalled by the content type "application/problem+json". +- JSON Patch, as defined in IETF RFC 6902 [12], signalled by the content type "application/json-patch+json". + +### 6.1.2.3 HTTP custom headers + +#### 6.1.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.1.3 Resources + +### 6.1.3.1 Overview + +![Figure 6.1.3.1-1: Resource URI structure of the Nhss_imsUECM API. The diagram shows a hierarchical tree structure starting from {apiRoot}/nhss-ims-uecm/v1. It branches into two main paths: one starting with /{imsUeId} which further branches into /scscf-registration and then /scscf-restoration-info; the other starting with /{impu} which branches into /authorize. The /authorize box is dashed.](4cd9eeaee1deb05bf88a8abf02ff7d7f_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nhss-ims-uecm/v1"] --> imsUeId["/{imsUeId}"] + Root --> impu["/{impu}"] + imsUeId --> scscfRegistration["/scscf-registration"] + scscfRegistration --> scscfRestorationInfo["/scscf-restoration-info"] + impu --> authorize["/authorize"] + style authorize stroke-dasharray: 5 5 + +``` + +Figure 6.1.3.1-1: Resource URI structure of the Nhss\_imsUECM API. The diagram shows a hierarchical tree structure starting from {apiRoot}/nhss-ims-uecm/v1. It branches into two main paths: one starting with /{imsUeId} which further branches into /scscf-registration and then /scscf-restoration-info; the other starting with /{impu} which branches into /authorize. The /authorize box is dashed. + +**Figure 6.1.3.1-1: Resource URI structure of the Nhss\_imsUECM API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name (Archetype) | Resource URI | HTTP method or custom operation | Description | +|-----------------------------------------|------------------------------------------------------|---------------------------------|----------------------------------------------------------| +| SscfRegistration (Document) | /{imsUeId}/scscf-registration | PUT | Create or update the S-CSCF registration state of the UE | +| Authorize (Custom operation) | /{impu}/authorize | authorize (POST) | Authorize the requested operation for the UE | +| Sscf Restoration Information (Document) | /{imsUeId}/scscf-registration/scscf-restoration-info | GET | Retrieve the S-CSCF restoration information. | +| | | PUT | Update the S-CSCF restoration information. | +| | | DELETE | Delete the S-CSCF restoration information. | + +### 6.1.3.2 Resource: Sscf Registration + +#### 6.1.3.2.1 Description + +This resource represents the registered S-CSCF. + +#### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-uecm/{apiVersion}/{imsUeId}/scscf-registration + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1 | +| imsUeId | Represents the IMS Subscription Identifier, either the IMS Public Identity (i.e. IMPU or Public PSI) or the Private Identity (i.e. IMPI or PSI). See 3GPP TS 23.228 [6] clause 4.3).
IMS Public Identity is used with the PUT method;
IMS Public Identity or IMS Private Identity is used with the PATCH methods.

Pattern: "^(impu-sip:\{[a-zA-Z0-9 \-\.!~*()&=+\$\,:?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\+\. \+)[a-z]{2,} impu-tel:\+\{0-9\}{5,15} impi-\+\. \+)\$" | + +### 6.1.3.2.3 Resource Standard Methods + +#### 6.1.3.2.3.1 PUT + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| ScscfRegistration | M | 1 | S-CSCF registration for indicated IMS Public Identity is updated with the received information. | + +**Table 6.1.3.2.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ScscfRegistration | M | 1 | 201 Created | A response body containing a representation of the created individual scscfRegistration resource for the received IMS Public Identity shall be returned. | +| ScscfRegistration | M | 1 | 200 OK | A response body containing a representation of the updated individual scscfRegistration resource for the received IMS Public Identity shall be returned. | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ExtendedProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- IDENTITY_ALREADY_REGISTERED In this case include invalidParams with cscfServerName as param and with value of the currently assigned S-CSCF name in the AdditionalInfo
- IDENTITIES_DO_NOT_MATCH
- ERROR_IN_REGISTRATION_TYPE | + +**Table 6.1.3.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.3.2.3.1-6: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nhss-ims-uecm/{apiVersion}/{imsUeId}/scscf-registration | + +#### 6.1.3.2.4 Resource Custom Operations + +There are no custom operations associated to resources. + +### 6.1.3.3 Resource: Scscf Restoration Information + +#### 6.1.3.3.1 Description + +This resource represents the IMS restoration information. It is queried by the service consumer (S-CSCF) to retrieve the information required for an S-CSCF to handle the requests for a user. + +#### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-uecm/{apiVersion}/{imsUeId}/scscf-registration/scscf-restoration-info + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: " ^ (impu-sip:\{([a-zA-Z0-9_-!~*()&=+;\$,;?V +])@([A-Za-z0-9]+([A-Za-z0-9-]+\.[a-z]{2,} impu-tel:\{[0-9]{5,15} impi-.\{+\})\$" | + +### 6.1.3.3.3 Resource Standard Methods + +#### 6.1.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.1.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ScscfRestorationInfoResponse | M | 1 | 200 OK | A response body containing information for the S-CSCF to handle the requests for a user. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- DATA_NOT_FOUND

NOTE: DATA_NOT_FOUND indicates that there is no restoration info stored under the scscf-registration resource. | + +**Table 6.1.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.1.3.3.3.2 PUT + +This method shall support the URI query parameters specified in table 6.1.3.3.3.2-1. + +**Table 6.1.3.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.3.3.2-3. + +**Table 6.1.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------| +| SscfRestorationInfoRequest | M | 1 | S-CSCF restoration information for indicated IMS Public Identity is updated with the received information. | + +**Table 6.1.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SscfRestorationInfoResponse | M | 1 | 201 Created | Upon success, a response body containing a representation of the created individual SscfRestorationInfo resource for the received IMS Public Identity shall be returned. | +| SscfRestorationInfoResponse | M | 1 | 200 OK | Upon success, a response body containing a representation of the updated individual SscfRestorationInfo resource shall be returned. | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- OPERATION_NOT_ALLOWED

NOTE: OPERATION_NOT_ALLOWED indicates the S-CSCF is not allowed to create/update the restoration information. | + +**Table 6.1.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.3.3.3.2-6: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nhss-ims-uecm/{apiVersion}/{imsUeId}/scscf-registration/scscf-restoration-info | + +### 6.1.3.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.1.3.3.3.3-1. + +**Table 6.1.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.3-2 and the response data structures and response codes specified in table 6.1.3.3.3.3-3. + +**Table 6.1.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | M | 1 | The request body shall be empty. | + +**Table 6.1.3.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- OPERATION_NOT_ALLOWED

NOTE: OPERATION_NOT_ALLOWED indicates the S-CSCF is not allowed to delete the restoration information stored in the HSS. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- DATA_NOT_FOUND

NOTE: DATA_NOT_FOUND indicates that there is no restoration info stored under the scscf-registration resource. | + +**Table 6.1.3.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.3.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.1.4 Custom Operations without associated resources + +### 6.1.4.1 Overview + +**Table 6.1.4.1-1: Custom operations without associated resources** + +| Custom operation URI | Mapped HTTP method | Description | +|----------------------|--------------------|----------------------------------------------| +| /{impu}/authorize | POST | Authorize the requested operation for the UE | + +### 6.1.4.2 Operation: Authorize + +#### 6.1.4.2.1 Description + +This resource represents the information that is needed to authorize a UE to register or establish sessions in the IMS domain. See 3GPP TS 23.228 [6]. + +#### 6.1.4.2.2 Operation Definition + +This resource shall support the resource URI variables defined in table 6.1.4.2.2-1. + +**Table 6.1.4.2.2-1: URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1 | +| impu | Represents the IMS Public Identity (i.e. IMPU or Public PSI). See 3GPP TS 23.228 [6] clause 4.3). | + +This operation shall support the request data structures specified in table 6.1.4.2.2-1 and the response data structure and response codes specified in table 6.1.4.2.2-2. + +**Table 6.1.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------| +| AuthorizationRequest | M | 1 | Contains input for authorization, such as the authorization type or the visited network identifier. | + +**Table 6.1.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| AuthorizationResponse | M | 1 | 200 OK | A response body containing result information or the registered S-CSCF shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- IDENTITY_NOT_REGISTERED | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AUTHORIZATION_REJECTED
- IDENTITIES_DONT_MATCH | + +**Table 6.1.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.1.5 Notifications + +### 6.1.5.1 General + +### 6.1.5.2 Deregistration Notification + +The POST method shall be used for Deregistration Notifications and the URI shall be as provided during the registration procedure. + +Resource URI: {callbackReference} + +Support of URI query parameters is specified in table 6.1.5.2-1. + +**Table 6.1.5.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.1.5.2-2 and of response data structures and response codes is specified in table 6.1.5.2-3. + +**Table 6.1.5.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|------------------------------------------------------------------| +| DeregistrationData | M | 1 | Includes Deregistration Reason and identities to be deregistered | + +**Table 6.1.5.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| DeregistrationData | | | 200 OK | Upon success or partial success, DeregistrationData shall be returned including additional information about the result of the procedure. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- CONTEXT_NOT_FOUND | + +**Table 6.1.5.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the notification endpoint of the subscribing NF Service Consumer. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.5.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the notification endpoint of the subscribing NF Service Consumer. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.1.6 Data Model + +### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nhss\_imsUECM service-based interface protocol. + +**Table 6.1.6.1-1: Nhss\_imsUECM specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|------------------------------|----------------|----------------------------------------------------------------------------------------------------------|---------------| +| AuthorizationRequest | 6.1.6.2.2 | Information for the type of authorization requested and the visited PLMN-ID | | +| AuthorizationResponse | 6.1.6.2.3 | Result of the authorization requested for registration. | | +| ScscfRestorationInfo | 6.1.6.2.4 | Information required for an S-CSCF to handle the requests for a user. | | +| ScscfRestorationInfoRequest | 6.1.6.2.5 | Scscf restoration information request. | | +| ScscfRestorationInfoResponse | 6.1.6.2.6 | Result of the scscf restoration information request. | | +| RestorationInfo | 6.1.6.2.7 | Information related to a specific registration required for an S-CSCF to handle the requests for a user. | | +| UeSubscriptionInfo | 6.1.6.2.8 | UE's subscription information. | | +| PscsfSubscriptionInfo | 6.1.6.2.9 | P-CSCF's subscription information. | | +| ScscfRegistration | 6.1.6.2.10 | Registration information of the S-CSCF for the registered UE. | | +| ExtendedProblemDetails | 6.1.6.2.11 | | | +| AdditionalInfo | 6.1.6.2.12 | | | +| DeregistrationData | 6.1.6.2.13 | | | +| DeregistrationReason | 6.1.6.2.14 | | | +| EmergencyRegisteredIdentity | 6.1.6.2.15 | | | + +Table 6.1.6.1-2 specifies data types re-used by the Nhss\_imsUECM service-based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nhss\_imsUECM service-based interface. + +**Table 6.1.6.1-2: Nhss\_imsUECM re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------------------------|---------------------|-----------------------------------------------------------------------------|---------------| +| Uri | 3GPP TS 29.571 [16] | Uniform Resource Identifier | | +| SupportedFeatures | 3GPP TS 29.571 [16] | see 3GPP TS 29.500 [4] clause 6.6 | | +| DateTime | 3GPP TS 29.571 [16] | String with format "date-time" as defined in OpenAPI Specification [9] | | +| ProblemDetails | 3GPP TS 29.571 [16] | Response body of error response messages. | | +| RedirectResponse | 3GPP TS 29.571 [16] | Response body of redirect response messages. | | +| ScscfSelectionAssistanceInformation | 6.2.6.2.51 | This information shall be used by the I-CSCF to select an S-CSCF for the UE | | + +## 6.1.6.2 Structured data types + +### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 6.1.6.2.2 Type: AuthorizationRequest + +**Table 6.1.6.2.2-1: Definition of type AuthorizationRequest** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| authorizationType | AuthorizationType | M | 1 | Contains the type of the authorization requested | | +| impi | Impi | O | 1 | Contains an IMS Private User Identity. It shall be present when the authorization requested is for a registration or de-registration. | | +| visitedNetworkIdentifier | string | O | 1 | Contains the identifier of the visited network where the P-CSCF is located. It shall be present when the authorization requested is for a registration or de-registration. | | + +### 6.1.6.2.3 Type: AuthorizationResponse + +**Table 6.1.6.2.3-1: Definition of type AuthorizationResponse** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|------------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| authorizationResult | AuthorizationResult | M | 1 | Contains the details of the granted authorization. | | +| cscfServerName | string | C | 0..1 | Contains the stored S-CSCF name in SIP URI format. It shall be present if there is a S-CSCF name stored for the associated IMS subscription. | | +| sccfSelectionAssistanceInfo | SccfSelectionAssistanceInformation | C | 0..1 | Contains information needed by the I-CSCF to select an S-CSCF for the UE. Shall be present if cscfServerName is absent. | | + +### 6.1.6.2.4 Type: SccfRestorationInfo + +**Table 6.1.6.2.4-1: Definition of type SccfRestorationInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|-------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| userName | Uri | O | 0..1 | Registered Private Identity of the user for whom the data is required. If the userName is NULL, it means that an S-CSCF request all registrations for all the private identities registered in the S-CSCF. | | +| restorationInfo | array(RestorationInfo) | O | 0..N | This IE shall contain the information related to a specific registration required for an S-CSCF to handle the requests for a user. | | +| registrationTimeout | DateTime | O | 1 | This IE indicates the point of time at which the UE's registration expires. | | +| sipAuthenticationScheme | SipAuthenticationScheme | O | 1 | This IE indicates the authentication scheme to be used in the authentication of SIP requests. | | + +## 6.1.6.2.5 Type: ScscfRestorationInfoRequest + +**Table 6.1.6.2.5-1: Definition of type ScscfRestorationInfoRequest** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------| +| scscfRestorationInfoRequest | ScscfRestorationInfo | M | 1 | This IE shall contain the information related to a specific registration required for an S-CSCF to handle the requests for the users. | | + +## 6.1.6.2.6 Type: ScscfRestorationInfoResponse + +**Table 6.1.6.2.6-1: Definition of type ScscfRestorationInfoResponse** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------|---------------| +| scscfRestorationInfoResponse | array(ScscfRestorationInfo) | M | 1..N | This IE shall contain the response information related to a specific or all registrations required for an S-CSCF. | | + +## 6.1.6.2.7 Type: RestorationInfo + +**Table 6.1.6.2.7-1: Definition of type RestorationInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------|---------------| +| path | string | M | 1 | This IE shall contain a comma separated list of SIP proxies in the Path header. | | +| contact | string | M | 1 | This IE shall contain the Contact Addresses and Parameters in the Contact header. | | +| initialCSeqSequenceNumber | Uint32 | O | 1 | This IE contains the sequence number of the CSeq header field contained in the initial successful REGISTER request. | | +| callIdSipHeader | string | O | 1 | This IE contains the information in the Call-ID header. | | +| uesubscriptionInfo | UeSubscriptionInfo | O | 1 | This IE contains the UE's subscription information. | | +| pcscfSubscriptionInfo | PcscfSubscriptionInfo | O | 1 | This IE contains the P-CSCF's subscription information. | | +| imsSdmSubscriptions | map(ImsSdmSubscription) | O | 1..N | A map (list of key-value pairs where subscriptionId serves as key) of imsSdmSubscriptions. | | + +## 6.1.6.2.8 Type: UeSubscriptionInfo + +**Table 6.1.6.2.8-1: Definition of type UeSubscriptionInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------|---|-------------|-----------------------------------------------------------------------------------|---------------| +| callIdSipHeader | string | M | 1 | This IE contains the information in the Call-ID header. | | +| fromSipHeader | string | M | 1 | This IE shall contain the information in the From header. | | +| toSipHeader | string | M | 1 | This IE shall contain the information in the To header. | | +| recordRoute | string | M | 1 | This IE shall contain a comma separated list of Record Route header(s). | | +| contact | string | M | 1 | This IE shall contain the Contact Addresses and Parameters in the Contact header. | | + +## 6.1.6.2.9 Type: PscfSubscriptionInfo + +**Table 6.1.6.2.9-1: Definition of type PscfSubscriptionInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------|---|-------------|-----------------------------------------------------------------------------------|---------------| +| callIdSipHeader | string | M | 1 | This IE contains the information in the Call-ID header. | | +| fromSipHeader | string | M | 1 | This IE shall contain the information in the From header. | | +| toSipHeader | string | M | 1 | This IE shall contain the information in the To header. | | +| contact | string | M | 1 | This IE shall contain the Contact Addresses and Parameters in the Contact header. | | + +6.1.6.2.10 Type: ScscfRegistration + +**Table 6.1.6.2.10-1: Definition of type ScscfRegistration** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| imsRegistrationType | ImsRegistrationType | M | 1 | Contains the type of the registration/deregistration requested. | | +| impi | Impi | C | 1 | Contains an IMS Private Identity. It may be absent during the originating or terminating request to an unregistered Public Identity (imsRegistrationType shall contain the value UNREGISTERED_USER) | | +| cscfServerName | String | M | 1 | Contains the S-CSCF name in SIP URI format. | | +| cscfInstanceId | NfInstanceId | M | 1 | The NF instance id of the S-CSCF. | | +| deregCallbackUri | Uri | C | 1 |

A URI provided by the S-CSCF to receive (implicitly subscribed) notifications on deregistration. The deregistration callback URI shall have unique information within S-CSCF set to identify the IMS Public Identity to be deregistered.

If there are implicitly identities registered (i.e. the identity belongs to an IRS) in the response, the deregistration callback URI identifies the IRS to be deregistered.

If there is a wildcarded PSI unregistered received in the response, the deregistration callback URI identifies the wildcarded PSI to be deregistered.

| | +| associatedImpis | array(Impi) | O | 1..N | Associated IMS private identities in the subscription. If the IMS subscription contains only single Private Identity this attribute shall not be present.
(NOTE) | | +| associatedRegisteredImpis | array(Impi) | O | 1..N | Associated registered IMS private identities in the subscription.
(NOTE) | | +| irsImpus | array(Impu) | O | 1..N | List of non barred IMS Public User Identities (distinct or wildcarded) which are in the Implicit Registration Set. This attribute shall be present when the received public identity belongs to an IRS.
(NOTE) | | +| wildcardedPui | Impu | O | 1 | It shall be present when the Public Identity in the request fell within the range of a Wildcarded Public User Identity present in the IRS.
(NOTE) | | +| wildcardedPsi | Impu | O | 1 |

It shall be present if the Public Identity in the request fell within the range of a Wildcarded Public Service Identity in the HSS whose state is unregistered.

If this element is present, it shall be used by the S-CSCF to identify the identity affected by the request.
(NOTE)

| | +| looseRouteIndicator | LooseRouteIndication | O | 1 | Loose Routing Indicator
(NOTE) | | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.2.8 | | +| multipleRegistrationIndicator | boolean | C | 1 | Contains the multiple registration indication. If included, when it is set to true it indicates multiple registration. | | + +| | | | | | +|----------------------------------------------------------------|---------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| pcscfRestorationIndicator | boolean | C | 0..1 | true: indicates that the P-CSCF-Restoration-mechanism shall be executed by the HSS.
false or absent: P-CSCF-Restoration is not requested.
May be present if imsRegistrationType is "UNREGISTERED_USER" or "ADMINISTRATIVE_DEREGISTRATION"; otherwise shall be absent. | +| scscfReselectionIndicator | boolean | C | 0..1 | true: indicates that the S-CSCF has been selected due to, e.g. failure of the previously assigned S-CSCF.
false or absent: no S-CSCF reselection requested | +| NOTE: Optional attribute applicable in response messages only. | | | | | + +#### 6.1.6.2.11 Type: ExtendedProblemDetails + +**Table 6.1.6.2.11-1: Definition of type ExtendedProblemDetails** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|-------------------------------------------------------------------------------------------------------------| +| problemDetails | ProblemDetails | M | 1 | More information on the error shall be provided in the "cause" attribute of the "ProblemDetails" structure. | +| additionalInfo | AdditionalInfo | O | 1 | Contains the currently assigned S-CSCF name in SIP URI format. | + +#### 6.1.6.2.12 Type: AdditionalInfo + +**Table 6.1.6.2.12-1: Definition of type AdditionalInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------| +| scscfServerName | String | O | 1 | Current S-CSCF assigned to the user (in SIP URI format). This attribute shall be included when "cause" is IDENTITY_ALREADY_REGISTERED. | + +#### 6.1.6.2.13 Type: DeregistrationData + +**Table 6.1.6.2.13-1: Definition of type DeregistrationData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------|------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| deregReason | DeregistrationReason | M | 1 | Indicates the reason for the deregistration. | | +| impi | Impi | M | 1 | Contains the IMS Private User Identity known by the S-CSCF. | | +| associatedImpis | Array(Impi) | O | 0..N | Associated IMS private Identities in the subscription that are deregistered.

This attribute may be present in responses, otherwise, it shall be absent. | | +| emergencyRegisteredIdentities | array(EmergencyRegisteredIdentity) | O | 1..N | A list of pairs of private and public user identities which have not been deregistered due to emergency registration.

This attribute may be present in responses, otherwise, it shall be absent. | | + +#### 6.1.6.2.14 Type: DeregistrationReason + +**Table 6.1.6.2.14-1: Definition of type DeregistrationReason** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|----------------------------------------------------------------------------------------|---------------| +| reasonCode | DeregistrationReasonCode | M | 1 | Defines the reason for the network initiated de-registration | | +| reasonText | string | O | 0..1 | Contains textual information to inform the user about the reason for a de-registration | | + +#### 6.1.6.2.15 Type: EmergencyRegisteredIdentity + +**Table 6.1.6.2.15-1: Definition of type EmergencyRegisteredIdentity** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|---------------------------|---------------| +| impi | Impi | M | 1 | IMS Private User Identity | | +| impu | Impu | M | 1 | IMS Public User Identity | | + +### 6.1.6.3 Simple data types and enumerations + +#### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|---------------------------------------|---------------| +| Impu | string | Contains an IMS Public Identity | | +| Impi | string | Contains an IMS Private User Identity | | + +#### 6.1.6.3.3 Enumeration: AuthorizationType + +The enumeration AuthorizationType represents the type of authorization requested. It shall comply with the provisions defined in table 6.1.6.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration AuthorizationType** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------------------------------------------------|---------------| +| "REGISTRATION" | The authorization requested if for a user's IMS registration or re-registration. | | +| "DEREGISTRATION" | The authorization requested if for a user's IMS de-registration. | | + +#### 6.1.6.3.4 Enumeration: AuthorizationResult + +The enumeration AuthorizationResult represents the details of the granted authorization. It shall comply with the provisions defined in table 6.1.6.3.4-1. + +**Table 6.1.6.3.4-1: AuthorizationResult** + +| Enumeration value | Description | +|---------------------------|---------------------------------------------------------------------------------| +| "FIRST_REGISTRATION" | The registration is an initial registration for the IMS Public User Identity | +| "SUBSEQUENT_REGISTRATION" | The registration is an subsequent registration for the IMS Public User Identity | + +#### 6.1.6.3.5 Enumeration: ImsRegistrationType + +The enumeration ImsRegistrationType represents the type of registration associated to the REGISTER request. + +**Table 6.1.6.3.5-1: Enumeration ImsRegistrationType** + +| Enumeration value | Description | Applicability | +|---------------------------------|----------------------------------------------------------------------------------------------------------------|---------------| +| "INITIAL_REGISTRATION" | The request is related to an initial registration | | +| "RE_REGISTRATION" | The request is related to a re-registration | | +| "TIMEOUT_DEREGISTRATION" | The registration timer of an identity has expired. | | +| "USER_DEREGISTRATION" | The S-CSCF has received a user initiated de-registration request | | +| "ADMINISTRATIVE_DEREGISTRATION" | The S-CSCF, due to administrative reasons or network issues, has performed the de-registration of an identity. | | +| "AUTHENTICATION_FAILURE" | The authentication of a user has failed. | | +| "AUTHENTICATION_TIMEOUT" | Authentication timeout has occurred. | | +| "UNREGISTERED_USER" | The request is related to a request for a Public Identity that is not registered. | | + +#### 6.1.6.3.6 Enumeration: LooseRouteIndication + +The enumeration LooseRouteIndication represents whether the "loose routing" mechanism is required, or not, to serve the user. + +**Table 6.1.6.3.6-1: Enumeration LooseRouteIndication** + +| Enumeration value | Description | Applicability | +|----------------------------|------------------------------------------------------------------------|---------------| +| "LOOSE_ROUTE_NOT_REQUIRED" | Indicates that strict routing mechanism is required to serve the user. | | +| "LOOSE_ROUTE_REQUIRED " | Indicates that loose routing mechanism is required to serve the user. | | + +#### 6.1.6.3.7 Enumeration: DeregistrationReasonCode + +The enumeration DeregistrationReasonCode indicates the reason for the network initiated de-registration. + +**Table 6.1.6.3.7-1: Enumeration DeregistrationReasonCode** + +| Enumeration value | Description | Applicability | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| "PERMANENT_TERMINATION" | The HSS indicates to the S-CSCF that the S-CSCF will no longer be assigned to the Public Identity and associated implicitly registered/unregistered Public Identities (if any) for the Private Identity(ies) indicated in the request (e.g. due to an IMS subscription cancellation, or modification, or a removal of IP-address secure binding information when GIBA is used). | | +| "NEW_SERVER_ASSIGNED" | The HSS indicates to the S-CSCF that a new S-CSCF has been allocated to the IMS Subscription e.g. because the previous assigned S-CSCF was unavailable during a registration procedure. The S-CSCF shall remove all information for all of the Public Identities indicated in the request. | | +| "SERVER_CHANGE" | The HSS indicates to the S-CSCF that the de-registration is requested to force the selection of new S-CSCF to assign to the IMS Subscription (e.g. when the S-CSCF capabilities are changed in the HSS or when the S-CSCF indicates that it has not enough memory for the updated User Profile). If the S-CSCF does not indicate in the response all the associated Private Identities, the HSS shall repeat this request for each of the remaining Private Identities in the IMS Subscription that are known to the S-CSCF. The S-CSCF should start the network initiated de-registration towards the user, i.e. all registrations within the IMS Subscription are de-registered and the user is asked to re-register to all existing registrations. | | +| "REMOVE_S-CSCF" | The HSS indicates to the S-CSCF that the S-CSCF will no longer be assigned to an unregistered Public Identity(ies) (i.e registered as a consequence of an originating or terminating request or there is a S-CSCF keeping the user profile stored) for a given IMS Subscription. | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +There are no alternative data types, neither combinations of data types + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.1.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.1.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nhss\_imsUECM service. The following application errors listed in Table 6.1.7.3-1 are specific for the Nhss\_imsUECM service. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The received IMS UE identity is unknown. | +| CONTEXT_NOT_FOUND | 404 Not Found | The context identified by the callback reference is not found | +| IDENTITIES_DO_NOT_MATCH | 403 Forbidden | A message was received with a public identity and a private identity for a user, and the server determines that the public identity does not correspond to the private identity. | +| ERROR_IN_REGISTRATION_TYPE | 403 Forbidden | The requested registrationType is not allowed or the Public Identity type received in the request is not allowed for the requested registrationType. | +| IDENTITY_ALREADY_REGISTERED | 403 Forbidden | The identity has already a server assigned, and the registration information cannot be overwritten. | + +## 6.1.8 Feature negotiation + +The optional features in Table 6.1.8-1 are defined for the Nhss\_imsUEContextManagement API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 6.1.9 Security + +As indicated in 3GPP TS 33.501 [5], the access to the Nhss\_imsUECM API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [35]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [36]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_imsUECM API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [36], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nhss\_imsUECM service. + +The Nhss\_imsUECM API defines the following scopes for OAuth2 authorization: + +**Table 6.1.9-1: OAuth2 scopes defined in Nhss\_imsUECM API** + +| Scope | Description | +|-------------------------------------|----------------------------------------------------------------| +| "nhss-ims-uecm" | Access to the Nhss IMS UE Context Management API | +| "nhss-ims-uecm:authorize:invoke" | Access to invoke the Authorize custom operation | +| "nhss-ims-uecm:registration:create" | Access to create S-CSCF Registration resources | +| "nhss-ims-uecm:restoration:read" | Access to read the S-CSCF Restoration resource | +| "nhss-ims-uecm:restoration:modify" | Access to create/update/delete the S-CSCF Restoration resource | + +## 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different HSS service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different HSS producer instance will return the NF Instance ID of the new HSS producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an HSS redirects a service request to a different HSS using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new HSS towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# 6.2 Nhss\_imsSubscriberDataManagement Service API + +## 6.2.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}/{apiName}/{apiVersion}/ + +where "apiRoot" is defined in clause 4.4.1 of 3GPP TS 29.501 [5], the "apiName" shall be set to "nhss-ims-sdm" and the "apiVersion" shall be set to "v1" for the current version of this specification. + +## 6.2.2 Usage of HTTP + +### 6.2.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nhss\_imsSubscriberDataManagement service shall comply with the OpenAPI [9] specification contained in Annex A.3. + +### 6.2.2.2 HTTP standard headers + +#### 6.2.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +#### 6.2.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [10], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 9457 [11]) signalled by the content type "application/problem+json" +- JSON Patch, as defined in IETF RFC 6902 [12], signalled by the content type "application/json-patch+json" + +### 6.2.2.3 HTTP custom headers + +#### 6.2.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.2.3 Resources + +### 6.2.3.1 Overview + +![A hierarchical tree diagram showing the resource URI structure of the Nhss_imsSDM API. The root is {apiRoot}/nhss-ims-sdm/v1. It branches into /{imsUeld}, /repository-data, /identities, /ims-data, and /subscriptions. /repository-data has a sub-branch /{serviceIndication}. /identities has sub-branches /ims-associated-identities, /msisdns, /private-identities, and /imeiSv. /ims-data has sub-branches /profile-data, /location-data (dashed box), and /registration-status. /profile-data has sub-branches /ifcs, /service-level-trace-info, /priority-levels, and /charging-info. /location-data has sub-branches /server-name, /scscf-capabilities, and /scscf-selection-assistance-info. /subscriptions has a sub-branch /{subscriptionId}.](4a390493f601ce1ac6b9201db4e28b5a_img.jpg) + +``` +graph TD; Root["{apiRoot}/nhss-ims-sdm/v1"] --- IMSUeld["/{imsUeld}"]; Root --- RepositoryData["/repository-data"]; Root --- Identities["/identities"]; Root --- IMSData["/ims-data"]; Root --- Subscriptions["/subscriptions"]; RepositoryData --- ServiceIndication["/{serviceIndication}"]; Identities --- IMSAssociatedIdentities["/ims-associated-identities"]; Identities --- MSISDNs["/msisdns"]; Identities --- PrivateIdentities["/private-identities"]; Identities --- IMEISV["/imeiSv"]; IMSData --- ProfileData["/profile-data"]; IMSData --- LocationData["/location-data"]; IMSData --- RegistrationStatus["/registration-status"]; ProfileData --- IFCS["/ifcs"]; ProfileData --- ServiceLevelTraceInfo["/service-level-trace-info"]; ProfileData --- PriorityLevels["/priority-levels"]; ProfileData --- ChargingInfo["/charging-info"]; LocationData --- ServerName["/server-name"]; LocationData --- SCSCFCapabilities["/scscf-capabilities"]; LocationData --- SCSCFSelectionAssistanceInfo["/scscf-selection-assistance-info"]; Subscriptions --- SubscriptionId["/{subscriptionId}"]; +``` + +A hierarchical tree diagram showing the resource URI structure of the Nhss\_imsSDM API. The root is {apiRoot}/nhss-ims-sdm/v1. It branches into /{imsUeld}, /repository-data, /identities, /ims-data, and /subscriptions. /repository-data has a sub-branch /{serviceIndication}. /identities has sub-branches /ims-associated-identities, /msisdns, /private-identities, and /imeiSv. /ims-data has sub-branches /profile-data, /location-data (dashed box), and /registration-status. /profile-data has sub-branches /ifcs, /service-level-trace-info, /priority-levels, and /charging-info. /location-data has sub-branches /server-name, /scscf-capabilities, and /scscf-selection-assistance-info. /subscriptions has a sub-branch /{subscriptionId}. + +Figure 6.2.3.1-1: Resource URI structure of the Nhss\_imsSDM API + +![A hierarchical tree diagram showing the Resource URI structure of the Nhss_imsSDM API. The root is {apiRoot}/nhss-ims-sdm/v1. It branches into /{imsUeId}, /shared-data, /shared-data-subscriptions, /access-data, /srvcc-data, and /service-data. /{imsUeId} further branches into /ps-domain, /cs-domain, /wireline-domain, /srvcc-data, and /service-data. /ps-domain branches into /user-state, /location-data, /tads-info, /ip-address, and /ue-reach-subscriptions. /ue-reach-subscriptions branches into /{subscriptionId}. /cs-domain branches into /user-state, /location-data, and /csrn. /wireline-domain branches into /reference-location. /shared-data branches into /{sharedDataId}. /shared-data-subscriptions branches into /{subscriptionId}. /service-data branches into /psi-status, /dsai, and /sms-registration-info.](c07e21a8d65991db04263322f859c94f_img.jpg) + +``` +graph TD; Root["{apiRoot}/nhss-ims-sdm/v1"]; Root --- IMS["/{imsUeId}"]; Root --- SharedData["/shared-data"]; Root --- SharedDataSubscriptions["/shared-data-subscriptions"]; Root --- AccessData["/access-data"]; Root --- SrvccData["/srvcc-data"]; Root --- ServiceData["/service-data"]; IMS --- PS["/ps-domain"]; IMS --- CS["/cs-domain"]; IMS --- Wireline["/wireline-domain"]; IMS --- SrvccData2["/srvcc-data"]; IMS --- ServiceData2["/service-data"]; PS --- PS_US["/user-state"]; PS --- PS_LD["/location-data"]; PS --- PS_TI["/tads-info"]; PS --- PS_IP["/ip-address"]; PS --- PS_URS["/ue-reach-subscriptions"]; PS_URS --- PS_URS_S["/{subscriptionId}"]; CS --- CS_US["/user-state"]; CS --- CS_LD["/location-data"]; CS --- CS_C["/csrn"]; Wireline --- Wireline_RL["/reference-location"]; SharedData --- SD_S["/{sharedDataId}"]; SharedDataSubscriptions --- SDS_S["/{subscriptionId}"]; ServiceData --- SDAT_P["/psi-status"]; ServiceData --- SDAT_D["/dsai"]; ServiceData --- SDAT_S["/sms-registration-info"]; +``` + +A hierarchical tree diagram showing the Resource URI structure of the Nhss\_imsSDM API. The root is {apiRoot}/nhss-ims-sdm/v1. It branches into /{imsUeId}, /shared-data, /shared-data-subscriptions, /access-data, /srvcc-data, and /service-data. /{imsUeId} further branches into /ps-domain, /cs-domain, /wireline-domain, /srvcc-data, and /service-data. /ps-domain branches into /user-state, /location-data, /tads-info, /ip-address, and /ue-reach-subscriptions. /ue-reach-subscriptions branches into /{subscriptionId}. /cs-domain branches into /user-state, /location-data, and /csrn. /wireline-domain branches into /reference-location. /shared-data branches into /{sharedDataId}. /shared-data-subscriptions branches into /{subscriptionId}. /service-data branches into /psi-status, /dsai, and /sms-registration-info. + +Figure 6.2.3.1-2: Resource URI structure of the Nhss\_imsSDM API + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name
(Archetype) | Resource URI | HTTP method or
custom operation | Description | +|-------------------------------------------------------|------------------------------------------------------------------|------------------------------------|--------------------------------------------------------------------------| +| Repository Data
(Document) | /{imsUId}/repository-data/
{serviceIndication} | GET | Retrieve repository data for a service indication | +| | | DELETE | Delete repository data for a service indication | +| | | PUT | Update repository data for a service indication | +| Repository Data List
(Document) | /{imsUId}/repository-data | GET | Retrieve multiple repository data for a list of service indications | +| IMS Associated Identities
(Document) | /{imsUId}/identities/ims-associated-identities | GET | Retrieve the UE's IMS associated identities (implicit and alias) | +| MSISDNs
(Document) | /{imsUId}/identities/msisdns | GET | Retrieve the UE's MSISDNs (basic and additional) | +| PrivateIdentities
(Document) | /{imsUId}/identities/private-identities | GET | Retrieve the UE's Private Identities (IMPI and IMSI) | +| ImeiSvnInformation
(Document) | /{imsUId}/identities/imeisv | GET | Retrieve the UE's IMEISV | +| IMS Profile Data
(Document) | /{imsUId}/ims-data/profile-data | GET | Retrieve the UE's subscribed Profile | +| Initial Filter Criteria
(Document) | /{imsUId}/ims-data/profile-data/ifcs | GET | Retrieve the UE's subscribed Initial Filter Criteria | +| Service Level Trace Information
(Document) | /{imsUId}/ims-data/profile-data/service-level-trace-info | GET | Retrieve the UE's subscribed Service Level Trace Information | +| Service Priority Information
(Document) | /{imsUId}/ims-data/profile-data/priority-levels | GET | Retrieve the UE's subscribed Service Priority Levels | +| Charging Information
(Document) | /{imsUId}/ims-data/profile-data/chargingInfo | GET | Retrieve the UE's subscribed Charging Information | +| IMS Location Data
(Document) | /{imsUId}/ims-data/location-data/server-name | GET | Retrieve the UE's S-CSCF name | +| S-CSCF Capabilities
(Document) | /{imsUId}/ims-data/location-data/scscf-capabilities | GET | Retrieve the UE's S-CSCF capabilities (mandatory and/or optional) | +| S-CSCF Selection Assistance Information
(Document) | /{imsUId}/ims-data/location-data/scscf-selection-assistance-info | GET | Retrieve the UE's S-CSCF Selection Assistance Information | +| IMS Registration Status
(Document) | /{imsUId}/ims-data/registration-status | GET | Retrieve the UE's IMS registration status. | +| Subscriptions
(Collection) | /{imsUId}/subscriptions | POST | Create a subscription | +| Individual subscription
(Document) | /{imsUId}/subscriptions/
{subscriptionId} | DELETE | Delete the subscription identified by {subscriptionId}, i.e. unsubscribe | +| | | PATCH | Modify the sdm-subscription identified by {subscriptionId} | + +| | | | | +|---------------------------------------------------|-------------------------------------------------------------------------|--------|----------------------------------------------------------------------------------------------------| +| PS Location Information(Document) | /{imsUId}/access-data/ps-domain/location-data | GET | Retrieve the UE's location in PS domain | +| CS Location Information(Document) | /{imsUId}/access-data/cs-domain/location-data | GET | Retrieve the UE's location in CS domain | +| PsUserState(Document) | /{imsUId}/access-data/ps-domain/user-state | GET | Retrieve the UE's state in PS domain | +| CsUserState(Document) | /{imsUId}/access-data/cs-domain/user-state | GET | Retrieve the UE's state in CS domain | +| TadsInfo(Document) | /{imsUId}/access-data/ps-domain/tads-info | GET | Retrieve the UE's T-ADS information | +| UeReachabilityIpSubscriptions(Collection) | /{imsUId}/access-data/ps-domain/ue-reach-subscriptions | POST | Create a subscription to UE Reachability for IP | +| UE reachability individual subscription(Document) | /{imsUId}/access-data/ps-domain/ue-reach-subscriptions/{subscriptionId} | DELETE | Delete the subscription to UE reachability for IP identified by {subscriptionId}, i.e. unsubscribe | +| | | PATCH | Modify the subscription to UE reachability for IP identified by {subscriptionId} | +| IpAddress(Document) | /{imsUId}/access-data/ps-domain/ip-address | GET | Retrieve the UE's stored IP Address Secure Binding Information | +| Csrn(Document) | /{imsUId}/access-data/cs-domain/csrn | GET | Retrieve a CSRN for the UE | +| ReferenceAccessLocation(Document) | /{imsUId}/access-data/wireline-domain/reference-location | GET | Retrieve the UE's subscribed Reference Access Location | +| SRVCC Data(Document) | /{imsUId}/srvcc-data | GET | Retrieve the UE's STN-SR and SRVCC capability | +| | | PATCH | Update the UE's STN-SR. | +| PSI Activation State(Document) | /{imsUId}/service-data/psi-status | GET | Retrieve a PSI activation status | +| | | PATCH | Update a PSI activation status | +| Dsai(Document) | /{imsUId}/service-data/dsai | GET | Retrieve DSAI data (i.e. DSAI tags and status) associated to an Application Server | +| | | PATCH | Update DSAI data associated to an Application Server | +| SMSRegistrationInfo(Document) | /{imsUId}/service-data/sms-registration-info | GET | Retrieve the SMS Registration Information (e.g. IP-SM-GW address) | +| | | PUT | Creates or updates the SMS Registration Information (e.g. IP-SM-GW address) | +| | | DELETE | Deletes the SMS Registration Information (e.g. IP-SM-GW address) | +| SharedData(Collection) | /shared-data | GET | Retrieve shared data | +| SharedDataSubscriptions(Collection) | /shared-data-subscriptions | POST | Create a subscription | +| Shared Data Individual Subscription(Document) | /shared-data-subscriptions/{subscriptionId} | DELETE | Delete the subscription identified by {subscriptionId}, i.e. unsubscribe | +| | | PATCH | Modify the subscription identified by {subscriptionId} | + +### 6.2.3.2 Resource: IMS Associated Identities + +#### 6.2.3.2.1 Description + +This resource represents the IMS associated identities. It is queried by the service consumer (IMS-AS) to retrieve the list of identities in the same Implicit Registration Set, together with the Alias Group Information and additional information (e.g. identity type) + +### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/identities/ims-associated-identities + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)
pattern: " ^(impu-sip:\{[a-zA-Z0-9\_\.!~*()&=+\$,;?V]+\})\@([A-Za-z0-9]+\{[-A-Za-z0-9]+\})\.\.[a-z]{2,}\ impu-tel:\.\+[0-9]{5,15}\ impi-\.\+\.\+\)" | + +### 6.2.3.2.3 Resource Standard Methods + +#### 6.2.3.2.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.2.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3. + +**Table 6.2.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ImAssociatedIdentities | M | 1 | 200 OK | A response body containing the list of identities belonging to the same Implicit Registration Set shall be returned, together with the related information (Alias Group, if any, identity type, IRS default identity, registration state of the IRS). | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.3 Resource: MSISDNS + +### 6.2.3.3.1 Description + +This resource represents the MSISDNs associated to the UE. It is queried by the service consumer (IMS-AS) to retrieve the list of MSISDNs (basic and additional). If the UE is shared among multiple IMS Private Identities and the consumer queries for the basic MSISDN (C-MSISDN), the URI query parameter Private Identity (IMPI) shall be included. + +### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/identities/msisdns + +This resource shall support the resource URI variables defined in table 6.2.3.3.2-1. + +**Table 6.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)
pattern: "^(impu-sip:\{[a-zA-Z0-9 \-\.!~*()\&=+\$,;:?\V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impn-tel:\+[0-9]{5,15} impi-\.[a-z]+\.[a-z]{2,} impn-tel:\+[0-9]{5,15} impi-\.[a-z]+\.[a-z]{2,} )" | + +### 6.2.3.3.3 Resource Standard Methods + +#### 6.2.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.3.3.1-1. + +**Table 6.2.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| private-id | PrivateId | O | 0..1 | IMS Private Identity (IMPI) of the UE. It shall be included if there are multiple Private Identities associated to the Public Identity received and the basic MSISDN (C-MSISDN) is requested. | + +This method shall support the request data structures specified in table 6.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3. + +**Table 6.2.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 6.2.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MsisdnList | M | 1 | 200 OK | A response body containing the list of MSISDNs associated to the UE and all Private Identities shall be returned. If the response is for a basic MSISDN (C-MSISDN) query (query parameter IMPI was present), only one MSISDN shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.4 Resource: S-CSCF Capabilities + +### 6.2.3.4.1 Description + +This resource represents the S-CSCF capabilities. It is queried by the service consumer (I-CSCF) to retrieve S-CSCF capabilities associated to the UE (mandatory capabilities and/or optional capabilities). + +#### 6.2.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/location-data/scscf-capabilities + +This resource shall support the resource URI variables defined in table 6.2.3.4.2-1. + +**Table 6.2.3.4.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip:([a-zA-Z0-9_\-\.!~*()&=+\$,:;?V]+)@([A-Za-z0-9]+([-A-Za-z0-9+]+\.)+)[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+ .+)\$" | + +#### 6.2.3.4.3 Resource Standard Methods + +**6.2.3.4.3.1 GET** + +This method shall support the URI query parameters specified in table 6.2.3.4.3.1-1. + +**Table 6.2.3.4.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.4.3.1-2 and the response data structures and response codes specified in table 6.2.3.4.3.1-3. + +**Table 6.2.3.4.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.4.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ScscfCapabilityList | M | 1 | 200 OK | A response body containing the list mandatory and/or optional capabilities shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found |

The "cause" attribute may be used to indicate one of the following application errors:

  • - USER_NOT_FOUND
  • - DATA_NOT_FOUND

NOTE: DATA_NOT_FOUND indicates that any S-CSCF can be selected, e.g. based on I-CSCF local policy.

| +| ProblemDetails | O | 0..1 | 403 Forbidden |

The "cause" attribute may be used to indicate the following application error:

  • - OPERATION_NOT_ALLOWED
| + +**Table 6.2.3.4.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.4.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.2.3.5 Resource: IMS Profile Data + +#### 6.2.3.5.1 Description + +This resource represents the IMS Profile Data. It is queried by the service consumer (S-CSCF) to retrieve the user's IMS profile data, containing the required information to handle the multimedia sessions (e.g. Initial Filter Criteria) + +### 6.2.3.5.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/profile-data** + +This resource shall support the resource URI variables defined in table 6.2.3.5.2-1. + +**Table 6.2.3.5.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId |

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:([a-zA-Z0-9_\-\.\!~*'( )&=+\$,;?V/]+)@([A-Za-z0-9]+([-A-Za-z0-9]+\.)+[a-z]{2,}) impu-tel\:\+[0-9]{5,15} impi-.* .+)\$"

| + +### 6.2.3.5.3 Resource Standard Methods + +#### 6.2.3.5.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.5.3.1-1. + +NOTE: The retrieval of these data sets can also be achieved by sending individual GET requests to the corresponding sub-resources under the {imsUeId} resource. When multiple data sets need to be retrieved by the NF Service consumer, it is recommended to use a single GET request with query parameters rather than issuing multiple GET requests. + +**Table 6.2.3.5.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|--------------------|---|-------------|-----------------------------------| +| dataset-names | array(DataSetName) | O | 1..N | Datasets to be retrieved | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.5.3.1-2 and the response data structures and response codes specified in table 6.2.3.5.3.1-3. + +**Table 6.2.3.5.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.5.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------| +| lmsProfileData | M | 1 | 200 OK | Upon success, a response body containing the User's Profile Data shall be included. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application errors:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.5.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.5.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.6 Resource: Subscriptions + +#### 6.2.3.6.1 Description + +This resource is used to represent subscriptions to notifications of data change. + +#### 6.2.3.6.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/subscriptions** + +This resource shall support the resource URI variables defined in table 6.2.3.6.2-1. + +**Table 6.2.3.6.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId |

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:([a-zA-Z0-9_\-\.!~*()&=+\$,;?V]+)\@([A-Za-z0-9]+\-[A-Za-z0-9]+\.)+[a-z]{2,} impu-tel\:\+[0-9]{5,15} impi\-.+)\$"

| + +#### 6.2.3.6.3 Resource Standard Methods + +##### 6.2.3.6.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.3.6.3.1-1. + +**Table 6.2.3.6.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.6.3.1-2 and the response data structures and response codes specified in table 6.2.3.6.3.1-3. + +**Table 6.2.3.6.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-----------------------------------------| +| ImsSdmSubscription | M | 1 | The subscription that is to be created. | + +**Table 6.2.3.6.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lmsSdmSubscription | M | 1 | 201
Created | Upon success, a response body containing a representation of the created Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate the following application error:
- UNSUPPORTED_RESOURCE_URI

This response shall not be cached. | + +**Table 6.2.3.6.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.6.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.6.3.1-6: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nhss-im-sdm//imsUeId/subscription s/{subscriptionId} | + +## 6.2.3.7 Resource: Individual subscription + +### 6.2.3.7.1 Description + +This resource is used to represent an individual subscription to notifications of data change. + +### 6.2.3.7.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.2.3.7.2-1. + +**Table 6.2.3.7.2-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)
pattern: "^(impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$,;?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-\.[.+\+])\$" | +| subscriptionId | The subscriptionId identifies an individual subscription to notifications. | + +### 6.2.3.7.3 Resource Standard Methods + +#### 6.2.3.7.3.1 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.7.3.1-1. + +**Table 6.2.3.7.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.7.3.1-2 and the response data structures and response codes specified in table 6.2.3.7.3.1-3. + +**Table 6.2.3.7.3.1-2: Data structures supported by the Delete Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.7.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +**Table 6.2.3.7.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.7.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.7.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.7.3.2-1. + +**Table 6.2.3.7.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.7.3.2-2 and the response data structures and response codes specified in table 6.2.3.7.3.2-3. + +**Table 6.2.3.7.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1 | It contains the list of changes to be made to the resource representing the individual subscription, according to the JSON PATCH format specified in IETF RFC 6902 [12]. | + +**Table 6.2.3.7.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, a response with no content is returned. (NOTE 1) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 1) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate the following application error:
- MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult. + +**Table 6.2.3.7.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.7.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.8 Resource: SharedDataSubscriptions + +### 6.2.3.8.1 Description + +This resource is used to represent subscriptions to notifications for shared data. + +### 6.2.3.8.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/shared-data-subscriptions + +This resource shall support the resource URI variables defined in table 6.2.3.8.2-1. + +**Table 6.2.3.8.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | + +### 6.2.3.8.3 Resource Standard Methods + +#### 6.2.3.8.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.3.8.3.1-1. + +**Table 6.2.3.8.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.8.3.1-2 and the response data structures and response codes specified in table 6.2.3.8.3.1-3. + +**Table 6.2.3.8.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-----------------------------------------| +| lmsSdmSubscription | M | 1 | The subscription that is to be created. | + +**Table 6.2.3.8.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lmsSdmSubscription | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate the following application error:
- UNSUPPORTED_RESOURCE_URI

This response shall not be cached. | + +**Table 6.2.3.8.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.8.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.8.3.1-6: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nhss-ims-sdm//shared-data-subscriptions/{subscriptionId} | + +## 6.2.3.9 Resource: Shared Data Individual subscription + +### 6.2.3.9.1 Description + +This resource is used to represent an individual subscription to notifications for shared data. + +### 6.2.3.9.2 Resource Definition + +Resource URI: {apiRoot}/nhss-sdm/{apiVersion}/shared-data-subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.2.3.9.2-1. + +**Table 6.2.3.9.2-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|----------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| subscriptionId | The subscriptionId identifies an individual subscription to notifications. | + +### 6.2.3.9.3 Resource Standard Methods + +#### 6.2.3.9.3.1 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.9.3.1-1. + +**Table 6.2.3.9.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.zz.3.1-2 and the response data structures and response codes specified in table 6.2.3.zz.3.1-3. + +**Table 6.2.3.9.3.1-2: Data structures supported by the Delete Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.9.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The resource corresponding to the SubscriptionId can't be found.

The "cause" attribute may be used to indicate the following application error:
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +**Table 6.2.3.9.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.9.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.9.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.9.3.2-1. + +**Table 6.2.3.9.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.9.3.2-2 and the response data structures and response codes specified in table 6.2.3.9.3.2-3. + +**Table 6.2.3.9.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1 | It contains the list of changes to be made to the resource representing the individual subscription, according to the JSON PATCH format specified in IETF RFC 6902 [12]. | + +**Table 6.2.3.9.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, a response with no content is returned. (NOTE 1) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 1) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The resource corresponding to the SubscriptionId can't be found.

The "cause" attribute may be used to indicate the following application error:
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate the following application error:
- MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult. + +**Table 6.2.3.9.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.9.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.10 Resource: IMS Registration Status + +### 6.2.3.10.1 Description + +This resource represents the IMS Registration Status. It is queried by the service consumer (e.g. AS) to retrieve the IMS registration status of the user. + +### 6.2.3.10.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/registration-status + +This resource shall support the resource URI variables defined in table 6.2.3.10.2-1. + +**Table 6.2.3.10.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)
pattern: "^(impu-sip:\{[a-zA-Z0-9\_\.!~*()&=+\$,;?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impu-tel:\{+[0-9]{5,15} impi-\.[.]+\})\$" | + +### 6.2.3.10.3 Resource Standard Methods + +#### 6.2.3.10.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.10.3.1-1. + +**Table 6.2.3.10.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.2.3.10.3.1-2 and the response data structure and response codes specified in table 6.2.3.10.3.1-3. + +**Table 6.2.3.10.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.10.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ImRegistrationStatus | M | 1 | 200 OK | A response body containing the IMS registration status of the user. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates the user has not performed yet any IMS registration. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.10.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.10.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.2.3.11 Resource: Service Priority Information + +#### 6.2.3.11.1 Description + +This resource represents the Service Priority Levels. It is queried by the service consumer (e.g. AS) to retrieve the Namespaces and priority levels allowed for the user. + +### 6.2.3.11.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/profile-data/priority-levels** + +This resource shall support the resource URI variables defined in table 6.2.3.11.2-1. + +**Table 6.2.3.11.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId |

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:([a-zA-Z0-9_\-\.\!~*'()&=+\$,;?V/]+)@([A-Za-z0-9]+([-A-Za-z0-9]+\.)+[a-z]{2,} impu-tel\:\+[0-9]{5,15} impi-.+) .+)\$"

| + +### 6.2.3.11.3 Resource Standard Methods + +#### 6.2.3.11.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.11.3.1-1. + +**Table 6.2.3.11.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.2.3.11.3.1-2 and the response data structures and response codes specified in table 6.2.3.11.3.1-3. + +**Table 6.2.3.11.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 6.2.3.11.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PriorityLevels | M | 1 | 200 OK | A response body containing the service priority information (priority namespaces and associated levels) allowed for the user shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the user does not have priority service. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.11.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.11.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.12 Resource: Initial Filter Criteria + +### 6.2.3.12.1 Description + +This resource represents the Initial Filter Criteria (IFCs). It is queried by the service consumer (e.g. S-CSCF, AS) to retrieve the list of IFCs associated to the UE (including Shared IFC Set Identifiers, if provisioned). + +### 6.2.3.12.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/profile-data/ifcs + +This resource shall support the resource URI variables defined in table 6.2.3.12.2-1. + +**Table 6.2.3.12.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: " ^ (impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$_;?V]+\}@([A-Za-z0-9]+([-A-Za-z0-9]+\.)+[a-z]{2,} impu-tel:\{+[0-9]{5,15}impi-\.+\})\$" | + +## 6.2.3.12.3 Resource Standard Methods + +### 6.2.3.12.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.12.3.1-1. + +**Table 6.2.3.12.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|-------------------|---|-------------|------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| application-server-name | SipServerName | O | 0..1 | This information element indicates application server's SIP URI. | | + +This method shall support the request data structures specified in table 6.2.3.12.3.1-2 and the response data structures and response codes specified in table 6.2.3.12.3.1-3. + +**Table 6.2.3.12.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.12.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lfcs | M | 1 | 200 OK | A response body containing the list of complete IFCs and/or shared IFC set identifiers shall be returned. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that there is no Initial Filter Criteria associated to the user (i.e. no AS is triggered by S-CSCF for the user) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.12.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.12.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.13 Resource: IMS Location Data + +### 6.2.3.13.1 Description + +This resource represents the IMS location data. It is queried by the service consumer (e.g. AS) to retrieve the S-CSCF name stored for the user. + +### 6.2.3.13.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/location-data/server-name** + +This resource shall support the resource URI variables defined in table 6.2.3.13.2-1. + +**Table 6.2.3.13.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^ (impu-sip :([a-zA-Z0-9_\-.!~*'()&=+\$,;?V]+)@([A-Za-z0-9]+([-A-Za-z0-9]+)*\.)+[a-z]{2,} impu-tel :\+[0-9]{5,15} impi-.+)\$" | + +### 6.2.3.13.3 Resource Standard Methods + +### 6.2.3.13.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.13.3.1-1. + +**Table 6.2.3.13.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.2.3.13.3.1-2 and the response data structure and response codes specified in table 6.2.3.13.3.1-3. + +**Table 6.2.3.13.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 6.2.3.13.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ImsLocationData | M | 1 | 200 OK | A response body containing the S-CSCF name stored for the user. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates the user has not performed yet any IMS registration. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.13.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.13.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.14 Resource: Service Level Trace Information + +### 6.2.3.14.1 Description + +This resource represents the Service Level Trace Information. It is queried by the service consumer (e.g. AS) to retrieve the Trace Level information so that the consumer can perform logging for the user as described in IETF RFC 8497 [23]. + +### 6.2.3.14.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/profile-data/service-trace-level-information + +This resource shall support the resource URI variables defined in table 6.2.3.14.2-1. + +**Table 6.2.3.14.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^ (impu-sip:([a-zA-Z0-9_\-.!~*()&=+\$;,?V]+)@([A-Za-z0-9]+([-A-Za-z0-9]+)*\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+ .+)\$" | + +### 6.2.3.14.3 Resource Standard Methods + +#### 6.2.3.14.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.14.3.1-1. + +**Table 6.2.3.14.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.2.3.14.3.1-2 and the response data structures and response codes specified in table 6.2.3.14.3.1-3. + +**Table 6.2.3.14.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.14.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ServiceLevelTraceInformation | M | 1 | 200 OK | A response body containing the IMS service level trace information shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the service level tracing is disabled for the user. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.14.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.14.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.15 Resource: PS location Information + +### 6.2.3.15.1 Description + +This resource represents the Location Information in PS domain. It is queried by the service consumer (e.g. AS) to retrieve the location information in PS domain as retrieved from the serving node(s). The service consumer may indicate the requested nodes for which the request is applicable (e.g. AMF only) + +### 6.2.3.15.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/ps-domain/location-data + +This resource shall support the resource URI variables defined in table 6.2.3.15.2-1. + +**Table 6.2.3.15.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$,;?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-\.[a-z]+\.[a-z]{2,} impi-tel:\+[0-9]{5,15} impi-\.[a-z]+\.[a-z]{2,}))"\$ | + +### 6.2.3.15.3 Resource Standard Methods + +#### 6.2.3.15.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.15.3.1-1. + +**Table 6.2.3.15.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| requested-nodes | array(RequestedNode) | O | 1..N | Indicates the serving node(s) for which the request is applicable. | +| serving-node | boolean | O | 0..1 | Indicates that only the stored NF id/address of the serving node(s) requested and PLMN identity are required, that is, other location data (e.g. Global Cell ID) is not required.

It shall be absent if current-location is present with value true.

true: only the requested node(s) address(es) are requested
false or absent: location data as retrieved from the requested node(s) is requested. | +| local-time | boolean | O | 0..1 | Indicates that only the Local Time Zone information (Time Zone and Daylight Saving Time) and the PLMN identity of the location in the visited network where the UE is attached is requested, that is, other location data (e.g. Global Cell ID) is not required.

true: only the local time is requested
false or absent: location data as retrieved from the requested node(s) is requested. | +| current-location | boolean | O | 0..1 | Indicates whether an active location retrieval has to be initiated by the requested node(s).

true: active location retrieval is requested
false or absent: active location retrieval is not requested | +| rat-type | boolean | O | 0..1 | Indicates whether retrieval of RAT type is requested.
true: requested
false: not requested | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| private-identity | Privateld | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeld variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +If "requested-nodes" is not included, HSS shall return location information as retrieved from all the nodes (AMF, MME and SGSN) + +This method shall support the request data structures specified in table 6.2.3.15.3.1-2 and the response data structures and response codes specified in table 6.2.3.15.3.1-3. + +**Table 6.2.3.15.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.15.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PsLocation | M | 1 | 200 OK | A response body containing the PS location information as requested shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the location information is unknown or unavailable. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.15.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.15.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.16 Resource: CS location Information + +### 6.2.3.16.1 Description + +This resource represents the Location Information in CS domain. It is queried by the service consumer (e.g. AS) to retrieve the location information in CS domain as retrieved from the MSC/VLR. + +### 6.2.3.16.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/cs-domain/location-data + +This resource shall support the resource URI variables defined in table 6.2.3.16.2-1. + +**Table 6.2.3.16.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$_;?V]+\}@([A-Za-z0-9]+\{[-A-Za-z0-9]+\}\.)+[a-z]{2,} impu-tel:\{+[0-9]{5,15} impi-\{+\}\.+\})\$" | + +## 6.2.3.16.3 Resource Standard Methods + +### 6.2.3.16.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.16.3.1-1. + +**Table 6.2.3.16.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| serving-node | boolean | O | 0..1 | Indicates that only the MSC/VLR address and PLMN identity are required, that is, other location data (e.g. Global Cell ID) is not required.

It shall be absent if current-location is present.

true: only the MSC/VLR number requested
false or absent: location data as retrieved from the MSC/VLR is requested. | +| local-time | boolean | O | 0..1 | Indicates that only the Local Time Zone information (Time Zone and Daylight Saving Time) and the PLMN identity of the location in the visited network where the UE is attached is requested, that is, other location data (e.g. Global Cell ID) is not required.

It shall be absent if current-location is present. | +| current-location | boolean | O | 0..1 | Indicates whether an active location retrieval has to be initiated by the MSC/VLR. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| private-identity | Privateld | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +If "serving-node" is not included, HSS shall return the location data as retrieved from the MSC/VLR. + +If "local-time" is not included, HSS shall return the location data as retrieved from the MSC/VLR. + +This method shall support the request data structures specified in table 6.2.3.16.3.1-2 and the response data structures and response codes specified in table 6.2.3.16.3.1-3. + +**Table 6.2.3.16.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.16.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CsLocation | M | 1 | 200 OK | A response body containing the CS location information as requested shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the location information is unknown or unavailable. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.16.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.16.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.17 Resource: SRVCC data + +### 6.2.3.17.1 Description + +This resource represents the SRVCC data. It is queried by the service consumer (e.g. AS) to retrieve the UE SRVCC capability and the STN-SR for the user. + +### 6.2.3.17.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/srvcc-data + +This resource shall support the resource URI variables defined in table 6.2.3.17.2-1. + +**Table 6.2.3.17.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip:([a-zA-Z0-9_\-\.\!~*()&=+\$,;?V]+)@([A-Za-z0-9]+([\-A-Za-z0-9]+)*\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+ .+)\$" | + +**6.2.3.17.3 Resource Standard Methods** + +**6.2.3.17.3.1 GET** + +This method shall support the URI query parameters specified in table 6.2.3.17.3.1-1. + +**Table 6.2.3.17.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | | + +This method shall support the request data structures specified in table 6.2.3.17.3.1-2 and the response data structures and response codes specified in table 6.2.3.17.3.1-3. + +**Table 6.2.3.17.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.17.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SrvccData | M | 1 | 200 OK | A response body containing the STN-SR and the UE SRVCC capabilities for the user shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the user is not subscribed to SRVCC. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.17.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.17.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.17.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.17.3.2-1. + +**Table 6.2.3.17.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.17.3.2-2 and the response data structures and response codes specified in table 6.2.3.17.3.2-3. + +**Table 6.2.3.17.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Items describe the modifications to the SRVCC data.
Modification are not applicable to UE SRVCC capabilities. | + +**Table 6.2.3.17.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. (NOTE 1) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 1) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the user is not subscribed to SRVCC. | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED, see GPP TS 29.500 [4] table 5.2.7.2-1.
- OPERATION_NOT_ALLOWED | + +NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult. + +**Table 6.2.3.17.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.17.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.18 Resource: PSI activation state + +### 6.2.3.18.1 Description + +This resource represents the PSI activation state. It is queried by the service consumer (e.g. AS) to retrieve the activation state for the IMS Public Service Identity. + +### 6.2.3.18.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/psi-status + +This resource shall support the resource URI variables defined in table 6.2.3.18.2-1. + +**Table 6.2.3.18.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Service Identity
pattern: "^(impu-sip:\{[a-zA-Z0-9\_\.!~*()&=+\\$;:?,;?V]+\})@([A-Za-z0-9]+\{[A-Za-z0-9]+\})\.[a-z]{2,} impu-tel:\{+[0-9]{5,15} impi\.[+\-\.]+\})\$" | + +### 6.2.3.18.3 Resource Standard Methods + +#### 6.2.3.18.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.18.3.1-1. + +**Table 6.2.3.18.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.2.3.18.3.1-2 and the response data structures and response codes specified in table 6.2.3.18.3.1-3. + +**Table 6.2.3.18.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.18.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------| +| PsiActivationState | M | 1 | 200 OK | A response body containing the PSI activation state shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- SERVICE_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.18.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.18.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.18.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.18.3.2-1. + +**Table 6.2.3.18.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| Supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.18.3.2-2 and the response data structures and response codes specified in table 6.2.3.18.3.2-3. + +**Table 6.2.3.18.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|---------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Items describe the modifications to the PSI activation state. | + +**Table 6.2.3.18.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. (NOTE 1) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 1) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- SERVICE_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED, see GPP TS 29.500 [4] table 5.2.7.2-1.
- OPERATION_NOT_ALLOWED | + +NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult. + +**Table 6.2.3.18.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.18.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.19 Resource: Repository Data + +### 6.2.3.19.1 Description + +This resource represents the Repository Data. It is used by the service consumer (e.g. IMS-AS) to create, retrieve, update or delete the repository data for a given service indication. + +### 6.2.3.19.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/repository-data/{serviceIndication} + +This resource shall support the resource URI variables defined in table 6.2.3.19.2-1. + +**Table 6.2.3.19.2-1: Resource URI variables for this resource** + +| Name | Definition | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: " ^ (impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$_;?V]+\}@([A-Za-z0-9]+([-A-Za-z0-9]+\.)+[a-z]{2,} impu-tel:\{+[0-9]{5,15} impi-\{+\.+\})\$" | +| serviceIndication | Represents the identifier of a service related data. | + +## 6.2.3.19.3 Resource Standard Methods + +### 6.2.3.19.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.19.3.1-1. + +**Table 6.2.3.19.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.19.3.1-2 and the response data structures and response codes specified in table 6.2.3.19.3.1-3. + +**Table 6.2.3.19.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.19.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| RepositoryData | M | 1 | 200 OK | A response body containing the Repository Data for the requested Service Indication. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403
Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.19.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.19.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.19.3.2 PUT + +This method shall support the URI query parameters specified in table 6.2.3.19.3.2-1. + +**Table 6.2.3.19.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.19.3.2-2 and the response data structures and response codes specified in table 6.2.3.19.3.2-3. + +**Table 6.2.3.19.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|------------------------------------------------| +| RepositoryData | M | 1 | The Repository Data to be created or replaced. | + +**Table 6.2.3.19.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| RepositoryData | M | 1 | 201
Created | Upon success, a response body containing a representation of the created Individual RepositoryData resource shall be returned. | +| RepositoryData | M | 1 | 200 OK | Upon success, a response body containing a representation of the updated Individual RepositoryData resource shall be returned. | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | +| ProblemDetails | O | 0..1 | 409 Conflict | The "cause" attribute may be used to indicate the following application error:
- OUT_OF_SYNC | +| ProblemDetails | O | 0..1 | 413
Content Too Large | The "cause" attribute may be used to indicate the following application error:
- TOO_MUCH_DATA | + +**Table 6.2.3.19.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.19.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.19.3.2-6: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nhss-ims-sdm//{imsUeId}/repository-data/{serviceIndication} | + +### 6.2.3.19.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.19.3.3-1. + +**Table 6.2.3.19.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.19.3.3-2 and the response data structures and response codes specified in table 6.2.3.19.3.3-3. + +**Table 6.2.3.19.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.19.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that no repository data exists for the requested service indication. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.19.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.19.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.20 Resource: SharedData + +### 6.2.3.20.1 Description + +This resource represents the collection of data that can be shared by multiple UEs. + +### 6.2.3.20.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm//shared-data + +This resource shall support the resource URI variables defined in table 6.2.3.20.2-1. + +**Table 6.2.3.20.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | + +### 6.2.3.20.3 Resource Standard Methods + +#### 6.2.3.20.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.20.3.1-1. + +**Table 6.2.3.20.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------|---------------------|---|-------------|-------------| +| shared-data-ids | array(SharedDataId) | M | 1..N | | + +This method shall support the request data structures specified in table 6.2.3.20.3.1-2 and the response data structures and response codes specified in table 6.2.3.20.3.1-3. + +**Table 6.2.3.20.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.20.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------| +| array(SharedData) | M | 1..N | 200 OK | Upon success, a response body containing a list of SharedData shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- DATA_NOT_FOUND | + +**Table 6.2.3.20.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.20.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.21 Resource: ImeiSvInformation + +### 6.2.3.21.1 Description + +This resource represents the IMEI(SV) information. It is queried by the service consumer (e.g. IMS AS) to retrieve the IMEI(SV) for the user. + +### 6.2.3.21.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/identities/imeisv + +This resource shall support the resource URI variables defined in table 6.2.3.21.2-1. + +**Table 6.2.3.21.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity) or the IMS Private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$,;?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impnu-tel:\+[0-9]{5,15} impi-\.[a-z]{2,} impi-\.[0-9]{5,15} impi-\.[a-z]{2,} impi-\.[0-9]{5,15}))\$" | + +### 6.2.3.21.3 Resource Standard Methods + +#### 6.2.3.21.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.21.3.1-1. + +**Table 6.2.3.21.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| private-identity | Privateld | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeld variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | | + +This method shall support the request data structures specified in table 6.2.3.21.3.1-2 and the response data structures and response codes specified in table 6.2.3.21.3.1-3. + +**Table 6.2.3.21.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.21.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| ImeiSvInformation | M | 1 | 200 OK | A response body containing the IMEI(SV) information for the user shall be returned. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.21.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.21.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.22 Resource: IP Address + +### 6.2.3.22.1 Description + +This resource represents the IP Address Information. It is queried by the service consumer (e.g. SCC-AS) to retrieve the IP Address Information for the user. + +### 6.2.3.22.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/ps-domain/ip-address + +This resource shall support the resource URI variables defined in table 6.2.3.22.2-1. + +**Table 6.2.3.22.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. non-shared IMS Public User identity) or the IMS Private Identity.

pattern: "^(impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$,;?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-\.[.]+\+))\$" | + +### 6.2.3.22.3 Resource Standard Methods + +#### 6.2.3.22.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.22.3.1-1. + +**Table 6.2.3.22.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.2.3.22.3.1-2 and the response data structures and response codes specified in table 6.2.3.22.3.1-3. + +**Table 6.2.3.22.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.22.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IpAddr | M | 1 | 200 OK | A response body containing the IP address (IPv4, IPv6, IPv6 prefix and/or IPv6 interface identifier) for the user shall be returned. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that no IP Address is currently allocated for the user. | +| ProblemDetails | O | 0..1 | 403
Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.22.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.22.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.23 Resource: T-ADS Info + +### 6.2.3.23.1 Description + +This resource represents the T-ADS Information. It is queried by the service consumer (e.g. SCC-AS) to retrieve the T-ADS Information for the user. + +### 6.2.3.23.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/ps-domain/tads-info + +This resource shall support the resource URI variables defined in table 6.2.3.23.2-1. + +**Table 6.2.3.23.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeld | Represents the IMS Public Identity (i.e. IMS Public User identity) or the IMS Private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeld represents the IMS Public Identity.

pattern: "^(impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+,\$;:V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-\.[a-z]+\.[a-z]{2,} impi-tel:\+[0-9]{5,15} impi-\.[a-z]+\.[a-z]{2,}))"\$" | + +### 6.2.3.23.3 Resource Standard Methods + +#### 6.2.3.23.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.23.3.1-1. + +**Table 6.2.3.23.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeld variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | | + +This method shall support the request data structures specified in table 6.2.3.23.3.1-2 and the response data structures and response codes specified in table 6.2.3.23.3.1-3. + +**Table 6.2.3.23.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.23.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------| +| TadsInformation | M | 1 | 200 OK | A response body containing the T-ADS information (most recent VoPS support) for the user shall be returned. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.23.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.23.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.24 Resource: UeReachabilitySubscriptions + +### 6.2.3.24 Description + +This resource is used to represent subscriptions to notifications of UE Reachability for IP. + +#### 6.2.3.24.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/ps-domain/ue-reach-subscriptions + +This resource shall support the resource URI variables defined in table 6.2.3.24.2-1. + +**Table 6.2.3.24.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+;\$,;?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.)+[a-z]{2,} impu-tel:\{[0-9]{5,15} impi-\+\.+\})\$" | + +#### 6.2.3.24.3 Resource Standard Methods + +##### 6.2.3.24.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.3.24.3.1-1. + +**Table 6.2.3.24.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| private-identity | Privateld | C | 0..1 | Represents the IMS Private Identity.
Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.24.3.1-2 and the response data structures and response codes specified in table 6.2.3.24.3.1-3. + +**Table 6.2.3.24.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|-------------------------------------------------------------------| +| UeReachabilitySubscription | M | 1 | The subscription to UE reachability for IP that is to be created. | + +**Table 6.2.3.24.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CreatedUeReachabilitySubscription | M | 1 | 201
Created | Upon success, a response body containing a representation of the created Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | + +**Table 6.2.3.24.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.24.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.24.3.1-6: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nhss-ims-sdm//imsUeId/access-data/ps-domain/ue-reach-subscriptions/{subscriptionId} | + +#### 6.2.3.25 Resource: UE reachability Individual subscription + +#### 6.2.3.25.1 Description + +This resource is used to represent an individual subscription to notification of UE reachability for IP. + +#### 6.2.3.25.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/ps-domain/ue-reach-subscriptions/{subscriptionId}** + +This resource shall support the resource URI variables defined in table 6.2.3.25.2-1. + +**Table 6.2.3.25.2-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip:([a-zA-Z0-9_\-.!~*'()&=+\$,;?%\/]+)@([A-Za-z0-9]+([-A-Za-z0-9]+)*\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+)\$" | +| subscriptionId | The subscriptionId identifies an individual subscription to notification of UE reachability for IP. | + +#### 6.2.3.25.3 Resource Standard Methods + +#### 6.2.3.25.3.1 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.25.3.1-1. + +**Table 6.2.3.25.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity.
Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.25.3.1-2 and the response data structures and response codes specified in table 6.2.3.7.3.1-3. + +**Table 6.2.3.25.3.1-2: Data structures supported by the Delete Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.25.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +**Table 6.2.3.25.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.25.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.25.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.25.3.2-1. + +**Table 6.2.3.25.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| private-identity | Privateld | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUld variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.25.3.2-2 and the response data structures and response codes specified in table 6.2.3.25.3.2-3. + +**Table 6.2.3.25.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1 | It contains the list of changes to be made to the resource representing the individual subscription, according to the JSON PATCH format specified in IETF RFC 6902 [12]. | + +**Table 6.2.3.25.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, a response with no content is returned. (NOTE 1) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 1) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate the following application error:
- MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult. + +**Table 6.2.3.25.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.25.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.26 Resource: PS User State + +### 6.2.3.26.1 Description + +This resource represents the User State information in PS domain. It is queried by the service consumer (e.g. AS) to retrieve the User State information in PS domain as retrieved from the serving node(s). The service consumer may indicate the requested nodes for which the request is applicable (e.g. AMF only) + +### 6.2.3.26.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/ps-domain/user-state** + +This resource shall support the resource URI variables defined in table 6.2.3.26.2-1. + +**Table 6.2.3.26.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId |

Represents the IMS Public Identity (i.e. IMS Public User Identity or Public Service Identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(imp sip):([a-zA-Z0-9_\-\.~!\*\'\(\);&=\+\\$,;\?]+)@([A-Za-z0-9]+([\-A-Za-z0-9]+)\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+ .+)\$"

| + +### 6.2.3.26.3 Resource Standard Methods + +#### 6.2.3.26.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.26.3.1-1. + +**Table 6.2.3.26.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| requested-nodes | array(RequestedNode) | O | 1..N | Indicates the serving node(s) for which the request is applicable. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +If "requested-nodes" is not included, HSS shall return the user state as retrieved from all the nodes (AMF, MME and SGSN) + +This method shall support the request data structures specified in table 6.2.3.26.3.1-2 and the response data structures and response codes specified in table 6.2.3.26.3.1-3. + +**Table 6.2.3.26.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.26.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PsUserState | M | 1 | 200 OK | A response body containing the PS user state information as requested shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the user state information is unknown or unavailable. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.26.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.26.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.27 Resource: CS User State + +### 6.2.3.27.1 Description + +This resource represents the User State information in CS domain. It is queried by the service consumer (e.g. AS) to retrieve the User State information in CS domain as retrieved from the MSC/VLR. + +### 6.2.3.27.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/cs-domain/user-state + +This resource shall support the resource URI variables defined in table 6.2.3.27.2-1. + +**Table 6.2.3.27.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$_;?V]+\}@([A-Za-z0-9]+\{[-A-Za-z0-9]+\}\.)+[a-z]{2,} impu-tel:\{+[0-9]{5,15} impi-\{+\}\.+\})\$" | + +### 6.2.3.27.3 Resource Standard Methods + +#### 6.2.3.27.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.27.3.1-1. + +**Table 6.2.3.27.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.27.3.1-2 and the response data structures and response codes specified in table 6.2.3.27.3.1-3. + +**Table 6.2.3.27.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.27.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------| +| CsUserState | M | 1 | 200 OK | A response body containing the CS user state information as requested shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.27.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.27.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.28 Resource: Csrn + +#### 6.2.3.28.1 Description + +This resource represents the CSRN. It is queried by the service consumer (e.g. SCC-AS) to retrieve a CSRN for the user. + +#### 6.2.3.28.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/cs-domain/csrn** + +This resource shall support the resource URI variables defined in table 6.2.3.28.2-1. + +**Table 6.2.3.28.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId |

Represents the IMS Public Identity (i.e. IMS Public User identity) or the IMS Private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip:([a-zA-Z0-9_\-.!~*()&=+\$,;?V/]+)@([A-Za-z0-9]+([-A-Za-z0-9]+)+\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+)\$"

| + +#### 6.2.3.28.3 Resource Standard Methods + +##### 6.2.3.28.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.28.3.1-1. + +**Table 6.2.3.28.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| pre-paging | PrePaging | O | 0..1 | Indicates if pre-paging is supported

true: pre-paging is supported
false or absent: pre-paging is not supported | | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity.
Shall be present if the imsUId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | | +| call-reference-info | CallReferenceInfo | O | 0..1 | Contains a Call Reference Number and the AS-Number. It allows a later retry of the call setup in the context of MTRR.
See 3GPP TS 29.328 [38] | | + +This method shall support the request data structures specified in table 6.2.3.28.3.1-2 and the response data structures and response codes specified in table 6.2.3.28.3.1-3. + +**Table 6.2.3.28.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.28.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Csrn | M | 1 | 200 OK | A response body containing the CSRN for the user shall be returned. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that CSRN retrieval from MSC/VLR failed. | +| ProblemDetails | O | 0..1 | 403
Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.28.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.28.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.29 Resource: ReferenceAccessLocation + +### 6.2.3.29.1 Description + +This resource represents the Reference Location Information. It is queried by the service consumer (e.g. IMS-AS) to retrieve the reference location information for the user (e.g. line identifier in fixed access networks). + +### 6.2.3.29.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/wireline-domain/reference-location + +This resource shall support the resource URI variables defined in table 6.2.3.29.2-1. + +**Table 6.2.3.29.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity) or the IMS Private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip\:[(a-zA-Z0-9_-\.!~*()&=+\$,;?V +)]@([A-Za-z0-9]+(-[A-Za-z0-9]+)\.)+[a-z]{2,} impu-tel\:[+0-9]{5,15} impi\-[+\.]+\+)\$" | + +### 6.2.3.29.3 Resource Standard Methods + +#### 6.2.3.29.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.29.3.1-1. + +**Table 6.2.3.29.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeld variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | | + +This method shall support the request data structures specified in table 6.2.3.29.3.1-2 and the response data structures and response codes specified in table 6.2.3.29.3.1-3. + +**Table 6.2.3.29.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.29.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ReferenceLocationInformation | M | 1 | 200 OK | A response body containing the reference location information (e.g. access type, line identifier) for the user shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that no reference location information exist for the user. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.29.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.29.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.30 Resource: SMSRegistrationInfo + +### 6.2.3.30.1 Description + +This resource represents the SMS registration information. It is used by the service consumer (e.g. IP-SM-GW) to create, retrieve, update or delete the SMS registration information. + +### 6.2.3.30.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/service-data/sms-registration-info + +This resource shall support the resource URI variables defined in table 6.2.3.30.2-1. + +**Table 6.2.3.30.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip:\{[a-zA-Z0-9_\-\.!~*()\&=+\\$;:,?V]+\}@\{[A-Za-z0-9]+\+\-\{[A-Za-z0-9]+\+\-\{[a-z]{2,}\}impn-tel:\{[0-9]{5,15}\}impi-\+\-\{[a-z]{2,}\})\$" | + +### 6.2.3.30.3 Resource Standard Methods + +#### 6.2.3.30.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.30.3.1-1. + +**Table 6.2.3.30.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.30.3.1-2 and the response data structures and response codes specified in table 6.2.3.30.3.1-3. + +**Table 6.2.3.30.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.30.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SmsRegistrationInfo | M | 1 | 200 OK | A response body containing the SMS registration information. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that no IP-SM-GW number is preconfigured or created previously for the user. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.30.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.30.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.30.3.2 PUT + +This method shall support the URI query parameters specified in table 6.2.3.30.3.2-1. + +**Table 6.2.3.30.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| private-identity | Privateld | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.30.3.2-2 and the response data structures and response codes specified in table 6.2.3.30.3.2-3. + +**Table 6.2.3.30.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|-------------------------------------------------------------| +| lpSmGwAddress | M | 1 | The SMS Registration Information to be created or replaced. | + +**Table 6.2.3.30.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| SmsRegistrationInfo | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual RepositoryData resource shall be returned. | +| SmsRegistrationInfo | M | 1 | 200 OK | Upon success, a response body containing a representation of the updated Individual RepositoryData resource shall be returned. | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | +| ProblemDetails | O | 0..1 | 409 Conflict | The "cause" attribute may be used to indicate the following application error:
- IP_SM_GW_CANNOT_BE_MODIFIED | + +**Table 6.2.3.30.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.30.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.30.3.2-6: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUId}/service-data/sms-registration-info | + +## 6.2.3.30.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.30.3.3-1. + +**Table 6.2.3.30.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------------|------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| private-identity | PrivatedId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.30.3.3-2 and the response data structures and response codes specified in table 6.2.3.30.3.3-3. + +**Table 6.2.3.30.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.30.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that no SMS registration information exists for the user. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | +| ProblemDetails | O | 0..1 | 409 Conflict | The "cause" attribute may be used to indicate the following application error:
- IP_SM_GW_CANNOT_BE_MODIFIED | + +**Table 6.2.3.30.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.30.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.31 Resource: Dsai + +### 6.2.3.31.1 Description + +This resource represents the DSAI Tag Information for the requested Application Server Name. It is used by the service consumer (e.g. IMS-AS) to retrieve or update the DSAI Tag Status. + +### 6.2.3.31.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/service-data/dsai + +This resource shall support the resource URI variables defined in table 6.2.3.31.2-1. + +**Table 6.2.3.31.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. non-shared IMS Public User identity) or the IMS private Identity.

pattern: "^(impu-sip:\{[a-zA-Z0-9\-\-!~*()&=+\$;,?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.)+\-[a-z]{2,}\-impu-tel:\+\[0-9]{5,15}\-impi\-\+\+\+\\$)" | + +### 6.2.3.31.3 Resource Standard Methods + +#### 6.2.3.31.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.31.3.1-1. + +**Table 6.2.3.31.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------| +| application-server-name | SipServerName | M | 1 | The requested Application Server Name. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| dsai-tag | string | O | 0..1 | This information element identify the requested instance of Dynamic Service Activation Info (DSAI). | + +This method shall support the request data structures specified in table 6.2.3.31.3.1-2 and the response data structures and response codes specified in table 6.2.3.31.3.1-3. + +**Table 6.2.3.31.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.31.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DsaiTagInformation | M | 1 | 200 OK | A response body containing the DSAI information for the requested Application Server. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that no DSAI Tag was found for the requested Application Server. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.31.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.31.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.31.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.31.3.2-1. + +**Table 6.2.3.31.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| Supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.31.3.2-2 and the response data structures and response codes specified in table 6.2.3.31.3.2-3. + +**Table 6.2.3.31.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Items describe the modifications to the DSAI tag(s) activation state. | + +**Table 6.2.3.31.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. (NOTE 1) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 1) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- DSAI_TAG_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED, see GPP TS 29.500 [4] table 5.2.7.2-1.
- OPERATION_NOT_ALLOWED | + +NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult. + +**Table 6.2.3.31.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.31.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.32 Resource: Private Identities + +### 6.2.3.32.1 Description + +This resource represents the private identities. It is queried by the service consumer (IMS-AS) to retrieve the list of private identities. + +### 6.2.3.32.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/identities/private-identities + +This resource shall support the resource URI variables defined in table 6.2.3.32.2-1. + +**Table 6.2.3.32.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: " ^ (impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$_;?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-\.[a-z]+\.[a-z]{2,} impi-tel:\+[0-9]{5,15} impi-\.[a-z]+\.[a-z]{2,} impi-tel:\+[0-9]{5,15}))\$" | + +## 6.2.3.32.3 Resource Standard Methods + +### 6.2.3.32.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.32.3.1-1. + +**Table 6.2.3.32.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| impi | PrivateId | O | 0..1 | Private Identity of type IMPI | | + +This method shall support the request data structures specified in table 6.2.3.32.3.1-2 and the response data structures and response codes specified in table 6.2.3.32.3.1-3. + +**Table 6.2.3.32.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.32.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------| +| PrivateIdentities | M | 1 | 200 OK | A response body containing the list of private identities belonging to the IMS UE. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.32.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.32.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.2.3.33 Resource: S-CSCF Selection Assistance Information + +### 6.2.3.33.1 Description + +This resource represents the S-CSCF selection assistance information. It is queried by the service consumer (I-CSCF) before S-CSCF selection. + +### 6.2.3.33.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/location-data/scscf-selection-assistance-info** + +This resource shall support the resource URI variables defined in table 6.2.3.33.2-1. + +**Table 6.2.3.33.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^ (impu-sip sip):([a-zA-Z0-9_\-.!~*'()&=+\$,;?V]+)@([A-Za-z0-9]+([\-A-Za-z0-9]+)*\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+ .+)\$" | + +### 6.2.3.33.3 Resource Standard Methods + +#### 6.2.3.33.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.33.3.1-1. + +**Table 6.2.3.33.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.33.3.1-2 and the response data structures and response codes specified in table 6.2.3.33.3.1-3. + +**Table 6.2.3.33.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 6.2.3.33.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ScscfSelectionAssistanceInformation | M | 1 | 200 OK | A response body containing the S-CSCF Selection Assistance Information. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

NOTE: DATA_NOT_FOUND indicates that any S-CSCF can be selected, e.g. based on I-CSCF local policy. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.33.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.33.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.34 Resource: Charging Information + +### 6.2.3.34.1 Description + +This resource represents the Charging Information. It is queried by the service consumer (e.g. AS) to retrieve the Diameter addresses Charging Functions for the user. + +### 6.2.3.34.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/profile-data/charging-info + +This resource shall support the resource URI variables defined in table 6.2.3.34.2-1. + +**Table 6.2.3.34.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip:([a-zA-Z0-9_\.!~*()&=+\$;,?/]+)@([A-Za-z0-9]+([-A-Za-z0-9]+\.)+[a-z]{2,}) impu-tel:\+[0-9]{5,15} impi-.+ .+)\$" | + +### 6.2.3.34.3 Resource Standard Methods + +**6.2.3.34.3.1 GET** + +This method shall support the URI query parameters specified in table 6.2.3.34.3.1-1. + +**Table 6.2.3.34.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.2.3.34.3.1-2 and the response data structures and response codes specified in table 6.2.3.34.3.1-3. + +**Table 6.2.3.34.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.34.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| ChargingInfo | M | 1 | 200 OK | A response body containing the Charging Information for the user shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +#### 6.2.3.35 Resource: Repository Data List + +#### 6.2.3.35.1 Description + +This resource represents the Repository Data. It is used by the service consumer (e.g. IMS-AS) to retrieve multiple repository data for a given list of service indications. + +#### 6.2.3.35.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/repository-data** + +This resource shall support the resource URI variables defined in table 6.2.3.19.2-1. + +**Table 6.2.3.35.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)
pattern: "^(impu-sip:\{[a-zA-Z0-9 \-\.!~*()&=+\$,;?V]+\}@([A-Za-z0-9]+([-A-Za-z0-9]+\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-\+\.+\+)\$" | + +## 6.2.3.35.3 Resource Standard Methods + +### 6.2.3.35.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.35.3.1-1. + +**Table 6.2.3.35.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------------|--------------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| service-indications | array(ServiceIndication) | M | 1..N | | + +This method shall support the request data structures specified in table 6.2.3.35.3.1-2 and the response data structures and response codes specified in table 6.2.3.35.3.1-3. + +**Table 6.2.3.35.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.35.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| RepositoryDataList | M | 1 | 200 OK | A response body containing the Repository Data List for the requested Service Indications. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.35.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.35.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.5 Notifications + +### 6.2.5.1 General + +This clause specifies the use of notifications and corresponding protocol details. + +### 6.2.5.2 Data Change Notification + +The POST method shall be used for Data Change Notifications and the URI shall be as provided during the subscription procedure. + +Resource URI: {callbackReference} + +Support of URI query parameters is specified in table 6.2.5.2-1. + +**Table 6.2.5.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.2.5.2-2 and of response data structures and response codes is specified in table 6.2.5.2-3. + +**Table 6.2.5.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|-------------| +| ModificationNotification | M | 1 | | + +**Table 6.2.5.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- CONTEXT_NOT_FOUND

See table 6.2.7.3-1 for the description of this error. | + +**Table 6.2.5.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the notification endpoint of the subscribing NF. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.5.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the notification endpoint of the subscribing NF. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.6 Data Model + +### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Nhss\_imsSDM service API. + +**Table 6.2.6.1-1: Nhss\_imsSDM specific Data Types** + +| Data type | Clause defined | Description | +|-----------------------------------|----------------|--------------------------------------------------------------------------------------------------------------------------| +| ScscfCapabilityList | 6.2.6.2.2 | Information about mandatory and optional S-CSCF capabilities | +| ImsProfileData | 6.2.6.2.4 | User's IMS profile data | +| RepositoryData | 6.2.6.2.7 | Repository Data for the requested Service Indication | +| MsisdnList | 6.2.6.2.8 | List of MSISDNs associated to the IMS public Identity | +| PublicIdentities | 6.2.6.2.9 | IMS Public Identities which belong to the same Implicit Registration Set (if any) as the requested IMS Public Identity | +| PublicIdentity | 6.2.6.2.10 | IMS Public Identity and the related data (Alias Group Id, IRS default indication, Identity Type) | +| ImsSdmSubscription | 6.2.6.2.11 | A subscription to notifications of data change | +| ImsRegistrationStatus | 6.2.6.2.12 | Registration status of the user. | +| PriorityLevels | 6.2.6.2.13 | Namespaces and priority levels allowed for the IMS public Identity. | +| Ifcs | 6.2.6.2.14 | List of IFCs associated to the IMS public Identity | +| Ifc | 6.2.6.2.15 | Data associated to an individual IFC (Initial Filter Criteria) | +| TriggerPoint | 6.2.6.2.16 | Contains the conditions that should be checked in order to find out if an Application Server should be contacted or not | +| Spt | 6.2.6.2.17 | Contains the data of a Service Point Trigger | +| HeaderSipRequest | 6.2.6.2.18 | Contains a header (and optionally value of the header) in the SIP request | +| SdpDescription | 6.2.6.2.19 | Contains a SDP line (and optionally the value in the line) within the body (if any) of a SIP request | +| ApplicationServer | 6.2.6.2.20 | Application Server which shall be triggered if the conditions of a certain IFC are met, and its associated data | +| ImsLocationData | 6.2.6.2.21 | IMS Location Data (S-CSCF name) | +| ServiceLevelTraceInformation | 6.2.6.2.22 | IMS Service Level Trace Information | +| PsLocation | 6.2.6.2.23 | Location data in PS domain. | +| SgsnLocationData | 6.2.6.2.24 | Location information as retrieved from the SGSN serving node | +| MmeLocationData | 6.2.6.2.25 | Location information as retrieved from the MME serving node | +| AmfLocationData | 6.2.6.2.26 | Location information as retrieved from the AMF serving node | +| TwanLocationData | 6.2.6.2.27 | Location information of the 3GPP AAA Server for Trusted W-LAN Access | +| CsLocation | 6.2.6.2.28 | Location data in CS domain. | +| CsgInformation | 6.2.6.2.29 | Information about a Closed Subscriber Group (CSG) | +| SrvccData | 6.2.6.2.30 | UE SRVCC capability (if available) and STN-SR (if subscribed) | +| PsiActivationState | 6.2.6.2.31 | Public Service Identity activation state | +| ImeiSvInformation | 6.2.6.2.34 | IMEI(SV) information | +| TadsInformation | 6.2.6.2.36 | T-ADS Information | +| UeReachabilitySubscription | 6.2.6.2.37 | A subscription to notifications of UE reachability for IP. | +| UeReachabilityNotification | 6.2.6.2.38 | A notification of UE reachability for IP. | +| PsUserState | 6.2.6.2.39 | User state in PS domain | +| CsUserState | 6.2.6.2.40 | User state in CS domain | +| Csrn | 6.2.6.2.41 | CS domain routeing number | +| ReferenceLocationInformation | 6.2.6.2.42 | Reference Location Information for the user in fixed access networks. | +| SmsRegistrationInfo | 6.2.6.2.43 | SMS Registration Information (IP-SM-GW number and SC address) | +| IpSmGwAddress | 6.2.6.2.44 | IP-SM-GW number and diameter URI/realm | +| ImsAssociatedIdentities | 6.2.6.2.45 | A list of identities belonging to the same Implicit Registration Set (IRS), along with the registration state of the IRS | +| DsaiTagInformation | 6.2.6.2.46 | DSAI tag information (list of DSAI tags activation state for an Application Server) | +| DsaiTagStatus | 6.2.6.2.47 | DSAI tag status (DSAI tag and activation state) | +| CreatedUeReachabilitySubscription | 6.2.6.2.48 | A subscription to notifications of UE reachability for IP. | +| PrivateIdentities | 6.2.6.2.49 | IMS Private Identities | + +| | | | +|-------------------------------------|------------|----------------------------------------------------------------| +| PrivateIdentity | 6.3.6.2.50 | IMS Private Identity and the related data (e.g. Identity Type) | +| ScscfSelectionAssistanceInformation | 6.2.6.2.51 | Information used by the I-CSCF to select an S-CSCF for the UE | +| ChargingInfo | 6.2.6.2.52 | Diameter addresses of the charging function | +| RepositoryDataList | 6.2.6.2.53 | List of Repository Data for the requested Service Indications | +| CoreNetworkServiceAuthorization | 6.2.6.2.54 | Core Network Service Authorization | + +Table 6.2.6.1-2 specifies data types re-used by the Nhss\_imsSDM service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nhss\_imsSDM. + +**Table 6.2.6.1-2: Nhss\_imsSDM re-used Data Types** + +| Data type | Reference | Comments | +|--------------------------|---------------------|---------------------------------------------------------| +| Uri | 3GPP TS 29.571 [16] | Uniform Resource Identifier | +| SupportedFeatures | 3GPP TS 29.571 [16] | see 3GPP TS 29.500 [4] clause 6.6 | +| ModificationNotification | 3GPP TS 29.503 [15] | Content of the notification after a data change | +| EutraLocation | 3GPP TS 29.571 [16] | E-UTRAN user location | +| NrLocation | 3GPP TS 29.571 [16] | NR user location | +| PlmnId | 3GPP TS 29.571 [16] | PLMN Identity | +| TimeZone | 3GPP TS 29.571 [16] | Time Zone and Daylight Saving Time | +| UtraLocation | 3GPP TS 29.571 [16] | UTRAN user location | +| GeraLocation | 3GPP TS 29.571 [16] | GERAN user location | +| DiameterIdentity | 3GPP TS 29.571 [16] | Diameter URI | +| NfInstanceId | 3GPP TS 29.571 [16] | String uniquely identifying a NF instance | +| RatType | 3GPP TS 29.571 [16] | RAT type | +| StnSr | 3GPP TS 29.571 [16] | Session Transfer Number for SRVCC | +| PatchItem | 3GPP TS 29.571 [16] | Patch Item | +| PatchResult | 3GPP TS 29.571 [16] | Patch Result | +| IpAddr | 3GPP TS 29.571 [16] | IP address (IPv4 address, IPv6 address, or IPv6 Prefix) | +| DateTime | 3GPP TS 29.571 [16] | UTC time | +| AccessType | 3GPP TS 29.571 [16] | Type of access | +| ProblemDetails | 3GPP TS 29.571 [16] | Response body of error response messages. | +| RedirectResponse | 3GPP TS 29.571 [16] | Response body of redirect response messages. | +| Ecgi | 3GPP TS 29.571 [16] | E-UTRAN Cell Global Identity | +| Tai | 3GPP TS 29.571 [16] | Tracking Area Identity | + +## 6.2.6.2 Structured data types + +### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 6.2.6.2.2 Type: ScscfCapabilityList + +**Table 6.2.6.2.2-1: Definition of type ScscfCapabilityList** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|--------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mandatoryCapabilityList | Capabilities | O | 1 | List of S-CSCF capabilities which are mandatory to be supported by the S-CSCF allocated to the subscription the user belongs to. | +| optionalCapabilityList | Capabilities | O | 1 | List of S-CSCF capabilities which are optional or preferred (but not mandatory) to be supported by the S-CSCF allocated to the subscription the user belongs to. | + +NOTE 1: At least one of mandatory or optional capabilities shall be present. + +## 6.2.6.2.3 Type: Capabilities + +Table 6.2.6.2.3-1: Definition of type Capabilities + +| Type Name | Type Definition | Description | +|--------------|-------------------|-----------------------------------------| +| Capabilities | array(Capability) | This IE contains a list of capabilities | + +## 6.2.6.2.4 Type: ImsProfileData + +Table 6.2.6.2.4-1: Definition of type ImsProfileData + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|------------------------------|---|-------------|-------------------------------------------------------------------------------------| +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.2.8 | +| imsServiceProfiles | array(ImsServiceProfile) | M | 1..N | IMS service profile shared by several public identities when they belong to an IRS. | +| chargingInfo | ChargingInfo | O | 0..1 | A response body containing the Charging Information for the user. | +| serviceLevelTraceInfo | ServiceLevelTraceInformation | O | 0..1 | IMS Service Level Trace information. Syntax described in 3GPP TS 24.323 [24]. | +| servicePriorityLevelList | array(NameSpacePriority) | O | 1..N | List of namespaces and their associated priorities allowed for the user. | +| maxAllowedSimulReg | integer | O | 0..1 | Maximum number of allowed simultaneous registrations for the Public User Identity. | +| servicePriorityLevel | integer | O | 0..1 | Possible values:
0 (Highest priority)
1
2
3
4 (Lowest priority) | + +## 6.2.6.2.5 Type: SharedData + +Table 6.2.6.2.5-1: SharedData + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|--------------|---|-------------|-------------------------------| +| sharedDataId | SharedDataId | M | 1 | Identifier of the shared data | +| sharedImsIfcData | Ifcs | O | 0..1 | Shared IFC Subscription Data | + +NOTE 1: The attribute sharedImsIfcData shall not contain sharedDataIds. +NOTE 2: When shared data clash with individual data, individual data shall take precedence. + +## 6.2.6.2.6 Type: ImsDataSets + +Table 6.2.6.2.6-1: ImsDataSets + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------| +| ifcData | IfcData | O | 0..1 | IFC Data | + +## 6.2.6.2.7 Type: RepositoryData + +Table 6.2.6.2.7-1: Definition of type RepositoryData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|---------------------------------------------------------------------------| +| serviceData | string | M | 1 | The Repository Data for the requested Service Indication. Base64 encoded. | +| sequenceNumber | SequenceNumber | M | 1 | The sequence number associated to the current version of Repository Data. | + +## 6.2.6.2.8 Type: MsisdnList + +**Table 6.2.6.2.8-1: Definition of type MsisdnList** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|---------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------| +| basicMsisdn | Msisdn | M | 1 | The basic (or correlation) MSISDN associated to the IMS Public Identity for the IMS Private Identity indicated (if any) | +| additionalMsisdns | array(Msisdn) | O | 1..N | Additional MSISDNs | + +## 6.2.6.2.9 Type: PublicIdentities + +**Table 6.2.6.2.9-1: Definition of type PublicIdentities** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-----------------------|---|-------------|------------------------------------------| +| publicIdentities | array(PublicIdentity) | M | 1..N | List of IMS Public Identities associated | + +## 6.2.6.2.10 Type: PublicIdentity + +**Table 6.2.6.2.10-1: Definition of type PublicIdentity** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| imsPublicId | ImsPublicId | M | 1 | IMS Public Identity (distinct or wildcarded) | +| identityType | IdentityType | M | 1 | Type of IMS Public Identity (e.g. Wildcarded Public Service Identity type) | +| irIsDefault | boolean | O | 0..1 | Indicates whether the IMS Public Identity is the default within the Implicit Registration Set. Absence and false indicates "non-default".
Only one identity in SIP URI format and one identity in TEL URI format (if any) shall have value True for this attribute. | +| aliasGroupId | string | O | 0..1 | Indicates the Alias Public User Identity Group to which the Public User Identity belongs. Absence indicates that the identity does not belong to any Alias Group | + +## 6.2.6.2.11 Type: ImsSdmSubscription + +**Table 6.2.6.2.11-1: ImsSdmSubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|---------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nflInstanceId | NflInstanceId | M | 1 | Identity of the NF Instance creating the subscription. | +| callbackReference | Uri | M | 1 | URI provided by the NF service consumer to receive notifications | +| monitoredResourceUris | array(Uri) | M | 1..N | A set of URIs that identify the resources for which a change triggers a notification.
The URI shall take the form of either an absolute URI or an absolute-path reference as defined in IETF RFC 3986 [31].
See NOTE. | +| expires | DateTime | C | 0..1 | If present, indicates the point in time at which the subscription expires.
Within a POST request the proposed expiry time is conveyed whereas in a POST response or PATCH response the confirmed expiry time is returned. | + +NOTE: The HSS should handle only the relative-path part (apiSpecificResourceUriPart, see 3GPP TS 29.501 [5] clause 4.4.1) and ignore possible inconsistencies in the base URI part. + +## 6.2.6.2.12 Type: ImsRegistrationStatus + +**Table 6.2.6.2.12-1: Definition of type ImsRegistrationStatus** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------| +| imsUserStatus | ImsRegistrationState | M | 1 | It contains the registration state of the user or the IRS, as described in 3GPP TS 29.328 [38], clause 7.6.3. | + +## 6.2.6.2.13 Type: PriorityLevels + +**Table 6.2.6.2.13-1: Definition of type PriorityLevels** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|--------------------------|---|-------------|--------------------------------------------------------------------------------| +| servicePriorityLevelList | array(NameSpacePriority) | M | 1..N | List of namespaces and their associated priorities allowed for the user. | +| servicePriorityLevel | integer | O | 0..1 | Possible values:
0 (Highest priority)
1
2
3
4 (Lowest priority) | + +## 6.2.6.2.14 Type: Ifcs + +**Table 6.2.6.2.14-1: Definition of type Ifcs** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------|------------------------|---|-------------|---------------------------------------------------------| +| ifcList | array(Ifc) | C | 1..N | List of complete IFCs which are associated to the user. | +| cscfFilterSetIdList | array(cscfFilterSetId) | C | 1..N | List of S-CSCF specific filter set identifiers. | +| NOTE: At least one of IfcList or cscfFilterSetIdList shall be present. | | | | | + +## 6.2.6.2.15 Type: Ifc + +**Table 6.2.6.2.15-1: Definition of type Ifc** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| priority | integer | M | 1 | Contains the priority of the IFC. The higher the Priority Number the lower the priority of the Filter Criteria is.
Minimum: 1 | +| trigger | TriggerPoint | O | 1 | Contains the conditions that should be checked in order to find out if the indicated Application Server should be contacted or not. The absence of this attribute will indicate an unconditional triggering to Application Server. | +| appServer | ApplicationServer | M | 1 | Contains the Application Server which shall be triggered if the conditions are met and its associated data (e.g. default handling) | +| NOTE : See 3GPP TS 29.228 [20], Annex B.2.2 for more details on the terms and concepts associated to Initial Filter Criteria. The ProfilePartIndicator attribute described in Annex B.2.2 is removed and it shall be derived from the SessionCase attribute described in Annex B.2.3. | | | | | + +## 6.2.6.2.16 Type: TriggerPoint + +Table 6.2.6.2.16-1: Definition of type TriggerPoint + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| conditionType | TypeOfCondition | M | 1 | Indicates how the set of SPTs are expressed, i.e. either an Ored set of ANDed sets of SPT statements or an ANDed set of Ored sets of statements. These combinations are termed, respectively, Disjunctive Normal Form (DNF) and Conjunctive Normal Form (CNF) for the SPT (see 3GPP TS 29.228 [20], Annex C). | +| sptList | array(Spt) | M | 1..N | Contains the list of Service Point Triggers | + +## 6.2.6.2.17 Type: Spt + +Table 6.2.6.2.17-1: Definition of type Spt + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| conditionNegated | boolean | M | 1 | Indicates if the Service Point Trigger instance is negated (i.e. NOT logical expression) | +| sptGroup | array(SptGroupId) | M | 1..N | Contains the SPT group or list of SPT groups assigned to the SPT. | +| regType | array(RegistrationType) | O | 1..2 | Indicates the type of registration. If included, it shall contain the values that define whether the SPT matches to REGISTER messages that are related to initial registrations, re-registrations, and/or de-registrations. This attribute shall be included only if the SPT is for SIP method with a value "REGISTER" and only if it does not apply to all types of registration; otherwise, it shall be absent (i.e. the SIP Method SPT matches to all REGISTER messages).
The attribute regType shall be discarded if it is present in an SPT other than SIP Method with value "REGISTER". | +| requestURI | string | C | 1 | Contains the request-URI of the SIP request (NOTE 2) | +| sipMethod | string | C | 1 | Contains the method of the SIP request (NOTE 2) | +| sipHeader | HeaderSipRequest | C | 1 | Contains a header (and optionally value of the header) in the SIP request (NOTE 2) | +| sessionCase | RequestDirection | O | 1 | Contains the direction of the SIP request as evaluated by the S-CSCF. | +| sessionDescription | SdpDescription | C | 1 | Contains a SDP line (and optionally the value in the line) within the body (if any) of a SIP request (NOTE 2) | + +NOTE 1: See 3GPP TS 29.228 [20], Annex B.2.3 for more details on the terms and concepts associated to Service Point Trigger. The ProfilePartIndicator attribute described in Annex B.2.2 is removed and it shall be derived from the SessionCase attribute described in Annex B.2.3. + +NOTE 2: Exactly one of requestURI, method, header and sessionDescription shall be present. See TS 29.228 [20], Annex F for the definition of these attributes. + +## 6.2.6.2.18 Type: HeaderSipRequest + +Table 6.2.6.2.18-1: Definition of type HeaderSipRequest + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| header | string | M | 1 | Contains a SIP header | +| content | string | O | 1 | Contains the content of the SIP header. If this attribute is absent, it shall indicate that the SPT is the presence (if conditionNegated="FALSE") or absence (if conditionNegated="TRUE") of the SIP header. | + +## 6.2.6.2.19 Type: SdpDescription + +**Table 6.2.6.2.19-1: Definition of type SdpDescription** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| line | string | M | 1 | Contains a line in the session description | +| content | string | O | 1 | Contains the content of the SDP line. If this attribute is absent, it shall indicate that the SPT is the presence (if conditionNegated="FALSE") or absence (if conditionNegated="TRUE") of the SDP line. | + +## 6.2.6.2.20 Type: ApplicationServer + +**Table 6.2.6.2.20-1: Definition of type ApplicationServer** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|---------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| asUri | string | M | 1 | Contains the Application Server SIP URI, as described in IETF RFC 3261 [22] or 3GPP TS 23.003 [13]. | +| sessionContinue | boolean | O | 1 | This IE indicates whether the SIP dialog shall be continued or released if the Application Server could not be reached.

true: indicates that the session shall be continued

false or absent: indicates that the session shall be released | +| serviceInfoList | array(ServiceInformation) | O | 1..N | Indicates a list of service information that shall be sent to the Application Server. | + +## 6.2.6.2.21 Type: ImsLocationData + +**Table 6.2.6.2.21-1: Definition of type ImsLocationData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------| +| scscfName | string | M | 1 | S-CSCF name assigned to the IMS subscription the UE belongs to in the form of a SIP URI, as defined in IETF RFC 3261 [22]. | + +## 6.2.6.2.22 Type: ServiceLevelTraceInformation + +**Table 6.2.6.2.22-1: Definition of type ServiceLevelTraceInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------| +| serviceLevelTraceInfo | string | M | 1 | IMS Service Level Trace information. Syntax described in 3GPP TS 24.323 [24] | + +## 6.2.6.2.23 Type: PsLocation + +**Table 6.2.6.2.23-1: Definition of type PsLocation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|------------------------------------------------| +| sgsnLocation | SgsnLocationData | O | 0..1 | Location information as retrieved from SGSN | +| mmeLocation | MmeLocationData | O | 0..1 | Location information as retrieved from MME | +| amfLocation | AmfLocationData | O | 0..1 | Location information as retrieved from AMF | +| twanLocation | TwanLocationData | O | 0..1 | 3GPP AAA Server for TWAN Location information. | + +NOTE: At least one of the "sgsnLocation", "mmeLocation", "amfLocation" or "twanLocation" shall be included. + +## 6.2.6.2.24 Type: SgsnLocationData + +**Table 6.2.6.2.24-1: Definition of type SgsnLocationData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| sgsnNumber | string | M | 1 | SGSN number. See 3GPP TS 23.003 [13] clause 5.1. | +| plmnId | PlmnId | M | 1 | PLMN identity | +| sgsnLocation | UltraLocation | O | 0..1 | User location as retrieved from SGSN. | +| csgInformation | CsgInformation | O | 0..1 | Closed Subscriber Group Information. See 3GPP TS 23.060 [25]. | +| timeZone | TimeZone | O | 0..1 | Local Time Zone information (Time Zone and Daylight Saving Time) of the location in the visited network where the UE is located. | +| ratType | RatType | O | 0..1 | RAT type | + +## 6.2.6.2.25 Type: MmeLocationData + +**Table 6.2.6.2.25-1: Definition of type MmeLocationData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| mmeAddress | DiameterIdentity | M | 1 | MME diameter identity | +| plmnId | PlmnId | M | 1 | PLMN identity | +| mmeLocation | EutraLocation | O | 0..1 | User location as retrieved from MME. | +| csgInformation | CsgInformation | O | 0..1 | Closed Subscriber Group Information. See 3GPP TS 23.060 [25]. | +| timeZone | TimeZone | O | 0..1 | Local Time Zone information (Time Zone and Daylight Saving Time) of the location in the visited network where the UE is located. | +| ratType | RatType | O | 0..1 | RAT type | + +## 6.2.6.2.26 Type: AmfLocationData + +**Table 6.2.6.2.26-1: Definition of type AmfLocationData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| amfAddress | NfInstanceId | M | 1 | AMF identity. | +| plmnId | PlmnId | M | 1 | PLMN identity | +| amfLocation | NrLocation | O | 0..1 | User location as retrieved from AMF. | +| smsfAddress | NfInstanceId | O | 0..1 | SMSF identity | +| timeZone | TimeZone | O | 0..1 | Local Time Zone information (Time Zone and Daylight Saving Time) of the location in the visited network where the UE is located. | +| ratType | RatType | O | 0..1 | RAT type | + +## 6.2.6.2.27 Type: TwanLocationData + +Table 6.2.6.2.27-1: Definition of type TwanLocationData + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| twanSsid | string | M | 1 | TWAN SSID, as defined in 3GPP TS 29.273 [26]. | +| plmnId | PlmnId | M | 1 | PLMN identity of the TWAN | +| twanBssid | string | O | 0..1 | TWAN BSSID, as defined in 3GPP TS 29.273 [26]. | +| civicAddress | string | O | 0..1 | Defined in clause 3.4 of IETF RFC 4776 [27] excluding the first 3 octets. Base64 encoded, according to IETF RFC 2045 [28]. | +| twanOperatorName | string | O | 0..1 | TWAN Operator Name, as defined in clause 19.8 of 3GPP TS 23.003 [13]. | +| timeZone | TimeZone | O | 0..1 | Local Time Zone information (Time Zone and Daylight Saving Time) of the location in the visited network where the UE is located. | +| logicalAccessId | string | O | 0..1 | Logical Access ID, as defined in ETSI ES 283 034 [29]. | + +## 6.2.6.2.28 Type: CsLocation + +Table 6.2.6.2.28-1: Definition of type CsLocation + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| mscNumber | string | M | 0..1 | MSC number. See 3GPP TS 23.003 [13] clause 5.1. | +| vlrNumber | string | M | 0..1 | VLR number. See 3GPP TS 23.003 [13] clause 5.1. | +| plmnId | PlmnId | M | 0..1 | PLMN identity | +| vlrLocation | GeraLocation | O | 0..1 | User location as retrieved from MSC/VLR. | +| csgInformation | CsgInformation | O | 0..1 | Closed Subscriber Group Information. See 3GPP TS 23.060 [25]. | +| timeZone | TimeZone | O | 0..1 | Local Time Zone information (Time Zone and Daylight Saving Time) of the location in the visited network where the UE is located. | +| eUtranCgi | Ecgi | O | 0..1 | E-UTRAN Cell Global Identity | +| tai | Tai | O | 0..1 | Tracking Area ID | + +## 6.2.6.2.29 Type: CsgInformation + +Table 6.2.6.2.29-1: Definition of type CsgInformation + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| csgId | string | M | 1 | CSG Identity. Syntax described in 3GPP TS 29.002 [30] i.e. 5 octets BER encoded value of 27-bit BIT STRING (Base64 encoded according to IETF RFC 2045 [28]). Length = 8. | +| accessMode | string | O | 0..1 | CSG Access Mode. Syntax described in 3GPP TS 29.002 [30] (Base64 encoded according to IETF RFC 2045 [28]). Length = 4. | +| cMi | boolean | O | 0..1 | CSG Membership Indication
0: CSG membership
1: non CSG membership | + +## 6.2.6.2.30 Type: SrvccData + +Table 6.2.6.2.30-1: Definition of type SrvccData + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------| +| stnSr | StnSr | M | 1 | Indicates the STN-SR (Session Transfer Number for SRVCC) of the UE. | +| ueSrvccCapabilities | array(SrvccCapability) | O | 1..N | List of accesses supported by UE SRVCC capability (e.g. 4G, 5G).
Absence of this attribute indicates that UE is not SRVCC capable. | + +## 6.2.6.2.31 Type: PsiActivationState + +Table 6.2.6.2.31-1: Definition of type PsiActivationState + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------------|---|-------------|-------------------------------------------------| +| activationState | ActivationState | M | 1 | Indicates whether the PSI is active or inactive | + +## 6.2.6.2.32 Type: ImsServiceProfile + +Table 6.2.6.2.32-1: Definition of type ImsServiceProfile + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|---------------------------------|---|-------------|------------------------------------------------------------------------------------| +| publicIdentifierList | array(PublicIdentifier) | M | 1..N | List of public identities sharing the same service profile and its individual data | +| ifcs | Ifcs | O | 1 | List of IFCs and/or shared IFC set identifiers | +| cnServiceAuthorization | CoreNetworkServiceAuthorization | O | 0..1 | Core Network Service Authorization | + +## 6.2.6.2.33 Type: PublicIdentifier + +Table 6.2.6.2.33-1: Definition of type PublicIdentifier + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| publicIdentity | PublicIdentity | M | 1 | Public identity information | +| displayName | string | O | 1 | Name associated with the public identity | +| imsServicePriority | PriorityLevels | O | 1 | Multimedia service priority | +| serviceLevelTraceInfo | ServiceLevelTraceInfo | O | 1 | Service Level Tracing Information | +| barringIndicator | boolean | O | 1 | Indicates whether the identity is barred, i.e. it can not be used in any IMS communication except registrations, re-registrations and de-registrations.

true: identity is barred
false or absent: identity is not barred | +| wildcardedImpu | String | O | 1 | When identityType is wildcarded IMPU it contains the wildcard id as stored by HSS | + +## 6.2.6.2.34 Type: ImeiSvInformation + +Table 6.2.6.2.34-1: Definition of type ImeiSvInformation + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------------------------|-----------|---|-------------|----------------------| +| imei | Imei | C | 1 | Indicates the IMEI | +| imeiSv | ImeiSv | C | 1 | Indicates the IMEISV | +| NOTE: Either imei or imeiSv shall be present. | | | | | + +6.2.6.2.35 Void + +6.2.6.2.36 Type: TadsInformation + +**Table 6.2.6.2.36-1: Definition of type TadsInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|------------------------------|---|-------------|-----------------------------------------------------------| +| voiceOverPsSessionSupport | ImsVoiceOverPsSessionSupport | M | 1 | Indicates the support for Voice over PS | +| accessType | AccessType | O | 0..1 | Indicates the type of access | +| ratType | RatType | O | 0..1 | Indicates the RAT Type | +| lastUeActivityTime | DateTime | O | 0..1 | Indicates the time of the last radio contact with the UE. | + +6.2.6.2.37 Type: UeReachabilitySubscription + +**Table 6.2.6.2.37-1: Definition of type UeReachabilitySubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------| +| expiry | DateTime | M | 1 | Indicates the suggested time at which monitoring should cease and the subscription should become invalid. | +| callbackReference | Uri | M | 1 | Callback URI provided by the subscribing NF service consumer. | + +6.2.6.2.38 Type: UeReachabilityNotification + +**Table 6.2.6.2.38-1: Definition of type UeReachabilityNotification** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|---------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| reachabilityIndicator | boolean | M | 1 | Indicates that the UE has been detected reachable for IP. | +| detectingNode | DetectingNode | M | 1 | Indicates the serving node which detected the UE reachability for IP. | +| accessType | AccessType | C | 1 | Indicates the access type (e.g. non 3GPP) where the reachability was detected. It shall be present when the serving node is AMF. | + +6.2.6.2.39 Type: PsUserState + +**Table 6.2.6.2.39-1: Definition of type PsUserState** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------------------------|-------------|---|-------------|-----------------------------------| +| sgsnUserState | UserStatePs | C | 0..1 | User state as retrieved from SGSN | +| mmeUserState | UserStatePs | C | 0..1 | User state as retrieved from MME | +| amfUserState | UserStatePs | C | 0..1 | User state as retrieved from AMF | +| NOTE: At least one of the "sgsnUserState", "mmeUserState" or "amfUserState" shall be included. | | | | | + +6.2.6.2.40 Type: CsUserState + +**Table 6.2.6.2.40-1: Definition of type PsUserState** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-------------|---|-------------|--------------------------------------| +| mscVlrUserState | UserStateCs | M | 1 | User state as retrieved from MSC/VLR | + +## 6.2.6.2.41 Type: Csrn + +**Table 6.2.6.2.41-1: Definition of type CsrnInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------| +| csrn | Msisdn | M | 1 | Contains a CS domain routeing number as retrieved from MSC/VLR | + +## 6.2.6.2.42 Type: ReferenceLocationInformation + +**Table 6.2.6.2.42-1: Definition of type ReferenceLocationInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------| +| accessType | string | C | 1 | Indicates the type of access for which the reference location of the user is defined (e.g. ADSL). | +| accessInfo | string | C | 1 | Indicates the type of the access information defined for the reference location of the user (e.g. dsl-location). | +| accessValue | string | C | 1 | It contains the location information (e.g. line identifier in fixed access networks) as configured by the operator. | + +NOTE 1: At least one of accessType or accessInfo or accessValue shall be present. +NOTE 2: The syntax of accessType, accessInfo and accessValue is as described in 3GPP TS 24.229 [18] for P-Access-Network-Info header fields: accessType corresponds to the "access-type" field whereas accessInfo and accessValue correspond to the type and associated value defined for the "access-info" field. + +## 6.2.6.2.43 Type: SmsRegistrationInfo + +**Table 6.2.6.2.43-1: Definition of type SmsRegistrationInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------------------------| +| ipSmGwNumber | Msisdn | M | 1 | IP-SM-GW number | +| scAddress | Msisdn | O | 0..1 | Short Message Service Centre Address | + +## 6.2.6.2.44 Type: IpSmGwAddress + +**Table 6.2.6.2.44-1: Definition of type IpSmGwAddress** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ipSmGwNumber | Msisdn | M | 1 | IP-SM-GW number | +| ipSmGwDiaUri | DiameterIdentity | O | 0..1 | IP-SM-GW Diameter Uri. It shall be present if s6c is supported. | +| ipSmGwDiaRealm | DiameterIdentity | O | 0..1 | IP-SM-GW Diameter Realm. It shall be present if s6c is supported. | +| ipSmGwSbiSupInd | boolean | C | 0..1 | SBI Support Indication of the IP-SM-GW. it shall be present if provided in SMS Registration Information Creation or Update procedure (see clauses 5.3.2.7.6)
Contains the indication on whether or not the IP-SM-GW is expecting to support SBI-based MT SM transmit.
- true: the IP-SM-GW supports SBI for MT SM transmit.
- false, or absence of this attribute: the IP-SM-GW do not support SBI for MT SM transmit. | + +## 6.2.6.2.45 Type: ImsAssociatedIdentities + +**Table 6.2.6.2.45-1: Definition of type ImsAssociatedIdentities** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|----------------------|---|-------------|----------------------------------------------------------------------| +| irsState | ImsRegistrationState | M | 1 | It contains the registration state of the Implicit Registration Set. | +| publicIdentities | PublicIdentities | M | 1 | List of IMS Public Identities associated. | + +## 6.2.6.2.46 Type: DsaiTagInformation + +**Table 6.2.6.2.46-1: Definition of type DsaiTagInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|----------------------|---|-------------|--------------------------------------------------------------| +| dsaiTagStatusList | array(DsaiTagStatus) | M | 1..N | List of DSAI Tags associated to the Application Server Name. | + +## 6.2.6.2.47 Type: DsaiTagStatus + +**Table 6.2.6.2.47-1: Definition of type DsaiTagStatus** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|-----------------------------------------------------| +| dsaiTag | string | M | 1 | DSAI tag associated to the Application Server Name. | +| dsaiStatus | ActivationState | M | 1 | Status of DSAI tag | + +## 6.2.6.2.48 Type: CreatedUeReachabilitySubscription + +**Table 6.2.6.2.48-1: Definition of type CreatedUeReachabilitySubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------| +| expiry | DateTime | M | 1 | Indicates the granted time at which monitoring will cease and the subscription becomes invalid. | + +## 6.2.6.2.49 Type: PrivateIdentities + +**Table 6.2.6.2.49-1: Definition of type PrivateIdentities** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|------------------------|---|-------------|--------------------------------------------| +| privateIdentities | array(PrivateIdentity) | M | 1..N | List of IMS Private Identities associated. | + +## 6.2.6.2.50 Type: PrivateIdentity + +**Table 6.2.6.2.50-1: Definition of type PrivateIdentity** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------------|---|-------------|---------------------------------------------------| +| privateIdentity | PrivateId | M | 1 | IMS Private Identity. | +| privateIdentityType | PrivateIdentityType | M | 1 | Type of IMS Private Identity (e.g. IMPI or IMSI). | + +#### 6.2.6.2.51 Type: ScscfSelectionAssistanceInformation + +**Table 6.2.6.2.51-1: Definition of type ScscfSelectionAssistanceInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| scscfCapabilityList | ScscfCapabilityList | C | 0..1 | Information about mandatory and optional S-CSCF capabilities.
Shall be present if scscfNames is absent; may be present otherwise. | +| scscfNames | array(string) | C | 1..N | a list of S-CSCF names the UE can be steered to. Each strings shall contain a SIP-URL as defined in IETF RFC 3261 [22] to identify a SIP server (S-CSCF)
Shall be present if scscfCapabilityList is absent; may be present otherwise. | + +#### 6.2.6.2.52 Type: ChargingInfo + +**Table 6.2.6.2.52-1: Definition of type ChargingInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------------------|------------------|---|-------------|--------------------| +| primaryEventChargingFunctionName | DiameterIdentity | C | 0..1 | See 3GPP TS 29.328 | +| secondaryEventChargingFunctionName | DiameterIdentity | O | 0..1 | See 3GPP TS 29.328 | +| primaryChargingCollectionFunctionName | DiameterIdentity | C | 0..1 | See 3GPP TS 29.328 | +| secondaryChargingCollectionFunctionName | DiameterIdentity | O | 0..1 | See 3GPP TS 29.328 | + +NOTE: At least primaryEventChargingFunctionName or primaryChargingCollectionFunctionName shall be present + +#### 6.2.6.2.53 Type: RepositoryDataList + +**Table 6.2.6.2.53-1: Definition of type RepositoryDataList** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|---------------------|---|-------------|------------------------------------------------------------------------------------------| +| repositoryDataMap | map(RepositoryData) | M | 1..N | A map (list of key-value pairs where ServiceIndication serves as key) of RepositoryData. | + +#### 6.2.6.2.54 Type: CoreNetworkServiceAuthorization + +**Table 6.2.6.2.54-1: Definition of type CoreNetworkServiceAuthorization** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|-----------|---|-------------|-----------------------------| +| subscribedMediaProfileId | integer | O | 0..1 | Subscribed Media Profile ID | + +### 6.2.6.3 Simple data types and enumerations + +#### 6.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +**Table 6.2.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Capability | integer | S-CSCF capability | +| SequenceNumber | integer | Unsigned integer containing the sequence number associated to the current version of Repository Data | +| ServiceIndication | string | String containing the Service Indication or Service Identifier | +| Msisdn | string | String containing an additional or basic MSISDN
Pattern: "[0-9]{5,15}\$" | +| PrivateId | string | String containing a Private User Identity or a Private Service Identity. | +| ImsPublicId | string | String containing an IMS Public Identity in SIP URI format or TEL URI format, as specified 3GPP TS 23.003 [13]
Pattern: "^(sip:\{[a-zA-Z0-9_\-\.!~*()&=+\$;,?:V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,})tel:\{[0-9]{5,15}\})\$" | +| NameSpacePriority | string | String containing the namespace and priority. It shall be formatted as "r-value" parameter described in IETF RFC 4412 [19]. See also 3GPP TS 24.229 [18].
Pattern: "[0-9a-zA-Z-!%]* \+\`~\]+\.[0-9a-zA-Z-!%]* \+\`~\]+\-\$" | +| CscfFilterSetId | integer | Contains the identifier of a specific filter set in the S-CSCF.
Minimum=0 | +| SptGroupId | integer | Contains the identifier of the Group of SPTs.
Minimum=0 | +| SharedDataId | string | Identifies globally and uniquely a piece of subscription data shared by multiple UEs. The value shall start with the HPLMN id (MCC/MNC) followed by a hyphen followed by a local Id as allocated by the home network operator.
Pattern: "[0-9]{5,6}\-\-\.+" | +| PrePaging | boolean | Indicates the support of pre-paging. | +| SipServerName | string | Server Name (e.g. AS name, CSCF name) in SIP URI format
Pattern: "^(sip:\{[a-zA-Z0-9_\-\.!~*()&=+\$;,?:V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,})\$" | + +### 6.2.6.3.3 Enumeration: DataSetName + +The enumeration DataSetName represents a Set of Data within the IMS User Profile. It shall comply with the provisions defined in table 6.2.6.3.3-1. + +**Table 6.2.6.3.3-1: Enumeration DataSetName** + +| Enumeration value | Description | +|-------------------|-------------------------------------| +| "CHARGING_DATA" | Charging Information Data | +| "IFC_DATA" | Initial Filter Criteria Data | +| "TRACE_DATA" | IMS service level trace information | +| "PRIORITY_DATA" | Service Priority Levels | + +### 6.2.6.3.4 Enumeration: IdentityType + +The enumeration IdentityType represents the type of IMS Public Identity. It shall comply with the provisions defined in table 6.2.6.3.4-1. + +**Table 6.2.6.3.4-1: Enumeration IdentityType** + +| Enumeration value | Description | +|-------------------|-----------------------------------------------------------| +| "DISTINCT_IMPU" | The identity is an IMS Public User Identity | +| "DISTINCT_PSI" | The identity is an IMS Public Service Identity | +| "WILDCARDED_IMPU" | The identity is an IMS Wildcarded Public User Identity | +| "WILDCARDED_PSI" | The identity is an IMS Wildcarded Public Service Identity | + +#### 6.2.6.3.5 Enumeration: ImsRegistrationState + +The enumeration ImsRegistrationState represents the IMS status of the user or Public Identity or the IRS. It shall comply with the provisions defined in table 6.2.6.3.5-1 + +**Table 6.2.6.3.5-1: Enumeration ImsRegistrationState** + +| Enumeration value | Description | +|-----------------------------|---------------------------------------------------------------------------------------------------------------| +| "REGISTERED" | The identity is explicitly registered by the user. | +| "NOT_REGISTERED" | The identity is not registered. | +| "AUTHENTICATION_PENDING" | The identity initiated a registration and its authentication is ongoing (authentication pending flag is set). | +| "REGISTERED_UNREG_SERVICES" | The identity is not registered but has an S-CSCF assigned. | +| NOTE: | See clause 3.1 for more details on the IMS registration states and terms. | + +#### 6.2.6.3.6 Enumeration: TypeOfCondition + +The enumeration TypeOfCondition represents the type of condition to be applied to the logical expression of SPT groups and SPTs. See 3GPP TS 29.228 [20], Annex C. + +**Table 6.2.6.3.6-1: Enumeration TypeOfCondition** + +| Enumeration value | Description | Applicability | +|-------------------|------------------|---------------| +| "CNF" | Conjunctive form | | +| "DNF" | Disjunctive form | | + +#### 6.2.6.3.7 Enumeration: RegistrationType + +The enumeration RegistrationType represents the type of registration associated to the REGISTER request. + +**Table 6.2.6.3.7-1: Enumeration RegistrationType** + +| Enumeration value | Description | Applicability | +|------------------------|---------------------------------------------------|---------------| +| "INITIAL_REGISTRATION" | The request is related to an initial registration | | +| "RE_REGISTRATION" | The request is related to a re-registration | | +| "DE_REGISTRATION" | The request is related to a de-registration | | + +#### 6.2.6.3.8 Enumeration: RequestDirection + +The enumeration RequestDirection represents the direction of the request in combination with the registration status of the user as evaluated in the S-CSCF. + +**Table 6.2.6.3.8-1: Enumeration RequestDirection** + +| Enumeration value | Description | Applicability | +|----------------------------|--------------------------------------------------------------------------------------------------------------------------------|---------------| +| "ORIGINATING_REGISTERED" | The request is originated by an explicitly registered user. | | +| "ORIGINATING_UNREGISTERED" | The request is originated by a non-registered user. | | +| "ORIGINATING_CDIV " | The REGISTER request is related to an originating request after call diversion service (regardless of the registration state). | | +| "TERMINATING_REGISTERED" | The request is targeted to an explicitly registered user. | | +| "TERMINATING_UNREGISTERED" | The request is targeted to a non-registered user. | | + +#### 6.2.6.3.9 Enumeration: ServiceInformation + +The enumeration ServiceInformation indicates the type of additional information to be included in the body of the SIP request towards the Application Server. + +**Table 6.2.6.3.9-1: Enumeration ServiceInformation** + +| Enumeration value | Description | Applicability | +|----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| "INCLUDE_REGISTER_REQUEST" | Indicates to the S-CSCF that the incoming SIP REGISTER request is to be transferred to the Application Server. | | +| "INCLUDE_REGISTER_RESPONSE" | Indicates to the S-CSCF that the final SIP response to the incoming SIP REGISTER request is to be transferred to the Application Server. | | +| NOTE: See 3GPP TS 23.218 [43] for the use of this information. | | | + +#### 6.2.6.3.10 Enumeration: RequestedNode + +The enumeration RequestedNode represents serving node requested. It shall comply with the provisions defined in table 6.2.6.3.10-1. + +**Table 6.2.6.3.10-1: Enumeration RequestedNode** + +| Enumeration value | Description | Applicability | +|------------------------|--------------------------------------------|---------------| +| "SGSN" | The requested node is SGSN. | | +| "MME" | The requested node is MME. | | +| "AMF" | The requested node is AMF. | | +| "3GPP_AAA_SERVER_TWAN" | The requested node is 3GPP-AAA-SERVER-TWAN | | + +#### 6.2.6.3.11 Enumeration: SrvccCapability + +The enumeration SrvccCapability represents the type of UE support for SRVCC. It shall comply with the provisions defined in table 6.2.6.3.11-1. + +**Table 6.2.6.3.11-1: Enumeration IdentityType** + +| Enumeration value | Description | +|-----------------------|------------------------| +| "UE_4G_SRVCC_CAPABLE" | UE is 4G SRVCC capable | +| "UE_5G_SRVCC_CAPABLE" | UE is 5G SRVCC capable | + +#### 6.2.6.3.12 Enumeration: ActivationState + +The enumeration ActivationState represents the activation state of a PSI or DSAI tag. It shall comply with the provisions defined in table 6.2.6.3.12-1. + +**Table 6.2.6.3.12-1: Enumeration ActivationState** + +| Enumeration value | Description | +|-------------------|-------------| +| "ACTIVE" | | +| "INACTIVE" | | + +#### 6.2.6.3.13 Enumeration: ImsVoiceOverPsSessionSupport + +The enumeration ImsVoiceOverPsSessionSupport represents the support for Voice over PS associated to the UE. + +**Table 6.2.6.3.13-1: Enumeration ImsVoiceOverPsSessionSupport** + +| Enumeration value | Description | Applicability | +|-------------------------------------|---------------------------------------------|---------------| +| "IMS VOICE OVER PS NOT_SUPPORTED" | Voice over PS is supported for the UE | | +| "IMS VOICE OVER PS_SUPPORTED" | Voice over PS is not supported for the UE | | +| "IMS_VOICE_OVER_PS_SUPPORT_UNKNOWN" | Voice over PS support for the UE is unknown | | + +#### 6.2.6.3.14 Enumeration: AccessType + +The enumeration AccessType represents the type of access. It shall comply with the provisions defined in table 6.2.6.3.14-1. + +**Table 6.2.6.3.14-1: Enumeration AccessType** + +| Enumeration value | Description | Applicability | +|-------------------|-------------|---------------| +| "3GPP_ACCESS" | | | +| "NON_3GPP_ACCESS" | | | + +#### 6.2.6.3.15 Enumeration: UserStatePs + +The enumeration UserStatePs represents the user state in PS domain. + +**Table 6.2.6.3.15-1: Enumeration ImsVoiceOverPsSessionSupport** + +| Enumeration value | Description | Applicability | +|----------------------------------------------------------------------------------------------------|-------------|---------------| +| "DETACHED" | | | +| "ATTACHED_NOT_REACHABLE_FOR_PAGING" | | | +| "ATTACHED_REACHABLE_FOR_PAGING" | | | +| "CONNECTED_NOT_REACHABLE_FOR_PAGING" | | | +| "CONNECTED_REACHABLE_FOR_PAGING" | | | +| "NOT_PROVIDED_FROM_SGSN_OR_MME_OR_AMF" | | | +| "NETWORK_DETERMINED_NOT_REACHABLE" | | | +| NOTE: See 3GPP TS 29.272 [32] for PS/EPS User State and 3GPP TS 29.518 [33] for the 5GS User State | | | + +#### 6.2.6.3.16 Enumeration: UserStateCs + +The enumeration UserStateCs represents the user state in CS domain. + +**Table 6.2.6.3.16-1: Enumeration ImsVoiceOverPsSessionSupport** + +| Enumeration value | Description | Applicability | +|-------------------------------------------------------|-------------|---------------| +| "CAMEL_BUSY" | | | +| "NETWORK_DETERMINED_NOT_REACHABLE" | | | +| "ASSUMED_IDLE" | | | +| "NOT_PROVIDED_FROM_VLR" | | | +| NOTE: See 3GPP TS 23.078 [31] for CS Subscriber State | | | + +### 6.2.6.3.17 Enumeration: PrivateIdentityType + +The enumeration PrivateIdentityType represents the type of IMS Private Identity. It shall comply with the provisions defined in table 6.2.6.3.17-1. + +**Table 6.2.6.3.17-1: Enumeration PrivateIdentityType** + +| Enumeration value | Description | +|-------------------|-----------------------------------------------| +| "IMPI" | The identity is an IMS Private User Identity. | +| "IMSI" | The identity is an IMSI. | + +## 6.2.7 Error Handling + +### 6.2.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +### 6.2.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.2.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nhss\_imsSDM service. The following application errors listed in Table 6.2.7.3-1 are specific for the Nhss\_imsSDM service. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN | +| SERVICE_NOT_FOUND | 404 Not Found | The service (PSI) does not exist in the HPLMN | +| DATA_NOT_FOUND | 404 Not Found | The requested data is not found/does not exist. Additional information (if any) about this application error is indicated for each specific resource. | +| CONTEXT_NOT_FOUND | 404 Not Found | It is used during the modification of an existing subscription when no corresponding context exists. | +| OPERATION_NOT_ALLOWED | 403 Forbidden | The requested data is not allowed to be accessed by the service consumer, e.g. the IMS-AS does not have permissions for the requested resource and/or HTTP method. | +| OUT_OF_SYNC | 409 Conflict | The request could not be completed due to a conflict with the current state of the target resource (wrong version or sequence number) | +| TOO_MUCH_DATA | 413 Content Too Large | The request could not be completed due to large amount of data (e.g. size of repository data is too large). This response may be due to constraints applied by the service producer, e.g. based on local policy. | + +## 6.2.8 Feature negotiation + +The optional features in table 6.2.8-1 are defined for the Nhss\_imsSDM API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | SharedData | When receiving a Nhss_ismSDM_Get service operation request to retrieve a UE's IMS profile data, and the request does not contain a supported-features query parameter indicating support of this feature, the HSS shall not include Shared Data Ids in the response. Instead the HSS may – based on operator policy – take no further action (i.e. allow the UE to get services based on only the UE's individual IMS profile data), or send the shared data as individual data (this may result in notifications of individual subscription data change – if so subscribed – when shared data, which are sent as individual data, are modified, and/or when the UE's Shared Data IDs are modified). | +| 2 | PatchReport | If some of the modifications included in the PATCH request are not successfully implemented, the HSS reports the result of PATCH request execution to the consumer. See clause 5.2.7.2 of 3GPP TS 29.500 [4]. | + +## 6.2.9 Security + +As indicated in 3GPP TS 33.501 [5], the access to the Nhss\_imsSDM API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [35]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [36]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_imsSDM API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [36], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nhss\_imsSDM service. + +The Nhss\_imsSDM API defines the following scopes for OAuth2 authorization: + +**Table 6.2.9-1: Oauth2 scopes defined in Nhss\_imsSDM API** + +| Scope | Description | +|--------------------------------------------------------|---------------------------------------------------------------------------| +| "nhss-ims-sdm" | Access to the Nhss IMS Subscription Data Management API | +| "nhss-ims-sdm:registration-status:read" | Access to read the Registration Status resource | +| "nhss-ims-sdm:profile-data:read" | Access to read the Profile Data resource | +| "nhss-ims-sdm:priority-levels:read" | Access to read the Priority Levels resource | +| "nhss-ims-sdm:ifcs:read" | Access to read the Initial Filter Criteria resource | +| "nhss-ims-sdm:service-level-trace-information:read" | Access to read the Service Level Trace Information resource | +| "nhss-ims-sdm:server-name:read" | Access to read the Server Name resource | +| "nhss-ims-sdm:scscf-capabilities:read" | Access to read the S-CSCF Capabilities resource | +| "nhss-ims-sdm:ps-domain:location-data:read" | Access to read the PS-Domain Location Data resource | +| "nhss-ims-sdm:ps-domain:ip-address:read" | Access to read the PS-Domain IP Address resource | +| "nhss-ims-sdm:ps-domain:tads-info:read" | Access to read the PS-Domain TADS Info resource | +| "nhss-ims-sdm:ps-domain:ue-reach-subscriptions:create" | Access to create PS-Domain UE Reachability Subscriptions resources | +| "nhss-ims-sdm:ps-domain:ue-reach-subscriptions:modify" | Access to update/delete a PS-Domain UE Reachability Subscription resource | +| "nhss-ims-sdm:ps-domain:user-state:read" | Access to read the PS-Domain User State resource | +| "nhss-ims-sdm:cs-domain:location-data:read" | Access to read the CS-Domain Location Data resource | +| "nhss-ims-sdm:cs-domain:user-state:read" | Access to read the CS-Domain User State resource | +| "nhss-ims-sdm:cs-domain:csrn:read" | Access to read the CS-Domain CSRN resource | +| "nshh-ims-sdm:wireline-domain:reference-location:read" | Access to read the Wireline-Domain Reference Location resource | +| "nhss-ims-sdm:repository-data:modify" | Access to create/update/delete the Repository Data resource | +| "nhss-ims-sdm:repository-data:read" | Access to read the Repository Data resource | +| "nhss-ims-sdm:identities:read" | Access to read the Identities resource | +| "nhss-ims-sdm:srvcc:read" | Access to read the SRVCC resource | +| "nhss-ims-sdm:srvcc:modify" | Access to update the SRVCC resource | +| "nhss-ims-sdm:psi-status:read" | Access to read the PSI Status resource | +| "nhss-ims-sdm:psi-status:modify" | Access to update the PSI Status resource | +| "nhss-ims-sdm:dsai:read" | Access to read the DSAI resource | +| "nhss-ims-sdm:dsai:modify" | Access to update the DSAI resource | +| "nhss-ims-sdm:sms-registration-info:read" | Access to read the SMS Registration Info resource | +| "nhss-ims-sdm:sms-registration-info:modify" | Access to create/update/delete the SMS Registration Info resource | +| "nhss-ims-sdm:subscriptions:create" | Access to create Subscriptions resources | +| "nhss-ims-sdm:subscription:modify" | Access to update/delete a Subscription resource | +| "nhss-ims-sdm:shared-subscriptions:create" | Access to create a Shared-Data Subscriptions resource | +| "nhss-ims-sdm:shared-subscriptions:modify" | Access to update/delete a Shared-Data Subscription resource | +| "nhss-ims-sdm:shared-subscriptions:read" | Access to read the Shared-Data resource | +| "nhss-ims-sdm:charging-info:read" | Access to read the Charging-Information resource | + +## 6.2.10 HTTP redirection + +An HTTP request may be redirected to a different HSS service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different HSS producer instance will return the NF Instance ID of the new HSS producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an HSS redirects a service request to a different HSS using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new HSS towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.3 Nhss\_imsUEAuthentication Service API + +### 6.3.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}/{apiName}/{apiVersion}/ + +where "apiRoot" is defined in clause 4.4.1 of 3GPP TS 29.501 [5], the "apiName" shall be set to "nhss-ims-ueau" and the "apiVersion" shall be set to "v1" for the current version of this specification. + +### 6.3.2 Usage of HTTP + +#### 6.3.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nhss\_imsUEAU service shall comply with the OpenAPI [9] specification contained in Annex A.3. + +#### 6.3.2.2 HTTP standard headers + +##### 6.3.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.3.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [10], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 9457 [11]) signalled by the content type "application/problem+json" +- JSON Patch, as defined in IETF RFC 6902 [12], signalled by the content type "application/json-patch+json" + +#### 6.3.2.3 HTTP custom headers + +##### 6.3.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.3.3 Resources + +### 6.3.3.1 Overview + +![Figure 6.3.3.1-1: Resource URI structure of the Nhss_imSUEAU API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nhss-ims-ueau/v1. It branches to /{impi}, which further branches to /security-information.](9af97997b7d3fbca90b8ddba0ea39c6c_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nhss-ims-ueau/v1"] --> Impi["/{impi}"] + Impi --> SecurityInformation["/security-information"] + +``` + +Figure 6.3.3.1-1: Resource URI structure of the Nhss\_imSUEAU API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nhss-ims-ueau/v1. It branches to /{impi}, which further branches to /security-information. + +**Figure 6.3.3.1-1: Resource URI structure of the Nhss\_imSUEAU API** + +Table 6.3.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.3.3.1-1: Resources and methods overview** + +| Resource name (Archetype) | Resource URI | HTTP method or custom operation | Description | +|----------------------------------------|---------------------------------------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SecurityInformation (Custom operation) | /{impi}/security-information/
generate-sip-auth-data | generate-sip-auth-data (POST) | The HSS takes the variable {impi} and, if applicable, fetches the corresponding SUPI. The HSS calculates a fresh authentication vector based on the received information and the stored security information, if IMS-AKA is selected. Otherwise, the HSS provides the corresponding authentication information. | + +### 6.3.3.2 Resource: SecurityInformation + +#### 6.3.3.2.1 Description + +This resource represents the information that is needed together with the SIP authentication scheme to calculate a fresh authentication vector. + +#### 6.3.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-ueau/v1/{impi}/security-information + +This resource shall support the resource URI variables defined in table 6.3.3.2.2-1. + +**Table 6.3.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|--------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.3.1 | +| impi | Represents the IMS Private Identity (see 3GPP TS 23.003 [13] clause 13.3.
Pattern: "^(impi-\.+\+\.+\+)\$" | + +### 6.3.3.2.3 Resource Standard Methods + +No Standard Methods are supported for this resource. + +### 6.3.3.2.4 Resource Custom Operations + +#### 6.3.3.2.4.1 Overview + +**Table 6.3.3.2.4.1-1: Custom operations** + +| Custom operation URI | Mapped HTTP method | Description | +|-------------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------| +| /generate-sip-auth-data | POST | Select the authentication method and calculate a fresh AV if IMS-AKA is selected or provides corresponding authentication information. | + +#### 6.3.3.2.4.2 Operation: generate-sip-auth-data + +##### 6.3.3.2.4.2.1 Description + +This custom operation is used by the NF service consumer (S-CSCF) to request authentication information data for the IMPI from the HSS. The HSS calculates an authentication vector taking into account the information received from the NF service consumer (S-CSCF) and the current representation of this resource if IMS AKA is selected. For details see 3GPP TS 33.203 [14]. + +##### 6.3.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.3.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.3.3.2.4.2.2-2. + +**Table 6.3.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------| +| SipAuthenticationInfoRequest | M | 1 | Contains the SIP Authentication Scheme, the number of authentication items and Resynchronization Information | + +**Table 6.3.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| SipAuthenticationInfoResult | M | 1 | 200 OK | Upon success, a response body containing the selected authentication method and an authentication vector if IMS AKA has been selected shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AUTHENTICATION_REJECTED
- UNSUPPORTED_SIP_AUTH_SCHEME | + +**Table 6.3.3.2.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.3.3.2.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.3.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nhss\_imsUEAuthentication Service. + +## 6.3.5 Notifications + +In this release of this specification, no notifications are defined for the Nhss\_imsUEAuthentication Service. + +## 6.3.6 Data Model + +### 6.3.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.3.6.1-1 specifies the structured data types defined for the Nhss\_imsUEAU service API. + +**Table 6.3.6.1-1: Nhss\_imsUEAU specific Data Types** + +| Data type | Clause defined | Description | +|------------------------------|----------------|--------------------------------------------------------------------------------------------| +| SipAuthenticationInfoRequest | 6.3.6.2.2 | Contains SIP Authentication Schema, Authentication Items and Resynchronization Information | +| SipAuthenticationInfoResult | 6.3.6.2.3 | Contains authentication information (e.g. authentication vectors, line id) | +| ResynchronizationInfo | 6.3.6.2.4 | Contains RAND and AUTS | +| 3GAkaAv | 6.3.6.2.5 | Contains RAND, XRES, AUTN, CK, and IK | + +Table 6.3.6.1-2 specifies data types re-used by the Nhss\_imsUEAU service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nhss\_imsUEAU. + +**Table 6.3.6.1-2: Nhss\_imsUEAU re-used Data Types** + +| Data type | Reference | Comments | +|--------------------|---------------------|---------------------------------------------------------------------------| +| ProblemDetails | 3GPP TS 29.571 [16] | Response body of error response messages. | +| RedirectResponse | 3GPP TS 29.571 [16] | Response body of redirect response messages. | +| IpAddr | 3GPP TS 29.571 [16] | IP Address (either IPv4 address, IPv6 address or IPv6 prefix) | +| Autn | 3GPP TS 29.503 [15] | AUTN component of the Authentication Vector | +| Auts | 3GPP TS 29.503 [15] | AUTS component of the Resynchronization Info | +| Rand | 3GPP TS 29.503 [15] | RAND component of the Authentication Vector or the Resynchronization Info | +| Xres | 3GPP TS 29.503 [15] | XRES component of the Authentication Vector | +| ConfidentialityKey | 3GPP TS 29.503 [15] | CK component of the Authentication Vector | +| IntegrityKey | 3GPP TS 29.503 [15] | IK component of the Authentication Vector | + +### 6.3.6.2 Structured data types + +#### 6.3.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +#### 6.3.6.2.2 Type: SipAuthenticationInfoRequest + +**Table 6.3.6.2.3-1: Definition of type AuthenticationInfoRequest** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|-------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| cscfServerName | string | M | 1 | S-CSCF name in SIP URI format | +| sipAuthenticationScheme | SipAuthenticationScheme | M | 1 | SIP Authentication Scheme requested by service consumer (S-CSCF) | +| sipNumberAuthItems | SipNumberAuthItems | O | 0..1 | Number of authentication items (AVs). Absence indicates that only one AV is requested. This attribute shall be absent for authentication schemes other than IMS AKA. | +| resynchronizationInfo | ResynchronizationInfo | O | 0..1 | Contains RAND and AUTS; see 3GPP TS 33.203 [14]. This attribute shall be included only if a resynchronization procedure needs to be triggered. This attribute shall be absent for authentication schemes other than IMS AKA. | + +#### 6.3.6.2.3 Type: SipAuthenticationInfoResult + +**Table 6.3.6.2.3-1: Definition of type AuthenticationInfoResult** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------| +| sipAuthenticationScheme | SipAuthenticationScheme | M | 1 | SIP Authentication Scheme used by service producer (HSS) | +| 3gAkaAvs | array(3GAkaAv) | O | 1..N | If IMS AKA is requested, it shall be present and will contain Authentication Vectors. | +| digestAuth | DigestAuthentication | O | 0..1 | If SIP Digest is used, it shall be present and shall contain the digest realm, algorithm, QoP and HA1. | +| lineIdentifierList | array(LineIdentifier) | O | 0..N | If NBA is used, it shall be present and shall contain a list of fixed broadband access line identifiers associated to the user. | +| ipAddress | IpAddr | O | 0..1 | If GIBA is used, it shall be present and shall contain an IP address (IPv4, or IPv6, or IPv6 prefix) | + +#### 6.3.6.2.4 Type: ResynchronizationInfo + +**Table 6.3.6.2.4-1: Definition of type ResynchronizationInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------| +| rand | Rand | M | 1 | | +| auts | Auts | M | 1 | | + +#### 6.3.6.2.5 Type: 3GAkaAv + +**Table 6.3.6.2.5-1: Definition of type 3gAkaAv** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------------|---|-------------|---------------------------------------------| +| rand | Rand | M | 1 | RAND component of the Authentication Vector | +| xres | Xres | M | 1 | XRES component of the Authentication Vector | +| autn | Autn | M | 1 | AUTN component of the Authentication Vector | +| ck | ConfidentialityKey | M | 1 | CK component of the Authentication Vector | +| ik | IntegrityKey | M | 1 | IK component of the Authentication Vector | + +#### 6.3.6.2.6 Type: DigestAuthentication + +**Table 6.3.6.2.6-1: Definition of type DigestAuthentication** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|--------------------|---|-------------|------------------------------------------------| +| digestRealm | string | M | 1 | Digest realm. See IETF RFC 4740 [17]. | +| digestAlgorithm | SipDigestAlgorithm | M | 1 | Digest Algorithm. See IETF RFC 4740 [17]. | +| digestQop | SipDigestQop | M | 1 | Quality of Protection. See IETF RFC 4740 [17]. | +| ha1 | string | M | 1 | Hash H(A1). See IETF RFC 4740 [17]. | + +#### 6.3.6.2.7 Void + +### 6.3.6.3 Simple data types and enumerations + +#### 6.3.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 6.3.6.3.2 Simple data types + +The simple data types defined in table 6.3.6.3.2-1 shall be supported. + +**Table 6.3.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|--------------------|-----------------|----------------------------------------------| +| SipNumberAuthItems | integer | Number of authentication items
Minimum: 1 | +| Impi | string | IMS Private User Identity | +| LineIdentifier | string | Line Identifier for the wireline access | + +#### 6.3.6.3.3 Enumeration: SipAuthenticationScheme + +The enumeration SipAuthenticationScheme represents an IMS authentication scheme. It shall comply with the provisions defined in table 6.3.6.3.3-1. + +**Table 6.3.6.3.3-1: Enumeration SipAuthenticationScheme** + +| Enumeration value | Description | +|--------------------|---------------------------------------------------------------------| +| "DIGEST-AKAV1-MD5" | IMS-AKA authentication scheme | +| "DIGEST-HTTP" | SIP Digest authentication scheme | +| "NBA" | NASS Bundled authentication scheme | +| "GIBA" | GPRS-IMS-Bundled authentication scheme | +| "UNKNOWN" | Authentication scheme to be used is unknown by the service consumer | + +#### 6.3.6.3.4 Enumeration: SipDigestAlgorithm + +The enumeration SipDigestAlgorithm represents the algorithm for SIP Digest scheme. It shall comply with the provisions defined in table 6.3.6.3.4-1. + +**Table 6.3.6.3.4-1: Enumeration SipDigestAlgorithm** + +| Enumeration value | Description | +|-------------------|-------------| +| "MD5" | | +| "MD5_SESS" | | + +#### 6.3.6.3.5 Enumeration: SipDigestQop + +The enumeration SipDigestQop represents the quality of protection for SIP Digest scheme. It shall comply with the provisions defined in table 6.3.6.3.5-1. + +**Table 6.3.6.3.5-1: Enumeration SipDigestQop** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------| +| "AUTH" | Indicates authentication | +| "AUTH_INT" | Indicates authentication with integrity protection | + +### 6.3.7 Error Handling + +#### 6.3.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.3.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.3.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nhss\_imsUEAuthentication service. The following application errors listed in Table 6.3.7.3-1 are specific for the Nhss\_imsUEAuthentication service. + +**Table 6.3.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------------------|---------------------|------------------------------------------------------------------| +| AUTHENTICATION_REJECTED | 403 Forbidden | The user cannot be authenticated with this authentication method | +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN | +| UNSUPPORTED_SIP_AUTHENTICATION_SCHEME | 501 Not implemented | The received SIP authentication scheme is not supported by HPLMN | + +### 6.3.8 Feature Negotiation + +### 6.3.9 Security + +As indicated in 3GPP TS 33.501 [5], the access to the Nhss\_imsUEAU API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [35]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [36]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_imsUEAU API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [36], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nhss\_imsUEAU service. + +The Nhss\_imsUEAU API defines the following scopes for OAuth2 authorization: + +**Table 6.3.9-1: OAuth2 scopes defined in Nhss\_imsUEAU API** + +| Scope | Description | +|-----------------------------------------------|-----------------------------------------------------------| +| "nhss-ims-ueau" | Access to the Nhss IMS UE Context Management API | +| "nhss-ims-ueau:generate-sip-auth-data:invoke" | Access to invoke the Generate SIP Auth Data custom method | + +### 6.3.10 HTTP redirection + +An HTTP request may be redirected to a different HSS service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different HSS producer instance will return the NF Instance ID of the new HSS producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an HSS redirects a service request to a different HSS using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new HSS towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.4 Nhss\_gbaSubscriberDataManagement Service API + +### 6.4.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}/{apiName}/{apiVersion} + +where "apiRoot" is defined in clause 4.4.1 of 3GPP TS 29.501 [5], the "apiName" shall be set to "nhss-gba-sdm" and the "apiVersion" shall be set to "v1" for the current version of this specification. + +### 6.4.2 Usage of HTTP + +#### 6.4.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nhss\_gbaSubscriberDataManagement service shall comply with the OpenAPI [9] specification contained in Annex A.5. + +#### 6.4.2.2 HTTP standard headers + +##### 6.4.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.4.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [10], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 9457 [11]) signalled by the content type "application/problem+json" +- JSON Patch, as defined in IETF RFC 6902 [12], signalled by the content type "application/json-patch+json" + +#### 6.4.2.3 HTTP custom headers + +##### 6.4.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.4.3 Resources + +#### 6.4.3.1 Overview + +![Figure 6.4.3.1-1: Resource URI structure of the Nhss_gbaSDM API. The diagram shows a hierarchical tree structure starting from {apiRoot}/nhss-gba-sdm/v1. A vertical line descends from the root to a box containing /{ueId}. From this box, a horizontal line extends to the right, with two vertical branches leading to boxes containing /gba-subscriber-data and /subscriptions. From the /subscriptions box, another vertical line descends to a box containing /{subscriptionId}.](92171b3c1fa1c46db587486e1a4a260f_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nhss-gba-sdm/v1"] --> ueId["/{ueId}"] + ueId --> gbaData["/gba-subscriber-data"] + ueId --> subscriptions["/subscriptions"] + subscriptions --> subscriptionId["/{subscriptionId}"] + +``` + +Figure 6.4.3.1-1: Resource URI structure of the Nhss\_gbaSDM API. The diagram shows a hierarchical tree structure starting from {apiRoot}/nhss-gba-sdm/v1. A vertical line descends from the root to a box containing /{ueId}. From this box, a horizontal line extends to the right, with two vertical branches leading to boxes containing /gba-subscriber-data and /subscriptions. From the /subscriptions box, another vertical line descends to a box containing /{subscriptionId}. + +**Figure 6.4.3.1-1: Resource URI structure of the Nhss\_gbaSDM API** + +Table 6.4.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.4.3.1-1: Resources and methods overview** + +| Resource name (Archetype) | Resource URI | HTTP method or custom operation | Description | +|--------------------------------------------|----------------------------------------|---------------------------------|-------------| +| GBA Subscriber Data (Document) | /{ueId}/gba-subscriber-data | GET | | +| GBA SDM Subscriptions (Collection) | /{ueId}/subscriptions | POST | | +| GBA SDM Individual Subscription (Document) | /{ueId}/subscriptions/{subscriptionId} | PATCH | | +| | | DELETE | | + +## 6.4.3.2 Resource: GBA Subscriber Data + +### 6.4.3.2.1 Description + +This resource represents the subscriber data of the UE for GBA, including the GBA User Security Settings (GUSS). + +### 6.4.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nhss-gba-sdm/v1/{ueId}/gba-subscriber-data + +This resource shall support the resource URI variables defined in table 6.4.3.2.2-1. + +**Table 6.4.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------| +| apiRoot | See clause 6.4.1 | +| ueId | Represents the UE Identity. See clause 6.4.6.3.2. | + +### 6.4.3.2.3 Resource Standard Methods + +#### 6.4.3.2.3.1 GET + +This method shall support the URI query parameters specified in table 6.4.3.2.3.1-1. + +**Table 6.4.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.4.3.2.3.1-2 and the response data structures and response codes specified in table 6.4.3.2.3.1-3. + +**Table 6.4.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.4.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------| +| GbaSubscriberData | M | 1 | 200 OK | A response body containing the GBA subscriber data of the UE; it includes the GBA User Security Settings (GUSS) data. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- OPERATION_NOT_ALLOWED | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | + +**Table 6.4.3.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.4.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.4.3.3 Resource: Subscriptions + +#### 6.4.3.3.1 Description + +This resource is used to represent subscriptions to notifications of data change. + +#### 6.4.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nhss-gba-sdm/{apiVersion}/{ueId}/subscriptions + +This resource shall support the resource URI variables defined in table 6.4.3.3.2-1. + +**Table 6.4.3.3.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------| +| apiRoot | See clause 6.4.1 | +| apiVersion | See clause 6.4.1 | +| ueId | Represents the UE Identity. See clause 6.4.6.3.2. | + +### 6.4.3.3.3 Resource Standard Methods + +#### 6.4.3.3.3.1 POST + +This method shall support the URI query parameters specified in table 6.4.3.3.3.1-1. + +**Table 6.4.3.3.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.4.3.3.3.1-2 and the response data structures and response codes specified in table 6.4.3.3.3.1-3. + +**Table 6.4.3.3.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-----------------------------------------| +| GbaSdmSubscription | M | 1 | The subscription that is to be created. | + +**Table 6.4.3.3.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| GbaSdmSubscription | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate the following application error:
- UNSUPPORTED_RESOURCE_URI

This response shall not be cached. | + +**Table 6.4.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.4.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.4.3.3.3.1-6: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nhss-gba-sdm///subscriptions/ | + +### 6.4.3.4 Resource: Individual subscription + +#### 6.4.3.4.1 Description + +This resource is used to represent an individual subscription to notifications of data change. + +#### 6.4.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nhss-gba-sdm/{apiVersion}/{ueId}/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.4.3.4.2-1. + +**Table 6.4.3.4.2-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|----------------------------------------------------------------------------| +| apiRoot | See clause 6.4.1 | +| apiVersion | See clause 6.4.1 | +| ueId | Represents the UE Identity. See clause 6.4.6.3.2. | +| subscriptionId | The subscriptionId identifies an individual subscription to notifications. | + +#### 6.4.3.4.3 Resource Standard Methods + +##### 6.4.3.4.3.1 DELETE + +This method shall support the URI query parameters specified in table 6.4.3.4.3.1-1. + +**Table 6.4.3.4.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.4.3.4.3.1-2 and the response data structures and response codes specified in table 6.4.3.4.3.1-3. + +**Table 6.4.3.4.3.1-2: Data structures supported by the Delete Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.4.3.4.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +**Table 6.4.3.4.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.4.3.4.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.4.3.4.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.4.3.4.3.2-1. + +**Table 6.4.3.4.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.4.3.4.3.2-2 and the response data structures and response codes specified in table 6.4.3.4.3.2-3. + +**Table 6.4.3.4.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1 | It contains the list of changes to be made to the resource representing the individual subscription, according to the JSON PATCH format specified in IETF RFC 6902 [12]. | + +**Table 6.4.3.4.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, a response with no content is returned. (NOTE 1) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 1) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate the following application error:
- MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult. + +**Table 6.4.3.4.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.4.3.4.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.4.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nhss\_gbaSDM Service. + +## 6.4.5 Notifications + +### 6.4.5.1 General + +This clause specifies the use of notifications and corresponding protocol details. + +## 6.4.5.2 Data Change Notification + +The POST method shall be used for Data Change Notifications and the URI shall be as provided during the subscription procedure. + +Resource URI: {callbackReference} + +Support of URI query parameters is specified in table 6.4.5.2-1. + +**Table 6.4.5.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.4.5.2-2 and of response data structures and response codes is specified in table 6.4.5.2-3. + +**Table 6.4.5.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|-------------| +| ModificationNotification | M | 1 | | + +**Table 6.4.5.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- CONTEXT_NOT_FOUND

See table 6.4.7.3-1 for the description of this error. | + +**Table 6.4.5.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the notification endpoint of the subscribing NF. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.4.5.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the notification endpoint of the subscribing NF. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.4.6 Data Model + +### 6.4.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.4.6.1-1 specifies the structured data types defined for the Nhss\_gbaSDM service API. + +**Table 6.4.6.1-1: Nhss\_gbaSDM specific Data Types** + +| Data type | Clause defined | Description | +|--------------------|----------------|-------------| +| GbaSubscriberData | 6.4.6.2.2 | | +| Guss | 6.4.6.2.3 | | +| BsfInfo | 6.4.6.2.4 | | +| GbaSdmSubscription | 6.4.6.2.5 | | +| Ueld | 6.4.6.3.2 | | + +Table 6.4.6.1-2 specifies data types re-used by the Nhss\_gbaSDM service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nhss\_gbaSDM. + +**Table 6.4.6.1-2: Nhss\_gbaSDM re-used Data Types** + +| Data type | Reference | Comments | +|--------------------------|---------------------|----------------------------------------------| +| UssListItem | 3GPP TS 29.309 [42] | | +| SecFeature | 3GPP TS 29.309 [42] | | +| ModificationNotification | 3GPP TS 29.503 [15] | | +| NfInstanceId | 3GPP TS 29.571 [16] | | +| Uri | 3GPP TS 29.571 [16] | | +| DateTime | 3GPP TS 29.571 [16] | | +| DurationSec | 3GPP TS 29.571 [16] | | +| ProblemDetails | 3GPP TS 29.571 [16] | Response body of error response messages. | +| RedirectResponse | 3GPP TS 29.571 [16] | Response body of redirect response messages. | +| ImSUId | 3GPP TS 29.562 | IMS UE ID (IMPU or IMPI) | + +### 6.4.6.2 Structured data types + +#### 6.4.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +#### 6.4.6.2.2 Type: GbaSubscriberData + +**Table 6.4.6.2.2-1: Definition of type GbaSubscriberData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------| +| guss | Guss | M | 1 | | + +#### 6.4.6.2.3 Type: Guss + +**Table 6.4.6.2.3-1: Definition of type Guss** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------------|---|-------------|---------------------------| +| bsfInfo | BsfInfo | O | 0..1 | BSF-specific information. | +| ussList | array(UssListItem) | O | 1..N | | + +#### 6.4.6.2.4 Type: BsflInfo + +**Table 6.4.6.2.4-1: Definition of type BsflInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| uiccType | UiccType | O | 0..1 | It indicates whether GBA or GBA_U is to be used; default value is GBA. | +| lifeTime | DurationSec | O | 0..1 | It indicates a user-specific key lifetime (duration in seconds). If the lifeTime element is missing the default value in the BSF is used. | +| securityFeatures | array(SecFeature) | O | 1..N | It indicates a user-specific security feature list that the UE supports. If the securityFeature element is missing, then the security features are not defined. Standard security features are defined in 3GPP TS 29.309 [42], clause 6.1.6.3.5. | + +#### 6.4.6.2.5 Type: GbaSdmSubscription + +**Table 6.4.6.2.5-1: Definition of type GbaSdmSubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|---------------|---|-------------|-------------| +| nflInstanceId | NflInstanceId | M | 1 | | +| callbackReference | Uri | M | 1 | | +| monitoredResourceUris | array(Uri) | M | 1..N | | +| expires | DateTime | O | 0..1 | | + +### 6.4.6.3 Simple data types and enumerations + +#### 6.4.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 6.4.6.3.2 Simple data types + +The simple data types defined in table 6.4.6.3.2-1 shall be supported. + +**Table 6.4.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|--------------------------------------------|----------------------------------------------------------------------| +| Ueld | string | Identity of the UE. It can be an MSISDN, an IMSI an IMPI or an IMPU. | +| Msisdn | string
pattern: '^msisdn-[0-9]{5,15}\$' | MS-ISDN of the UE. | +| Imsi | string
pattern: '^imsi-[0-9]{5,15}\$' | IMSI of the UE. | + +#### 6.4.6.3.3 Enumeration: UiccType + +The enumeration UiccType represents whether GBA or GBA\_U is to be used. It shall comply with the provisions defined in table 6.4.6.3.4-1. + +**Table 6.4.6.3.4-1: Enumeration UiccType** + +| Enumeration value | Description | +|-------------------|---------------------------------------------------------------| +| "GBA" | GBA: Basic GBA case (no generation of Ks_int_NAF at the BSF). | +| "GBA_U" | GBA_U: Generation of Ks_int_NAF is required at the BSF. | + +## 6.4.7 Error Handling + +### 6.4.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +### 6.4.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.4.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nhss\_gbaSDM service. The following application errors listed in Table 6.4.7.3-1 are specific for the Nhss\_gbaSDM service. + +**Table 6.4.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN | +| CONTEXT_NOT_FOUND | 404 Not Found | The service consumer has received a notification from a service producer for a subscription that is unknown to the service consumer. | + +## 6.4.8 Feature Negotiation + +The optional features in table 6.4.8-1 are defined for the Nhss\_gbaSDM API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.4.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 6.4.9 Security + +As indicated in 3GPP TS 33.501 [5], the access to the Nhss\_gbaSDM API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [35]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [36]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_gbaSDM API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [36], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nhss\_gbaSDM service. + +The Nhss\_gbaSDM API defines the following scopes for OAuth2 authorization: + +**Table 6.4.9-1: OAuth2 scopes defined in Nhss\_gbaSDM API** + +| Scope | Description | +|-----------------------------------------|-------------------------------------------------| +| "nhss-gba-sdm" | Access to the Nhss_gbaSDM API | +| "nhss-gba-sdm:gba-subscriber-data:read" | Access to read the GBA Subscriber Data resource | + +## 6.4.10 HTTP redirection + +An HTTP request may be redirected to a different HSS service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different HSS producer instance will return the NF Instance ID of the new HSS producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an HSS redirects a service request to a different HSS using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new HSS towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# 6.5 Nhss\_gbaUEAuthentication Service API + +## 6.5.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}/{apiName}/{apiVersion} + +where "apiRoot" is defined in clause 4.4.1 of 3GPP TS 29.501 [5], the "apiName" shall be set to "nhss-gba-ueau" and the "apiVersion" shall be set to "v1" for the current version of this specification. + +## 6.5.2 Usage of HTTP + +### 6.5.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nhss\_gbaUEAuthentication service shall comply with the OpenAPI [9] specification contained in Annex A.6. + +### 6.5.2.2 HTTP standard headers + +#### 6.5.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +#### 6.5.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [10], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 9457 [11]) signalled by the content type "application/problem+json" + +### 6.5.2.3 HTTP custom headers + +#### 6.5.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.5.3 Resources + +### 6.5.3.1 Overview + +![Figure 6.5.3.1-1: Resource URI structure of the Nhss_gbaUEAU API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nhss-gba-ueau/v1. A line branches down to a box containing {/ueId}. From this box, a line branches down to a box containing /security-information. From this box, a line branches down to a dashed box containing /generate-auth-data.](5bd8085079508bb158cfc55b1007a459_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nhss-gba-ueau/v1"] --> ueId["{/ueId}"] + ueId --> security["/security-information"] + security --> authData["/generate-auth-data"] + style authData stroke-dasharray: 5 5 + +``` + +Figure 6.5.3.1-1: Resource URI structure of the Nhss\_gbaUEAU API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nhss-gba-ueau/v1. A line branches down to a box containing {/ueId}. From this box, a line branches down to a box containing /security-information. From this box, a line branches down to a dashed box containing /generate-auth-data. + +**Figure 6.5.3.1-1: Resource URI structure of the Nhss\_gbaUEAU API** + +Table 6.5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.5.3.1-1: Resources and methods overview** + +| Resource name
(Archetype) | Resource URI | HTTP
method
or
custom
operation | Description | +|-------------------------------------------|-----------------------------------------------------|---------------------------------------------|-------------| +| SecurityInformation
(Custom operation) | /{ueId}/security-information/
generate-auth-data | generate-
auth-data
(POST) | | + +### 6.5.3.2 Resource: SecurityInformation (Custom Operation) + +#### 6.5.3.2.1 Description + +This resource represents the information that is needed to calculate a fresh authentication vector for GBA. + +#### 6.5.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nhss-gba-ueau/v1/{ueId}/security-information + +This resource shall support the resource URI variables defined in table 6.5.3.2.2-1. + +**Table 6.5.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|------------------------------------------------------------------------------| +| apiRoot | See clause 6.5.1 | +| ueId | Represents the UE Identity. It can be an MSISDN, an IMSI an IMPI or an IMPU. | + +#### 6.5.3.2.3 Resource Standard Methods + +No Standard Methods are supported for this resource. + +### 6.5.3.2.3 Resource Custom Operations + +#### 6.5.3.2.4.1 Overview + +**Table 6.5.3.2.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|--------------------|----------------------|--------------------|-------------| +| generate-auth-data | /generate-auth-data | POST | | + +#### 6.5.3.2.4.2 Operation: generate-auth-data + +##### 6.5.3.2.4.2.1 Description + +This custom operation is used by the NF service consumer (BSF) to request authentication information data for the UE from the HSS. + +##### 6.5.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.5.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.5.3.2.4.2.2-2. + +**Table 6.5.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|-------------| +| AuthenticationInfo Request | M | 1 | | + +**Table 6.5.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------| +| AuthenticationInfoResult | M | 1 | 200 OK | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- OPERATION_NOT_ALLOWED | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | + +**Table 6.5.3.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.5.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.5.5 Notifications + +In this release of this specification, no notifications are defined for the Nhss\_gbaUEAuthentication Service. + +## 6.5.6 Data Model + +### 6.5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.5.6.1-1 specifies the structured data types defined for the Nhss\_gbaUEAU service API. + +**Table 6.5.6.1-1: Nhss\_gbaUEAU specific Data Types** + +| Data type | Clause defined | Description | +|---------------------------|----------------|-------------| +| AuthenticationInfoRequest | 6.5.6.2.2 | | +| AuthenticationInfoResult | 6.5.6.2.3 | | +| DigestAuthentication | 6.5.6.2.6 | | +| Impi | 6.5.6.3.2 | | +| AuthenticationScheme | 6.5.6.3.3 | | +| DigestAlgorithm | 6.5.6.3.4 | | +| DigestQop | 6.5.6.3.5 | | + +Table 6.5.6.1-2 specifies data types re-used by the Nhss\_gbaUEAU service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nhss\_gbaUEAU. + +**Table 6.5.6.1-2: Nhss\_gbaUEAU re-used Data Types** + +| Data type | Reference | Comments | +|-----------------------|---------------------|----------------------------------------------| +| Autn | 3GPP TS 29.503 [15] | | +| Auts | 3GPP TS 29.503 [15] | | +| Rand | 3GPP TS 29.503 [15] | | +| Xres | 3GPP TS 29.503 [15] | | +| ProblemDetails | 3GPP TS 29.571 [16] | Response body of error response messages. | +| RedirectResponse | 3GPP TS 29.571 [16] | Response body of redirect response messages. | +| SupportedFeatures | 3GPP TS 29.571 [16] | | +| ResynchronizationInfo | 3GPP TS 29.562 | Clause 6.3.6.2.4 | +| 3GAkaAv | 3GPP TS 29.562 | Clause 6.3.6.2.5 | +| Ueld | 3GPP TS 29.562 | Clause 6.4.6.3.2 | + +### 6.5.6.2 Structured data types + +#### 6.5.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 6.5.6.2.2 Type: AuthenticationInfoRequest + +**Table 6.5.6.2.2-1: Definition of type AuthenticationInfoRequest** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------------------|---|-------------|-------------| +| authenticationScheme | AuthenticationScheme | M | 1 | | +| resynchronizationInfo | ResynchronizationInfo | O | 0..1 | | +| supportedFeatures | SupportedFeatures | O | 0..1 | | + +## 6.5.6.2.3 Type: AuthenticationInfoResult + +**Table 6.5.6.2.3-1: Definition of type AuthenticationInfoResult** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|----------------------|---|-------------|-------------| +| impi | Impi | O | 0..1 | | +| 3gAkaAv | 3gAkaAv | O | 0..1 | | +| digestAuth | DigestAuthentication | O | 0..1 | | +| supportedFeatures | SupportedFeatures | O | 0..1 | | + +## 6.5.6.2.4 Void + +## 6.5.6.2.5 Void + +## 6.5.6.2.6 Type: DigestAuthentication + +**Table 6.5.6.2.6-1: Definition of type DigestAuthentication** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------------|---|-------------|-------------| +| digestRealm | string | M | 1 | | +| digestAlgorithm | DigestAlgorithm | M | 1 | | +| digestQop | DigestQop | M | 1 | | +| ha1 | string | M | 1 | | + +## 6.5.6.3 Simple data types and enumerations + +## 6.5.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 6.5.6.3.2 Simple data types + +The simple data types defined in table 6.5.6.3.2-1 shall be supported. + +**Table 6.5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|-----------------|-------------------------------| +| Impi | string | IMS Private User Identity | +| Ck | string | pattern: "^[A-Fa-f0-9]{32}\$" | +| lk | string | pattern: "^[A-Fa-f0-9]{32}\$" | + +## 6.5.6.3.3 Enumeration: AuthenticationScheme + +The enumeration AuthenticationScheme represents the authentication scheme used in GBA. It shall comply with the provisions defined in table 6.5.6.3.3-1. + +**Table 6.5.6.3.3-1: Enumeration AuthenticationScheme** + +| Enumeration value | Description | +|--------------------|-------------------------------| +| "DIGEST_AKAV1_MD5" | IMS-AKA authentication scheme | +| "DIGEST_HTTP" | Digest authentication scheme | + +#### 6.5.6.3.4 Enumeration: DigestAlgorithm + +The enumeration DigestAlgorithm represents the algorithm for the Digest scheme. It shall comply with the provisions defined in table 6.5.6.3.4-1. + +**Table 6.5.6.3.4-1: Enumeration DigestAlgorithm** + +| Enumeration value | Description | +|-------------------|---------------------------------------------| +| "MD5" | MD5 digest algorithm | +| "MD5_SESS" | Session variant of the MD5 digest algorithm | + +#### 6.5.6.3.5 Enumeration: DigestQop + +The enumeration DigestQop represents the quality of protection for the Digest scheme. It shall comply with the provisions defined in table 6.5.6.3.5-1. + +**Table 6.5.6.3.5-1: Enumeration DigestQop** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------| +| "AUTH" | Indicates authentication | +| "AUTH_INT" | Indicates authentication with integrity protection | + +### 6.5.7 Error Handling + +#### 6.5.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.5.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.5.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nhss\_gbaUEAU service. The following application errors listed in Table 6.5.7.3-1 are specific for the Nhss\_gbaUEAU service. + +**Table 6.5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------|------------------|--------------------------------------------------------------------------------------| +| OPERATION_NOT_ALLOWED | 403 Forbidden | The NF Service Consumer is not authorized to invoke the requested service operation. | +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN. | + +### 6.5.8 Feature Negotiation + +The optional features in table 6.5.8-1 are defined for the Nhss\_gbaUEAU API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.5.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 6.5.9 Security + +As indicated in 3GPP TS 33.501 [5], the access to the Nhss\_gbaUEAU API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [35]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [36]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_gbaUEAU API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [36], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nhss\_gbaUEAU service. + +The Nhss\_gbaUEAU API defines the following scopes for OAuth2 authorization: + +**Table 6.5.9-1: OAuth2 scopes defined in Nhss\_gbaUEAU API** + +| Scope | Description | +|-------------------------------------------|---------------------------------------------------| +| "nhss-gba-ueau" | Access to the Nhss_gbaUEAU API | +| "nhss-gba-ueau:generate-auth-data:invoke" | Access to invoke the Generate Auth Data operation | + +## 6.5.10 HTTP redirection + +An HTTP request may be redirected to a different HSS service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different HSS producer instance will return the NF Instance ID of the new HSS producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an HSS redirects a service request to a different HSS using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new HSS towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the Nhss IMS API(s). It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [34] clause 5B). + +## A.2 Nhss\_imsUECM API + +``` +openapi: 3.0.0 + +info: + version: '1.2.0-alpha.2' + title: 'Nhss_imsUECM' + description: | + Nhss UE Context Management Service for IMS. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.562 Home Subscriber Server (HSS) Services, version 18.2.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.562/' + +servers: + - url: '{apiRoot}/nhss-ims-uecm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-uecm + +paths: + + /{impu}/authorize: + post: + summary: > + Authorize IMS Identities to register in the network or establish multimedia sessions + and return CSCF location if it is stored + operationId: Authorize + tags: + - Authorize (Custom Operation) + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-uecm + - oAuth2ClientCredentials: + - nhss-ims-uecm + - nhss-ims-uecm:authorize:invoke + parameters: + - name: impu + in: path +``` + +``` + description: Public identity of the user. + required: true + schema: + $ref: '#/components/schemas/Impu' +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationRequest' + required: true +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationResponse' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + deregistrationNotification: + '{request.body#/deregCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DeregistrationData' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +``` + +``` + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/scscf-registration: + put: + summary: SCSCF registration information + operationId: SCSCF registration + tags: + - S-CSCF Registration (Document) + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-uecm + - oAuth2ClientCredentials: + - nhss-ims-uecm + - nhss-ims-uecm:registration:create + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfRegistration' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfRegistration' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-ims-uecm/v1/{imsUeId}/scscf-registration + required: true + schema: + type: string + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfRegistration' + '204': + description: No content + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtendedProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +``` + +``` + + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/scscf-registration/scscf-restoration-info: + put: + summary: Update the S-CSCF restoration information of the UE + operationId: UpdateScscfRestorationInfo + tags: + - S-CSCF Restoration Information (Document) + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-uecm + - oAuth2ClientCredentials: + - nhss-ims-uecm + - nhss-ims-uecm:restoration:modify + parameters: + - name: imsUeId + in: path + description: IMS Identity. + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfRestorationInfoRequest' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfRestorationInfoResponse' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-ims-uecm/v1/{imsUeId}/scscf-registration/scscf-restoration-info + required: true + schema: + type: string + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfRestorationInfoResponse' + '204': + description: No content + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + +``` + +``` +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieve the S-CSCF restoration information of the UE + operationId: GetScscfRestorationInfo + tags: + - S-CSCF Restoration Information (Document) + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-uecm + - oAuth2ClientCredentials: + - nhss-ims-uecm + - nhss-ims-uecm:restoration:read + parameters: + - name: impu + in: path + description: Public identity of the user. + required: true + schema: + $ref: '#/components/schemas/Impu' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfRestorationInfoResponse' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Delete the S-CSCF restoration information of the UE + operationId: DeleteScscfRestorationInfo + tags: + - S-CSCF Restoration Information (Document) + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-uecm + - oAuth2ClientCredentials: + - nhss-ims-uecm + - nhss-ims-uecm:restoration:modify + parameters: + - name: impu +``` + +``` + + in: path + description: Public identity of the user. + required: true + schema: + $ref: '#/components/schemas/Impu' + responses: + '204': + description: No content + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-ims-uecm: Access to the Nhss IMS UE Context Management API + nhss-ims-uecm:authorize:invoke: Access to invoke the Authorize custom operation + nhss-ims-uecm:registration:create: Access to create the S-CSCF Registration resource + nhss-ims-uecm:restoration:read: Access to read the S-CSCF Restoration resource + nhss-ims-uecm:restoration:modify: >- + Access to create/update/delete the S-CSCF Restoration resource + +schemas: + +# +# COMPLEX TYPES: +# + + AuthorizationRequest: + description: Ims authorization request data + type: object + required: + - authorizationType + properties: + impi: + $ref: '#/components/schemas/Impi' + authorizationType: + $ref: '#/components/schemas/AuthorizationType' + visitedNetworkIdentifier: + type: string + emergencyIndicator: + type: boolean + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + AuthorizationResponse: + description: Ims Registration authorization information result + type: object + properties: + authorizationResult: + $ref: '#/components/schemas/AuthorizationResult' + cscfServerName: + type: string + +``` + +``` + scscfSelectionAssistanceInfo: + $ref: 'TS29562_Nhss_imsSDM.yaml#/components/schemas/ScscfSelectionAssistanceInformation' + required: + - authorizationResult + oneOf: + - required: + - cscfServerName + - required: + - scscfSelectionAssistanceInfo + +ScscfRegistration: + description: Scscf Registration + type: object + required: + - imsRegistrationType + - cscfServerName + properties: + impi: + $ref: '#/components/schemas/Impi' + imsRegistrationType: + $ref: '#/components/schemas/ImsRegistrationType' + cscfServerName: + type: string + scscfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + deregCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + associatedImpis: + type: array + items: + $ref: '#/components/schemas/Impi' + associatedRegisteredImpis: + type: array + items: + $ref: '#/components/schemas/Impi' + irsImpus: + type: array + items: + $ref: '#/components/schemas/Impu' + minItems: 1 + uniqueItems: true + wildcardedPui: + $ref: '#/components/schemas/Impu' + looseRouteIndicator: + $ref: '#/components/schemas/LooseRouteIndication' + wildcardedPsi: + $ref: '#/components/schemas/Impu' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + multipleRegistrationIndicator: + type: boolean + pscfRestorationIndicator: + type: boolean + default: false + scscfReselectionIndicator: + type: boolean + default: false + +ExtendedProblemDetails: + description: > + Extension of the ProblemDetails data type, to include additional information + in an error response message + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/AdditionalInfo' + +AdditionalInfo: + description: > + Additional information to be sent on error response messages, along with the + common content in ProblemDetails + type: object + properties: + scscfServerName: + type: string + +ScscfRestorationInfo: + description: S-CSCF restoration information + type: object +``` + +``` +properties: + userName: + $ref: '#/components/schemas/Impi' + restorationInfo: + type: array + items: + $ref: '#/components/schemas/RestorationInfo' + registrationTimeout: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + sipAuthenticationScheme: + $ref: 'TS29562_Nhss_imsUEAU.yaml#/components/schemas/SipAuthenticationScheme' + +ScscfRestorationInfoRequest: + description: S-CSCF restoration information request + type: object + properties: + scscfRestorationInfoRequest: + $ref: '#/components/schemas/ScscfRestorationInfo' + +ScscfRestorationInfoResponse: + description: S-CSCF restoration information response + type: object + properties: + scscfRestorationInfoResponse: + type: array + items: + $ref: '#/components/schemas/ScscfRestorationInfo' + +RestorationInfo: + description: > + The information relevant to a specific registration required for an S-CSCF + to handle the requests for a user + type: object + required: + - path + - contact + properties: + path: + type: string + contact: + type: string + initialCSeqSequenceNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + callIdSipHeader: + type: string + ueSubscriptionInfo: + $ref: '#/components/schemas/UeSubscriptionInfo' + pcscfSubscriptionInfo: + $ref: '#/components/schemas/PcscfSubscriptionInfo' + imsSdmSubscriptions: + description: > + A map (list of key-value pairs where subscriptionId serves as key) of ImsSdmSubscription + type: object + additionalProperties: + $ref: 'TS29562_Nhss_imsSDM.yaml#/components/schemas/ImsSdmSubscription' + +UeSubscriptionInfo: + description: Subscription information of the UE for the SIP Registration State event + type: object + required: + - callIdSipHeader + - fromSipHeader + - toSipHeader + - recordRoute + - contact + properties: + callIdSipHeader: + type: string + fromSipHeader: + type: string + toSipHeader: + type: string + recordRoute: + type: string + contact: + type: string + +PcscfSubscriptionInfo: +``` + +``` + +description: Subscription information of the P-CSCF for the SIP Registration State event +type: object +required: +- callIdSipHeader +- fromSipHeader +- toSipHeader +- contact +properties: +callIdSipHeader: +type: string +fromSipHeader: +type: string +toSipHeader: +type: string +contact: +type: string + +DeregistrationData: +description: Data related to the de-registration information of a S-CSCF in HSS +type: object +required: +- deregReason +- impi +properties: +deregReason: +$ref: '#/components/schemas/DeregistrationReason' +impi: +$ref: '#/components/schemas/Impi' +associatedImpis: +type: array +items: +$ref: '#/components/schemas/Impi' +emergencyRegisteredIdentities: +type: array +items: +$ref: '#/components/schemas/EmergencyRegisteredIdentity' +minItems: 1 + +EmergencyRegisteredIdentity: +description: > +A pair of private and public user identities which have not been de-registered +due to emergency registration +type: object +required: +- impi +- impu +properties: +impi: +$ref: '#/components/schemas/Impi' +impu: +$ref: '#/components/schemas/Impu' + +DeregistrationReason: +description: > +Contains the reason for the network initiated de-registration (including a reason code, +and a human-readable reason text) +type: object +required: +- reasonCode +- reasonText +properties: +reasonCode: +$ref: '#/components/schemas/DeregistrationReasonCode' +reasonText: +type: string + +# +# SIMPLE TYPES +# + +ImsUEId: +description: IMS UE Identity (IMPU or IMPI) +type: string +pattern: '^([impusip\:\([a-zA-Z0-9_\-\.\!~*()\&=+$,;\?\/]+\)\@[([A-Za-z0-9]+\-[A-Za-z0-9]+\)\.\])+[a-z]{2,}\|imputel\:\+[0-9]{5,15}\|impi\-\.\+\.\+\$)' + +Impu: +description: IMS Public Identity of the UE (sip URI or tel URI) + +``` + +``` + + type: string + pattern: '^((sip\:(\[a-zA-Z0-9_\-\.\!~*()\&=+\$,\;?\/\]+\)\@(\[A-Za-z0-9]+\-\[A-Za-z0-9]+\)\.\)\+\[a-z]{2,}\| +tel\:\+\[0-9]{5,15}\}$' + + Impi: + description: IMS Private Identity of the UE + type: string + +# +# ENUMS: +# + + AuthorizationType: + description: Represents the type of authorization requested by the UE + anyOf: + - type: string + enum: + - REGISTRATION + - DEREGISTRATION + - type: string + + AuthorizationResult: + description: Represents the details of the granted authorization to the UE + anyOf: + - type: string + enum: + - FIRST_REGISTRATION + - SUBSEQUENT_REGISTRATION + - type: string + + ImsRegistrationType: + description: Represents the type of registration associated to the REGISTER request + anyOf: + - type: string + enum: + - INITIAL_REGISTRATION + - RE_REGISTRATION + - TIMEOUT_DEREGISTRATION + - USER_DEREGISTRATION + - ADMINISTRATIVE_DEREGISTRATION + - AUTHENTICATION_FAILURE + - AUTHENTICATION_TIMEOUT + - UNREGISTERED_USER + - type: string + + LooseRouteIndication: + description: Indicates whether the loose routing mechanism is required to serve the user + anyOf: + - type: string + enum: + - LOOSE_ROUTE_NOT_REQUIRED + - LOOSE_ROUTE_REQUIRED + - type: string + + DeregistrationReasonCode: + description: Indicates the reason for the network-initiated deregistration + anyOf: + - type: string + enum: + - PERMANENT_TERMINATION + - NEW_SERVER_ASSIGNED + - REMOVE_S-CSCF + - SERVER_CHANGE + - type: string + +``` + +## A.3 Nhss\_imsSDM API + +openapi: 3.0.0 + +``` + +info: + version: '1.2.0-alpha.1' + title: 'Nhss_imsSDM' + description: | + Nhss Subscriber Data Management Service for IMS. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + +``` + +All rights reserved. + +``` +externalDocs: + description: 3GPP TS 29.562 HSS Services for interworking with IMS, version 18.0.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.562/' + +servers: + - url: '{apiRoot}/nhss-ims-sdm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + +paths: + /{imsUeId}/ims-data/registration-status: + get: + summary: Retrieve the registration status of a user + operationId: GetRegistrationStatus + tags: + - Registration Status retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:registration-status:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImsRegistrationStatus' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/profile-data: + get: + summary: > + Retrieve the complete IMS profile for a given IMS public identity + (and public identities in the same IRS) + operationId: GetProfileData + tags: + - IMS Profile Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:profile-data:read + parameters: + - name: imsUeId + in: path + description: IMS Identity. In this case it shall be an IMS public identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: dataset-names + in: query + description: Datasets to be retrieved + schema: + $ref: '#/components/schemas/DataSetNames' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImsProfileData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/profile-data/priority-levels: + get: + summary: Retrieve the service priority levels associated to the user + operationId: GetPriorityInfo + tags: + - Priority Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:priority-levels:read + +``` + +``` +parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/PriorityLevels' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/profile-data/ifcs: + get: + summary: Retrieve the Initial Filter Criteria for the associated IMS subscription + operationId: GetIfcs + tags: + - IFCs Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ifcs:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: application-server-name + in: query + description: SIP URI of the Application Server Name + schema: + $ref: '#/components/schemas/SipServerName' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +``` + +``` +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/Ifcs' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/profile-data/service-level-trace-information: + get: + summary: Retrieve the IMS service level trace information for the associated user + operationId: GetServiceTraceInfo + tags: + - Service Trace Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:service-level-trace-information:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceLevelTraceInformation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +``` + +``` + + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/profile-data/charging-info: + get: + summary: Retrieve the charging information for to the user + operationId: GetChargingInfo + tags: + - Charging Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:charging-info:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ChargingInfo' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/location-data/server-name: + get: + +``` + +``` +summary: Retrieve the server name for the associated user +operationId: GetServerName +tags: + - Server Name retrieval +security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:server-name:read +parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImsLocationData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/location-data/scscf-capabilities: +get: + summary: Retrieve the S-CSCF capabilities for the associated IMS subscription + operationId: GetScscfCapabilities + tags: + - Retrieval of the S-CSCF capabilities for the IMS subscription + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:scscf-capabilities:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: +``` + +``` + + $ref: '#/components/schemas/ImsUeId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfCapabilityList' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/location-data/scscf-selection-assistance-info: + get: + summary: Retrieve the S-CSCF selection assistance info + operationId: GetScscfSelectionAssistanceInfo + tags: + - Retrieval of the S-CSCF selection assistance information for the IMS subscription + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:scscf-selection-assistance-info:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfSelectionAssistanceInformation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + +``` + +``` +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +'504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/ps-domain/location-data: + get: + summary: Retrieve the location data in PS domain + operationId: GetLocPsDomain + tags: + - PS location retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ps-domain:location-data:read + parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: requested-nodes + in: query + description: Indicates the serving node(s) for which the request is applicable. + style: form + explode: false + schema: + type: array + items: + $ref: '#/components/schemas/RequestedNode' + - name: serving-node + in: query + description: > + Indicates that only the stored NF id/address of the serving node(s) is required + schema: + type: boolean + - name: local-time + in: query + description: > + Indicates that only the Local Time Zone information of the location in the visited + network where the UE is attached is requested + schema: + type: boolean + - name: current-location + in: query + description: > + Indicates whether an active location retrieval has to be initiated by the requested node + schema: + type: boolean + - name: rat-type + in: query + description: Indicates whether RAT Type retrieval is requested + schema: + type: boolean + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' +``` + +``` + +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/PsLocation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/cs-domain/location-data: + get: + summary: Retrieve the location data in CS domain + operationId: GetLocCsDomain + tags: + - CS location retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:cs-domain:location-data:read + parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: serving-node + in: query + description: > + Indicates that only the stored NF id/address of the serving node(s) is required + schema: + type: boolean + - name: local-time + in: query + description: > + Indicates that only the Local Time Zone information of the location in the visited + network where the UE is attached is requested + schema: + type: boolean + - name: current-location + in: query + description: > + Indicates whether an active location retrieval has to be initiated by the requested node + schema: + type: boolean + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +``` + +``` + +- name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/CsLocation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/repository-data/{serviceIndication}: + put: + summary: Update the repository data associated to an IMPU and service indication + operationId: UpdateRepositoryDataServInd + tags: + - Update repository data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:repository-data:modify + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: serviceIndication + in: path + description: Identifier of a service related data + required: true + schema: + $ref: '#/components/schemas/ServiceIndication' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RepositoryData' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/RepositoryData' + +``` + +``` +headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-ims-sdm/v1/{imsUeId}/repository-data/{serviceIndication} + required: true + schema: + type: string +'200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/RepositoryData' +'204': + description: No content +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +delete: + summary: delete the Repository Data for a Service Indication + operationId: DeleteRepositoryDataServInd + tags: + - Delete repository data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:repository-data:modify + parameters: + - name: imsUeId + in: path + description: Identifier of the UE + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: serviceIndication + in: path + description: Identifier of a service related data + required: true + schema: + $ref: '#/components/schemas/ServiceIndication' + responses: + '204': + description: Expected response to a valid request + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +``` + +``` +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +get: + summary: Retrieve the repository data associated to an IMPU and service indication + operationId: GetRepositoryDataServInd + tags: + - Repository data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:repository-data:read + parameters: + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: serviceIndication + in: path + description: Identifier of a service related data + required: true + schema: + $ref: '#/components/schemas/ServiceIndication' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/RepositoryData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/identities/msisdns: + get: + summary: retrieve the Msisdns associated to requested identity + operationId: GetMsisdns + tags: + - Retrieval of the associated Msisdns + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:identities:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-id + in: query + description: Private identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/MsisdnList' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/identities/ims-associated-identities: + get: + summary: > + Retrieve the associated identities to the IMS public identity included + in the service request + operationId: GetImAssocIds + tags: + - Retrieval of associated IMS public identities + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:identities:read +``` + +``` + +parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImsAssociatedIdentities' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/identities/private-identities: + get: + summary: > + Retrieve the associated private identities to the IMS public identity included + in the service request + operationId: GetImsPrivateIds + tags: + - Retrieval of associated IMS private identities + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:identities:read + parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: impi + in: query + description: Private Identity of type IMPI + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + +``` + +``` + + schema: + $ref: '#/components/schemas/PrivateIdentities' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/srvcc-data: + get: + summary: Retrieve the srvcc data + operationId: GetSrvccData + tags: + - Retrieval of UE SRVCC capability and STN-SR + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:srvcc:read + parameters: + - name: imsUeId + in: path + description: IMS Public Identity or IMS Private Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SrvccData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + +``` + +``` + + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: Patch + operationId: UpdateSrvccData + tags: + - Update SRVCC data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:srvcc:modify + parameters: + - name: imsUeId + in: path + description: IMS Public Identity or IMS Private Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + +``` + +``` +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/{imsUeId}/service-data/psi-status: + get: + summary: Retrieve the PSI activation state data + operationId: GetPsiState + tags: + - Retrieval of PSI activation state + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:psi-status:read + parameters: + - name: imsUeId + in: path + description: IMS Private Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/PsiActivationState' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + patch: + summary: Patch + operationId: UpdatePsiState + tags: + - Update PSI state data + security: + - {} + - oAuth2ClientCredentials: +``` + +``` + + - nhss-ims-sdm + - OAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:psi-status:modify +parameters: + - name: imsUeId + in: path + description: IMS Public Service Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/{imsUeId}/service-data/dsai: + get: + summary: Retrieve the DSAI information associated to an Application Server + operationId: GetDsaiInfo + tags: + - DSAI registration information + security: + - {} + - OAuth2ClientCredentials: + - nhss-ims-sdm + - OAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:dsai:read + parameters: + - name: imsUeId + +``` + +``` +in: path +description: IMS Identity +required: true +schema: + $ref: '#/components/schemas/ImsUeId' +- name: application-server-name +in: query +description: SIP URI of the Application Server Name +required: true +schema: + $ref: '#/components/schemas/SipServerName' +- name: dsai-tag +in: query +description: The requested instance of Dynamic Service Activation Info +schema: + type: string +- name: supported-features +in: query +description: Supported Features +schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/DsaiTagInformation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: Patch + operationId: UpdateDsaiState + tags: + - Update Dsai State + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:dsai:modify + parameters: + - name: imsUeId + in: path + description: IMS Public Service Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{imsUeId}/service-data/sms-registration-info: + put: + summary: Update the SMS registration information associated to a user + operationId: UpdateSmsRegistrationInfo + tags: + - Update SMS registration info + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:sms-registration-info:modify + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IpSmGwAddress' + +``` + +``` + + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/SmsRegistrationInfo' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-ims-sdm/v1/{imsUeId}/service-data/sms-registration-info + required: true + schema: + type: string + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/SmsRegistrationInfo' + '204': + description: No content + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + delete: + summary: delete the SMS registration information + operationId: DeleteSmsRegistrationInfo + tags: + - Delete SMS registration information + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:sms-registration-info:modify + parameters: + - name: imsUeId + in: path + description: Identifier of the UE + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + +``` + +``` +responses: + '204': + description: Expected response to a valid request + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +get: + summary: Retrieve the SMS registration information associated to a user + operationId: GetSmsRegistrationInfo + tags: + - SMS registration information + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:sms-registration-info:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmsRegistrationInfo' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +``` + +``` + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/identities/imeiSv: + get: + summary: Retrieve the IMEISV information + operationId: GetIMEISVInfo + tags: + - IMEISV Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:identities:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImeiSvInformation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/ps-domain/ip-address: + get: + summary: Retrieve the IP address information + operationId: GetIpAddressInfo + tags: + - IP address Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm +``` + +``` + - nhss-ims-sdm:ps-domain:ip-address:read +parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/ps-domain/tads-info: + get: + summary: Retrieve the T-ADS information + operationId: GetTadsInfo + tags: + - TADS Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ps-domain:tads-info:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/TadsInformation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +``` + +``` + + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/ps-domain/ue-reach-subscriptions: + post: + summary: subscribe to notifications of UE reachability + operationId: UeReachIpSubscribe + tags: + - UE IP reachability Subscription Creation + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ps-domain:ue-reach-subscriptions:create + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UeReachabilitySubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/CreatedUeReachabilitySubscription' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-ims-sdm/v1/{imsUeId}/access-data/ps-domain/ue-reach-subscriptions/ + {subscriptionId} + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + +``` + +``` + + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + callbacks: + ueReachabilityNotification: + '{request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UeReachabilityNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{imsUeId}/access-data/ps-domain/ue-reach-subscriptions/{subscriptionId}: + delete: + summary: unsubscribe from notifications to UE reachability + operationId: UeReachUnsubscribe + tags: + - Reachability Subscription Deletion + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + +``` + +``` +- oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ps-domain:ue-reach-subscriptions:modify +parameters: +- name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' +- name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string +- name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' +responses: +'204': + description: Successful response +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +patch: + summary: modify the subscription + operationId: UeReachSubsModify + tags: + - Reachability Subscription Modification + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ps-domain:ue-reach-subscriptions:modify + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + - name: supported-features + in: query +``` + +``` + +description: Supported Features +schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful modification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/{imsUeId}/access-data/ps-domain/user-state: + get: + summary: Retrieve the user state information in PS domain + operationId: GetPsUserInfo + tags: + - PS User State Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ps-domain:user-state:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: requested-nodes + in: query + description: Indicates the serving node(s) for which the request is applicable. + style: form + explode: false + schema: + type: array + items: + +``` + +``` + + $ref: '#/components/schemas/RequestedNode' + minItems: 1 +- name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/PsUserState' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/cs-domain/user-state: + get: + summary: Retrieve the user state information in CS domain + operationId: GetCsUserStateInfo + tags: + - CS User State Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:cs-domain:user-state:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/CsUserState' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': +$ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': +$ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': +$ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': +$ref: 'TS29571_CommonData.yaml#/components/responses/404' +'405': +$ref: 'TS29571_CommonData.yaml#/components/responses/405' +'406': +$ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': +$ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': +$ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': +$ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': +$ref: 'TS29571_CommonData.yaml#/components/responses/503' +'504': +$ref: 'TS29571_CommonData.yaml#/components/responses/504' +default: +$ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/cs-domain/csrn: +get: +summary: Retrieve the routing number in CS domain +operationId: GetCsrn +tags: +- CSRN retrieval +security: +- {} +- oAuth2ClientCredentials: +- nhss-ims-sdm +- oAuth2ClientCredentials: +- nhss-ims-sdm +- nhss-ims-sdm:cs-domain:csrnrn:read +parameters: +- name: imsUeId +in: path +description: IMS Public Identity +required: true +schema: +$ref: '#/components/schemas/ImsUeId' +- name: pre-paging +in: query +description: Indicates pre-paging support +schema: +$ref: '#/components/schemas/PrePaging' +- name: supported-features +in: query +description: Supported Features +schema: +$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +- name: private-identity +in: query +description: IMS Private Identity +schema: +$ref: '#/components/schemas/PrivateId' +- name: call-reference-info +in: query +description: Indicates Call-Reference Number and AS-Number +content: +application/json: +schema: +$ref: '#/components/schemas/CallReferenceInfo' +responses: +'200': +description: Expected response to a valid request +content: +application/json: +schema: +$ref: '#/components/schemas/Csrn' +'307': +$ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/wireline-domain/reference-location: + get: + summary: Retrieve the reference location information + operationId: GetReferenceLocationInfo + tags: + - Reference Location Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:wireline-domain:reference-location:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ReferenceLocationInformation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/subscriptions: + post: + summary: subscribe to notifications + operationId: ImsSdmSubscribe + tags: + - SDM Subscription Creation + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:subscriptions:create + parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImsSdmSubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImsSdmSubscription' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-ims-sdm/v1/{imsUeId}/subscriptions/{subscriptionId} + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + datachangeNotification: + '{request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ModificationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/imsUeId/subscriptions/{subscriptionId}: + delete: + summary: unsubscribe from notifications + operationId: ImsSdmUnsubscribe + tags: + - SDM Subscription Deletion + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:subscription:modify + parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string + responses: + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + +``` + +``` +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: modify the subscription + operationId: ImsSdmSubsModify + tags: + - SDM Subscription Modification + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:subscription:modify + parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful modification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +``` + +``` +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/shared-data-subscriptions: + post: + summary: subscribe to notifications for shared data + operationId: SubscribeToSharedData + tags: + - Subscription Creation for shared data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:shared-subscriptions:create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImsSdmSubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImsSdmSubscription' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-ims-sdm/v1/shared-data-subscriptions/{subscriptionId} + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + datachangeNotification: + '{request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ModificationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/shared-data-subscriptions/{subscriptionId}: + delete: + summary: unsubscribe from notifications for shared data + operationId: UnsubscribeForSharedData + tags: + - Subscription Deletion for shared data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:shared-subscription:modify + parameters: + - name: subscriptionId + in: path + description: Id of the Shared data Subscription + required: true + schema: + type: string + responses: + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + +``` + +``` +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: modify the subscription + operationId: ModifySharedDataSubs + tags: + - Subscription Modification + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:shared-subscription:modify + parameters: + - name: subscriptionId + in: path + description: Id of the SDM Subscription + required: true + schema: + type: string + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful modification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +``` + +``` + + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/shared-data: + get: + summary: retrieve shared data + operationId: GetSharedData + tags: + - Retrieval of shared data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:shared-data:read + parameters: + - name: shared-data-ids + in: query + description: List of shared data ids + required: true + style: form + explode: false + schema: + type: array + items: + $ref: '#/components/schemas/SharedDataId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SharedData' + minItems: 1 + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/repository-data: + get: + summary: Retrieve the repository data associated to an IMPU and service indication list + operationId: GetRepositoryDataServIndList + tags: + - Repository data list + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:repository-data:read + parameters: + +``` + +``` + +- name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' +- name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +- name: service-indications + in: query + description: Identifiers of a services related data + required: true + style: form + explode: false + schema: + type: array + items: + $ref: '#/components/schemas/ServiceIndication' + minItems: 1 +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/RepositoryDataList' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + +securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-ims-sdm: Access to the Nhss IMS Subscription Data Management API + nhss-ims-sdm:registration-status:read: Access to read the Registration Status resource + nhss-ims-sdm:profile-data:read: Access to read the Profile Data resource + nhss-ims-sdm:priority-levels:read: Access to read the Priority Levels resource + nhss-ims-sdm:ifcs:read: Access to read the Initial Filter Criteria resource + nhss-ims-sdm:service-level-trace-information:read: >- + Access to read the Service Level Trace Information resource + nhss-ims-sdm:server-name:read: Access to read the Server Name resource + nhss-ims-sdm:scscf-capabilities:read: Access to read the S-CSCF Capabilities resource + nhss-ims-sdm:ps-domain:location-data:read: >- + Access to read the PS-Domain Location Data resource + nhss-ims-sdm:ps-domain:ip-address:read: Access to read the PS-Domain IP Address resource + nhss-ims-sdm:ps-domain:tads-info:read: Access to read the PS-Domain TADS Info resource + +``` + +``` + +nhss-ims-sdm:ps-domain:ue-reach-subscriptions:create: >- + Access to create PS-Domain UE Reachability Subscriptions resources +nhss-ims-sdm:ps-domain:ue-reach-subscriptions:modify: >- + Access to update/delete a PS-Domain UE Reachability Subscription resource +nhss-ims-sdm:ps-domain:user-state:read: Access to read the PS-Domain User State resource +nhss-ims-sdm:cs-domain:location-data:read: >- + Access to read the CS-Domain Location Data resource +nhss-ims-sdm:cs-domain:user-state:read: Access to read the CS-Domain User State resource +nhss-ims-sdm:cs-domain:csrnr:read: Access to read the CS-Domain CSRNR resource +nhss-ims-sdm:wireline-domain:reference-location:read: >- + Access to read the Wireline-Domain Reference Location resource +nhss-ims-sdm:repository-data:modify: >- + Access to create/update/delete the Repository Data resource +nhss-ims-sdm:repository-data:read: Access to read the Repository Data resource +nhss-ims-sdm:identities:read: Access to read the Identities resource +nhss-ims-sdm:srvcc:read: Access to read the SRVCC resource +nhss-ims-sdm:srvcc:modify: Access to update the SRVCC resource +nhss-ims-sdm:psi-status:read: Access to read the PSI Status resource +nhss-ims-sdm:psi-status:modify: Access to update the PSI Status resource +nhss-ims-sdm:dsai:read: Access to read the DSAI resource +nhss-ims-sdm:dsai:modify: Access to update the DSAI resource +nhss-ims-sdm:sms-registration-info:read: >- + Access to read the SMS Registration Info resource +nhss-ims-sdm:sms-registration-info:modify: >- + Access to create/update/delete the SMS Registration Info resource +nhss-ims-sdm:subscriptions:create: Access to create Subscriptions resources +nhss-ims-sdm:subscription:modify: Access to update/delete a Subscription resource +nhss-ims-sdm:shared-subscriptions:create: >- + Access to create a Shared-Data Subscriptions resource +nhss-ims-sdm:shared-subscription:modify: >- + Access to update/delete a Shared-Data Subscription resource +nhss-ims-sdm:shared-data:read: Access to read the Shared-Data resource +nhss-ims-sdm:charging-info:read: Access to read the ChargingInfo resource + +``` + +schemas: + +``` + +# +# COMPLEX TYPES: +# + +``` + +``` + +SscfCapabilityList: + description: Information about mandatory and optional S-CSCF capabilities + type: object + properties: + mandatoryCapabilityList: + $ref: '#/components/schemas/Capabilities' + optionalCapabilityList: + $ref: '#/components/schemas/Capabilities' + anyOf: + - required: [mandatoryCapabilityList] + - required: [optionalCapabilityList] + +Capabilities: + description: A list of capabilities of the S-CSCF + type: array + items: + $ref: '#/components/schemas/Capability' + minItems: 1 + uniqueItems: true + +RepositoryData: + description: Repository Data for the requested Service Indication + type: object + required: + - serviceData + - sequenceNumber + properties: + sequenceNumber: + $ref: '#/components/schemas/SequenceNumber' + serviceData: + type: string + format: byte + +MsisdnList: + description: List of MSISDNs associated to the IMS public Identity + type: object + required: + - basicMsisdn + +``` + +``` +properties: + basicMsisdn: + $ref: '#/components/schemas/Msisdn' + additionalMsisdns: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/Msisdn' + +PublicIdentities: + description: > + IMS Public Identities which belong to the same Implicit Registration Set (if any) + as the requested IMS Public Identity + type: object + required: + - publicIdentities + properties: + publicIdentities: + type: array + items: + $ref: '#/components/schemas/PublicIdentity' + minItems: 1 + uniqueItems: true + +PrivateIdentities: + description: A list of IMS Private Identities + type: object + required: + - privateIdentities + properties: + privateIdentities: + type: array + items: + $ref: '#/components/schemas/PrivateIdentity' + minItems: 1 + uniqueItems: true + +PublicIdentity: + description: > + IMS Public Identity and related data (Alias Group Id, IRS default indication, + Identity Type) + type: object + required: + - imsPublicId + - identityType + properties: + imsPublicId: + $ref: '#/components/schemas/ImSPublicId' + identityType: + $ref: '#/components/schemas/IdentityType' + irsIsDefault: + type: boolean + aliasGroupId: + type: string + +PrivateIdentity: + description: IMS Private Identity and its identity type (IMPI or IMSI) + type: object + required: + - privateIdentity + - privateIdentityType + properties: + privateIdentity: + $ref: '#/components/schemas/PrivateId' + privateIdentityType: + $ref: '#/components/schemas/PrivateIdentityType' + +ImsAssociatedIdentities: + description: > + A list of identities belonging to the same Implicit Registration Set (IRS), + along with the registration state of the IRS + type: object + required: + - irsState + - publicIdentities + properties: + irsState: + $ref: '#/components/schemas/ImRegistrationState' +``` + +``` + publicIdentities: + $ref: '#/components/schemas/PublicIdentities' + +ImsSdmSubscription: + description: A subscription to notifications of data change + type: object + required: + - nfInstanceId + - callbackReference + - monitoredResourceUris + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + callbackReference: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + monitoredResourceUris: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + expires: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +ImsRegistrationStatus: + description: Registration status of the user + type: object + required: + - imsUserStatus + properties: + imsUserStatus: + $ref: '#/components/schemas/ImsRegistrationState' + +PriorityLevels: + description: Namespaces and priority levels allowed for the IMS public Identity + type: object + required: + - servicePriorityLevelList + properties: + servicePriorityLevelList: + type: array + items: + $ref: '#/components/schemas/NameSpacePriority' + minItems: 1 + uniqueItems: true + servicePriorityLevel: + type: integer + minimum: 0 + maximum: 4 + +Ifcs: + description: List of IFCs associated to the IMS public Identity + type: object + properties: + ifcList: + type: array + items: + $ref: '#/components/schemas/Ifc' + minItems: 1 + cscfFilterSetIdList: + type: array + items: + $ref: '#/components/schemas/CscfFilterSetId' + minItems: 1 + anyOf: + - required: [ ifcList ] + - required: [ cscfFilterSetIdList ] + +Ifc: + description: Data associated to an individual IFC (Initial Filter Criteria) + type: object + required: + - priority + - appServer + properties: + priority: + type: integer + minimum: 1 + trigger: +``` + +``` +$ref: '#/components/schemas/TriggerPoint' +appServer: + $ref: '#/components/schemas/ApplicationServer' + +TriggerPoint: + description: > + Contains the conditions that should be checked in order to find out if an + Application Server should be contacted or not + type: object + required: + - conditionType + - sptList + properties: + conditionType: + $ref: '#/components/schemas/TypeOfCondition' + sptList: + type: array + items: + $ref: '#/components/schemas/Spt' + minItems: 1 + +Spt: + description: Contains the data of a Service Point Trigger + type: object + required: + - conditionNegated + - sptGroup + properties: + conditionNegated: + type: boolean + sptGroup: + type: array + items: + $ref: '#/components/schemas/SptGroupId' + minItems: 1 + regType: + items: + $ref: '#/components/schemas/RegistrationType' + minItems: 1 + maxItems: 2 + requestUri: + type: string + sipMethod: + type: string + sipHeader: + $ref: '#/components/schemas/HeaderSipRequest' + sessionCase: + $ref: '#/components/schemas/RequestDirection' + sessionDescription: + $ref: '#/components/schemas/SdpDescription' + +HeaderSipRequest: + description: Contains a header (and optionally value of the header) in the SIP request + type: object + required: + - header + properties: + header: + type: string + content: + type: string + +SdpDescription: + description: > + Contains a SDP line (and optionally the value in the line) within the body (if any) + of a SIP request + type: object + required: + - line + properties: + line: + type: string + content: + type: string + +ApplicationServer: + description: > + Application Server which shall be triggered if the conditions of a certain IFC are met, +``` + +``` + and its associated data + type: object + required: + - asUri + properties: + asUri: + type: string + sessionContinue: + type: boolean + serviceInfoList: + type: array + items: + $ref: '#/components/schemas/ServiceInformation' + minItems: 1 + +ImsLocationData: + description: IMS Location Data (S-CSCF name) + type: object + required: + - scscfName + properties: + scscfName: + type: string + +PsLocation: + description: Location data in PS domain + type: object + oneOf: + - required: + - sgsnLocationData + - required: + - mmeLocationData + - required: + - amfLocationData + - required: + - twanLocationData + properties: + sgsnLocationData: + $ref: '#/components/schemas/SgsnLocationData' + mmeLocationData: + $ref: '#/components/schemas/MmeLocationData' + amfLocationData: + $ref: '#/components/schemas/AmfLocationData' + twanLocationData: + $ref: '#/components/schemas/TwanLocationData' + +SgsnLocationData: + description: Location information as retrieved from the SGSN serving node + type: object + required: + - sgsnNumber + - plmnId + properties: + sgsnNumber: + type: string + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + sgsnLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UtraLocation' + csgInformation: + $ref: '#/components/schemas/CsgInformation' + timeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + +MmeLocationData: + description: Location information as retrieved from the MME serving node + type: object + required: + - mmeAddress + - plmnId + properties: + mmeAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + mmeLocation: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/EutraLocation' + csgInformation: + $ref: '#/components/schemas/CsgInformation' + timeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + +AmfLocationData: + description: Location information as retrieved from the AMF serving node + type: object + required: + - amfAddress + - plmnId + properties: + amfAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + amfLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NrLocation' + smsfAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + timeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + +TwanLocationData: + description: Location information of the 3GPP AAA Server for Trusted W-LAN Access + type: object + required: + - twanSsid + - plmnId + properties: + twanSsid: + type: string + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + twanBssid: + type: string + civicAddress: + type: string + format: byte + twanOperatorName: + type: string + timeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + logicalAccessId: + type: string + +CsLocation: + description: Location data in CS domain + type: object + required: + - mscNumber + - vlrNumber + - plmnId + properties: + mscNumber: + type: string + vlrNumber: + type: string + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + vlrLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GeraLocation' + csgInformation: + $ref: '#/components/schemas/CsgInformation' + timeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + eUtranCgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + tai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + +CsgInformation: + description: Information about a Closed Subscriber Group (CSG) +``` + +``` +type: object +required: +- csgId +properties: + csgId: + type: string + format: byte + accessMode: + type: string + format: byte + cMi: + type: boolean + +SrvccData: + description: UE SRVCC capability (if available) and STN-SR (if subscribed) + type: object + required: + - stnSr + properties: + stnSr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/StnSr' + ueSrvccCapabilities: + type: array + items: + $ref: '#/components/schemas/SrvccCapability' + minItems: 1 + uniqueItems: true + +PsiActivationState: + description: Public Service Identity activation state + type: object + required: + - activationState + properties: + activationState: + $ref: '#/components/schemas/ActivationState' + +SharedData: + description: Represents a part of the IMS Profile data shared by several UEs + type: object + required: + - sharedDataId + properties: + sharedDataId: + $ref: '#/components/schemas/SharedDataId' + sharedImsiIfcData: + $ref: '#/components/schemas/Ifcs' + minProperties: 1 + +ImsProfileData: + description: User's IMS profile data + type: object + required: + - imsServiceProfiles + properties: + imsServiceProfiles: + type: array + items: + $ref: '#/components/schemas/ImsServiceProfile' + chargingInfo: + $ref: '#/components/schemas/ChargingInfo' + serviceLevelTraceInfo: + $ref: '#/components/schemas/ServiceLevelTraceInformation' + servicePriorityLevelList: + type: array + items: + $ref: '#/components/schemas/NameSpacePriority' + minItems: 1 + uniqueItems: true + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + maxAllowedSimulReg: + type: integer + servicePriorityLevel: + type: integer + minimum: 0 + maximum: 4 +``` + +``` +ImsServiceProfile: + description: > + IMS Service Profile of the UE, containing the list of Public Identifiers and + optionally a list of IFCs + type: object + required: + - publicIdentifierList + properties: + publicIdentifierList: + type: array + items: + $ref: '#/components/schemas/PublicIdentifier' + ifcs: + $ref: '#/components/schemas/Ifcs' + cnServiceAuthorization: + $ref: '#/components/schemas/CoreNetworkServiceAuthorization' + +CoreNetworkServiceAuthorization: + description: > + Core Network Service Authorization + type: object + properties: + subscribedMediaProfileId: + type: integer + +PublicIdentifier: + description: > + Distinct or wildcarded public identity and its associated priority, trace and + barring information + type: object + required: + - publicIdentity + properties: + publicIdentity: + $ref: '#/components/schemas/PublicIdentity' + displayName: + type: string + imsServicePriority: + $ref: '#/components/schemas/PriorityLevels' + serviceLevelTraceInfo: + $ref: '#/components/schemas/ServiceLevelTraceInformation' + barringIndicator: + type: boolean + wildcardedImpu: + type: string + +ServiceLevelTraceInformation: + description: IMS Service Level Trace Information + type: object + properties: + serviceLevelTraceInfo: + type: string + +ImeiSvInformation: + description: IMEI(SV) information + type: object + oneOf: + - required: + - imei + - required: + - imeiSv + properties: + imei: + $ref: '#/components/schemas/Imei' + imeiSv: + $ref: '#/components/schemas/ImeiSv' + +TadsInformation: + description: T-ADS Information + type: object + required: + - voiceOverPsSessionSupport + properties: + voiceOverPsSessionSupport: + $ref: '#/components/schemas/ImsVoiceOverPsSessionSupport' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' +lastUeActivityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +UeReachabilitySubscription: + description: > + Contains the request parameters received by the HSS for a subscription to + notifications of UE reachability for IP + type: object + required: + - expiry + - callbackReference + properties: + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + callbackReference: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + +CreatedUeReachabilitySubscription: + description: > + Contains the response data returned by HSS after the subscription to + notifications of UE reachability for IP was created + type: object + required: + - expiry + properties: + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +UeReachabilityNotification: + description: > + Represents the contents of a notification of UE reachability for IP sent by the HSS + type: object + required: + - reachabilityIndicator + - detectingNode + - accessType + properties: + reachabilityIndicator: + type: boolean + detectingNode: + $ref: '#/components/schemas/DetectingNode' + accessType: + $ref: '#/components/schemas/AccessType' + +PsUserState: + description: User state in PS domain + type: object + oneOf: + - required: + - sgsnUserState + - required: + - mmeUserState + - required: + - amfUserState + properties: + sgsnUserState: + $ref: '#/components/schemas/UserStatePs' + mmeUserState: + $ref: '#/components/schemas/UserStatePs' + amfUserState: + $ref: '#/components/schemas/UserStatePs' + +CsUserState: + description: User state in CS domain + type: object + required: + - mscVlrUserState + properties: + mscVlrUserState: + $ref: '#/components/schemas/UserStateCs' + +Csrn: + description: CS domain routeing number + type: object + required: + - csrn + properties: +``` + +``` +csrn: + $ref: '#/components/schemas/Msisdn' + +ReferenceLocationInformation: + description: Reference Location Information for the user in fixed access networks + type: object + properties: + accessType: + type: string + accessInfo: + type: string + accessValue: + type: string + anyOf: + - required: [accessType] + - required: [accessInfo] + - required: [accessValue] + +SmsRegistrationInfo: + description: SMS Registration Information (IP-SM-GW number and SC address) + type: object + required: + - ipSmGwNumber + properties: + ipSmGwNumber: + $ref: '#/components/schemas/Msisdn' + scAddress: + $ref: '#/components/schemas/Msisdn' + +IpSmGwAddress: + description: IP-SM-GW number and diameter URI/realm + type: object + required: + - ipSmGwNumber + properties: + ipSmGwNumber: + $ref: '#/components/schemas/Msisdn' + ipSmGwDiaUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + ipSmGwDiaRealm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + ipSmGwSbiSupInd: + type: boolean + default: false + +DsaiTagInformation: + description: > + DSAI tag information (list of DSAI tags activation state for an Application Server) + type: object + required: + - dsaiTagStatusList + properties: + dsaiTagStatusList: + type: array + items: + $ref: '#/components/schemas/DsaiTagStatus' + minItems: 1 + uniqueItems: true + +DsaiTagStatus: + description: DSAI tag status (DSAI tag and activation state) + type: object + required: + - dsaiTag + - dsaiState + properties: + dsaiTag: + type: string + dsaiState: + $ref: '#/components/schemas/ActivationState' + +ScscfSelectionAssistanceInformation: + description: Information used by the I-CSCF to select an S-CSCF for the UE + type: object + properties: + scscfCapabilityList: + $ref: '#/components/schemas/ScscfCapabilityList' + scscfNames: +``` + +``` + type: array + items: + type: string + minItems: 1 + anyOf: + - required: [scscfCapabilityList] + - required: [scscfNames] + +ChargingInfo: + description: Diameter addresses of the charging function + type: object + anyOf: + - required: + - primaryEventChargingFunctionName + - required: + - primaryChargingCollectionFunctionName + properties: + primaryEventChargingFunctionName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + secondaryEventChargingFunctionName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + primaryChargingCollectionFunctionName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + secondaryChargingCollectionFunctionName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + +CallReferenceInfo: + description: > + Contains a Call Reference Number and the AS-Number; it allows a later retry of the call + setup in the context of MTRR + type: object + required: + - callRefNumber + - asNumber + properties: + callRefNumber: + type: string + format: byte + description: > + The content is according to CallReferenceNumber type described in 3GPP TS 29.002 [30]. + Base64 encoded according to IETF RFC 2045 [28] + asNumber: + type: string + format: byte + description: > + The content is according to ISDN-AddressString type described in 3GPP TS 29.002 [30]. + Base64 encoded according to IETF RFC 2045 [28] + +DataSetNames: + description: Contains the data sets to be retrieved from the IMS User Profile + type: array + items: + $ref: '#/components/schemas/DataSetName' + minItems: 1 + uniqueItems: true + +RepositoryDataList: + description: List of Repository Data for the requested Service Indications + type: object + required: + - repositoryDataMap + properties: + repositoryDataMap: + description: > + A map (list of key-value pairs where ServiceIndication serves as key) of RepositoryData + type: object + additionalProperties: + $ref: '#/components/schemas/RepositoryData' + +# +# SIMPLE TYPES: +# + +Capability: + description: S-CSCF capability + type: integer + +ImsUeId: +``` + +``` + + description: > + Represents the IMS Public Identity (i.e. IMS Public User identity or + Public Service Identity) + type: string + pattern: '^(impu-sip:(([a-zA-Z0-9_\-.!~*()&=+$,;?/]+)@(([A-Za-z0-9]+([-A-Za-z0-9]+)*\.)+[a-z]{2,})|impu-tel:\+[0-9]{5,15}|impi-.+.+)$' + + SequenceNumber: + description: > + Unsigned integer containing the sequence number associated to the current version + of Repository Data + type: integer + minimum: 0 + + ServiceIndication: + description: String containing the Service Indication or Service Identifier + type: string + + Msisdn: + description: String containing an additional or basic MSISDN + type: string + pattern: '^[0-9]{5,15}$' + + PrivateId: + description: String containing a Private User Identity or a Private Service Identity + type: string + + ImsPublicId: + description: String containing an IMS Public Identity in SIP URI format or TEL URI format + type: string + pattern: '^(sip:(([a-zA-Z0-9_\-.!~*()&=+$,;?/]+)@(([A-Za-z0-9]+([-A-Za-z0-9]+)*\.)+[a-z]{2,})|tel:\+[0-9]{5,15}))$' + + NameSpacePriority: + description: > + String containing the namespace and priority formatted as "r-value" parameter + described in IETF RFC 4412 + type: string + pattern: '^[0-9a-zA-Z-\!%\*_\+\‘\‘~]+\.[0-9a-zA-Z-\!%\*_\+\‘\‘~]+$' + + CscfFilterSetId: + description: Contains the identifier of a specific filter set in the S-CSCF + type: integer + minimum: 0 + + SptGroupId: + description: Contains the identifier of the Group of SPTs + type: integer + minimum: 0 + + SharedDataId: + description: > + Identifies globally and uniquely a piece of subscription data shared by multiple UEs; + the value shall start with the HPLMN id (MCC/MNC) followed by a hyphen followed by a + local Id as allocated by the home network operator + type: string + pattern: '^[0-9]{5,6}-.+$' + + Imei: + description: IMEI of the UE + type: string + pattern: '^[0-9]{15}$' + + ImeiSv: + description: IMEISV of the UE + type: string + pattern: '^[0-9]{16}$' + + PrePaging: + description: Indicates the support of pre-paging + type: boolean + + SipServerName: + description: Server Name (e.g. AS name, CSCF name) in SIP URI format + type: string + pattern: '^(sip:(([a-zA-Z0-9_\-.!~*()&=+$,;?/]+)@(([A-Za-z0-9]+([-A-Za-z0-9]+)*\.)+[a-z]{2,}))$ + +``` + +``` +# +# ENUMS: +# + +IdentityType: + description: Represents the type of IMS Public Identity + anyOf: + - type: string + enum: + - DISTINCT_IMPU + - DISTINCT_PSI + - WILDCARDED_IMPU + - WILDCARDED_PSI + - type: string + +PrivateIdentityType: + description: Represents the type of IMS Private Identity (IMPI or IMSI) + anyOf: + - type: string + enum: + - IMPI + - IMSI + - type: string + +ImsRegistrationState: + description: Represents the IMS status of the user or Public Identity or the IRS + anyOf: + - type: string + enum: + - REGISTERED + - NOT_REGISTERED + - AUTHENTICATION_PENDING + - REGISTERED_UNREG_SERVICES + - type: string + +TypeOfCondition: + description: > + Represents the type of condition to be applied to the logical expression of SPT groups + and SPTs (Conjunctive Normal Form, or Disjunctive Normal Form) + anyOf: + - type: string + enum: + - CNF + - DNF + - type: string + +RegistrationType: + description: Represents the type of registration associated to the REGISTER request + anyOf: + - type: string + enum: + - INITIAL_REGISTRATION + - RE_REGISTRATION + - DE_REGISTRATION + - type: string + +RequestDirection: + description: > + Represents the direction of the request in combination with the registration status + of the user as evaluated in the S-CSCF + anyOf: + - type: string + enum: + - ORIGINATING_REGISTERED + - ORIGINATING_UNREGISTERED + - ORIGINATING_CDIV + - TERMINATING_REGISTERED + - TERMINATING_UNREGISTERED + - type: string + +ServiceInformation: + description: > + Indicates the type of additional information to be included in the body of the SIP request + towards the Application Server + anyOf: + - type: string + enum: + - INCLUDE_REGISTER_REQUEST +``` + +``` + - INCLUDE_REGISTER_RESPONSE + - type: string + +RequestedNode: + description: Represents the type of serving node for which certain data is requested + anyOf: + - type: string + enum: + - SGSN + - MME + - AMF + - 3GPP_AAA_SERVER_TWAN + - type: string + +SrvccCapability: + description: Represents the type of SRVCC support of the UE + anyOf: + - type: string + enum: + - UE_4G_SRVCC_CAPABLE + - UE_5G_SRVCC_CAPABLE + - type: string + +ActivationState: + description: Represents the activation state of a PSI or DSAI tag + anyOf: + - type: string + enum: + - ACTIVE + - INACTIVE + - type: string + +ImsVoiceOverPsSessionSupport: + description: Represents the support for Voice-over-PS of the UE + anyOf: + - type: string + enum: + - IMS_VOICE_OVER_PS_NOT_SUPPORTED + - IMS_VOICE_OVER_PS_SUPPORTED + - IMS_VOICE_OVER_PS_SUPPORT_UNKNOWN + - type: string + +DetectingNode: + description: Represents the type of serving node that detected the reachability of the UE + anyOf: + - type: string + enum: + - SGSN + - MME + - AMF + - type: string + +AccessType: + description: Represents the type of access (3GPP or non-3GPP) + anyOf: + - type: string + enum: + - 3GPP_ACCESS + - NON_3GPP_ACCESS + - type: string + +UserStatePs: + description: Represents the user state in PS domain + anyOf: + - type: string + enum: + - DETACHED + - ATTACHED_NOT_REACHABLE_FOR_PAGING + - ATTACHED_REACHABLE_FOR_PAGING + - CONNECTED_NOT_REACHABLE_FOR_PAGING + - CONNECTED_REACHABLE_FOR_PAGING + - NOT_PROVIDED_FROM_SGSN_OR_MME_OR_AMF + - NETWORK_DETERMINED_NOT_REACHABLE + - type: string + +UserStateCs: + description: Represents the user state in CS domain + anyOf: +``` + +``` + +- type: string +enum: +- CAMEL_BUSY +- NETWORK_DETERMINED_NOT_REACHABLE +- ASSUMED_IDLE +- NOT_PROVIDED_FROM_VLR +- type: string + +DataSetName: +description: A set of data within the IMS User Profile +anyOf: +- type: string +enum: +- CHARGING_DATA +- IFC_DATA +- TRACE_DATA +- PRIORITY_DATA +- type: string + +``` + +## A.4 Nhss\_imsUEAU API + +``` + +openapi: 3.0.0 + +info: + version: '1.2.0-alpha.1' + title: 'Nhss_imsUEAU' + description: | + Nhss UE Authentication Service for IMS. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.562 Home Subscriber Server (HSS) Services, version 18.0.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.562/' + +servers: +- url: '{apiRoot}/nhss-ims-ueau/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: +- {} +- oAuth2ClientCredentials: +- nhss-ims-ueau + +paths: + + /{impi}/security-information/generate-sip-auth-data: + post: + summary: Generate authentication data for the UE based on the Auth-Scheme provided + operationId: GenerateSipAuthData + tags: + - Generate SIP Auth Data (Custom Operation) + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-ueau + - oAuth2ClientCredentials: + - nhss-ims-ueau + - nhss-ims-ueau:generate-sip-auth-data:invoke + parameters: + - name: impi + in: path + description: IMS Private Identity for the UE (IMPI) + required: true + schema: + $ref: '#/components/schemas/Impi' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SipAuthenticationInfoRequest' + +``` + +``` + + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SipAuthenticationInfoResult' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-ims-ueau: Access to the Nhss IMS UE Authentication API + nhss-ims-ueau:generate-sip-auth-data:invoke: > + Access to invoke the Generate SIP Auth Data custom operation + + schemas: + +# +# COMPLEX TYPES: +# + + SipAuthenticationInfoRequest: + description: > + Contains input data to the SIP authentication request message (e.g. SIP authentication + scheme, requested number of authentication items, resynchronization information) + type: object + required: + - cscfServerName + - sipAuthenticationScheme + properties: + cscfServerName: + type: string + sipAuthenticationScheme: + $ref: '#/components/schemas/SipAuthenticationScheme' + sipNumberAuthItems: + $ref: '#/components/schemas/SipNumberAuthItems' + resynchronizationInfo: + +``` + +``` +$ref: '#/components/schemas/ResynchronizationInfo' + +ResynchronizationInfo: + description: Contains RAND and AUTS + type: object + required: + - rand + - auts + properties: + rand: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Rand' + auts: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Auts' + +SipAuthenticationInfoResult: + description: > + Contains authentication information returned in the SIP authentication response message + (e.g. authentication vectors, digest authentication parameters, line identifiers) + type: object + required: + - impi + properties: + impi: + $ref: '#/components/schemas/Impi' + 3gAkaAvs: + type: array + items: + $ref: '#/components/schemas/3GAkaAv' + minItems: 1 + digestAuth: + $ref: '#/components/schemas/DigestAuthentication' + lineIdentifierList: + type: array + items: + $ref: '#/components/schemas/LineIdentifier' + minItems: 1 + ipAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + +3GAkaAv: + description: Contains RAND, XRES, AUTN, CK, and IK + type: object + required: + - rand + - xres + - autn + - ck + - ik + properties: + rand: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Rand' + xres: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Xres' + autn: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Autn' + ck: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ConfidentialityKey' + ik: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/IntegrityKey' + +DigestAuthentication: + description: Parameters used for the Digest authentication scheme + type: object + required: + - digestRealm + - digestAlgorithm + - digestQop + - hal + properties: + digestRealm: + type: string + digestAlgorithm: + $ref: '#/components/schemas/SipDigestAlgorithm' + digestQop: + $ref: '#/components/schemas/SipDigestQop' + hal: + type: string +``` + +``` + +# +# SIMPLE TYPES: +# + +SipNumberAuthItems: + description: Indicates the number of requested SIP authentication items + type: integer + minimum: 1 + +Impi: + description: IMS Private Identity of the UE + type: string + +LineIdentifier: + description: Line Identifier for the wireline access + type: string + +# +# ENUMS: +# + +SipAuthenticationScheme: + description: Authentication scheme to be used in the SIP authentication request message + anyOf: + - type: string + enum: + - DIGEST-AKAV1-MD5 + - DIGEST-HTTP + - NBA + - GIBA + - UNKNOWN + - type: string + +SipDigestAlgorithm: + description: Algorithm used for the SIP Digest authentication scheme + anyOf: + - type: string + enum: + - MD5 + - MD5_SESS + - type: string + +SipDigestQop: + description: Quality of Protection for the SIP Digest authentication scheme + anyOf: + - type: string + enum: + - AUTH + - AUTH_INT + - type: string + +``` + +## A.5 Nhss\_gbaSDM API + +``` + +openapi: 3.0.0 + +info: + version: '1.1.0-alpha.1' + title: 'Nhss_gbaSDM' + description: | + Nhss Subscriber Data Management Service for GBA. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.562 Home Subscriber Server (HSS) Services, version 18.0.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.562/' + +servers: + - url: '{apiRoot}/nhss-gba-sdm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + +``` + +``` +- {} +- oAuth2ClientCredentials: + - nhss-gba-sdm + +paths: + /{ueId}/subscriber-data: + get: + summary: Retrieve the subscriber data of a user + operationId: GetSubscriberData + tags: + - Subscriber Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nhss-gba-sdm + - oAuth2ClientCredentials: + - nhss-gba-sdm + - nhss-gba-sdm:subscriber-data:read + parameters: + - name: ueId + in: path + description: UE Identity + required: true + schema: + $ref: '#/components/schemas/UeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/GbaSubscriberData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /{ueId}/subscriptions: + post: + summary: Subscribe to notifications + operationId: GbaSdmSubscribe + tags: + - GBA SDM Subscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nhss-gba-sdm + - oAuth2ClientCredentials: + - nhss-gba-sdm + - nhss-gba-sdm:subscriptions:create + parameters: +``` + +``` + +- name: ueId + in: path + description: UE Identity + required: true + schema: + $ref: '#/components/schemas/UEId' +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GbaSdmSubscription' + required: true +responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/GbaSdmSubscription' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-gba-sdm/{apiVersion}/{ueId}/subscriptions/{subscriptionId} + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + datachangeNotification: + '{request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ModificationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + +``` + +``` + + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{ueId}/subscriptions/{subscriptionId}: + delete: + summary: Unsubscribe from notifications + operationId: GbaSdmUnsubscribe + tags: + - GBA SDM Subscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nhss-gba-sdm + - oAuth2ClientCredentials: + - nhss-gba-sdm + - nhss-gba-sdm:subscription:modify + parameters: + - name: ueId + in: path + description: UE Identity + required: true + schema: + $ref: '#/components/schemas/UeId' + - name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string + responses: + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + patch: + summary: Modify the subscription + operationId: GbaSdmSubsModify + tags: + - GBA SDM Subscription (Document) + +``` + +``` +security: +- {} +- oAuth2ClientCredentials: +- nhss-gba-sdm +- oAuth2ClientCredentials: +- nhss-gba-sdm +- nhss-gba-sdm:subscription:modify +parameters: +- name: ueId + in: path + description: UE Identity + required: true + schema: + $ref: '#/components/schemas/UEId' +- name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string +- name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +requestBody: +content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true +responses: +'200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' +'204': + description: Successful modification +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + +securitySchemes: +oAuth2ClientCredentials: +type: oauth2 +flows: +``` + +``` + +clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-gba-sdm: Access to the Nhss GBA Subscription Data Management API + nhss-gba-sdm:subscriber-data:read: Access to read the GBA Subscriber Data resource + nhss-gba-sdm:subscriptions:create: Access to create Subscriptions resources + nhss-gba-sdm:subscription:modify: Access to update/delete a Subscription resource + +schemas: + +# +# COMPLEX TYPES: +# + +GbaSubscriberData: + description: > + GBA subscriber data of the UE; it includes the GBA User Security Settings (GUSS) data + type: object + properties: + guss: + $ref: '#/components/schemas/Guss' + +Guss: + description: > + GBA User Security Settings of the UE; it includes information about the BSF, + and a list of User Security Settings + type: object + properties: + bsfInfo: + $ref: '#/components/schemas/BsfInfo' + ussList: + type: array + items: + $ref: 'TS29309_Nbsp_GBA.yaml#/components/schemas/UssListItem' + minItems: 1 + +BsfInfo: + description: > + Information about the BSF; it includes an indication of whether GBA or GBA_U is to be used, + the key lifetime and a user-specific list of security features + type: object + properties: + uiccType: + $ref: '#/components/schemas/UiccType' + lifeTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + securityFeatures: + type: array + items: + $ref: 'TS29309_Nbsp_GBA.yaml#/components/schemas/SecFeature' + minItems: 1 + +GbaSdmSubscription: + description: > + Information about a subscription created in the HSS, so the consumer (e.g. BSF) can be + notified when there are changes on the monitored data + type: object + required: + - nfInstanceId + - callbackReference + - monitoredResourceUris + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + callbackReference: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + monitoredResourceUris: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + expires: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +# +# SIMPLE TYPES: +# + +``` + +``` + +UeId: + description: UE ID can be MSISDN, IMSI, IMPI or IMPU + anyOf: + - $ref: '#/components/schemas/Msisdn' + - $ref: '#/components/schemas/Imsi' + - $ref: 'TS29562_Nhss_imsSDM.yaml#/components/schemas/ImsUEId' + +Msisdn: + description: MS-ISDN of the UE + type: string + pattern: '^msisdn-[0-9]{5,15}$' + +Imsi: + description: IMSI of the UE + type: string + pattern: '^imsi-[0-9]{5,15}$' + +# +# ENUMS: +# + +UiccType: + description: Indicates whether GBA or GBA_U is to be used + anyOf: + - type: string + enum: + - GBA + - GBA_U + - type: string + +``` + +## A.6 Nhss\_gbaUEAU API + +``` + +openapi: 3.0.0 + +info: + version: '1.1.0-alpha.1' + title: 'Nhss_gbaUEAU' + description: | + Nhss UE Authentication Service for GBA. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.562 Home Subscriber Server (HSS) Services, version 18.0.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.562/' + +servers: + - url: '{apiRoot}/nhss-gba-ueau/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - oAuth2ClientCredentials: + - nhss-gba-ueau + - {} + +paths: + /{ueId}/security-information/generate-auth-data: + post: + summary: Generate GBA authentication data for the UE + operationId: GenerateAuthData + tags: + - Generate Auth Data (Custom Operation) + security: + - {} + - oAuth2ClientCredentials: + - nhss-gba-ueau + - oAuth2ClientCredentials: + - nhss-gba-ueau + - nhss-gba-ueau:generate-auth-data:invoke + parameters: + - name: ueId + in: path + +``` + +``` + description: UE identity of the user + required: true + schema: + $ref: '#/components/schemas/UEId' +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthenticationInfoRequest' + required: true +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/AuthenticationInfoResult' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-gba-ueau: Access to the nhss-gba-ueau API + nhss-gba-ueau:generate-auth-data:invoke: > + Access to invoke the Generate Auth Data custom operation + +schemas: + +# +# COMPLEX TYPES: +# + +AuthenticationInfoRequest: + description: > + Contains input data to the authentication request message (e.g. authentication + scheme, resynchronization information) + type: object + properties: + authenticationScheme: + $ref: '#/components/schemas/AuthenticationScheme' + resynchronizationInfo: + $ref: 'TS29562_Nhss_imsUEAU.yaml#/components/schemas/ResynchronizationInfo' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +``` + +``` +AuthenticationInfoResult: + description: > + Contains authentication information returned in the authentication response message + (e.g. authentication vector, digest authentication parameters) + type: object + properties: + impi: + $ref: '#/components/schemas/Impi' + 3gAkaAv: + $ref: 'TS29562_Nhss_imsUEAU.yaml#/components/schemas/3GAkaAv' + digestAuth: + $ref: '#/components/schemas/DigestAuthentication' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +DigestAuthentication: + description: Parameters used for the Digest authentication scheme + type: object + required: + - digestRealm + - digestAlgorithm + - digestQop + - hal + properties: + digestRealm: + type: string + digestAlgorithm: + $ref: '#/components/schemas/DigestAlgorithm' + digestQop: + $ref: '#/components/schemas/DigestQop' + hal: + type: string + +# +# SIMPLE TYPES: +# + +UeId: + $ref: 'TS29562_Nhss_gbaSDM.yaml#/components/schemas/UeId' + +Impi: + description: IMS Private Identity of the UE + type: string + +# +# ENUMS: +# + +AuthenticationScheme: + description: Authentication scheme to be used in the authentication request message + anyOf: + - type: string + enum: + - DIGEST_AKAV1_MD5 + - DIGEST_HTTP + - type: string + +DigestAlgorithm: + description: Algorithm used for the Digest authentication scheme + anyOf: + - type: string + enum: + - MD5 + - MD5_SESS + - type: string + +DigestQop: + description: Quality of Protection for the Digest authentication scheme + anyOf: + - type: string + enum: + - AUTH + - AUTH_INT + - type: string +``` + +--- + +## Annex B (informative): Withdrawn API versions + +### B.1 General + +This Annex lists withdrawn API versions of the APIs defined in the present specification. 3GPP TS 29.501 [5] clause 4.3.1.6 describes the withdrawal of API versions. + +--- + +## Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-09 | CT4#93 | C4-193851 | | | | Initial Draft (C4-193264) and incorporation of agreed pCRs at CT4#93: C4-193576, C4-193272, C4-193273, C4-193579, C4-193706, C4-193838. | 0.1.0 | +| 2019-10 | CT4#94 | C4-194525 | | | | Incorporation of agreed pCRs at CT4#94: C4-194361, C4-194362, C4-194364, C4-194365, C4-194556 | 0.2.0 | +| 2019-11 | CT4#95 | C4-195640 | | | | Incorporation of agreed pCRs at CT4#95: C4-195468, C4-195469, C4-195475, C4-195478, C4-195583, C4-195650 | 0.3.0 | +| 2020-03 | CT4#96 | C4-201270 | | | | Incorporation of agreed pCRs at CT4#96: C4-200572, C4-200578, C4-200582, C4-200803, C4-200804, C4-200927, C4-200929, C4-200963, C4-200977, C4-201098, C4-201104, C4-201105, C4-201106, C4-201107, C4-201108, C4-201109, C4-201110, C4-201111, C4-201112, C4-201113, C4-201114, C4-201115, C4-201116 | 0.4.0 | +| 2020-03 | CT#87 | CP-200064 | | | | TS presented for information and approval | 1.0.0 | +| 2020-03 | CT#87 | | | | | Approved at CT#87 | 16.0.0 | +| 2020-07 | CT#88 | CP-201038 | 0001 | - | B | IMEISV retrieval | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0002 | - | B | IP address retrieval | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0003 | - | B | T-ADS info retrieval | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0004 | - | B | UE Reachability subscription | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0005 | - | B | User State retrieval | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0006 | - | B | Storage of YAML files in ETSI Forge | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0007 | - | B | Resource-Level Authorization | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0008 | - | F | Common data structures in the response body | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0009 | - | B | CSRN retrieval | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0010 | 1 | B | Wireline domain info retrieval | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0011 | - | B | SDM SMS Registration Info | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0012 | 1 | F | Miscellaneous corrections | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0013 | 1 | F | IMS restoration amendments | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0014 | 1 | F | Support of Multiple Registration | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0015 | 2 | F | IMS Identity Data Retrieval amendments | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0016 | - | F | SDM Wireline-domain Line-Id Removal | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0017 | 1 | B | SDM - DSAI handling | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0018 | 1 | F | Cleanup of TS | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0019 | - | F | Miscellaneous Corrections | 16.1.0 | +| 2020-07 | CT#88 | CP-201073 | 0020 | - | F | 29.562 Rel-16 API version and External doc update | 16.1.0 | +| 2020-09 | CT#89 | CP-202118 | 0021 | - | F | P-CSCF Restoration | 16.2.0 | +| 2020-09 | CT#89 | CP-202118 | 0022 | - | F | Missing Resource Scopes | 16.2.0 | +| 2020-09 | CT#89 | CP-202118 | 0023 | 1 | F | IMS restoration amendments II | 16.2.0 | +| 2020-09 | CT#89 | CP-202118 | 0024 | - | F | Miscellaneous Corrections | 16.2.0 | +| 2020-09 | CT#89 | CP-202096 | 0025 | - | F | 29.562 Rel-16 API version and External doc update | 16.2.0 | +| 2020-12 | | | | | | Corrupted figures fixed | 16.2.1 | +| 2020-12 | CT#90 | CP-203053 | 0027 | - | F | Storage of YAML files in 3GPP Forge | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0028 | - | F | RAT type retrieval | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0029 | - | F | Resource ImsServerNameAndCapabilities | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0030 | - | F | S-CSCF Restoration | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0031 | 1 | F | S-CSCF Selection | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0032 | - | F | S-CSCF name | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0033 | - | F | Text alignment with yaml definitions | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0034 | - | F | Type name alignments | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0035 | - | F | UE-Reachability subscription | 16.3.0 | +| 2020-12 | CT#90 | CP-203066 | 0039 | 1 | F | Private identities | 16.3.0 | +| 2020-12 | CT#90 | CP-203067 | 0040 | 1 | F | Authorization Response | 16.3.0 | +| 2020-12 | CT#90 | CP-203036 | 0041 | - | F | 29.562 Rel-16 API version and External doc update | 16.3.0 | +| 2021-03 | CT#91 | CP-210038 | 0044 | - | F | Authorization Response | 16.4.0 | +| 2021-03 | CT#91 | CP-210054 | 0047 | - | F | 29.562 Rel-16 API version and External doc update | 16.4.0 | +| 2021-03 | CT#91 | CP-210023 | 0045 | - | F | Title and Scope of TS 29.562 | 17.0.0 | +| 2021-06 | CT#92 | CP-211060 | 0049 | 1 | A | Alias Group Id | 17.1.0 | +| 2021-06 | CT#92 | CP-211060 | 0051 | 2 | A | IMSI retrieval | 17.1.0 | +| 2021-06 | CT#92 | CP-211060 | 0054 | 1 | A | Charging Information retrieval | 17.1.0 | +| 2021-06 | CT#92 | CP-211060 | 0056 | - | A | Shared IMPU | 17.1.0 | +| 2021-06 | CT#92 | CP-211028 | 0057 | - | F | OpenAPI Reference | 17.1.0 | +| 2021-06 | CT#92 | CP-211060 | 0059 | - | A | S-CSCF reselection in eIMS | 17.1.0 | +| 2021-06 | CT#92 | CP-211060 | 0061 | - | A | CSRN retrieval | 17.1.0 | +| 2021-06 | CT#92 | CP-211059 | 0063 | - | A | Redirect Responses | 17.1.0 | +| 2021-06 | CT#92 | CP-211060 | 0064 | 1 | A | Correction to schema of requested-nodes | 17.1.0 | +| 2021-06 | CT#92 | CP-211060 | 0065 | - | A | DSAI resource query parameters | 17.1.0 | +| 2021-06 | CT#92 | CP-211060 | 0066 | - | A | Initial Filter Criteria resource query parameter | 17.1.0 | +| 2021-06 | CT#92 | CP-211170 | 0067 | 1 | A | Correction to IMS User Profile | 17.1.0 | +| 2021-06 | CT#92 | CP-211050 | 0073 | - | F | 29.562 Rel-17 API version and External doc update | 17.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------|--------| +| 2021-09 | CT#93 | CP-212066 | 0053 | 1 | A | Query parameter name alignment | 17.2.0 | +| 2021-09 | CT#93 | CP-212066 | 0078 | - | A | imsUeld pattern | 17.2.0 | +| 2021-09 | CT#93 | CP-212026 | 0079 | 1 | F | Patch alignment | 17.2.0 | +| 2021-09 | CT#93 | CP-212183 | 0080 | 2 | F | Retrieval of multiple Repository Data | 17.2.0 | +| 2021-09 | CT#93 | CP-212066 | 0082 | - | A | RequestedNodes data type definition | 17.2.0 | +| 2021-09 | CT#93 | CP-212066 | 0084 | 1 | F | S-CSCF Restoration Information Retrieval | 17.2.0 | +| 2021-09 | CT#93 | CP-212059 | 0086 | - | F | 29.562 Rel-17 API version and External doc update | 17.2.0 | +| 2021-09 | CT#93 | CP-212066 | 0088 | 1 | A | Correction to shared IMPU | 17.2.0 | +| 2021-12 | CT#94 | CP-213091 | 0090 | 3 | B | HSS GBA SBI Services Definition | 17.3.0 | +| 2021-12 | CT#94 | CP-213132 | 0092 | - | A | Monitored resource URI | 17.3.0 | +| 2021-12 | CT#94 | CP-213132 | 0094 | - | A | Supported Feature | 17.3.0 | +| 2021-12 | CT#94 | CP-213091 | 0095 | 1 | B | HSS GBA SDM API Definition | 17.3.0 | +| 2021-12 | CT#94 | CP-213091 | 0096 | 1 | B | HSS GBA UEAU API Definition | 17.3.0 | +| 2021-12 | CT#94 | CP-213121 | 0097 | - | F | 29.562 Rel-17 API version and External doc update | 17.3.0 | +| 2022-03 | CT#95 | CP-220023 | 0099 | - | F | Wrong Oauth2 scope name | 17.4.0 | +| 2022-03 | CT#95 | CP-220029 | 0100 | 1 | F | User Identifier Pattern | 17.4.0 | +| 2022-03 | CT#95 | CP-220066 | 0101 | - | F | 29.562 Rel-17 API version and External doc update | 17.4.0 | +| 2022-06 | CT#96 | CP-221094 | 0103 | 1 | F | Missing Description Fields and Additional Corrections | 17.5.0 | +| 2022-06 | CT#96 | CP-221058 | 0104 | - | F | Corrections to the Nhss_imsUEAU API | 17.5.0 | +| 2022-06 | CT#96 | CP-221058 | 0105 | 1 | F | Corrections to the Nhss_imsUECM API | 17.5.0 | +| 2022-06 | CT#96 | CP-221028 | 0106 | - | F | RestorationInfoDelete clarification | 17.5.0 | +| 2022-06 | CT#96 | CP-221029 | 0107 | 1 | F | Corrections Nhss_imsSDM API | 17.5.0 | +| 2022-06 | CT#96 | CP-221051 | 0108 | - | F | 29.562 Rel-17 API version and External doc update | 17.5.0 | +| 2022-09 | CT#97 | CP-222027 | 0109 | 1 | B | Add SBI support Indication for IP-SM-GW in HSS | 17.6.0 | +| 2022-09 | CT#97 | CP-222060 | 0111 | - | A | Obvious yaml error correction | 17.6.0 | +| 2022-09 | CT#97 | CP-222026 | 0112 | - | F | Charging Info retrieval | 17.6.0 | +| 2022-09 | CT#97 | CP-222026 | 0113 | - | F | Core Network Service Authorization | 17.6.0 | +| 2022-09 | CT#97 | CP-222026 | 0114 | - | F | IMS User Profile Retrieval | 17.6.0 | +| 2022-09 | CT#97 | CP-222026 | 0116 | - | F | ImsProfileData | 17.6.0 | +| 2022-09 | CT#97 | CP-222026 | 0117 | - | F | IMS ServicePriority Level | 17.6.0 | +| 2022-09 | CT#97 | CP-222026 | 0118 | - | F | 403 Forbidden | 17.6.0 | +| 2022-09 | CT#97 | CP-222060 | 0120 | - | A | CsLocation | 17.6.0 | +| 2022-09 | CT#97 | CP-222060 | 0122 | - | A | CallReferenceInfo | 17.6.0 | +| 2022-09 | CT#97 | CP-222058 | 0123 | - | F | 29.562 Rel-17 API version and External doc update | 17.6.0 | +| 2022-12 | CT#98 | CP-223028 | 0125 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98 | CP-223033 | 0127 | - | F | 29.562 Rel-18 API version and External doc update | 18.0.0 | +| 2023-06 | CT#100 | CP-231027 | 0128 | 4 | F | Location header and missing Redirection clause | 18.1.0 | +| 2023-09 | CT#101 | CP-232045 | 0130 | - | B | Add DCSF as service consumer | 18.2.0 | +| 2023-09 | CT#101 | CP-232063 | 0132 | - | A | Add Location description for 201 response | 18.2.0 | +| 2023-09 | CT#101 | CP-232063 | 0134 | 1 | A | Update OpenAPI for Scscf Registration and Scscf Restoration Information Resource URI | 18.2.0 | +| 2023-09 | CT#101 | CP-232060 | 0135 | - | F | 29.562 Rel-18 API version and External doc update | 18.2.0 | +| 2023-12 | CT#102 | CP-233029 | 0137 | 1 | B | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.3.0 | +| 2023-12 | CT#102 | CP-233029 | 0138 | 1 | B | ProblemDetails RFC 7807 obsoleted by 9457 | 18.3.0 | +| 2023-12 | CT#102 | CP-233048 | 0139 | 1 | B | Update the procedure to support DCSF get and update the repository data | 18.3.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29563/raw.md b/marked/Rel-18/29_series/29563/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..cf2ad524d46f3d9b4f2844b54860d9488b862103 --- /dev/null +++ b/marked/Rel-18/29_series/29563/raw.md @@ -0,0 +1,4417 @@ + + +# 3GPP TS 29.563 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Home Subscriber Server (HSS) services for interworking with Unified Data Management (UDM); Stage 3; (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- ***Copyright Notification*** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------------------------------|----| +| Foreword ..... | 8 | +| 1 Scope..... | 9 | +| 2 References..... | 9 | +| 3 Definitions of terms, symbols and abbreviations..... | 10 | +| 3.1 Terms..... | 10 | +| 3.2 Symbols..... | 10 | +| 3.3 Abbreviations ..... | 10 | +| 4 Overview..... | 10 | +| 4.1 Introduction ..... | 10 | +| 5 Services offered by the HSS ..... | 11 | +| 5.1 Introduction ..... | 11 | +| 5.2 Nhss_UEAuthentication Service..... | 11 | +| 5.2.1 Service Description ..... | 11 | +| 5.2.2 Service Operations..... | 11 | +| 5.2.2.1 Introduction..... | 11 | +| 5.2.2.2 Get..... | 12 | +| 5.2.2.2.1 General ..... | 12 | +| 5.2.2.2.2 Authentication Vector Retrieval..... | 12 | +| 5.3 Nhss_SubscriberDataManagement Service ..... | 12 | +| 5.3.1 Service Description ..... | 12 | +| 5.3.2 Service Operations..... | 13 | +| 5.3.2.1 Introduction..... | 13 | +| 5.3.2.2 Get..... | 13 | +| 5.3.2.2.1 General ..... | 13 | +| 5.3.2.2.2 UE Context In PGW Data Retrieval ..... | 13 | +| 5.3.2.3 Subscribe..... | 14 | +| 5.3.2.3.1 General ..... | 14 | +| 5.3.2.3.2 Subscription to notifications of data change ..... | 14 | +| 5.3.2.4 Unsubscribe ..... | 15 | +| 5.3.2.4.1 General ..... | 15 | +| 5.3.2.4.2 Unsubscribe to notifications of data change ..... | 15 | +| 5.3.2.5 Notification ..... | 15 | +| 5.3.2.5.1 General ..... | 15 | +| 5.3.2.5.2 Data Change Notification To NF ..... | 15 | +| 5.3.2.6 ModifySubscription ..... | 16 | +| 5.3.2.6.1 General ..... | 16 | +| 5.3.2.6.2 Modification of a subscription to notifications of data change..... | 16 | +| 5.4 Nhss_UEContextManagement Service..... | 17 | +| 5.4.1 Service Description ..... | 17 | +| 5.4.2 Service Operations..... | 17 | +| 5.4.2.1 Introduction..... | 17 | +| 5.4.2.2 SnDeregistration ..... | 17 | +| 5.4.2.2.1 General ..... | 17 | +| 5.4.2.2.2 SN Deregistration..... | 17 | +| 5.4.2.3 IMEI Update ..... | 18 | +| 5.4.2.4 Roaming Status Update ..... | 19 | +| 5.5 Nhss_EventExposure Service ..... | 19 | +| 5.5.1 Service Description ..... | 19 | +| 5.5.2 Service Operations..... | 19 | +| 5.5.2.1 Introduction..... | 19 | +| 5.5.2.2 Subscribe..... | 20 | +| 5.5.2.2.1 General ..... | 20 | +| 5.5.2.2.2 Subscription to Notification of event occurrence..... | 20 | +| 5.5.2.3 Unsubscribe ..... | 21 | + +| | | | +|-----------|--------------------------------------------------------|----| +| 5.5.2.3.1 | General ..... | 21 | +| 5.5.2.3.2 | Unsubscribe to notifications of event occurrence ..... | 21 | +| 5.5.2.4 | Notify ..... | 22 | +| 5.5.2.4.1 | General ..... | 22 | +| 5.5.2.4.2 | Event Occurrence Notification..... | 22 | +| 5.5.2.5 | ModifySubscription ..... | 22 | +| 5.5.2.5.1 | General ..... | 22 | +| 5.5.2.5.2 | Modification of a subscription ..... | 22 | +| 6 | API Definitions ..... | 23 | +| 6.1 | Nhss_UEAuthentication Service API ..... | 23 | +| 6.1.1 | Introduction ..... | 23 | +| 6.1.2 | Usage of HTTP..... | 24 | +| 6.1.2.1 | General..... | 24 | +| 6.1.2.2 | HTTP standard headers..... | 24 | +| 6.1.2.2.1 | General ..... | 24 | +| 6.1.2.2.2 | Content type ..... | 24 | +| 6.1.2.3 | HTTP custom headers..... | 24 | +| 6.1.2.3.1 | General ..... | 24 | +| 6.1.3 | Resources..... | 24 | +| 6.1.3.1 | Overview..... | 24 | +| 6.1.4 | Custom Operations without associated resources ..... | 25 | +| 6.1.4.1 | Overview..... | 25 | +| 6.1.4.2 | Operation: Generate AV ..... | 25 | +| 6.1.4.2.1 | Description ..... | 25 | +| 6.1.4.2.2 | Operation Definition ..... | 25 | +| 6.1.5 | Notifications ..... | 26 | +| 6.1.6 | Data Model ..... | 26 | +| 6.1.6.1 | General..... | 26 | +| 6.1.6.2 | Structured data types..... | 27 | +| 6.1.6.2.1 | Introduction ..... | 27 | +| 6.1.6.2.2 | Type: AvGenerationRequest..... | 27 | +| 6.1.6.2.3 | Type: AvGenerationResponse..... | 27 | +| 6.1.6.3 | Simple data types and enumerations..... | 27 | +| 6.1.6.3.1 | Introduction ..... | 27 | +| 6.1.6.3.2 | Simple data types ..... | 27 | +| 6.1.7 | Error Handling ..... | 27 | +| 6.1.7.1 | General..... | 27 | +| 6.1.7.2 | Protocol Errors ..... | 27 | +| 6.1.7.3 | Application Errors..... | 28 | +| 6.1.8 | Feature negotiation ..... | 28 | +| 6.1.9 | Security..... | 28 | +| 6.1.10 | HTTP redirection..... | 28 | +| 6.2 | Nhss_SubscriberDataManagement Service API..... | 28 | +| 6.2.1 | API URI..... | 28 | +| 6.2.2 | Usage of HTTP..... | 29 | +| 6.2.2.1 | General..... | 29 | +| 6.2.2.2 | HTTP standard headers..... | 29 | +| 6.2.2.2.1 | General ..... | 29 | +| 6.2.2.2.2 | Content type ..... | 29 | +| 6.2.2.3 | HTTP custom headers..... | 29 | +| 6.2.2.3.1 | General ..... | 29 | +| 6.2.3 | Resources..... | 30 | +| 6.2.3.1 | Overview..... | 30 | +| 6.2.3.2 | Resource: UeContextInPgwData ..... | 30 | +| 6.2.3.2.1 | Description ..... | 30 | +| 6.2.3.2.2 | Resource Definition..... | 30 | +| 6.2.3.2.3 | Resource Standard Methods..... | 31 | +| 6.2.3.3 | Resource: Subscriptions..... | 32 | +| 6.2.3.3.1 | Description ..... | 32 | +| 6.2.3.3.2 | Resource Definition..... | 32 | +| 6.2.3.3.3 | Resource Standard Methods..... | 32 | + +| | | | +|-----------|------------------------------------------------------|----| +| 6.2.3.4 | Resource: Individual subscription ..... | 33 | +| 6.2.3.4.1 | Description ..... | 33 | +| 6.2.3.4.2 | Resource Definition..... | 33 | +| 6.2.3.4.3 | Resource Standard Methods..... | 34 | +| 6.2.4 | Custom Operations without associated resources ..... | 36 | +| 6.2.5 | Notifications ..... | 36 | +| 6.2.5.1 | General..... | 36 | +| 6.2.5.2 | Data Change Notification ..... | 36 | +| 6.2.6 | Data Model ..... | 37 | +| 6.2.6.1 | General..... | 37 | +| 6.2.6.2 | Structured data types..... | 38 | +| 6.2.6.2.1 | Introduction ..... | 38 | +| 6.2.6.2.2 | Type: UeContextInPgwData ..... | 38 | +| 6.2.6.2.3 | Type: SubscriptionData..... | 39 | +| 6.2.6.2.4 | Type: SubscriptionDataSets ..... | 39 | +| 6.2.6.3 | Simple data types and enumerations..... | 39 | +| 6.2.6.3.1 | Introduction ..... | 39 | +| 6.2.6.3.2 | Simple data types ..... | 39 | +| 6.2.7 | Error Handling ..... | 40 | +| 6.2.7.1 | General..... | 40 | +| 6.2.7.2 | Protocol Errors ..... | 40 | +| 6.2.7.3 | Application Errors..... | 40 | +| 6.2.8 | Feature Negotiation ..... | 40 | +| 6.2.9 | Security ..... | 40 | +| 6.2.10 | HTTP redirection..... | 40 | +| 6.3 | Nhss_UEContextManagement Service API..... | 41 | +| 6.3.1 | Introduction ..... | 41 | +| 6.3.2 | Usage of HTTP..... | 41 | +| 6.3.2.1 | General..... | 41 | +| 6.3.2.2 | HTTP standard headers..... | 41 | +| 6.3.2.2.1 | General ..... | 41 | +| 6.3.2.2.2 | Content type ..... | 41 | +| 6.3.2.3 | HTTP custom headers..... | 41 | +| 6.3.2.3.1 | General ..... | 41 | +| 6.3.3 | Resources..... | 42 | +| 6.3.3.1 | Overview..... | 42 | +| 6.3.4 | Custom Operations without associated resources ..... | 42 | +| 6.3.4.1 | Overview..... | 42 | +| 6.3.4.2 | Operation: deregister-sn..... | 42 | +| 6.3.4.2.1 | Description ..... | 42 | +| 6.3.4.2.2 | Operation Definition ..... | 42 | +| 6.3.4.3 | Operation: imei-update ..... | 43 | +| 6.3.4.3.1 | Description ..... | 43 | +| 6.3.4.3.2 | Operation Definition ..... | 43 | +| 6.3.4.4 | Operation: roaming-status-update..... | 44 | +| 6.3.4.4.1 | Description ..... | 44 | +| 6.3.4.4.2 | Operation Definition ..... | 44 | +| 6.3.5 | Notifications ..... | 45 | +| 6.3.6 | Data Model ..... | 45 | +| 6.3.6.1 | General..... | 45 | +| 6.3.6.2 | Structured data types..... | 46 | +| 6.3.6.2.1 | Introduction ..... | 46 | +| 6.3.6.2.2 | Type: DeregistrationRequest..... | 46 | +| 6.3.6.2.3 | Type: ImeiUpdateInfo..... | 46 | +| 6.3.6.2.4 | Type: ImeiUpdateResponse ..... | 47 | +| 6.3.6.2.5 | Type: RoamingStatusUpdateInfo ..... | 47 | +| 6.3.6.3 | Simple data types and enumerations..... | 47 | +| 6.3.6.3.1 | Introduction ..... | 47 | +| 6.3.6.3.2 | Simple data types ..... | 47 | +| 6.3.6.3.3 | Enumeration: DeregistrationReason ..... | 48 | +| 6.3.7 | Error Handling ..... | 48 | +| 6.3.7.1 | General..... | 48 | + +| | | | +|------------|------------------------------------------------------|----| +| 6.3.7.2 | Protocol Errors ..... | 48 | +| 6.3.7.3 | Application Errors..... | 48 | +| 6.3.8 | Feature Negotiation ..... | 48 | +| 6.3.9 | Security ..... | 49 | +| 6.3.10 | HTTP redirection..... | 49 | +| 6.4 | Nhss_EventExposure Service API ..... | 49 | +| 6.4.1 | API URI ..... | 49 | +| 6.4.2 | Usage of HTTP..... | 49 | +| 6.4.2.1 | General ..... | 49 | +| 6.4.2.2 | HTTP standard headers..... | 49 | +| 6.4.2.2.1 | General ..... | 49 | +| 6.4.2.2.2 | Content type ..... | 50 | +| 6.4.2.3 | HTTP custom headers..... | 50 | +| 6.4.2.3.1 | General ..... | 50 | +| 6.4.3 | Resources..... | 50 | +| 6.4.3.1 | Overview..... | 50 | +| 6.4.3.2 | Resource: EeSubscriptions (Collection) ..... | 51 | +| 6.4.3.2.1 | Description ..... | 51 | +| 6.4.3.2.2 | Resource Definition..... | 51 | +| 6.4.3.2.3 | Resource Standard Methods..... | 51 | +| 6.4.3.3 | Resource: Individual subscription (Document) ..... | 52 | +| 6.4.3.3.1 | Resource Definition..... | 52 | +| 6.4.3.3.2 | Resource Standard Methods..... | 53 | +| 6.4.4 | Custom Operations without associated resources ..... | 55 | +| 6.4.5 | Notifications ..... | 55 | +| 6.4.5.1 | General..... | 55 | +| 6.4.5.2 | Event Occurrence Notification ..... | 56 | +| 6.4.6 | Data Model ..... | 57 | +| 6.4.6.1 | General ..... | 57 | +| 6.4.6.2 | Structured data types..... | 57 | +| 6.4.6.2.1 | Introduction ..... | 57 | +| 6.4.6.2.2 | Type: EeSubscription ..... | 58 | +| 6.4.6.2.3 | Type: CreatedEeSubscription..... | 59 | +| 6.4.6.2.4 | Type: MonitoringConfiguration ..... | 60 | +| 6.4.6.2.5 | Type: MonitoringReport ..... | 60 | +| 6.4.6.2.6 | Type: Report..... | 61 | +| 6.4.6.2.7 | Type: ReportingOptions..... | 61 | +| 6.4.6.2.8 | Type: LocationReportingConfiguration ..... | 61 | +| 6.4.6.2.9 | Type: ReachabilityForSmsReport..... | 62 | +| 6.4.6.2.10 | Type: LossConnectivityConfiguration ..... | 62 | +| 6.4.6.2.11 | Type: ReachabilityForDataConfiguration..... | 62 | +| 6.4.6.2.12 | Type: PduSessionStatusCfg ..... | 62 | +| 6.4.6.2.13 | Type: ReachabilityForDataReport ..... | 63 | +| 6.4.6.2.14 | Type: FailedMonitoringConfiguration..... | 63 | +| 6.4.6.2.15 | Type: EeSubscriptionErrorAddInfo ..... | 63 | +| 6.4.6.2.16 | Type: EeSubscriptionError..... | 63 | +| 6.4.6.3 | Simple data types and enumerations..... | 63 | +| 6.4.6.3.1 | Introduction ..... | 63 | +| 6.4.6.3.2 | Simple data types ..... | 63 | +| 6.4.6.3.3 | Enumeration: EventType..... | 64 | +| 6.4.6.3.4 | Enumeration: LocationAccuracy..... | 64 | +| 6.4.6.3.5 | Enumeration: FailedCause ..... | 65 | +| 6.4.7 | Error Handling ..... | 65 | +| 6.4.7.1 | General ..... | 65 | +| 6.4.7.2 | Protocol Errors ..... | 65 | +| 6.4.7.3 | Application Errors..... | 65 | +| 6.4.8 | Feature Negotiation ..... | 65 | +| 6.4.9 | Security ..... | 66 | +| 6.4.10 | HTTP redirection..... | 66 | + +| | | | +|-------------------------------|----------------------------------------|-----------| +| Annex A (normative): | OpenAPI specification ..... | 67 | +| A.1 | General ..... | 67 | +| A.2 | Nhss_UEAuthentication API ..... | 67 | +| A.3 | Nhss_SubscriberDataManagement API..... | 69 | +| A.4 | Nhss_UEContextManagement API ..... | 73 | +| A.5 | Nhss_EE API ..... | 77 | +| Annex B (informative): | Withdrawn API versions ..... | 85 | +| B.1 | General ..... | 85 | +| Annex C (informative): | Change history..... | 86 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol, including message flows and API specification details, for the Nhss services, as part of the 5G Service-Based Architecture, offered by the HSS for interworking with the 5G UDM Network Function. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The User Data Interworking, Coexistence and Migration stage 2 architecture and procedures are specified in 3GPP TS 23.632 [8]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 23.335: "User Data Convergence (UDC); Technical realization and information flows". +- [7] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [8] 3GPP TS 23.632: "User Data Interworking, Coexistence and Migration". +- [9] IETF RFC 9113: "HTTP/2". +- [10] OpenAPI Initiative, "OpenAPI Specification Version 3.0.0", . +- [11] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [12] IETF RFC 9457: "Problem Details for HTTP APIs". + +- [13] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [14] 3GPP TR 21.900: "Technical Specification Group working methods". +- [15] 3GPP TS 23.003: "Numbering, addressing and identification". +- [16] 3GPP TS 29.303: "Domain Name System Procedures; Stage 3". +- [17] 3GPP TS 29.272: "Evolved Packet System; MME and SGSN Related Interfaces Based on Diameter Protocol". +- [18] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications". +- [19] 3GPP TS 29.335: "User Data Convergence (UDC); User Data Repository Access Protocol over the Ud interface". +- [20] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [21] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +Void. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|------|----------------------------| +| 5GC | 5G Core Network | +| HSS | Home Subscriber Server | +| JSON | Javascript Object Notation | +| SBI | Service Based Interface | +| UDM | Unified Data Management | +| UDR | Unified Data Repository | + +# --- 4 Overview + +## 4.1 Introduction + +Within the 5GC, the HSS offers services to the UDM via the Nhss service-based interface (see 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.632 [8]). + +Figure 4.1-1 provides the reference model in service-based interface representation with focus on the HSS. + +![Figure 4.1-1: Reference model – HSS. A diagram showing a UDM (User Data Management) block connected to an HSS (Home Subscriber Server) block via an interface labeled Nhss. The HSS block is highlighted in green.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +``` + +graph LR + UDM[UDM] --- Nhss((Nhss)) + Nhss --- HSS[HSS] + style HSS fill:#90EE90,stroke:#000 + +``` + +Figure 4.1-1: Reference model – HSS. A diagram showing a UDM (User Data Management) block connected to an HSS (Home Subscriber Server) block via an interface labeled Nhss. The HSS block is highlighted in green. + +Figure 4.1-1: Reference model – HSS + +# 5 Services offered by the HSS + +## 5.1 Introduction + +The HSS offers the following services via the Nhss interface: + +- Nhss\_UEAuthentication Service +- Nhss\_SubscriberDataManagement Service +- Nhss\_UEContextManagement service + +All scenarios shown in the following clauses assume that the HSS is stateful and stores information in local memory. However, the HSS may be stateless and stores information externally in the EPS-UDR. If so, the stateless HSS makes use of Ud interface as specified in 3GPP TS 23.335 [6] and 3GPP TS 29.335 [19] to retrieve required data from the EPS-UDR and store them locally before processing an incoming request. Processing the incoming request may then include updating data in the EPS-UDR or subscribing to data change notifications at the EPS-UDR by using the Ud interface. After processing the incoming request, the HSS may delete the locally stored data. + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +Table 5.1-1: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|---------------------------------------|--------|--------------------------------|----------------------------|-----------|-------| +| Nhss_UEAuthentication Service | 6.1 | HSS UE Authentication Service | TS29563_Nhss_UEAU.yaml | nhss-ueau | A.2 | +| Nhss_SubscriberDataManagement Service | 6.2 | HSS Subscriber Data Management | TS29563_Nhss_SDM.yaml | nhss-sdm | A.3 | +| Nhss_UEContextManagement Service | 6.3 | HSS UE Context Management | TS29563_Nhss_UECM.yaml | nhss-uecm | A.4 | +| Nhss_EventExposure | 6.4 | HSS Event Exposure | TS29563_Nhss_EE.yaml | nhss-ee | A.5 | + +## 5.2 Nhss\_UEAuthentication Service + +### 5.2.1 Service Description + +The Nhss\_UEAuthentication service allows a NF consumer (UDM) to request calculation of a fresh Authentication Vector (AV) for 5G\_AKA or EAP\_AKA\_PRIME and provide the calculated AV to the requesting NF. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +For the Nhss\_UEAuthentication service the following service operation is defined: + +- Get + +The Nhss\_UEAuthentication service is used by the UDM to request the HSS to, calculate a fresh authentication vector (AV) for authentication the method 5G\_AKA or EAP\_AKA\_PRIME, and provide it to the UDM by means of the Get service operation. See 3GPP TS 23.632 [8] clause 4.2.2. + +#### 5.2.2.2 Get + +##### 5.2.2.2.1 General + +The following procedure using the Get service operation is supported: + +- Authentication Vector Retrieval + +##### 5.2.2.2.2 Authentication Vector Retrieval + +Figure 5.2.2.2.2-1 shows a scenario where the NF service consumer (UDM) retrieves an Authentication Vector for the UE from the HSS (see also 3GPP TS 23.632 [8] clause 4.2.2). The request contains the UE's identity (imsi), the serving network name, the authentication method (5G\_AKA or EAP\_AKA\_PRIME) and may contain resynchronization info. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS for Authentication Vector Retrieval. The consumer sends a POST request with (imsi, serving network name, authentication method, resync. info) to the HSS. The HSS responds with 2a. 200 OK (Authentication Vector), 2b. 403 Forbidden, or 2c. 3xx Redirect.](63e0c22852c26699d0bd095a2d796bab_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note right of NF: (imsi, serving network name, authentication method, resync. info) + NF->>HSS: 1. POST .../generate-av + HSS-->>NF: 2a. 200 OK (Authentication Vector) + HSS-->>NF: 2b. 403 Forbidden + HSS-->>NF: 2c. 3xx Redirect + +``` + +Sequence diagram showing the interaction between an NF service consumer and an HSS for Authentication Vector Retrieval. The consumer sends a POST request with (imsi, serving network name, authentication method, resync. info) to the HSS. The HSS responds with 2a. 200 OK (Authentication Vector), 2b. 403 Forbidden, or 2c. 3xx Redirect. + +**Figure 5.2.2.2.2-1: NF service consumer requesting an Authentication Vector** + +1. The NF service consumer sends a POST request (custom method: generate-av) to the HSS. +- 2a. The HSS responds with "200 OK" with the message body containing the authentication vector. +- 2b. If the operation cannot be authorized due to e.g. UE does not have required subscription data, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.3 Nhss\_SubscriberDataManagement Service + +### 5.3.1 Service Description + +This service is used to retrieve the subscriber data indicated by the requested data type from HSS. In this release, only the PGW-C+SMF FQDN for S5/S8 interface information is supported as requested data type. See 3GPP TS 23.632 [8], clause 6.1.4. + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +For the Nhss\_SubscriberDataManagement service the following service operations are defined: + +- Get +- Subscribe +- ModifySubscription +- Unsubscribe +- Notification + +The Nhss\_SubscriberDataManagement service is used by Consumer NF (UDM) to retrieve the UE data from the HSS due to IRAT mobility by means of the Get service operation. + +It is also used by consumer NFs to subscribe to notifications of data change by means of the Subscribe service operation. + +It is also used by consumer NFs to modify an existing subscription by means of the ModifySubscription service operation. + +It is also used by consumer NFs that have previously subscribed, to unsubscribe from notifications of data changes by means of the Unsubscribe service operation. + +It is also used by Consumer NFs that have previously subscribed, to get notified by means of the Notification service operation. + +#### 5.3.2.2 Get + +##### 5.3.2.2.1 General + +The following procedure using the Get service operation is supported: + +- UE Context In PGW Data Retrieval + +##### 5.3.2.2.2 UE Context In PGW Data Retrieval + +Figure 5.3.2.2.2-1 shows a scenario where the NF service consumer (UDM) sends a request to the HSS to retrieve the UE's Context In PGW data. The request contains the UE's identity (which shall be an IMSI) and the requested information. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS for requesting UE context in PGW data.](b978ce2c39dbbcd4c4e087eb265a830b_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note left of NF: + NF->>HSS: 1. GET .../{ueId}/ue-context-in-pgw-data () + Note right of HSS: + HSS-->>NF: 2a. 200 OK (UeContextInPgwData) + Note right of HSS: + HSS-->>NF: 2b. 404 Not Found + Note right of HSS: + HSS-->>NF: 2c. 3xx Redirect +``` + +The diagram illustrates a sequence of interactions between an 'NF service consumer' and an 'HSS'. The consumer sends a 'GET .../{ueId}/ue-context-in-pgw-data ()' request to the HSS. The HSS responds with one of three possible messages: '2a. 200 OK (UeContextInPgwData)', '2b. 404 Not Found', or '2c. 3xx Redirect'. + +Sequence diagram showing the interaction between an NF service consumer and an HSS for requesting UE context in PGW data. + +**Figure 5.3.2.2.2-1: Requesting a UE's Context in PGW Data** + +1. The NF service consumer (e.g. UDM) shall send a GET request to the resource representing the UE's Context In PGW Data. + +2a. On Success, the HSS shall respond with "200 OK" with the message body containing the UE's Context In PGW Data as relevant for the requesting NF service consumer. + +2b. If there is no valid data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.3 Subscribe + +##### 5.3.2.3.1 General + +The following procedures using the Subscribe service operation are supported: + +- Subscription to notification of data change + +##### 5.3.2.3.2 Subscription to notifications of data change + +Figure 5.3.2.3.2-1 shows a scenario where the NF service consumer (e.g. UDM) sends a request to the HSS to subscribe to notifications of data change. The request contains a callback URI and the URI of the monitored resource. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS for subscription to notifications of data change.](e190b6ddb7c2e64b940749a1c5612256_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note right of HSS: 2a. 201 Created (SubscriptionData) + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 501 Not Implemented + Note right of HSS: 2d. 3xx Redirect + NF->>HSS: 1. POST .../{ueId}/subscriptions (SubscriptionData) + HSS-->>NF: 2a. 201 Created (SubscriptionData) + HSS-->>NF: 2b. 404 Not Found + HSS-->>NF: 2c. 501 Not Implemented + HSS-->>NF: 2d. 3xx Redirect +``` + +The diagram illustrates a sequence of messages between an NF service consumer and an HSS. The NF service consumer sends a POST request (1. POST .../{ueId}/subscriptions (SubscriptionData)) to the HSS. The HSS responds with one of four possible status codes: 2a. 201 Created (SubscriptionData), 2b. 404 Not Found, 2c. 501 Not Implemented, or 2d. 3xx Redirect. The responses are shown as dashed lines from the HSS back to the NF service consumer. + +Sequence diagram showing the interaction between an NF service consumer and an HSS for subscription to notifications of data change. + +**Figure 5.3.2.3.2-1: NF service consumer subscribes to notifications** + +1. The NF service consumer sends a POST request to the parent resource (collection of subscriptions) (.../{ueId}/subscriptions), to create a subscription as present in message body. +- 2a. On success, the HSS responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the UE subscription data exist, but the requested subscription to data change notification cannot be created (e.g. due to an invalid/unsupported data reference to be monitored, contained in the SubscriptionData parameter), HTTP status code "501 Not Implemented" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.4 Unsubscribe + +##### 5.3.2.4.1 General + +The following procedures using the Unsubscribe service operation are supported: + +- Unsubscribe to notification of data change + +##### 5.3.2.4.2 Unsubscribe to notifications of data change + +Figure 5.3.2.4.2-1 shows a scenario where the NF service consumer sends a request to the HSS to unsubscribe from notifications of data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram showing the Unsubscribe process between an NF service consumer and an HSS.](a7c51c18111139f9aca2805114108565_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant HSS + Note left of NF service consumer: 1. DELETE.../{ueId}/subscriptions/{subscriptionId} + NF service consumer->>HSS: 1. DELETE.../{ueId}/subscriptions/{subscriptionId} + Note right of HSS: 2a. 204 No Content + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect + HSS-->>NF service consumer: 2a. 204 No Content + HSS-->>NF service consumer: 2b. 404 Not Found + HSS-->>NF service consumer: 2c. 3xx Redirect +``` + +The diagram illustrates the interaction between an NF service consumer and an HSS for unsubscribing. The consumer sends a DELETE request to a specific subscription resource. The HSS responds with one of three possible HTTP status codes: 204 No Content (success), 404 Not Found (if the subscription does not exist), or a 3xx Redirect (if the request needs to be forwarded to another instance). + +Sequence diagram showing the Unsubscribe process between an NF service consumer and an HSS. + +**Figure 5.3.2.4.2-1: NF service consumer unsubscribes to notifications** + +1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.5 Notification + +##### 5.3.2.5.1 General + +The following procedures using the Notification service operation are supported: + +- Data change notification to NF. + +##### 5.3.2.5.2 Data Change Notification To NF + +Figure 5.3.2.5.2-1 shows a scenario where the HSS notifies the NF service consumer (that has subscribed to receive such notification) about subscription data change. The request contains the callbackReference URI as previously received in the SubscriptionData. + +![Sequence diagram for Subscription Data Change Notification. The NF service consumer sends a POST {callbackReference} (Notification) to the HSS. The HSS responds with 2a. 204 No Content or 2b. 3xx Redirect.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + Note left of NF service consumer: 1. POST {callbackReference} (Notification) + NF service consumer->>HSS: 1. POST {callbackReference} (Notification) + Note right of HSS: 2a. 204 No Content +2b. 3xx Redirect + HSS-->>NF service consumer: 2a. 204 No Content +2b. 3xx Redirect + +``` + +Sequence diagram for Subscription Data Change Notification. The NF service consumer sends a POST {callbackReference} (Notification) to the HSS. The HSS responds with 2a. 204 No Content or 2b. 3xx Redirect. + +**Figure 5.3.2.5.2-1: Subscription Data Change Notification** + +1. The HSS sends a POST request to the callbackReference as provided by the NF service consumer during the subscription. +- 2a. The NF service consumer responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the NF Service Consumer shall return 3xx status code, which shall contain a Location header with an URI pointing to an alternative notification endpoint. + +#### 5.3.2.6 ModifySubscription + +##### 5.3.2.6.1 General + +The following procedures using the ModifySubscription service operation are supported: + +- Modification of a Subscription to notification of data change + +##### 5.3.2.6.2 Modification of a subscription to notifications of data change + +Figure 5.3.2.6.2-1 shows a scenario where the NF service consumer sends a request to the HSS to modify a subscription to notifications of data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram for NF service consumer modifies a subscription to notifications. The NF service consumer sends a PATCH.../{ueId}/subscriptions/{subscriptionId} (PatchItems) to the HSS. The HSS responds with 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect.](69f52512bb7387a5dc9f952279513019_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + Note left of NF service consumer: 1. PATCH.../{ueId}/subscriptions/{subscriptionId} (PatchItems) + NF service consumer->>HSS: 1. PATCH.../{ueId}/subscriptions/{subscriptionId} (PatchItems) + Note right of HSS: 2a. 204 No Content +2b. 404 Not Found +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>NF service consumer: 2a. 204 No Content +2b. 404 Not Found +2c. 403 Forbidden +2d. 3xx Redirect + +``` + +Sequence diagram for NF service consumer modifies a subscription to notifications. The NF service consumer sends a PATCH.../{ueId}/subscriptions/{subscriptionId} (PatchItems) to the HSS. The HSS responds with 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect. + +**Figure 5.3.2.6.2-1: NF service consumer modifies a subscription to notifications** + +1. The NF service consumer sends a PATCH request to the resource identified by the URI previously received during subscription creation. +- 2a. On success, the UDM responds with "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the operation cannot be authorized, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element) + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.4 Nhss\_UEContextManagement Service + +### 5.4.1 Service Description + +The service allows an NF consumer (UDM) to trigger the cancellation of any previous registered serving node due to IRAT mobility. See 3GPP TS 23.632 [8], clause 6.1.3. + +### 5.4.2 Service Operations + +#### 5.4.2.1 Introduction + +For the Nhss\_UEContextManagement service the following service operations are defined: + +- SnDeregistration +- ImeiUpdate +- RoamingStatusUpdate + +The Nhss\_UEContextManagement service is used by Consumer NF (UDM) to request HSS to deregister the MME/SGSN via cancel location procedure and to update the IMEI and roaming status of the UE in the HSS. + +#### 5.4.2.2 SnDeregistration + +##### 5.4.2.2.1 General + +The following procedure using the SnDeregistration service operation is supported: + +- SN Deregistration + +##### 5.4.2.2.2 SN Deregistration + +Figure 5.4.2.2.2-1 shows a scenario where the NF service consumer (UDM) requests HSS to initiate Cancel Location procedure towards the MME/SGSN due to IRAT mobility. The request contains the UE's identity which shall be an IMSI. + +![Sequence diagram for SN Deregistration showing the interaction between an NF service consumer and an HSS.](b057cbcc73029e4684d3821b3f303e42_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note left of NF: + NF->>HSS: 1. POST .../deregister-sn (DeregistrationRequest) + Note right of HSS: + HSS-->>NF: 2a. 204 No Content () + Note right of HSS: + HSS-->>NF: 2b. 404 Not Found + Note right of HSS: + HSS-->>NF: 2c. 3xx Redirect +``` + +The diagram illustrates a sequence of interactions between an 'NF service consumer' and an 'HSS'. The consumer sends a '1. POST .../deregister-sn (DeregistrationRequest)' to the HSS. The HSS responds with one of three possible messages: '2a. 204 No Content ()', '2b. 404 Not Found', or '2c. 3xx Redirect'. + +Sequence diagram for SN Deregistration showing the interaction between an NF service consumer and an HSS. + +Figure 5.4.2.2.2-1: SN Deregistration + +1. The NF service consumer sends a POST request (custom method: deregister-sn) to the HSS; the request body contains the UE identity (IMSI) and the deregistration reason. + +The HSS, based on the value indicated in the deregistration reason, initiates a Cancel Location towards the serving node, including a Cancellation Type value (see 3GPP TS 29.272 [17] and 3GPP TS 29.002 [20]) as follows: + +- "UE\_INITIAL\_AND\_SINGLE\_REGISTRATION": S6a/S6d/Gr(S4/Gn/Gp) Cancel Location sent towards MME/SGSN, with a Cancellation-Type set to MME\_UPDATE\_PROCEDURE/SGSN\_UPDATE\_PROCEDURE; the HSS shall delete the stored MME/SGSN address and MME/SGSN number. + +Additionally, a MAP D Cancel Location (IMSI) shall be sent towards MSC/VLR if a VLR number was found in the HSS/HLR for the user; the HSS/HLR shall delete the stored MSC/VLR number. + +- "UE\_INITIAL\_AND\_DUAL\_REGISTRATION": S6d/Gr(S4) Cancel Location sent towards SGSN, with a Cancellation-Type set to SGSN\_UPDATE\_PROCEDURE; the HSS shall delete the stored SGSN address and SGSN number. + +NOTE 1: As described in 3GPP TS 23.502 [3], a UE operating in dual-registration mode indicates that it is moving from EPS, which implies that there is an MME registered in HSS. + +- "EPS\_TO\_5GS\_MOBILITY": S6a Cancel Location sent towards MME, with a Cancellation-Type set to MME\_UPDATE\_PROCEDURE; the HSS shall delete the stored MME address and MME number. + +Additionally, a MAP D Cancel Location (IMSI) shall be sent towards MSC/VLR if a VLR number was found in the HSS/HLR for the user; the HSS/HLR shall delete the stored MSC/VLR number. + +- "EPS\_TO\_5GS\_MOBILITY": S6d/Gr(S4) Cancel Location sent towards SGSN, with a Cancellation-Type set to SGSN\_UPDATE\_PROCEDURE; the HSS shall delete the stored SGSN address and SGSN number. + +NOTE 2: Based on operator policy, and the presence of GUAMI in the DeregistrationRequest, the HSS can decide whether a registered VLR in the VPLMN needs to be cancelled. It should be noted that keeping the VLR registration can impact terminating services (e.g. T-ADS, MT-SMS...) causing failed paging attempts. + +2a. On success, the HSS responds with "204 No Content". If the HSS has a valid subscription for the UE, but the UE is not registered in EPS network, the HSS shall respond with "204 No Content". + +2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.4.2.3 IMEI Update + +Figure 5.4.2.3-1 shows a scenario where the NF service consumer (UDM) requests HSS to update the IMEI of the UE stored in the HSS. The request contains the UE's identity which shall be an IMSI, and the new IMEI of the UE. + +![Sequence diagram for IMEI Update. The NF service consumer sends a POST request to the HSS. The HSS responds with one of three options: 2a. 200 OK or 204 No Content, 2b. 404 Not Found, or 2c. 3xx Redirect.](0882d90c2036d3612040d0989282678a_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant HSS + Note left of NF: + NF->>HSS: 1. POST .../imei-update (ImeiUpdateInfo) + Note right of HSS: + HSS-->>NF: 2a. 200 OK or 204 No Content () + Note right of HSS: + HSS-->>NF: 2b. 404 Not Found + Note right of HSS: + HSS-->>NF: 2c. 3xx Redirect + +``` + +Sequence diagram for IMEI Update. The NF service consumer sends a POST request to the HSS. The HSS responds with one of three options: 2a. 200 OK or 204 No Content, 2b. 404 Not Found, or 2c. 3xx Redirect. + +Figure 5.4.2.3-1: IMEI Update + +1. The NF service consumer sends a POST request (custom method: imei-update) to the HSS; the request body contains the UE identity (IMSI) and the new IMEI of the UE. + +- 2a. On success, the HSS responds either with "204 No Content", which indicates that the HSS does not have any stored IMEI(SV) value for the UE, or with a "200 OK", which indicates that the HSS had an IMEI value stored for the UE. In the latter case, the HSS shall update the locally stored IMEI value for the UE, and return in the response body the previous IMEI, so the NF Service Consumer (UDM) can determine whether the HSS contained a different IMEI value than the current one sent to the HSS in this IMEI Update notification. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.4.2.4 Roaming Status Update + +Figure 5.4.2.4-1 shows a scenario where the NF service consumer (UDM) requests HSS to update the Roaming Status of the UE stored in the HSS. The request contains the UE's identity which shall be an IMSI, and the new PLMN-ID where the UE is located. + +![Sequence diagram for Roaming Status Update showing interaction between NF service consumer and HSS.](40f30e4d577a17052f8b1e6dc802a0d8_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant HSS + Note left of NF: 1. POST .../roaming-status-update (RoamingStatusUpdateInfo) + NF->>HSS: Request + Note right of HSS: 2a. 200 OK, 204 No Content + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect + HSS-->>NF: Response +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and an HSS. The NF service consumer sends a POST request (step 1) to the HSS. The HSS responds with one of three possible status codes (steps 2a, 2b, or 2c). The request is labeled as '1. POST .../roaming-status-update (RoamingStatusUpdateInfo)'. The responses are labeled as '2a. 200 OK, 204 No Content', '2b. 404 Not Found', and '2c. 3xx Redirect'. + +Sequence diagram for Roaming Status Update showing interaction between NF service consumer and HSS. + +Figure 5.4.2.4-1: Roaming Status Update + +1. The NF service consumer sends a POST request (custom method: roaming-status-update) to the HSS; the request body contains the UE identity (IMSI) and the new PLMN-ID of the UE. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.5 Nhss\_EventExposure Service + +### 5.5.1 Service Description + +See 3GPP TS 23.632 [8]. + +### 5.5.2 Service Operations + +#### 5.5.2.1 Introduction + +For the Nhss\_EventExposure service the following service operations are defined: + +- Subscribe +- Unsubscribe +- Notify +- ModifySubscription + +The Nhss\_EventExposure service is used by consumer NFs (e.g. UDM) to subscribe to notifications of event occurrence by means of the Subscribe service operation. + +The Nhss\_EventExposure service is also used by the consumer NFs (e.g. UDM) that have previously subscribed to notifications, to unsubscribe by means of the Unsubscribe service operation. + +The Nhss\_EventExposure service is also used by the subscribed consumer NFs (e.g. UDM) to modify an existing subscription by means of the ModifySubscription service operation. + +#### 5.5.2.2 Subscribe + +##### 5.5.2.2.1 General + +The following procedures using the Subscribe service operation are supported: + +- Subscribe to Notification of event occurrence + +##### 5.5.2.2.2 Subscription to Notification of event occurrence + +Figure 5.5.2.2.2-1 shows a scenario where the NF service consumer sends a request to the HSS to subscribe to notifications of event occurrence. The request contains a callback URI, the type of event that is monitored and additional information e.g. SCEF Id, event filters and reporting options. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS for subscription. The consumer sends a POST request to the HSS. The HSS responds with one of several possible status codes: 2a. 201 Created, 2b. 404 Not Found, 2c. 403 Forbidden, 2d. 3xx Redirect, or 2e. 501 Not Implemented.](5c6787bac31274e2dc992efeca74b303_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note left of NF: + NF->>HSS: 1. POST.../{ueId}/ee-subscriptions (EeSubscription) + Note right of HSS: + HSS-->>NF: 2a. 201 Created (CreatedEeSubscription) + Note right of HSS: + HSS-->>NF: 2b. 404 Not Found + Note right of HSS: + HSS-->>NF: 2c. 403 Forbidden + Note right of HSS: + HSS-->>NF: 2d. 3xx Redirect + Note right of HSS: + HSS-->>NF: 2e. 501 Not Implemented + +``` + +Sequence diagram showing the interaction between an NF service consumer and an HSS for subscription. The consumer sends a POST request to the HSS. The HSS responds with one of several possible status codes: 2a. 201 Created, 2b. 404 Not Found, 2c. 403 Forbidden, 2d. 3xx Redirect, or 2e. 501 Not Implemented. + +**Figure 5.5.2.2.2-1: NF service consumer subscribes to notifications** + +1. The NF service consumer sends a POST request to the parent resource (collection of subscriptions) (.../{ueId}/ee-subscriptions), to create a subscription as present in message body. The request may contain an expiry time, suggested by the NF Service Consumer, representing the time upto which the subscription is desired to be kept active and the time after which the subscribed event(s) shall stop generating notifications. Additionally, the request may include an SCEF Id if Common Network Exposure is used (i.e. if combined SCEF+NEF requested the event(s) to be subscribed/monitored in EPC) + +If MTC Provider information is received in the request, the HSS shall check whether the MTC Provider is allowed to perform this operation for the UE; otherwise, the HSS shall skip the MTC provider authorization check. + +- 2a. On success, the HSS responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription. + +If immediate reporting is requested and if both HSS and NF consumer has indicated supporting of ERIR feature (see clause 6.4.8), the HSS shall include available immediate event reports, i.e. reports already received from MME, in the response body; otherwise if the HSS and/or the NF consumer cannot support the ERIR feature, the HSS shall send a notification (see clause 5.5.2.4.2) towards the NF consumer including the current status of the events requested for immediate reporting. If immediate reporting is requested but the current status of the event(s) is not available at the time of subscription, the HSS should include the current status not available indication in the response. + +If some of the requested monitoring configurations fails, the response may include the failedMonitoringConfigs to indicate the failed cause of the failed monitoring configurations. + +- 2b. If the user does not exist, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If there is no valid subscription data for the UE, i.e. based on the UE's subscription information monitoring of the requested EventType is not allowed, or the requested EventType is not supported, or the MTC Provider is not allowed to perform this operation for the UE, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2d. In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. +- 2e. If the requested monitoring event types or reporting options are not supported, HTTP status code "501 Not Implemented" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +#### 5.5.2.3 Unsubscribe + +##### 5.5.2.3.1 General + +The following procedures using the Unsubscribe service operation are supported: + +- Unsubscribe to Notifications of event occurrence + +##### 5.5.2.3.2 Unsubscribe to notifications of event occurrence + +Figure 5.5.2.3.2-1 shows a scenario where the NF service consumer sends a request to the HSS to unsubscribe from notifications of event occurrence. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram showing the Unsubscribe process between an NF service consumer and an HSS. The consumer sends a DELETE request to the HSS. The HSS responds with one of three possible status codes: 2a. 204 No Content, 2b. 404 Not Found, or 2c. 3xx Redirect.](c0e369274e53b2e5364666be6f786c7a_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note left of NF: 1. DELETE.../{ueId}/ee-subscriptions/{subscriptionId} + NF->>HSS: 1. DELETE.../{ueId}/ee-subscriptions/{subscriptionId} + Note right of HSS: 2a. 204 No Content +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF: 2a. 204 No Content +2b. 404 Not Found +2c. 3xx Redirect + +``` + +Sequence diagram showing the Unsubscribe process between an NF service consumer and an HSS. The consumer sends a DELETE request to the HSS. The HSS responds with one of three possible status codes: 2a. 204 No Content, 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.5.2.3.2-1: NF service consumer unsubscribes to notifications** + +1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation. +- 2a. On success, the HSS responds with "204 No Content". + +- 2b. If there is no valid subscription available (e.g. due to an unknown SubscriptionId value), HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.5.2.4 Notify + +##### 5.5.2.4.1 General + +The following procedures using the Notify service operation are supported: + +- Event Occurrence Notification + +##### 5.5.2.4.2 Event Occurrence Notification + +Figure 5.5.2.4.2-1 shows a scenario where the HSS notifies the NF service consumer (that has subscribed to receive such notification) about occurrence of an event or the current status of the events requested for immediate reporting if ERIR feature (see clause 6.4.8) is not supported by the HSS and/or the NF consumer. The request contains the Reference IDs as previously received in the EeSubscription. + +![Sequence diagram showing Event Occurrence Notification between NF service consumer and HSS.](421fc75480c21e7ebb25756826652367_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note right of HSS: 1. POST {callbackReference} (MonitoringReport) + HSS->>NF: + Note left of NF: 2a. 204 No Content + Note left of NF: 2b. 3xx Redirect + NF-->>HSS: +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and an HSS. The HSS sends a POST request (step 1) to the NF service consumer's callback reference URI. The NF service consumer responds with either a 204 No Content status (step 2a) or a 3xx Redirect status (step 2b). + +Sequence diagram showing Event Occurrence Notification between NF service consumer and HSS. + +Figure 5.5.2.4.2-1: Event Occurrence Notification + +1. The HSS sends a POST request to the callbackReference URI as provided by the NF service consumer during the subscription. +- 2a. The NF Service Consumer responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the NF Service Consumer shall return 3xx status code, which shall contain a Location header with an URI pointing to an alternative notification endpoint. + +#### 5.5.2.5 ModifySubscription + +##### 5.5.2.5.1 General + +The following procedures using the ModifySubscription service operation are supported: + +- Modification of an EE-Subscription to notification of events + +##### 5.5.2.5.2 Modification of a subscription + +The service operation is invoked by a NF Service Consumer, e.g. UDM, towards the HSS, when it needs to modify an existing subscription previously created by itself at the HSS. + +The NF Service Consumer shall modify the subscription by using HTTP method PATCH with the URI of the individual subscription resource to be modified. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS for updating a subscription. The consumer sends a PATCH request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect.](844077b3034f0030b404207db0ad76b4_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + NF service consumer->>HSS: 1. PATCH .../{ueId}/ee-subscriptions/{subscriptionId} + HSS-->>NF service consumer: 2a. 204 No Content () + HSS-->>NF service consumer: 2b. 404 Not Found + HSS-->>NF service consumer: 2c. 403 Forbidden + HSS-->>NF service consumer: 2d. 3xx Redirect + +``` + +Sequence diagram showing the interaction between an NF service consumer and an HSS for updating a subscription. The consumer sends a PATCH request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect. + +**Figure 5.5.2.5.2-1: NF service consumer updates subscription** + +1. The NF service consumer (e.g. NEF) shall send a PATCH request to the resource representing a subscription. The modification may be for the events subscribed or for updating the event report options. +- 2a. On success, the request is accepted, the HSS shall respond with "204 No Content". +- 2b. If the resource does not exist e.g. the subscriptionId cannot be found, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the modification can't be accepted, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +# 6 API Definitions + +## 6.1 Nhss\_UEAuthentication Service API + +### 6.1.1 Introduction + +The Nhss\_UEAuthentication service shall use the Nhss\_UEAuthentication API. + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nhss-ueau". +- The shall be "v1". +- The shall be set as described in clause 6.1. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nhss\_UEAuthentication service shall comply with the OpenAPI [10] specification contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [11], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 9457 [12]) signalled by the content type "application/problem+json". + +#### 6.1.2.3 HTTP custom headers + +##### 6.1.2.3.1 General + +In this release of the specification, no specific custom headers are defined for the Nhss\_UEAuthentication service. + +For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +![Diagram showing the resource URI structure for the nhss-ueau API. The root URI is {apiRoot}/nhss-ueau/. A sub-resource URI /generate-av is shown, enclosed in a dashed box, connected to the root by a line.](109caef02615eec1894dfc07d24deb97_img.jpg) + +``` +graph TD; Root["{apiRoot}/nhss-ueau/"] --- Sub["/generate-av"]; style Sub stroke-dasharray: 5 5; +``` + +Diagram showing the resource URI structure for the nhss-ueau API. The root URI is {apiRoot}/nhss-ueau/. A sub-resource URI /generate-av is shown, enclosed in a dashed box, connected to the root by a line. + +**Figure 6.1.3.1-1: Resource URI structure of the nhss-ueau API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------|--------------|---------------------------------|--------------------------------| +| n/a | generate-av | generate-av (POST) | Generate Authentication Vector | + +### 6.1.4 Custom Operations without associated resources + +#### 6.1.4.1 Overview + +**Table 6.1.4.1-1: Custom operations without associated resources** + +| Custom operation URI | Mapped HTTP method | Description | +|----------------------------------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| {apiRoot}/nhss-ueau//generate-av | POST | The HSS calculates a fresh Authentication Vector taking into account the received information (imsi, serving network name, authentication method) | + +#### 6.1.4.2 Operation: Generate AV + +##### 6.1.4.2.1 Description + +This custom operation is used by the NF service consumer (UDM) to request calculation of an authentication vector for the provided imsi. + +##### 6.1.4.2.2 Operation Definition + +This operation shall support the response data structures and response codes specified in tables 6.1.4.2.2-1 and 6.1.4.2.2-2. + +**Table 6.1.4.2.2-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|-----------------------------------------------------------------| +| AvGenerationRequest | M | 1 | Contains input parameters for Authentication Vector calculation | + +**Table 6.1.4.2.2-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------| +| AvGenerationResponse | M | 1 | 200 OK | Upon success, a response body containing the generated authentication vector shall be returned | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AUTHENTICATION_REJECTED | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | + +**Table 6.1.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.1.5 Notifications + +In this release of this specification, no notifications are defined for the Nhss\_UEAuthentication Service. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nhss service based interface protocol. + +**Table 6.1.6.1-1: Nhss specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------------|----------------|------------------------------------------------------------------------------------|---------------| +| AvGenerationRequest | 6.1.6.2.2 | Contains imsi, authentication method, serving network name, resynchronization info | | +| AvGenerationResponse | 6.1.6.2.3 | Contains the calculated Authentication Vector | | + +Table 6.1.6.1-2 specifies data types re-used by the Nhss service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nhss service based interface. + +**Table 6.1.6.1-2: Nhss re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-----------------------|---------------------|----------------------------------------------|---------------| +| AuthType | 3GPP TS 29.503 [13] | | | +| ServingNetworkName | 3GPP TS 29.503 [13] | | | +| ResynchronizationInfo | 3GPP TS 29.503 [13] | | | +| AvEapAkaPrime | 3GPP TS 29.503 [13] | | | +| Av5GHeAka | 3GPP TS 29.503 [13] | | | +| ProblemDetails | 3GPP TS 29.571 [7] | Response body of error response messages. | | +| RedirectResponse | 3GPP TS 29.571 [7] | Response body of redirect response messages. | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: AvGenerationRequest + +**Table 6.1.6.2.2-1: Definition of type AvGenerationRequest** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|-----------------------|---|-------------|------------------------------------------------------------------|---------------| +| imsi | string | M | 1 | pattern: "[0-9]{5,15}" | | +| authType | AuthType | M | 1 | Indicates the authentication method; "EAP_AKA_PRIME" or "5G_AKA" | | +| servingNetworkName | ServingNetworkName | M | 1 | | | +| resynchronizationInfo | ResynchronizationInfo | O | 0..1 | | | + +##### 6.1.6.2.3 Type: AvGenerationResponse + +**Table 6.1.6.2.3-1: Definition of type AvGenerationResponse** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-------------------------------------------------------------------------|---------------| +| avEapAkaPrime | AvEapAkaPrime | C | 0..1 | shall be present if av5GHeAka is absent, otherwise shall be absent. | | +| av5GHeAka | Av5GHeAka | C | 0..1 | shall be present if avEapAkaPrime is absent, otherwise shall be absent. | | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.1.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nhss\_UEAuthentication service are listed in table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------------|------------------|--------------------------------------| +| AUTHENTICATION_REJECTED | 403 Forbidden | The user cannot be authenticated | +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nhss\_UEAuthentication API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [6] and 3GPP TS 29.500 [4], the access to the Nhss\_UEAU API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [18]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [19]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_UEAU API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [19], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nhss\_UEAU service. + +The Nhss\_UEAU API defines a single scope "nhss-ueau" for OAuth2 authorization (as specified in 3GPP TS 33.501 [6]) for the entire API, and it does not define any additional scopes at resource or operation level. + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different HSS service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different HSS producer instance will return the NF Instance ID of the new HSS producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an HSS redirects a service request to a different HSS using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new HSS towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.2 Nhss\_SubscriberDataManagement Service API + +### 6.2.1 API URI + +The Nhss\_SubscriberDataManagement service shall use the Nhss\_SubscriberDataManagement API. + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +{apiRoot}// + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nhss-sdm". +- The shall be "v1". +- The shall be set as described in clause 6.2.3. + +### 6.2.2 Usage of HTTP + +#### 6.2.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nhss\_SubscriberDataManagement service shall comply with the OpenAPI [10] specification contained in Annex A. + +#### 6.2.2.2 HTTP standard headers + +##### 6.2.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.2.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [11], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 9457 [12]) signalled by the content type "application/problem+json". + +#### 6.2.2.3 HTTP custom headers + +##### 6.2.2.3.1 General + +In this release of the specification, no specific custom headers are defined for the Nhss\_SubscriberDataManagement service. + +For 3GPP specific HTTP custom headers used across all service-based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.2.3 Resources + +#### 6.2.3.1 Overview + +![Figure 6.2.3.1-1: Resource URI structure of the nhss-sdm API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nhss-sdm/{apiVersion}. A branch labeled '{ueId}' leads to two sub-resources: '/ue-context-in-pgw-data' and '/subscriptions'. The '/subscriptions' resource further branches into '{subscriptionId}'.](7d2d1d3870cd224c4430d19334557716_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nhss-sdm/{apiVersion}"] --> ueId["{ueId}"] + ueId --> ueContext["/ue-context-in-pgw-data"] + ueId --> subscriptions["/subscriptions"] + subscriptions --> subscriptionId["{subscriptionId}"] + +``` + +Figure 6.2.3.1-1: Resource URI structure of the nhss-sdm API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nhss-sdm/{apiVersion}. A branch labeled '{ueId}' leads to two sub-resources: '/ue-context-in-pgw-data' and '/subscriptions'. The '/subscriptions' resource further branches into '{subscriptionId}'. + +**Figure 6.2.3.1-1: Resource URI structure of the nhss-sdm API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name (Archetype) | Resource URI | HTTP method or custom operation | Description | +|------------------------------------|----------------------------------------|---------------------------------|--------------------------------------------------------------------------| +| UeContextInPgwData (Document) | /{ueId}/ue-context-in-pgw-data | GET | Retrieve the UE's Context in PGW Data | +| Subscriptions (Collection) | /{ueId}/subscriptions | POST | Create a subscription | +| Individual Subscription (Document) | /{ueId}/subscriptions/{subscriptionId} | DELETE | Delete the subscription identified by {subscriptionId}, i.e. unsubscribe | +| | | PATCH | Modify the subscription identified by {subscriptionId} | + +#### 6.2.3.2 Resource: UeContextInPgwData + +##### 6.2.3.2.1 Description + +This resource represents the allocated PGWs for the UE. + +##### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nhss-sdm/{apiVersion}/{ueId}/ue-context-in-pgw-data + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| ueId | Represents the UE identifier with type IMSI.
pattern: "^(imsi-[0-9]{5,15}).+\$" | + +##### 6.2.3.2.3 Resource Standard Methods + +###### 6.2.3.2.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.2.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3. + +**Table 6.2.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| UeContextInPgwData | M | 1 | 200 OK | A response body containing the UeContextInPgwData shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | + +NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +**Table 6.2.3.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.2.3.3 Resource: Subscriptions + +##### 6.2.3.3.1 Description + +This resource is used to represent subscriptions to notifications. + +##### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nhss-sdm///subscriptions + +This resource shall support the resource URI variables defined in table 6.2.3.3.2-1. + +**Table 6.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|----------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1 | +| ueId | Represents the IMSI of the subscriber.
pattern: "^(imsi-[0-9]{5,15})\$" | + +##### 6.2.3.3.3 Resource Standard Methods + +###### 6.2.3.3.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.3.3.3.1-1. + +**Table 6.2.3.3.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3. + +**Table 6.2.3.3.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------| +| SubscriptionData | M | 1 | The subscription that is to be created. | + +Table 6.2.3.3.3.1-3: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SubscriptionData | M | 1 | 201
Created | Upon success, a response body containing a representation of the created Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:

- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate one of the following application errors:

- UNSUPPORTED_RESOURCE_URI

This response shall not be cached. | + +NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +Table 6.2.3.3.3.1-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +Table 6.2.3.3.3.1-5: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.2.3.4 Resource: Individual subscription + +##### 6.2.3.4.1 Description + +This resource is used to represent an individual subscription to notifications. + +##### 6.2.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nhss-sdm/{apiVersion}/{ueId}/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.2.3.4.2-1. + +**Table 6.2.3.4.2-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|----------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1 | +| ueId | Represents the IMSI of the subscriber
pattern: "^(imsi-[0-9]{5,15})\$" | +| subscriptionId | The subscriptionId identifies an individual subscription to notifications. | + +##### 6.2.3.4.3 Resource Standard Methods + +###### 6.2.3.4.3.1 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.4.3.1-1. + +**Table 6.2.3.4.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.4.3.1-2 and the response data structures and response codes specified in table 6.2.3.4.3.1-3. + +**Table 6.2.3.4.3.1-2: Data structures supported by the Delete Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.4.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:

- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND (see 3GPP TS 29.500 [4] table 5.2.7.2-1) | + +NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +**Table 6.2.3.4.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.4.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +###### 6.2.3.4.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.4.3.2-1. + +**Table 6.2.3.4.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.4.3.2-2 and the response data structures and response codes specified in table 6.2.3.4.3.2-3. + +**Table 6.2.3.4.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1 | It contains the list of changes to be made to the resource representing the individual subscription, according to the JSON PATCH format specified in IETF RFC 6902 [13]. | + +**Table 6.2.3.4.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, a response with no content is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND (see 3GPP TS 29.500 [4] table 5.2.7.2-1) | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.
The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED (see 3GPP TS 29.500 [4] table 5.2.7.2-1) | +| NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +**Table 6.2.3.4.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.4.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nhss\_SubscriberDataManagement Service. + +### 6.2.5 Notifications + +#### 6.2.5.1 General + +This clause specifies the use of notifications and corresponding protocol details. + +#### 6.2.5.2 Data Change Notification + +The POST method shall be used for Data Change Notifications and the URI shall be as provided during the subscription procedure. + +Resource URI: {callbackReference} + +Support of URI query parameters is specified in table 6.2.5.2-1. + +**Table 6.2.5.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.2.5.2-2 and of response data structures and response codes is specified in table 6.2.5.2-3. + +**Table 6.2.5.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|-------------| +| ModificationNotification | M | 1 | | + +Table 6.2.5.2-3: Data structures supported by the POST Response Body + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:

- CONTEXT_NOT_FOUND

See table 6.2.7.3-1 for the description of this error. | + +NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +Table 6.2.5.2-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +Table 6.2.5.2-5: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.6 Data Model + +#### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Nhss\_SubscriberDataManagement service API. + +Table 6.2.6.1-1: Nhss\_SubscriberDataManagement specific Data Types + +| Data type | Clause defined | Description | +|----------------------|----------------|---------------------------| +| UeContextInPgwData | 6.2.6.2.2 | | +| SubscriptionData | 6.2.6.2.3 | Subscription Data | +| SubscriptionDataSets | 6.2.6.2.4 | UE Subscription Data Sets | + +Table 6.2.6.1-2 specifies data types re-used by the Nhss\_SubscriberDataManagement service API from other APIs, including a reference and when needed, a short description of their use within the Nhss\_SubscriberDataManagement service API. + +**Table 6.2.6.1-2: Nhss\_SubscriberDataManagement re-used Data Types** + +| Data type | Reference | Comments | +|--------------------------|---------------------|----------------------------------------------| +| PgwInfo | 3GPP TS 29.503 [13] | | +| ModificationNotification | 3GPP TS 29.503 [13] | | +| NfInstanceId | 3GPP TS 29.571 [7] | Network Function Instance Identifier | +| Uri | 3GPP TS 29.571 [7] | Uniform Resource Identifier | +| DateTime | 3GPP TS 29.571 [7] | | +| ProblemDetails | 3GPP TS 29.571 [7] | Response body of error response messages. | +| RedirectResponse | 3GPP TS 29.571 [7] | Response body of redirect response messages. | +| Fqdn | 3GPP TS 29.571 [7] | Fully Qualified Domain Name | + +#### 6.2.6.2 Structured data types + +##### 6.2.6.2.1 Introduction + +This clause defines the data structures to be used in resource representations. + +##### 6.2.6.2.2 Type: UeContextInPgwData + +**Table 6.2.6.2.2-1: Definition of type UeContextInPgwData** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------------------------------------------------------------| +| pgwInfo | array(PgwInfo) | O | 1..N | Information about the APNs and PGW-C+SMF FQDNs used in interworking with UDM | +| emergencyFqdn | Fqdn | O | 0..1 | PGW-C+SMF FQDN for emergency session | +| emergencyPlmnId | PlmnId | O | 0..1 | PLMN where the PGW-C+SMF for emergency session is located | +| emergencyIpAddr | IpAddress | O | 0..1 | IP address of the PGW-C+SMF for emergency session | +| emergencyRegistrationTime | DateTime | O | 0..1 | Time of PGW-C+SMF for emergency session Registration. | +| Note: | At least one of pgwInfo and emergencyFqdn/emergencyIpAddr shall be present. The format of PGW-C+SMF FQDN is specified in clause 5.12.3.2, 3GPP TS 29.303 [16]. | | | | + +##### 6.2.6.2.3 Type: SubscriptionData + +Table 6.2.6.2.3-1: Definition of type SubscriptionData + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nfInstanceId | NfInstanceId | M | 1 | Identity of the NF Instance creating the subscription. | +| callbackReference | Uri | M | 1 | URI provided by the NF service consumer to receive notifications | +| monitoredResourceUris | array(Uri) | M | 1..N | A set of URIs that identify the resources for which a change triggers a notification.
The URI shall take the form of either an absolute URI or an absolute-path reference as defined in IETF RFC 3986 [31].
See NOTE 1. | +| expires | DateTime | O | 0..1 | If present in a POST request, it indicates the point in time at which the subscription expires.

Within a POST request the proposed expiry time is conveyed whereas in a POST response or PATCH response the confirmed expiry time is returned. | +| immediateReport | boolean | O | 0..1 | This IE indicates whether immediate report is needed or not.

When present, this IE shall be set as following:
- true: immediate report is required
- false (default) immediate report is not required | +| report | SubscriptionDataSets | C | 0..1 | This IE shall be present in Subscribe response, if the immediateReport attribute is set to "true" in Subscribe request.

When present, this IE shall contain the representation of subscription data sets that to be monitored, i.e. listed in monitoredResourceUris attribute. | + +NOTE 1: The HSS should handle only the relative-path part (apiSpecificResourceUriPart, see 3GPP TS 29.501 [5] clause 4.4.1) and ignore possible inconsistencies (caused by e.g. an SCP) in the base URI part. + +##### 6.2.6.2.4 Type: SubscriptionDataSets + +Table 6.2.6.2.4-1: Definition of type SubscriptionDataSets + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|--------------------|---|-------------|------------------------| +| ueContextInPgwData | UeContextInPgwData | O | 0..1 | UE Context in PGW Data | + +#### 6.2.6.3 Simple data types and enumerations + +##### 6.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +Table 6.2.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | +|-----------|-----------------|-------------| +| | | | + +### 6.2.7 Error Handling + +#### 6.2.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.2.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.2.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nhss\_SubscriberDataManagement service. The following application errors listed in Table 6.2.7.3-1 are specific for the Nhss\_SubscriberDataManagement service. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|------------------------------------------------------------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The user does not exist. | +| DATA_NOT_FOUND | 404 Not Found | The requested data is not found/does not exist. | +| CONTEXT_NOT_FOUND | 404 Not Found | It is used during the modification of an existing subscription when no corresponding context exists. | + +### 6.2.8 Feature Negotiation + +The optional features in table 6.2.8-1 are defined for the Nhss\_SubscriberDataManagement API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.2.9 Security + +As indicated in 3GPP TS 33.501 [6] and 3GPP TS 29.500 [4], the access to the Nhss\_SDM API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [18]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [19]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_SDM API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [19], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nhss\_SDM service. + +The Nhss\_SDM API defines a single scope "nhss-sdm" for OAuth2 authorization (as specified in 3GPP TS 33.501 [6]) for the entire API, and it does not define any additional scopes at resource or operation level. + +### 6.2.10 HTTP redirection + +An HTTP request may be redirected to a different HSS service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different HSS producer instance will return the NF Instance ID of the new HSS producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an HSS redirects a service request to a different HSS using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new HSS towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.3 Nhss\_UEContextManagement Service API + +### 6.3.1 Introduction + +The Nhss\_UEContextManagement service shall use the Nhss\_UEContextManagement API. + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nhss-uecm". +- The shall be "v1". +- The shall be set as described in clause 6.1. + +### 6.3.2 Usage of HTTP + +#### 6.3.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nhss\_UEContextManagement service shall comply with the OpenAPI [10] specification contained in Annex A. + +#### 6.3.2.2 HTTP standard headers + +##### 6.3.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.3.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [11], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 9457 [12]) signalled by the content type "application/problem+json". + +#### 6.3.2.3 HTTP custom headers + +##### 6.3.2.3.1 General + +In this release of the specification, no specific custom headers are defined for the Nhss\_UEContextManagement service. + +For 3GPP specific HTTP custom headers used across all service-based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.3.3 Resources + +#### 6.3.3.1 Overview + +![Diagram showing the resource URI structure of the nhss-uecm API. The base path is {apiRoot}/nhss-uecm/. Three sub-resources are listed: /deregister-sn, /imei-update, and /roaming-status-update, each enclosed in a dashed box and connected to the base path by a vertical line with horizontal branches.](e05122559f56af5699789b7118d8fe87_img.jpg) + +{apiRoot}/nhss-uecm/ + +``` + +graph TD + Base["{apiRoot}/nhss-uecm/"] --- Dashed1[["/deregister-sn"]] + Base --- Dashed2[["/imei-update"]] + Base --- Dashed3[["/roaming-status-update"]] + +``` + +Diagram showing the resource URI structure of the nhss-uecm API. The base path is {apiRoot}/nhss-uecm/. Three sub-resources are listed: /deregister-sn, /imei-update, and /roaming-status-update, each enclosed in a dashed box and connected to the base path by a vertical line with horizontal branches. + +**Figure 6.3.3.1-1: Resource URI structure of the nhss-uecm API** + +Table 6.3.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.3.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------|-----------------------|---------------------------------|-------------------------------------------------------------------| +| n/a | deregister-sn | deregister-sn (POST) | Requesting MME/SGSN deregistration | +| n/a | imei-update | imei-update (POST) | Requests the update of the IMEI of the UE stored in HSS | +| n/a | roaming-status-update | roaming-status-update (POST) | Requests the update of the roaming status of the UE stored in HSS | + +### 6.3.4 Custom Operations without associated resources + +#### 6.3.4.1 Overview + +**Table 6.3.4.1-1: Custom operations without associated resources** + +| Custom operation URI | Mapped HTTP method | Description | +|------------------------------------------------|--------------------|-------------------------------------| +| {apiRoot}/nhss-uecm//deregister-sn | POST | Requesting MME/SGSN deregistration. | + +#### 6.3.4.2 Operation: deregister-sn + +#### 6.3.4.2.1 Description + +This custom operation is used by the NF service consumer (UDM) to request MME/SGSN deregistration. + +#### 6.3.4.2.2 Operation Definition + +This operation shall support the data structures and response codes specified in tables 6.3.4.2.2-1 and 6.3.4.2.2-2. + +**Table 6.3.4.2.2-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | | +|-----------------------|---|-------------|-------------|--| +| DeregistrationRequest | M | 1 | | | + +**Table 6.3.4.2.2-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | + +**Table 6.3.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.3.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.3.4.3 Operation: imei-update + +#### 6.3.4.3.1 Description + +This custom operation is used by the NF service consumer (UDM) to request the update of the IMEI of the UE. + +#### 6.3.4.3.2 Operation Definition + +This operation shall support the data structures and response codes specified in tables 6.3.4.3.2-1 and 6.3.4.3.2-2. + +**Table 6.3.4.3.2-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | | +|----------------|---|-------------|-------------|--| +| ImeiUpdateInfo | M | 1 | | | + +Table 6.3.4.3.2-2: Data structures supported by the POST Response Body + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| ImeiUpdateResponse | M | 1 | 200 OK | Upon success, a response body containing the IMEI(SV) stored previously in HSS shall be returned. | +| n/a | | | 204 No Content | Upon success, if the HSS does not have any IMEI(SV) values stored for the UE, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- CONTEXT_NOT_FOUND | + +Table 6.3.4.3.2-3: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +Table 6.3.4.3.2-4: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.3.4.4 Operation: roaming-status-update + +#### 6.3.4.4.1 Description + +This custom operation is used by the NF service consumer (UDM) to request the update of the roaming status of the UE. + +#### 6.3.4.4.2 Operation Definition + +This operation shall support the data structures and response codes specified in tables 6.3.4.4.2-1 and 6.3.4.4.2-2. + +Table 6.3.4.4.2-1: Data structures supported by the POST Request Body + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|-------------| +| RoamingStatusUpdateInfo | M | 1 | | + +Table 6.3.4.4.2-2: Data structures supported by the POST Response Body + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- CONTEXT_NOT_FOUND | + +Table 6.3.4.4.2-3: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +Table 6.3.4.4.2-4: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.3.5 Notifications + +In this release of this specification, no notifications are defined for the Nhss\_UEContextManagement Service. + +## 6.3.6 Data Model + +### 6.3.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.3.6.1-1 specifies the structured data types defined for the Nhss\_UECM service API. + +Table 6.3.6.1-1: Nhss\_UECM specific Data Types + +| Data type | Clause defined | Description | Applicability | +|-------------------------|----------------|----------------------------------------------|---------------| +| DeregistrationRequest | 6.3.6.2.2 | Contains IMSI, deregistration reason | | +| ImeiUpdateInfo | 6.3.6.2.3 | Contains IMSI, new IMEI(SV) | | +| ImeiUpdateResponse | 6.3.6.2.4 | Contains the previous IMEI(SV) stored in HSS | | +| RoamingStatusUpdateInfo | 6.3.6.2.5 | Contains PLMN-ID where the UE is located | | + +Table 6.3.6.1-2 specifies data types re-used by the Nhss\_UECM service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nhss\_UECM service API. + +**Table 6.3.6.1-2: Nhss\_UECM re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|------------------|--------------------|----------------------------------------------|---------------| +| Guami | 3GPP TS 29.571 [7] | | | +| ProblemDetails | 3GPP TS 29.571 [7] | Response body of error response messages. | | +| RedirectResponse | 3GPP TS 29.571 [7] | Response body of redirect response messages. | | +| PlmnId | 3GPP TS 29.571 [7] | | | + +## 6.3.6.2 Structured data types + +### 6.3.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 6.3.6.2.2 Type: DeregistrationRequest + +**Table 6.3.6.2.2-1: Definition of type DeregistrationRequest** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| imsi | string | M | 1 | pattern: "[0-9]{5,15}\$" | | +| deregReason | DeregistrationReason | M | 1 | String, see clause 6.3.6.3.3 | | +| guami | Guami | O | 0..1 | The GUAMI identifying the AMF where the UE is registered. May be used by the HSS based on operator policy to decide whether a registered VLR shall be cancelled. | | + +### 6.3.6.2.3 Type: ImeiUpdateInfo + +**Table 6.3.6.2.3-1: Definition of type ImeiUpdateInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------------------------------------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------| +| imsi | string | M | 1 | IMSI of the subscriber.
pattern: "[0-9]{5,15}\$" | +| imei | string | C | 0..1 | IMEI of the UE as described in 3GPP TS 23.003 [15], clause 6.2.1; it shall not include the Check Digit.
pattern: "[0-9]{14}\$" | +| imeisv | string | C | 0..1 | IMEISV of the UE as described in 3GPP TS 23.003 [15], clause 6.2.2.
pattern: "[0-9]{16}\$" | +| NOTE: Exactly one of attributes "imei" or "imeisv" shall be present. | | | | | + +## 6.3.6.2.4 Type: ImeiUpdateResponse + +Table 6.3.6.2.4-1: Definition of type ImeiUpdateResponse + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| previousImei | string | C | 0..1 | Previous IMEI of the UE as described in 3GPP TS 23.003 [15], clause 6.2.1; it shall not include the Check Digit.

It shall be included if the HSS has an IMEI value stored for the UE.

pattern: "[0-9]{14}\$" | +| previousImeisv | string | C | 0..1 | IMEISV of the UE as described in 3GPP TS 23.003 [15], clause 6.2.2.

It shall be included if the HSS has an IMEISV value stored for the UE.

pattern: "[0-9]{16}\$" | + +NOTE: At least one of attributes "previousImei" or "previousImeisv" shall be present. + +## 6.3.6.2.5 Type: RoamingStatusUpdateInfo + +Table 6.3.6.2.5-1: Definition of type RoamingStatusUpdateInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------| +| imsi | string | M | 1 | IMSI of the subscriber.

pattern: "[0-9]{5,15}\$" | +| plmnId | PlmnId | M | 1 | PLMN-ID where the UE is located. | + +## 6.3.6.3 Simple data types and enumerations + +## 6.3.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 6.3.6.3.2 Simple data types + +The simple data types defined in table 6.3.6.3.2-1 shall be supported. + +Table 6.3.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | +|-----------|-----------------|-------------| +| | | | + +### 6.3.6.3.3 Enumeration: DeregistrationReason + +**Table 6.3.6.3.3-1: Enumeration DeregistrationReason** + +| Enumeration value | Description | +|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "UE_INITIAL_AND_SINGLE_REGISTRATION" | This value is used when the UDM needs to indicate to HSS that the MME/SGSN, if any, shall be cancelled due to an initial registration for single registration. | +| "UE_INITIAL_AND_DUAL_REGISTRATION" | This value is used when the UDM needs to indicate to HSS that an SGSN shall be cancelled (due to initial registration), but the MME shall not be cancelled (due to dual registration). | +| "EPS_TO_5GS_MOBILITY" | This value is used when the UDM needs to indicate to HSS that the MME/SGSN, if any, shall be cancelled due to a mobility event (i.e. for single registration which is not an initial registration). | + +## 6.3.7 Error Handling + +### 6.3.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +### 6.3.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.3.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nudm\_UEContextManagement service. The application errors defined for the Nhss\_UEContextManagement service are listed in Table 6.3.7.3-1. + +**Table 6.3.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-----------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The user does not exist. | +| CONTEXT_NOT_FOUND | 404 Not Found | It is used when no corresponding UE context exists. | + +## 6.3.8 Feature Negotiation + +The optional features in table 6.3.8-1 are defined for the Nhss\_UEContextManagement API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.3.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 6.3.9 Security + +As indicated in 3GPP TS 33.501 [6] and 3GPP TS 29.500 [4], the access to the Nhss\_UECM API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [18]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [19]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_UECM API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [19], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nhss\_UECM service. + +The Nhss\_UECM API defines a single scope "nhss-uecm" for OAuth2 authorization (as specified in 3GPP TS 33.501 [6]) for the entire API, and it does not define any additional scopes at resource or operation level. + +## 6.3.10 HTTP redirection + +An HTTP request may be redirected to a different HSS service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different HSS producer instance will return the NF Instance ID of the new HSS producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an HSS redirects a service request to a different HSS using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new HSS towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-NF-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# 6.4 Nhss\_EventExposure Service API + +## 6.4.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}// + +where "apiRoot" is defined in clause 4.4.1 of 3GPP TS 29.501 [5], the "apiName" shall be set to "nhss-ee" and the "apiVersion" shall be set to "v1" for the current version of this specification. + +## 6.4.2 Usage of HTTP + +### 6.4.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [13], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nhss\_EE service shall comply with the OpenAPI [14] specification contained in Annex A5. + +### 6.4.2.2 HTTP standard headers + +#### 6.4.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +#### 6.4.2.2.2 Content type + +The following content types shall be supported: + +JSON, as defined in IETF RFC 8259 [15], signalled by the content type "application/json". + +The Problem Details JSON Object (IETF RFC 9457 [16]) signalled by the content type "application/problem+json" + +JSON Patch (IETF RFC 6902 [41]). The use of the JSON Patch format in a HTTP request body shall be signalled by the content type "application/json-patch+json". + +#### 6.4.2.3 HTTP custom headers + +##### 6.4.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.4.3 Resources + +#### 6.4.3.1 Overview + +![Diagram showing the resource URI structure of the Nhss_EE API. The root is {apiRoot}/nhss-ee/{apiVersion}. A branch from this root leads to /{ueld}. From /{ueld}, a branch leads to /ee-subscriptions. From /ee-subscriptions, a branch leads to /{subscriptionId}.](f9528ea5b0d2cd0192b7242e5a6af969_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nhss-ee/{apiVersion}"] --> Ueld["/{ueld}"] + Ueld --> EeSubscriptions["/ee-subscriptions"] + EeSubscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Diagram showing the resource URI structure of the Nhss\_EE API. The root is {apiRoot}/nhss-ee/{apiVersion}. A branch from this root leads to /{ueld}. From /{ueld}, a branch leads to /ee-subscriptions. From /ee-subscriptions, a branch leads to /{subscriptionId}. + +**Figure 6.4.3.1-1: Resource URI structure of the Nhss\_EE API** + +Table 6.4.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.4.3.1-1: Resources and methods overview** + +| Resource name (Archetype) | Resource URI | HTTP method or custom operation | Description | +|------------------------------------|-------------------------------------------|---------------------------------|--------------------------------------------------------------------------| +| EeSubscriptions (Collection) | /{ueld}/ee-subscriptions | POST | Create a subscription | +| Individual subscription (Document) | /{ueld}/ee-subscriptions/{subscriptionId} | PATCH | Update the subscription identified by {subscriptionId} | +| | | DELETE | Delete the subscription identified by {subscriptionId}, i.e. unsubscribe | + +### 6.4.3.2 Resource: EeSubscriptions (Collection) + +#### 6.4.3.2.1 Description + +This resource is used to represent subscriptions to notifications. + +#### 6.4.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ee//{ueId}/ee-subscriptions + +This resource shall support the resource URI variables defined in table 6.4.3.2.2-1. + +**Table 6.4.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.4.1 | +| ueId | Represents the identity of the UE in the HSS (IMSI) or the identity of a group of UEs.
  • - If representing a single UE, this parameter shall contain the IMSI of the UE.
    pattern: See type lmsi in clause 6.4.6.3.2 of this document.
  • - If representing a group of UEs, this parameter shall contain the External Group Id.
    pattern: "^extgroupid-[^@]+@[^\@]+\\$"
(NOTE)
NOTE: If the HSS supports GBEE feature, the ueId can contain the External Group Id, or ueId can only contain IMSI of the UE. | + +#### 6.4.3.2.3 Resource Standard Methods + +##### 6.4.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.4.3.2.3.1-1. + +**Table 6.4.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.4.3.2.3.1-2 and the response data structures and response codes specified in table 6.4.3.2.3.1-3. + +**Table 6.4.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|----------------------------------------| +| EeSubscription | M | 1 | The subscription that is to be created | + +Table 6.4.3.2.3.1-3: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CreatedEeSubscription | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual subscription resource shall be returned, along with event reports that might be immediately available at the HSS.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| EeSubscriptionError | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- MONITORING_NOT_ALLOWED
- MAXIMUM_RESOURCES_EXCEEDED
- MTC_PROVIDER_NOT_ALLOWED | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | +| EeSubscriptionError | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate one of the following application errors:
- UNSUPPORTED_MONITORING_EVENT_TYPE
- UNSUPPORTED_MONITORING_REPORT_OPTIONS

This response shall not be cached. | + +Table 6.4.3.2.3.1-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +Table 6.4.3.2.3.1-5: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.4.3.3 Resource: Individual subscription (Document) + +#### 6.4.3.3.1 Resource Definition + +Resource URI: {apiRoot}/nhss-ee/{apiVersion}/{ueId}/ee-subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.4.3.3.1-1. + +**Table 6.4.3.3.1-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.4.1 | +| ueId | Represents the identity of the UE in the HSS (IMSI) or the identity of a group of UEs.
  • - If representing a single UE, this parameter shall contain the IMSI of the UE.
    pattern: See type lmsi in clause 6.4.6.3.2 of this document.
  • - If representing a group of UEs, this parameter shall contain the External Group Id.
    pattern: "^extgroupid-[^@]+@[^\@]+\+\$"
(NOTE) | +| subscriptionId | The subscriptionId identifies an individual subscription to notifications
The type is string. | + +NOTE: If the HSS supports GBEE feature, the ueId can contain the External Group Id, or ueId can only contain IMSI of the UE. + +### 6.4.3.3.2 Resource Standard Methods + +#### 6.4.3.3.2.1 DELETE + +This method shall support the URI query parameters specified in table 6.4.3.3.2.1-1. + +**Table 6.4.3.3.1.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.4.3.3.2.1-2 and the response data structures and response codes specified in table 6.4.3.3.2.1-3. + +**Table 6.4.3.3.2.1-2: Data structures supported by the Delete Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.4.3.3.2.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +**Table 6.4.3.3.2.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.4.3.3.2.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.4.3.3.2.2 PATCH + +This method shall support the URI query parameters specified in table 6.4.3.3.2.2-1. + +**Table 6.4.3.3.2.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.4.3.3.2.2-2 and the response data structures and response codes specified in table 6.4.3.3.2.2-3. + +**Table 6.4.3.3.2.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Items describe the modifications to the Event Subscription | + +**Table 6.4.3.3.2.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +**Table 6.4.3.3.2.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.4.3.3.2.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.4.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nhss\_EventExposure Service. + +## 6.4.5 Notifications + +### 6.4.5.1 General + +This clause will specify the use of notifications and corresponding protocol details if required for the specific service. When notifications are supported by the API, it will include a reference to the general description of notifications support over the 5G SBIs specified in TS 29.500 / TS 29.501. + +### 6.4.5.2 Event Occurrence Notification + +The POST method shall be used for Event Occurrence Notifications and the URI shall be as provided during the subscription procedure. + +Resource URI: {callbackReference} + +Support of URI query parameters is specified in table 6.4.5.2-1. + +**Table 6.4.5.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.4.5.2-2 and of response data structures and response codes is specified in table 6.4.5.2-3. + +**Table 6.4.5.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|---------------------------------------------------------------------------------------------| +| array(MonitoringReport) | M | 1..N | A list of MonitoringReports each of which contains information regarding the occurred event | + +**Table 6.4.5.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT NOT FOUND | + +NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +**Table 6.4.5.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.4.5.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.4.6 Data Model + +### 6.4.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.4.6.1-1 specifies the data types defined for the Nhss\_EE service API. + +**Table 6.4.6.1-1: Nhss\_EE specific Data Types** + +| Data type | Clause defined | Description | +|----------------------------------|----------------|----------------------------------------------------------------------------| +| EeSubscription | 6.4.6.2.2 | A subscription to Notifications | +| CreatedEeSubscription | 6.4.6.2.3 | | +| MonitoringConfiguration | 6.4.6.2.4 | Monitoring Configuration | +| MonitoringReport | 6.4.6.2.5 | Monitoring Report | +| Report | 6.4.6.2.6 | | +| ReportingOptions | 6.4.6.2.7 | | +| LocationReportingConfiguration | 6.4.6.2.8 | | +| ReachabilityForSmsReport | 6.4.6.2.9 | | +| LossConnectivityConfiguration | 6.4.6.2.10 | | +| ReachabilityForDataConfiguration | 6.4.6.2.11 | | +| PduSessionStatusCfg | 6.4.6.2.12 | Reporting configuration for events related to PDN connectivity Status | +| ReachabilityForDataReport | 6.4.6.2.13 | Report of "UE_REACHABILITY FOR DATA" event | +| FailedMonitoringConfiguration | 6.4.6.2.14 | Failed Monitoring Configuration in the EE subscription | +| EeSubscriptionErrorAddInfo | 6.4.6.2.15 | Event Exposure Subscription Error Additional Information | +| EeSubscriptionError | 6.4.6.2.16 | Event Exposure Subscription Error | +| EventType | 6.4.6.3.3 | | +| LocationAccuracy | 6.4.6.3.4 | | +| FailedCause | 6.4.6.3.5 | Failed cause of the failed Monitoring Configuration in the EE subscription | + +Table 6.4.6.1-2 specifies data types re-used by the Nhss\_EE service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nhss\_EE service API. + +**Table 6.4.6.1-2: Nhss\_EE re-used Data Types** + +| Data type | Reference | Comments | +|---------------------------|---------------------|------------------------------------------------------------------------------| +| Uri | 3GPP TS 29.571 [7] | Uniform Resource Identifier | +| SupportedFeatures | 3GPP TS 29.571 [7] | See 3GPP TS 29.500 [4] clause 6.6 | +| DateTime | 3GPP TS 29.571 [7] | | +| PatchResult | 3GPP TS 29.571 [7] | | +| DurationSec | 3GPP TS 29.571 [7] | | +| DiameterIdentity | 3GPP TS 29.571 [7] | | +| Dnn | 3GPP TS 29.571 [7] | Data Network Name with Network Identifier only. | +| ProblemDetails | 3GPP TS 29.571 [7] | Response body of error response messages. | +| RedirectResponse | 3GPP TS 29.571 [7] | Response body of redirect response messages. | +| MtcProviderInformation | 3GPP TS 29.571 [7] | MTC Provider Information | +| DiameterIdentity | 3GPP TS 29.571 [7] | Diameter Identity (FQDN) | +| LossConnectivityReport | 3GPP TS 29.503 [13] | Report of "LOSS_OF_CONNECTIVITY" event | +| LocationReport | 3GPP TS 29.503 [13] | Report of "LOCATION_REPORTING" event | +| PdnConnectivityStatReport | 3GPP TS 29.503 [13] | Report of "PDN_CONNECTIVITY_STATUS" event | +| ReferenceId | 3GPP TS 29.503 [13] | Reference ID defined in Nudm_EE API. It shall contain a 64-bit long integer. | + +### 6.4.6.2 Structured data types + +#### 6.4.6.2.1 Introduction + +This clause defines the data structures to be used in resource representations. + +## 6.4.6.2.2 Type: EeSubscription + +Table 6.4.6.2.2-1: Definition of type EeSubscription + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| callbackReference | Uri | M | 1 | URI provided by the NF service consumer to receive notifications | +| monitoringConfigurations | map(MonitoringConfiguration) | O | 1..N | A map (list of key-value pairs where referencedId converted from integer to string serves as key) of MonitoringConfigurations | +| scefId | DiameterIdentity | O | 0..1 | Diameter Identity (FQDN) of the SCEF | +| scefDiamRealm | DiameterIdentity | O | 0..1 | When present, It contains the Diameter realm of the SCEF to which the monitored reports may be sent in EPC. | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.4.8 | +| reportingOptions | ReportingOptions | O | 0..1 | This IE may be included if the NF service consumer wants to describe how the reports of the event are to be generated.
If this attribute is not present in the request, it means that the NF service consumer does not specify any maximum number of reports or any expiry time for the subscription; still, the NF service producer (HSS) may set an expiry time in the response to the subscription creation (see clause 6.4.6.2.7). | +| mtcProviderInformation | MtcProviderInformation | O | 0..1 | Indicates MTC provider information for Monitoring Configuration authorization. | +| externalIdentifier | string | O | 0..1 | Represents a single external Identifier or a group of external Identifiers:
  • - If representing a single external identifier:
    pattern: "extid-[^@]+@[^\@]+\\$"
  • - If representing a group of external identifiers:
    pattern: "extgroupid-[^@]+@[^\@]+\\$"
| + +## 6.4.6.2.3 Type: CreatedEeSubscription + +Table 6.4.6.2.3-1: Definition of type CreatedEeSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------|------------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eeSubscription | EeSubscription | M | 1 | This IE shall contain the representation of the created event subscription. | | +| eventReports | array(MonitoringReport) | O | 1..N | This IE may be included when the NF consumer has indicated supporting of ERIR feature in the subscription creation request (see clause 6.4.8).

This IE when present, shall contain the status of events that are requested for immediate reporting as well, if those events are available at the time of subscription. | ERIR | +| failedMonitoringConfigs | map(FailedMonitoringConfiguration) | O | 1..N | A map (list of key-value pairs where ReferenceId converted from integer to string serves as key; see clause 6.4.6.3.2) of FailedMonitoringConfiguration; see clause 6.4.6.2.14.

This IE is used to indicate the failed subscriptions of event monitoring configuration and the failed cause for them. | | +| currentStatusNotAvailableList | array(EventType) | O | 1..N | This IE should be present if immediate reporting was requested by the NF consumer, but the current status of at least one of the subscribed events is not available at the time of subscription.

When present, this IE shall list the events for which the current status is not available for immediate reporting. | | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.4.8 | | + +## 6.4.6.2.4 Type: MonitoringConfiguration + +Table 6.4.6.2.4-1: Definition of type MonitoringConfiguration + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------------|----------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| eventType | EventType | M | 1 | Event type | +| immediateFlag | boolean | O | 0..1 | Indicates if an immediate event report in the subscription response indicating current value / status of the event is required, if available. If the flag is not present, then immediate reporting may be skipped. | +| locationReportingConfiguration | LocationReportingConfiguration | C | 0..1 | Shall be present if eventType is "LOCATION_REPORTING" | +| lossConnectivityConfiguration | LossConnectivityConfiguration | O | 0..1 | May be present if eventType is "LOSS_OF_CONNECTIVITY". | +| reachabilityForDataConfiguration | ReachabilityForDataConfiguration | O | 0..1 | May be present if eventType is "UE_REACHABILITY_FOR_DATA" | +| pduSessionStatusCfg | PduSessionStatusCfg | O | 0..1 | may be present if eventType is "PDN_CONNECTIVITY_STATUS" | +| idleStatusInd | boolean | O | 0..1 | Idle Status Indication request.

May be present if eventType is "UE_REACHABILITY_FOR_DATA" or "AVAILABILITY_AFTER_DDN_FAILURE"

When present, this IE shall be set as following:
- true: Idle status indication is requested
- false (default): Idle status indication is not requested | + +## 6.4.6.2.5 Type: MonitoringReport + +Table 6.4.6.2.5-1: Definition of type MonitoringReport + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| referenceId | ReferenceId | M | 1 | Shall contain the Reference ID which was provided as the key of the associated monitoring configuration in subscription request. The consumer can use this IE to uniquely associate the report with the corresponding event that was requested to be monitored. | +| eventType | EventType | M | 1 | String; see clause 6.4.6.3.3
only the following values are allowed:
"UE_REACHABILITY_FOR_SMS"
"UE_REACHABILITY_FOR_DATA"
"LOSS_OF_CONNECTIVITY"
"LOCATION_REPORTING"
"PDN_CONNECTIVITY_STATUS" | +| timeStamp | DateTime | M | 1 | Point in time at which the event occurred | +| report | Report | O | 0..1 | Shall be present if eventType is
"UE_REACHABILITY_FOR_SMS"
"UE_REACHABILITY_FOR_DATA"
"LOSS_OF_CONNECTIVITY"
"LOCATION_REPORTING"
"PDN_CONNECTIVITY_STATUS" | + +## 6.4.6.2.6 Type: Report + +Table 6.4.6.2.6-1: Definition of type Report + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|----------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reachabilityForSmsReport | ReachabilityForSms Report | O | 0..1 | Reports the UE reachability for SMS | +| reachabilityForDataReport | ReachabilityForData Report | O | 0..1 | Reports the UE reachability for Data | +| lossConnectivityReport | LossConnectivityReport | O | 0..1 | Reports the Loss of Connectivity | +| locationReport | LocationReport | O | 0..1 | Reports the UE Location | +| pdnConnectivityStatReport | PdnConnectivityStat Report | O | 0..1 | Reports the PDN Connectivity Status.
Absence of pdnConnectivityStatReport in MonitoringReports with EventType "PDN_CONNECTIVITY_STATUS" indicates that the requested APN is not active. | + +## 6.4.6.2.7 Type: ReportingOptions + +Table 6.4.6.2.7-1: Definition of type ReportingOptions + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| maxNumOfReports | MaxNumOfReports | O | 0..1 | Maximum number of reports. If not present, the NF service consumer does not specify any maximum number of reports to be received.
(NOTE) | +| expiry | DateTime | C | 0..1 | This IE shall be included in an event subscription response, if, based on operator policy, the HSS needs to include an expiry time, and may be included in an event subscription request. When present, this IE shall represent the time at which monitoring shall cease and the subscription becomes invalid. If the maxNumOfReports included in an event subscription response is 1 and if an event report is included in the subscription response then the value of the expiry included in the response shall be an immediate timestamp.
(NOTE) | +| reportPeriod | DurationSec | C | 0..1 | Indicates the interval time between which the event notification is reported, may be present if event type is "LOCATION_REPORTING" | + +NOTE: If parameter "maxNumOfReports" and "expiry" are included at the same time, the subscription will expire as soon as one of the conditions is met. + +## 6.4.6.2.8 Type: LocationReportingConfiguration + +Table 6.4.6.2.8-1: Definition of type LocationReportingConfiguration + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------| +| currentLocation | boolean | M | 1 | true: Indicates that current location is requested.
false: Indicates that last known location is requested. | +| accuracy | LocationAccuracy | C | 0..1 | Indicates whether Cell-level or TA-level accuracy is requested. Shall be present when current location is requested. | + +## 6.4.6.2.9 Type: ReachabilityForSmsReport + +Table 6.4.6.2.9-1: Definition of type ReachabilityForSmsReport + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reachabilitySmsStatus | boolean | M | 1 | true: UE is reachable for SMS
false: UE is not reachable for SMS | +| maxAvailabilityTime | DateTime | O | 0..1 | Indicates the time (in UTC) until which the UE is expected to be reachable.

This information may be used by the SMS Service Center to prioritize the retransmission of pending Mobile Terminated Short Message to UEs using a power saving mechanism (eDRX, PSM etc.). | + +## 6.4.6.2.10 Type: LossConnectivityConfiguration + +Table 6.4.6.2.10-1: Definition of type LossConnectivityConfiguration + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-------------|---|-------------|------------------------------------------------------------------| +| maxDetectionTime | DurationSec | O | 0..1 | When present, it indicates the configured Maximum Detection Time | + +## 6.4.6.2.11 Type: ReachabilityForDataConfiguration + +Table 6.4.6.2.11-1: Definition of type ReachabilityForDataConfiguration + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|-------------|---|-------------|----------------------------------------------------------------------------------------| +| maximumLatency | DurationSec | O | 0..1 | When present, it indicates the configured Maximum Latency. (NOTE) | +| maximumResponseTime | DurationSec | O | 0..1 | When present, it indicates the configured Maximum Response Time. (NOTE) | +| suggestedPacketNumDI | integer | O | 0..1 | When present, it indicates the configured Suggested number of downlink packets. (NOTE) | + +NOTE: At least one of maximumLatency, maximumResponseTime or suggestedPacketNumDI shall be present + +## 6.4.6.2.12 Type: PduSessionStatusCfg + +Table 6.4.6.2.12-1: Definition of type PduSessionStatusCfg + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------| +| apn | Dnn | O | 0..1 | When present, it indicates the APN for which the event is monitored. Absence indicates that monitoring of the event applies to all APNs. | + +## 6.4.6.2.13 Type: ReachabilityForDataReport + +Table 6.4.6.2.13-1: Definition of type ReachabilityForDataReport + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reachabilityDataStatus | boolean | M | 1 | true: UE is reachable for Data
false: UE is not reachable for Data | +| maxAvailabilityTime | DateTime | O | 0..1 | Indicates the time (in UTC) until which the UE is expected to be reachable.

This information may be used by the SMS Service Center to prioritize the retransmission of pending Mobile Terminated Short Message to UEs using a power saving mechanism (eDRX, PSM etc.). | + +## 6.4.6.2.14 Type: FailedMonitoringConfiguration + +Table 6.4.6.2.14-1: Definition of type FailedMonitoringConfiguration + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|------------------------------------------------------------------------| +| eventType | EventType | M | 1 | Contains the Event type, see clause 6.4.6.3.3 | +| failedCause | FailedCause | M | 1 | Contains the failed cause of the subscription of the event monitoring. | + +## 6.4.6.2.15 Type: EeSubscriptionErrorAddInfo + +Table 6.4.6.2.15-1: Definition of type EeSubscriptionErrorAddInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|------------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| failedMonitoringConfigs | map(FailedMonitoringConfiguration) | O | 1..N | A map (list of key-value pairs where ReferenceId converted from integer to string serves as key; see clause 6.4.6.3.2) of FailedMonitoringConfiguration; see clause 6.4.6.2.14.

This IE is used to indicate the failed subscriptions of event monitoring configuration and the failed cause for them. | + +## 6.4.6.2.16 Type: EeSubscriptionError + +Table 6.4.6.2.16-1: Definition of type EeSubscriptionError as a list of to be combined data types + +| Data type | Cardinality | Description | Applicability | +|----------------------------|-------------|----------------------------------------------------------|---------------| +| ProblemDetails | 1 | Detail information of the problem | | +| EeSubscriptionErrorAddInfo | 1 | Additional information to be returned in error response. | | + +## 6.4.6.3 Simple data types and enumerations + +## 6.4.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 6.4.6.3.2 Simple data types + +The simple data types defined in table 6.4.6.3.2-1 shall be supported. + +**Table 6.4.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------| +| Imsi | string | IMSI
pattern: '^(imsi-[0-9]{5,15})\$' | +| UeIdOrGroupId | string | Contains the UE identifier or the Group Identifier of the UE.
pattern: '^(imsi-[0-9]{5,15} extgroupid-[^@]+@[^@]+ .+)\$' | +| MaxNumOfReports | integer | Maximum number of reports.
Minimum: 1 | + +### 6.4.6.3.3 Enumeration: EventType + +**Table 6.4.6.3.3-1: Enumeration EventType** + +| Enumeration value | Description | +|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "LOSS_OF_CONNECTIVITY" | Loss of connectivity event | +| "UE_REACHABILITY_FOR_DATA" |

UE reachability for Data, implements the "UE Reachability for Data" event as specified in 3GPP TS 23.682 [18].

When this event is subscribed by an NF service consumer, the HSS shall send an Insert Subscriber Data Request message to the MME/SGSN for the UE with the Monitoring-Type AVP set to the value UE_REACHABILITY and the Reachability-Information AVP set to the value REACHABLE_FOR_DATA, see clause 5.2.2.1.3 of 3GPP TS 29.272 [17].

| +| "UE_REACHABILITY_FOR_SMS" |

UE reachability for SMS, implements the "UE Reachability for SMS Delivery" event as specified in 3GPP TS 23.682 [18].

This event only supports One-Time reporting.

| +| "LOCATION_REPORTING" | Location Reporting event | +| "COMMUNICATION_FAILURE" | Communication Failure event | +| "AVAILABILITY_AFTER_DDN_FAILURE" | Availability after DDN failure event | +| "PDN_CONNECTIVITY_STATUS" | PDN Connectivity Status event | + +#### 6.4.6.3.4 Enumeration: LocationAccuracy + +**Table 6.4.6.3.4-1: Enumeration LocationAccuracy** + +| Enumeration value | Description | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "CELL_LEVEL" | Change of cell shall be reported, equivalent to the value "CGI-ECGI (0)" of Accuracy IE of HSS Diameter interface as specified in clause 8.4.17 of 3GPP TS 29.336 [21]. | +| "RAN_NODE_LEVEL" | change of serving RAN node shall be reported, equivalent to the value "eNB (1)" of Accuracy IE of HSS Diameter interface as specified in clause 8.4.17 of 3GPP TS 29.336 [21]. | +| "TA_LEVEL" | Change of TA shall be reported, equivalent to the value " LA-TA-RA (2)" of Accuracy IE of HSS Diameter interface as specified in clause 8.4.17 of 3GPP TS 29.336 [21]. | + +#### 6.4.6.3.5 Enumeration: FailedCause + +**Table 6.4.6.3.5-1: Enumeration FailedCause** + +| Enumeration value | Description | +|-----------------------------------------|-------------------------------------------------------------------------------------------------------| +| "MTC_PROVIDER_NOT_ALLOWED" | MTC Provider is now allowed to perform monitoring for the requested event type. | +| "MONITORING_NOT_ALLOWED" | The subscriber does not have the necessary subscription for monitoring with the requested Event Type. | +| "UNSUPPORTED_MONITORING_EVENT_TYPE" | The required event type is unsupported. | +| "UNSUPPORTED_MONITORING_REPORT_OPTIONS" | The monitoring configuration for the required event type contains unsupported report options. | +| "UNSPECIFIED" | The failed cause is unspecified. | + +### 6.4.7 Error Handling + +#### 6.4.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.4.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.4.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nhss\_EventExposure service. The following application errors listed in Table 6.4.7.3-1 are specific for the Nhss\_EventExposure service. + +**Table 6.4.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------------------|---------------------|-------------------------------------------------------------------------------------------------------| +| MONITORING_NOT_ALLOWED | 403 Forbidden | The subscriber does not have the necessary subscription for monitoring with the requested Event Type. | +| MTC_PROVIDER_NOT_ALLOWED | 403 Forbidden | MTC Provider not authorized to perform monitoring configuration. | +| USER_NOT_FOUND | 404 Not Found | The user does not exist | +| CONTEXT_NOT_FOUND | 404 Not Found | It is used when no corresponding context exists. | +| UNSUPPORTED_MONITORING_EVENT_TYPE | 501 Not Implemented | The monitoring configuration contains unsupported event type. | +| UNSUPPORTED_MONITORING_REPORT_OPTIONS | 501 Not Implemented | The monitoring configuration contains unsupported report options. | + +### 6.4.8 Feature Negotiation + +The optional features in table 6.4.8-1 are defined for the Nhss\_EE API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.4.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ERIR | Event Reports in Response
An NF consumer supporting this feature shall be able to handle the event reports within the Event Subscription Create Response, as specified in clause 5.5.2.2.2. | +| 2 | GBEE | Support of Group-based Event Exposure.
This feature bit indicates whether the Nhss_EventExposure Service support Group-based Event Exposure or not. | + +## 6.4.9 Security + +As indicated in 3GPP TS 33.501 [6] and 3GPP TS 29.500 [4], the access to the Nhss\_EE API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [18]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [19]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_EE API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [19], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nhss\_EE service. + +The Nhss\_EE API defines a single scope "nhss-ee" for OAuth2 authorization (as specified in 3GPP TS 33.501 [6]) for the entire API, and it does not define any additional scopes at resource or operation level. + +## 6.4.10 HTTP redirection + +An HTTP request may be redirected to a different HSS service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different HSS producer instance will return the NF Instance ID of the new HSS producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an HSS redirects a service request to a different HSS using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new HSS towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +--- + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the Nhss Service API(s). It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [14] clause 5B). + +--- + +## A.2 Nhss\_UEAuthentication API + +``` +openapi: 3.0.0 +info: + version: '1.2.0-alpha.2' + title: 'NhssUEAU' + description: | + HSS UE Authentication Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.563 HSS Services for Interworking With UDM, version 18.4.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.563/' + +servers: + - url: '{apiRoot}/nhss-ueau/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - oAuth2ClientCredentials: + - nhss-ueau + - {} + +paths: + /generate-av: + post: + summary: Generate authentication vector for the UE + operationId: GenerateAV + tags: + - Generate Auth Vector + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AvGenerationRequest' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/AvGenerationResponse' +``` + +``` +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-ueau: Access to the nhss-ueau API + +schemas: + +# STRUCTURED TYPES: + +AvGenerationRequest: + description: > + It represents the request body in the Authentication Vector (AV) request sent by UDM to HSS, + containing the IMSI of the UE, authentication type, serving network, etc. + type: object + required: + - imsi + - authType + - servingNetworkName + properties: + imsi: + type: string + pattern: '^[0-9]{5,15}$' + authType: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/AuthType' + servingNetworkName: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ServingNetworkName' + resynchronizationInfo: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ResynchronizationInfo' + +AvGenerationResponse: + description: > + It represents the response body in the AV response sent by HSS to UDM, containing the 5G-AKA + or EAP-AKA-prime authentication vector + type: object + oneOf: + - required: + - avEapAkaPrime + - required: + - av5GHeAka + properties: +``` + +``` +avEapAkaPrime: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/AvEapAkaPrime' +av5GHeAka: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Av5GHeAka' +``` + +``` +# SIMPLE TYPES: +``` + +``` +# ENUMS: +``` + +--- + +## A.3 Nhss\_SubscriberDataManagement API + +``` +openapi: 3.0.0 + +info: + version: '1.2.0-alpha.2' + title: 'Nhss_SDM' + description: | + HSS Subscriber Data Management. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.563 HSS Services for Interworking With UDM, version 18.4.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.563/' + +servers: + - url: '{apiRoot}/nhss-sdm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - oAuth2ClientCredentials: + - nhss-sdm + - {} + +paths: + /{ueId}/ue-context-in-pgw-data: + get: + summary: Retrieve the UE Context In PGW + operationId: GetUeCtxInPgwData + tags: + - UE Context In PGW Data Retrieval + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + type: string + pattern: '^(imsi-[0-9]{5,15})$' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextInPgwData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/subscriptions: + post: + summary: subscribe to notifications + operationId: Subscribe + tags: + - Subscription Creation + parameters: + - name: ueId + in: path + description: IMSI of the user + required: true + schema: + type: string + pattern: '^(imsi-[0-9]{5,15})$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-sdm/{apiVersion}/{ueId}/subscriptions/{subscriptionId} + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + callbacks: +``` + +``` + +datachangeNotification: + '{request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ModificationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/subscriptions/{subscriptionId}: + delete: + summary: unsubscribe from notifications + operationId: Unsubscribe + tags: + - Subscription Deletion + parameters: + - name: ueId + in: path + description: IMSI of the user + required: true + schema: + type: string + pattern: '^imsi-[0-9]{5,15}$' + - name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string + responses: + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + +``` + +``` +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +patch: + summary: modify the subscription + operationId: Modify + tags: + - Subscription Modification + parameters: + - name: ueId + in: path + description: IMSI of the user + required: true + schema: + type: string + pattern: '^(imsi-[0-9]{5,15})$' + - name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '204': + description: Successful modification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-sdm: Access to the nhss-sdm API +``` + +``` + +schemas: + +# STRUCTURED TYPES: + +UeContextInPgwData: + description: > + Contains data about APNs and PGW-C+SMF FQDNs used in interworking with UDM, and the + PGW-C+SMF FQDN to be used for emergency session + type: object + properties: + pgwInfo: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/PgwInfo' + minItems: 1 + emergencyFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + emergencyPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + emergencyIpAddress: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpAddress' + emergencyRegistrationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +SubscriptionData: + description: > + Contains data about a subscription request, to be created by a consumer to an URI of the + HSS_SDM API to be monitored; it also represents the response containing data about the + created subscription + type: object + required: + - nfInstanceId + - callbackReference + - monitoredResourceUris + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + callbackReference: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + monitoredResourceUris: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + expires: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + immediateReport: + type: boolean + default: false + report: + $ref: '#/components/schemas/SubscriptionDataSets' + +SubscriptionDataSets: + description: > + Contains data to be reported as an immediate report in the response to a subscription + creation request + type: object + properties: + ueContextInPgwData: + $ref: '#/components/schemas/UeContextInPgwData' + +# SIMPLE TYPES: + +# ENUMS: + +``` + +## A.4 Nhss\_UEContextManagement API + +openapi: 3.0.0 + +``` + +info: + version: '1.2.0-alpha.2' + title: 'Nhss_UECM' + description: | + +``` + +HSS UE Context Management. +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +externalDocs: +description: 3GPP TS 29.563 HSS Services for Interworking With UDM, version 18.4.0 +url: 'https://www.3gpp.org/ftp/Specs/archive/29\_series/29.563/' + +servers: +- url: '{apiRoot}/nhss-uecm/v1' +variables: +apiRoot: +default: https://example.com +description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: +- oAuth2ClientCredentials: +- nhss-uecm +- {} + +paths: +/deregister-sn: +post: +summary: MME/SGSN Deregistration +operationId: DeregisterSN +tags: +- MME/SGSN Deregistration +requestBody: +content: +application/json: +schema: +\$ref: '#/components/schemas/DeregistrationRequest' +required: true +responses: +'204': +description: No content +'307': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/307' +'308': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/308' +'400': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/400' +'401': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/401' +'403': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/403' +'404': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/404' +'411': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/411' +'413': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/413' +'415': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/415' +'429': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/429' +'500': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/500' +'501': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/501' +'502': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/502' +'503': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/503' +default: +description: Unexpected error + +/imei-update: +post: +summary: IMEI Update +operationId: IMEIUpdate +tags: +- IMEI Update +requestBody: +content: +application/json: +schema: +\$ref: '#/components/schemas/ImeiUpdateInfo' + +``` + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImeiUpdateResponse' + '204': + description: No content + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/roaming-status-update: + post: + summary: Roaming Status Update + operationId: RoamingStatusUpdate + tags: + - Roaming Status Update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingStatusUpdateInfo' + required: true + responses: + '204': + description: No content + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +``` + +``` +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-uecm: Access to the nhss-uecm API + +schemas: + +# STRUCTURED TYPES: + +DeregistrationRequest: + description: > + It represents the request body of the deregistration request sent by UDM to HSS and contains + the IMSI of the UE, the deregistration reason, etc. + type: object + required: + - imsi + - deregReason + properties: + imsi: + type: string + pattern: '^[0-9]{5,15}$' + deregReason: + $ref: '#/components/schemas/DeregistrationReason' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + +ImeiUpdateInfo: + description: > + It represents the request body of the IMEI update request sent by UDM to HSS, + and contains the IMSI of the UE and the new IMEI(SV) + type: object + required: + - imsi + oneOf: + - required: [ imei ] + - required: [ imeisv ] + properties: + imsi: + type: string + pattern: '^[0-9]{5,15}$' + imei: + type: string + pattern: '^[0-9]{14,15}$' + imeisv: + type: string + pattern: '^[0-9]{16}$' + +ImeiUpdateResponse: + description: > + It represents the response body of the IMEI update request sent by UDM to HSS, + and contains the previous IMEI(SV) stored by HSS + type: object + anyOf: + - required: [ previousImei ] + - required: [ previousImeisv ] + properties: + previousImei: + type: string + pattern: '^[0-9]{14,15}$' + previousImeisv: + type: string + pattern: '^[0-9]{16}$' + +RoamingStatusUpdateInfo: +``` + +``` + +description: > + It represents the request body of the Roaming Status Update request sent by UDM to HSS, + and contains the IMSI of the UE and the new PLMN-ID +type: object +required: + - imsi + - plmnId +properties: + imsi: + type: string + pattern: '^[0-9]{5,15}$' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + +``` + +# SIMPLE TYPES: + +# ENUMS: + +``` + +DeregistrationReason: + description: The reason that triggers that the serving node needs to be deregistered by HSS + anyOf: + - type: string + enum: + - UE_INITIAL_AND_SINGLE_REGISTRATION + - UE_INITIAL_AND_DUAL_REGISTRATION + - EPS_TO_5GS_MOBILITY + - type: string + +``` + +## A.5 Nhss\_EE API + +openapi: 3.0.0 + +``` + +info: + version: '1.2.0-alpha.3' + title: 'Nhss_EE' + description: | + HSS Event Exposure. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +``` + +``` + +externalDocs: + description: 3GPP TS 29.563 HSS Services for Interworking With UDM, version 18.4.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.563/' + +``` + +``` + +servers: + - url: '{apiRoot}/nhss-ee/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +``` + +``` + +security: + - {} + - oAuth2ClientCredentials: + - nhss-ee + +``` + +``` + +paths: + /{ueId}/ee-subscriptions: + post: + summary: Subscribe + operationId: CreateEeSubscription + tags: + - EE Subscription (Collection) + parameters: + - name: ueId + in: path + description: IMSI of the subscriber or the identity of a group of UEs + required: true + schema: + $ref: '#/components/schemas/UeIdOrGroupId' + requestBody: + content: + application/json: + schema: + +``` + +``` + $ref: '#/components/schemas/EeSubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/CreatedEeSubscription' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-ee/v1/{ueId}/ee-subscriptions/{subscriptionId} + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/EeSubscriptionError' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + description: Not Implemented + content: + application/problem+json: + schema: + $ref: '#/components/schemas/EeSubscriptionError' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + callbacks: + eventOccurrenceNotification: + '{request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MonitoringReport' + minItems: 1 + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/ee-subscriptions/{subscriptionId}: + delete: + summary: Unsubscribe + operationId: DeleteEeSubscription + tags: + - Delete EE Subscription + parameters: + - name: ueId + in: path + description: IMSI of the subscriber or the identity of a group of UEs + required: true + schema: + $ref: '#/components/schemas/UeIdOrGroupId' + - name: subscriptionId + in: path + description: Id of the EE Subscription + required: true + schema: + type: string + responses: + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + + patch: + summary: Patch + operationId: UpdateEeSubscription + tags: + - Update EE Subscription + parameters: + - name: ueId + in: path + description: IMSI of the subscriber or the identity of a group of UEs + required: true + schema: +``` + +``` + + $ref: '#/components/schemas/UEIdOrGroupId' + - name: subscriptionId + in: path + description: Id of the EE Subscription + required: true + schema: + type: string + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-ee: Access to the nhss-ee API + +schemas: + +# STRUCTURED TYPES: + +EeSubscription: + description: > + It represents the request body of the subscription request sent to HSS, containing data + related to the subscription to be created, such as the SCEF, Monitoring Configurations and + reporting options + type: object + required: + - callbackReference + properties: + callbackReference: + +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +sceId: +$ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' +sceDiamRealm: +$ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' +monitoringConfigurations: + description: > + A map (list of key-value pairs where ReferenceId serves as key) of + MonitoringConfigurations + type: object + additionalProperties: + $ref: '#/components/schemas/MonitoringConfiguration' + minProperties: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + reportingOptions: + $ref: '#/components/schemas/ReportingOptions' + mtcProviderInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' + externalIdentifier: + type: string + +CreatedEeSubscription: + description: > + It represents the response body of the subscription request, containing data of the created + subscription in the HSS + type: object + required: + - eeSubscription + properties: + eeSubscription: + $ref: '#/components/schemas/EeSubscription' + eventReports: + type: array + items: + $ref: '#/components/schemas/MonitoringReport' + minItems: 1 + failedMonitoringConfigs: + description: > + A map (list of key-value pairs where referenceId converted from integer to string serves + as key; see clause 6.4.6.3.2) of FailedMonitoringConfiguration + type: object + additionalProperties: + $ref: '#/components/schemas/FailedMonitoringConfiguration' + minProperties: 1 + currentStatusNotAvailableList: + type: array + items: + $ref: '#/components/schemas/EventType' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +FailedMonitoringConfiguration: + description: > + Contains the event type and failed cause of the failed Monitoring Configuration + in the EE subscription + type: object + required: + - eventType + - failedCause + properties: + eventType: + $ref: '#/components/schemas/EventType' + failedCause: + $ref: '#/components/schemas/FailedCause' + +MonitoringConfiguration: + description: > + Contains data for each Monitoring Configuration (such as event type, etc.) and + the configuration data needed depending on each event type + type: object + required: + - eventType + properties: + eventType: + $ref: '#/components/schemas/EventType' + immediateFlag: +``` + +``` + type: boolean + locationReportingConfiguration: + $ref: '#/components/schemas/LocationReportingConfiguration' + lossConnectivityConfiguration: + $ref: '#/components/schemas/LossConnectivityConfiguration' + reachabilityForDataConfiguration: + $ref: '#/components/schemas/ReachabilityForDataConfiguration' + pduSessionStatusCfg: + $ref: '#/components/schemas/PduSessionStatusCfg' + idleStatusInd: + type: boolean + default: false + +MonitoringReport: + description: Contains data for each Monitoring Event Report sent by the HSS + type: object + required: + - referenceId + - eventType + - timeStamp + properties: + referenceId: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/ReferenceId' + eventType: + $ref: '#/components/schemas/EventType' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + report: + $ref: '#/components/schemas/Report' + +ReportingOptions: + description: > + Contains the different reporting options associated to a given subscription created in HSS + type: object + properties: + maxNumOfReports: + $ref: '#/components/schemas/MaxNumOfReports' + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + reportPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + +Report: + description: Contains data for a given Monitoring Event Report + type: object + properties: + reachabilityForSmsReport: + $ref: '#/components/schemas/ReachabilityForSmsReport' + reachabilityForDataReport: + $ref: '#/components/schemas/ReachabilityForDataReport' + lossConnectivityReport: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/LossConnectivityReport' + locationReport: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/LocationReport' + pdnConnectivityStatReport: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/PdnConnectivityStatReport' + +ReachabilityForSmsReport: + description: > + Contains data for a Monitoring Event Report, specific to the 'Reachability For SMS' + event type + type: object + required: + - reachabilitySmsStatus + properties: + reachabilitySmsStatus: + type: boolean + maxAvailabilityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +ReachabilityForDataReport: + description: > + Contains data for a Monitoring Event Report, specific to the 'Reachability For Data' + event type + type: object + required: + - reachabilityDataStatus + properties: +``` + +``` +reachabilityDataStatus: + type: boolean + maxAvailabilityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +LossConnectivityConfiguration: + description: > + Contains data needed for a Monitoring Configuration, specific to the 'Loss of Connectivity' + event type + type: object + properties: + maxDetectionTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + +LocationReportingConfiguration: + description: > + Contains data needed for a Monitoring Configuration, specific to the 'Location Reporting' + event type + type: object + required: + - currentLocation + properties: + currentLocation: + type: boolean + accuracy: + $ref: '#/components/schemas/LocationAccuracy' + +ReachabilityForDataConfiguration: + description: > + Contains data needed for a Monitoring Configuration, specific to the 'Reachability for Data' + event type + type: object + anyOf: + - required: [ maximumLatency ] + - required: [ maximumResponseTime ] + - required: [ suggestedPacketNumDl ] + properties: + maximumLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + maximumResponseTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + suggestedPacketNumDl: + type: integer + minimum: 1 + +PduSessionStatusCfg: + description: > + Contains data needed for a Monitoring Configuration, specific to the 'PDN Connectivity + Status' event type + type: object + properties: + apn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + +EeSubscriptionErrorAddInfo: + description: Additional Information for EE Subscription Error. + type: object + properties: + failedMonitoringConfigs: + description: > + A map (list of key-value pairs where referenceId converted from integer to string serves + as key; see clause 6.4.6.3.2) of FailedMonitoringConfiguration + type: object + additionalProperties: + $ref: '#/components/schemas/FailedMonitoringConfiguration' + minProperties: 1 + +EeSubscriptionError: + description: EE Subscription Error. + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/EeSubscriptionErrorAddInfo' + +# SIMPLE TYPES: + +Imsi: + description: IMSI of the UE + type: string +``` + +pattern: '^^(imsi-[0-9]{5,15})\$' + +UeIdOrGroupId: + +description: Contains the UE identifier or the Group Identifier of the UE + +type: string + +pattern: '^^(imsi-[0-9]{5,15}|extgroupid-[^@]+@[^\+]+\+|.+)\$' + +MaxNumOfReports: + +description: Maximum number of events to be reported for events in a given subscription + +type: integer + +minimum: 1 + +# ENUMS: + +EventType: + +description: Type of Monitoring Event + +anyOf: + +- type: string + +enum: + +- LOSS\_OF\_CONNECTIVITY +- UE\_REACHABILITY\_FOR\_DATA +- UE\_REACHABILITY\_FOR\_SMS +- LOCATION\_REPORTING +- COMMUNICATION\_FAILURE +- AVAILABILITY\_AFTER\_DDN\_FAILURE +- PDN\_CONNECTIVITY\_STATUS + +- type: string + +LocationAccuracy: + +description: Location accuracy used in the 'Location Reporting' event type + +anyOf: + +- type: string + +enum: + +- CELL\_LEVEL +- RAN\_NODE\_LEVEL +- TA\_LEVEL + +- type: string + +FailedCause: + +description: > + +Indicates the Failed cause of the failed Monitoring Configuration in the EE subscription + +anyOf: + +- type: string + +enum: + +- MTC\_PROVIDER\_NOT\_ALLOWED +- MONITORING\_NOT\_ALLOWED +- UNSUPPORTED\_MONITORING\_EVENT\_TYPE +- UNSUPPORTED\_MONITORING\_REPORT\_OPTIONS +- UNSPECIFIED + +- type: string + +--- + +## Annex B (informative): Withdrawn API versions + +### B.1 General + +This Annex lists withdrawn API versions of the APIs defined in the present specification. 3GPP TS 29.501 [5] clause 4.3.1.6 describes the withdrawal of API versions. + +## Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|---------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-05 | CT4#91 | C4-192407 | | | | Initial Draft. | 0.1.0 | +| 2019-09 | CT4#93 | C4-193847 | | | | Incorporation of pCRs agreed at CT4#93 in C4-193553, C4-193624. | 0.2.0 | +| 2019-10 | CT4#94 | C4-194521 | | | | Incorporation of pCRs agreed at CT4#94 in C4-194346. | 0.3.0 | +| 2019-11 | CT4#95 | C4-195636 | | | | Incorporation of pCRs agreed at CT4#95 in C4-195579. | 0.4.0 | +| 2019-12 | CT#86 | CP-193067 | | | | TS presented for information | 1.0.0 | +| 2020-03 | CT4#96 | C4-201271 | | | | Incorporation of pCRs agreed at CT4#96 in C4-200880, C4-200917, C4-200964, C4-201100. | 1.1.0 | +| 2020-03 | CT#87 | CP-200065 | | | | TS presented for approval | 2.0.0 | +| 2020-03 | CT#87 | | | | | Approved at CT#87 | 16.0.0 | +| 2020-07 | CT#88 | CP-201033 | 0001 | - | B | Storage of YAML files in ETSI Forge | 16.1.0 | +| 2020-07 | CT#88 | CP-201033 | 0002 | - | F | PGW-C+SMF FQDN for Emergency Session | 16.1.0 | +| 2020-07 | CT#88 | CP-201033 | 0003 | 1 | B | Initial Registration | 16.1.0 | +| 2020-07 | CT#88 | CP-201033 | 0004 | 1 | B | HSS Event Exposure | 16.1.0 | +| 2020-07 | CT#88 | CP-201033 | 0005 | 1 | F | Serving Node Deregistration | 16.1.0 | +| 2020-07 | CT#88 | CP-201073 | 0006 | - | F | 29.563 Rel-16 API version and External doc update | 16.1.0 | +| 2020-09 | CT#89 | CP-202111 | 0007 | - | F | UE Id Correction for EE Subscription | 16.2.0 | +| 2020-09 | CT#89 | CP-202111 | 0008 | 1 | F | Correction of HSS Event Exposure data types | 16.2.0 | +| 2020-09 | CT#89 | CP-202096 | 0009 | - | F | 29.563 Rel-16 API version and External doc update | 16.2.0 | +| 2020-12 | CT#90 | CP-205049 | 0010 | 1 | F | Config APN for PDN connectivity status | 16.3.0 | +| 2020-12 | CT#90 | CP-205049 | 0011 | 1 | F | Definition of SubscriptionData | 16.3.0 | +| 2020-12 | CT#90 | CP-205049 | 0012 | - | F | References and Cardinality errors clean up | 16.3.0 | +| 2020-12 | CT#90 | CP-205048 | 0013 | - | F | Storage of YAML files in GitLab | 16.3.0 | +| 2020-12 | CT#90 | CP-205049 | 0014 | - | F | Reference ID | 16.3.0 | +| 2020-12 | CT#90 | CP-205036 | 0015 | - | F | 29.563 Rel-16 API version and External doc update | 16.3.0 | +| 2021-03 | CT#91 | CP-210042 | 0018 | - | F | GUAMI in Deregistration Request | 16.4.0 | +| 2021-03 | CT#91 | CP-210054 | 0022 | - | F | 29.563 Rel-16 API version and External doc update | 16.4.0 | +| 2021-03 | CT#91 | CP-210042 | 0023 | - | F | Cancellation Type sent to MME/SGSN when UE registers in 5G | 16.4.0 | +| 2021-03 | CT#91 | CP-210042 | 0017 | - | F | Correction of reference | 17.0.0 | +| 2021-06 | CT#92 | CP-211064 | 0025 | - | A | Serving Node Deregistration | 17.1.0 | +| 2021-06 | CT#92 | CP-211028 | 0026 | - | F | OpenAPI Reference | 17.1.0 | +| 2021-06 | CT#92 | CP-211028 | 0027 | 1 | B | Data Type Descriptions | 17.1.0 | +| 2021-06 | CT#92 | CP-211028 | 0028 | - | F | Nhss Services | 17.1.0 | +| 2021-06 | CT#92 | CP-211047 | 0029 | 4 | F | RAN Node Level Location Accuracy | 17.1.0 | +| 2021-06 | CT#92 | CP-211065 | 0031 | 1 | A | Monitored Resource URI | 17.1.0 | +| 2021-06 | CT#92 | CP-211059 | 0033 | - | A | Redirect Responses | 17.1.0 | +| 2021-06 | CT#92 | CP-211064 | 0035 | 1 | A | VLR Cancellation | 17.1.0 | +| 2021-06 | CT#92 | CP-211054 | 0036 | 1 | B | MTC Provider in Nhss_EE | 17.1.0 | +| 2021-06 | CT#92 | CP-211050 | 0037 | - | F | 29.563 Rel-17 API version and External doc update | 17.1.0 | +| 2021-09 | CT#93 | CP-212060 | 0040 | - | A | 3xx description correction for SCP | 17.2.0 | +| 2021-09 | CT#93 | CP-212069 | 0043 | 1 | A | Immediate Report in Response | 17.2.0 | +| 2021-09 | CT#93 | CP-212069 | 0045 | - | A | Missing Event Reports | 17.2.0 | +| 2021-09 | CT#93 | CP-212056 | 0048 | 1 | F | Corrections on EventType | 17.2.0 | +| 2021-09 | CT#93 | CP-212057 | 0049 | 1 | B | Partial success on EE subscription | 17.2.0 | +| 2021-09 | CT#93 | CP-212059 | 0050 | - | F | 29.563 Rel-17 API version and External doc update | 17.2.0 | +| 2021-12 | CT#94 | CP-213085 | 0041 | 2 | F | EE subscription for a group | 17.3.0 | +| 2021-12 | CT#94 | CP-213121 | 0052 | - | F | 29.563 Rel-17 API version and External doc update | 17.3.0 | +| 2022-03 | CT#95 | CP-220023 | 0053 | - | F | 501 Not Implemented | 17.4.0 | +| 2022-03 | CT#95 | CP-220074 | 0055 | - | A | Essential Correction on Monitoring Events | 17.4.0 | +| 2022-03 | CT#95 | CP-220074 | 0057 | - | A | Idle Status Indication | 17.4.0 | +| 2022-03 | CT#95 | CP-220090 | 0058 | - | F | Editorial corrections | 17.4.0 | +| 2022-03 | CT#95 | CP-220066 | 0059 | - | F | 29.563 Rel-17 API version and External doc update | 17.4.0 | +| 2022-06 | CT#96 | CP-221029 | 0061 | 1 | F | Fqdn Data Type Definition | 17.5.0 | +| 2022-06 | CT#96 | CP-221028 | 0062 | 1 | F | UeContextInPgwData for emergency sessions | 17.5.0 | +| 2022-06 | CT#96 | CP-221029 | 0063 | 1 | F | Subscription modification | 17.5.0 | +| 2022-06 | CT#96 | CP-221051 | 0064 | - | F | 29.563 Rel-17 API version and External doc update | 17.5.0 | +| 2022-09 | CT#97 | CP-222057 | 0065 | - | F | IMEI Update | 17.6.0 | +| 2022-09 | CT#97 | CP-222057 | 0066 | - | F | Roaming Status Update | 17.6.0 | +| 2022-09 | CT#97 | CP-222058 | 0067 | - | F | 29.563 Rel-17 API version and External doc update | 17.6.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------|--------| +| 2022-12 | CT#98 | CP-223028 | 0068 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98 | CP-223033 | 0069 | - | F | 29.563 Rel-18 API version and External doc update | 18.0.0 | +| 2023-03 | CT#99 | CP-230029 | 0070 | - | F | PDN connectivity status | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0071 | 1 | F | Missing OAuth Security Clauses | 18.1.0 | +| 2023-06 | CT#100 | CP-231027 | 0072 | 4 | F | Location header and missing Redirection clause | 18.2.0 | +| 2023-06 | CT#100 | CP-231025 | 0074 | - | F | Roaming Status Update | 18.2.0 | +| 2023-06 | CT#100 | CP-231027 | 0075 | 1 | D | Editorial corrections for Roaming Status Update | 18.2.0 | +| 2023-09 | CT#101 | CP-232033 | 0076 | 1 | F | NEF Reference ID | 18.3.0 | +| 2023-09 | CT#101 | CP-232058 | 0077 | 1 | F | Immediate Reporting Handling | 18.3.0 | +| 2023-09 | CT#101 | CP-232060 | 0078 | - | F | 29.563 Rel-18 API version and External doc update | 18.3.0 | +| 2023-12 | CT#102 | CP-233029 | 0079 | 1 | B | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.4.0 | +| 2023-12 | CT#102 | CP-233029 | 0080 | 1 | B | ProblemDetails RFC 7807 obsoleted by 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233027 | 0081 | - | B | Per Monitoring Configuration Failure Cause in Error Response | 18.4.0 | +| 2023-12 | CT#102 | CP-233030 | 0082 | - | F | Editorial and Style Corrections | 18.4.0 | +| 2023-12 | CT#102 | CP-233071 | 0084 | - | A | Group ID on Nhss_EE API | 18.4.0 | +| 2023-12 | CT#102 | CP-233060 | 0085 | - | F | 29.563 Rel-18 API version and External doc update | 18.4.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29564/raw.md b/marked/Rel-18/29_series/29564/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..4d2b6a8b01e75a0f008df82be9b4e226eee1d074 --- /dev/null +++ b/marked/Rel-18/29_series/29564/raw.md @@ -0,0 +1,2781 @@ + + +# 3GPP TS 29.564 V18.3.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; User Plane Function Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in small capital letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in small capital letters. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|----------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 8 | +| 4 Overview..... | 8 | +| 4.1 Introduction ..... | 8 | +| 5 Services offered by the UPF ..... | 9 | +| 5.1 Introduction ..... | 9 | +| 5.2 Nupf_EventExposure Service ..... | 9 | +| 5.2.1 Service Description ..... | 9 | +| 5.2.1.1 Service operations..... | 9 | +| 5.2.1.2 Subscription to UPF events..... | 10 | +| 5.2.1.3 UPF events supported by the Nupf_EventExposure service ..... | 10 | +| 5.2.1.3.1 General ..... | 10 | +| 5.2.1.3.2 QoS Monitoring..... | 11 | +| 5.2.1.3.3 User Data Usage Measures ..... | 12 | +| 5.2.1.3.4 User Data Usage Trends..... | 13 | +| 5.2.1.3.5 TSC Management Information..... | 13 | +| 5.2.2 Service Operations..... | 13 | +| 5.2.2.1 Introduction..... | 13 | +| 5.2.2.2 Subscribe..... | 14 | +| 5.2.2.2.1 General ..... | 14 | +| 5.2.2.2.2 Creation of a subscription ..... | 14 | +| 5.2.2.2.3 Modification of a subscription ..... | 16 | +| 5.2.2.2A Unsubscribe ..... | 17 | +| 5.2.2.2A.1 General ..... | 17 | +| 5.2.2.3 Notify ..... | 17 | +| 5.2.2.3.1 General ..... | 17 | +| 5.2.2.3.2 UPF sends notification on subscribed events..... | 18 | +| 5.3 Nupf_GetPrivateUEIPAddr Service..... | 19 | +| 5.3.1 Service Description ..... | 19 | +| 5.3.2 Service Operations..... | 19 | +| 5.3.2.1 Introduction..... | 19 | +| 5.3.2.2 Get..... | 19 | +| 5.3.2.2.1 General ..... | 19 | +| 6 API Definitions ..... | 20 | +| 6.1 Nupf_EventExposure Service API..... | 20 | +| 6.1.1 API URI..... | 20 | +| 6.1.2 Usage of HTTP..... | 20 | +| 6.1.2.1 General..... | 20 | +| 6.1.2.2 HTTP standard headers..... | 20 | +| 6.1.2.2.1 General ..... | 20 | +| 6.1.2.2.2 Content type ..... | 20 | +| 6.1.2.3 HTTP custom headers..... | 21 | +| 6.1.3 Resources..... | 21 | +| 6.1.3.1 Overview..... | 21 | +| 6.1.3.2 Resource: EventExposureSubscriptions ..... | 21 | +| 6.1.3.2.1 Description ..... | 21 | +| 6.1.3.2.2 Resource Definition..... | 21 | +| 6.1.3.2.3 Resource Standard Methods..... | 22 | + +| | | | +|------------|--------------------------------------------|----| +| 6.1.3.2.4 | Resource Custom Operations ..... | 23 | +| 6.1.3.3 | Resource: Individual subscription ..... | 23 | +| 6.1.3.3.1 | Description ..... | 23 | +| 6.1.3.3.2 | Resource Definition..... | 23 | +| 6.1.3.3.3 | Resource Standard Methods..... | 23 | +| 6.1.3.3.4 | Resource Custom Operations..... | 26 | +| 6.1.4 | void ..... | 26 | +| 6.1.5 | Notifications ..... | 26 | +| 6.1.5.1 | General..... | 26 | +| 6.1.5.2 | Event Notification..... | 26 | +| 6.1.5.2.1 | Description ..... | 26 | +| 6.1.5.2.2 | Target URI..... | 26 | +| 6.1.6 | Data Model ..... | 27 | +| 6.1.6.1 | General..... | 27 | +| 6.1.6.2 | Structured data types..... | 29 | +| 6.1.6.2.1 | Introduction ..... | 29 | +| 6.1.6.2.2 | Type: NotificationData..... | 30 | +| 6.1.6.2.3 | Type: NotificationItem..... | 31 | +| 6.1.6.2.4 | Type: QosMonitoringMeasurement..... | 32 | +| 6.1.6.2.5 | Type: UserDataUsageMeasurements ..... | 35 | +| 6.1.6.2.6 | Type: VolumeMeasurement..... | 36 | +| 6.1.6.2.7 | Type: ThroughputMeasurement..... | 36 | +| 6.1.6.2.8 | Type: ApplicationRelatedInformation ..... | 36 | +| 6.1.6.2.9 | Type: ThroughputStatisticMeasurement..... | 37 | +| 6.1.6.2.10 | Type: DomainInformation..... | 37 | +| 6.1.6.2.11 | Type: UpfEventSubscription..... | 38 | +| 6.1.6.2.12 | Type: UpfEventMode..... | 39 | +| 6.1.6.2.13 | Type: UpfEvent..... | 41 | +| 6.1.6.2.14 | Type: CreateEventSubscription..... | 42 | +| 6.1.6.2.15 | Type: CreatedEventSubscription..... | 42 | +| 6.1.6.2.16 | Type: ReportingSuggestionInformation..... | 42 | +| 6.1.6.2.17 | Type: TscManagementInfo ..... | 42 | +| 6.1.6.3 | Simple data types and enumerations..... | 42 | +| 6.1.6.3.1 | Introduction ..... | 42 | +| 6.1.6.3.2 | Simple data types ..... | 43 | +| 6.1.6.3.3 | Enumeration: EventType..... | 43 | +| 6.1.6.3.4 | Enumeration: UpfEventTrigger..... | 43 | +| 6.1.6.3.5 | Enumeration: MeasurementType ..... | 43 | +| 6.1.6.3.6 | Enumeration: GranularityOfMeasurement..... | 44 | +| 6.1.6.3.7 | Enumeration: DnProtocol..... | 44 | +| 6.1.6.3.8 | Enumeration: ReportingUrgency ..... | 44 | +| 6.1.7 | Error Handling ..... | 44 | +| 6.1.7.1 | General..... | 44 | +| 6.1.7.2 | Protocol Errors ..... | 44 | +| 6.1.7.3 | Application Errors..... | 44 | +| 6.1.8 | Feature negotiation ..... | 45 | +| 6.1.9 | Security ..... | 45 | +| 6.1.10 | HTTP redirection..... | 45 | +| 6.2 | Nupf_GetPrivateUEIPaddr Service API ..... | 46 | +| 6.2.1 | Introduction ..... | 46 | +| 6.2.2 | Usage of HTTP..... | 46 | +| 6.2.2.1 | General..... | 46 | +| 6.2.2.2 | HTTP standard headers..... | 46 | +| 6.2.2.2.1 | General ..... | 46 | +| 6.2.2.2.2 | Content type ..... | 46 | +| 6.2.2.3 | HTTP custom headers..... | 46 | +| 6.2.3 | Resources..... | 47 | +| 6.2.3.1 | Overview..... | 47 | +| 6.2.3.2 | Resource: UE IP Address Info..... | 47 | +| 6.2.3.2.1 | Description ..... | 47 | +| 6.2.3.2.2 | Resource Definition..... | 47 | +| 6.2.3.2.3 | Resource Standard Methods..... | 47 | + +| | | | +|-------------------------------|------------------------------------------------------|-----------| +| 6.2.3.2.4 | Resource Custom Operations ..... | 49 | +| 6.2.4 | Custom Operations without associated resources ..... | 49 | +| 6.2.5 | Notifications ..... | 49 | +| 6.2.5.1 | General ..... | 49 | +| 6.2.6 | Data Model ..... | 49 | +| 6.2.6.1 | General ..... | 49 | +| 6.2.6.2 | Structured data types ..... | 49 | +| 6.2.6.2.1 | Introduction ..... | 49 | +| 6.2.6.2.2 | Type: UeIpInfo ..... | 50 | +| 6.2.6.3 | Simple data types and enumerations ..... | 50 | +| 6.2.6.3.1 | Introduction ..... | 50 | +| 6.2.7 | Error Handling ..... | 50 | +| 6.2.7.1 | General ..... | 50 | +| 6.2.7.2 | Protocol Errors ..... | 50 | +| 6.2.7.3 | Application Errors ..... | 51 | +| 6.2.8 | Feature negotiation ..... | 51 | +| 6.2.9 | Security ..... | 51 | +| 6.2.10 | HTTP redirection ..... | 51 | +| Annex A (normative): | OpenAPI specification ..... | 52 | +| A.1 | General ..... | 52 | +| A.2 | Nupf_EventExposure API ..... | 52 | +| A.3 | Nupf_GetPrivateUEIPaddr API ..... | 61 | +| Annex B (informative): | Change history ..... | 64 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +| | | +|-------------------|------------------------------------------------| +| should | indicates a recommendation to do something | +| should not | indicates a recommendation not to do something | +| may | indicates permission to do something | +| need not | indicates permission not to do something | + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +| | | +|---------------|----------------------------------------| +| can | indicates that something is possible | +| cannot | indicates that something is impossible | + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +| | | +|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| will | indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document | +| will not | indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document | +| might | indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document | +| might not | indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document | + +In addition: + +| | | +|---------------|-----------------------------------------------------------------------------------| +| is | (or any other verb in the indicative mood) indicates a statement of fact | +| is not | (or any other negative verb in the indicative mood) indicates a statement of fact | + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nupf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the UPF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.548[14]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. + +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "HTTP/2". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] 3GPP TS 23.548: "5G System Enhancements for Edge Computing; Stage 2". +- [15] 3GPP TS 29.244: "Interface between the Control Plane and the User Plane Nodes; Stage 3". +- [16] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [17] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". +- [18] 3GPP TS 24.539: "5G System (5GS); Network to TSN translator (TT) protocol aspects; Stage 3". +- [19] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3". +- [20] 3GPP TS 29.122: "Technical Specification Group Core Network and Terminals; T8 reference point for Northbound APIs". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Symbols + +None in this release. + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|--------|----------------------------------------------------------------| +| AF | Application Function | +| DCCF | Data Collection Coordination Function | +| L-UPF | Local User Plane Function | +| L-NEF | Local Network Exposure Function | +| MFAF | Messaging Framework Adaptor Function | +| NEF | Network Exposure Function | +| NWDAF | Network Data Analytics Function | +| UPF | User Plane Function | +| SMF | Session Management Function | +| TSCTSF | Time Sensitive Communication and Time Synchronization Function | +| TSN | Time Sensitive Networking | + +# 4 Overview + +## 4.1 Introduction + +Within the 5GC, the UPF offers services to the NEF, AF, SMF, NWDAF, DCCF, MFAF, TSCTSF and TSN AF via the Nupf service based interface (see 3GPP TS 23.501 [2], 3GPP TS 23.502 [3], 3GPP TS 23.288 [17] and 3GPP TS 23.548 [14]). + +Figure 4.1-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the UPF. + +![Figure 4.1-1: Reference model – UPF. The diagram shows a central green box labeled 'UPF' connected to a central point via a line labeled 'Nupf'. To the left of this central point, eight boxes are arranged in two columns, each with lines connecting to the central point. The left column contains NEF, AF, NWDAF, SMF, TSN AF, and TSCTSF. The right column contains DCCF and MFAF.](7affafe7362a2d2d072e9d4bf515f0bb_img.jpg) + +``` +graph LR; subgraph LeftColumn [ ]; NEF; AF; NWDAF; SMF; TSN_AF[TSN AF]; TSCTSF; end; subgraph RightColumn [ ]; DCCF; MFAF; end; LeftColumn --> Nupf((Nupf)); RightColumn --> Nupf; Nupf --> UPF[UPF]; +``` + +Figure 4.1-1: Reference model – UPF. The diagram shows a central green box labeled 'UPF' connected to a central point via a line labeled 'Nupf'. To the left of this central point, eight boxes are arranged in two columns, each with lines connecting to the central point. The left column contains NEF, AF, NWDAF, SMF, TSN AF, and TSCTSF. The right column contains DCCF and MFAF. + +**Figure 4.1-1: Reference model – UPF** + +The UPF supports the following functionalities which are provided via Service Based Interface: + +- Subscription to notifications of events exposed by the UPF; +- Notification about UPF events; and +- Translation of (NATed) Public UE IP address and port to (5GC) Private UE IP address. + +# 5 Services offered by the UPF + +## 5.1 Introduction + +The UPF offers the following services via the Nupf interface: + +- Nupf\_EventExposure Service +- Nupf\_GetPrivateUEIPaddr Service + +Table 5.1-1 summarizes the SBI services produced by the UPF: + +**Table 5.1-1: NF Services provided by UPF** + +| Service Name | Description | Example Consumers | +|-------------------------|---------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| +| Nupf_EventExposure | This service exposes UPF related information to other NFs | SMF, NWDAF, NEF, AF, TSCTSF, TSN AF, DCCF, MFAF | +| Nupf_GetPrivateUEIPaddr | This service provides the private UE IP address information of a PDU session from the (NATed) public IP address and port number | NEF | + +Table 5.2-1 summarizes the corresponding APIs defined for this specification. + +**Table 5.2-1: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|-------------------------|--------|---------------------------------------|--------------------------------------|------------|-------| +| Nupf_EventExposure | 6.1 | UPF Event Exposure Service | TS29564_Nupf_EventExposure.yaml | nupf-ee | A.2 | +| Nupf_GetPrivateUEIPaddr | 6.2 | UPF Get Private UE IP address Service | TS29564_Nupf_GetPrivateUEIPaddr.yaml | nupf-gueip | A.3 | + +## 5.2 Nupf\_EventExposure Service + +### 5.2.1 Service Description + +#### 5.2.1.1 Service operations + +The Nupf\_EventExposure service enables NF service consumers to subscribe to UPF events and/or the UPF to send notifications about UPF events to NF service consumers. + +The Nupf\_EventExposure service supports the service operations defined in Table 5.2.1.1-1. + +**Table 5.2.1.1-1: Service operations supported by the Nupf\_EventExposure service** + +| Service Operations | Description | Operation Semantics | Example Consumer(s) | +|--------------------|-------------------------------|---------------------|-------------------------------------------| +| Subscribe | Subscribe to UPF events | Subscribe/Notify | NWDAF, SMF, DCCF | +| Unsubscribe | Unsubscribe from UPF events | Subscribe/Notify | NWDAF, SMF, DCCF | +| Notify | Notification about UPF events | Subscribe/Notify | NEF, AF, NWDAF, TSCTSF, TSNAP, DCCF, MFAF | + +#### 5.2.1.2 Subscription to UPF events + +The UPF exposes UPF events via the Nupf\_EventExposure service as defined in Table 5.2.1.2-1. + +**Table 5.2.1.2-1: Subscriptions to UPF events** + +| Subscription | Protocol used for the subscription to UPF | Description | +|----------------------|-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Subscription via SMF | PFCP |

The NF service consumer creates the subscription for the event of interest via the SMF. The SMF instructs the UPF to report the events directly to the NF service consumer via the N4 interface as specified in 3GPP TS 29.244 [15].

Upon occurrence of the event of interest, the UPF sends a notification directly to the NF service consumer using the Nupf_EventExposure Notify service operation.

| +| | Nupf_EventExposure Subscribe |

The NF service consumer creates the subscription for the event of interest via the SMF. The SMF subscribes to the UPF using the Nupf_EventExposure Subscribe service operation.

Upon occurrence of the event of interest, the UPF sends a notification directly to the NF Service Consumer using the Nupf_EventExposure Notify service operation.

| +| Subscription to UPF | Nupf_EventExposure Subscribe |

The NF service consumer creates the subscription for the event of interest to the UPF using the Nupf_EventExposure Subscribe service operation.

Upon occurrence of the event of interest, the UPF sends a notification directly to the NF Service Consumer using the Nupf_EventExposure Notify service operation

| + +Clause 5.2.1.3 describes which of the above subscriptions shall be used for each event type supported by the Nupf\_EventExposure service. + +#### 5.2.1.3 UPF events supported by the Nupf\_EventExposure service + +##### 5.2.1.3.1 General + +The Nupf\_EventExposure service supports the events defined in this clause. + +See also clauses 4.15.4.5.1 and 5.2.26.2.1 of 3GPP TS 23.502 [3]. + +##### 5.2.1.3.2 QoS Monitoring + +**Table 5.2.1.3.2-1: QoS Monitoring event** + +| | | +|-----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description |

This event provides QoS flow performance information, i.e. QoS monitoring results for the QoS parameter(s) to be measured.

The following QoS parameters may be measured and/or reported:

  • - Packet delay monitoring: DL, UL and/or Round-Trip packet delay between UE and PSA UPF of specific QoS flow(s) of the PDU session.
  • - Data rate monitoring: UL and/or DL data rate measurement for a QoS flow.
  • - Congestion information of a QoS flow on the UL and/or DL directions received from the NG-RAN.
| +| Subscription type | Subscription via SMF using PFCP | +| Subscription inputs to UPF |
  • - QFI(s) of a specific PDU session
  • - requested QoS measurements
  • - UPF event consumer notification URI
  • - Notification correlation ID
  • - Reporting suggestion information (i.e. Report urgency, Reporting time information)

See clauses 5.24.4 and 5.24.5 of 3GPP TS 29.244 [15].

| +| Report type |

Continuous (event triggered) Report (for Packet Delay and Congestion Information).

Periodic Report (for Packet Delay)

| + +##### 5.2.1.3.3 User Data Usage Measures + +**Table 5.2.1.3.3-1: User Data Usage Measures event** + +| | | +|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description |

This event provides information of user data usage of a PDU session:

  • - Volume Measurement: measures of data volume exchanged (UL, DL and/or overall) and/or number of packets exchanged (UL, DL and/or overall) with or without application granularity.
  • - Throughput Measurement: measures of data throughput (UL and DL) measures aggregated for the PDU Session or per application.
  • - Application related information: URL(s) and/or Domain name(s) detected in the PDU session for the target traffic.
| +| Subscription type |

Subscription via SMF using Nupf_EventExposure Subscribe, if the target is:

  • - PDU session(s) of a specific UE or a group of UEs; or
  • - PDU session(s) of any UE and the subscription includes at least one of the following parameters: AoI, Traffic filtering, BSSID/SSID, Application ID.

Subscription to the UPF, if the target is PDU session(s) of any UE and the subscription does not need to include any of the following parameters: AoI, Traffic filtering, BSSID/SSID, Application ID.

| +| Subscription inputs to UPF |

Required:

  • - UE IP address or "Any UE"
  • - UPF event consumer notification URI

Optional:

  • - DNN(s)
  • - S-NSSAI(s)
  • - Application ID(s) or Traffic filtering
  • - Type of Measurement (i.e. Volume, Throughput, Application related information)
  • - Granularity of Measurement (i.e. required granularity for the information reported)
  • - Reporting suggestion information (i.e. Report urgency, Reporting time information)
  • - Notification correlation ID
| +| Report type |

One-Time Report

Periodic Report

| + +##### 5.2.1.3.4 User Data Usage Trends + +**Table 5.2.1.3.4-1: User Data Usage Trends event** + +| | | +|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | This event provides statistics related to user data usage of a PDU session:
  • - Throughput Statistics Measurement (average and/or peak throughput) over the measurement period for the PDU Session or per application
| +| Subscription type | Subscription via SMF using Nupf_EventExposure Subscribe, if the target is:
  • - PDU session(s) of a specific UE or a group of UEs; or
  • - PDU session(s) of any UE and the subscription includes at least one of the following parameters: AoI, Traffic filtering, BSSID/SSID, Application ID.
Subscription to the UPF, if the target is PDU session(s) of any UE and the subscription does not need to include any of the following parameters: AoI, Traffic filtering, BSSID/SSID, Application ID. | +| Subscription inputs to UPF | Required:
  • - UE IP address or "Any UE"
  • - UPF event consumer notification URI
Optional:
  • - DNN(s)
  • - S-NSSAI(s)
  • - Application ID(s) or Traffic filtering
  • - Granularity of Measurement (i.e. required granularity for the information reported)
  • - Reporting suggestion information (i.e. Report urgency, Reporting time information)
  • - Notification correlation ID
| +| Report type | One-Time Report
Periodic Report | + +##### 5.2.1.3.5 TSC Management Information + +**Table 5.2.1.3.5-1: TSC Management Information event** + +| | | +|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | This event provides TSC Management Information. | +| Subscription type | Subscription via SMF using PFCP | +| Subscription inputs to UPF |
  • - UPF event consumer notification URI
  • - Notification correlation ID
See clauses 5.26.3.2 of 3GPP TS 29.244 [15] and clauses 6.2.1 and 6.3.1 of 3GPP TS 24.539 [18]. | +| Report type | Continuous (event triggered) Report. | + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +The service operations defined for the Nupf\_EventExposure service are as follows: + +- **Subscribe:** It enables an NF service consumer to subscribe to UPF event exposure notifications.. +- **Unsubscribe:** It enables an NF service consumer to unsubscribe from UPF event exposure notifications. +- **Notify:** It allows the UPF to send event notifications directly to NF service consumers. + +**NOTE:** The Subscribe and Unsubscribe service operations only apply to UPF events that can be subscribed using the Nupf service based interface (see clauses 5.2.1.2 and 5.2.1.3). + +#### 5.2.2.2 Subscribe + +##### 5.2.2.2.1 General + +The Subscribe service operation is used by a NF Service Consumer to subscribe to UPF event exposure notifications, e.g. for the purpose of UPF data collection for a specified PDU session or any UE. + +NOTE: NF service consumers can only be SMF, NWDAF or DCCF in this release of the specification. + +##### 5.2.2.2.2 Creation of a subscription + +An NF Service Consumer shall invoke the Subscribe service operation towards the UPF to create a subscription to monitor at least one UPF event. The NF Service Consumer may subscribe to multiple events in a subscription. A subscription may be associated with one UE's PDU session or with any UE. + +The NF Service Consumer shall request to create a new subscription by using the HTTP method POST with the URI of the subscriptions collection, see clause 6.1.3.2. + +![Sequence diagram showing the creation of a subscription. The NF Service Consumer sends a POST request to the UPF. The UPF responds with either a 201 Created status (with an optional event report) or a 4xx/5xx status (ProblemDetails) or a 3xx status (RedirectResponse).](d17f75945bbb3feb84a153ecfedb9b81_img.jpg) + +``` + +sequenceDiagram + participant NFSC as NF Service Consumer + participant UPF + Note left of NFSC: + NFSC->>UPF: 1. POST .../ee-subscriptions (CreateEventSubscription) + Note right of UPF: + UPF-->>NFSC: 2a. 201 Created (CreatedEventSubscription (with optional event report)) + Note right of UPF: + UPF-->>NFSC: 2b. 4xx/5xx (ProblemDetails) or 3xx (RedirectResponse) + +``` + +Sequence diagram showing the creation of a subscription. The NF Service Consumer sends a POST request to the UPF. The UPF responds with either a 201 Created status (with an optional event report) or a 4xx/5xx status (ProblemDetails) or a 3xx status (RedirectResponse). + +**Figure 5.2.2.2.2-1 Subscription creation** + +1. The NF Service Consumer shall send a POST request to create a subscription resource in the UPF. The content of the POST request shall contain a representation of the individual subscription resource to be created. + +The NF Service Consumer shall include the following information in the HTTP message body: + +- NF ID, indicating the identity of the network function instance creating the subscription; +- Target of Event Reporting, indicating the target(s) to be monitored, i.e. + - a specific PDU Session of a UE identified with a UE IP address; or + - any UE (identified by the "anyUE" flag); +- List of UPF events requested to be subscribed; +- Event Reporting Mode, indicating how the events shall be reported (One-time Report or Periodic Report); and +- UPF event consumer notification URI, indicating the address where to send the event notifications generated by the subscription. + +The NF Service Consumer may include the following information in the HTTP message body: + +- a SUPI, PEI or GPSI identifying a specific UE; +- one or more S-NSSAI(s) and/or DNN(s) of PDU sessions to which the subscription applies; +- one or more Application ID(s) or traffic filters identifying the traffic to be monitored by the subscription (only applicable to a subscription targeting a specific PDU Session of a UE identified with a UE IP address); +- Type of measurement, for UPF events supporting multiple types of measurement (e.g. UserDataUsageMeasures event) + +- Granularity of Measurement, indicating that the granularity of the required measurements is per PDU Session, per data flow or per application; + - Reporting period, defining the period for periodic reporting; + - Maximum number of reports, defining the maximum number of reports after which the event subscription ceases to exist; + - Expiry time, suggested by the NF Service Consumer representing the time up to which the subscription is desired to be kept active and the time after which the subscribed event(s) shall stop generating report; + - Reporting suggestion information, i.e. Report urgency indicating whether the event report can be delayed (i.e. it is delay-tolerant) and if so, the Reporting time information defining the last valid reporting time for the UPF to report the detected event; + - Deactivate notification flag, indicating that the notification of the available events shall be muted until the event consumer NF (e.g. NWDAF or DCCF) provides the retrieval notification flag to retrieve the events stored; + - Immediate Report Flag per event, indicating an immediate report to be generated with the current event status; and/or + - Notification Correlation ID, indicating the correlation identity to be signaled in the event notifications generated by the subscription. + - Sampling ratio, defining the random subset of PDU sessions among target PDU sessions, and the UPF only report the event(s) related to the selected subset of PDU sessions; + - partitioningCriteria, defining the criteria for partitioning PDU sessions before applying sampling ratio; + - Muting Exception Instructions, which specify instructions to apply to the subscription and the stored events when an exception occurs at the UPF while the event is muted (e.g., the buffer of stored event reports is full, or the number of stored event reports exceeds a certain number), if the EEMM feature is supported (see clause 6.1.8). +- 2a. On success (i.e. if the request is accepted), the UPF shall include a HTTP Location header to provide the location of the newly created resource (subscription) together with the status code 201 indicating the requested resource is created in the response message. + +If the NF Service Consumer has included more than one events in the event subscription and some of the events cannot be subscribed, the UPF shall accept the request and provide the successfully subscribed event(s) in the CreatedEventSubscription. + +If the NF Service Consumer has included the Immediate Report Flag with the value true in the event subscription, and if the current status of the events subscribed are available, the UPF shall include the current status of the events subscribed in the response. Otherwise, the UPF shall generate reports for the events and notify the NF service consumer using the Nupf\_EventExposure\_Notify service operation. If the events with the Immediate Report Flag set to true are subscribed via an SMF, the notification shall be sent to the actual NF service consumer directly, i.e. the current status of the events subscribed shall not be included in the subscription creation response. + +If the NF Service Consumer has set the event reporting option to ONE\_TIME and if the UPF has included the current status of the events subscribed in the response, then the UPF shall not do any subsequent event notification for the corresponding events. + +The response, based on operator policy and taking into account the expiry time included in the request, may contain the expiry time, as determined by the UPF, after which the subscription becomes invalid. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the UPF. The UPF shall not provide the same expiry time for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. If the expiry time is not included in the response, the NF Service Consumer shall consider the subscription to be valid without an expiry time. + +If the sampling ratio ("sampRatio") attribute is included in the subscription without a partitioningCriteria, the UPF shall select a random subset of PDU sessions among target PDU sessions according to the sampling ratio and only report the event(s) related to the selected subset of PDU sessions. If the partitioningCriteria attribute is + +also included along with sampling ratio, the UPF shall apply the sampling ratio on the group of PDU sessions determined according to the partitioning criteria. + +If the "notifFlag" attribute is included and set to "DEACTIVATE" in the request by e.g. the NWDAF or DCCF, the UPF shall mute the event notification and store the available events. Additionally, if the UPF supports the EEMM feature (see clause 6.1.8) and if the NF service consumer includes event muting instructions in the request, the UPF should evaluate the received event muting instructions against local actions (if configured) and, if the subscription creation request is accepted, the UPF may indicate the following information to the NF service consumer in the response: + +- the maximum number of notifications that the UPF expects to be able to store for the subscription; +- an estimate of the duration for which notifications can be buffered. + +2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.2.3.1-3. + +If the UPF supports the EEMM features (see clause 6.1.8), the NF service consumer sets the "notifFlag" attribute to "DEACTIVATE" and event muting instructions in the request, but the UPF cannot accept the received instructions, the UPF may reject the request with a 403 Forbidden response and the application error "MUTING\_EXC\_INSTR\_NOT\_ACCEPTED". + +##### 5.2.2.2.3 Modification of a subscription + +The service operation is invoked by a NF Service Consumer, towards the UPF, when it needs to modify an existing subscription previously created at the UPF. + +The NF Service Consumer shall modify the subscription by using the HTTP method PATCH with the URI of the individual subscription resource (see clause 6.1.3.3) to be modified. + +![Sequence diagram showing the modification of a subscription. The NF Service Consumer sends a PATCH request to the UPF. The UPF responds with either 2a. 204 No Content, 2b. 200 OK (PatchResult), or 2c. 4xx/5xx (ProblemDetails) or 3xx.](96b0240f56d14453b5da05ec30fd5c6e_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant UPF + Note left of NF Service Consumer: 1. PATCH .../ee-subscriptions/{subscriptionId} (PatchData) + NF Service Consumer->>UPF: 1. PATCH .../ee-subscriptions/{subscriptionId} (PatchData) + Note right of UPF: 2a. 204 No Content + UPF-->>NF Service Consumer: 2a. 204 No Content + Note right of UPF: 2b. 200 OK (PatchResult) + UPF-->>NF Service Consumer: 2b. 200 OK (PatchResult) + Note right of UPF: 2c. 4xx/5xx (ProblemDetails) or 3xx + UPF-->>NF Service Consumer: 2c. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the modification of a subscription. The NF Service Consumer sends a PATCH request to the UPF. The UPF responds with either 2a. 204 No Content, 2b. 200 OK (PatchResult), or 2c. 4xx/5xx (ProblemDetails) or 3xx. + +**Figure 5.2.2.2.3-1: Modification of a subscription** + +1. The NF service consumer shall send a PATCH request to the resource representing a subscription. The modification may be for the events subscribed or for updating the event report options, or the NF Id. +- 2a. On success, the request is accepted, and all the modification instructions in the PATCH request have been implemented, the UPF shall respond with "204 No Content". +- 2b. On success, the request is accepted, but some of the modification instructions in the PATCH request have been discarded, the UPF shall respond with "200 OK" including PatchResult to indicate the failed modifications. +- 2c. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.3.3.2-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.3.3.2-3. + +#### 5.2.2.2A Unsubscribe + +##### 5.2.2.2A.1 General + +The Unsubscribe service operation is invoked by a NF Service Consumer towards the UPF to delete an existing subscription previously created at the UPF. + +The NF Service Consumer shall unsubscribe from a subscription by using the HTTP method DELETE with the URI of the individual subscription resource (see clause 6.1.3.3) to be deleted. + +![Sequence diagram showing the Unsubscribe process between an NF Service Consumer and a UPF. The NF Service Consumer sends a DELETE request to the UPF. The UPF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (RedirectResponse) message.](36117e9cb27c58484cd8d3e5f9dc7ac3_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant UPF + Note left of NF Service Consumer: 1. DELETE .../subscriptions/{subscriptionId} + NF Service Consumer->>UPF: 1. DELETE .../subscriptions/{subscriptionId} + Note right of UPF: -2a. 204 No Content + UPF-->>NF Service Consumer: -2a. 204 No Content + Note right of UPF: 2b. 4xx/5xx (ProblemDetails) or 3xx (RedirectResponse) + UPF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx (RedirectResponse) + +``` + +Sequence diagram showing the Unsubscribe process between an NF Service Consumer and a UPF. The NF Service Consumer sends a DELETE request to the UPF. The UPF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (RedirectResponse) message. + +**Figure 5.2.2.2A.1-1 Unsubscribing from UPF events** + +1. The NF Service Consumer shall send a DELETE request to delete an existing subscription resource in the UPF. +- 2a. On success (i.e. if the request is accepted), the UPF shall reply with the status code 204 in the response message to indicate that the resource identified by the subscription ID has been successfully deleted. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.3.1-3 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.3.1-3. + +#### 5.2.2.3 Notify + +##### 5.2.2.3.1 General + +The Notify service operation is invoked by the UPF, to send a notification, towards the notification URI, when certain event included in the subscription has taken place. + +For the events "USER\_DATA\_USAGE\_MEASURES" and "USER\_DATA\_USAGE\_TRENDS", the UPF shall use the HTTP method POST, using the notification URI received in the subscription creation as specified in clause 5.2.2.2.2, including e.g. the subscription ID, Event ID(s) for which event has happened, notification correlation ID provided by the NF service consumer at the time of event subscription, to send a notification. + +If the subscription is targeting PDU sessions of any UE, i.e. the "anyUe" is set to true, the UPF shall perform the requested measurements per PDU session and send notification(s) with multiple NotificationItem IEs within the NotificationData wherein each NotificationItem shall correspond to a report on one subscribed event per PDU session. See Figure 5.2.2.3.2-1. If the subscription request included a sampling ratio, the notification may include the sampling ratio achieved by the UPF. + +For the events "QOS\_MONITORING" and "TSC\_MNGT\_INFO", the UPF shall use the HTTP method POST, using the notification URI received from the SMF via N4 interface, see clause 5.33.5 of 3GPP TS 29.244 [15]. + +For the event "USER\_DATA\_USAGE\_MEASURES", the event notification may contain following information: + +- Volume Measurement: measures of data volume exchanged (UL, DL and/or overall) and/or number of packets exchanged (UL, DL and/or overall). +- Throughput Measurement: measures of data throughput (UL and DL). +- Application related Information: URLs and/or Domain names and Domain name protocols detected in the traffic identified by the information included in the subscription request, e.g. an application id. + +When the granularity of the measurement is per data flow, the notification includes the packet filter set and the Applications Identifier if available. + +For the event "USER\_DATA\_USAGE\_TRENDS", the event notification may contain following information: + +- Throughput Statistic Measurement (average and/or peak throughput) over the measurement. + +When the granularity of the measurement is per data flow, the notification includes the packet filter set and the Applications Identifier if available. + +For the event "QOS\_MONITORING", this service operation is used by the UPF to send the following kinds of event notification: + +- Periodic notification on the downlink packet delay, uplink packet delay, and/or the round trip packet delay between the UPF (PSA) and UE; +- Event triggered notification on the downlink packet delay, uplink packet delay, and/or the round trip packet delay between the UPF (PSA) and UE, i.e. when the packet delay exceeds a defined threshold; +- Notification on the downlink packet delay, uplink packet delay, and/or the round trip packet delay between the UPF (PSA) and UE when the PDU session is released. +- Event triggered notification of congestion information of the QoS flow on the UL and/or DL directions received from the NG-RAN, upon a change of the congestion information. + +For the event "TSC\_MNGT\_INFO", the event notification may contain the following information: + +- Port Management Information Container(s) for one or more NW-TT ports and/or +- a User Plane Node Management Information Container; + +The event notification shall also contain the following information: + +- the related NW-TT port number(s), if Port Management Information Container(s) is present; and +- the notification correlation ID received from the SMF, if any. + +##### 5.2.2.3.2 UPF sends notification on subscribed events + +![Sequence diagram showing the interaction between an NF Service Consumer and a UPF. The UPF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (redirection) status code.](dc23d430e878eb71b8cd589984113940_img.jpg) + +``` + +sequenceDiagram + participant UPF + participant NFSC as NF Service Consumer + Note right of UPF: 1. POST {eventNotificationUri} (NotificationData) + UPF->>NFSC: 1. POST {eventNotificationUri} (NotificationData) + Note left of NFSC: 2a. 204 No Content () + NFSC-->>UPF: 2a. 204 No Content () + Note left of NFSC: 2b. 4xx/5xx (ProblemDetails) or 3xx + NFSC-->>UPF: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and a UPF. The UPF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (redirection) status code. + +**Figure 5.2.2.3.2-1: UPF sends notification on subscribed events** + +1. The UPF shall send a POST request to the eventNotificationUri as provided by the SMF during the provisioning of Session Reporting Rule (see clause 7.5.2.9 of 3GPP TS 29.244 [15]) or received in the subscription creation as specified in clause 5.2.2.2.2. +- 2a. Upon success, the NF Service Consumer responds with "204 No Content". +- 2b. On failure or redirection: + - If the NF Service Consumer does not consider the "eventNotificationUri" as a valid notification URI, the NF Service Consumer shall return "404 Not Found" status code with the ProblemDetails IE providing details of the error. + - In the case of redirection, the NF service consumer shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NF service consumer endpoint. + +## 5.3 Nupf\_GetPrivateUEIPAddr Service + +### 5.3.1 Service Description + +The Nupf\_GetPrivateUEIPAddr Service enables the UPF to provide the UE IP address information of a PDU session, e.g. to provide the (private) UE IP address when being queried with a NATed UE IP Address, to the NF service consumer, e.g. a NEF. + +Table 5.3.1-1 lists the service operations that are supported by the Nupf\_GetPrivateUEIPAddr service. + +**Table 5.3.1-1: Service operations supported by the Nupf\_GetPrivateUEIPAddr service** + +| Service Operations | Description | Operation Semantics | Example Consumers | +|--------------------|----------------------------------------------------------------------------------------------------------------------------------------|---------------------|-------------------| +| Get | Retrieve the UE IP address information of a PDU session, to get e.g., UE's private IP address and optionally the associated IP domain. | Request / Response | NEF | + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +See Table 5.3.1-1 for an overview of the service operations supported by the Nupf\_GetPrivateUEIPAddr service. + +#### 5.3.2.2 Get + +##### 5.3.2.2.1 General + +The Get service operation is used in the following procedure: + +- AF specific UE ID retrieval as specified in clause 4.15.10 of 3GPP TS 23.502 [3] + +This service operation is consumed by querying the "ue-ip-info" resource. The request is sent to the UPF hosting the IP address in the query. + +![Sequence diagram showing the interaction between an NF Service Consumer and a UPF for retrieving UE IP info. The consumer sends a GET request to the UPF, and the UPF responds with either a 200 OK (UeIpInfo) or an error status code (4xx/5xx or 3xx).](3191384ecc1531d40a00140dd21fd781_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant UPF + Note left of NF Service Consumer: + NF Service Consumer->>UPF: 1. GET .../ue-ip-info? + Note right of UPF: + UPF-->>NF Service Consumer: 2a. 200 OK (UeIpInfo) + Note right of UPF: + UPF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and a UPF for retrieving UE IP info. The consumer sends a GET request to the UPF, and the UPF responds with either a 200 OK (UeIpInfo) or an error status code (4xx/5xx or 3xx). + +**Figure 5.3.2.2.1-1: Retrieval of UE IP Info for a PDU session** + +1. The NF Service Consumer shall send an HTTP GET request to the resource URI of "ue-ip-info". The input filter criteria for the discovery request shall be included in query parameters, e.g. the UE (public) IP address and Port Number, and optionally DNN and S-NSSAI. +- 2a. On success, "200 OK" shall be returned. The response body shall include a UeIpInfo object which contains relevant attributes matching the query parameters included in the request message. +- 2b. On failure, one of the HTTP status code listed in Table 6.2.3.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.2.3.2.3.1-3, where applicable. + +On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse IE may be included in the content of POST response. + +# --- 6 API Definitions + +## 6.1 Nupf\_EventExposure Service API + +### 6.1.1 API URI + +The Nupf\_EventExposure shall use the Nupf\_EventExposure API. + +The API URI of the Nupf\_EventExposure API shall be: + +**{apiRoot}** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nupf-ee". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nupf\_EventExposure API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +In this release of this specification, no custom headers specific to the Nupf\_EventExposure service are defined. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +![Diagram showing the hierarchical structure of the nupf-ee API resource URI. The root is {apiRoot}/nupf-ee/, which branches to /ee-subscriptions, which in turn branches to /{subscriptionId}.](75e4b78ee25f885d73120e3066a5253e_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nupf-ee/"] --> Subscriptions["/ee-subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Diagram showing the hierarchical structure of the nupf-ee API resource URI. The root is {apiRoot}/nupf-ee/, which branches to /ee-subscriptions, which in turn branches to /{subscriptionId}. + +**Figure 6.1.3.1-1: Resource URI structure of the nupf-ee API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------------------|------------------------------------|---------------------------------|-------------------------------------------------------------| +| EventExposureSubscriptions (Collection) | /ee-subscriptions | POST | Subscribe service operation, creating a new subscription . | +| Individual subscription (Document) | /ee-subscriptions/{subscriptionId} | DELETE | Unsubscribe service operation | +| | | PATCH | Subscribe service operation, modification of a subscription | + +#### 6.1.3.2 Resource: EventExposureSubscriptions + +##### 6.1.3.2.1 Description + +This resource represents a collection of subscriptions created by NF service consumers of Nupf\_EventExposure service. + +This resource is modelled as the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nupf-ee//ee-subscriptions + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1 | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|------------------------------------------------------------| +| CreateEventSubscription | M | 1 | Content of the Subscribe request to create a subscription. | + +**Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CreatedEventSubscription | M | 1 | 201
Created | Represents successful creation of an UPF Event Subscription | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403
Forbidden | Indicates the creation of subscription has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- PDU_SESSION_NOT_SERVED_BY_UPF
- MUTING_EXC_INSTR_NOT_ACCEPTED | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nupf-ee//ee-subscriptions/{subscriptionId} | + +**Table 6.1.3.2.3.1-5: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.3.1-6: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +##### 6.1.3.2.4 Resource Custom Operations + +None. + +#### 6.1.3.3 Resource: Individual subscription + +##### 6.1.3.3.1 Description + +This resource represents an individual of subscription created by NF service consumers of Nupf\_EventExposure service. + +This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nupf-ee//ee-subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|--------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| apiVersion | string | See clause 6.2.1. | +| subscriptionId | string | String identifies an individual subscription to the UPF event exposure service | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 DELETE + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.1.3.3.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.3.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | Indicates the modification of subscription has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- SUBSCRIPTION_NOT_FOUND | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.3.1-4: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.3.1-5: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +###### 6.1.3.3.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.1.3.3.3.2-1. + +**Table 6.1.3.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.3.3.2-3. + +**Table 6.1.3.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Items describe the modifications to the Event Subscription | + +**Table 6.1.3.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 3) | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1.
- MUTING_EXC_INSTR_NOT_ACCEPTED | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UPF shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, the UPF shall respond with PatchResult. + +NOTE 3: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.3.2-4: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance. It is implementation specific how the alternative URI is determined. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.3.2-5: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance. It is implementation specific how the alternative URI is determined. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +##### 6.1.3.3.4 Resource Custom Operations + +None. + +### 6.1.4 void + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 6.1.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|-------------------------------------------------------------------------------------------------| +| Event Notification | {eventNotificationUri} (This URI is either provided by NF service consumer via Nupf interface, or it is provided via N4 interface during the provisioning of Session Reporting Rule) | POST | Notify about the events that UPF exposes and to which the NF service consumer may subscribe to. | + +#### 6.1.5.2 Event Notification + +##### 6.1.5.2.1 Description + +The Event Notification is used by the UPF to report one or several observed Events to a NF service consumer that has subscribed to such Notifications. + +##### 6.1.5.2.2 Target URI + +The POST method shall be used for Event Notification and the URI shall be the Event Notification URI provided by the SMF during the provisioning of Session Reporting Rule, see clause 5.33.5 of 3GPP TS 29.244 [15], or by NF Service Consumer during creation of the subscription as specified in clause 5.2.2.2.2. + +Resource URI: {eventNotificationUri} + +Support of URI query parameters is specified in table 6.1.5.2.2-1. + +**Table 6.1.5.2.2-1: Callback URI variables** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.1.5.2.2-2, and support of response data structures and response codes is specified in table 6.1.5.2.2-3. + +**Table 6.1.5.2.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-------------------------------------------| +| NotificationData | M | 1 | Representation of the event notification. | + +**Table 6.1.5.2.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents a successful notification of the event. | +| ProblemDetails | O | 0..1 | 404 Not Found | If the NF Service Consumer considers the "eventNotificationUri" and/or "Notification Correlation ID" is not recognized, the NF Service Consumer shall return "404 Not Found" status code | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.5.2.2-4: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer instance to which the request should be sent. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF instance ID towards which the notification is redirected | + +**Table 6.1.5.2.2-5: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer instance to which the request should be sent. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF instance ID towards which the notification is redirected | + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nupf\_EventExposure service. + +Table 6.1.6.1-1: Nupf\_EventExposure specific Data Types + +| Data type | Clause defined | Description | Applicability | +|--------------------------------|----------------|---------------------------------------------------------------------|---------------| +| NotificationData | 6.1.6.2.2 | The list of NotificationItems | | +| NotificationItem | 6.1.6.2.3 | Represents a report on one subscribed event | | +| QosMonitoringMeasurement | 6.1.6.2.4 | QoS Monitoring Measurement information | | +| UserDataUsageMeasurements | 6.1.6.2.5 | User Data Usage Measurements | | +| VolumeMeasurement | 6.1.6.2.6 | Volume Measurement | | +| ThroughputMeasurement | 6.1.6.2.7 | Throughput Measurement | | +| ApplicationRelatedInformation | 6.1.6.2.8 | Application Related Information | | +| ThroughputStatisticMeasurement | 6.1.6.2.9 | Throughput Statistic Measurement | | +| DomainInformation | 6.1.6.2.10 | Domain Name and Domain Name Protocol | | +| UpfEventSubscription | 6.1.6.2.11 | Represents an individual event subscription resource on UPF | | +| UpfEventMode | 6.1.6.2.12 | Describes how the reports shall be generated for a subscribed event | | +| UpfEvent | 6.1.6.2.13 | Describes an event to be subscribed | | +| CreateEventSubscription | 6.1.6.2.14 | Data within a create UPF event subscription request | | +| CreatedEventSubscription | 6.1.6.2.15 | Data within a create UPF event subscription response | | +| ReportingSuggestionInformation | 6.1.6.2.16 | Reporting Suggestion Information | | +| TscManagementInfo | 6.1.6.2.17 | TSC Management Information | | +| EventType | 6.1.6.3.3 | Event Type | | +| UpfEventTrigger | 6.1.6.3.4 | Describes how the UPF generates the report for the event | | +| MeasurementType | 6.1.6.3.5 | Type of Measurement | | +| GranularityOfMeasurement | 6.1.6.3.6 | Granularity Of Measurement | | +| DnProtocol | 6.1.6.3.7 | Domain Name Protocol | | +| ReportingUrgency | 6.1.6.3.8 | Reporting Urgency | | + +Table 6.1.6.1-2 specifies data types re-used by the Nupf\_EventExposure service from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nupf\_EventExposure service. + +Table 6.1.6.1-2: Nupf\_EventExposure re-used Data Types + +| Data type | Reference | Comments | Applicability | +|-----------------------------|---------------------|-------------------------------------------------|---------------| +| DateTime | 3GPP TS 29.571 [16] | Date time | | +| Dnn | 3GPP TS 29.571 [16] | DNN | | +| Gpsi | 3GPP TS 29.571 [16] | GPSI | | +| Snssai | 3GPP TS 29.571 [16] | S-NSSAI | | +| Uint32 | 3GPP TS 29.571 [16] | Uint32 | | +| MacAddr48 | 3GPP TS 29.571 [16] | MAC Address | | +| Ipv4Addr | 3GPP TS 29.571 [16] | IPv4 address | | +| Ipv6Prefix | 3GPP TS 29.571 [16] | IPv6 address prefix | | +| Uint64 | 3GPP TS 29.571 [16] | Unsigned 64-bit integer | | +| BitRate | 3GPP TS 29.571 [16] | Bit rate | | +| PacketRate | 3GPP TS 29.571 [16] | Packet rate | | +| TrafficVolume | 3GPP TS 29.571 [16] | Traffic Volume | | +| ApplicationId | 3GPP TS 29.571 [16] | The application identifier. | | +| DurationSec | 3GPP TS 29.571 [16] | | | +| NotificationFlag | 3GPP TS 29.571 [16] | Notification flag. | | +| PartitioningCriteria | 3GPP TS 29.571 [16] | Used to partition UEs before applying sampling. | | +| ProblemDetails | 3GPP TS 29.571 [16] | | | +| SamplingRatio | 3GPP TS 29.571 [16] | Sampling Ratio. | | +| Uri | 3GPP TS 29.571 [16] | | | +| IpAddr | 3GPP TS 29.571 [16] | | | +| SupportedFeatures | 3GPP TS 29.571 [16] | | | +| Supi | 3GPP TS 29.571 [16] | | | +| Pei | 3GPP TS 29.571 [16] | | | +| Uinteger | 3GPP TS 29.571 [16] | Unsigned Integer | | +| PortManagementContainer | 3GPP TS 29.512 [19] | PMIC | | +| BridgeManagementContainer | 3GPP TS 29.512 [19] | UMIC | | +| FlowInformation | 3GPP TS 29.512 [19] | IP or Ethernet Flow Information | | +| PatchItem | 3GPP TS 29.571 [16] | Patch item of JSON PATCH | | +| PatchResult | 3GPP TS 29.571 [16] | Patch result of JSON PATCH | | +| MutingExceptionInstructions | 3GPP TS 29.571 [16] | Muting exception instructions. | | +| MutingNotificationsSettings | 3GPP TS 29.571 [16] | Muting notifications settings. | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: NotificationData + +Table 6.1.6.2.2-1: Definition of type NotificationData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| notificationItems | array(NotificationItem) | M | 1..N | The list of NotificationItem, each entry corresponds to a report on one subscribed event per PDU session. | | +| correlationId | string | C | 0..1 | The UPF shall include this attribute in the notification if the "Notification Correlation ID" IE was received via N4 interface (see clause 7.5.2.9 of 3GPP TS 29.244 [15]) | | +| achievedSampRatio | SamplingRatio | O | 0..1 | This IE may be included for an event subscription for any UE to indicate the ratio of the random subset of target PDU sessions achieved by the UPF. | | + +##### 6.1.6.2.3 Type: NotificationItem + +Table 6.1.6.2.3-1: Definition of type NotificationItem + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------|----------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------|---------------| +| eventType | EventType | M | 1 | The event type of the event for which the notification is generated. | | +| uelpv4Addr | Ipv4Addr | C | 0..1 | IPv4 address of the UE (NOTE 1) | | +| uelpv6Prefix | Ipv6Prefix | C | 0..1 | IPv6 address prefix of the UE (NOTE 1) | | +| ueMacAddr | MacAddr48 | O | 0..1 | MAC address of the UE. (NOTE 2) | | +| dnn | Dnn | O | 0..1 | When present, this attribute indicates the DNN of the PDU session for which the notification is generated. | | +| snssai | Snssai | O | 0..1 | When present, this attribute indicates the S-NSSAI of the PDU session for which the notification is generated. | | +| gpsi | Gpsi | O | 0..1 | When present, this attribute indicates the GPSI of the UE for which the notification is generated. | | +| supi | Supi | O | 0..1 | Subscription Permanent Identifier | | +| timeStamp | DateTime | M | 1 | The value represents the UTC time when the information in this report was generated. | | +| startTime | DateTime | O | 0..1 | When present, this attribute shall provide the timestamp when the information measured for generating this report was started. | | +| qosMonitoringMeasurement | QosMonitoringMeasurement | C | 0..1 | This attribute shall be present if eventType is set to "QOS_MONITORING". | | +| userDataUsageMeasurements | array(UserDataUsageMeasurements) | C | 1..N | This IE shall be present if eventType is set to "USER_DATA_USAGE_MEASURES" or "USER_DATA_USAGE_TRENDS". | | +| tscMngtInfo | TscManagementInfo | C | 0..1 | This attribute shall be present if eventType is set to "TSC_MNGT_INFO". | | + +NOTE 1: At least one of uelpv4Addr and uelpv6Prefix shall be present if the subscription applies to an IP PDU session. + +NOTE 2: An NF service consumer subscribing to receive QoS Monitoring Measurement report for an ethernet PDU session shall accept the NotificationItem having neither uelpv4Addr nor uelpv6Prefix. + +6.1.6.2.4 Type: QosMonitoringMeasurement + +**Table 6.1.6.2.3-1: Definition of type QosMonitoringMeasurement** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| flowInfos | array(FlowInformation) | C | 1..N | When present, this IE shall contain an array of Ethernet or IP flow packet filter information corresponding to the QoS flow.
(NOTE) | | +| appIds | array(ApplicationId) | C | 1..N | When present, this IE shall contain an array of application identifiers corresponding to the QoS flow.
(NOTE) | | +| dlPacketDelay | Uint32 | O | 0..1 | When present, the value of this attribute is set to the measured downlink packet delay in millisecond (ms). | | +| ulPacketDelay | Uint32 | O | 0..1 | When present, the value of this attribute is set to the measured uplink packet delay in millisecond (ms). | | +| rtrPacketDelay | Uint32 | O | 0..1 | When present, the value of this attribute is set to the measured round trip packet delay in millisecond (ms). | | +| measureFailure | boolean | C | 0..1 | This IE shall be present to report packet delay measurement failure.

When present, it shall be set to true to indicate the report is sent due to packet delay measurement failure. This IE is named as the "PLMF" flag over PFCP interface. See also clauses 5.24.4.3 and 8.2.171 in 3GPP TS 29.244 [15]. | | +| dlAveThroughput | BitRate | O | 0..1 | When present, this IE shall indicate the average data throughput in downlink direction as specified in clause 5.39.3.4 of 3GPP TS 29.244 [15]. | | +| ulAveThroughput | BitRate | O | 0..1 | When present, this IE shall indicate the average data throughput in uplink direction as specified in clause 5.39.3.4 of 3GPP TS 29.244 [15]. | | +| dlCongestion | string | O | 0..1 | When present, this IE shall contain Downlink congestion information. | | +| ulCongestion | string | O | 0..1 | When present, this IE shall contain Uplink congestion information. | | + +| | | | | | +|-----------------------------------------------------------------------------|---------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| defaultQosFlowInd | boolean | C | 0..1 |

The IE shall be present when the SMF has indicated that the QoS Monitoring is for a QoS flow associated with the default QoS rule in the QoS Monitoring per QoS flow Control Information as specified in 3GPP TS 29.244 [15].

When present, this IE shall indicate whether the QoS measurements is for a QoS flow associated with the default QoS rule.

  • - true: Qos Monitoring Measurement is for a QoS flow associated with the default QoS rule;
  • - false(default): Qos Monitoring Measurement is not for a QoS flow associated with the default QoS rule.
| +| NOTE: Either the flowInfos IE or the appIds IE should be present, not both. | | | | | + +Editor's note: the encoding of the dlCongestion and ulCongestion IEs is FFS. + +##### 6.1.6.2.5 Type: UserDataUsageMeasurements + +Table 6.1.6.2.5-1: Definition of type UserDataUsageMeasurements + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| appId | ApplicationId | C | 0..1 | When present, this IE shall contain the application identifier. This IE shall be included if the requested granularity of measurement was set to "PER_APPLICATION".
This IE may be present if the requested granularity of measurement was set to "PER_FLOW".

(NOTE) | +| flowInfo | FlowInformation | C | 0..1 | When present, this IE shall contain the IP or Ethernet data flow information. This IE shall be included if the requested granularity of measurement was set to "PER_FLOW".

(NOTE) | +| volumeMeasurement | VolumeMeasurement | C | 0..1 | This attribute shall be present if eventType is set to "USER_DATA_USAGE_MEASURES" and measurementType is set to "VOLUME_MEASUREMENT". | +| throughputMeasurement | ThroughputMeasurement | C | 0..1 | This attribute shall be present if eventType is set to "USER_DATA_USAGE_MEASURES" and measurementType is set to "THROUGHPUT_MEASUREMENT". | +| applicationRelatedInformation | ApplicationRelatedInformation | C | 0..1 | This attribute shall be present if eventType is set to "USER_DATA_USAGE_MEASURES" and measurementType is set to "APPLICATION_RELATED_INFORMATION". | +| throughputStatisticMeasurements | ThroughputStatisticMeasurement | C | 0..1 | This attribute shall be present if eventType is set to "USER_DATA_USAGE_TRENDS". | +| NOTE: Either the appId or the flowInfo may be present, not both. When neither appId nor flowInfo is present, the measurements (i.e., the volumeMeasurement and/or the throughputMeasurement, and/or the applicationRelatedInformation and/or the throughputStatisticMeasurements) shall correspond to the user plane measurements of the PDU session. When appId is present, the measurements shall correspond to user plane measurements of the application identified by the appId. When flowInfo is present, the measurement shall correspond to user plane measurements for the data flow identified by the flowInfo. | | | | | + +##### 6.1.6.2.6 Type: VolumeMeasurement + +Table 6.1.6.2.6-1: Definition of type VolumeMeasurement + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|---------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| totalVolume | TrafficVolume | O | 0..1 | When present, this IE shall indicate the total volume (bytes) of user plane traffic for both the uplink and downlink directions. | +| ulVolume | TrafficVolume | O | 0..1 | When present, this IE shall indicate the volume (bytes) of user plane traffic for the uplink direction. | +| dlVolume | TrafficVolume | O | 0..1 | When present, this IE shall indicate the volume (bytes) of user plane traffic for the downlink direction. | +| totalNbOfPackets | Uint64 | O | 0..1 | When present, this IE shall indicate the total number of user plane packets for both uplink and downlink directions. | +| ulNbOfPackets | Uint64 | O | 0..1 | When present, this IE shall indicate the number of user plane packets for the uplink direction. | +| dlNbOfPackets | Uint64 | O | 0..1 | When present, this IE shall indicate the number of user plane packets for the downlink direction. | + +##### 6.1.6.2.7 Type: ThroughputMeasurement + +Table 6.1.6.2.7-1: Definition of type ThroughputMeasurement + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|------------|---|-------------|--------------------------------------------------------------------------------------------------| +| ulThroughput | BitRate | O | 0..1 | When present, this IE shall indicate the measurement of data throughput in uplink direction. | +| dlThroughput | BitRate | O | 0..1 | When present, this IE shall indicate the measurement of data throughput in downlink direction. | +| ulPacketThroughput | PacketRate | O | 0..1 | When present, this IE shall indicate the measurement of packet throughput in uplink direction. | +| dlPacketThroughput | PacketRate | O | 0..1 | When present, this IE shall indicate the measurement of packet throughput in downlink direction. | + +##### 6.1.6.2.8 Type: ApplicationRelatedInformation + +Table 6.1.6.2.8-1: Definition of type ApplicationRelatedInformation + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| urls | array(Uri) | O | 1..N | This IE may be present if available. When present, it shall contain a list of URLs detected in the traffic identified by the information included in the subscription request, e.g. an application id. | +| domainInfoList | array(DomainInformation) | O | 1..N | This IE may be present if available. When present, it shall contain a list of Domain information detected in the traffic identified by the information included in the subscription request, e.g. an application id. | + +##### 6.1.6.2.9 Type: ThroughputStatisticMeasurement + +Table 6.1.6.2.9-1: Definition of type ThroughputStatisticMeasurement + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|------------|---|-------------|----------------------------------------------------------------------------------------------------------------| +| ulAverageThroughput | BitRate | O | 0..1 | When present, this IE shall indicate the average throughput in uplink direction over the measurement period. | +| dlAverageThroughput | BitRate | O | 0..1 | When present, this IE shall indicate the average throughput in downlink direction over the measurement period. | +| ulPeakThroughput | BitRate | O | 0..1 | When present, this IE shall indicate the peak throughput in uplink direction over the measurement period. | +| dlPeakThroughput | BitRate | O | 0..1 | When present, this IE shall indicate the peak throughput in downlink direction over the measurement period. | +| ulAveragePacketThroughput | PacketRate | O | 0..1 | When present, this IE shall indicate the average packet throughput in uplink direction. | +| dlAveragePacketThroughput | PacketRate | O | 0..1 | When present, this IE shall indicate the average packet throughput in downlink direction. | +| ulPeakPacketThroughput | PacketRate | O | 0..1 | When present, this IE shall indicate the Peak packet throughput in uplink direction. | +| dlPeakPacketThroughput | PacketRate | O | 0..1 | When present, this IE shall indicate the Peak packet throughput in downlink direction. | + +##### 6.1.6.2.10 Type: DomainInformation + +Table 6.1.6.2.10-1: Definition of type: DomainInformation + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|------------|---|-------------|-------------------------------------------------------------| +| domainName | Fqdn | M | 1 | This IE shall contain a domain name. | +| domainNameProtocol | DnProtocol | O | 0..1 | This IE may be present to contain the Domain Name Protocol. | + +##### 6.1.6.2.11 Type: UpfEventSubscription + +Table 6.1.6.2.11-1: Definition of type UpfEventSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------------------------------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eventList | array(UpfEvent) | M | 1..N | Describes the events to be subscribed in subscription request or the events successfully subscribed for this subscription in subscription response. | | +| eventNotifyUri | Uri | M | 1 | Identifies the recipient of notifications sent by UPF for this subscription | | +| notifyCorrelationId | string | M | 1 | Identifies the notification correlation ID. The UPF shall include this ID in the notifications. The value of this IE shall be unique per subscription for a given NF service consumer. | | +| eventReportingMode | UpfEventMode | M | 1 | This IE shall be included to describe how the reports of the event shall be generated. | | +| nflId | NfInstanceId | M | 1 | Indicates the instance identity of the network function creating the subscription. | | +| uelpAddress | lpAddr | C | 0..1 | The IE shall be present if the event subscription is applicable to one UE. The IE shall indicate the UE's PDU Session IP address.
(NOTE) | | +| supi | Supi | O | 0..1 | Subscription Permanent Identifier | | +| gpsi | Gpsi | O | 0..1 | Generic Public Subscription Identifier | | +| pei | Pei | O | 0..1 | Permanent Equipment Identifier | | +| anyUe | boolean | C | 0..1 | This IE shall be present if the event subscription is applicable to any UE.

When present, it shall be set as follows:
true: the subscription applies to any UE.
false (default): the subscription applies to a specific UE.
(NOTE) | | +| dnn | Dnn | O | 0..1 | Data Network Name | | +| snssai | Snssai | O | 0..1 | A single Network Slice Selection Assistance Information. | | +| NOTE: Either information about a single UE (i.e. uelpAddress) or anyUe set to true shall be included. | | | | | | + +Editor's Note: Whether one DNN and/or one S-NSSAI shall be present when subscription is for any UE is FFS. The cardinality and description of DNN and S-NSSAI are FFS. + +6.1.6.2.12 Type: UpfEventMode + +**Table 6.1.6.2.12-1: Definition of type UpfEventMode** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|-----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| trigger | UpfEventTrigger | M | 1 | Describes how the reports are triggered. | | +| maxReports | integer | C | 0..1 | This IE may be present if the trigger is set to "PERIODIC". When present, this IE shall indicate the maximum number of reports that can be generated by each subscribed event in the subscription.

If the UPF event subscription is for a list of events, this parameter shall be applied to each individual event in the list. | | +| expiry | DateTime | C | 0..1 | This IE shall be included in an event subscription response, if, based on operator policy and taking into account the expiry time included in the request, the UPF needs to include an expiry time.

This IE may be included in an event subscription request.

When present, this IE shall represent the time after which the subscribed event(s) shall stop generating report and the subscription becomes invalid. If the trigger value included in an event subscription response is "ONE_TIME" and if an event report is included in the subscription response then the value of the expiry included in the response shall be an immediate timestamp. | | +| repPeriod | DurationSec | C | 0..1 | This IE shall be present if the trigger is set to "PERIODIC". When present, this IE shall indicate the period time for the event reports.

When the Event Subscription is for "ANY UE", the NF Consumer should set the "repPeriod" to a value which does not lead to a potential overload in the UPF and use sampRatio. | | +| sampRatio | SamplingRatio | O | 0..1 | This IE may be included in an event subscription request for any UE to indicate the ratio of the random subset of target PDU sessions. Event reports only relate to the subset.

If the UPF event subscription is for a list of UPF event, this parameter shall be applied to each individual event. | | +| partitioningCriteria | array(PartitioningCriteria) | O | 1..N | This IE may be included in an event subscription request for any UE if the sampRatio IE is provided.

When present, this IE shall define the criteria for determining the PDU sessions for which the sampling ratio shall apply.
(NOTE) | | +| notifFlag | NotificationFlag | O | 0..1 | Indicates the notification flag, which is used to mute/unmute notifications and to retrieve events stored during a period of muted notifications. | | + +| | | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| mutingExcInSTRUCTIONS | MutingExceptionInstructions | O | 0..1 | This IE may be included by NWDAF or DCCF in the event subscription request, if the notifFlag IE is present and set to "DEACTIVATE".
When present, it shall indicate the instructions for the subscription and stored events when an exception (e.g. the buffer of stored event reports is full, or the number of stored event reports exceeds a certain number) occurs at UPF while the events are muted.
See 3GPP TS 23.288 [17], clause 6.2.7.2.
Write-Only: true | EEMM | +| mutingNotSettings | MutingNotificationsSettings | O | 0..1 | This IE may be included in the event subscription response if the event notifications muting is activated.
This IE Indicates the UPF muting notification settings.
See 3GPP TS 23.288 [17], clause 6.2.7.2.
Read-Only: true | EEMM | +| NOTE: In this release of specification, the partitioningCriteria values defined in 3GPP TS 29.571 [16] that apply to UPF Event Exposure are SNSSAI and DNN. | | | | | | + +##### 6.1.6.2.13 Type: UpfEvent + +**Table 6.2.6.2.13-1: Definition of type UpfEvent** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| type | EventType | M | 1 | Describes the UPF event type to be reported | | +| immediateFlag | boolean | O | 0..1 | Indicates if an immediate event report containing the currently available value / status of the event is requested. The report contains the value / status of the event currently available at the UPF at the time of the subscription.

The default value is false. | | +| measurements | array(MeasurementType) | C | 1..N | This IE shall be present if the type IE is set to "USER_DATA_USAGE_MEASURES".

When present, this IE shall indicate the types of requested measurements. | | +| appIds | array(ApplicationId) | O | 1..N | Contains the application identifiers.
(NOTE 1, NOTE 2) | | +| trafficFilters | array(FlowInformation) | O | 1..N | Identifies IP or Ethernet packet filters.
(NOTE 1, NOTE 2) | | +| granularityOfMeasurement | GranularityOfMeasurement | O | 0..1 | Indicates the granularity of measurement.
(NOTE 2) | | +| reportingSuggestionInfo | ReportingSuggestionInformation | C | 0..1 | The IE should be present if the event notification can be delayed, i.e. it is delay tolerant. | | +| NOTE 1: Either the appIds IE or the trafficFilters IE may be present, not both. | | | | | | +| NOTE 2: If the appIds or trafficFilters is provided, the granularityOfMeasurement shall not be set to "PER_SESSION". If neither appIds nor trafficFilters is provided, the granularityOfMeasurement may be set to "PER_SESSION", "PER_APPLICATION" or "PER_FLOW" to request the UPF to provide measurements with the corresponding granularity. | | | | | | + +##### 6.1.6.2.14 Type: CreateEventSubscription + +Table 6.2.6.2.14-1: Definition of type CreateEventSubscription + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| subscription | UpfEventSubscription | M | 1 | Represents the UPF Event Subscription resource to be created. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | + +##### 6.1.6.2.15 Type: CreatedEventSubscription + +Table 6.1.6.2.15-1: Definition of type CreatedEventSubscription + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| subscription | UpfEventSubscription | M | 1 | Represents the newly created UPF Event Subscription resource. | +| subscriptionId | Uri | M | 1 | Represents the URI of the newly created UPF Event Subscription resource. This shall contain an absolute URI set to the Resource URI specified in clause 6.1.3.3.2. (NOTE) | +| reportList | array(NotificationItem) | O | 1..N | Represents the immediate event reports (i.e. the current value / status of the events subscribed), if available. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | + +NOTE: 3GPP TS 23.502 [3] specifies this attribute as "Subscription Correlation ID". + +##### 6.1.6.2.16 Type: ReportingSuggestionInformation + +Table 6.1.6.2.16-1: Definition of type ReportingSuggestionInformation + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reportingUrgency | ReportingUrgency | M | 1 | Indicates whether the event report is delay tolerant. | +| reportingTimeInfo | DurationSec | C | 0..1 | This IE shall be present if the Reporting urgency information indicates it is delay tolerant. When present, this IE shall define the latest time for the UPF to report the detected event. | + +##### 6.1.6.2.17 Type: TscManagementInfo + +Table 6.1.6.2.17-1: Definition of type TscManagementInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------|---------------| +| pmics | array(PortManagementContainer) | O | 1..N | When present, this IE shall contain a Port Management Information Container for one or more NW-TT ports. | | +| umic | BridgeManagementContainer | O | 0..1 | When present, this IE shall contain a User Plane Node Management Information Container. | | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +No specific simple data types are defined in this release. + +##### 6.1.6.3.3 Enumeration: EventType + +The enumeration EventType represents the type of event to which the NF service consumer may subscribe to and for which the notification is generated. It shall comply with the provisions defined in table 6.1.5.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration EventType** + +| Enumeration value | Description | Applicability | +|----------------------------|---------------------------------------------------|---------------| +| "QOS_MONITORING" | QoS Monitoring Measurement (see clause 5.2.1.3.2) | | +| "USER_DATA_USAGE_MEASURES" | User Data Usage Measures (see clause 5.2.1.3.3) | | +| "USER_DATA_USAGE_TRENDS" | User Data Usage Trends (see clause 5.2.1.3.4) | | +| "TSC_MNGT_INFO" | TSC Management Information | | + +##### 6.1.6.3.4 Enumeration: UpfEventTrigger + +**Table 6.1.6.3.4-1: Enumeration UpfEventTrigger** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "ONE_TIME" | Defines that UPF should generate report for the event only once. After reporting, the subscription to this event is terminated. | +| "PERIODIC" | Defines that UPF should periodically generate reports for the event, until the subscription to this event ends, due to end of report duration or up to the maximum number of reports or the event being unsubscribed explicitly. | + +##### 6.1.6.3.5 Enumeration: MeasurementType + +**Table 6.1.6.3.5-1: Enumeration MeasurementType** + +| Enumeration value | Description | +|-----------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| "VOLUME_MEASUREMENT" | Measures of data volume exchanged (UL, DL and/or overall and/or number of packets exchanged (UL, DL and/or overall).
(NOTE) | +| "THROUGHPUT_MEASUREMENT" | Measures of data throughput (UL and DL).
(NOTE) | +| "APPLICATION_RELATED_INFO" | URL/s and/or Domain name/s detected in the traffic identified by the information included in the subscription request, e.g. an application id.
(NOTE) | +| NOTE: This value may be used for the "USER_DATA_USAGE_MEASURES" event type. | | + +##### 6.1.6.3.6 Enumeration: GranularityOfMeasurement + +**Table 6.1.6.3.6-1: Enumeration GranularityOfMeasurement** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------------------------------------| +| "PER_APPLICATION" | Indicates that the granularity of the requested measurements is per application. | +| "PER_SESSION" | Indicates that the granularity of the requested measurements is per PDU Session. | +| "PER_FLOW" | Indicates that granularity of the requested measurements is per data flow. | + +##### 6.1.6.3.7 Enumeration: DnProtocol + +**Table 6.1.6.3.7-1: Enumeration DnProtocol** + +| Enumeration value | Description | +|-------------------|---------------------------------------------------------------------------| +| "DNS_QNAME" | Identifies the DNS protocol and the question name in DNS query. | +| "TLS_SNI" | Identifies the Server Name Indication in TLS ClientHello message. | +| "TLS_SAN" | Identifies the Subject Alternative Name in TLS ServerCertificate message. | +| "TLS_SCN" | Identifies the Subject Common Name in TLS ServerCertificate message. | + +##### 6.1.6.3.8 Enumeration: ReportingUrgency + +**Table 6.1.6.3.8-1: Enumeration ReportingUrgency** + +| Enumeration value | Description | +|----------------------|-----------------------------------------| +| "DELAY_TOLERANT" | The event report is delay tolerant. | +| "NON_DELAY_TOLERANT" | The event report is not delay tolerant. | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nupf\_EventExposure API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nupf\_EventExposure API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nupf\_EventExposure service are specified in this release. + +#### 6.1.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nupf\_EventExposure service, and the following application errors listed in Table 6.1.7.3-1 are specific for the Nupf\_EventExposure service. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| PDU_SESSION_NOT_SERVED_BY_UPF | 403 Forbidden | Indicates the creation of a subscription towards a PDU session has failed due to an application error when the PDU session is not served by the UPF. | +| MUTING_EXC_INSTR_NOT_ACCEPTED | 403 Forbidden | Indicates the UPF does not accept the received muting exception instructions. | +| SUBSCRIPTION_NOT_FOUND | 404 Not Found | Indicates the deletion of subscription has failed due to an application error when the subscription is not found in the UPF. | + +### 6.1.8 Feature negotiation + +The optional features listed in table 6.2.8-1 are defined for the Nupf\_EventExposure API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | M/O | Description | +|----------------|--------------|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | EEMM | O | Event Exposure Muting Mechanism

An UPF supporting this feature shall support the handling of event muting exception instructions as specified in clause 6.2.7.2 of 3GPP TS 23.288 [17]. | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8], the access to the Nupf\_EventExposure API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nupf\_EventExposure API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nupf\_EventExposure service. + +The Nupf\_EventExposure API defines scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [8]; it defines a single scope consisting on the name of the service (i.e., "nupf-ee"), and it does not define any additional scopes at resource or operation level. + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different UPF service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different UPF producer instance will return the NF Instance ID of the new UPF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an UPF redirects a service request to a different UPF using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new UPF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.2 Nupf\_GetPrivateUEIPaddr Service API + +### 6.2.1 Introduction + +The Nupf\_GetPrivateUEIPaddr service shall use the Nupf\_GetPrivateUEIPaddr API. + +The API URI of the Nupf\_GetPrivateUEIPaddr Service API shall be: + +**{apiRoot}** + +The request URI used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nupf\_gueip". +- The shall be "v1". +- The shall be set as described in clause 5.3. + +### 6.2.2 Usage of HTTP + +#### 6.2.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nupf\_GetPrivateUEIPaddr API is contained in Annex A. + +#### 6.2.2.2 HTTP standard headers + +##### 6.2.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.2.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +#### 6.2.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +### 6.2.3 Resources + +#### 6.2.3.1 Overview + +![Diagram showing the resource URI structure. A vertical line descends from the base URI '{apiRoot}/nupf-gueip/' to a horizontal line that leads to a rounded rectangle containing the path '/ue-ip-info'.](69e5f1993021af230d08c08aac97d9df_img.jpg) + +{apiRoot}/nupf-gueip/ + +``` + +graph TD + A["{apiRoot}/nupf-gueip/"] --> B["/ue-ip-info"] + +``` + +Diagram showing the resource URI structure. A vertical line descends from the base URI '{apiRoot}/nupf-gueip/' to a horizontal line that leads to a rounded rectangle containing the path '/ue-ip-info'. + +**Figure 6.2.3.1-1: Resource URI structure of the Nupf\_GetPrivateUEIPaddr API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------|--------------|---------------------------------|-----------------------------| +| UE IP Address Info | /ue-ip-info | GET | Nupf_GetPrivateUEIPaddr_Get | + +#### 6.2.3.2 Resource: UE IP Address Info + +##### 6.2.3.2.1 Description + +This resource represents the UE IP Address Info of all the PDU sessions served by the UPF. + +This resource is modelled with the Document archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nupf\_gueip//ue-ip-info + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | + +##### 6.2.3.2.3 Resource Standard Methods + +###### 6.2.3.2.3.1 GET + +This operation retrieves the UE IP Info of a PDU session, which contains the UE's PDU Session (private) IP address, by querying the UPF with the NATed UE's public IP address and an optional Port number. + +This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.2.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|-----------------|------------|---|-------------|----------------------------|---------------| +| ue-ipv4-address | Ipv4Addr | O | 0..1 | UE's IPv4 address | | +| ue-ipv6-prefix | Ipv6Prefix | O | 0..1 | UE's IPv6 Prefix | | +| port-number | integer | O | 0..1 | UDP or TCP Port | | +| dnn | Dnn | O | 0..1 | DNN of the PDU session | | +| snssai | Snssai | O | 0..1 | S-NSSAI of the PDU session | | + +This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3. + +**Table 6.2.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UelpInfo | M | 1 | 200 OK | The response body contains a UelpInfo for a PDU session which contains attributes that are matching the queryparameter. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- NO_MATCHING UE_IP_ADDRESS

See table 6.2.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | + +**Table 6.2.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +##### 6.2.3.2.4 Resource Custom Operations + +None. + +### 6.2.4 Custom Operations without associated resources + +None + +### 6.2.5 Notifications + +#### 6.2.5.1 General + +None. + +### 6.2.6 Data Model + +#### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Nupf\_GetPrivateUEIPaddr service based interface protocol. + +**Table 6.2.6.1-1: Nupf\_GetPrivateUEIPaddr specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-----------|----------------|------------------------------|---------------| +| UelpInfo | 6.1.6.2.2 | A UelpInfo for a PDU session | | + +Table 6.2.6.1-2 specifies data types re-used by the Nupf\_GetPrivateUEIPaddr service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the NNF service based interface. + +**Table 6.2.6.1-2: Nupf\_GetPrivateUEIPaddr re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|------------|---------------------|---------------------|---------------| +| Dnn | 3GPP TS 29.571 [16] | DNN | | +| Snssai | 3GPP TS 29.571 [16] | S-NSSAI | | +| Ipv4Addr | 3GPP TS 29.571 [16] | IPv4 address | | +| Ipv6Prefix | 3GPP TS 29.571 [16] | IPv6 address prefix | | +| Supi | 3GPP TS 29.571 [16] | SUPI | | +| Gpsi | 3GPP TS 29.571 [16] | GPSI | | + +#### 6.2.6.2 Structured data types + +##### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.2.6.2.2 Type: UelpInfo + +Table 6.2.6.2.2-1: Definition of type UelpInfo + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| privateIpv4Address | Ipv4Address | O | 0..1 | When present, this IE shall contain the Private IPv4 IP address. | +| ipDomain | string | O | 0..1 | When present, this IE contains the IP domain of the private IPv4 address. | +| privateIpv6Prefix | Ipv6Prefix | O | 0..1 | When present, this IE shall contain the Private IPv6 Prefix. | +| publicIpv4Address | Ipv4Address | O | 0..1 | When present, this IE shall contain the public (NATed) IPv4 IP address. | +| publicIpv6Prefix | Ipv6Prefix | O | 0..1 | When present, this IE shall contain the public (NATed) IPv6 Prefix. | +| portNumber | Uint16 | O | 0..1 | When present, this IE shall contain the port number for the source UDP or TCP port when Port Address Translation is used. | +| dnn | Dnn | O | 0..1 | When present, this IE shall contain the DNN of the PDU Session. | +| snssai | Snssai | O | 0..1 | When present, this IE shall contain the S-NSSAI of the PDU Session. | +| hplmnSnssai | Snssai | O | 0..1 | This IE may be included by a V-UPF acting as (local) PSA for a HR-SBO PDU session.
When present, it shall contain the HPLMN S-NSSAI of the PDU session. | +| supi | Supi | O | 0..1 | When present, this IE shall contain the SUPI of the UE. | +| gpsi | Gpsi | O | 0..1 | When present, this IE shall contain the GPSI of the UE. | + +#### 6.2.6.3 Simple data types and enumerations + +##### 6.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +### 6.2.7 Error Handling + +#### 6.2.7.1 General + +For the Nupf\_GetPrivateUEIPaddr API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nupf\_GetPrivateUEIPaddr API. + +#### 6.2.7.2 Protocol Errors + +No specific procedures for the Nupf\_GetPrivateUEIPaddr service are specified. + +#### 6.2.7.3 Application Errors + +The application errors defined for the Nupf\_GetPrivateUEIPaddr service are listed in Table 6.2.7.3-1. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------|------------------|----------------------------------------------------------| +| NO_UE_IP_INFO_FOUND | 404 Not Found | There is no UE IP address matching the query parameters. | + +### 6.2.8 Feature negotiation + +The optional features in table 6.2.8-1 are defined for the Nupf\_GetPrivateUEIPaddr API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.2.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nupf\_GetPrivateUEIPaddr API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nupf\_GetPrivateUEIPaddr API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nupf\_GetPrivateUEIPaddr service. + +The Nupf\_GetPrivateUEIPaddr API defines a single scope "nupf\_gueip" for the entire service, and it does not define any additional scopes at resource or operation level. + +### 6.2.10 HTTP redirection + +An HTTP request may be redirected to a different UPF service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different UPF producer instance will return the NF Instance ID of the new UPF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an UPF redirects a service request to a different UPF using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new UPF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## --- A.2 Nupf\_EventExposure API + +``` +openapi: 3.0.0 + +info: + title: 'UPF Event Exposure Service' + version: 1.1.0-alpha.4 + description: | + UPF Event Exposure Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.564 V18.3.0; 5G System; User Plane Function Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.564/ + +servers: + - url: '{apiRoot}/nupf-ee/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nupf-ee + +paths: + /ee-subscriptions: + post: + summary: Nupf_EventExposure Subscribe service Operation + operationId: CreateSubscription + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateEventSubscription' + responses: + '201': + description: Successful creation of an UPF Event Subscription + headers: + Location: +``` + +``` + + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nupf-ee//ee-subscriptions/{subscriptionId}' + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CreatedEventSubscription' +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + eeNotification: + '{eventNotificationUri}': + # The URI in {eventNotificationUri} is provided via N4 interface during provisioning of +Session Reporting Rule or in the Nupf_EventExposure Subscribe request. + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationData' + responses: + '204': + description: No Content, Notification was successfull + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: 'The URI pointing to the resource located on the redirect target' +NF service consumer' + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: 'The URI pointing to the resource located on the redirect target' +NF service consumer' + required: true + schema: + type: string + +``` + +``` + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/ee-subscriptions/{subscriptionId}: + patch: + summary: Nupf_EventExposure Subscribe Modify service Operation + operationId: ModifySubscription + parameters: + - name: subscriptionId + in: path + required: true + description: Unique ID of the subscription to be modified + schema: + type: string + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +``` + +``` +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Nupf_EventExposure UnSubscribe service Operation + operationId: DeleteSubscription + parameters: + - name: subscriptionId + in: path + required: true + description: Unique ID of the subscription to be deleted + schema: + type: string + responses: + '204': + description: Subscription deleted successfully + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nupf-ee: Access to the Nupf_EventExposure API + +schemas: + # API specific definitions + +# STRUCTURED DATA TYPES + +NotificationData: + description: the list of NotificationItems + type: object + required: + - notificationItems + properties: + notificationItems: + type: array + items: + $ref: '#/components/schemas/NotificationItem' + minItems: 1 + correlationId: + type: string + achievedSampRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' +``` + +``` +NotificationItem: + description: represents a report on one subscribed event + type: object + required: + - eventType + - timeStamp + anyOf: + - required: [ ueIpv4Addr ] + - required: [ ueIpv6Prefix ] + - required: [ ueMacAddr ] + properties: + eventType: + $ref: '#/components/schemas/EventType' + ueIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ueIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + ueMacAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + startTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + qosMonitoringMeasurement: + $ref: '#/components/schemas/QosMonitoringMeasurement' + tscMngtInfo: + $ref: '#/components/schemas/TscManagementInfo' + userDataUsageMeasurements: + type: array + items: + $ref: '#/components/schemas/UserDataUsageMeasurements' + minItems: 1 + +UpfEventSubscription: + description: UPF Event Subscription + type: object + properties: + eventList: + type: array + items: + $ref: '#/components/schemas/UpfEvent' + minItems: 1 + eventNotifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifyCorrelationId: + type: string + eventReportingMode: + $ref: '#/components/schemas/UpfEventMode' + nfid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + ueIpAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + anyUe: + type: boolean + default: false + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + required: + - eventList + - eventNotifyUri + - notifyCorrelationId +``` + +- eventReportingMode +- nfId + +UpfEventMode: +description: UPF Event Mode +type: object +properties: + trigger: + \$ref: '#/components/schemas/UpfEventTrigger' + maxReports: + type: integer + expiry: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/DateTime' + repPeriod: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/DurationSec' + sampRatio: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/SamplingRatio' + partitioningCriteria: + type: array + items: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/PartitioningCriteria' + minItems: 1 + notifFlag: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/NotificationFlag' + mutingExcInstructions: + writeOnly: true + allOf: + - \$ref: 'TS29571\_CommonData.yaml#/components/schemas/MutingExceptionInstructions' + mutingNotSettings: + readOnly: true + allOf: + - \$ref: 'TS29571\_CommonData.yaml#/components/schemas/MutingNotificationsSettings' +required: + - trigger + +UpfEvent: +description: UPF Event +type: object +properties: + type: + \$ref: '#/components/schemas/EventType' + immediateFlag: + type: boolean + default: false + measurementTypes: + type: array + items: + \$ref: '#/components/schemas/MeasurementType' + minItems: 1 + appIds: + type: array + items: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + trafficFilters: + type: array + items: + \$ref: 'TS29512\_Npcf\_SMPolicyControl.yaml#/components/schemas/FlowInformation' + minItems: 1 + granularityOfMeasurement: + \$ref: '#/components/schemas/GranularityOfMeasurement' + reportingSuggestionInfo: + \$ref: '#/components/schemas/ReportingSuggestionInformation' +required: + - type + +CreateEventSubscription: +description: Data within UPF Create Event Subscription Request +type: object +properties: + subscription: + \$ref: '#/components/schemas/UpfEventSubscription' + supportedFeatures: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/SupportedFeatures' +required: + - subscription + +CreatedEventSubscription: + +``` +description: Data within UPF Create Event Subscription Response +type: object +properties: + subscription: + $ref: '#/components/schemas/UpfEventSubscription' + subscriptionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + reportList: + type: array + items: + $ref: '#/components/schemas/NotificationItem' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +required: +- subscription +- subscriptionId +``` + +``` +ReportingSuggestionInformation: +description: Reporting Suggestion Information +type: object +properties: + reportingUrgency: + $ref: '#/components/schemas/ReportingUrgency' + reportingTimeInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +required: +- reportingUrgency +``` + +``` +QosMonitoringMeasurement: +description: QoS Monitoring Measurement information +type: object +properties: + flowInfos: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowInformation' + minItems: 1 + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + dlPacketDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + ulPacketDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + rtrPacketDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + measureFailure: + type: boolean + enum: + - true + dlAveThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ulAveThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + dlCongestion: + type: string + ulCongestion: + type: string + defaultQosFlowInd: + type: boolean + default: false +``` + +# Editor's note: the encoding of the dlCongestion and ulCongestion IEs is FFS + +``` +TscManagementInfo: +description: TSC Management Information +type: object +properties: + pmics: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + minItems: 1 + umic: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/BridgeManagementContainer' +``` + +``` +UserDataUsageMeasurements: + description: > + User Data Usage Measurements either for the PDU session, or the app-id, or the data flow + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + flowInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowInformation' + volumeMeasurement: + $ref: '#/components/schemas/VolumeMeasurement' + throughputMeasurement: + $ref: '#/components/schemas/ThroughputMeasurement' + applicationRelatedInformation: + $ref: '#/components/schemas/ApplicationRelatedInformation' + throughputStatisticsMeasurement: + $ref: '#/components/schemas/ThroughputStatisticsMeasurement' + +VolumeMeasurement: + description: Volume Measurement information + type: object + properties: + totalVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TrafficVolume' + ulVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TrafficVolume' + dlVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TrafficVolume' + totalNbOfPackets: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + ulNbOfPackets: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + dlNbOfPackets: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + +ThroughputMeasurement: + description: Throughput Measurement information + type: object + properties: + ulThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + dlThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ulPacketThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketRate' + dlPacketThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketRate' + +ApplicationRelatedInformation: + description: Application Related Information + type: object + properties: + urls: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + domainInfoList: + type: array + items: + $ref: '#/components/schemas/DomainInformation' + minItems: 1 + +ThroughputStatisticsMeasurement: + description: Throughput Statistics Measurement + type: object + properties: + ulAverageThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + dlAverageThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ulPeakThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + dlPeakThroughPut: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ulAveragePacketThroughput: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketRate' + dlAveragePacketThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketRate' + ulPeakPacketThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketRate' + dlPeakPacketThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketRate' + +DomainInformation: + description: Domain Information + type: object + properties: + domainName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + domainNameProtocol: + $ref: '#/components/schemas/DnProtocol' + required: + - domainName + +# ENUMS + +EventType: + description: Event Type + anyOf: + - type: string + enum: + - QOS_MONITORING + - USER_DATA_USAGE_MEASURES + - USER_DATA_USAGE_TRENDS + - TSC_MNGT_INFO + - type: string + +UpfEventTrigger: + description: Upf Event Trigger + anyOf: + - type: string + enum: + - ONE_TIME + - PERIODIC + - type: string + +MeasurementType: + description: Measurement Type + anyOf: + - type: string + enum: + - VOLUME_MEASUREMENT + - THROUGHPUT_MEASUREMENT + - APPLICATION_RELATED_INFO + - type: string + +GranularityOfMeasurement: + description: Granularity Of Measurement + anyOf: + - type: string + enum: + - PER_APPLICATION + - PER_SESSION + - PER_FLOW + - type: string + +DnProtocol: + description: Domain Name Protocol + anyOf: + - type: string + enum: + - DNS_QNAME + - TLS_SNI + - TLS_SAN + - TLS_SCN + - type: string + +ReportingUrgency: + description: Reporting Urgency + anyOf: + - type: string +``` + +``` +enum: + - DELAY_TOLERANT + - NON_DELAY_TOLERANT +- type: string +``` + +``` +# SIMPLE TYPES +``` + +## A.3 Nupf\_GetPrivateUEIPaddr API + +``` +openapi: 3.0.0 +``` + +### ``` info: ``` + +``` + version: '1.0.0-alpha.3' + title: 'UPF GET Private UE IP address Service' + description: | + Nupf_GetPrivateUEIPaddr Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +``` + +### ``` externalDocs: ``` + +``` + description: 3GPP TS 29.564 V18.3.0; 5G System; 5G System; User Plane Function Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.564/' +``` + +### ``` servers: ``` + +``` + - url: '{apiRoot}/nupf-gueip/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 +``` + +### ``` security: ``` + +``` + - {} + - oAuth2ClientCredentials: + - nupf-gueip +``` + +### ``` paths: ``` + +### ``` /ue-ip-info: ``` + +### ``` get: ``` + +``` + summary: Search UeIpInfo for a PDU session from the UeIpInfo + operationId: SearchUeIpInfo + tags: + - UE IP Info_Get + parameters: + - name: snssai + in: query + description: Slice of the PDU session + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + - name: dnn + in: query + description: Dnn of the PDU session + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - name: ue-ipv4-address + in: query + description: IPv4 address of the UE + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + - name: ue-ipv6-prefix + in: query + description: IPv6 prefix of the UE + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + - name: port-number + in: query + description: UDP or TCP port associated with the public address + schema: + type: integer + minimum: 0 + maximum: 65535 + responses: + '200': + description: Successful response + content: + application/json: +``` + +``` + + schema: + $ref: '#/components/schemas/UeIpInfo' + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target UPF + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target UPF + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nupf-gueip: Access to the Nupf_GetPrivateUEIPaddr API + +schemas: + UeIpInfo: + description: a UE IP Address Info for a PDU session + type: object + properties: + privateIpv4Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipDomain: + type: string + privateIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + publicIpv4Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + publicIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + portNumber: + +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16' +dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' +hplmnSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' +supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' +``` + +# --- Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|--------------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------|-------------|--| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | | +| 2021-09 | CT4#105e | C4-214754 | | | | Version after CT4#105-e including agreed pCRs:
C4-214464
C4-214465
C4-214559 | 0.1.0 | | +| 2021-10 | CT4#106e | C4-215518 | | | | Version after CT4#106-e including agreed pCRs:
C4-215441
C4-215443
C4-215532
C4-215536 | 0.2.0 | | +| 2021-11 | CT4#107e | C4-216471 | | | | Version after CT4#107-e including agreed pCRs:
C4-216524
C4-216525 | 0.3.0 | | +| 2021-12 | CT#94e | CP-213167 | | | | V1.0.0 presented for information | 1.0.0 | | +| 2022-01 | CT4#107bis-e | C4-220453 | | | | Version after CT4#107bis-e including agreed pCRs:
C4-220146
C4-220147
C4-220148
C4-220149 | 1.1.0 | | +| 2022-02 | CT4#108-e | C4-221591 | | | | Editorial corrections of the rapporteur | 1.2.0 | | +| 2022-03 | CT#95-e | CP-220106 | | | | TS presented for approval | 2.0.0 | | +| 2022-03 | CT#95-e | | | | | TS approved | 17.0.0 | | +| 2022-06 | CT#96-e | CP-221034 | 0001 | 2 | B | Resolving Editor's Note on Notification Information | 17.1.0 | | +| 2022-06 | CT#96-e | CP-221051 | 0003 | | F | 29.564 Rel-17 API version and External doc update | 17.1.0 | | +| 2022-09 | CT#97-e | CP-222029 | 0005 | | F | Description fields | 17.2.0 | | +| 2022-09 | CT#97-e | CP-222029 | 0004 | 1 | F | Reporting Packet Delay Measurement Failure to AF/NEF when direct reporting applies | 17.2.0 | | +| 2022-09 | CT#97-e | CP-222029 | 0006 | 1 | F | Add MAC address information in NotificationItem | 17.2.0 | | +| 2022-09 | CT#97-e | CP-222058 | 0008 | | F | 29.564 Rel-17 API version and External doc update | 17.2.0 | | +| 2023-03 | CT#99 | CP-230034 | 0010 | 1 | B | Service operations of the UPF event exposure service | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0011 | 1 | B | Subscriptions to UPF events | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0012 | 1 | B | UPF events supported by the UPF event exposure service | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0014 | 1 | B | Unsubscribe service operation | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0015 | 1 | B | Resource URI structure of the UPF event exposure API | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0017 | 1 | B | Security of UPF Event Exposure service | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0022 | 1 | B | Service operations of Nupf_EventExposure service | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0019 | 1 | B | Nupf_GetPrivateUEIPaddr service operation and API | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0021 | 1 | B | Resource and data type of Nupf_GetPrivateUEIPaddr service | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0009 | 3 | B | Updates to the Introduction of TS 29.564 | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0013 | 2 | B | Subscribe service operation | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0023 | 2 | B | Resource for Nupf_EventExposure service | 18.0.0 | | +| 2023-03 | CT#99 | CP-230071 | 0029 | | F | 29.564 Rel-18 API version and External doc update | 18.0.0 | | +| 2023-06 | CT#100 | CP-231027 | 0027 | | 4 | Location header and missing Redirection clause | 18.1.0 | | +| 2023-06 | CT#100 | CP-231035 | 0030 | | F | Correction on DNN and S-NSSAI in Nupf_GetPrivateUEIPaddr_Get Operation | 18.1.0 | | +| 2023-06 | CT#100 | CP-231035 | 0035 | | B | Support for Data rate monitoring | 18.1.0 | | +| 2023-06 | CT#100 | CP-231035 | 0032 | 1 | F | Creation of a Subscription for Nupf_eventexposure | 18.1.0 | | +| 2023-06 | CT#100 | CP-231259 | 0033 | 3 | B | Data types for Nupf_eventexposure service notify operation and openAPI | 18.1.0 | | +| 2023-06 | CT#100 | CP-231260 | 0024 | 3 | B | Data types for Nupf_eventexposure service subscribe operation and openAPI | 18.1.0 | | +| 2023-06 | CT#100 | CP-231035 | 0036 | 1 | B | Including SUPI in the response | 18.1.0 | | +| 2023-06 | CT#100 | CP-231035 | 0038 | 1 | B | UPF exposure of TSC Management Information | 18.1.0 | | +| 2023-06 | CT#100 | CP-231035 | 0039 | 1 | B | NF ID in Nupf_EventExposure_Subscribe Request and Fixing Incorrect References | 18.1.0 | | +| 2023-06 | CT#100 | CP-231035 | 0040 | 1 | B | Modification of a subscription for UPF events | 18.1.0 | | +| 2023-06 | CT#100 | CP-231035 | 0041 | 1 | B | Resource and data type of modification of a subscription for UPF events | 18.1.0 | | +| 2023-06 | CT#100 | CP-231057 | 0037 | 1 | B | UPF exposure of congestion information | 18.1.0 | | +| 2023-06 | CT#100 | CP-231070 | 0045 | | F | 29.564 Rel-18 API version and External doc update | 18.1.0 | | +| 2023-09 | CT#101 | CP-232038 | 0046 | | F | Consumers of the UPF Event Exposure service | 18.2.0 | | +| 2023-09 | CT#101 | CP-232038 | 0053 | | B | Applicability of the value "CONTINUOUS" for UpfEventTrigger | 18.2.0 | | +| 2023-09 | CT#101 | CP-232038 | 0055 | | F | RedirectResponse Description | 18.2.0 | | +| 2023-09 | CT#101 | CP-232038 | 0056 | | B | The Immediate Report Flag | 18.2.0 | | +| 2023-09 | CT#101 | CP-232038 | 0047 | 1 | F | Subscription type for User Data Usage Measures / Trends | 18.2.0 | | +| 2023-09 | CT#101 | CP-232038 | 0054 | 1 | B | Domain Name Protocol | 18.2.0 | | +| 2023-09 | CT#101 | CP-232038 | 0058 | 2 | B | The partitioning criteria for the UPF Event Exposure | 18.2.0 | | +| 2023-09 | CT#101 | CP-232038 | 0057 | 2 | B | Multiple PDU Sessions in a NotificationItem | 18.2.0 | | +| 2023-09 | CT#101 | CP-232054 | 0050 | 1 | B | QoS flow description in QoS monitoring report | 18.2.0 | | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------|--------| +| 2023-09 | CT#101 | CP-232054 | 0048 | 2 | B | Data rate monitoring | 18.2.0 | +| 2023-09 | CT#101 | CP-232054 | 0049 | 3 | B | Exposure of congestion information | 18.2.0 | +| 2023-09 | CT#101 | CP-232060 | 0059 | | F | 29.564 Rel-18 API version and External doc update | 18.2.0 | +| 2023-09 | CT#101 | CP-232067 | 0052 | 1 | A | Support of an Ethernet PDU Session | 18.2.0 | +| 2023-12 | CT#102 | CP-233028 | 0069 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9113 | 18.3.0 | +| 2023-12 | CT#102 | CP-233030 | 0075 | | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.3.0 | +| 2023-12 | CT#102 | CP-233032 | 0064 | | F | Miscellaneous corrections | 18.3.0 | +| 2023-12 | CT#102 | CP-233032 | 0066 | | F | List and description of events supported by the Nupf_EventExposure service | 18.3.0 | +| 2023-12 | CT#102 | CP-233032 | 0068 | | B | Reporting Suggestion Information | 18.3.0 | +| 2023-12 | CT#102 | CP-233032 | 0063 | 1 | F | Correction on dnn and reportingUrgency attributes | 18.3.0 | +| 2023-12 | CT#102 | CP-233032 | 0073 | | B | Achieved sampling ratio in Nupf_EventExposure_Notify | 18.3.0 | +| 2023-12 | CT#102 | CP-233032 | 0074 | 1 | B | Indication of QoS Flow associated with the default QoS Rule | 18.3.0 | +| 2023-12 | CT#102 | CP-233032 | 0072 | 1 | B | Nupf_GetPrivateUEIPaddr_Get response with GPSI | 18.3.0 | +| 2023-12 | CT#102 | CP-233038 | 0065 | | B | UPF GetPrivateUEIPaddr service extensions for HR-SBO PDU sessions | 18.3.0 | +| 2023-12 | CT#102 | CP-233045 | 0061 | 2 | B | Muting enhancements | 18.3.0 | +| 2023-12 | CT#102 | CP-233053 | 0071 | 1 | F | Per QoS flow data rate monitoring | 18.3.0 | +| 2023-12 | CT#102 | CP-233060 | 0077 | | F | 29.564 Rel-18 API version and External doc update | 18.3.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29565/raw.md b/marked/Rel-18/29_series/29565/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..cdc53a9fad13c0d4c02fd5fecdab217824424836 --- /dev/null +++ b/marked/Rel-18/29_series/29565/raw.md @@ -0,0 +1,7832 @@ + + +# 3GPP TS 29.565 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Time Sensitive Communication and Time Synchronization Function Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' in black with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller black text to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'P' has a red signal wave icon below it. Below the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps, black font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|----------------------------------------------------------------------------------|----| +| Foreword..... | 10 | +| 1 Scope..... | 11 | +| 2 References..... | 11 | +| 3 Definitions, symbols and abbreviations..... | 12 | +| 3.1 Definitions..... | 12 | +| 3.2 Symbols..... | 13 | +| 3.3 Abbreviations..... | 13 | +| 4 Overview..... | 13 | +| 4.1 Introduction..... | 13 | +| 4.2 Service Architecture..... | 13 | +| 5 Services offered by the TSCTSF..... | 14 | +| 5.1 Introduction..... | 14 | +| 5.2 Ntsctsf_TimeSynchronization Service..... | 15 | +| 5.2.1 Service Description..... | 15 | +| 5.2.1.1 Overview..... | 15 | +| 5.2.1.2 Network Functions..... | 16 | +| 5.2.1.2.1 TSCTSF..... | 16 | +| 5.2.1.2.2 NF Service Consumers..... | 16 | +| 5.2.2 Service Operations..... | 16 | +| 5.2.2.1 Introduction..... | 16 | +| 5.2.2.2 Ntsctsf_TimeSynchronization_CapsSubscribe..... | 17 | +| 5.2.2.2.1 General..... | 17 | +| 5.2.2.2.2 Creating a new subscription..... | 17 | +| 5.2.2.2.3 Modifying an existing subscription..... | 20 | +| 5.2.2.3 Ntsctsf_TimeSynchronization_CapsUnsubscribe..... | 21 | +| 5.2.2.3.1 General..... | 21 | +| 5.2.2.3.2 Unsubscription from capability notifications..... | 21 | +| 5.2.2.4 Ntsctsf_TimeSynchronization_CapsNotify..... | 22 | +| 5.2.2.4.1 General..... | 22 | +| 5.2.2.4.2 Notification about the capability of time synchronization service..... | 22 | +| 5.2.2.5 Ntsctsf_TimeSynchronization_ConfigCreate..... | 23 | +| 5.2.2.5.1 General..... | 23 | +| 5.2.2.5.2 Creating a new configuration..... | 23 | +| 5.2.2.6 Ntsctsf_TimeSynchronization_ConfigUpdate..... | 26 | +| 5.2.2.6.1 General..... | 26 | +| 5.2.2.6.2 Updating an existing configuration..... | 26 | +| 5.2.2.7 Ntsctsf_TimeSynchronization_ConfigDelete..... | 29 | +| 5.2.2.7.1 General..... | 29 | +| 5.2.2.7.2 Deleting an existing configuration..... | 29 | +| 5.2.2.8 Ntsctsf_TimeSynchronization_ConfigUpdateNotify..... | 30 | +| 5.2.2.8.1 General..... | 30 | +| 5.2.2.8.2 Notifying the current state of an existing configuration..... | 30 | +| 5.3 Ntsctsf_QoSandTSCAssistance Service..... | 31 | +| 5.3.1 Service Description..... | 31 | +| 5.3.1.1 Overview..... | 31 | +| 5.3.1.2 Network Functions..... | 31 | +| 5.3.1.2.1 TSCTSF..... | 31 | +| 5.3.1.2.2 NF Service Consumers..... | 31 | +| 5.3.2 Service Operations..... | 32 | +| 5.3.2.1 Introduction..... | 32 | +| 5.3.2.2 Ntsctsf_QoSandTSCAssistance_Create..... | 32 | +| 5.3.2.2.1 General..... | 32 | +| 5.3.2.2.2 Initial provisioning of TSC related service information..... | 32 | +| 5.3.2.2.3 Subscriptions to Service Data Flow QoS notification control..... | 35 | +| 5.3.2.2.4 Subscription to Service Data Flow Deactivation..... | 36 | + +| | | | +|------------|-------------------------------------------------------------------------------------------------------------|----| +| 5.3.2.2.5 | Subscription to resources allocation outcome..... | 36 | +| 5.3.2.2.6 | Subscriptions to Service Data Flow QoS Monitoring Information..... | 36 | +| 5.3.2.2.7 | Initial provisioning of sponsored connectivity information..... | 37 | +| 5.3.2.3 | Ntsctsf_QoSandTSCAssistance_Update..... | 39 | +| 5.3.2.3.1 | General..... | 39 | +| 5.3.2.3.2 | Modification of TSC related service information..... | 39 | +| 5.3.2.3.3 | Modification of Subscription to Service Data Flow QoS notification control..... | 42 | +| 5.3.2.3.4 | Modification of Subscription to Service Data Flow Deactivation..... | 42 | +| 5.3.2.3.5 | Modification of subscription to resources allocation outcome..... | 42 | +| 5.3.2.3.6 | Modification of Subscription to Service Data Flow QoS Monitoring Information..... | 43 | +| 5.3.2.3.7 | Modification of sponsored connectivity information..... | 43 | +| 5.3.2.3.9 | Modification of Subscription to BAT offset notification..... | 44 | +| 5.3.2.4 | Ntsctsf_QoSandTSCAssistance_Delete..... | 44 | +| 5.3.2.4.1 | General..... | 44 | +| 5.3.2.4.2 | TSC AF application session context termination..... | 44 | +| 5.3.2.4.3 | Reporting usage for sponsored data connectivity..... | 45 | +| 5.3.2.5 | Ntsctsf_QoSandTSCAssistance_Notify..... | 46 | +| 5.3.2.5.1 | General..... | 46 | +| 5.3.2.5.2 | Notification about TSC application session context event..... | 46 | +| 5.2.2.5.3 | Notification about TSC application session context termination..... | 47 | +| 5.3.2.5.4 | Notification about Service Data Flow QoS notification control..... | 48 | +| 5.3.2.5.5 | Notification about Service Data Flow Deactivation..... | 49 | +| 5.3.2.5.6 | Notification about resources allocation outcome..... | 49 | +| 5.3.2.5.7 | Notification about Service Data Flow QoS Monitoring control..... | 49 | +| 5.3.2.5.8 | Reporting usage for sponsored data connectivity..... | 50 | +| 5.3.2.5.10 | Notification about BAT offset..... | 50 | +| 5.3.2.6 | Ntsctsf_QoSandTSCAssistance_Subscribe..... | 51 | +| 5.3.2.6.1 | General..... | 51 | +| 5.3.2.6.2 | Handling of subscription to events for the existing TSC application session context..... | 51 | +| 5.3.2.6.3 | Subscription to Service Data Flow QoS Monitoring Information..... | 53 | +| 5.3.2.6.4 | Subscription to Usage Monitoring of Sponsored Data Connectivity..... | 53 | +| 5.3.2.7 | Ntsctsf_QoSandTSCAssistance_Unsubscribe..... | 53 | +| 5.3.2.7.1 | General..... | 53 | +| 5.3.2.7.2 | Unsubscription to events..... | 54 | +| 5.4 | Ntsctsf_ASTI Service..... | 54 | +| 5.4.1 | Service Description..... | 54 | +| 5.4.1.1 | Overview..... | 54 | +| 5.4.1.2 | Network Functions..... | 55 | +| 5.4.1.2.1 | TSCTSF..... | 55 | +| 5.4.1.2.2 | NF Service Consumers..... | 55 | +| 5.4.2 | Service Operations..... | 55 | +| 5.4.2.1 | Introduction..... | 55 | +| 5.4.2.2 | Ntsctsf_ASTI_Create..... | 56 | +| 5.4.2.2.1 | General..... | 56 | +| 5.4.2.2.2 | Creating a new configuration..... | 56 | +| 5.4.2.3 | Ntsctsf_ASTI_Update..... | 58 | +| 5.4.2.3.1 | General..... | 58 | +| 5.4.2.3.2 | Updating an existing configuration..... | 59 | +| 5.4.2.4 | Ntsctsf_ASTI_Delete..... | 60 | +| 5.4.2.4.1 | General..... | 60 | +| 5.4.2.4.2 | Delete an existing configuration..... | 60 | +| 5.4.2.5 | Ntsctsf_ASTI_Get..... | 61 | +| 5.4.2.5.1 | General..... | 61 | +| 5.4.2.5.2 | Retrieve the status of access stratum time distribution..... | 61 | +| 5.4.2.6 | Ntsctsf_ASTI_UpdateNotify..... | 62 | +| 5.4.2.6.1 | General..... | 62 | +| 5.4.2.6.2 | Notification about the 5G access stratum time distribution events..... | 63 | +| 5.4.2.6.3 | Notification about ASTI configuration changes due to UE presence in time synchronization coverage area..... | 63 | +| 5.4.2.6.4 | Notification about the 5G access stratum time distribution status information..... | 64 | + +| | | | +|-------------|-----------------------------------------------------------------------|----| +| 6 | API Definitions..... | 64 | +| 6.1 | Ntsctsf_TimeSynchronization Service API..... | 64 | +| 6.1.1 | Introduction..... | 64 | +| 6.1.2 | Usage of HTTP..... | 65 | +| 6.1.2.1 | General..... | 65 | +| 6.1.2.2 | HTTP standard headers..... | 65 | +| 6.1.2.2.1 | General..... | 65 | +| 6.1.2.2.2 | Content type..... | 65 | +| 6.1.2.3 | HTTP custom headers..... | 65 | +| 6.1.3 | Resources..... | 65 | +| 6.1.3.1 | Overview..... | 65 | +| 6.1.3.2 | Resource: Time Synchronization Exposure Subscriptions..... | 67 | +| 6.1.3.2.1 | Description..... | 67 | +| 6.1.3.2.2 | Resource Definition..... | 67 | +| 6.1.3.2.3 | Resource Standard Methods..... | 67 | +| 6.1.3.2.3.1 | POST..... | 67 | +| 6.1.3.2.4 | Resource Custom Operations..... | 68 | +| 6.1.3.3 | Resource: Individual Time Synchronization Exposure Subscription..... | 68 | +| 6.1.3.3.1 | Description..... | 68 | +| 6.1.3.3.2 | Resource Definition..... | 68 | +| 6.1.3.3.3 | Resource Standard Methods..... | 68 | +| 6.1.3.3.3.1 | GET..... | 68 | +| 6.1.3.3.3.2 | DELETE..... | 69 | +| 6.1.3.3.3.3 | PUT..... | 70 | +| 6.1.3.3.4 | Resource Custom Operations..... | 71 | +| 6.1.3.4 | Resource: Time Synchronization Exposure Configurations..... | 72 | +| 6.1.3.4.1 | Description..... | 72 | +| 6.1.3.4.2 | Resource Definition..... | 72 | +| 6.1.3.4.3 | Resource Standard Methods..... | 72 | +| 6.1.3.4.3.1 | POST..... | 72 | +| 6.1.3.4.4 | Resource Custom Operations..... | 73 | +| 6.1.3.5 | Resource: Individual Time Synchronization Exposure Configuration..... | 74 | +| 6.1.3.5.1 | Description..... | 74 | +| 6.1.3.5.2 | Resource Definition..... | 74 | +| 6.1.3.5.3 | Resource Standard Methods..... | 74 | +| 6.1.3.5.3.1 | GET..... | 74 | +| 6.1.3.5.3.2 | PUT..... | 75 | +| 6.1.3.5.3.3 | DELETE..... | 76 | +| 6.1.3.5.4 | Resource Custom Operations..... | 78 | +| 6.1.4 | Custom Operations without associated resources..... | 78 | +| 6.1.5 | Notifications..... | 78 | +| 6.1.5.1 | General..... | 78 | +| 6.1.5.2 | Time Synchronization Capability Notification..... | 78 | +| 6.1.5.2.1 | Description..... | 78 | +| 6.1.5.2.2 | Target URI..... | 78 | +| 6.1.5.2.3 | Standard Methods..... | 78 | +| 6.1.5.3 | Time Synchronization Configuration Notification..... | 79 | +| 6.1.5.3.1 | Description..... | 79 | +| 6.1.5.3.2 | Target URI..... | 79 | +| 6.1.5.3.3 | Standard Methods..... | 80 | +| 6.1.5.3.3.1 | POST..... | 80 | +| 6.1.6 | Data Model..... | 80 | +| 6.1.6.1 | General..... | 80 | +| 6.1.6.2 | Structured data types..... | 83 | +| 6.1.6.2.1 | Introduction..... | 83 | +| 6.1.6.2.2 | Type: TimeSyncExposureSubsc..... | 84 | +| 6.1.6.2.3 | Type: TimeSyncExposureSubsNotif..... | 86 | +| 6.1.6.2.4 | Type: SubsEventNotification..... | 86 | +| 6.1.6.2.5 | Type: TimeSyncCapability..... | 87 | +| 6.1.6.2.6 | Type: PtpCapabilitiesPerUe..... | 87 | +| 6.1.6.2.7 | Type: TimeSyncExposureConfigNotif..... | 88 | + +| | | | +|---------------|-----------------------------------------------------------|-----| +| 6.1.6.2.8 | Type: StateOfConfiguration..... | 88 | +| 6.1.6.2.9 | Type: TimeSyncExposureConfig..... | 89 | +| 6.1.6.2.10 | Type: PtpInstance..... | 90 | +| 6.1.6.2.11 | Type: ConfigForPort..... | 91 | +| 6.1.6.2.12 | Type: StateOfDtt..... | 93 | +| 6.1.6.3 | Simple data types and enumerations..... | 93 | +| 6.1.6.3.1 | Introduction..... | 93 | +| 6.1.6.3.2 | Simple data types..... | 93 | +| 6.1.7 | Error Handling..... | 93 | +| 6.1.7.1 | General..... | 93 | +| 6.1.7.2 | Protocol Errors..... | 94 | +| 6.1.7.3 | Application Errors..... | 94 | +| 6.1.8 | Feature negotiation..... | 94 | +| 6.1.9 | Security..... | 94 | +| 6.2 | Ntsctsf_QoSandTSCAssistance Service API..... | 94 | +| 6.2.1 | Introduction..... | 94 | +| 6.2.2 | Usage of HTTP..... | 95 | +| 6.2.2.1 | General..... | 95 | +| 6.2.2.2 | HTTP standard headers..... | 95 | +| 6.2.2.2.1 | General..... | 95 | +| 6.2.2.2.2 | Content type..... | 95 | +| 6.2.2.3 | HTTP custom headers..... | 95 | +| 6.2.3 | Resources..... | 95 | +| 6.2.3.1 | Overview..... | 95 | +| 6.2.3.2 | Resource: TSC Application Sessions..... | 96 | +| 6.2.3.2.1 | Description..... | 96 | +| 6.2.3.2.2 | Resource Definition..... | 97 | +| 6.2.3.2.3 | Resource Standard Methods..... | 97 | +| 6.2.3.2.3.1 | POST..... | 97 | +| 6.2.3.2.4 | Resource Custom Operations..... | 98 | +| 6.2.3.3 | Resource: Individual TSC Application Session Context..... | 98 | +| 6.2.3.3.1 | Description..... | 98 | +| 6.2.3.3.2 | Resource Definition..... | 98 | +| 6.2.3.3.3 | Resource Standard Methods..... | 98 | +| 6.2.3.3.3.1 | GET..... | 98 | +| 6.2.3.3.3.2 | PATCH..... | 99 | +| 6.2.3.3.4 | Resource Custom Operations..... | 101 | +| 6.2.3.3.4.1 | Overview..... | 101 | +| 6.2.3.3.4.2 | Operation: delete..... | 101 | +| 6.2.3.3.4.2.1 | Description..... | 101 | +| 6.2.3.3.4.2.2 | Operation Definition..... | 101 | +| 6.2.3.4 | Resource: Events Subscription (Document)..... | 102 | +| 6.2.3.4.1 | Description..... | 102 | +| 6.2.3.4.2 | Resource Definition..... | 102 | +| 6.2.3.4.3 | Resource Standard Methods..... | 103 | +| 6.2.3.4.3.1 | PUT..... | 103 | +| 6.2.3.4.3.2 | DELETE..... | 104 | +| 6.2.3.4.4 | Resource Custom Operations..... | 105 | +| 6.2.4 | Custom Operations without associated resources..... | 105 | +| 6.2.5 | Notifications..... | 105 | +| 6.2.5.1 | General..... | 105 | +| 6.2.5.2 | Event Notification..... | 105 | +| 6.2.5.2.1 | Description..... | 105 | +| 6.2.5.2.2 | Target URI..... | 106 | +| 6.2.5.2.3 | Standard Methods..... | 106 | +| 6.2.5.2.3.1 | POST..... | 106 | +| 6.2.5.3 | Termination Request..... | 107 | +| 6.2.5.3.1 | Description..... | 107 | +| 6.2.5.3.2 | Target URI..... | 107 | +| 6.2.5.3.3 | Standard Methods..... | 107 | +| 6.2.5.3.3.1 | POST..... | 107 | + +| | | | +|---------------|---------------------------------------------------------------------------------|-----| +| 6.2.6 | Data Model..... | 108 | +| 6.2.6.1 | General..... | 108 | +| 6.2.6.2 | Structured data types..... | 111 | +| 6.2.6.2.1 | Introduction..... | 111 | +| 6.2.6.2.2 | Type TscAppSessionContextData..... | 112 | +| 6.2.6.2.3 | Type EventsSubscReqData..... | 114 | +| 6.2.6.2.4 | Type TscAppSessionContextUpdateData..... | 115 | +| 6.2.6.2.5 | Type EventsSubscReqDataRm..... | 115 | +| 6.2.6.2.6 | Type EventsNotification..... | 116 | +| 6.2.6.2.7 | Type EventNotification..... | 117 | +| 6.2.6.2.8 | Type AdditionalInfoTscsfQosTscac..... | 117 | +| 6.2.6.3 | Simple data types and enumerations..... | 118 | +| 6.2.6.3.1 | Introduction..... | 118 | +| 6.2.6.3.2 | Simple data types..... | 118 | +| 6.2.6.3.3 | Enumeration: TscEvent..... | 118 | +| 6.2.6.4 | Data types describing alternative data types or combinations of data types..... | 119 | +| 6.2.6.4.1 | Type: ProblemDetailsTscsfQosTscac..... | 119 | +| 6.2.7 | Error Handling..... | 119 | +| 6.2.7.1 | General..... | 119 | +| 6.2.7.2 | Protocol Errors..... | 119 | +| 6.2.7.3 | Application Errors..... | 119 | +| 6.2.8 | Feature negotiation..... | 120 | +| 6.2.9 | Security..... | 120 | +| 6.3 | Ntscsf_ ASTI Service API..... | 120 | +| 6.3.1 | Introduction..... | 120 | +| 6.3.2 | Usage of HTTP..... | 121 | +| 6.3.2.1 | General..... | 121 | +| 6.3.2.2 | HTTP standard headers..... | 121 | +| 6.3.2.2.1 | General..... | 121 | +| 6.3.2.2.2 | Content type..... | 121 | +| 6.3.2.3 | HTTP custom headers..... | 121 | +| 6.3.3 | Resources..... | 121 | +| 6.3.3.1 | Overview..... | 121 | +| 6.3.3.2 | Resource: ASTI Configurations..... | 122 | +| 6.3.3.2.1 | Description..... | 122 | +| 6.3.3.2.2 | Resource Definition..... | 122 | +| 6.3.3.2.3 | Resource Standard Methods..... | 123 | +| 6.3.3.2.3.1 | POST..... | 123 | +| 6.3.3.2.4 | Resource Custom Operations..... | 123 | +| 6.3.3.2.4.1 | Overview..... | 123 | +| 6.3.3.2.4.2 | Operation: retrieve..... | 124 | +| 6.3.3.2.4.2.1 | Description..... | 124 | +| 6.3.3.2.4.2.2 | Operation Definition..... | 124 | +| 6.3.3.3 | Resource: Individual ASTI Configuration..... | 124 | +| 6.3.3.3.1 | Description..... | 124 | +| 6.3.3.3.2 | Resource Definition..... | 124 | +| 6.3.3.3.3 | Resource Standard Methods..... | 124 | +| 6.3.3.3.2 | PUT..... | 124 | +| 6.3.3.3.3 | DELETE..... | 125 | +| 6.3.3.3.4 | Resource Custom Operations..... | 126 | +| 6.3.4 | Custom Operations without associated resources..... | 126 | +| 6.3.5 | Notifications..... | 127 | +| 6.3.5.1 | General..... | 127 | +| 6.3.5.2 | ASTI Notification..... | 127 | +| 6.3.5.2.1 | Description..... | 127 | +| 6.3.5.2.2 | Target URI..... | 127 | +| 6.3.5.2.3 | Standard Methods..... | 127 | +| 6.3.5.2.3.1 | POST..... | 127 | +| 6.3.6 | Data Model..... | 128 | +| 6.3.6.1 | General..... | 128 | +| 6.3.6.2 | Structured data types..... | 130 | + +| | | | +|-----------|-----------------------------------------|-----| +| 6.3.6.2.1 | Introduction..... | 130 | +| 6.3.6.2.2 | Type: AccessTimeDistributionData..... | 130 | +| 6.3.6.2.3 | Type: AsTimeDistributionParam..... | 131 | +| 6.3.6.2.4 | Type: StatusRequestData..... | 131 | +| 6.3.6.2.5 | Type: StatusResponseData..... | 132 | +| 6.3.6.2.6 | Type: ActiveUe..... | 132 | +| 6.3.6.2.7 | Type AstiConfigNotification..... | 132 | +| 6.3.6.2.8 | Type AstiConfigStateNotification..... | 133 | +| 6.3.6.3 | Simple data types and enumerations..... | 133 | +| 6.3.6.3.1 | Introduction..... | 133 | +| 6.3.6.3.2 | Simple data types..... | 133 | +| 6.3.6.3.3 | Enumeration: AstiEvent..... | 133 | +| 6.3.7 | Error Handling..... | 133 | +| 6.3.7.1 | General..... | 133 | +| 6.3.7.2 | Protocol Errors..... | 134 | +| 6.3.7.3 | Application Errors..... | 134 | +| 6.3.8 | Feature negotiation..... | 134 | +| 6.3.9 | Security..... | 134 | + +**Annex A (normative): OpenAPI specification..... 135** + +| | | | +|-----|--------------------------------------|-----| +| A.1 | General..... | 135 | +| A.2 | Ntscstf_TimeSynchronization API..... | 135 | +| A.3 | Ntscstf_QoSandTSCAssistance API..... | 146 | +| A.4 | Ntscstf_ASTI API..... | 157 | + +**Annex B (normative): 3GPP extensions for DetNet integration with 5GS..... 163** + +| | | | +|-------------|----------------------------------------------------------------------------|-----| +| B.1 | 3GPP extensions for DetNet integration with 5GS..... | 163 | +| B.1.1 | Introduction..... | 163 | +| B.1.2 | 3GPP Extension 3gpp-5gs-detnet-node..... | 164 | +| B.1.2.1 | Description..... | 164 | +| B.1.2.2 | Provisioning of 5GS specific traffic characteristics and requirements..... | 164 | +| B.1.2.3 | Report of 5GS DetNet flow(s) status..... | 165 | +| B.1.2.4 | Exposure of 5GS DetNet Node Identification..... | 165 | +| B.2 | YANG Module Definitions..... | 165 | +| B.2.1 | Introduction..... | 165 | +| B.2.1.1 | General..... | 165 | +| B.2.1.2 | Module name..... | 166 | +| B.2.1.3 | Header information..... | 166 | +| B.2.1.3.1 | ..... | 166 | +| B.2.1.3.2 | ..... | 166 | +| B.2.1.3.3 | ..... | 166 | +| B.2.1.4 | Meta-information..... | 166 | +| B.2.1.4.1 | ..... | 166 | +| B.2.1.4.2 | ..... | 167 | +| B.2.1.4.3 | ..... | 167 | +| B.2.1.4.4 | ..... | 167 | +| B.2.1.4.5 | ..... | 167 | +| B.2.1.2 | Formatting rules..... | 168 | +| B.2.2 | 3gpp-5gs-detnet-node Module definition..... | 169 | +| B.2.2.1 | Introduction..... | 169 | +| B.2.2.2 | Data Model..... | 169 | +| B.2.2.2.1 | General..... | 169 | +| B.2.2.2.2 | Structured data types..... | 169 | +| B.2.2.2.2.1 | Introduction..... | 169 | +| B.2.2.2.2.2 | Type: _3gpp-5gs-node-requirements..... | 169 | +| B.2.2.2.2.3 | Type: _3gpp-5gs-node-configuration-outcome..... | 170 | + +| | | | +|-------------------------------|-------------------------------------------------------|------------| +| B.2.2.2.2.4 | Type: _3gpp-5gs-node-identity..... | 170 | +| B.2.2.2.3 | Simple data types and enumerations..... | 171 | +| B.2.2.2.3.1 | Introduction..... | 171 | +| B.2.2.2.3.2 | Simple data types..... | 171 | +| B.2.2.2.3.3 | Enumeration: _3gpp-5gs-node-configuration-status..... | 171 | +| Annex C (normative): | YANG module specification..... | 172 | +| C.1 | General..... | 172 | +| C.2 | YANG module _3gpp-5gs-detnet-node..... | 172 | +| Annex D (informative): | Change history..... | 175 | + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +--- + +## 1 Scope + +The present document specifies the stage 3 protocol and data model for the Ntsctsf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the TSCTSF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [19]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +--- + +## 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "HTTP/2". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] 3GPP TS 29.534: "5G System; Access and Mobility Policy Authorization Service; Stage 3". + +- [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [16] 3GPP TS 29.508: "5G System; Session Management Event Exposure Service; Stage 3". +- [17] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [18] IEEE Std 802.1Q-2018: "IEEE Standard for Local and metropolitan area networks--Bridges and Bridged Networks". +- [19] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System". +- [20] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [21] 3GPP TS 29.122: "T8 reference point for northbound Application Programming Interfaces (APIs)". +- [22] IETF RFC 7396: "JSON Merge Patch". +- [23] 3GPP TS 29.521: "5G System; Binding Support Management Service; Stage 3". +- [24] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [25] IEEE Std 1588-2019: "IEEE Standard for a Precision Clock Synchronization Protocol for Networked Measurement and Control". +- [26] IEEE Std 802.1AS-2020: "IEEE Standard for Local and metropolitan area networks--Timing and Synchronization for Time-Sensitive Applications". +- [27] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". +- [28] IETF draft-ietf-detnet-yang: "Deterministic Networking (DetNet) YANG Model". + +**Editor's note:** The above document cannot be formally referenced until it is published as an RFC. + +- [29] IETF RFC 6241: "Network Configuration Protocol (NETCONF)". +- [30] IETF RFC 8040: "RESTCONF Protocol". +- [31] 3GPP TS 29.513: "5G System; Policy and Charging Control signalling flows and QoS parameter mapping; Stage 3". +- [32] IETF RFC 8939: "Deterministic Networking (DetNet) Data Plane: IP". +- [33] IETF RFC 7950: "The YANG 1.1 Data Modeling Language". +- [34] IETF RFC 8407: "Guidelines for Authors and Reviewers of Documents Containing YANG Data Models". +- [35] IETF RFC 6020: "YANG – A Data Modeling Language for the Network Configuration Protocol (NETCONF)". + +--- + +## 3 Definitions, symbols and abbreviations + +### 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +Void + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +Void + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|--------|----------------------------------------------------------------| +| ASTI | Access Stratum Time distribution | +| BAT | Burst Arrival Time | +| DetNet | Deterministic Networking | +| DS-TT | Device-side TSN translator | +| NW-TT | Network-side TSN translator | +| PTP | Precision Time Protocol | +| TA | Tracking Area | +| TSC | Time Sensitive Communication | +| TSCAI | TSC Assistance Information | +| TSCTSF | Time Sensitive Communication and Time Synchronization function | + +--- + +## 4 Overview + +### 4.1 Introduction + +The Ntscsf services are offered by the TSCTSF to support the Time Sensitive Communications and Time Synchronization. + +The following Ntscsf services are specified: + +- Ntscsf\_TimeSynchronization service; +- Ntscsf\_QoSandTSCAssistance service. +- Ntscsf\_ASTI service. + +To enable the reporting of 5GS DetNet node configuration and the provisioning and configuration data for DetNet flows, the TSCTSF offers RESTCONF (IETF RFC 8040 [30]) and/or NETCONF (IETF RFC 6241 [29]) interfaces to the DetNet controller to access the 3GPP extended Deterministic Networking (DetNet) YANG Model as specified in Annex B. + +### 4.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. + +The known NF service consumers of the Ntscsf services are the Application Function (AF) within the operator's trust domain and the Network Exposure Function (NEF). + +The Ntscsf services are provided by the TSCTSF and consumed by the NF service consumers (e.g. AF, NEF), as shown in figure 4.2-1 for the SBI representation model and in figure 4.2-2 for the reference point representation model. + +![Ntsctsf services architecture, SBI representation diagram showing TSCTSF (Ntsctsf) connected to a Service Based Interface (SBI) which is accessed by NEF and AF.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` + +graph TD + TSCTSF[TSCTSF +Ntsctsf] --- SBI(( )) + NEF[NEF] --- SBI + AF[AF] --- SBI + +``` + +Ntsctsf services architecture, SBI representation diagram showing TSCTSF (Ntsctsf) connected to a Service Based Interface (SBI) which is accessed by NEF and AF. + +Figure 4.2-1: Ntsctsf services architecture, SBI representation + +![Ntsctsf services architecture, reference point representation diagram showing TSCTSF connected to NEF via N85 reference point and to AF via N86 reference point.](a26e142d3df5bef41a84a9dd099d7825_img.jpg) + +``` + +graph TD + TSCTSF[TSCTSF] ---|N85| NEF[NEF] + TSCTSF ---|N86| AF[AF] + +``` + +Ntsctsf services architecture, reference point representation diagram showing TSCTSF connected to NEF via N85 reference point and to AF via N86 reference point. + +Figure 4.2-2: Ntsctsf services architecture, reference point representation + +The DetNet controller, as specified in clause 4.4.8.4 of 3GPP TS 23.501 [2], is the TSCTSF's consumer that accesses the 3GPP extended DetNet YANG model, as specified in Annex B, clause B.1.1. + +## 5 Services offered by the TSCTSF + +### 5.1 Introduction + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +Table 5.1-1: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|-----------------------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|-------------------|-------| +| Ntsctsf_TimeSynchronization | 6.1 | Provides the support to subscribe/unsubscribe to the notification about time synchronization capabilities or changes in time synchronization status information. Also allows to activate and | TS29565_Ntsctsf_TimeSynchronization.yaml | ntsctsf-time-sync | A.2 | + +| | | | | | | +|-----------------------------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|-------------------|-----| +| | | deactivate the time synchronization configuration. | | | | +| Ntsctsf_QoSandTSCAssistance | 6.2 | Provides the support to request specific QoS and provide assistance for handling traffic characterized by TSC QoS parameters. | TS29565_Ntsctsf_QoSandTSCAssistance.yaml | ntsctsf-qos-tscai | A.3 | +| Ntsctsf_ASTI | 6.3 | Provides support for time synchronization service based on 5G access stratum time distribution method. Allows the NF consumer to configure the 5GC and RAN for 5G access stratum based time synchronization service for the UEs and subscribe to get informed about changes in time synchronization status information. | TS29565_Ntsctsf_ASTI.yaml | ntsctsf-asti | A.4 | + +## 5.2 Ntsctsf\_TimeSynchronization Service + +### 5.2.1 Service Description + +#### 5.2.1.1 Overview + +This service provides: + +- Authorization of NF Service Consumer requests for the subscription to the notification of the capability of time synchronization service. +- Authorization of NF Service Consumer requests to create and update time synchronization configuration, and to activate and deactivate the time synchronization service as described in clause 5.27.1.8 of TS 23.501 [2]. + +NOTE: The AF can use either the procedure specified in bullet2) for configuring the (g)PTP instance in 5GS or the procedure specified in clause 5.4.2.2 for controlling the 5G access stratum time distribution for a particular UE. The procedures are not intended to be used in conjunction with each other by the AF. However, the (g)PTP instance activation, modification, and deactivation can influence the 5G access stratum time distribution for the UEs that are part of the impacted PTP instance. + +- Detection and reporting of time synchronization service status based on gNB and/or UPF/NW-TT timing synchronization status information and reporting status updates. +- Notifications to the NF service consumer about the state and changes of state of time synchronization configuration due to evaluation of e.g. time synchronization coverage area conditions. + +## 5.2.1.2 Network Functions + +### 5.2.1.2.1 TSCTSF + +The TSCTSF supports to: + +- receive the request to create/update the subscription to the notification of the capability of time synchronization service from the NEF or AF and interact with the related PCF; +- receive the request to delete the subscription to the notification of the capability of time synchronization service from the NEF or AF and remove the information from the related PCF; +- receive the notification of the availability of the user plane node information from the PCF and subscribe the notification of user plane node related events at the PCF; +- makes a translation from External/Internal Group Identifier to a list of SUPI by querying UDM; +- retrieve the Time Synchronization Subscription data from UDM for the control of (g)PTP instance(s) and make decision based on received the Time Synchronization Subscription data; +- determine the capability of time synchronization service based on the capability information received from the DS-TT(s) and NW-TT and notify the NEF or AF of the capability; +- receive the request to create or modify the time synchronization configuration from the NEF or AF, configure and initialize the PTP instance(s) by constructing a PMIC to each DS-TT/UE to activate the time synchronization service in DS-TT and PMIC(s) and UMIC to NW-TT to activate the time synchronization service in NW-TT and provision them to the PCF; +- determine whether the UE is inside/outside the requested time synchronization coverage area and enforce the time synchronization service accordingly; +- notify the NEF or AF of the current state of the time synchronization service configuration; +- receive the request of time synchronization deactivation from the NEF or AF and disable the corresponding PTP instance(s) in the DS-TT(s) and NW-TT. +- indicate whether the service is supported or not as per the requested acceptance criteria (e.g., based on the known timing synchronization status attribute thresholds pre-configured at gNB); and +- based on gNB and/or UPF/NW-TT timing synchronization status (degradation/failure/improvement) information and reporting, provide a notification when there is a service status update if the NEF or AF subscribe to service status updates. + +### 5.2.1.2.2 NF Service Consumers + +The NF service consumer supports to: + +- send the request to create/update and delete the subscription to the notification of the capability of time synchronization service to TSCTSF; +- receive the notification of the capability of time synchronization service; +- send the request to create, modify and delete the time synchronization configuration to the TSCTSF; +- provide clock quality reporting control information, consisting of clock quality detail level and clock quality acceptance criteria during activation or modification of time synchronization service; and +- subscribe to time synchronization service status for the target UE(s). + +## 5.2.2 Service Operations + +### 5.2.2.1 Introduction + +Service operations defined for the Ntsctsf\_TimeSynchronization service are shown in table 5.2.2.1-1. + +**Table 5.2.2.1-1: Ntsctsf\_TimeSynchronization Service Operations** + +| Service Operation Name | Description | Initiated by | +|------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| +| Ntsctsf_TimeSynchronization_CapsSubscribe | Allows the NF service consumer to create or modify a subscription to the notification about the capability of time synchronization service for a list of UEs a group of UEs or any UE using a DNN/S-NSSAI combination. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_TimeSynchronization_CapsUnsubscribe | Allows the NF service consumer to delete the subscription to the notification about capability of time synchronization service for a list of UEs, a group of UEs or any UE using a DNN/S-NSSAI combination. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_TimeSynchronization_CapsNotify | Allows the TSCTSF to notify the NF service consumer of the capability of time synchronization service. | TSCTSF | +| Ntsctsf_TimeSynchronization_ConfigCreate | Allows the NF service consumer to create a time synchronization configuration. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_TimeSynchronization_ConfigUpdate | Allows the NF service consumers to update the time synchronization configuration. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_TimeSynchronization_ConfigDelete | Allows the NF service consumer to delete the time synchronization configuration. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_TimeSynchronization_ConfigUpdateNotify | Allows the TSCTSF to notify the NF service consumer of the state of time synchronization configuration. | TSCTSF | + +NOTE: The NEF and the AF use the Ntsctsf\_TimeSynchronization service in the same way. + +## 5.2.2.2 Ntsctsf\_TimeSynchronization\_CapsSubscribe + +### 5.2.2.2.1 General + +This service operation is used by an NF service consumer to subscribe to notification of capability of time synchronization service for a list of UEs, a group of UEs or any UE using a DNN/S-NSSAI combination. + +The following procedures using the Ntsctsf\_TimeSynchronization\_CapsSubscribe service operation are supported: + +- creating a new subscription; +- modifying an existing subscription. + +### 5.2.2.2.2 Creating a new subscription + +Figure 5.2.2.2.2-1 illustrates the creation of a subscription. + +![Sequence diagram illustrating the creation of a subscription. An NF service consumer sends a POST request to the TSCTSF, and the TSCTSF responds with a 201 Created status.](6f659142d4789aa889184459f884787e_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. POST ... /subscriptions + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2. "201 Created" + TSCTSF-->>NF service consumer: Response + +``` + +Sequence diagram illustrating the creation of a subscription. An NF service consumer sends a POST request to the TSCTSF, and the TSCTSF responds with a 201 Created status. + +**Figure 5.2.2.2.2-1: Creation of a subscription** + +To subscribe the notification of the capability of time synchronization service, the NF service consumer shall send an HTTP POST message to the TSCTSF to the URI "{apiRoot}/ntsctsf-time-sync//subscriptions". The HTTP POST message shall include the TimeSyncExposureSubsc data structure as request body. The TimeSyncExposureSubsc data structure shall include: + +- the indication of the UEs to which the time synchronization capabilities is requested via: + - identification of a list of individual UEs within a "supis" attribute; + - identification of a list of individual UEs within a "gpsi" attribute; + - indication of any UE within the "anyUeInd" attribute; or + - identification of a group of UE(s) within the "interGroupId" attribute; or + - identification of a group of UE(s) within the "exterGroupId" attribute. +- subscription to event(s) notification as "subscribedEvents" attribute; +- notification URI within the "subsNotifUri" attribute; +- notification correlation Id within the "subsNotifId" attribute; +- DNN with the "dnn" attribute; and +- S-NSSAI with the "snssai" attribute; + +and may include: + +- the conditions to match for notifying the event within the "eventFilters" attribute; +- notification method within the "notifMethod" attribute +- maximum number of reports within the "maxReportNbr" attribute; +- expiry time within the "expiry" attribute; and +- report period within the "repPeriod" attribute. + +Upon receipt of the HTTP request from the NF service consumer, if the request is authorized, the TSCTSF shall: + +- create a new subscription; +- assign a subscription correlation ID; +- select an expiry time that is equal to or less than the expiry time potentially received in the request; +- store the subscription; +- if the "interGroupId" attribute or "exterGroupId" attribute is received from the NF service consumer, interact with the UDM to retrieve the SUPI list that belong to the group using the Nudm\_SDM service as defined in 3GPP TS 29.503 [24]; +- if the "gpsi" attribute is received from the NF service consumer, interact with the UDM to retrieve the SUPI(s) that correspond to the GPSI(s) using the Nudm\_SDM service as defined in 3GPP TS 29.503 [24]; +- use the parameters received from the NF service consumer (i.e. DNN, S-NSSAI and, if available, the list of UEs or UEs that belong to the group of UEs) and the time synchronization subscription data retrieved from UDM to determine the matching AF-session(s) that are authorized by subscription, and for any such AF-session for which the SUPI interact with the PCF by triggering Npcf\_PolicyAuthorization\_Create/Update request message as defined in 3GPP TS 29.514 [20]. + +NOTE 1: If the PCF determines an existing PDU Session is potentially impacted by time synchronization service (based on local configuration or SM Policy Association), the PCF invokes Npcf\_PolicyAuthorization\_Notify service operation to the TSCTSF as defined in clause 4.2.5.16 of 3GPP TS 29.514 [20] to send the received TSC User Plane Node information. At that time, the TSCTSF retrieves from the BSF the PCF binding information (including the UE Identities as SUPI and if available, GPSI for the notified PDU session), as specified in 3GPP TS 29.521 [23], and can create the AF-session by sending to the PCF the Npcf\_PolicyAuthorization\_Create service operation. + +- send an HTTP "201 Created" response with TimeSyncExposureSubsc data structure as response body and a Location header field containing the URI of the created individual subscription resource, i.e. "{apiRoot}/ntsctsf-time-sync//subscriptions/{subscriptionId}" + +The TSCTSF shall handle the AF session(s) associated with the "Individual Time Synchronization Exposure Subscription" resource as follows: + +- For the association of AF sessions to "Individual Time Synchronization Exposure Subscription" resources: + - Upon PDU Session establishment, i.e. when the TSCTSF receives the Npcf\_PolicyAuthorization\_Notify service operation for the establishment of a new PDU session, the TSCTSF shall retrieve from the BSF, as specified in 3GPP TS 29.521 [23], the PCF binding information to complete the necessary AF-Session information and triggers the Npcf\_PolicyAuthorization\_Create request message to the PCF to create an AF-session to subscribe to TSC user plane node related events. The TSCTSF, shall use the parameters of existing "Individual Time Synchronization Exposure Subscription" resources to determine whether they shall be associated to this newly created AF session. The TSCTSF associates the new AF session to the "Individual Time Synchronization Exposure Subscription" resources for which these parameters match. The TSCTSF shall read time synchronization capabilities from the DS-TT and NW-TT, if not available in the AF session, from the PCF by triggering Npcf\_PolicyAuthorization\_Update request message as defined in 3GPP TS 29.514 [20] and determine the (g)PTP capabilities from the DS-TT and the NW-TT as described in clause K.2.1 of 3GPP TS 23.501 [2]. The TSCTSF shall update the time synchronization service capability for this new DS-TT as defined in clause 5.2.2.4.2. + - Upon AF sessions establishment, i.e. when the TSCTSF receives the AF request for the time synchronization service, the TSCTSF shall retrieve Time Synchronization Subscription data from UDM. The TSCTSF, shall use the parameters of existing "Individual Time Synchronization Exposure Subscription" resources to determine whether they shall be associated to this newly created AF session. The TSCTSF associates the new AF session to the "Individual Time Synchronization Exposure Subscription" resources for which these parameters match if the AF-session (i.e., the SUPI) is authorized by UDM subscription, otherwise the AF-session is excluded. + - Upon "Individual Time Synchronization Exposure Subscription" resource creation, the TSCTSF uses the parameters of the created resource to determine which existing and authorized AF sessions it matches. The TSCTSF associates the new "Individual Time Synchronization Exposure Subscription" resource to the authorized AF sessions for which these parameters match. + - To remove an AF session from the associated ones to the "Individual Time Synchronization Exposure Subscription" resource, when the TSCTSF receives the Npcf\_PolicyAuthorization\_Notify service operation indicating the termination of an existing PDU session, the TSCTSF triggers the Npcf\_PolicyAuthorization\_Delete request message to the PCF and determines if the corresponding AF session is associated with the "Individual Time Synchronization Exposure Subscription" resource. If it is so, the TSCTSF shall remove the AF session from the list of AF session(s) associated with the "Individual Time Synchronization Exposure Subscription" resource. The TSCTSF shall update the time synchronization service capability for this removed DS-TT as defined in clause 5.2.2.4.2. + +NOTE 2: After the TSCTSF retrieves from the BSF the PCF binding information (including the UE Identities for the notified PDU session), as specified in 3GPP TS 29.521 [23], the TSCTSF can store internally the information required to invoke Npcf\_PolicyAuthorization\_Create service operation and delay the Npcf\_PolicyAuthorization\_Create service operation (the creation of the AF session) till the subscription to notification of the capability of time synchronization service is received for the concerned UE. In this case, when the TSCTSF receives the subscription request, the TSCTSF interacts with the PCF by triggering Npcf\_PolicyAuthorization\_Create message as defined in 3GPP TS 29.514 [20]. + +NOTE 3: When the TSCTSF receives the Npcf\_PolicyAuthorization\_Notify service operation indicating the termination of an existing PDU session associated to an AF session that it is not associated with any "Individual Time Synchronization Exposure Subscription" resource, the TSCTSF removes the AF-session and triggers the Npcf\_PolicyAuthorization\_Delete request message to the PCF. + +If the TSCTSF cannot successfully fulfil the received HTTP POST request due to the internal TSCTSF error or due to the error in the HTTP POST request, the TSCTSF shall send the HTTP error response as specified in clause 6.1.7. + +#### 5.2.2.2.3 Modifying an existing subscription + +Figure 5.2.2.2.3-1 illustrates the modification of a subscription. + +![Sequence diagram showing the modification of a subscription. An NF service consumer sends a PUT request to the TSCTSF. The TSCTSF responds with either a 200 OK or a 204 No Content.](e636d7ccca0ad14c6b95201404324823_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. PUT « /subscriptions/{subscriptionId} » + NF service consumer->>TSCTSF: Request + Note right of TSCTSF: 2a. "200 OK" +2b. "204 No Content" + TSCTSF-->>NF service consumer: Response + +``` + +Sequence diagram showing the modification of a subscription. An NF service consumer sends a PUT request to the TSCTSF. The TSCTSF responds with either a 200 OK or a 204 No Content. + +Figure 5.2.2.2.3-1: Modification of a subscription + +To modify the subscription to the notification of the capability of time synchronization service, the NF service consumer shall send an HTTP PUT message to the TSCTSF to the URI "{apiRoot}/ntcsetf-time-sync//subscriptions/{subscriptionId}" representing an existing "Individual Time Synchronization Exposure Subscription" resource, as shown in figure 5.2.2.2.3-1, step 1. The HTTP PUT message shall include the TimeSyncExposureSubsc data structure as request body. The TimeSyncExposureSubsc data structure shall include the parameters as defined in clause 5.2.2.2.2. + +Upon receipt of the HTTP request from the NF service consumer, if the request is authorized, the TSCTSF shall: + +- update the existing "Individual Time Synchronization Exposure Subscription" resource; +- identify the affected AF session(s) based on the parameters received from the NF service consumer and interact with the PCF by triggering Npcf\_PolicyAuthorization\_Update request message as defined in 3GPP TS 29.514 [20] for the new added UE(s), by triggering Npcf\_PolicyAuthorization\_Delete request message as defined in 3GPP TS 29.514 [20] for the removed UE(s) or by triggering Npcf\_PolicyAuthorization\_Update request message as defined in 3GPP TS 29.514 [20] for the existing UE(s) if necessary. + +NOTE 1: If the PCF determines an existing PDU Session is potentially impacted by time synchronization service (based on local configuration or SM Policy Association), the PCF invokes Npcf\_PolicyAuthorization\_Notify service operation to the TSCTSF as defined in clause 4.2.5.16 of 3GPP TS 29.514 [20] to send the received TSC User Plane Node information. At that time, the TSCTSF retrieves from the BSF the PCF binding information (including the UE Identities as SUPI and if available, GPSI for the notified PDU session), as specified in 3GPP TS 29.521 [23], and can create the AF-session by sending to the PCF the Npcf\_PolicyAuthorization\_Create service operation. + +NOTE 2: After the TSCTSF retrieves from the BSF the PCF binding information (including the UE Identities for the notified PDU session), as specified in 3GPP TS 29.521 [23], the TSCTSF can store internally the information required to invoke Npcf\_PolicyAuthorization\_Create service operation and delay the Npcf\_PolicyAuthorization\_Create service operation (the creation of the AF-session) till the subscription to notification of the capability of time synchronization service is received for the concerned UE. In this case, when the TSCTSF receives the subscription request, the TSCTSF interacts with the PCF by triggering Npcf\_PolicyAuthorization\_Create message as defined in 3GPP TS 29.514 [20]. + +- update the list of AF sessions that are associated to the "Individual Time Synchronization Exposure Subscription" resource (i.e. add or remove AF sessions as associated to this resource) based on if the parameters of the AF sessions match the updated parameters of the "Individual Time Synchronization Exposure Subscription" resource. +- send a HTTP response including "200 OK" status code with TimeSyncExposureSubsc data structure or "204 No Content" status code, as shown in figure 5.2.2.2.3-1, step 2. + +If the HTTP PUT request from the NF service consumer is not accepted, the TSCTSF shall indicate in the response to HTTP PUT request the cause for the rejection as specified in clause 6.1.7. + +If the TSCTSF determines the received HTTP PUT request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +### 5.2.2.3 Ntsctsf\_TimeSynchronization\_CapsUnsubscribe + +#### 5.2.2.3.1 General + +This service operation is used by an NF service consumer to unsubscribe from the notifications. + +The following procedure using the Ntsctsf\_TimeSynchronization\_CapsUnsubscribe service operation is supported: + +- unsubscribe from capability notifications. + +#### 5.2.2.3.2 Unsubscription from capability notifications + +Figure 5.2.2.3.2-1 illustrates the unsubscription from event notifications. + +![Sequence diagram showing the unsubscription process from capability notifications between an NF service consumer and a TSCTSF.](c0e369274e53b2e5364666be6f786c7a_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. DELETE « /subscriptions/{subscriptionId} » + NF service consumer->>TSCTSF: Request + Note right of TSCTSF: 2. "204 No Content" + TSCTSF-->>NF service consumer: Response +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and a TSCTSF. The first message, labeled '1. DELETE « /subscriptions/{subscriptionId} »', is sent from the NF service consumer to the TSCTSF. The second message, labeled '2. "204 No Content"', is sent from the TSCTSF back to the NF service consumer. + +Sequence diagram showing the unsubscription process from capability notifications between an NF service consumer and a TSCTSF. + +**Figure 5.2.2.3.2-1: Unsubscription from capability notifications** + +To unsubscribe from event notifications, the NF service consumer shall send an HTTP DELETE request with: "{apiRoot}/ntsctsf-time-sync//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the subscription correlation ID of the existing subscription that is to be deleted. + +Upon the reception of the HTTP DELETE request, if the received HTTP request is successfully processed and accepted, the TSCTSF shall: + +- remove the corresponding subscription; +- identify the affected AF session(s) and, for each AF session, interact with the PCF by triggering Npcf\_PolicyAuthorization\_Delete request message as defined in 3GPP TS 29.514 [20]; and +- send an HTTP "204 No Content" response. + +If the HTTP DELETE request from the NF service consumer is not accepted, the TSCTSF shall indicate in the response to HTTP DELETE request the cause for the rejection as specified in clause 6.1.7. + +If the TSCTSF determines the received HTTP DELETE request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +#### 5.2.2.4 Ntsctsf\_TimeSynchronization\_CapsNotify + +##### 5.2.2.4.1 General + +This service operation is used by the TSCTSF to send notifications to NF service consumers upon the detection of the capability of the time synchronization service for a list of UEs. + +The following procedure using the Ntsctsf\_TimeSynchronization\_CapsNotify service operation is supported: + +- notification about the capability of time synchronization service. + +##### 5.2.2.4.2 Notification about the capability of time synchronization service + +Figure 5.2.2.4.2-1 illustrates the notification about the capability of time synchronization service. + +![Sequence diagram showing the notification about the capability of time synchronization service. The diagram involves two participants: TSCTSF and NF service consumer. The sequence of messages is: 1. POST {subsNotifUri} from NF service consumer to TSCTSF, and 2. '204 No Content' response from TSCTSF to NF service consumer.](2834bdd6eb8540277e609decbb924003_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. POST {subsNotifUri} + NF service consumer->>TSCTSF: 1. POST {subsNotifUri} + Note left of TSCTSF: 2. "204 No Content" + TSCTSF-->>NF service consumer: 2. "204 No Content" + +``` + +Sequence diagram showing the notification about the capability of time synchronization service. The diagram involves two participants: TSCTSF and NF service consumer. The sequence of messages is: 1. POST {subsNotifUri} from NF service consumer to TSCTSF, and 2. '204 No Content' response from TSCTSF to NF service consumer. + +**Figure 5.2.2.4.2-1: Notification about the capability of time synchronization service** + +The TSCTSF maintains the association between the AF session(s) and the Individual Time Synchronization Exposure Subscription resource as defined in clause 5.2.2.2.2 and detects the capability of time synchronization service (for a list of UEs, a group of UEs or any UE in a DNN and S-NSSAI), by composing the time synchronization capabilities for the DS-TT/UE(s) connected to the NW-TT based on the capability information received from the DS-TT(s) and NW-TT via the PCF. If the NF service consumer includes an Event Filter with one or more of the requested PTP instance type, requested transport protocol for PTP, or requested PTP Profile, the TSCTSF considers only the DS-TT(s) and NW-TT(s) with these capabilities as part of the time synchronization capability set that is reported to the NF service consumer. If necessary, when the list of AF session(s) associated to the Individual Time Synchronization Exposure Subscription resource changes, e.g. upon PDU Session establishment or termination, the TSCTSF may notify the update of the capability of time synchronization service for the DS-TT/UE(s) connected to the NW-TT(s). In order to send the capability of time synchronization service to the NF service consumer, the TSCTSF shall send an HTTP POST request with "{subsNotifUri}", as previously provided by the NF service consumer within the corresponding subscription, as request URI and TimeSyncExposureSubsNotif data structure as request body that shall include: + +- Notification correlation ID provided by the NF service consumer during the subscription within "subsNotifId" attribute; and +- information about the observed event(s) within the "eventNotifs" attribute that shall contain for each observed event an "SubsEventNotification" data structure that shall include: + 1. the detected event within the "event" attribute; + 2. when the event is "AVAILABILITY\_FOR\_TIME\_SYNC\_SERVICE", the capabilities of time synchronization service for one or more user plane nodes with the "timeSyncCapas" attribute. Within each instance of TimeSyncCapability data structure, the TSCTSF shall include the identifier of the applicable NW-TT within the "upNodeId" attribute, the "gmCapables" attribute indicating if the user plane node supports acting as a gPTP and/or PTP grandmaster, the supported 5G clock quality within the "asTimeRes" + +attribute, if applicable, and the PTP capabilities for each UE within the "ptpCapForUes" attribute, when the UEs are identified with a SUPI, or within "ptpCapForGpsi" attribute, when the UEs are identified with a GPSI. + +Upon the reception of an HTTP POST, the NF service consumer shall send an HTTP "204 No Content" response for a successful processing. + +If the HTTP POST request from the TSCTSF is not accepted, the NF service consumer shall indicate in the response to HTTP POST request the cause for the rejection as specified in clause 6.1.7. + +If the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +## 5.2.2.5 Ntsctsf\_TimeSynchronization\_ConfigCreate + +### 5.2.2.5.1 General + +This service operation is used by an NF service consumer to create a time synchronization configuration and activate the time synchronization service with the configuration. + +The following procedures using the Ntsctsf\_TimeSynchronization\_ConfigCreate service operation are supported: + +- creating a new configuration; and +- creating a subscription for notification for the changes in the time synchronization service configuration. + +### 5.2.2.5.2 Creating a new configuration + +Figure 5.2.2.5.2-1 illustrates the creation of a configuration. + +![Sequence diagram showing the creation of a configuration. The NF service consumer sends a POST request to the TSCTSF, and the TSCTSF responds with a 201 Created status.](414cf5c0e2959c558de57a9fb5c2134a_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. POST « /subscriptions/{subscriptionId}/configurations » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2. "201 Created" + TSCTSF-->>NF service consumer: Response +``` + +Sequence diagram showing the creation of a configuration. The NF service consumer sends a POST request to the TSCTSF, and the TSCTSF responds with a 201 Created status. + +**Figure 5.2.2.5.2-1: Creation of a configuration** + +To create a configuration, the NF service consumer shall send an HTTP POST message to the TSCTSF to the URI "{apiRoot}/ntsctsf-time-sync//subscriptions/{subscriptionId}/configurations". The HTTP POST message shall include the TimeSyncExposureConfig data structure as request body, as shown in figure 5.2.2.5.2-1, step 1. The TimeSyncExposureConfig data structure shall include: + +- the user plane node Id within the "upNodeId" attribute; +- the requested PTP instance within the "reqPtpIns" attribute; +- the time domain within the "timeDom" attribute; +- the notification URI within the "configNotifUri" attribute; +- the notification correlation Id within the "configNotifId" attribute; + +and may include: + +- the "gmEnable" attribute set to true if the AF requests 5GS to act as a grandmaster for PTP or gPTP; +- the time synchronization error budget within the "timeSyncErrBdgt" attribute; +- the grandmaster priority with the "gmPrio" attribute; +- the temporal validity condition within the "tempValidity" attribute; +- if the "CoverageAreaSupport" feature is supported, the time synchronization coverage area encoded as "covReq" attribute, that contains a list of Tracking Area codes per serving network where the requested PTP instance applies; and +- if the "NetTimeSyncStatus" feature is supported, the clock quality detail level in the "clkQltDetLvl" attribute and the clock quality acceptance criteria for the PTP instance in the "clkQltAcptCri" attribute if applicable, if the NF service consumer to subscribe to receiving network time synchronization status report(s). + +NOTE 1: The AF request for PTP service activation, modification cannot indicate that the clock quality detail level to provide is "metrics", i.e. if the AF includes the clock quality detail level, its value needs to set to "acceptable/not acceptable indication" and accompanied with "clock quality acceptance criteria". The UE/DS-TT retrieves detailed information (timing synchronization metrics) from Announce messages sent for (g)PTP services. + +Upon receipt of the HTTP request from the NF service consumer, if the request is authorized, the TSCTSF shall: + +- create a new resource, which represents a new "Individual Time Synchronization Exposure Configuration" instance, addressed by a URI as defined in clause 6.1.3.5 and containing a TSCTSF created resource identifier; +- send an HTTP "201 Created" response with TimeSyncExposureConfig data structure as response body and a Location header field containing the URI of the created Individual Time Synchronization Exposure Configuration resource, i.e. "{apiRoot}/ntsctsf-time-sync/{apiVersion}/subscriptions/{subscriptionId}/configuration/{configurationId}", as shown in figure 5.2.2.5.2-1, step 2; +- use the {subscriptionId} within the requested URI and user plane node ID within the "upNodeId" attribute in the request to determine the target UEs and corresponding authorized AF sessions, then use the parameters (e.g. requested PTP instance type, transport protocol, and PTP profile) in the request to determine suitable DS-TT(s) and AF session(s) among all the AF session(s) and: + - if the "CoverageAreaSupport" feature is supported and a time synchronization coverage area is provided within the "covReq" attribute, the TSCTSF perform the following operations: + 1. if the UE's Time Synchronization Subscription data from the UDM contains the list of TA(s) that comprise the authorized time synchronization coverage area. If the requested time synchronization coverage area within the "covReq" attribute is within the subscribed time synchronization coverage area, the TSCTSF determines that the time synchronization coverage area is fulfilled, and the UE is authorized for the requested time synchronization service. If the Authorized Time Synchronization Coverage Area is inside of the requested Coverage Area, the TSCTSF uses the Authorized Time Synchronization Coverage Area. If the requested Coverage Area partly overlaps with the Authorized Time Synchronization Coverage Area, the TSCTSF uses the intersection of them. If there is no overlap between them, the TSCTSF shall reject the AF request as described in clause 5.27.1.11 of 3GPP TS 23.501 [2]. + 2. The TSCTSF discovers the list of AMF(s) serving the list of TA(s) that comprise the authorized time synchronization coverage area using the Nnrf\_NFDiscovery service operation as described in 3GPP TS 29.510 [10], if they are not available, and, for each UE with matched AF-sessions, subscribes with the discovered AMF(s) to receive notifications about presence of the UE in an Area of Interest events using the Namf\_EventExposure service as described in 3GPP TS 29.518 [27], where the Area of Interest is the provided time synchronization coverage area. + 3. Based on the outcome provided by the AMF about the UE's presence in the Area of Interest and the authorized time synchronization coverage area, the TSCTSF determines if the time synchronization service is activated or deactivated: + - i. If the UE presence is within any of the TAs from the authorized time synchronization coverage area, the TSCTSF determines that the time synchronization coverage area condition is fulfilled, and the UE is authorized for the activation of the received PTP instance configuration. + +- ii. If the UE presence is not within any of the TAs from the authorized time synchronization coverage area, the TSCTSF determines that the time synchronization coverage area condition is not fulfilled, and the UE is not authorized for the activation of the received PTP instance configuration; + - b If the UE's Time Synchronization Subscription data contains the authorized Uu time synchronization error budget, and the requested time synchronization error budget within the "timeSyncErrBdgt" attribute is within the authorized time synchronization coverage area, the TSCTSF determines that the UE is authorized for the requested time synchronization service. + - c. If the UE's Time Synchronization Subscription data contains the periods of authorized start and stop times, and the requested temporal validity condition within the "tempValidity" attribute is within any of the subscribed periods of authorized start and stop times, the TSCTSF determines that the UE is authorized for the requested time synchronization service. +- for each authorized UE and matched AF-session, contact with the each corresponding PCF for the PDU session to configure and initialize the PTP instance in the DS-TT(s) and NW-TT as defined in 3GPP TS 23.502 [3], clause 4.15.9.3.2, step 5-6; + - for each authorized UE with matched AF-session(s), calculate the Uu time synchronization error budget as specified in clauses 5.27.1.9 and 5.27.1.11 of 3GPP TS 23.501 [2], subscribe to event notifications of newly registered PCF for the UE for the affected UEs by invoking Nbsf\_Management\_Subscribe Service Operation as defined in clause 4.2.6 of 3GPP TS 29.521 [23] if not yet done, and send a request to the PCF for the UE for AM policy authorization by invoking Npcf\_AMPolicyAuthorization\_Create service operation as defined in clause 4.2.2 of 3GPP TS 29.534 [14] providing the appropriate values in the "asTimeDisParam" attribute in order to activate the access stratum time distribution and provide the calculated Uu time synchronization error budget. + - if the "NetTimeSyncStatus" feature is supported and upon the reception of the clock quality acceptance criteria in the "clkQltAcptCri" attribute, then TSCTSF subscribes to UPF/NW-TT time synchronization status reports via UMIC as described in clause 4.2.2.31 of 3GPP TS 29.514 [20], if the UPF/NW-TT is involved in providing time synchronization information to DS-TT. In case NG-RAN is involved in providing time synchronization status information to DS-TT, then TSCTSF sends the time synchronization status reporting control information to the NG-RAN and then initiates the subscription to the NG-RAN time synchronization status via AMF using Namf\_Communication\_NonUeN2InfoSubscribe service operation, if not previously done for the involved NG-RAN node, as described in 3GPP TS 29.518 [27]. + +If the temporal validity condition is provided and if the start-time is in the future, the TSCTSF shall maintain the time synchronization configuration and then proceed as described above when the start-time is reached; otherwise, if the start-time is in the past, the TSCTSF shall proceed as described above immediately. When the stop-time is reached for active time synchronization service configuration, the TSCTSF shall proceed as Ntsetsf\_TimeSynchronization\_ConfigDelete was received as described in clause 5.2.2.7.2 without interacting with the AF. + +The TSCTSF shall associate the affected UEs and matched AF sessions to the "Individual Time Synchronization Exposure Configuration". When the "CoverageAreaSupport" feature is supported, the TSCTSF also associates whether the UE fulfills the time synchronization coverage area condition, if provided. When receiving the Npcf\_PolicyAuthorization\_Notify service operation indicating the termination of an existing PDU session and the corresponding AF session is associated with the "Individual Time Synchronization Exposure Configuration" resource, the TSCTSF shall remove the AF session from the list of AF sessions associated with the "Individual Time Synchronization Exposure Configuration" resource and invoke Npcf\_AMPolicyAuthorization\_Delete service operation as defined in clause 4.2.4 of 3GPP TS 29.534 [14] to remove the access stratum time distribution parameters for the UE if they were provided. + +If for all the affected UEs the provided parameters are not allowed by subscription, the TSCTSF shall indicate in an HTTP "403 Forbidden" response message the "cause" attribute set to "UE\_SERVICE\_NOT\_AUTHORIZED". + +If the HTTP POST request from the NF service consumer is not accepted, the TSCTSF shall indicate in the response to HTTP POST request the cause for the rejection as specified in clause 6.1.7. + +If the TSCTSF determines the received HTTP POST request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +## 5.2.2.6 Ntsctsf\_TimeSynchronization\_ConfigUpdate + +### 5.2.2.6.1 General + +This service operation is used by an NF service consumer to update a time synchronization configuration. + +The following procedures using the Ntsctsf\_TimeSynchronization\_ConfigUpdate service operation are supported: + +- Updating an existing configuration; +- Creating the subscription for notification for the changes in the time synchronization service configuration in case the subscription was not created before. + +### 5.2.2.6.2 Updating an existing configuration + +Figure 5.2.2.6.2-1 illustrates the updating of an existing configuration. + +![Sequence diagram illustrating the update of a configuration. The NF service consumer sends a PUT request to the TSCTSF. The TSCTSF responds with either a 200 OK or a 204 No Content.](f1fbb1287d999c7034742de35bdab836_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. PUT « /subscriptions/{subscriptionId}/configurations/{configurationId} » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2a. "200 OK" +2b. "204 No Content" + TSCTSF-->>NF service consumer: Response + +``` + +Sequence diagram illustrating the update of a configuration. The NF service consumer sends a PUT request to the TSCTSF. The TSCTSF responds with either a 200 OK or a 204 No Content. + +**Figure 5.2.2.6.2-1: Update of a configuration** + +To update a configuration, the NF service consumer shall send an HTTP PUT request to the resource "{apiRoot}/ntsctsf-time-sync//subscriptions/{subscriptionId}/configurations/{configurationId}" representing an existing "Individual Time Synchronization Exposure Configuration" resource, as shown in figure 5.2.2.6.2-1, step 1, to modify the configuration. + +The TimeSyncExposureConfig data structure provided in the request body shall include: + +- the user plane node Id within the "upNodeId" attribute; + +NOTE 1: The user plane node Id cannot be changed during the modification. + +- the requested PTP instance within the "reqPtpIns" attribute; +- the time domain within the "timeDom" attribute; + +NOTE 2: The user plane node Id, the requested PTP instance and the time domain cannot be changed during the modification. + +- the notification URI within the "configNotifUri" attribute; +- the notification correlation Id within the "configNotifId" attribute; + +NOTE 3: If the notification URI or notification correlation Id is not changed the previously value is included. + +and may include: + +- the "gmEnable" attribute set to true if the AF requests 5GS to act as a grandmaster for PTP or gPTP; +- the time synchronization error budget within the "timeSyncErrBdgt" attribute; +- the grandmaster priority with the "gmPrio" attribute; + +- the temporal validity condition within the "tempValidity" attribute; +- if the "CoverageAreaSupport" feature is supported, the spatial validity condition encoded as "covReq" attribute, that contains a list of Tracking Area codes per serving network where the requested PTP instance applies; and +- if the "NetTimeSyncStatus" feature is supported, the clock quality detail level in the "clkQltDetLvl" attribute and the clock quality acceptance criteria for the PTP instance in the "clkQltAcptCri" attribute if applicable. + +Upon receipt of the corresponding HTTP PUT message, if the request is authorized, the TSCTSF shall: + +- update the existing "Individual Time Synchronization Exposure Configuration" resource; +- send a HTTP response including "200 OK" status code with TimeSyncExposureConfig data structure or "204 No Content" status code, as shown in figure 5.2.2.6.2-1, step 2; +- use the {subscriptionId} within the requested URI and user plane node ID within the "upNodeId" attribute in the request to determine the target UEs and corresponding AF-sessions, then use the updated parameters (e.g. requested PTP instance type, transport protocol, and PTP profile) in the request to determine suitable DS-TT(s) and AF session(s) among all AF session: + - If the "CoverageAreaSupport" feature is supported and a requested coverage area is provided or updated within the "covReq" attribute, the TSCTSF perform the following operations: + 1. the TSCTSF, based on the time synchronization coverage area retrieved from UDM determines whether the UE is authorized for the request again as described in clause 5.2.2.5.2. + 2. The TSCTSF discovers the list of AMF(s) serving the list of TA(s) that comprise the authorized time synchronization coverage area using the Nnrf\_NFDiscovery service operation as described in 3GPP TS 29.510 [10], if they are not available, and for each UE with matched AF-sessions, subscribes/updates the subscription, if applicable, with the discovered AMF(s) to receive notifications about presence of the UE in an Area of Interest events using the Namf\_EventExposure service as described in 3GPP TS 29.518 [27], where the Area of Interest is the requested/applicable spatial validity condition. + 3. Based on the outcome provided by the AMF or available in the TSCTSF about the UE's presence in the Area of Interest, the TSCTSF determines if the time synchronization service is activated or deactivated: + - i. If the UE presence is within any of the TAs from the authorized time synchronization coverage area, the TSCTSF determines that the spatial validity condition is fulfilled, and the UE is authorized for the activation of the received PTP instance configuration. + - If the UE presence is within any of the TAs from the authorized time synchronization coverage area, the TSCTSF determines that the spatial validity condition is not fulfilled, and the UE is not authorized for the activation of the received PTP instance configuration; + - b. If the "CoverageAreaSupport" feature is supported and a requested coverage area previously provided is removed, the TSCTSF perform the following operations: + 1. For each UE with matched AF-sessions, the TSCTSF terminates the subscriptions to notifications about presence of the UE in an Area of Interest events using the Namf\_EventExposure service as described in 3GPP TS 29.518 [27]. + 2. For each UE with matched AF-sessions that did not fulfil the removed spatial validity condition, the TSCTSF determines the UE is authorized for the activation of the received PTP instance configuration + - c. If the time synchronization error budget within the "timeSyncErrBdgt" attribute and/or the temporal validity condition within the "tempValidity" attribute from the NF service consumer is provided, updated, or removed, the TSCTSF based on the Time Synchronization Subscription data retrieved from the UDM determines whether the UE is authorized for the request again as described in clause 5.2.2.5.2 +- for each authorized UE and matched AF-session, and contact with each corresponding PCF for the PDU session to configure and initialize the PTP instance in the DS-TT(s) and NW-TT as defined in 3GPP TS 23.502 [3], clause 4.15.9.3.3, step 5-6. The TSCTSF associates the new affected AF session(s) with the "Individual Time Synchronization Exposure Configuration" resource. + +- for each authorized UE with matched AF-session(s), if the time synchronization error budget is provided, updated, or removed, calculate the Uu time synchronization error budget as specified in clause 5.27.1.9 of 3GPP TS 23.501 [2] and send a request to the PCF for the UE for AM policy authorization by invoking Npcf\_AMPolicyAuthorization\_Update service operation as defined in clause 4.2.3 of 3GPP TS 29.534 [14] in order to update the Uu time synchronization error budget. +- if the "NetTimeSyncStatus" feature is supported and upon the reception of the updated clock quality acceptance criteria within the "clkQltAcptCri" attribute, then TSCTSF determines the clock acceptance criteria results as specified in clause 5.2.2.8.2. In case the updated clock quality acceptance criteria within the "clkQltAcptCri" attribute is received and the clock acceptance criteria results is not available, then TSCTSF subscribes to UPF/NW-TT time synchronization status reports via UMIC as described in clause 4.2.3.34 of 3GPP TS 29.514 [20], if the UPF/NW-TT is involved in providing time information to DS-TT. In case NG-RAN is involved in providing time synchronization status information to DS-TT, then TSCTSF sends the updated configuration of time synchronization status reporting to the NG-RAN and then initiates the subscription to the NG-RAN time synchronization status via AMF using Namf\_Communication\_NonUeN2InfoSubscribe service operation, as described in 3GPP TS 29.518 [27] + +If the temporal validity condition was provided but it is removed during the update of time synchronization configuration, the TSCTSF shall perform the time synchronization configuration as described above without considering the temporal validity condition. + +If the temporal validity condition was not provided and the temporal validity condition is provided during the update of configuration, the TSCTSF shall perform as follows: + +- if the start-time is in the future, the TSCTSF shall maintain the time synchronization configuration and then proceeds as described above when the start-time is reached; otherwise, if the start-time is in the past, the TSCTSF shall proceed as described above immediately; +- When the stop-time is reached for active time synchronization service configuration, the TSCTSF shall proceed as Ntscsf\_TimeSynchronization\_ConfigDelete was received as described in clause 5.2.2.7.2 without interacting with the AF. + +If the temporal validity condition was provided and the temporal validity condition is updated during the update of configuration, the TSCTSF shall perform as follows: + +- if the previously provided time configuration is being applied but the new start-time is in the future, the TSCTSF shall proceed as Ntscsf\_TimeSynchronization\_ConfigDelete was received as described in clause 5.2.2.7.2 without interacting with the AF firstly and then proceeds as described above when the new start-time is reached; otherwise if the time synchronization configuration has been created but the new start-time is in the past, the TSCTSF keep the existing configuration; +- when the new stop-time is reached for active time synchronization service configuration, the TSCTSF shall proceed as Ntscsf\_TimeSynchronization\_ConfigDelete was received as described in clause 5.2.2.7.2 without interacting with the AF; +- if the previously provided time configuration is not being applied because the previously provided start-time is in the future, the TSCTSF shall perform as the case that the temporal validity condition was not provided previously. + +The TSCTSF shall associate the affected UEs and matched AF session to the "Individual Time Synchronization Exposure Configuration". When the "CoverageAreaSupport" feature is supported, the TSCTSF also associates whether the UE fulfills the spatial validity condition, if provided. When receiving the Npcf\_PolicyAuthorization\_Notify service operation indicating the termination of an existing PDU session and the corresponding AF session is associated with the "Individual Time Synchronization Exposure Configuration" resource, the TSCTSF shall remove the AF session from the list of AF sessions associated with the "Individual Time Synchronization Exposure Configuration" resource and invoke Npcf\_AMPolicyAuthorization\_Delete service operation as defined in clause 4.2.4 of 3GPP TS 29.534 [14] to remove the access stratum time distribution parameters for the UE if they were provided. + +If for all the affected UEs the provided parameters are not allowed by subscription, the TSCTSF shall indicate in an HTTP "403 Forbidden" response message the "cause" attribute set to "UE\_SERVICE\_NOT\_AUTHORIZED". + +If the HTTP PUT request from the NF service consumer is not accepted, the TSCTSF shall indicate in the response to HTTP PUT request the cause for the rejection as specified in clause 6.1.7. + +If the TSCTSF determines the received HTTP PUT request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +## 5.2.2.7 Ntsctsf\_TimeSynchronization\_ConfigDelete + +### 5.2.2.7.1 General + +This service operation is used by an NF service consumer to delete a time synchronization configuration. + +The following procedures using the Ntsctsf\_TimeSynchronization\_ConfigDelete service operation are supported: + +- Deleting an existing configuration. + +### 5.2.2.7.2 Deleting an existing configuration + +Figure 5.2.2.7.2-1 illustrates the deleting of an existing configuration. + +![Sequence diagram showing the deletion of a configuration. An NF service consumer sends a DELETE request to the TSCTSF, and the TSCTSF responds with a 204 No Content.](1c29dadab94c3fa552d270434db09c81_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. DELETE « /subscriptions/{subscriptionId}/configurations/{configurationId} » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2. "204 No Content" + TSCTSF-->>NF service consumer: Response +``` + +Sequence diagram showing the deletion of a configuration. An NF service consumer sends a DELETE request to the TSCTSF, and the TSCTSF responds with a 204 No Content. + +Figure 5.2.2.7.2-1: Deletion of a configuration + +To delete a configuration, the NF service consumer shall send an HTTP DELETE request to the resource "{apiRoot}/ntsctsf-time-sync/{apiVersion}/subscriptions/{subscriptionId}/configurations/{configurationId}" representing an existing "Individual Time Synchronization Exposure Configuration" resource, as shown in figure 5.2.2.7.2-1, step 1, to delete the configuration. + +Upon the reception of an HTTP DELETE request and if the HTTP DELETE request is accepted by the TSCTSF, the TSCTSF shall: + +- remove the corresponding configuration and respond with "204 No Content" as shown in figure 5.2.2.7.2-1, step 2; +- use the {configurationId} within the requested URI to identify the time synchronization service configuration and the corresponding AF sessions, and then interact with: + - the PCF(s) for the PDU Session to disable the corresponding PTP instance(s) in the DS-TT(s) and NW-TT as defined in 3GPP TS 23.502 [3], clause 4.15.9.3.4, step 5-6. + - the PCF(s) for the UE to remove the time synchronization error budget by invoking the Npcf\_AMPolicyAuthorization\_Delete service operation as defined in clause 4.2.4 of 3GPP TS 29.534 [14]. + +If the HTTP DELETE request from the NF service consumer is not accepted, the TSCTSF shall indicate in the response to HTTP DELETE request the cause for the rejection as specified in clause 6.1.7. + +If the TSCTSF determines the received HTTP DELETE request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +## 5.2.2.8 Ntsctsf\_TimeSynchronization\_ConfigUpdateNotify + +### 5.2.2.8.1 General + +This service operation is used by an TSCTSF to notify the NF Service Consumer of the current state of the time synchronization configuration. + +The following procedures using the Ntsctsf\_TimeSynchronization\_ConfigUpdateNotify service operation are supported: + +- notification about the current state of the time synchronization configuration. + +### 5.2.2.8.2 Notifying the current state of an existing configuration + +Figure 5.2.2.8.2-1 illustrates the notification about the current state of the time synchronization configuration. + +![Sequence diagram showing the notification process between TSCTSF and NF service consumer.](17a1ba23b641c01871b08f0a4f08ef48_img.jpg) + +``` +sequenceDiagram + participant TSCTSF + participant NF_service_consumer as NF service consumer + Note right of TSCTSF: 1. POST {configNotifUri} + TSCTSF->>NF_service_consumer: Request + Note left of NF_service_consumer: 2. "204 No Content" + NF_service_consumer-->>TSCTSF: Response +``` + +The diagram illustrates a sequence of interactions between a TSCTSF (Time Synchronization Configuration Function) and an NF service consumer. The TSCTSF sends a POST request to the NF service consumer, labeled "1. POST {configNotifUri}". The NF service consumer responds with a "204 No Content" status, labeled "2. '204 No Content'". + +Sequence diagram showing the notification process between TSCTSF and NF service consumer. + +**Figure 5.2.2.8.2-1: Notification about the current state of the time synchronization configuration** + +When the TSCTSF receives the notification of the change in the PTP instance for each DS-TT and/or NW-TT from the PCF as defined in clause 4.2.5.13 of 3GPP TS 29.514 [20] or when the TSCTSF receives the NG-RAN time synchronization status update related to clock quality acceptance criteria via AMF as described in clause 5.2.2.4.2 of 3GPP TS 29.518 [27] and determines the affected PTP instance(s), the TSCTSF shall determine the current state of the time synchronization configuration and sends an HTTP POST request with "{configNotifUri}", as previously provided by the NF service consumer within the corresponding configuration, as URI and the TimeSyncExposureConfigNotif data structure as request body, as shown in figure 5.2.2.8.2-1, step 1. + +The TimeSyncExposureConfigNotif data structure as request body that shall include: + +- Notification correlation ID provided by the NF service consumer during the configuration within the "configNotifId" attribute; +- current states of the time synchronization configuration for the DS-TT port(s) and/or NW-TT port within the "stateOfConfig" attribute; + +and may include: + +- if "NetTimeSyncStatus" feature is supported, the report of whether the time synchronization service status according to the clock quality acceptance criteria result is acceptable or not acceptable within the "stateOfConfig" attribute. + +If the "CoverageAreaSupport" feature is supported and the TSCTSF received time synchronization coverage area as part of the Ntsctsf\_TimeSynchronization\_ConfigCreate/Update service operation as described in clauses 5.2.2.5.2 and 5.2.2.6.2, when the TSCTSF receives a change in the UE presence in Area of Interest notification as described in 3GPP TS 29.518 [27], the TSCTSF checks the activation or deactivation of the time synchronization service and adds/removes the UE/DS-TT port to/from the PTP instance and configures the Grandmaster functionality, as applicable, as specified in clause K.2.1 of 3GPP TS 23.501 [2]. For the added/removed UE/DS-TT port to/from the PTP instance, the TSCTSF triggers the notification to the NF service consumer where the "stateOfDstts" attribute within the "stateOfConfig" attribute shall include the state of the added/removed UE/DS-TT port. + +If the "NetTimeSyncStatus" feature is supported and the TSCTSF received the clock quality detail level and the clock quality acceptance criteria as part of the Ntsctsf\_TimeSynchronization\_ConfigCreate/Update service operation as described in clauses 5.2.2.5.2 and 5.2.2.6.2, when the TSCTSF receives a change corresponding to the time synchronization status as described in clause 5.27.1.12 of 3GPP TS 23.501 [2], the TSCTSF provides the notification for the clock quality acceptance criteria result by including the "clkQltAcptCriResInd" attribute within the "stateOfConfig" attribute (for the result related to the NW-TT port(s)) and/or within the entries of the "stateOfDstts" attribute of the "stateOfConfig" attribute (for the results related to every DS-TT port). + +**Editor's note: Whether it is required the report of the clock quality acceptance criteria for the NW-TTP ports (i.e., whether the clkQltIndOfNwtt attribute is needed) is FFS and requires SA2 clarifications.** + +If the HTTP POST request from the TSCTSF is not accepted, the NF service consumer shall indicate in the response to HTTP POST request the cause for the rejection as specified in clause 6.1.7. + +If the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +## 5.3 Ntsctsf\_QoSandTSCAssistance Service + +### 5.3.1 Service Description + +#### 5.3.1.1 Overview + +This service provides: + +- Authorization of NF Service Consumer requests for the resource reservation for TSC. +- NF Service Consumer request to reserve or update resources for handling traffic characterized by TSC QoS parameters as described in clause 6.1.3.22 of TS 23.503 [19]. + +#### 5.3.1.2 Network Functions + +##### 5.3.1.2.1 TSCTSF + +The TSCTSF supports to: + +- receive the request to reserve or update a specific QoS or a specific QoS with additional Alternative QoS for an AF session; +- receive the request to delete the AF session with requested QoS or the AF session with requested QoS including Alternative Service Requirements +- receive the request to subscribe or unsubscribe to the event(s) about the AF session with requested QoS or the AF session with requested QoS including Alternative Service Requirements; +- determine the requested PDB and construct the TSC Assistance Container; and +- Notify the NF service consumer of the event(s). + +##### 5.3.1.2.2 NF Service Consumers. + +The NF service consumer supports to: + +- send the request to reserve or update a specific QoS or a specific QoS with additional Alternative QoS for an AF session; +- send the request to delete the AF session with requested QoS or the AF session with requested QoS including Alternative Service Requirements +- send the request to subscribe or unsubscribe to the event(s); and + +- receive the notification of the event(s). + +## 5.3.2 Service Operations + +### 5.3.2.1 Introduction + +Service operations defined for the Ntsctsf\_QoSandTSCAssistance service are shown in table 6.3.2.1-1. + +**Table 5.3.2.1-1: Ntsctsf\_TimeSynchronization Service Operations** + +| Service Operation Name | Description | Initiated by | +|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| +| Ntsctsf_QoSandTSCAssistance_Create | Allows the NF service consumer to request the network to provide a specific QoS or a specific QoS with additional Alternative QoS for an AF session. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_QoSandTSCAssistance_Update | Allows the NF service consumer to request the network to update the QoS or the QoS with additional Alternative QoS for an AF session | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_QoSandTSCAssistance_Delete | Allows the NF service consumer to request the network to delete the AF session with requested QoS or the AF session with requested QoS including Alternative Service Requirements. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_QoSandTSCAssistance_Notify | Allows the TSCTSF to report the QoS Flow level event(s) to the NF service consumer. | TSCTSF | +| Ntsctsf_QoSandTSCAssistance_Subscribe | Allows the NF service consumer to subscribe to the event(s). | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_QoSandTSCAssistance_Unsubscribe | Allows the NF service consumer to unsubscribe to the event(s). | NF service consumer (e.g. AF, NEF) | + +NOTE: The NEF and the AF use the Ntsctsf\_QoSandTSCAssistance service in the same way. + +### 5.3.2.2 Ntsctsf\_QoSandTSCAssistance\_Create + +#### 5.3.2.2.1 General + +This service operation is used by an NF service consumer to request the network to provide a specific QoS for an AF session. + +The following procedures using the Ntsctsf\_QoSandTSCAssistance\_Create service operation are supported: + +- Initial provisioning of TSC related service information. +- Subscriptions to Service Data Flow QoS notification control. +- Subscription to Service Data Flow Deactivation +- Subscription to resources allocation outcome +- Subscriptions to Service Data Flow QoS Monitoring Information. +- Initial provisioning of sponsored connectivity information. +- Initial provisioning of AF requested QoS for a UE or a group of UE(s) not identified by UE address. +- Subscription to BAT offset notification. + +#### 5.3.2.2.2 Initial provisioning of TSC related service information + +This procedure is used to set up a TSC AF application session context for the service as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [19]. + +Figure 5.3.2.2.2-1 illustrates the initial provisioning of TSC related service information. + +![Sequence diagram showing the initial provisioning of TSC related service information. The NF service consumer sends a POST request to the TSCTSF, and the TSCTSF responds with a 201 Created status.](b5335262987c819d7f71ce40f99cb71b_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. POST « /tsc-app-sessions » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2. "201 Created" + TSCTSF-->>NF service consumer: Response + +``` + +Sequence diagram showing the initial provisioning of TSC related service information. The NF service consumer sends a POST request to the TSCTSF, and the TSCTSF responds with a 201 Created status. + +**Figure 5.3.2.2.2-1: Initial provisioning of TSC related service information** + +When a new TSC AF application session context needs to be established, the NF service consumer shall invoke the Ntsctsf\_QoSAndTSCAssistance\_Create service operation by sending the HTTP POST request to the resource URI representing the "TSC Application Sessions" collection resource of the TSCTSF, as shown in figure 5.3.2.2.2-1, step 1. + +The NF service consumer shall include the "TscAppSessionContextData" data type in the content of the HTTP POST request in order to request the creation of the "Individual TSC Application Session Context" resource. The "Individual TSC Application Session Context" resource and the "Events Subscription" sub-resource are created as described below. + +The NF service consumer shall include in the "TscAppSessionContextData" data structure: + +- the AF identifier within the "afId" attribute; +- when the "GMEC" feature is not supported, either the IP address (IPv4 or IPv6) of the PDU session within the "ueIpAddr" attribute for IP type PDU session or the MAC address of the DS-TT port within the "ueMac" attribute for Ethernet type PDU sessions; +- when the "GMEC" feature is supported, either the targeted UE within the "ueId" attribute or the targeted group of UE(s) within the "externalGroupId" attribute as defined in clause 5.3.2.2.8; +- either the Application Id within the "appId" attribute or the flow information within: + - a. for IP flows, the "flowInfo" attribute; or + - b. for Ethernet flows, either the "ethFlowInfo" attribute or, if the Ethernet\_UL/DL\_Flows feature is supported, the "enEthFlowInfo" attribute; +- the QoS reference within the "qosReference" attribute or the individual QoS parameter set (i.e. requested GBR, requested MBR, requested maximum burst size, requested priority if received and requested 5GS delay if received, and requested packet error rate if received) within the "tscQosReq" attribute; +- the input information to construct the TSC Assistance Container within the "tscaiInputUI" attribute and/or "tscaiInputDI" attribute of the "tscQosReq" attribute and the (g)PTP domain that the AF is located in within the "tscaiTimeDom" attribute of the "tscQosReq" attribute, if available; and +- the URI where the TSCTSF can request to the NF service consumer to delete the "Individual TSC Application Session Context" resource within the "notifUri" attribute; + +and may include: + +- the DNN within the "dnn" attribute; +- the S-NSSAI within the "snssai" attribute; +- the domain identity in the "ipDomain" attribute; +- if the "EnTSCAC" feature is supported, the capability for BAT adaptation in the "capBatAdaptation" attribute; + +- an ordered list of alternative QoS references within the "altQosReferences" attribute if the QoS reference is provided or an ordered list of requested alternative QoS parameters set(s) within the "altQosReqs" attribute if the individual QoS parameter set is provided. When the NF service consumer provides the "altQosReferences" attribute or the "altQosReqs" attribute, the NF service consumer shall also subscribe to receive notifications from the TSCTSF when the resources associated to the corresponding service information have been allocated as described in clause 5.3.2.2.5 and when the GBR QoS targets for one or more service data flows can no longer (or can again) be guaranteed, as described in clause 5.3.2.2.3; + +and + +- the request of the notification of certain user plane events within the "evSubsc" attribute. Within the EventsSubscReqData data structure, the NF service consumer shall include: + - a) the URI where the TSCTSF sends the event notification to the NF service consumer within the "notifUri" attribute; + - b) a Notification Correlation Identifier for the requested notifications within the "notifCorreId" attribute; + - c) the subscribed events within the "events" attribute; + - d) the usage threshold within the "usgThres" attribute if the "USAGE\_REPORT" event is subscribed; and + - e) QoS monitoring information within the "qosMon" attribute if the "QOS\_MONITORING" event is subscribed. + +Upon the reception of this HTTP POST request, the TSCTSF shall: + +- construct the TSC Assistance Container based on information provided by the NF service consumer; +- if the Requested 5GS delay including the requested 5GS delay within the individual QoS parameter set or within the requested alternative QoS parameters set(s) is received from NF service consumer, calculate a Requested PDB by subtracting the UE-DS-TT residence time either provided by the PCF or pre-configured at TSCTSF from the Requested 5GS delay; +- if the time domain information is not received with the Burst Arrival Time or Periodicity within the "tscQosReq" attribute from the NF service consumer, the TSCTSF may indicate Time Domain = "5GS" within the "tscaiTimeDom" attribute within the "tscQosReq" attribute to indicate that the NF service consumer does not provide the time domain information; + +NOTE 1: The Time Domain value corresponding to "5GS" is locally configured in the SMF and in the TSCTSF, and indicates that the AF does not provide a Time Domain and the provided TSCAI input information will be used without adjustments. + +- if the feature EnTSCAC is supported and if the NF service consumer includes the capability for BAT adaptation within the "capBatAdaptation" attribute or a BAT window within the "burstArrivalTimeWnd" attribute within the "tscaiInputUI" attribute and/or "tscaiInputDI" attribute of the "tscQosReq" attribute or the periodicity range in the "periodicityRange" attribute in the request, then the TSCTSF shall subscribe to the notification on BAT offset by using the "EventsSubscReqData" data type including an event within the "events" attribute with the "event" attribute set to "BAT\_OFFSET\_INFO"; +- interact with the PCF for the received UE address: + - a) if the TSCTSF has an AF-session with the PCF for the received UE address, the TSCTSF shall interact with the PCF by triggering a Npcf\_PolicyAuthorization\_Update request to provision the related parameters to the PCF as defined in 3GPP TS 29.514 [20]; or + - b) if the TSCTSF does not have an AF-Session with the PCF for the received UE address, the TSCTSF shall discover the PCF for the PDU session as specified in 3GPP TS 29.521 [23], and shall interact with the PCF by triggering a Npcf\_PolicyAuthorization\_Create to provision the related parameters to the PCF as defined in 3GPP TS 29.514 [20]; and + +NOTE 2: If the PCF determines an existing PDU Session is related with TSC traffic (based on local configuration or SM Policy Association), the PCF invokes Npcf\_PolicyAuthorization\_Notify service operation to the TSCTSF as defined in clause 4.2.5.16 of 3GPP TS 29.514 [20] to send the received TSC User Plane Node information. At that time, the TSCTSF retrieves from the BSF the PCF binding information, as specified in 3GPP TS 29.521 [23], and can create the AF-session by sending to the PCF the Npcf\_PolicyAuthorization\_Create service operation, if TSC related information, as e.g. QoS requirements, and/or subscription to PMIC(s)/UMIC updates need to be provided to the PCF. + +NOTE 3: After the TSCTSF retrieves from the BSF the PCF binding information (including the UE Identities for the notified PDU session), as specified in 3GPP TS 29.521 [23], the TSCTSF can store internally the received information and delay the Npcf\_PolicyAuthorization\_Create service operation (the creation of the AF-session). In this case, when the TSCTSF receives the QoS request, the TSCTSF interacts with the PCF by triggering a Npcf\_PolicyAuthorization\_Create request to provision the related parameters to the PCF as defined in 3GPP TS 29.514 [20]. + +- if receiving a successful response from the PCF, the TSCSTF shall create an "Individual TSC Application Session Context" resource and send to the NF service consumer a "201 Created" response to the HTTP POST request, as shown in figure 5.3.2.2.2-1, step 2. If the "evSubsc" attribute is received, the "Events Subscription" sub-resource shall be created within the "Individual TSC Application Session Context" resource. The TSCTSF shall include in the "201 Created" response: + +- a) a Location header field; and +- b) a "TscAppSessionContextData" data type in the content. + +The Location header field shall contain the URI of the created "Individual TSC Application Session Context" i.e. "{apiRoot}/ntscstf-qos-tscai//tsc-app-sessions/{appSessionId}". + +When "Events Subscription" sub-resource is created in this procedure, the NF service consumer shall build the sub-resource URI by adding the path segment "/events-subscription" at the end of the URI path received in the Location header field. + +If the TSCTSF cannot successfully fulfil the received HTTP POST request due to the internal TSCTSF error or due to the error in the HTTP POST request, the TSCTSF shall send the HTTP error response as specified in clause 6.2.7. + +The TSCTSF may send the following error responses based on failed AF-session creation/update request responses received from the PCF as specified in 3GPP TS 29.514 [20]: + +- a. If the TSCSTSF receives the indication that the PCF failed in executing session binding, the TSCTSF shall reject the HTTP POST request with an HTTP "500 Internal Server Error" response including the "cause" attribute set to "PDU\_SESSION\_NOT\_AVAILABLE". +- b. If the service information provided in the body of the HTTP POST request is rejected by the PCF (e.g. the subscribed guaranteed bandwidth for a particular user is exceeded or the authorized data rate in that slice for a UE is exceeded), the TSCTSF shall indicate in an HTTP "403 Forbidden" response message the cause for the rejection including the "cause" attribute set to "REQUESTED\_SERVICE\_NOT\_AUTHORIZED", as received. +- c. If the service information provided in the body of the HTTP POST request is rejected due to a temporary condition in the network, the TSCTSF may include in the "403 Forbidden" response the "cause" attribute set to "REQUESTED\_SERVICE\_TEMPORARILY\_NOT\_AUTHORIZED". The TSCTSF may also provide a received retry interval within the "Retry-After" HTTP header field. When the NF service consumer receives the retry interval within the "Retry-After" HTTP header field, the NF service consumer shall not send the same service information to the TSCTSF again (for the same application session context) until the retry interval has elapsed. The "Retry-After" HTTP header is described in 3GPP TS 29.500 [4] clause 5.2.2.2. + +The TSCTSF may additionally provide the received acceptable bandwidth within the attribute "acceptableServInfo" included in the "ProblemDetailsTscstfQoS" data structure returned in the rejection response message. + +### 5.3.2.2.3 Subscriptions to Service Data Flow QoS notification control + +The NF service consumer shall use the "EventsSubscReqData" data type as described in clause 5.3.2.2.2 and shall include in the HTTP POST request message an event within the "evSubsc" attribute with the "event" attribute set to + +"QOS\_GUARANTEED" and an event within the "evSubsc" attribute with the "event" attribute set to "QOS\_NOT\_GUARANTEED". + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.2.2. + +As result of this action, the TSCTSF shall set the appropriate subscription to QoS notification control as described in in 3GPP TS 29.514 [20]. + +#### 5.3.2.2.4 Subscription to Service Data Flow Deactivation + +The NF service consumer shall use the "EventsSubscReqData" data type as described in clause 5.3.2.2.2 and shall include in the HTTP POST request message an event entry within the "evSubsc" attribute with the "event" attribute set to "FAILED\_RESOURCES\_ALLOCATION". + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.2.2. + +As result of this action, the TSCTSF shall set the appropriate subscription to service data flow deactivation as described in in 3GPP TS 29.514 [20]. + +#### 5.3.2.2.5 Subscription to resources allocation outcome + +The NF service consumer shall use the "EventsSubscReqData" data type as described in clause 5.3.2.2.2 and shall include in the HTTP POST request message: + +- if the NF service consumer requests the TSCTSF to provide a notification when the resources associated to the service information have been allocated, an event entry within the "events" attribute with the "event" attribute set to "SUCCESSFUL\_RESOURCES\_ALLOCATION"; and/or +- if the NF service consumer requests the TSCTSF to provide a notification when the resources associated to the service information cannot be allocated, an event entry within the "events" attribute with the "event" attribute set to "FAILED\_RESOURCES\_ALLOCATION". + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.2.2. + +As result of this action, the TSCTSF shall set the appropriate subscription to notification of resources allocation outcome as described in in 3GPP TS 29.514 [20]. + +#### 5.3.2.2.6 Subscriptions to Service Data Flow QoS Monitoring Information + +The NF service consumer shall use the "EventsSubscReqData" data type as described in clause 5.3.2.2.2 and shall include in the HTTP POST request message an event within the "evSubsc" attribute with the "event" attribute set to "QOS\_MONITORING" and include the QoS monitoring information with the "qosMon" attribute. Within the QosMonitoringInformation data structure, the AF shall include: + +- one or more requested QoS Monitoring Parameter(s) within the "reqQosMonParams"; and +- one or more report frequency within the "repFreqs" attribute; and +- when the "repFreqs" attribute includes the value "PERIODIC", the periodic time for reporting and, if the feature "PacketDelayFailureReport" is supported, the maximum period with no QoS measurement results reported within the "repPeriod" attribute; and +- when the "repFreqs" attribute includes the value "EVENT\_TRIGGERED", the AF shall include: + - the minimum waiting time between subsequent reports within the "waitTime" attribute; andfor QoS monitoring for packet delay: + - the delay threshold for downlink with the "repThreshDI" attribute; + - the delay threshold for uplink with the "repThreshUI" attribute; and/or + - the delay threshold for round trip with the "repThreshRp" attribute; and + +- if the feature "PacketDelayFailureReport" is supported, the maximum period with no QoS measurement results reported within the "repPeriod" attribute. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.2.2. + +As result of this action, the TSCTSF shall set the appropriate subscription to service data flow QoS monitoring information as described in in 3GPP TS 29.514 [20]. + +#### 5.3.2.2.7 Initial provisioning of sponsored connectivity information + +The NF service consumer may include in the HTTP POST request message described in clause 5.3.2.2.2 an application service provider identity and a sponsor identity within the "aspId" attribute and "sponId" attribute. Additionally, the NF service consumer may provide an indication to the TSCTSF of sponsored data connectivity not enabled by including the "sponStatus" attribute set to "SPONSOR\_DISABLED". + +To support the usage monitoring of sponsored data connectivity, the NF service consumer may subscribe with the TSCTSF to the notification of usage threshold reached. The NF service consumer may also include the "evSubsc" attribute with: + +- the usage thresholds to apply in the "usgThres" attribute; and +- an entry of the "events" attribute set to "USAGE\_REPORT". + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.2.2. + +As result of this action, the TSCTSF shall provision the sponsored data connectivity information to the PCF as described in 3GPP TS 29.514 [20]. + +The TSCTSF may send the following error responses based on the response to the provisioning of sponsored data connectivity information received from the PCF, as described in 3GPP TS 29.514 [20], as follows: + +- HTTP "403 Forbidden" response message with the "cause" attribute set to "UNAUTHORIZED\_SPONSORED\_DATA\_CONNECTIVITY", when received from the PCF. +- HTTP "403 Forbidden" response message the "cause" attribute set to "REQUESTED\_SERVICE\_NOT\_AUTHORIZED", when received from the PCF. + +#### 5.3.2.2.8 Initial provisioning of AF requested QoS for a UE or group of UE(s) not identified by UE address + +When the "GMEC" feature is supported, if the NF service consumer includes in the HTTP POST request message described in clause 5.3.2.2.2 the targeted UE identified by its GPSI, within the "ueId" attribute, or the targeted group of UE(s) identified by its External Group ID, within the "externalGroupId" attribute, the provisions of clause 5.3.2.2.2 shall apply with the following differences: + +- the AF request information may include: + - the Temporal invalidity conditions, within the "tempInvalidity" attribute; + - the traffic characteristics information, within the "evSubsc" attribute; + - the QoS parameters for monitoring, within the "tscQosReq" attribute; + - the QoS parameters, within either the "qosReference" attribute, the "altQosReferences" attribute or the "altQosReqs" attribute; and/or + - the flow description, within either the "flowInfo" attribute or the "enEthFlowInfo" attribute. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.2.2 with the following differences: + +- upon reception of the HTTP request from the NF service consumer, and if the request is authorized, the TSCTSF shall: + - create a new "Individual TSC Application Session Context" resource; + +- if the "externalGroupId" attribute is received from the NF service consumer, interact with the UDM to retrieve the list of SUPI(s) identifying the UE(s) constituting the targeted group of UE(s) using the Nudm\_SDM service as defined in 3GPP TS 29.503 [24]; +- if the "ueId" attribute is received from the NF service consumer, interact with the UDM to retrieve the SUPI that corresponds to the targeted GPSI using the Nudm\_SDM service as defined in 3GPP TS 29.503 [24]; +- use the parameters received from the NF service consumer (i.e., DNN, S-NSSAI and, if available, the identifier of the targeted UE or group of UE(s) to determine the corresponding AF-session(s) (i.e., to which they match); and +- for each matching AF-session interact with the PCF by invoking the Npcf\_PolicyAuthorization\_Create/Update service operation as defined in 3GPP TS 29.514 [20] to create/update the AF session based on the provided requested QoS parameters; and + +NOTE 1: If the PCF determines that an existing PDU Session is potentially impacted by the time synchronization service (based on local configuration or SM Policy Association), the PCF invokes Npcf\_PolicyAuthorization\_Notify service operation towards the TSCTSF as defined in clause 4.2.5.16 of 3GPP TS 29.514 [20] to send the received TSC User Plane Node information. The TSCTSF then retrieves from the BSF the PCF binding information (including the UE Identities for the notified PDU session), as specified in 3GPP TS 29.521 [23], and can create the AF-session by invoking the Npcf\_PolicyAuthorization\_Create service operation towards the PCF. + +- the TSCTSF shall handle the AF session(s) associated with a given "Individual TSC Application Session Context" resource as follows: + - For the association of the AF session(s) at the PCF to the "Individual TSC Application Session Context" resource: + - a. Upon PDU Session establishment, i.e. when the TSCTSF receives a Npcf\_PolicyAuthorization\_Notify service operation following the establishment of a new PDU session, the TSCTSF shall retrieve from the BSF, as specified in 3GPP TS 29.521 [23], the PCF binding information to complete the necessary AF-Session information. The TSCTSF shall then trigger the Npcf\_PolicyAuthorization\_Create service operation towards the PCF to create an AF-session to subscribe to TSC user plane node related events. The TSCTSF shall use the parameters of the existing "Individual TSC Application Session Context" resources to determine whether they shall be associated to this newly created AF session. The TSCTSF associates the new AF session to the "Individual TSC Application Session Context" resource to which these parameters match. + - b. Upon "Individual TSC Application Session Context" resource creation, the TSCTSF uses the parameters of the created resource to determine which existing AF session(s) it matches. The TSCTSF then associates the new "Individual TSC Application Session Context" resource to the corresponding AF session(s). + - To remove an AF session from the list of AF session(s) associated to an "Individual TSC Application Session Context" resource, when the TSCTSF receives the Npcf\_PolicyAuthorization\_Notify service operation from the PCF indicating the termination of the corresponding existing PDU session, the TSCTSF triggers the Npcf\_PolicyAuthorization\_Delete service operation towards the PCF and determines if the corresponding AF session is associated with the "Individual TSC Application Session Context" resource. If it is so, the TSCTSF shall remove the AF session from the list of AF session(s) associated with the "Individual TSC Application Session Context" resource. + +NOTE 2: After the TSCTSF retrieves from the BSF the PCF binding information (including the UE Identities for the notified PDU session), as specified in 3GPP TS 29.521 [23], the TSCTSF can store internally the information required to invoke Npcf\_PolicyAuthorization\_Create service operation and delay the Npcf\_PolicyAuthorization\_Create service operation (the creation of the AF session) till a request is received for the concerned UE (time synchronization capability exposure or QoS provisioning request). In this case, when the TSCTSF receives the request, the TSCTSF interacts with the PCF by triggering Npcf\_PolicyAuthorization\_Create service operation as defined in 3GPP TS 29.514 [20]. + +NOTE 3: When the TSCTSF receives the Npcf\_PolicyAuthorization\_Notify service operation indicating the termination of an existing PDU session associated to an AF session that it is not associated with any "Individual Time Synchronization Exposure Subscription" resource and "Individual TSC Application Session Context resource" resource, the TSCTSF removes the AF-session and triggers the Npcf\_PolicyAuthorization\_Delete service operation towards the PCF. + +#### 5.3.2.2.9 Subscription to BAT offset notification + +When the "EnTSCAC" feature is supported, The NF service consumer shall use the "EventsSubscReqData" data type and shall include in the HTTP POST request message an event entry within the "evSubsc" attribute with the "event" attribute set to "BAT\_OFFSET\_INFO" to subscribe to receive a notification when AF provides the Capability for BAT adaptation or BAT Window as defined in clause 5.3.2.2.2. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.2.2. + +As result of this action, the TSCTSF shall set the appropriate subscription to BAT offset notification as described in 3GPP TS 29.514 [20]. + +#### 5.3.2.3 Ntsctsf\_QoSandTSCAssistance\_Update + +##### 5.3.2.3.1 General + +This service operation is used by an NF service consumer to request the network to update the QoS and/or additional Alternative QoS for an AF session. + +The following procedures using the Ntsctsf\_QoSandTSCAssistance\_Update service operation are supported: + +- Modification of TSC related service information. +- Modification of Subscription to Service Data Flow QoS notification control. +- Modification of Subscription to Service Data Flow Deactivation. +- Modification of subscription to resources allocation outcome. +- Modification of Subscription to Service Data Flow QoS Monitoring Information. +- Modification of sponsored connectivity information. +- Modification of AF the requested QoS for a UE or a group of UE(s) not identified by UE address. +- Modification of subscription to BAT offset notification. + +##### 5.3.2.3.2 Modification of TSC related service information + +This procedure is used to modify an existing TSC application session context as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [19]. + +Figure 5.3.2.3.2-1 illustrates the modification of TSC related service information using HTTP PATCH method. + +![Sequence diagram showing the modification of TSC related service information using HTTP PATCH. The NF service consumer sends a PATCH request to the TSCTSF. The TSCTSF responds with either a 200 OK or a 204 No Content.](329c96049bb432e9c2cbda4e224a0c9c_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. PATCH « /tsc-app-sessions/{appSessionId} » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2a. "200 OK" +2b. "204 No Content" + TSCTSF-->>NF service consumer: Response + +``` + +Sequence diagram showing the modification of TSC related service information using HTTP PATCH. The NF service consumer sends a PATCH request to the TSCTSF. The TSCTSF responds with either a 200 OK or a 204 No Content. + +**Figure 5.3.2.3.2-1: Modification of TSC related service information using HTTP PATCH** + +The NF service consumer may modify the TSC application session context information at any time and invoke the Ntsctsf\_QoSAndTSCAssistance\_Update service operation by sending the HTTP PATCH request message to the resource URI representing the "Individual TSC Application Session Context" resource, as shown in figure 5.3.2.3.2-1, step 1, with the modifications to apply. + +The JSON body within the PATCH request shall include the "TscAppSessionContextUpdateData" data type and shall be encoded according to "JSON Merge Patch", as defined in IETF RFC 7396 [22]. + +The NF service consumer may include in the "TscAppSessionContextUpdateData" data structure: + +- the updated flow information within the "flowInfo" attribute for IP flows or, either the "ethFlowInfo" or, if the Ethernet\_UL/DL\_Flows feature is supported, the "enEthFlowInfo" attribute for Ethernet flows; +- the updated application Id within the "appId" attribute; +- the updated QoS reference within the "qosReference" attribute or the updated individual QoS parameter set within the "tscQosReq" attribute; +- the updated input information to construct the TSC Assistance Container within the "tscaiInputUI" attribute and/or "tscaiInputDI" attribute of the "tscQosReq" attribute, and/or the updated (g)PTP domain that the AF is located in within the "tscaiTimeDom" attribute of the "tscQosReq" attribute; +- if the "EnTSCAC" feature is supported, the capability for BAT adaptation in the "capBatAdaptation" attribute; +- the updated URI where the TSCTSF can request to the NF service consumer to delete the "Individual TSC Application Session Context" resource within the "notifUri". +- the updated ordered list of alternative QoS references within the "altQosReferences" attribute or updated ordered list of requested alternative QoS parameters set(s) within the "altQosReqs" attribute; and +- the updated event subscription information within the "evSubsc" attribute. Within the EventsSubscReqDataRm data structure, the NF service consumer shall include: + - the new complete list of subscribed events within the "events" attribute; + - when the NF service consumer requests to update the additional information related to an event (e.g. the NF service consumer needs to provide new thresholds to the TSCTSF in the "usgThres" attribute related to the "USAGE\_REPORT" event), the additional information within the corresponding attribute(s). + +NOTE 2: Note that when the NF service consumer requests to remove an event, this event is not included in the "events" attribute. + +NOTE 3: When an event is included in the "events" attribute and its related additional information is set to null, the TSCTSF considers the subscription to this event is active, but the related procedures stop applying. + +NOTE 4: When an event is removed from the "events" attribute but its related information is not set to null, the TSCTSF considers the subscription to this event is terminated, the related additional information is removed, and the related procedures stop applying. + +The NF service consumer shall remove existing event subscription information by setting to null the "evSubsc" attribute included in "TscAppSessionContextUpdateData". + +NOTE 5: The "notifiUri" attribute within the EventsSubscReqData data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +Upon the reception of this HTTP PATCH request, the TSCTSF shall + +- if the updated Requested 5GS delay including the requested 5GS delay within the individual QoS parameter set or within the requested alternative QoS parameters set(s) is received from NF service consumer, re-calculate a Requested PDB by subtracting the UE-DS-TT residence time provided by the PCF or pre-configured in the TSCTSF from the Requested 5GS delay; +- update the TSC Assistance Container based on updated information provided by the NF service consumer; +- if the time domain information is not received with the Burst Arrival Time or Periodicity within the "tscQosReq" attribute from the NF service consumer, the TSCTSF may indicate Time Domain = "5GS" within the "tscaiTimeDom" attribute within the "tscQosReq" attribute to indicate that the NF service consumer does not provide the time domain information; + +NOTE 6: The Time Domain value corresponding to "5GS" is locally configured in the SMF and in the TSCTSF, and indicates that the AF does not provide a Time Domain and the provided TSCAI input information will be used without adjustments. + +- if the feature EnTSCAC is supported and if the NF service consumer during the modification includes the capability for BAT adaptation within the "capBatAdaptation" attribute or a BAT window within the "burstArrivalTimeWnd" attribute within the "tscaiInputUI" attribute and/or "tscaiInputDI" attribute of the "tscQosReq" attribute or the periodicity range in the "periodicityRange" attribute in the update request, then the TSCTSF shall subscribe to the notification on BAT offset by using the "EventsSubscReqDataRm" data type including an event within the "events" attribute with the "event" attribute set to "BAT\_OFFSET\_INFO"; +- interact with the PCF by triggering a Npcf\_PolicyAuthorization\_Update request to provision the related parameters to the PCF as defined in 3GPP TS 29.514 [20]; +- if receiving a successful response from the PCF, the TSCTSF shall update the "Individual TSC Application Session Context" resource and send a "200 OK" or "204 No Content" response to the HTTP POST request to the NF service consumer, as shown in figure 5.3.2.3.2-1, step 2. + +If the TSCTSF cannot successfully fulfil the received HTTP PATCH request due to the internal TSCTSF error or due to the error in the HTTP PATCH request, the TSCTSF shall send the HTTP error response as specified in clause 6.2.7. + +The TSCTSF may send the following error responses based on failed AF-session update responses received from the PCF as specified in 3GPP TS 29.514 [20]: + +- a. If the updated service information is not acceptable for the PCF (e.g. the subscribed guaranteed bandwidth for a particular user is exceeded or the authorized data rate in that slice for the UE is exceeded), the TSCTSF shall indicate in an HTTP "403 Forbidden" response message the received cause for the rejection including the "cause" attribute set to "REQUESTED\_SERVICE\_NOT\_AUTHORIZED". +- b. If the service information provided in the body of the HTTP POST request is rejected due to a temporary condition in the network, the TSCTSF may include in the "403 Forbidden" response the "cause" attribute set to "REQUESTED\_SERVICE\_TEMPORARILY\_NOT\_AUTHORIZED". The TSCTSF may also provide a received retry interval within the "Retry-After" HTTP header field. When the NF service consumer receives the retry interval within the "Retry-After" HTTP header field, the NF service consumer shall not send the same service information to the TSCTSF again (for the same application session context) until the retry interval has elapsed. The "Retry-After" HTTP header is described in 3GPP TS 29.500 [4] clause 5.2.2.2. + +The TSCTSF may additionally provide the acceptable bandwidth within the attribute "acceptableServInfo" included in the "ProblemDetailsTsctsfQosTscac" data structure returned in the rejection response message. + +If the TSCTSF determines the received HTTP PATCH request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +#### 5.3.2.3.3 Modification of Subscription to Service Data Flow QoS notification control + +The NF service consumer shall use the HTTP PATCH method to update the "Events Subscription" sub-resource together with the modifications to the "Individual TSC Application Sessions" resource. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 5.3.2.3.2, the updated event subscription information within the "evSubsc" attribute. Within the EventsSubscReqDataRm data type, the NF service consumer shall include the "events" attribute with the "QOS\_GUARANTEED" and "QOS\_NOT\_GUARANTEED" values to indicate the subscription to QoS notification control or include the "events" but without the "QOS\_GUARANTEED" and "QOS\_NOT\_GUARANTEED" values to indicate the termination of the subscription to QoS notification control. + +As result of this action, the TSCTSF shall set the appropriate subscription to QoS notification control as described in 3GPP TS 29.514 [20]. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.3.2. + +The TSCTSF may send the following error responses based on the response to the provisioning of sponsored data connectivity information received from the PCF, as described in 3GPP TS 29.514 [20], as follows: + +- HTTP "403 Forbidden" response message with the "cause" attribute set to "UNAUTHORIZED\_SPONSORED\_DATA\_CONNECTIVITY", when received from the PCF. +- HTTP "403 Forbidden" response message the "cause" attribute set to "REQUESTED\_SERVICE\_NOT\_AUTHORIZED", when received from the PCF. + +#### 5.3.2.3.4 Modification of Subscription to Service Data Flow Deactivation + +The NF service consumer shall use the HTTP PATCH method to update the "Events Subscription" sub-resource together with the modifications to the "Individual TSC Application Sessions" resource. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 5.3.2.3.2, the updated event subscription information within the "evSubsc" attribute. Within the EventsSubscReqDataRm data type, the NF service consumer shall include the "events" attribute with the "FAILED\_RESOURCES\_ALLOCATION" values to the subscription to service data flow deactivation or include the "events" but without "FAILED\_RESOURCES\_ALLOCATION" value to indicate the termination of the subscription to Service Data Flow Deactivation. + +As result of this action, the TSCTSF shall set the appropriate subscription to QoS notification control as described in 3GPP TS 29.514 [20]. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.3.2. + +#### 5.3.2.3.5 Modification of subscription to resources allocation outcome + +The NF service consumer shall use the HTTP PATCH method to modify the "Events Subscription" sub-resource together with the modifications to the "Individual TSC Application Sessions" resource. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 5.3.2.3.2, the updated event subscription information within the "evSubsc" attribute. Within the EventsSubscReqDataRm data type, the NF service consumer shall include the "events" attribute with the "SUCCESSFUL\_RESOURCES\_ALLOCATION" value for the successful resource allocation and/or "FAILED\_RESOURCES\_ALLOCATION" value for the unsuccessful resource allocation to the subscription to resources allocation outcome or include the "events" but without "SUCCESSFUL\_RESOURCES\_ALLOCATION" and/or "FAILED\_RESOURCES\_ALLOCATION" value to indicate the termination of the subscription to resources allocation outcome. + +As result of this action, the TSCTSF shall set the appropriate subscription to resources allocation outcome as described in 3GPP TS 29.514 [20]. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.3.2. + +#### 5.3.2.3.6 Modification of Subscription to Service Data Flow QoS Monitoring Information + +The NF service consumer shall use the HTTP PATCH method to update the "Events Subscription" sub-resource together with the modifications to the "Individual TSC Application Sessions" resource. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 5.3.2.3.2, the updated event subscription information within the "evSubsc" attribute. Within the EventsSubscReqDataRm data type, the NF service consumer shall perform as follows: + +- to create a subscription to QoS monitoring information: + - a) include the "events" attribute with the "QOS\_MONITORING" value; and + - b) include the updated QoS monitoring information within the "qosMon" attribute as defined in clause 5.3.2.2.6; +- to remove a subscription to QoS monitoring information: + - a) include the "events" attribute without "QOS\_MONITORING". + +As result of this action, the TSCTSF shall set the appropriate subscription to Service Data Flow QoS Monitoring Information as described in 3GPP TS 29.514 [20]. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.3.2. + +#### 5.3.2.3.7 Modification of sponsored connectivity information + +The NF service consumer shall use the HTTP PATCH method to modify the sponsored connectivity information. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 5.3.2.3.2, an application service provider identity and a sponsor identity within the "aspId" attribute and "sponId" attribute, and optionally an indication of whether to enable or disable sponsored data connectivity within the "sponStatus" attribute set to the applicable value to provide sponsored connectivity information or to update existing sponsored connectivity information. + +If the NF service consumer requests to enable sponsored data connectivity the NF service consumer shall change the "sponStatus" attribute value to "SPONSOR\_ENABLED". + +If the NF service consumer requests to disable sponsored data connectivity the NF service consumer shall provide an indication to disable sponsored data connectivity to the TSCTSF by setting the "sponStatus" attribute to "SPONSOR\_DISABLED". + +To support the usage monitoring of sponsored data connectivity, the NF service consumer may also include in the HTTP PATCH a new or modified "evSubsc" attribute with: + +- the usage thresholds to apply in the "usgThres" attribute; and +- an entry of the "events" attribute set to "USAGE\_REPORT". + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.3.2. + +As result of this action, the TSCTSF shall provision the updated sponsored data connectivity information to the PCF as described in 3GPP TS 29.514 [20]. + +#### 5.3.2.3.8 Modification of AF requested QoS for a UE or group of UE(s) not identified by UE address + +When the "GMEC" feature is supported, the NF service consumer shall use the HTTP PATCH method to modify the requested QoS, traffic characteristics information and/or QoS Monitoring information for a UE or a group of UE(s). + +The NF service consumer shall include in the HTTP PATCH request message the parameters to modify as described in clause 5.3.2.3.2, with the following differences: + +- To support the request the modification of requested QoS, the traffic characteristics and monitoring of performance characteristics for a group, the NF service consumer may modify: + +- the traffic characteristics information, within the "evSubsc" attribute; +- the QoS parameters for monitoring, within the "tscQosReq" attribute; +- the QoS parameters, within either the "qosReference" attribute, the "altQosReferences" attribute or the "altQosReqs" attribute; +- the temporal invalidity conditions, within the "tempInvalidity" attribute; and +- the flow description, within either the "flowInfo" attribute or the "enEthFlowInfo" attribute. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.3.2. + +As result of this action, the TSCTSF shall, for the list of matching AF-session(s) associated to the "Individual TSC Application Session Context" resource, provision to the PCF the updated requested QoS, traffic characteristics and/or QoS Monitoring information by the triggering Npcf\_PolicyAuthorization\_Update service operation as defined in 3GPP TS 29.514 [20]. + +### 5.3.2.3.9 Modification of Subscription to BAT offset notification + +When the "EnTSCAC" feature is supported, this procedure is used to modify in the TSCTSF the subscription to the BAT offset information notification. + +The NF service consumer shall use the HTTP PATCH method to update the "Events Subscription" sub-resource together with the modifications to the " Individual TSC Application Session" resource. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 5.3.2.3.2, the updated event subscription information within the "evSubsc" attribute. Within the EventsSubscReqDataRm data type, the NF service consumer shall include the "events" attribute with the "BAT\_OFFSET\_INFO" to indicate the subscription to changes of the BAT offset and the optionally adjusted periodicity. + +As result of this action, the TSCTSF shall set the appropriate subscription to resources allocation outcome as described in 3GPP TS 29.514 [20]. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.3.2. The TSCTSF shall include the "evsNotif" attribute with an entry in the "evNotifs" array with the "event" attribute set to "BAT\_OFFSET\_INFO" and the "batOffsetInfo" attribute including the offset of the BAT and optionally an adjusted periodicity if the TSCTSF has previously subscribed with the PCF to changes in this information. + +### 5.3.2.4 Ntsctsf\_QoSandTSCAssistance\_Delete + +#### 5.3.2.4.1 General + +This service operation is used by an NF service consumer to request the network to delete the AF session with requested QoS or the AF session with requested QoS including Alternative Service Requirements. + +The following procedures using the Ntsctsf\_QoSandTSCAssistance\_Delete service operation are supported: + +- TSC AF application session context termination. +- Reporting usage for sponsored data connectivity. +- TSC AF application session context termination for a UE or group of UE(s) not identified by UE address. + +#### 5.3.2.4.2 TSC AF application session context termination + +This procedure is used to terminate an AF application session context for the service as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [19]. + +Figure 5.3.2.4.2-1 illustrates the application session context termination. + +![Sequence diagram showing application session context termination between an NF service consumer and a TSCTSF. Step 1: POST /tsc-app-sessions/{appSessionId}/delete from consumer to TSCTSF. Step 2: Response from TSCTSF to consumer, either 2a. '200 OK' or 2b. '204 No Content'.](8e80de0cac529b2c3775d677c5203133_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. POST « /tsc-app-sessions/{appSessionId}/delete » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2a. "200 OK" +2b. "204 No Content" + TSCTSF-->>NF service consumer: Response + +``` + +Sequence diagram showing application session context termination between an NF service consumer and a TSCTSF. Step 1: POST /tsc-app-sessions/{appSessionId}/delete from consumer to TSCTSF. Step 2: Response from TSCTSF to consumer, either 2a. '200 OK' or 2b. '204 No Content'. + +**Figure 5.3.2.4.2-1: Application session context termination** + +When a TSC AF session is terminated, and if the TSC AF application session context was created as described in clause 5.3.2.2, the NF service consumer shall invoke the Ntscsf\_QoSandTSCAssistance\_Delete service operation to the TSCTSF using an HTTP POST request, as shown in figure 5.3.2.4.2-1, step 1. + +The NF service consumer shall set the request URI to + "{apiRoot}/ntscsf-qos-tscai/{apiVersion}/tsc-app-sessions/{appSessionId}/delete". + +The NF service consumer may include in the body of the HTTP POST the "EventsSubscReqData" data type with the "evSubsc" attribute indicating the corresponding list of events to subscribe to. + +When the TSCTSF receives the HTTP POST request from the NF service consumer, indicating the termination of the TSC AF application session context information, the TSCTSF shall acknowledge that request by sending an HTTP response message with the corresponding status code. + +If the HTTP POST request from the NF service consumer is accepted, the TSCTSF shall send to the NF service consumer: + +- if event information is reported, TSCTSF shall defer sending the response to the NF service consumer and shall immediately interact with the PCF to terminate the AF session with the event report, as specified in 3GPP TS 29.514 [20]. After receiving the event information from the PCF, the TSCTSF shall send a "200 OK" response to HTTP POST request, as shown in figure 5.3.2.4.2-1, step 2a, including in the "EventsNotification" to report to the NF service consumer; +- otherwise, the TSCTSF shall send to the NF service consumer a "204 No Content". + +If the TSCTSF cannot successfully fulfil the received HTTP POST request due to the internal TSCTSF error or due to the error in the HTTP POST request, the TSCTSF shall send the HTTP error response as specified in clause 6.2.7. + +If the TSCTSF determines the received HTTP POST request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +#### 5.3.2.4.3 Reporting usage for sponsored data connectivity + +When The NF service consumer indicated to enable sponsored data connectivity and the NF service consumer provided usage thresholds for such sponsor to the TSCTSF, the TSCTSF shall report accumulated usage to the NF service consumer using the response of the Ntscsf\_QoSandTSCAssistance\_Delete service operation. + +This procedure is initiated when: + +- the "Individual TSC Application Session" is deleted by the NF service consumer; or +- the TSCTSF requests the deletion of the "Individual TSC Application Session" to the NF service consumer, as described in clause 5.2.2.5.3, due to PDU session termination, the termination of all the service data flows of the Individual TSC Application Session. + +To report the accumulated usage, the TSCTSF shall immediately configure the PCF to retrieve the accumulated usage as specified in 3GPP TS 29.514 [20]. When the TSCTSF receives the usage information from the PCF, the TSCTSF shall notify the NF service consumer by including the "EventsNotification" data type in the response of the HTTP POST request as described in clause 5.3.2.4.2. + +The TSCTSF shall within an instance of "events" attribute include: + +- "USAGE\_REPORT" within the "event" attribute; +- accumulated usage within the "usgRep" attribute. + +#### 5.3.2.4.4 TSC AF application session context termination for a UE or group of UE(s) not identified by UE address + +When the "GMEC" feature is supported, the NF service consumer shall use the HTTP POST method to terminate the requested QoS, traffic characteristics information and/or QoS Monitoring information for a UE or a group of UE(s) as described in clause 5.3.2.4.2 with the following differences: + +- the TSCTSF shall identify the affected AF session(s) and, for each AF session, interact with the PCF by triggering the Npcf\_PolicyAuthorization\_Delete service operation as defined in 3GPP TS 29.514 [20], if the AF session is not associated with an "Individual Time Synchronization Exposure Subscription" resource. + +#### 5.3.2.5 Ntsctsf\_QoSandTSCAssistance\_Notify + +##### 5.3.2.5.1 General + +The Ntsctsf\_QoSandTSCAssistance\_Notify service operation enables notification to NF service consumers that the previously subscribed event for the existing TSC application session context occurred or that the TSC application session context is no longer valid. + +The following procedures using the Ntsctsf\_QoSandTSCAssistance\_Notify service operation are supported: + +- Notification about TSC application session context event. +- Notification about TSC application session context termination. +- Notification about Service Data Flow QoS notification control. +- Notification about Service Data Flow Deactivation +- Notification about resources allocation outcome. +- Notification about Service Data Flow QoS Monitoring control. +- Reporting usage for sponsored data connectivity. +- Notification about AF requested QoS for a UE or group of UE(s) not identified by UE address. +- Notification about BAT offset. + +##### 5.3.2.5.2 Notification about TSC application session context event + +This procedure is invoked by the TSCTSF to notify the NF service consumer when a certain, previously subscribed, application session context event occurs, as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [19]. + +Figure 5.3.2.5.2-1 illustrates the notification about TSC application session context event. + +![Sequence diagram showing notification about application session context event between NF service consumer and TSCTSF.](be3e5fe8be7cc5a74f67a4b8ac93193d_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of TSCTSF: 1. POST « {/notifUri}/notify + TSCTSF->>NF service consumer: 1. POST « {/notifUri}/notify + Note left of NF service consumer: 2. "204 No Content" + NF service consumer-->>TSCTSF: 2. "204 No Content" +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and a TSCTSF. The first message, labeled '1. POST « {/notifUri}/notify', is sent from the TSCTSF to the NF service consumer. The second message, labeled '2. "204 No Content"', is sent from the NF service consumer back to the TSCTSF. + +Sequence diagram showing notification about application session context event between NF service consumer and TSCTSF. + +**Figure 5.3.2.5.2-1: Notification about application session context event** + +When the TSCTSF determines that the event for the existing TSC AF application session context, to which the NF service consumer has subscribed to, occurred e.g. upon reception of an event notification for a PDU session from the PCF as described in 3GPP TS 29.514 [20], the TSCTSF shall invoke the Ntsctsf\_QoSAndTSCAssistance\_Notify service operation by sending the HTTP POST request (as shown in figure 5.3.2.5.2-1, step 1) to the NF service consumer using the notification URI received in the subscription creation (or modification), as specified in clause 5.3.2.2.2, 5.3.2.3.2, and 5.3.2.6, and appending the "notify" segment path at the end of the URI. The TSCTSF shall provide in the body of the HTTP POST request the "EventsNotification" data type including: + +- the notification correlation Id within the "notifCorreId"; and +- the list of the reported events in the "events" attribute. + +The NF service consumer notification of other specific events using the Ntsctsf\_QoSAndTSCAssistance\_Notify request is described in the related clauses. + +Upon the reception of the HTTP POST request from the TSCTSF indicating that the PDU session and/or service related event occurred, the NF service consumer shall acknowledge that request by sending an HTTP response message with the corresponding status code. + +If the HTTP POST request from the TSCTSF is accepted, the NF service consumer shall acknowledge the receipt of the event notification with a "204 No Content" response to HTTP POST request, as shown in figure 5.3.2.5.2-1, step 2. + +If the HTTP POST request from the TSCTSF is not accepted, the NF service consumer shall indicate in the response to HTTP POST request the cause for the rejection as specified in clause 6.2.7. + +If the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +### 5.2.2.5.3 Notification about TSC application session context termination + +This procedure is invoked by the TSCTSF to notify the NF service consumer that the TSC application session context is no longer valid, as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [19]. + +Figure 5.2.2.5.3-1 illustrates the notification about application session context termination. + +![Sequence diagram showing the notification about TSC application session context termination between an NF service consumer and a TSCTSF. Step 1: The TSCTSF sends a POST request to the NF service consumer with the URI '{notifUri}/terminate'. Step 2: The NF service consumer responds with a '204 No Content' status code.](a003ffe7299e0a48bceb7f1e45a4f1a3_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of TSCTSF: 1. POST « {notifUri}/terminate » + TSCTSF->>NF service consumer: Request + Note left of NF service consumer: 2. "204 No Content" + NF service consumer->>TSCTSF: Response + +``` + +Sequence diagram showing the notification about TSC application session context termination between an NF service consumer and a TSCTSF. Step 1: The TSCTSF sends a POST request to the NF service consumer with the URI '{notifUri}/terminate'. Step 2: The NF service consumer responds with a '204 No Content' status code. + +**Figure 5.2.2.5.3-1: Notification about TSC application session context termination** + +When the TSCTSF determines that the TSC application session context is no longer valid, the TSCTSF shall invoke the Ntscsfsf\_QoSAndTSCAssistance\_Notify service operation by sending the HTTP POST request (as shown in figure 5.2.2.5.3-1, step 1) using the notification URI received in the "Individual TSC Application Session Context" context creation, as specified in clause 5.3.2.2, and appending the "terminate" segment path at the end of the URI, to trigger the NF service consumer to request the TSC application session context termination (see clause 5.3.2.4.2). The TSCTSF shall provide in the body of the HTTP POST request the "TerminationInfo" data type including: + +- the Individual TSC Application Session Context resource identifier related to the termination notification in the "resUri" attribute; and +- the TSC application session context termination cause in the "termCause" attribute. + +Upon the reception of the HTTP POST request from the TSCTSF requesting the TSC application session context termination, the NF service consumer shall acknowledge that request by sending an HTTP response message with the corresponding status code. + +If the HTTP POST request from the TSCTSF is accepted, the NF service consumer shall acknowledge the receipt of the TSC application session context termination request with a "204 No Content" response to HTTP POST request (as shown in figure 5.2.2.5.3-1, step 2) and shall invoke the Ntscsfsf\_QoSAndTSCAssistance\_Delete service operation to the TSCTSF as described in clause 5.3.2.4. + +If the HTTP POST request from the TSCTSF is not accepted, the NF service consumer shall indicate in the response to HTTP POST request the cause for the rejection as specified in clause 6.2.7. + +If the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +#### 5.3.2.5.4 Notification about Service Data Flow QoS notification control + +When the TSCTSF receives the notification about Service Data Flow QoS notification control from the PCF as described in 3GPP TS 29.514 [20], the TSCTSF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed as described in clauses 5.3.2.2.3 and 5.3.2.3.3. + +The TSCTSF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 5.3.2.5.2. + +The TSCTSF shall within an instance of "events" attribute include: + +- "QOS\_GUARANTEED" or "QOS\_NOT\_GUARANTEED" within the "event" attribute; +- the identification of the affected service flows (if not all the flows are affected) encoded in the "flowIds" attribute if applicable; and + +- the reference to the Alternative Service Requirement corresponding alternative QoS parameter set if received from the PCF within the "appliedQosRef" attribute. When the "appliedQosRef" attribute is omitted and the "event" attribute is QOS\_NOT\_GUARANTEED, it indicates that the lowest priority alternative QoS profile could not be fulfilled. + +When the "AltQoSProfilesSupportReport" feature as defined in clause 6.2.8 is supported, and the NF service consumer included the "altQosReferences" attribute for the provided QoS reference, or the "AltQosReqs" attribute for the provided individual QoS parameter set, if the TSCTSF receives from the PCF the indication that the GBR QoS targets cannot be guaranteed and the indication that alternative QoS profiles are not supported in the NG-RAN where the UE is currently located as specified in 3GPP TS 29.514 [20], the TSCTSF may include within the EventNotification data structure the "altQosNotSuppInd" attribute set to true. When the Alternative QoS profiles are supported by the NG-RAN where the UE is currently located, the TSCTSF may omit or set the "altSerReqNotSuppInd" attribute to false, as indicated by the PCF. + +#### 5.3.2.5.5 Notification about Service Data Flow Deactivation + +When the TSCTSF receives the notification about service data flow deactivation from the PCF as described in 3GPP TS 29.514 [20], the TSCTSF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed as described in clauses 5.3.2.2.4 and 5.3.2.3.4. + +The TSCTSF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 5.3.2.5.2. + +The TSCTSF shall within an instance of "events" attribute include: + +- "FAILED\_RESOURCES\_ALLOCATION" within the "event" attribute; +- the identification of the affected service flows (if not all the flows are affected) encoded in the "flowIds" attribute if applicable. + +#### 5.3.2.5.6 Notification about resources allocation outcome + +When the TSCTSF receives the notification about resources allocation outcome from the PCF as described in 3GPP TS 29.514 [20], the TSCTSF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed as described in clauses 5.3.2.2.5 and 5.3.2.3.5. + +The TSCTSF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 5.3.2.5.2. + +The TSCTSF shall within an instance of "events" attribute include: + +- "SUCCESSFUL\_RESOURCES\_ALLOCATION" within the "event" attribute if the "SUCCESSFUL\_RESOURCES\_ALLOCATION" event is received from the PCF or "FAILED\_RESOURCES\_ALLOCATION" within the "event" attribute if the "FAILED\_RESOURCES\_ALLOCATION" event is received from the PCF; +- the identification of the affected service flows (if not all the flows are affected) encoded in the "flowIds" attribute if applicable. +- when the event is "SUCCESSFUL\_RESOURCES\_ALLOCATION", the reference to the Alternative Service Requirement corresponding alternative QoS parameter set if received from the PCF within the "appliedQosRef" attribute. + +#### 5.3.2.5.7 Notification about Service Data Flow QoS Monitoring control + +When the TSCTSF receives the notification about Service Data Flow QoS Monitoring control from the PCF as described in 3GPP TS 29.514 [20], the TSCTSF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed as described in clauses 5.3.2.2.6 and 5.3.2.3.6. + +The PCF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 5.3.2.5.2. + +The TSCTSF shall within an instance of "events" attribute include: + +- "QOS\_MONITORING" within the "event" attribute; +- the identification of the affected service flows (if not all the flows are affected) encoded in the "flowIds" attribute if applicable; and +- the "qosMonReports" array with the monitored QoS information. For QoS monitoring for packet delay: + - a) one or two uplink packet delays within the "ulDelays" attribute; + - b) one or two downlink packet delays within the "dlDelays" attribute; and/or + - c) one or two round trip packet delays within the "rtDelays" attribute; and + - d) if the feature "PacketDelayFailureReport" is supported, the packet delay measurement failure indicator within "pdmf" attribute. + +#### 5.3.2.5.8 Reporting usage for sponsored data connectivity + +When the NF service consumer enabled sponsored data connectivity and the NF service consumer provided usage thresholds for such sponsor to the TSCTSF, the TSCTSF shall report accumulated usage to the NF service consumer using the Npcf\_PolicyAuthorization\_Notify service operation when: + +- the TSCTSF detects that the usage threshold provided by the NF service consumer has been reached; or +- the NF service consumer disables the sponsored data connectivity. + +The TSCTSF shall notify the NF service consumer of the accumulated usage by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 5.3.2.5.2. + +The TSCTSF shall within an instance of "events" attribute include: + +- "USAGE\_REPORT" within the "event" attribute; +- accumulated usage within the "usgRep" attribute. + +When the NF service consumer receives the HTTP POST request, it shall acknowledge the request by sending a "204 No Content" response to the TSCTSF. The NF service consumer may terminate the Individual Application Session Context sending an HTTP POST as described in clause 5.3.2.4.2 or update the Individual Application Session Context information by providing a new usage threshold sending an HTTP PATCH request to the TSCTSF as described in clause 5.3.2.3.2 or an HTTP PUT request to the TSCTSF as described in clause 5.3.2.6.2. + +#### 5.3.2.5.9 Notification about AF requested QoS for a UE or group of UE(s) not identified by UE address. + +When the TSCTSF receives a notification about the requested QoS, traffic characteristics information and/or QoS Monitoring information from the PCF as described in 3GPP TS 29.514 [20] for an AF-session associated with an existing "Individual TSC Application Session Context" resource, the TSCTSF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed as described in clauses 5.3.2.2.8 and 5.3.2.3.8. + +The TSCTSF shall notify the NF service consumer by including the EventsNotification data type in the body of the HTTP POST request as described in clause 5.3.2.5.2. The TSCTSF notification of the specific events is described in the related clauses of the current specification (e.g. notification about service data flow QoS monitoring when the AF requested QoS for a UE or group of UE(s) as described in clause 5.3.2.5.7). + +#### 5.3.2.5.10 Notification about BAT offset + +When the TSCTSF receives the notification about network provided BAT offset from the PCF as described in 3GPP TS 29.514 [20], the TSCTSF shall inform the NF service consumer accordingly if the NF service consumer included the capability for BAT adaptation or a BAT window or the periodicity range as described in the clauses 5.3.2.2.8 and 5.3.2.3.8. + +The PCF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 5.3.2.5.2. + +The TSCTSF shall include: + +- in the "events" attribute an entry with the "event" attribute set to "BAT\_OFFSET\_INFO"; and +- the "batOffsetInfo" attribute containing the offset of the BAT and the optionally adjusted periodicity. The "BatOffsetInfo" data type shall contain the BAT offset of the arrival time in the "ranBatOffsetNotif" attribute, and the optionally adjusted periodicity of the data bursts encoded in the "adjPeriod" attribute. + +### 5.3.2.6 Ntscsf\_QoSandTSCAssistance\_Subscribe + +#### 5.3.2.6.1 General + +The Ntscsf\_QoSandTSCAssistance\_Subscribe service operation enables NF service consumers handling of subscription to events for the existing TSC application session context. Subscription to events shall be created: + +- within the application session context establishment procedure by invoking the Ntscsf\_QoSandTSCAssistance\_Subscribe service operation, as described in clause 5.3.2.2; or +- within the TSC application session context modification procedure by invoking the Ntscsf\_QoSandTSCAssistance\_Subscribe service operation, as described in clause 5.3.2.3; or +- by invoking the Ntscsf\_QoSandTSCAssistance\_Subscribe service operation for the existing TSC application session context, as described in clause 5.3.2.6.2. + +The following procedures using the Ntscsf\_QoSandTSCAssistance\_Subscribe service operation is supported: + +- Handling of subscription to events for the existing TSC application session context. +- Subscription to Service Data Flow QoS Monitoring Information. +- Subscription to Usage Monitoring of Sponsored Data Connectivity. + +#### 5.3.2.6.2 Handling of subscription to events for the existing TSC application session context + +This procedure is used to create a subscription to events for the existing TSC AF application session context bound to the corresponding PDU session or to modify an existing subscription, as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [19]. + +Figure 5.3.2.6.2-1 illustrates the creation of events subscription information using HTTP PUT method. + +![Sequence diagram showing the creation of events subscription information using HTTP PUT method. The NF service consumer sends a PUT request to the TSCTSF, and the TSCTSF responds with a 201 Created status.](4b8c5ecb492fd759c766fe8950fafe67_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. PUT « /tsc-app-sessions/{appSessionId}/events-subscription » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2. "201 Created" + TSCTSF-->>NF service consumer: Response +``` + +Sequence diagram showing the creation of events subscription information using HTTP PUT method. The NF service consumer sends a PUT request to the TSCTSF, and the TSCTSF responds with a 201 Created status. + +Figure 5.3.2.6.2-1: Creation of events subscription information using HTTP PUT + +Figure 5.3.2.6.2-2 illustrates the modification of events subscription information using HTTP PUT method. + +![Sequence diagram showing the modification of events subscription information using HTTP PUT. The NF service consumer sends a PUT request to the TSCTSF. The TSCTSF responds with either a 204 No Content or a 200 OK.](40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. PUT « /tsc-app-sessions/{appSessionId}/events-subscription » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2a. "204 No Content" +2b. "200 OK" + TSCTSF-->>NF service consumer: Response + +``` + +Sequence diagram showing the modification of events subscription information using HTTP PUT. The NF service consumer sends a PUT request to the TSCTSF. The TSCTSF responds with either a 204 No Content or a 200 OK. + +**Figure 5.3.2.6.2-2: Modification of events subscription information using HTTP PUT** + +When the NF service consumer decides to create a subscription to one or more events for the existing TSC application session context or to modify an existing subscription previously created by itself at the TSCTSF, the NF service consumer shall invoke the Ntsetcf\_QoSAndTSCAssistance\_Subscribe service operation by sending the HTTP PUT request to the resource URI representing the "Events Subscription" sub-resource in the TSCTSF, as shown in figure 5.3.2.6.2-1, step 1 and figure 5.3.2.6.2-2, step 1. The NF service consumer shall provide in the "EventsSubscReqData" data type of the body of the HTTP PUT request: + +- the "events" attribute with the list of events to be subscribed; +- the "notifUri" attribute that includes the Notification URI to indicate to the TSCTSF where to send the notification of the subscribed events; +- the notification correlation Id within the "notifCorreId" attribute; and +- the specific event information related to the subscribed event, e.g. QoS monitoring information within the "qosMon" attribute if the "QOS\_MONITORING" event is subscribed. + +NOTE: The "notifUri" attribute within the EventsSubscReqData data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +Upon the reception of the HTTP PUT request from the NF service consumer, the TSCTSF shall decide whether the received HTTP PUT request is accepted. + +If the TSCTSF accepted the HTTP PUT request to create a subscription to events, the TSCTSF shall create the "Events Subscription" sub-resource and shall send the HTTP response message to the NF service consumer as shown in figure 5.3.2.6.2-1, step 2. The TSCTSF shall include in the "201 Created" response: + +- a Location header field that shall contain the URI of the created "Events Subscription" sub-resource i.e. "{apiRoot}/ntsetcf-qos-tscai//tsc-app-sessions/{appSessionId}/events-subscription"; and +- a response body with the "EventsSubscReqData" data type representing the created "Events Subscription" sub-resource. + +If the TSCTSF accepted the HTTP PUT request to modify the events subscription, the TSCTSF shall modify the "Events Subscription" sub-resource and shall send to the NF service consumer: + +- the HTTP "204 No Content" response (as shown in figure 5.3.2.6.2-2, step 2a); or +- the HTTP "200 OK" response (as shown in figure 5.3.2.6.2-2, step 2b) including in the "EventsSubscReqData" data type the updated representation of the "Events Subscription" sub-resource. + +If the HTTP PUT request from the NF service consumer is not accepted, the TSCTSF shall indicate in the response to HTTP POST request the cause for the rejection as specified in clause 6.2.7. + +If the TSCTSF determines the received HTTP PUT request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +### 5.3.2.6.3 Subscription to Service Data Flow QoS Monitoring Information + +This procedure is used by NF service consumer to subscribe and/or modify the subscription for notification about service data flow QoS monitoring information. + +The NF service consumer shall include in the HTTP PUT request message the "EventsSubscReqData" data type, which shall contain: + +- to create a subscription to QoS monitoring information: + - the "events" attribute with an entry containing the value "QOS\_MONITORING" to create a subscription to notification about service data flow QoS monitoring information; + - include the updated QoS monitoring information within the "qosMon" attribute as defined in clause 5.3.2.2.6 +- to remove a subscription to QoS monitoring information: + - the "events" attribute containing an array that omits the values "QOS\_MONITORING". + +The NF service consumer shall include other events related information as described in clause 5.3.2.6.1. + +As result of this action, the TSCTSF shall set the appropriate subscription to service data flow QoS monitoring information as described in in 3GPP TS 29.514 [20]. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.6.1. + +### 5.3.2.6.4 Subscription to Usage Monitoring of Sponsored Data Connectivity + +This procedure is used by NF service consumer to subscribe and/or modify the subscription for notification about usage monitoring of sponsored data connectivity. + +The NF service consumer shall include in the HTTP PUT request message the "EventsSubscReqData" data type, which shall contain: + +- to create a subscription to usage monitoring of sponsored data connectivity: + - the "events" attribute with an entry containing the value "USAGE\_REPORT" to create a subscription to notification about usage monitoring of sponsored data connectivity; + - include the usage thresholds to apply in the "usgThres" attribute. +- to remove a subscription to usage monitoring of sponsored data connectivity: + - the "events" attribute containing an array that omits the values "USAGE\_REPORT". + +The NF service consumer shall include other events related information as described in clause 5.3.2.6.1. + +As result of this action, the TSCTSF shall set the appropriate subscription to usage monitoring of sponsored data connectivity as described in in 3GPP TS 29.514 [20]. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.6.1. + +## 5.3.2.7 Ntsctsf\_QoSandTSCAssistance\_Unsubscribe + +### 5.3.2.7.1 General + +The Ntsctsf\_QoSandTSCAssistance\_Unsubscribe service operation enables NF service consumers to remove subscription to all subscribed events for the existing TSC application session context. Subscription to events shall be removed: + +- by invoking the Ntsctsf\_QoSandTSCAssistance\_Unsubscribe service operation for the existing application session context, as described in clause 5.3.2.7.2; or +- within the application session context modification procedure by invoking the Ntsctsf\_QoSandTSCAssistance\_Update service operation, as described in clause 5.3.2.3; or + +- within the TSC application session context termination procedure by invoking the Ntsctsf\_QoSandTSCAssistance\_Delete service operation, as described in clause 5.3.2.4. + +The following procedure using the Ntsctsf\_QoSandTSCAssistance\_Unsubscribe service operation is supported: + +- Unsubscription to events. + +#### 5.3.2.7.2 Unsubscription to events + +This procedure is used to unsubscribe to all subscribed events for the existing TSC AF application session context, as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [19]. + +Figure 5.3.2.7.2-1 illustrates the unsubscription to events using the HTTP DELETE method. + +![Sequence diagram showing the removal of events subscription information using HTTP DELETE. The NF service consumer sends a DELETE request to the TSCTSF, and the TSCTSF responds with a 204 No Content.](9e4f582a5d5f6742d1372956db0f8f0b_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note left of NF service consumer: + NF service consumer->>TSCTSF: 1. DELETE « /tsc-app-sessions/{appSessionId}/events-subscription » + Note right of TSCTSF: + TSCTSF-->>NF service consumer: 2. "204 No Content" +``` + +Sequence diagram showing the removal of events subscription information using HTTP DELETE. The NF service consumer sends a DELETE request to the TSCTSF, and the TSCTSF responds with a 204 No Content. + +**Figure 5.3.2.7.2-1: Removal of events subscription information using HTTP DELETE** + +When the NF service consumer decides to unsubscribe to all subscribed events for the existing TSC application session context, the NF service consumer shall invoke the Ntsctsf\_QoSandTSCAssistance\_Unsubscribe service operation by sending the HTTP DELETE request message to the resource URI representing the "Events Subscription" sub-resource in the TSCTSF, as shown in figure 5.3.2.7.2-1, step 1. + +Upon the reception of the HTTP DELETE request message from the NF service consumer, the TSCTSF shall decide whether the received HTTP request message is accepted. + +If the HTTP DELETE request message from the NF service consumer is accepted, the TSCTSF shall delete "Events Subscription" sub-resource and shall send to the NF service consumer a HTTP "204 No Content" response message. The TSCTSF may delete the existing subscription to event notifications for the related PDU session from the PCF as described in 3GPP TS 29.514 [20]. + +If the HTTP DELETE request from the NF service consumer is not accepted, the TSCTSF shall indicate in the response to HTTP DELETE request the cause for the rejection as specified in clause 6.2.7. + +If the TSCTSF determines the received HTTP DELETE request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +## 5.4 Ntsctsf\_ASTI Service + +### 5.4.1 Service Description + +#### 5.4.1.1 Overview + +This service provides: + +- Authorization of NF Service Consumer requests for the activation, update, and deactivation of the 5G access stratum time distribution. + +NOTE: The AF can use either the procedure specified in bullet 1) and 2) of clause 5.2.1.1 for configuring the (g)PTP instance in 5GS or the procedure specified in Ntscstf\_ASTI service for controlling the 5G access stratum time distribution for a particular UE. The procedures are not intended to be used in conjunction. + +- Detection and reporting of time synchronization service status based on gNB and/or UPF/NW-TT timing synchronization status information and reporting status updates. +- Detection and reporting of changes of the state of 5G access time distribution configuration based e.g. on evaluation of the time synchronization coverage area conditions. + +## 5.4.1.2 Network Functions + +### 5.4.1.2.1 TSCTSF + +The TSCTSF supports to: + +- receive the request to activate or update the 5G access stratum time distribution configuration from the NEF or AF and provide it for the target UE(s) to the PCF; +- receive the request to delete the 5G access stratum time distribution configuration from the NEF or AF and provide it for the target UE(s) to the PCF; +- receive the request to query the status of the access stratum time distribution from the NEF or AF and respond to the NEF or AF with the status of the access stratum time distribution; +- make a translation from External/Internal Group Identifier to a list of SUPI by querying UDM; +- retrieve the Time Synchronization Subscription data from UDM for the control of 5G access stratum-based time distribution and make decision based on received the Time Synchronization Subscription data; +- determine whether the UE is inside/outside the requested time synchronization coverage area and enforce the 5G access stratum time distribution service accordingly; +- indicate whether the service is supported or not as per the requested acceptance criteria (e.g., based on the known timing synchronization status attribute thresholds pre-configured at gNB); and +- based on gNB and/or UPF/NW-TT timing synchronization status (degradation/failure/improvement) information and reporting, provide a notification when there is a service status update if the NEF or AF subscribe to service status updates. + +### 5.4.1.2.2 NF Service Consumers + +The NF service consumer supports to: + +- send the request to create, modify and delete the 5G access stratum time distribution configuration to the TSCTSF; +- query the status of the access stratum time distribution configuration; +- provide clock quality reporting control information, consisting of clock quality detail level and clock quality acceptance criteria, during activation or modification of time synchronization service; +- subscribe to time synchronization service status for the target UE(s); and +- receive notifications about the state and changes of state of 5G access stratum time distribution configuration. + +## 5.4.2 Service Operations + +### 5.4.2.1 Introduction + +Service operations defined for the Ntscstf\_ASTI service are shown in table 5.4.2.1-1. + +**Table 5.4.2.1-1: Ntsctsf\_ASTI Service Operations** + +| Service Operation Name | Description | Initiated by | +|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| +| Ntsctsf_ASTI_Create | Allows the NF service consumer to create a 5G access stratum time distribution configuration. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_ASTI_Update | Allows the NF service consumer to update a 5G access stratum time distribution configuration. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_ASTI_Delete | Allows the NF service consumer to delete a 5G access stratum time distribution configuration. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_ASTI_Get | Allows the NF service consumer to query the status of the 5G access stratum time distribution configuration. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_ASTI_UpdateNotify | Allows the TSCTSF to notify about the status of the 5G access stratum time distribution and/or changes on the state of 5G access stratum time distribution configuration. | TSCTSF | + +NOTE: The NEF and the AF use the Ntsctsf\_ASTI service in the same way. + +## 5.4.2.2 Ntsctsf\_ASTI\_Create + +### 5.4.2.2.1 General + +This service operation is used by an NF service consumer to create a 5G access stratum time distribution configuration. + +The following procedures using the Ntsctsf\_ASTI\_Create service operation are supported: + +- creating a new configuration. + +### 5.4.2.2.2 Creating a new configuration + +Figure 5.4.2.2.2-1 illustrates the creation of a configuration. + +![Sequence diagram showing the creation of a configuration. An NF service consumer sends a POST request to the TSCTSF, and the TSCTSF responds with a 201 Created status.](15906392337ec83a921988b52f102a44_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. POST « configurations + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2. "201 Created" + TSCTSF-->>NF service consumer: Response + +``` + +Sequence diagram showing the creation of a configuration. An NF service consumer sends a POST request to the TSCTSF, and the TSCTSF responds with a 201 Created status. + +**Figure 5.4.2.2.2-1: Creation of a configuration** + +To create a configuration, the NF service consumer shall send an HTTP POST message to the TSCTSF to the URI "{apiRoot}/ntsctsf-asti//configurations". The HTTP POST message shall include the AccessTimeDistributionData data structure as request body, as shown in figure 5.4.2.2.2-1, step 1. The AccessTimeDistributionData data structure shall include: + +- one of the indication of the UEs to which the 5G access stratum time distribution configuration is requested via: + - identification of a list of individual UEs within the "supis" attribute; or + - identification of a group of UE(s) within the "interGrpId" attribute; + +- identification of a list of individual UEs within the "gpsi" attribute; +- identification of a group of UE(s) within the "exterGrpId" attribute; and +- 5G access stratum time distribution parameters within the "asTimeDisParam" attribute. + +Within the "asTimeDisParam" attribute inside the AccessTimeDistributionData data structure, the NF service consumer: + +- shall include the "asTimeDisEnabled" attribute set to true if the access stratum time distribution via Uu reference point should be activated. Otherwise, if the access stratum time distribution via Uu reference point should be inactive, the "asTimeDisEnabled" attribute may either be omitted or included and set to "false"; +- may include the time synchronization error budget within the "timeSyncErrBdgt" attribute; +- may include the temporal validity condition within the "tempValidity" attribute; and +- may indicate whether and which clock quality information to provide to the UE by including the clock quality detail level in the "clkQltDetLvl" attribute and optionally the clock quality acceptance criteria in the "clkQltAcptCri" attribute, if applicable. + +When the "CoverageAreaSupport" feature is supported, the AccessTimeDistributionData data structure may include the time synchronization coverage area encoded as "covReq" attribute, that contains a list of Tracking Area codes per serving network where the provided access stratum time distribution data applies. + +When the "ASTIConfigReport" feature is supported, to receive notifications about changes in the 5G access stratum time distribution configuration, the NF service consumer shall also provide the notification URI within the "astiNotifUri" attribute and the notification correlation Id within the "astiNotifId" attribute. When the "NetTimeSyncStatus" feature is supported, the NF service consumer may also include the clock quality detail level in the "clkQltDetLvl" attribute and the clock quality acceptance criteria in the "clkQltAcptCri" attribute to indicate the subscription to notification of the status of the access stratum time distribution service. + +Upon receipt of the HTTP request from the NF service consumer, if the request is authorized, the TSCTSF shall: + +- if the 5G access stratum time distribution configuration applies to an internal group of UEs indicated in the "interGrpId" attribute or to an external group of UEs indicated in the "exterGrpId" attribute, interact with the UDM to retrieve the list of individual UEs that belong to the group using the Nudm\_SDM service as defined in 3GPP TS 29.503 [24]; +- if the 5G access stratum time distribution configuration applies to a list of individual UEs within the "gpsi" attribute, interact with the UDM to retrieve the SUPI(s) that corresponds to each of the GPSI(s) using the Nudm\_SDM service as defined in 3GPP TS 29.503 [24]; +- The TSCTSF retrieves the UE's Time Synchronization Subscription data from the UDM for each individual UE. If the UE's Time Synchronization Subscription data contains the authorized Uu time synchronization error budget, and the requested time synchronization error budget within the "timeSyncErrBdgt" attribute is within the authorized time synchronization error budget, the TSCTSF determines that the UE is authorized for the requested time synchronization service. +- if the "CoverageAreaSupport" feature is supported and a time synchronization coverage area is provided within the "covReq" attribute, perform the following operations: + - a. if the Authorized Time Synchronization Coverage Area is inside of the requested Coverage Area, the TSCTSF uses the Authorized Time Synchronization Coverage Area. If the requested Coverage Area partly overlaps with the Authorized Time Synchronization Coverage Area, the TSCTSF uses the intersection of them. If there is no overlap between them, the TSCTSF shall reject the AF request as described in clause 5.27.1.11 of 3GPP TS 23.501 [2]. + - b. the TSCTSF shall discover the list of AMF(s) serving the list of TA(s) that comprise the time synchronization coverage area using the Nnrf\_NFDiscovery service operation as described in 3GPP TS 29.510 [10], if they were not previously retrieved, and: + - c. subscribe with the discovered AMF(s): + +1. for each UE, e.g. when the 5G access stratum time distribution configuration applies to a list of individual UEs, and the UE time synchronization coverage area within the "covReq" attribute is within the authorized time synchronization coverage area; or +2. for the group of UEs, when the 5G access stratum time distribution configuration applies to a group of UEs. + +To receive notifications about presence of the UE in an Area of Interest events using the Namf\_EventExposure service as described in 3GPP TS 29.518 [27], where the Area of Interest is the provided time synchronization coverage area. + +- d. Based on the outcome provided by the AMF about the UE's presence in the Area of Interest and the authorized time synchronization coverage area, the TSCTSF shall determine if the 5G access stratum time distribution configuration is enabled for the UE: + - i. If the UE presence is within any of the TAs from the authorized time synchronization coverage area, the TSCTSF determines that the time synchronization coverage area condition is fulfilled, and the provided 5G access stratum time distribution configuration is enabled for the UE. + - ii. If the UE presence is not within any of the TAs from the time synchronization coverage area, the TSCTSF determines that the time synchronization coverage area condition is not fulfilled, and the provided 5G access stratum time distribution configuration is not enabled for the UE. +- The TSCTSF retrieves the UE's Time Synchronization Subscription data from the UDM for each individual UE. If the UE's Time Synchronization Subscription data contains the periods of authorized start and stop times, and the requested temporal validity condition within the "tempValidity" attribute is within any of the authorized periods of authorized start and stop times, the TSCTSF determines that the UE is authorized for the requested time synchronization service. +- for each authorized UE, subscribe to event notifications of newly registered PCF for the UE by invoking Nbsf\_Management\_Subscribe Service Operation as defined in 3GPP TS 29.521 [23], if not yet subscribed; +- for each authorized UE, if the access stratum time distribution via Uu reference point is being activated (i.e. the "asTimeDisEnabled" attribute within the "asTimeDisParam" attribute was received and set to true), calculate the Uu time synchronization error budget as specified in clauses 5.27.1.9 and 5.27.1.11 of 3GPP TS 23.501 [2]; +- for each authorized UE, if clock quality information was provided, the authorized clock quality detail level within the "clkQltDetLvl" attribute and optionally the clock quality acceptance criteria in the "clkQltAcptCri" attribute, if applicable; +- for each authorized UE, interact with the PCF for a UE to provide the configuration information for each target UE using the Npcf\_AMPolicyAuthorization\_Create service operation as defined in 3GPP TS 29.534 [14]; +- create a new resource, which represents a new "Individual ASTI Configuration" resource, addressed by a URI as defined in clause 6.1.3.7 and containing a TSCTSF created resource identifier; and +- send an HTTP "201 Created" response with AccessTimeDistributionData data structure as response body and a Location header field containing the URI of the created Individual ASTI Configuration resource, i.e. "{apiRoot}/ntscstf-asti//configurations/{configId}", as shown in figure 5.4.2.2.2-1, step 2. + +If for all the affected UEs the provided parameters are not allowed by subscription, the TSCTSF shall indicate in an HTTP "403 Forbidden" response message the "cause" attribute set to "UE\_SERVICE\_NOT\_AUTHORIZED". + +If the TSCTSF cannot successfully fulfil the received HTTP POST request due to the internal TSCTSF error or due to the error in the HTTP POST request, the TSCTSF shall send the HTTP error response as specified in clause 6.3.7. + +### 5.4.2.3 Ntscstf\_ASTI\_Update + +#### 5.4.2.3.1 General + +This service operation is used by an NF service consumer to update a 5G access stratum time distribution configuration. + +The following procedures using the Ntscstf\_ASTI\_Update service operation are supported: + +- Updating an existing configuration. + +### 5.4.2.3.2 Updating an existing configuration + +Figure 5.4.2.3.2-1 illustrates the updating of an existing configuration. + +![Sequence diagram illustrating the update of a configuration. The NF service consumer sends a PUT request to the TSCTSF. The TSCTSF responds with either a 200 OK or a 204 No Content.](4842f073775fb1e84d101c02fd74e59e_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. PUT « configurations/{configId} » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2a. "200 OK" +2b. "204 No Content" + TSCTSF-->>NF service consumer: Response + +``` + +Sequence diagram illustrating the update of a configuration. The NF service consumer sends a PUT request to the TSCTSF. The TSCTSF responds with either a 200 OK or a 204 No Content. + +**Figure 5.4.2.3.2-1: Update of a configuration** + +To update a configuration, the NF service consumer shall send an HTTP PUT request to the resource "{apiRoot}/ntscsf-asti//configurations/{configId}" representing an existing "Individual ASTI Configuration" resource, as shown in figure 5.4.2.3.2-1, step 1, to modify the configuration. + +The AccessTimeDistributionData data structure provided in the request body shall include an updated representation of the "Individual ASTI Configuration" resource with the updated 5G access stratum time distribution configuration information as defined in clause 5.4.2.2.2. + +When the "CoverageAreaSupport" feature is supported, the AccessTimeDistributionData data structure may include the time synchronization coverage area encoded as "covReq" attribute, that may contain an updated list of Tracking Area codes per serving network where the provided access stratum time distribution data applies. + +When the "ASTIConfigReport" feature is supported, to receive notifications about changes in the 5G access stratum time distribution configuration, the NF service consumer shall also provide the notification URI within the "astiNotifUri" attribute and the notification correlation Id within the "astiNotifId" attribute; and/or, when the "NetTimeSyncStatus" feature is supported, the update of the clock quality detail level in the "clkQltDetLvl" attribute and optionally the clock quality acceptance criteria in the "clkQltAcptCri" attribute indicates an update in the subscription to notification of status of the access stratum time distribution service. + +Upon receipt of the corresponding HTTP PUT message, if the request is authorized, the TSCTSF shall: + +- If the "CoverageAreaSupport" feature is supported and an updated time synchronization coverage area is provided within the "covReq" attribute: + - i. discover the list of AMF(s) serving the list of TA(s) that comprise the time synchronization coverage area using the Nnrf\_NFDiscovery service operation as described in 3GPP TS 29.510 [10], if they were not previously retrieved, and; + - ii. update the subscription with the discovered AMF(s), if applicable: + - a. for each affected UE, e.g. when the 5G access stratum time distribution configuration applies to a list of individual UEs and the UE time synchronization coverage area within the "covReq" attribute is within the subscribed time synchronization coverage area; or + - b. for the group of UEs, when the 5G access stratum time distribution configuration applies to a group of UEs. + +to receive notifications about presence of the UE in an Area of Interest events using the Namf\_EventExposure service as described in 3GPP TS 29.518 [27], where the Area of Interest is the provided time synchronization coverage area. + +- iii. Based on the outcome provided by the AMF or the local available information about the UE's presence in the Area of Interest and the authorized time synchronization coverage area, the TSCTSF shall determine if the 5G access stratum time distribution configuration is enabled for the UE: + - i. If the UE presence is within any of the TAs from the authorized time synchronization coverage area, the TSCTSF determines that the time synchronization coverage area condition is fulfilled, and the provided 5G access stratum time distribution configuration is enabled for the UE. + - ii. If the UE presence is not within any of the TAs from the authorized time synchronization coverage area, the TSCTSF determines that the time synchronization coverage area condition is not fulfilled, and the provided 5G access stratum time distribution configuration is not enabled for the UE. +- if the "CoverageAreaSupport" feature is supported and a time synchronization coverage area previously provided is removed: + - 1. terminate the related subscriptions to notifications about presence of the UE in an Area of Interest events using the Namf\_EventExposure service as described in 3GPP TS 29.518 [27]. + - 2. for each UE that did not fulfil the removed time synchronization coverage area, authorize the UE for the 5GS access stratum time distribution configuration. +- if the time synchronization error budget within the "timeSyncErrBdgt" attribute and/or the temporal validity condition within the "tempValidity" attribute from the NF service consumer is provided, updated, or removed, the TSCTSF based on the Time Synchronization Subscription data retrieved from the UDM determines whether the UE is authorized for the request again as described in clause 5.4.2.2.2. +- for each authorized UE, if the access stratum time distribution via Uu reference point is being activated (i.e. the "asTimeDisEnabled" attribute within the "asTimeDisParam" attribute was received and set to true) or a time synchronization error budget for an active access stratum time distribution is provided or updated by the AF, calculate the Uu time synchronization error budget as specified in clause 5.27.1.9 of 3GPP TS 23.501 [2]; +- for each authorized UE, interact with the PCF for a UE to provide the updated configuration information using the Npcf\_AMPolicyAuthorization\_Update service operation as defined in 3GPP TS 29.534 [14]; and +- update the existing "Individual ASTI Configuration" resource. Then the TSCTSF shall send a HTTP response including "200 OK" status code with AccessTimeDistributionData data structure or "204 No Content" status code, as shown in figure 5.4.2.3.2-1, step 2. + +If for all the affected UEs the provided parameters are not allowed by subscription, the TSCTSF shall indicate in an HTTP "403 Forbidden" response message the "cause" attribute set to "UE\_SERIVCE\_NOT\_AUTHORIZED". + +If the TSCTSF cannot successfully fulfil the received HTTP PUT request due to the internal TSCTSF error or due to the error in the HTTP PUT request, the TSCTSF shall send the HTTP error response as specified in clause 6.3.7. + +If the TSCTSF determines the received HTTP PUT request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +#### 5.4.2.4 Ntsctsf\_ASTI\_Delete + +##### 5.4.2.4.1 General + +This service operation is used by an NF service consumer to delete a 5G access stratum time distribution configuration. + +The following procedures using the Ntsctsf\_ASTI\_Delete service operation are supported: + +- Delete an existing configuration. + +##### 5.4.2.4.2 Delete an existing configuration + +Figure 5.4.2.4.2-1 illustrates the deleting of an existing configuration. + +![Sequence diagram showing the deletion of a configuration. An NF service consumer sends a DELETE request for configurations/{configId} to the TSCTSF, which responds with a 204 No Content.](65e8c0628536d6d4245e9ab46ba070c3_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. DELETE « configurations/{configId} » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2. "204 No Content" + TSCTSF-->>NF service consumer: Response +``` + +Sequence diagram showing the deletion of a configuration. An NF service consumer sends a DELETE request for configurations/{configId} to the TSCTSF, which responds with a 204 No Content. + +**Figure 5.4.2.4.2-1: Deletion of a configuration** + +To delete a configuration, the NF service consumer shall send an HTTP DELETE request to the resource "{apiRoot}/ntscts-asti//configurations/{configId}" representing an existing "Individual ASTI Configuration" resource, as shown in figure 5.4.2.4.2-1, step 1, to delete the configuration. + +Upon the reception of an HTTP DELETE request from the NF service consumer, if the HTTP DELETE request is authorized, the TSCTSF shall: + +- interact with the PCF for a UE to remove the configuration information in the PCF by using the Npcf\_AMPolicyAuthorization\_Delete service operation as defined in 3GPP TS 29.534 [14]. +- remove the corresponding configuration and respond with "204 No Content" as shown in figure 5.4.2.4.2-1, step 2. + +If the TSCTSF cannot successfully fulfil the received HTTP DELETE request due to the internal TSCTSF error or due to the error in the HTTP DELETE request, the TSCTSF shall send the HTTP error response as specified in clause 6.3.7. + +If the TSCTSF determines the received HTTP DELETE request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +## 5.4.2.5 Ntscts\_asti\_Get + +### 5.4.2.5.1 General + +This service operation is used by an NF service consumer to retrieve the status of the access stratum time distribution for a list of UEs. + +The following procedures using the Ntscts\_asti\_Get service operation are supported: + +- Retrieve the status of access stratum time distribution. + +### 5.4.2.5.2 Retrieve the status of access stratum time distribution + +Figure 5.4.2.5.2-1 illustrates the retrieval of the status of access stratum time distribution. + +![Sequence diagram showing the retrieval of the status of access stratum time distribution. The NF service consumer sends a POST request to the TSCTSF, and the TSCTSF responds with a 200 OK.](56a5265d174ce056c1dbe5e7a60839fc_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. POST « configurations/retrieve » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2. "200 OK" + TSCTSF-->>NF service consumer: Response + +``` + +Sequence diagram showing the retrieval of the status of access stratum time distribution. The NF service consumer sends a POST request to the TSCTSF, and the TSCTSF responds with a 200 OK. + +**Figure 5.4.2.5.2-1: Retrieval of the status of access stratum time distribution** + +To retrieve the status of access stratum time distribution, the NF service consumer shall send an HTTP POST request to the resource "{apiRoot}/ntscts-asti//configurations/retrieve". The HTTP POST message shall include the StatusRequestData data structure as request body, as shown in figure 5.4.2.5.2-1, step 1. The StatusRequestData data structure shall include: + +- identification of a list of individual UEs within the "supis" attribute; or +- identification of a list of individual UEs within the "gpsi" attribute; + +Upon the reception of an HTTP POST request and if the HTTP POST request is accepted by the TSCTSF, the TSCTSF determines the status of the access stratum time distribution is active for a UE if there is a 5G access stratum time distribution configuration applicable to the UE, i.e., it applies according to the temporal validity, if present, and the access time distribution via Uu reference point is activated; otherwise, the status of the access stratum time distribution is inactive for the UE. + +The TSCTSF shall send an HTTP "200 OK" response with the StatusResponseData data structure as response body, as shown in figure 5.4.2.5.2-1, step 2 to notify of the status. + +Within the StatusResponseData data structure, TSCTSF may include: + +- a list of SUPI(s) whose status of the access stratum time distribution is inactive within the "inactiveUes" attribute or a list of GPSI(s) whose status of the access stratum time distribution is inactive within the "inactiveGpsi" attribute; +- the "activeUes" attribute containing one or more the ActiveUe instances which includes the UE identifier whose status of the access stratum time distribution is active within the "supi" attribute or "gpsi" attribute and the requested time synchronization error budget, if available, within the "timeSyncErrBdgt" attribute. + +If the TSCTSF cannot successfully fulfil the received HTTP POST request due to the internal TSCTSF error or due to the error in the HTTP POST request, the TSCTSF shall send the HTTP error response as specified in clause 6.3.7. + +## 5.4.2.6 Ntscts\_ ASTI\_UpdateNotify + +### 5.4.2.6.1 General + +This service operation is used by the TSCTSF to report about the change of state of the 5G access stratum time distribution configuration and the 5G access stratum time distribution status information. + +The following procedures using the Ntscts\_ ASTI\_UpdateNotify service operation are supported: + +- Notification about the 5G Access Stratum Time Distribution events +- Notification about ASTI configuration changes due to UE presence in time synchronization coverage area. +- Notification about the 5G access stratum time distribution status information. + +#### 5.4.2.6.2 Notification about the 5G access stratum time distribution events + +Figure 5.4.2.6.2-1 illustrates the notification about the 5G access stratum time distribution events. + +![Sequence diagram showing the notification about the 5G access stratum time distribution event. The TSCTSF sends a POST request to the NF service consumer, and the NF service consumer responds with a 204 No Content.](4cd9eeaee1deb05bf88a8abf02ff7d7f_img.jpg) + +``` +sequenceDiagram + participant TSCTSF + participant NF_service_consumer as NF service consumer + Note right of TSCTSF: 1. POST {astiNotifUri} + TSCTSF->>NF_service_consumer: 1. POST {astiNotifUri} + Note left of NF_service_consumer: 2. "204 No Content" + NF_service_consumer-->>TSCTSF: 2. "204 No Content" +``` + +Sequence diagram showing the notification about the 5G access stratum time distribution event. The TSCTSF sends a POST request to the NF service consumer, and the NF service consumer responds with a 204 No Content. + +**Figure 5.4.2.6.2-1: Notification about the 5G access stratum time distribution event** + +The TSCTSF shall invoke the Ntsctsf\_ASTI\_UpdateNotify to report a 5G access stratum time distribution event by sending an HTTP POST request (as shown in figure 5.4.2.6.2-1, step 1) to the NF service consumer using as request URI the notification URI received in the creation (as specified in clause 5.4.2.2.2) or modification (as specified in clause 5.4.2.3.2) of the Individual ASTI Configuration resource, and the AstiConfigNotification data structure as request body. + +The AstiConfigNotification data structure shall include: + +- the notification correlation ID provided by the NF service consumer during the provisioning of 5G access stratum time distribution configuration within the "astiNotifId" attribute; +- the update of the 5G access stratum configuration for the indicated UE(s) within the "stateConfigs" attribute. Within each entry of the "stateConfigs" attribute, the TSCTSF shall include: + - a. the identification of the individual UE within either the "supi" or the "gpsi" attribute; + - b. information about the observed event within the "event" attribute. For each reported event, the additional event information, if applicable. + +The notification of specific events using the Ntsctsf\_ASTI\_UpdateNotify service operation is described in the related clauses. + +If the HTTP POST request from the TSCTSF is not accepted, the NF service consumer shall indicate in the response to HTTP POST request the cause for the rejection as specified in clause 6.3.7. + +If the HTTP POST request from the TSCTSF is accepted, the NF service consumer shall acknowledge the receipt of the event notification with a "204 No Content" response, as shown in figure 5.4.2.6.2-1, step 2. + +If the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +#### 5.4.2.6.3 Notification about ASTI configuration changes due to UE presence in time synchronization coverage area + +If the feature "CoverageAreaSupport" is supported and the TSCTSF received time synchronization coverage area as part of the Ntsctsf\_ASTI\_Create/Update service operation as described in clauses 5.4.2.2.2 and 5.4.2.3.2, when the TSCTSF receives a change in the UE presence in Area of Interest notification as described in 3GPP TS 29.518 [27], the TSCTSF shall determine if the re-evaluation of the time synchronization coverage area shall trigger an activation or deactivation of the access stratum time distribution: + +- If the notification of change of UE presence in Area of Interest indicates that the UE is within any TAs from the time synchronization coverage area, then the TSCTSF shall enable access stratum time distribution for + +the UE. The TSCTSF shall provide the 5G access stratum time distribution configuration to the UE using the Npcf\_AMPolicyAuthorization\_Create service operation as defined in 3GPP TS 29.534 [14]. + +- If the notification of change of UE presence in Area of Interest indicates that the UE is not within any TAs from the time synchronization coverage area, then the TSCTSF shall disable access stratum time distribution for the UE. The TSCTSF shall disable the 5G access stratum time distribution to the UE using the Npcf\_AMPolicyAuthorization\_Update service operation as defined in 3GPP TS 29.534 [14]. + +If the feature "ASTIConfigReport" is supported, the TSCTSF shall invoke the Ntsctsf\_ASTI\_UpdateNotify to report the change of 5G access stratum time distribution configuration as specified in clause 5.4.2.6.2. The "stateConfigs" attribute shall include: + +- the "event" attribute set to "ASTI\_ENABLED" to indicate the 5G access stratum time distribution configuration for the UE is active; or +- the "event" attribute set to "ASTI\_DISABLED" to indicate the 5G access stratum time distribution configuration for the UE is inactive. + +The NF service consumer shall acknowledge or redirect the request as described in clause 5.4.2.6.2. + +#### 5.4.2.6.4 Notification about the 5G access stratum time distribution status information + +If the "NetTimeSyncStatus" feature is supported and the TSCTSF received clock quality acceptance criteria as part of the Ntsctsf\_ASTI\_Create/Update service operation as described in clauses 5.4.2.2.2 and 5.4.2.3.2, when the TSCTSF is aware of 5G access stratum time distribution status information, the TSCTSF shall determine if the UE is impacted or not based on the UE presence in Area of Interest notification as described in clause 4.15.9.5.1 of 3GPP TS 23.502 [3]. + +If the "NetTimeSyncStatus" feature is supported and for the affected UEs, the TSCTSF shall invoke the Ntsctsf\_ASTI\_UpdateNotify to report about the 5G access stratum time distribution status as specified in clause 5.4.2.6.2 and shall include the status of the access stratum time distribution for the targeted UE(s) within the "stateConfigs" attribute as follows: + +- the "event" attribute set to "CLOCK\_QUAL\_ACCEPTABLE" to indicate the clock quality for the ASTI service is fulfilling the clock quality acceptance criteria for the UE; or +- the "event" attribute set to "CLOCK\_QUAL\_NON\_ACCEPTABLE" to indicate the clock quality for the ASTI service is not fulfilling the clock quality acceptance criteria for the UE. Based on this notification, the AF decides whether to modify the ASTI service configured for the UE using the Ntsctsf\_ASTI\_Update service as described in clause 5.4.2.3. + +The NF service consumer shall acknowledge or redirect the request as described in clause 5.4.2.6.2. + +--- + +## 6 API Definitions + +### 6.1 Ntsctsf\_TimeSynchronization Service API + +#### 6.1.1 Introduction + +The Ntsctsf\_TimeSynchronization service shall use the Ntsctsf\_TimeSynchronization API. + +The API URI of the Ntsctsf\_TimeSynchronization API shall be: + +**{apiRoot}** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "ntscts-time-sync". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +## 6.1.2 Usage of HTTP + +### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Ntscts\_TimeSynchronization API is contained in Annex A. + +### 6.1.2.2 HTTP standard headers + +#### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +#### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +In this Release of the specification, no specific custom headers are defined for the Ntscts\_TimeSynchronization API. + +## 6.1.3 Resources + +### 6.1.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.1.3.1-1 depicts the resource URIs structure for the Ntscts\_TimeSynchronization API. + +![A hierarchical diagram showing the resource URI structure of the Ntscts_TimeSynchronization API. The root is {apiRoot}/ntscts-time-sync/. It branches to /subscriptions, which branches to /{subscriptionId}, which branches to /configurations, which finally branches to /{configurationId}.](fcc757566216206ceddbd6c775e8db02_img.jpg) + +{apiRoot}/ntscts-time-sync/ + +``` + +graph TD + Root["{apiRoot}/ntscts-time-sync/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + SubscriptionId --> Configurations["/configurations"] + Configurations --> ConfigurationId["/{configurationId}"] + +``` + +A hierarchical diagram showing the resource URI structure of the Ntscts\_TimeSynchronization API. The root is {apiRoot}/ntscts-time-sync/. It branches to /subscriptions, which branches to /{subscriptionId}, which branches to /configurations, which finally branches to /{configurationId}. + +**Figure 6.1.3.1-1: Resource URI structure of the Ntscts\_TimeSynchronization API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------------------------------------------|------------------------------------------------------------------|---------------------------------|---------------------------------------------------------------------------------------------| +| Time Synchronization Exposure | /subscriptions | POST | Create a new subscription to notification of capability of time synchronization service. | +| Individual Time Synchronization Exposure Subscription | /subscriptions/{subscriptionId} | GET | Read a subscription to notification of capability of time synchronization service. | +| | | PUT | Modify a subscription to notification of capability of time synchronization service. | +| | | DELETE | Delete a subscription to notification of capability of time synchronization service. | +| Time Synchronization Exposure Configurations | /subscriptions/{subscriptionId}/configurations | POST | Create a new configuration to time synchronization exposure. | +| Individual Time Synchronization Exposure Configuration | /subscriptions/{subscriptionId}/configurations/{configurationId} | GET | Read a configuration to time synchronization exposure. | +| | | PUT | Modify all of the properties of an existing configuration to time synchronization exposure. | +| | | DELETE | Delete a configuration to time synchronization exposure. | + +### 6.1.3.2 Resource: Time Synchronization Exposure Subscriptions + +#### 6.1.3.2.1 Description + +This resource allows a NF service consumer to create a new subscription to notification of the capability for time synchronization service. + +#### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/ntscetf-time-sync//subscriptions + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +#### 6.1.3.2.3 Resource Standard Methods + +##### 6.1.3.2.3.1 POST + +The POST method creates a new subscription resource to time synchronization exposure subscription. The NF service consumer shall initiate the HTTP POST request message and the TSCTSF shall respond to the message. The TSCTSF shall construct the URI of the created resource. + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|----------------------------------------------------------------------------------------------------------| +| TimeSyncExposureSubsc | M | 1 | Parameters to request a subscription to notification of the capability for time synchronization service. | + +**Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| TimeSyncExposureSubsc | M | 1 | 201
Created | The subscription was created successfully.
The URI of the created resource shall be returned in the "Location" HTTP header. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +**Table 6.1.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/ntsctsf-time-sync/{apiVersion}/subscriptions/{subscriptionId} | + +#### 6.1.3.2.4 Resource Custom Operations + +None. + +#### 6.1.3.3 Resource: Individual Time Synchronization Exposure Subscription + +##### 6.1.3.3.1 Description + +This resource allows a NF service consumer to read, modify or delete an existing subscription to notification of the capability for time synchronization service. + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/ntsctsf-time-sync/{apiVersion}/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|---------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| subscriptionId | string | Represents a specific subscription. It is the identifier of the Individual Time Synchronization Exposure Subscription resource. | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.1.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------| +| TimeSyncExposureSubsc | M | 1 | 200 OK | An Individual Time Synchronization Exposure Subscription resource is returned successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during an Individual Time Synchronization Exposure Subscription resource retrieval.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during an Individual Time Synchronization Exposure Subscription resource retrieval.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.1.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +#### 6.1.3.3.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.1.3.3.3.2-1. + +**Table 6.1.3.3.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.3.3.2-3. + +**Table 6.1.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The subscription was deleted successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual Time Synchronization Exposure Subscription resource deletion.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual Time Synchronization Exposure Subscription resource deletion.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.1.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +### 6.1.3.3.3.3 PUT + +This method shall support the URI query parameters specified in table 6.1.3.3.3-1. + +**Table 6.1.3.3.3-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3-2 and the response data structures and response codes specified in table 6.1.3.3.3-3. + +**Table 6.1.3.3.3.3-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|----------------------------------------------------------------| +| TimeSyncExposureSubsc | M | 1 | Modify an existing Time Synchronization Exposure Subscription. | + +**Table 6.1.3.3.3.3-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------| +| TimeSyncExposureSubsc | M | 1 | 200 OK | The subscription was updated successfully. | +| n/a | | | 204 No Content | The subscription was updated successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual Time Synchronization Exposure Subscription resource modification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual Time Synchronization Exposure Subscription resource modification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.1.3.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +#### 6.1.3.3.4 Resource Custom Operations + +None. + +### 6.1.3.4 Resource: Time Synchronization Exposure Configurations + +#### 6.1.3.4.1 Description + +This resource allows a NF service consumer to create a new subscription to notification of the capability for time synchronization service. + +#### 6.1.3.4.2 Resource Definition + +Resource URI: {apiRoot}/ntscsf-time-sync//subscriptions/{subscriptionId}/configurations + +This resource shall support the resource URI variables defined in table 6.1.3.4.2-1. + +**Table 6.1.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|---------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| subscriptionId | string | Represents a specific subscription. It is the identifier of the Individual Time Synchronization Exposure Subscription resource. | + +#### 6.1.3.4.3 Resource Standard Methods + +##### 6.1.3.4.3.1 POST + +The POST method creates a new configuration resource to activate time synchronization service. The NF service consumer shall initiate the HTTP POST request message and the TSCTSF shall respond to the message. The TSCTSF shall construct the URI of the created resource. + +This method shall support the URI query parameters specified in table 6.1.3.4.3.1-1. + +**Table 6.1.3.4.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.4.3.1-2 and the response data structures and response codes specified in table 6.1.3.4.3.1-3. + +**Table 6.1.3.4.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|--------------------------------------------------------------------------------| +| TimeSyncExposureConfig | M | 1 | Parameters to create a configuration to activate time synchronization service. | + +**Table 6.1.3.4.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| TimeSyncExposureConfig | M | 1 | 201
Created | The configuration was created successfully.
The URI of the created resource shall be returned in the "Location" HTTP header. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection, during Individual Time Synchronization Exposure Configuration resource creation.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection, during Individual Time Synchronization Exposure Configuration resource creation.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403
Forbidden | (NOTE 3) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +NOTE 3: Failure cases are described in clause 6.1.7. + +**Table 6.1.3.4.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/ntscts-time-sync/{apiVersion}/subscriptions/{subscriptionId}/configuration/{configurationId} | + +**Table 6.1.3.4.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.1.3.4.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +#### 6.1.3.4.4 Resource Custom Operations + +None. + +### 6.1.3.5 Resource: Individual Time Synchronization Exposure Configuration + +#### 6.1.3.5.1 Description + +This resource allows a NF service consumer to modify/cancel a configuration to modify/deactivate Time Synchronization service with the TSCTSF + +#### 6.1.3.5.2 Resource Definition + +Resource URI: {apiRoot}/ntsetsf-time-sync//subscriptions/{subscriptionId}/configurations/{configurationId} + +This resource shall support the resource URI variables defined in table 6.1.3.5.2-1. + +**Table 6.1.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| subscriptionId | string | Represents a specific subscription. It is the identifier of the Individual Time Synchronization Exposure Subscription resource. | +| configurationId | string | Represents a specific configuration. It is the identifier of the Individual Time Synchronization Exposure Configuration resource. | + +#### 6.1.3.5.3 Resource Standard Methods + +##### 6.1.3.5.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.5.3.1-1. + +**Table 6.1.3.5.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.5.3.1-2 and the response data structures and response codes specified in table 6.1.3.5.3.1-3. + +**Table 6.1.3.5.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.5.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------| +| TimeSyncExposureConfig | M | 1 | 200 OK | The configuration information in the request URI are returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual Time Synchronization Exposure Configuration resource retrieval.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual Time Synchronization Exposure Configuration resource retrieval.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.4.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.1.3.4.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +#### 6.1.3.5.3.2 PUT + +This method shall support the URI query parameters specified in table 6.1.3.5.3.2-1. + +**Table 6.1.3.5.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.5.3.2-2 and the response data structures and response codes specified in table 6.1.3.5.3.2-3. + +**Table 6.1.3.5.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|-----------------------------------------------------------------| +| TimeSyncExposureConfig | M | 1 | Modify an existing Time Synchronization Exposure Configuration. | + +**Table 6.1.3.5.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------| +| TimeSyncExposureConfig | M | 1 | 200 OK | The subscription was updated successfully. | +| n/a | | | 204 No Content | The subscription was updated successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual Time Synchronization Exposure Configuration resource update.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual Time Synchronization Exposure Configuration resource update.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 3) | + +NOTE 1: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +NOTE 3: Failure cases are described in clause 6.1.7. + +**Table 6.1.3.5.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.1.3.5.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +#### 6.1.3.5.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.1.3.5.3.3-1. + +**Table 6.1.3.5.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.5.3.3-2 and the response data structures and response codes specified in table 6.1.3.5.3.3-3. + +**Table 6.1.3.5.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 6.1.3.5.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The configuration was deleted successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual Time Synchronization Exposure Configuration resource deletion.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual Time Synchronization Exposure Configuration resource deletion
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.5.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.1.3.5.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +#### 6.1.3.5.4 Resource Custom Operations + +None. + +#### 6.1.4 Custom Operations without associated resources + +Void + +## 6.1.5 Notifications + +### 6.1.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 6.1.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-------------------------------------------------|------------------|---------------------------------|---------------------------------------------------------------------------| +| Time Synchronization Capability Notification | {subsNotifUri} | POST | Time Synchronization Capability Notification for a list of UEs. | +| Time Synchronization Configuration Notification | {configNotifUri} | POST | Current state of Time Synchronization Service configuration Notification. | + +### 6.1.5.2 Time Synchronization Capability Notification + +#### 6.1.5.2.1 Description + +The Time Synchronization Capability Notification is used by the NF service producer to report the capability of the time synchronization service for a list of UEs to a NF service consumer that has subscribed to such Notifications. + +#### 6.1.5.2.2 Target URI + +The Callback URI "{subsNotifUri}" shall be used with the callback URI variables defined in table 6.1.5.2.2-1. + +**Table 6.1.5.2.2-1: Callback URI variables** + +| Name | Definition | +|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| subsNotifUri | String formatted as URI with the Callback Uri.
The Callback Uri is assigned within the Time Synchronization Capability Notification and described within the TimeSyncExposureSubsc type (see table 6.1.6.2.2-1). | + +#### 6.1.5.2.3 Standard Methods + +##### 6.1.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.2.3.1-1 and the response data structures and response codes specified in table 6.1.5.2.3.1-2 + +**Table 6.1.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------| +| TimeSyncExposureSubsNotif | M | 1 | Provides the time synchronization capabilities of a list of UEs by the TSCTSF to the NF service consumer. | + +**Table 6.1.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------| +| n/a | | | 204 No Content | The event notification is received successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during event notification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.1.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +**Table 6.1.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +## 6.1.5.3 Time Synchronization Configuration Notification + +### 6.1.5.3.1 Description + +The Time Synchronization Configuration Notification is used by the NF service producer to report the current state of configuration of the time synchronization service. + +### 6.1.5.3.2 Target URI + +The Callback URI "{configNotifUri}" shall be used with the callback URI variables defined in table 6.1.5.3.2-1. + +**Table 6.1.5.3.2-1: Callback URI variables** + +| Name | Definition | +|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| configNotifUri | String formatted as URI with the Callback Uri.
The Callback Uri is assigned within the Time Synchronization Configuration Notification and described within the TimeSyncExposureConfig type (see table 6.1.6.2.9-1). | + +### 6.1.5.3.3 Standard Methods + +#### 6.1.5.3.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.3.3.1-1 and the response data structures and response codes specified in table 6.1.5.3.3.1-2. + +**Table 6.1.5.3.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------| +| TimeSyncExposureConfigNotif | M | 1 | Provides the current state of time synchronization configuration by the TSCTSF to the NF service consumer. | + +**Table 6.1.5.3.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------| +| n/a | | | 204 No Content | The event notification is received successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during event notification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.1.5.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +**Table 6.1.5.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +## 6.1.6 Data Model + +### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Ntsctsf\_TimeSynchronization service based interface protocol. + +**Table 6.1.6.1-1: Ntsctsf\_TimeSynchronization specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|---------------------------------|-----------------------|------------------------------------------------------------------------------------------------------------|----------------------| +| ConfigForPort | 6.1.6.2.11 | Contains the configuration for a port. | | +| PtpCapabilitiesPerUe | 6.1.6.2.6 | Contains the PTP capabilities supported by a UE. | | +| PtpInstance | 6.1.6.2.10 | Contains the PTP Instance. | | +| TimeSyncExposureSubsc | 6.1.6.2.2 | Contains the parameters for the subscription to notification of capability of time synchronization service | | +| TimeSyncCapability | 6.1.6.2.5 | Contains the capability of time synchronization service | | +| TimeSyncExposureConfig | 6.1.6.2.9 | Contains the configuration of time synchronization service | | +| TimeSyncExposureConfigNoti
f | 6.1.6.2.7 | Contains the notification of configuration of time synchronization service. | | +| TimeSyncExposureSubsNotif | 6.1.6.2.3 | Contains the notification of time synchronization service. | | +| StateOfConfiguration | 6.1.6.2.8 | Indicates the PTP port states for a NW-TT and DS-TTs. | | +| StateOfDstt | 6.1.6.2.12 | Contains the PTP port state of a DS-TT | | +| SubsEventNotification | 6.1.6.2.4 | Contains the notification of capability of time synchronization for a list of UEs. | | + +Table 6.1.6.1-2 specifies data types re-used by the Ntsctsf\_TimeSynchronization service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Ntsctsf\_TimeSynchronization service based interface. + +**Table 6.1.6.1-2: Ntsctsf\_TimeSynchronization re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|------------------------------------|---------------------|----------------------------------------------------------------------------------------------------------------|----------------------| +| AcceptanceCriteriaResultIndication | 3GPP TS 29.522 [17] | Contains the acceptable/not acceptable indication of the clock quality acceptance criteria result information. | NetTimeSyncStatus | +| AsTimeResource | 3GPP TS 29.522 [17] | Indicates the supported 5G clock quality. | | +| ClockQualityAcceptanceCriterion | 3GPP TS 29.571 [15] | Identifies clock quality acceptance criteria information. | NetTimeSyncStatus | +| ClockQualityDetailLevel | 3GPP TS 29.571 [15] | Identifies clock quality detail level information. | NetTimeSyncStatus | +| DateTime | 3GPP TS 29.571 [15] | String with format "date-time" as defined in OpenAPI Specification [6]. | | +| DistributionMethod | 3GPP TS 29.522 [17] | Identifies the time synchronization distribution methods supported by 5GS. | | +| Dnn | 3GPP TS 29.571 [15] | The DNN the user is connected to. | | +| DurationSec | 3GPP TS 29.571 [15] | Identifies a period of time in units of seconds. | | +| EventFilter | 3GPP TS 29.522 [17] | Contains the conditions to match for notifying the event. | | +| ExternalGroupId | 3GPP TS 29.571 [15] | Identifies a External Group. | | +| GmCapable | 3GPP TS 29.522 [17] | Indicates separately whether 5GS supports acting as a gPTP or PTP grandmaster. | | +| Gpsi | 3GPP TS 29.571 [15] | The external identification of the user (i.e., an External Id or an MSISDN). | | +| GroupId | 3GPP TS 29.571 [15] | Identifies a group of internal globally unique ID. | | +| ProblemDetails | 3GPP TS 29.571 [15] | Problem Details when returning an error response. | | +| RedirectResponse | 3GPP TS 29.571 [15] | Contains redirection related information. | | +| ServiceAreaCoverageInfo | 3GPP TS 29.534 [14] | It represents a list of Tracking Areas within a serving network. | CoverageAreaSupport | +| Snssai | 3GPP TS 29.571 [15] | Identifies the S-NSSAI. | | +| SubscribedEvent | 3GPP TS 29.522 [17] | Indicates the subscribed event. | | +| Supi | 3GPP TS 29.571 [15] | The identification of the user (i.e. IMSI, NAI). | | +| SupportedFeatures | 3GPP TS 29.571 [15] | Used to negotiate the applicability of the optional features defined in table 5.8-1. | | +| TimeSyncExposureConfig | 3GPP TS 29.522 [17] | Contains the parameters of time synchronization configuration. | | +| Uinteger | 3GPP TS 29.571 [15] | Unsigned integer. | | +| Uint64 | 3GPP TS 29.571 [15] | | | +| Uri | 3GPP TS 29.571 [15] | Identifies a referenced resource. | | + +## 6.1.6.2 Structured data types + +### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 6.1.6.2.2 Type: TimeSyncExposureSubsc + +**Table 6.1.6.2.2-1: Definition of type TimeSyncExposureSubsc** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supis | array(Supi) | C | 1..N | Subscription Permanent Identifier. (NOTE) | | +| gosis | array(Gpsi) | C | 1..N | Public user identifier. (NOTE) | | +| interGrpId | GroupId | C | 0..1 | The internal Group Id(s). (NOTE) | | +| exterGrpId | ExternalGroupId | C | 0..1 | The external Group Id. (NOTE) | | +| anyUeInd | boolean | C | 0..1 | Identifies whether the AF request applies to any UE (i.e. all UEs). This attribute shall set to "true" if applicable for any UE, otherwise, set to "false". (NOTE) | | +| notifMethod | NotificationMethod | O | 0..1 | If "notifMethod" is not supplied, the default value "ON_EVENT_DETECTION" applies. | | +| dnn | Dnn | M | 1 | Identifies a DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. | | +| snssai | Snssai | M | 1 | Identifies an S-NSSAI. | | +| subscribedEvents | array(SubscribeEvent) | M | 1..N | Identifies the requirement to be notified of the event(s). | | +| eventFilters | array(EventFilter) | O | 1..N | Contains the filter conditions to match for notifying the event(s) of time synchronization capabilities for a list of UE(s). | | +| subsNotifUri | Uri | M | 1 | Notification URI for time sensitive capability reporting. | | +| subsNotifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | +| maxReportNbr | UInteger | O | 0..1 | If omitted, there is no limit. | | +| expiry | DateTime | C | 0..1 | This attribute indicates the expiry time of the subscription, after which the NEF shall not send any event notifications and the subscription becomes invalid. It may be included in an event subscription request and may be included in an event subscription response based on operator policies. If an expiry time was included in the request, then the expiry time returned in the response should be less than or equal to that value. If the expiry time is not included in the response, the NF service consumer shall not associate an expiry time for the subscription. | | +| repPeriod | DurationSec | C | 0..1 | Is supplied for notification Method "periodic". | | +| suppFeat | SupportedFeatures | C | 0..1 | Represents the features supported by the NF service consumer. This parameter | | + +| | | | | | | +|---------------------------------------------------------------------------------------------------------------|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | shall be supplied by the NF service consumer in the POST request and the response that requested the creation of an Individual Time Synchronization Subscription resource. | | +| NOTE: Only one of the properties "supis", "gpps", "anyUeInd", "exterGrpId" or "interGrpId" shall be included. | | | | | | + +#### 6.1.6.2.3 Type: TimeSyncExposureSubsNotif + +**Table 6.1.6.2.3-1: Definition of type TimeSyncExposureSubsNotify** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------------|---|-------------|------------------------------------------------------------------|---------------| +| subsNotifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | +| eventNotifs | array(SubsEventNotification) | M | 1..N | Notifications about Individual Events | | + +#### 6.1.6.2.4 Type SubsEventNotification + +**Table 6.1.6.2.4-1: Definition of type SubsEventNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| event | SubscribedEvent | M | 1 | Subscribed events | | +| timeSyncCapas | array(TimeSyncCapability) | C | 1..N | Contains a list of time synchronization capabilities for the List of User-Plane Node IDs. It shall be provided if the reported event is "AVAILABILITY_FOR_TIME_SYNC_SERVICE". | | + +### 6.1.6.2.5 Type: TimeSyncCapability + +**Table 6.1.6.2.5-1: Definition of type TimeSyncCapability** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| upNodeId | Uint64 | M | 1 | Identifies the applicable NW-TT. Contains a TSC user plane node Id. If integrated with TSN, the user plane node Id is a bridge Id defined in IEEE Std 802.1Q-2018 [18] clause 14.2.5. | | +| gmCapables | array(GmCapable) | C | 1..N | Indicates whether user plane node supports acting as a gPTP and/or PTP grandmaster. (NOTE) | | +| asTimeRes | AsTimeResource | C | 0..1 | Indicates the supported 5G clock quality (i.e. the source of time used by the 5GS). (NOTE) | | +| ptpCapForUes | map(PtpCapabilitiesPerUe) | C | 1..N | Contains the PTP capabilities supported by the list of UE(s). The key of the map is the SUPI. Shall be present if the "gmCapables" attribute is included and the PTP Capabilities are reported per SUPI. | | +| ptpCapForGpsis | map(PtpCapabilitiesPerUe) | C | 1..N | Contains the PTP capabilities supported by the list of UE(s). The key of the map is the GPSI. Shall be present if the "gmCapables" attribute is included and the PTP Capabilities are reported per GPSI. | | + +NOTE: At least one of the "gmCapables" attribute and "asTimeRes" attribute shall be included. + +### 6.1.6.2.6 Type: PtpCapabilitiesPerUe + +**Table 6.1.6.2.6: Definition of type PtpCapabilitiesPerUe** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|--------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | Identifies the UE to which the reported PTP instance below apply. (NOTE) | | +| gpsi | Gpsi | C | 0..1 | Identifies the UE to which the reported PTP instance below apply. (NOTE) | | +| ptpCaps | array(EventFilter) | M | 1..N | Contains the reported PTP capabilities for the UE. | | + +NOTE: Either the "supi" or the "gpsi" attribute is included, based on whether the request contained an internal or an external identifier. + +## 6.1.6.2.7 Type: TimeSyncExposureConfigNotif + +Table 6.1.6.2.7-1: Definition of type TimeSyncExposureConfigNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|---------------------------------------------------------------------------|---------------| +| configNotifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | +| stateOfConfig | StateOfConfiguration | M | 1 | Indicates the current state of time synchronization service configuration | | + +## 6.1.6.2.8 Type: StateOfConfiguration + +Table 6.1.6.2.8-1: Definition of type StateOfConfiguration + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| stateOfNwtt | boolean | O | 0..1 | When any of the PTP port state(s) in NW-TT is Leader, Follower or Passive, it is included and set to true to indicate the current state of the time synchronization configuration for the NW-TT port(s) of the PTP instance is active; when PTP port state is in any other case, it is included and set to false to indicate the state of configuration for the NW-TT port(s) of the PTP instance is inactive. Default value is false. | | +| stateOfDstts | array(StateOfDstt) | O | 1..N | Contains the PTP port states and the clock quality acceptance criteria result of the DS-TT(s). | | + +Editor's note: Whether it is required the report of the clock quality acceptance criteria for the NW-TTP ports (i.e., whether the clkQltIndOfNwtt attribute is needed) is FFS and requires SA2 clarifications. + +## 6.1.6.2.9 Type: TimeSyncExposureConfig + +Table 6.1.6.2.9-1: Definition of type TimeSyncExposureConfig + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| upNodeId | Uint64 | M | 1 | Identifies the applicable NW-TT. Contains a TSC user plane node Id. If integrated with TSN, the user plane node Id is a bridge Id defined in IEEE 802.1Q [41] clause 14.2.5. | | +| reqPtplns | PtpInstance | M | 1 | Identifies the PtP instance configuration and activation requested by the AF. | | +| gmEnable | boolean | O | 0..1 | Indicates that the AF requests 5GS to act as a grandmaster for PTP or gPTP if it is included and set to true. The default value "false" shall apply, if the attribute is not present. | | +| gmPrio | UInteger | O | 0..1 | Indicates a priority used as defaultDS.priority1 when generating Announce message when 5GS acts as (g)PTP GM. It may be present if the "gmEnable" is set to true. | | +| timeDom | UInteger | M | 1 | Indicate the (g)PTP domain that the (TSN)AF is located in. | | +| timeSyncErrBdg
t | UInteger | O | 0..1 | Indicates the time synchronization budget for the time synchronization service in units of nanoseconds. Minimum = 1. | | +| tempValidity | TemporalValidity | O | 0..1 | Indicates the time period when the time synchronization service for a PTP instance is active. | | +| configNotifUri | Uri | M | 1 | Notification URI for configuration state reporting. | | +| configNotifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | +| covReq | array(ServiceAreaCoverageInfo) | O | 1..N | Identifies a list of Tracking Areas per serving network where the time synchronization service configuration is allowed. | CoverageAreaSupport | +| clkQltDetLvl | ClockQualityDetailLevel | O | 0..1 | Indicates the clock quality detail level. For (g)PTP services, its value, if provided, shall be set to "ACCEPT_INDICATION". | NetTimeSyncStatus | +| clkQltAcptCri | ClockQualityAcceptanceCriterion | C | 0..1 | Indicates the clock quality acceptance criteria, and it is used to determine whether the time synchronization status for the (g)PTP service is acceptable/not acceptable. It shall be present when the "clkQltDetLvl" attribute is present. | NetTimeSyncStatus | + +## 6.1.6.2.10 Type: PtpInstance + +**Table 6.1.6.2.10-1: Definition of type PtpInstance** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|----------------------------------------------------------------------|---------------| +| instanceType | InstanceType | M | 1 | Indicates the PTP instance type. | | +| protocol | Protocol | M | 1 | Indicates the protocol type. | | +| ptpProfile | string | M | 1 | Identifies the PTP profile. | | +| portConfigs | array(ConfigForPort) | O | 1..N | Contains the configurations for the PTP port(s) in the PTP instance. | | + +6.1.6.2.11 Type: ConfigForPort + +**Table 6.1.6.2.11-1: Definition of type ConfigForPort** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | Identifies the UE/DS-TT which the parameters below apply.
(NOTE) | | +| gpsi | Gpsi | C | 0..1 | Identifies the UE/ DS-TT which the parameters below apply
(NOTE) | | +| n6Ind | boolean | C | 0..1 | Indicates the N6 termination which the parameters below apply.
(NOTE) | | +| ptpEnable | boolean | O | 0..1 | This is used to set the portDS.portEnable. If omitted, the default value as described in the PTP Profile is used | | +| logSyncInter | integer | O | 0..1 | Specifies the mean time interval between successive Sync messages. This is applicable for IEEE Std 1588-2019 [25] Boundary Clock or IEEE Std 802.1AS-2020 [26] operation. If omitted, the default value as described in the PTP Profile is used. | | +| logSyncInterInd | boolean | O | 0..1 | When set to FALSE, the value of "logSyncInter" attribute is used to set the initialLogSyncInterval as described in IEEE Std 802.1AS-2020 [26]. When set to TRUE, the value of "logSyncInter" attribute is used to set the mgtSettableLogSyncInterval as described in IEEE Std 802.1AS-2020 [26]. If omitted, the default value as described in the IEEE Std 802.1AS-2020 [26] is used. | | +| logAnnouInter | integer | O | 0..1 | Specifies the mean time interval between successive Announce messages. This is applicable for IEEE Std 1588-2019 [25] Boundary Clock or IEEE Std 802.1AS-2020 [26] operation. If omitted, the default value as described in the PTP Profile is used. | | +| logAnnouInterInd | boolean | O | 0..1 | When set to FALSE, the value of "logAnnouInter" attribute is used to set the initialLogAnnounceInterval as described in IEEE 802.1AS-2020 [26]. When set to TRUE, the value of "logAnnouInter" attribute is used to set the mgtSettableLogAnnounceInterval as described in IEEE Std 802.1AS-2020 [26]. If omitted, the default value as described in the IEEE Std 802.1AS-2020 [26] is used. | | + +NOTE: Only one of "supi", "gpsi" or "n6Ind" attribute shall be included. + +## 6.1.6.2.12 Type: StateOfDstt + +**Table 6.1.6.2.12-1: Definition of type StateOfDstt** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|----------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| supi | Supi | C | 0..1 | Identifies the UE/DS-TT which the parameters below apply.
(NOTE) | | +| gpsi | Gpsi | C | 0..1 | Identifies the UE/DS-TT which the parameters below apply.
(NOTE) | | +| state | boolean | M | 1 | When the PTP port state is Leader, Follower or Passive, it is included and set to true to indicate the current state of the time synchronization configuration for DS-TT port is active; when PTP port state is in any other case, it is included and set to false to indicate the state of configuration for DS-TT port is inactive. Default value is false. | | +| clkQltIndOfDstts | AcceptanceCriteriaRes
ultIndication | O | 0..1 | Indicates the clock quality acceptance criteria changes ("ACCEPTABLE", "NOT_ACCEPTABLE") for the indicated DS-TT port of the PTP instance. | NetTimeSyncStatus | + +NOTE: Either the "supi" or the "gpsi" attribute is included, based on whether the request contained an internal or an external identifier + +## 6.1.6.3 Simple data types and enumerations + +## 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +## 6.1.7 Error Handling + +## 6.1.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [5]. + +For the Ntsctsf\_TimeSynchronization API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Ntsctsf\_TimeSynchronization API. + +### 6.1.7.2 Protocol Errors + +No specific procedures for the Ntsctsf\_TimeSynchronization service are specified. + +### 6.1.7.3 Application Errors + +The application errors defined for the Ntsctsf\_TimeSynchronization service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------|------------------|------------------------------------------------------------| +| UE_SERVICE_NOT_AUTHORIZED | 403 Forbidden | The requested service for the target UE is not authorized. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Ntsctsf\_TimeSynchronization API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|---------------------|---------------------------------------------------------------------------------------------------------------------------| +| 1 | CoverageAreaSupport | Indicates the support of spatial validity conditions for the activation/deactivation of the time synchronization service. | +| 2 | NetTimeSyncStatus | Indicates the time synchronization service status. | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Ntsctsf\_TimeSynchronization API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Ntsctsf\_TimeSynchronization API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Ntsctsf\_TimeSynchronization service. + +The Ntsctsf\_TimeSynchronization API defines a single scope "ntsctsf-time-sync" for the entire service, and it does not define any additional scopes at resource or operation level. + +## 6.2 Ntsctsf\_QoSandTSCAssistance Service API + +### 6.2.1 Introduction + +The Ntsctsf\_QoSandTSCAssistance service shall use the Ntsctsf\_QoSandTSCAssistance API. + +The API URI of the Ntsctsf\_QoSandTSCAssistance API shall be: + +**{apiRoot}/** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [4], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "ntscsf-qos-tscai". +- The shall be "v1". +- The shall be set as described in clause 6.2.3. + +## 6.2.2 Usage of HTTP + +### 6.2.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Ntscsf\_QoSandTSCAssistance API is contained in Annex A. + +### 6.2.2.2 HTTP standard headers + +#### 6.2.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +#### 6.2.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +JSON object used in the HTTP PATCH request shall be encoded according to "JSON Merge Patch" and shall be signalled by the content type "application/merge-patch+json", as defined in IETF RFC 7396 [22]. + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +### 6.2.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +In this Release of the specification, no specific custom headers are defined for the Ntscsf\_QoSandTSCAssistance API. + +## 6.2.3 Resources + +### 6.2.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.2.3.1-1 depicts the resource URIs structure for the Ntscsf\_QoSandTSCAssistance API. + +![Figure 6.2.3.1-1: Resource URI structure of the Ntsctsf_QoSandTSCAssistance API. The diagram shows a hierarchical tree structure starting with {apiRoot}/ntsctsf-qos-tscai/{apiVersion}. A line branches down to a box containing /tsc-app-sessions. From this box, a line branches down to a box containing /{appSessionId}. From the /{appSessionId} box, two lines branch out to boxes containing /delete and /events-subscription respectively.](18003425d0e8638dde4acc9c5c468c5c_img.jpg) + +``` + +graph TD + Root["{apiRoot}/ntsctsf-qos-tscai/{apiVersion}"] --> TSC["/tsc-app-sessions"] + TSC --> AppSession["/{appSessionId}"] + AppSession --> Delete["/delete"] + AppSession --> Events["/events-subscription"] + +``` + +Figure 6.2.3.1-1: Resource URI structure of the Ntsctsf\_QoSandTSCAssistance API. The diagram shows a hierarchical tree structure starting with {apiRoot}/ntsctsf-qos-tscai/{apiVersion}. A line branches down to a box containing /tsc-app-sessions. From this box, a line branches down to a box containing /{appSessionId}. From the /{appSessionId} box, two lines branch out to boxes containing /delete and /events-subscription respectively. + +**Figure 6.2.3.1-1: Resource URI structure of the Ntsctsf\_QoSandTSCAssistance API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------------------------------|------------------------------------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| TSC Application Sessions | /tsc-app-sessions | POST | Ntsctsf_QoSandTSCAssistance_Create.
Creates a new Individual TSC Application Session Context resource and may create the child Events Subscription sub-resource. | +| Individual TSC Application Session Context | /tsc-app-sessions/{appSessionId} | PATCH | Ntsctsf_QoSandTSCAssistance_Update.
Updates an existing Individual TSC Application Session Context resource. It can also update an Events Subscription sub-resource. | +| | | GET | Reads an existing Individual TSC Application Session Context resource. | +| | /tsc-app-sessions/{appSessionId}/delete | delete (POST) | Ntsctsf_QoSandTSCAssistance_Delete.
Deletes an existing Individual TSC Application Session Context resource and the child Events Subscription sub-resource. | +| Events Subscription | /tsc-app-sessions/{appSessionId}/events-subscription | PUT | Ntsctsf_QoSandTSCAssistance_Subscribe.
Creates a new Events Subscription sub-resource or modifies an existing Events Subscription sub-resource. | +| | | DELETE | Ntsctsf_QoSandTSCAssistance_Unsubscribe.
Deletes an Events Subscription sub-resource. | + +## 6.2.3.2 Resource: TSC Application Sessions + +### 6.2.3.2.1 Description + +This resource allows a NF service consumer to create a new Individual TSC Application Session Context resource and may create the child Events Subscription sub-resource. + +### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/ntscsf-qos-tscai//tsc-app-sessions + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.2.1 | + +### 6.2.3.2.3 Resource Standard Methods + +#### 6.2.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.2.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3. + +**Table 6.2.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|---------------------------------------------------------------------------------------------------------| +| TscAppSessionContextData | M | 1 | Contains the information for the creation of a new Individual TSC Application Session Context resource. | + +**Table 6.2.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| TscAppSessionContextData | M | 1 | 201
Created | The subscription was created successfully.
The URI of the created resource shall be returned in the "Location" HTTP header. | +| ProblemDetailsTscsfQosTscac | O | 0..1 | 403
Forbidden | (NOTE 2) | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: Failure cases are described in clause 6.2.7. + +**Table 6.2.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/ntscsf-qos-tscai//tsc-app-sessions /{appSessionId} | + +**Table 6.2.3.2.3.1-5: Headers supported by the 403 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|-----------|---|-------------|-------------------------------------------------------------------------------------| +| Retry-After | string | M | 1 | Indicates the time the NF service consumer has to wait before making a new request. | + +#### 6.2.3.2.4 Resource Custom Operations + +None. + +#### 6.2.3.3 Resource: Individual TSC Application Session Context + +##### 6.2.3.3.1 Description + +This resource allows a NF service consumer to read, modify or delete an existing Individual TSC Application Session Context resource. + +##### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/ntscsf-qos-tscai//tsc-app-sessions/{appSessionId} + +This resource shall support the resource URI variables defined in table 6.2.3.3.2-1. + +**Table 6.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|--------------|-----------|----------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| appSessionId | string | Identifier of an Individual TSC Application Session Context resource | + +##### 6.2.3.3.3 Resource Standard Methods + +###### 6.2.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.3.3.1-1. + +**Table 6.2.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3. + +**Table 6.2.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------| +| TscAppSessionContextData | M | 1 | 200 OK | An Individual TSC Application Session Context resource is returned successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during an Individual TSC Application Session Context resource retrieval.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during an Individual TSC Application Session Context resource retrieval.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.2.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.2.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +#### 6.2.3.3.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.3.3.2-1. + +**Table 6.2.3.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.2-2 and the response data structures and response codes specified in table 6.2.3.3.3.2-3. + +**Table 6.2.3.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------------|---|-------------|---------------------------------------------------------------------------------------------------| +| TscAppSessionContextUpdateData | M | 1 | Contains the modification(s) to apply to the Individual TSC Application Session Context resource. | + +**Table 6.2.3.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| TscAppSessionContextData | M | 1 | 200 OK | Successful case.
The Individual TSC Application Session Context resource was modified and a representation of that resource is returned. | +| n/a | | | 204 No Content | Successful case.
The Individual TSC Application Session Context resource was modified. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during an Individual TSC Application Session Context resource modification.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during an Individual TSC Application Session Context resource modification.
(NOTE 3) | +| ProblemDetailsTsctsfQoSTscac | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the PATCH method shall also apply. +NOTE 2: Failure cases are described in clause 6.2.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.2.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.2.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.2.3.3.3.2-6: Headers supported by the 403 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|-----------|---|-------------|-------------------------------------------------------------------------------------| +| Retry-After | string | M | 1 | Indicates the time the NF service consumer has to wait before making a new request. | + +### 6.2.3.3.4 Resource Custom Operations + +#### 6.2.3.3.4.1 Overview + +**Table 6.2.3.3.4.1-1: Custom operations** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|-----------------------------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| delete | /tsc-app-sessions/{appSessionId}/delete | POST | Ntsctsf_QoSandTSCAssistance_Delete.
Deletes an existing Individual TSC Application Session Context resource and the child Events Subscription sub-resource. | + +#### 6.2.3.3.4.2 Operation: delete + +##### 6.2.3.3.4.2.1 Description + +##### 6.2.3.3.4.2.2 Operation Definition + +This custom operation deletes an existing Individual TSC Application Session Context resource and the child Events Subscription sub-resource in the TSCTSF. + +This operation shall support the request data structures specified in table 6.2.3.3.4.2.2-1 and the response data structure and response codes specified in table 6.2.3.3.4.2.2-2. + +**Table 6.2.3.3.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EventsSubscReqData | O | 0..1 | Events subscription information to be sent by the NF service consumer to request event notification when the Individual TSC Application Session Context resource is deleted. | + +**Table 6.2.3.3.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case.
The Individual TSC Application Session Context resource was deleted. | +| EventsNotification | M | 1 | 200 OK | Successful case.
Describes information related to the notification of events. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during an Individual TSC Application Session Context resource deletion.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during an Individual TSC Application Session Context resource deletion.

(NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the POST method shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.2.3.3.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.2.3.3.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +## 6.2.3.4 Resource: Events Subscription (Document) + +### 6.2.3.4.1 Description + +The Events Subscription sub-resource represents a subscription to events for a TSC application session context that exists in the Ntscsf\_QoSandTSCAssistance service. + +### 6.2.3.4.2 Resource Definition + +Resource URI: {apiRoot}/ntscsf-qos-tscai//tsc-app-sessions/{appSessionId}/events-subscription + +This resource shall support the resource URI variables defined in table 6.2.3.4.2-1. + +**Table 6.2.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|--------------|-----------|-----------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| appSessionId | string | Identifier of an Individual TSC Application Session Context resource. | + +### 6.2.3.4.3 Resource Standard Methods + +#### 6.2.3.4.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.3.4.3.1-1. + +**Table 6.2.3.4.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.4.3.1-2 and the response data structures and response codes specified in table 6.2.3.4.3.1-3. + +**Table 6.2.3.4.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|------------------------------------------------------------------------------------| +| EventsSubscReqData | M | 1 | Contains information for the modification of the Events Subscription sub-resource. | + +**Table 6.2.3.4.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------| +| EventsSubscReqData | M | 1 | 201 Created | Successful case.
The Events Subscription sub-resource was created. | +| EventsSubscReqData | M | 1 | 200 OK | Successful case.
The Events Subscription sub-resource was modified. | +| n/a | | | 204 No Content | Successful case.
The Events Subscription sub-resource was modified. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during an Events Subscription sub-resource creation.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during an Events Subscription sub-resource creation.

(NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the PUT method shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.2.3.4.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/ntscsf-qos-tscai//tsc-app-sessions/{appSessionId}/events-subscription | + +**Table 6.2.3.4.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.2.3.4.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +#### 6.2.3.4.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.4.3.2-1. + +**Table 6.2.3.4.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.4.3.2-2 and the response data structures and response codes specified in table 6.2.3.4.3.2-3. + +**Table 6.2.3.4.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.4.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case.
The Events Subscription sub-resource was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during an Events Subscription sub-resource deletion.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during an Events Subscription sub-resource deletion.

(NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the DELETE method shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.2.3.4.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.2.3.4.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +#### 6.2.3.4.4 Resource Custom Operations + +None. + +### 6.2.4 Custom Operations without associated resources + +None. + +### 6.2.5 Notifications + +#### 6.2.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 6.2.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|---------------------|----------------------|---------------------------------|---------------------------------------------------------------------------| +| Event Notification | {notifUri}/notify | notify (POST) | TSCTSF event notification. | +| Termination Request | {notifUri}/terminate | terminate (POST) | Request for termination of an Individual TSC Application Session Context. | + +#### 6.2.5.2 Event Notification + +##### 6.2.5.2.1 Description + +The Event Notification is used by the TSCTSF to report one or several observed application session context events to the NF service consumer that has subscribed to such notifications via the Events Subscription sub-resource. + +##### 6.2.5.2.2 Target URI + +The Callback URI "{notifUri}/notify " shall be used with the callback URI variables defined in table 6.2.5.2.2-1. + +**Table 6.2.5.2.2-1: Callback URI variables** + +| Name | Definition | +|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | The Notification Uri as assigned within the Events Subscription sub-resource and described within the EventsSubscReqData type (see table 6.2.6.2.3-1) or EventsSubscReqDataRm (see table 6.2.6.2.5-1). | + +##### 6.2.5.2.3 Standard Methods + +###### 6.2.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.2.5.2.3.1-1 and the response data structures and response codes specified in table 6.2.5.2.3.1-2. + +**Table 6.2.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|---------------------------------------------| +| EventsNotification | M | 1 | Provides Information about observed events. | + +**Table 6.2.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------| +| n/a | | | 204 No Content | The event notification is received successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during event notification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.2.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +**Table 6.2.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +## 6.2.5.3 Termination Request + +### 6.2.5.3.1 Description + +The Termination Request is used by the TSCTSF to request the NF service consumer the deletion of the Individual TSC Application Session Context resource. + +### 6.2.5.3.2 Target URI + +The Callback URI "{notifUri}/terminate" shall be used with the callback URI variables defined in table 6.2.5.3.2-1. + +**Table 6.2.5.3.2-1: Callback URI variables** + +| Name | Definition | +|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | The Notification Uri as assigned within the Individual TSC Application Session Context resource and described within the TscAppSessionContextData Data type (see table 6.2.6.2.2-1) or TscAppSessionContextUpdateData (see table 6.2.6.2.4-1). | + +### 6.2.5.3.3 Standard Methods + +#### 6.2.5.3.3.1 POST + +This method shall support the request data structures specified in table 6.2.5.3.3.1-1 and the response data structures and response codes specified in table 6.2.5.3.3.1-2. + +**Table 6.2.5.3.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|----------------------------------------------------------| +| TerminationInfo | M | 1 | Provides information about the deletion of the resource. | + +**Table 6.2.5.3.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during event notification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.2.5.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +**Table 6.2.5.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +## 6.2.6 Data Model + +### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Ntsctsf\_QoSandTSCAssistance service based interface protocol. + +**Table 6.2.6.1-1: Ntsctsf\_QoSandTSCAssistance specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|--------------------------------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| AdditionalInfoTscsfQoSTscac | 6.2.6.2.8 | Describes additional error information specific for this API. | | +| EventsNotification | 6.2.6.2.6 | Describes the notification(s) about the event(s) occurred within an Individual TSC Application Session Context resource. | | +| EventNotification | 6.2.6.2.7 | Describes the notification for an Event. | | +| EventsSubscReqData | 6.2.6.2.3 | Identifies the events the application subscribes to within an Individual TSC Application Session Context resource | | +| EventsSubscReqDataRm | 6.2.6.2.5 | This data type is defined in the same way as the "EventsSubscReqData" data type, but with the OpenAPI "nullable: true" property. | | +| ProblemDetailsTscsfQoSTscac | 6.2.6.4.1 | Problem details as defined in 3GPP TS 29.571 [15] extended with specific error information for this API, as described in AdditionalInfoTscsfQoSTscac data type. | | +| TemporalInvalidity | 6.2.6.2.9 | Indicates the time interval during which the NF service consumer request shall not to be applied. | GMEC | +| TscAppSessionContextData | 6.2.6.2.2 | Represents the Individual TSC Application Session Context resource data. | | +| TscAppSessionContextUpdateData | 6.2.6.2.4 | Describes the modifications to an Individual TSC Application Session Context resource. | | +| TscEvent | 6.2.6.3.3 | Indicates the subscribed event(s). | | + +Table 6.2.6.1-2 specifies data types re-used by the Ntsctsf\_QoSandTSCAssistance service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Ntsctsf\_QoSandTSCAssistance service based interface. + +**Table 6.2.6.1-2: Ntsctsf\_QoSAndTSCAssistance re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| AcceptableServiceInfo | 3GPP TS 29.514 [20] | Acceptable maximum requested bandwidth. | | +| AccumulatedUsage | 3GPP TS 29.122 [21] | Accumulated Usage. | | +| AspId | 3GPP TS 29.514 [20] | Contains an identity of an application service provider. | | +| BatOffsetInfo | 3GPP TS 29.514 [20] | Contains the offset of the BAT and the optionally adjusted periodicity. | EnTSCAC | +| DateTime | 3GPP TS 29.571 [15] | Represents a date and a time. | GMEC | +| Dnn | 3GPP TS 29.571 [15] | The DNN the user is connected to. | | +| ExternalGroupId | 3GPP TS 29.571 [15] | Identifies an External Group. | GMEC | +| EthFlowDescription | 3GPP TS 29.514 [20] | Defines a packet filter for an Ethernet flow. | | +| EthFlowInfo | 3GPP TS 29.122 [21] | Contains an UL and/or DL Flow information. | Ethernet_UL/DL_Flows | +| FlowInfo | 3GPP TS 29.122 [21] | Contains the IP data flow information. | | +| Gpsi | 3GPP TS 29.571 [15] | Represents a GPSI. | GMEC | +| IpAddr | 3GPP TS 29.571 [15] | Contains the IP address. | | +| MacAddr48 | 3GPP TS 29.571 [15] | MAC Address. | | +| ProblemDetails | 3GPP TS 29.571 [15] | Problem Details when returning an error response. | | +| QosMonitoringInformation | 3GPP TS 29.122 [21] | Contains Qos Monitoring information. | | +| QosMonitoringInformationRm | 3GPP TS 29.122 [21] | This data type is defined in the same way as the "QosMonitoringInformation" data type, but with the OpenAPI "nullable: true" property. | | +| QosMonitoringReport | 3GPP TS 29.122 [21] | Contains Qos Monitoring Report information. | | +| RedirectResponse | 3GPP TS 29.571 [15] | Contains redirection related information. | | +| Snssai | 3GPP TS 29.571 [15] | Identifies the S-NSSAI. | | +| SponId | 3GPP TS 29.514 [20] | Contains an Identity of a sponsor. | | +| SponsoringStatus | 3GPP TS 29.514 [20] | Represents whether sponsored data connectivity is enabled or disabled/not enabled. | | +| SubscribedEvent | 3GPP TS 29.522 [17] | Indicates the subscribed event. | | +| SupportedFeatures | 3GPP TS 29.571 [15] | Used to negotiate the applicability of the optional features defined in table 5.8-1. | | +| TerminationInfo | 3GPP TS 29.514 [20] | Includes information related to the termination of the Individual TSC Application Session Context resource. | | +| TscQosRequirement | 3GPP TS 29.122 [21] | Contains the QoS requirements for time sensitive communication. | | +| TscQosRequirementRm | 3GPP TS 29.122 [21] | This data type is defined in the same way as the "TscQosRequirement" data type, but with removable attributes. | | +| UsageThreshold | 3GPP TS 29.122 [21] | Time period and/or traffic volume in which the QoS is to be applied. | | +| UsageThresholdRm | 3GPP TS 29.122 [21] | This data type is defined in the same way as the "UsageThreshold" data type, but with the OpenAPI "nullable: true" property. | | +| Uri | 3GPP TS 29.571 [15] | Identifies a referenced resource. | | + +## 6.2.6.2 Structured data types + +### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 6.2.6.2.2 Type TscAppSessionContextData + +**Table 6.2.6.2.2-1: Definition of type TscAppSessionContextData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-------------------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| uelpAddr | IpAddr | C | 0..1 | The address of the UE.
(NOTE 1) (NOTE 5) | | +| ipDomain | string | C | 0..1 | The IPv4 address domain identifier.

The attribute may only be provided if the uelpAddr attribute is present and contains an IPv4 address. | | +| ueMac | MacAddr48 | C | 0..1 | Identifies the MAC address.
(NOTE 1) (NOTE 5) | | +| ueId | Gpsi | C | 0..1 | The identity of the targeted UE.

(NOTE 5) | GMEC | +| externalGroupId | ExternalGroupId | C | 0..1 | Identifies the targeted group of UE(s).

(NOTE 5) | GMEC | +| dnn | Dnn | O | 0..1 | Data Network Name, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. | | +| snssai | Snssai | O | 0..1 | Identifies the S-NSSAI. | | +| notifUri | Uri | M | 1 | Notification URI for Individual TSC Application Session Context termination requests. | | +| appId | string | C | 0..1 | Contains the Application Identifier.
(NOTE 1) | | +| flowInfo | array(FlowInfo) | C | 1..N | Describe the IP data flow which requires QoS.
(NOTE 1) (NOTE 4) | | +| enEthFlowInfo | array(EthFlowInfo) | C | 1..N | Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow identifier and the corresponding UL and/or DL flows.
(NOTE 1) (NOTE 4) | Ethernet_UL/DL_Flows | +| ethFlowInfo | array(EthFlowDescription) | C | 1..N | Identifies Ethernet packet flows.
(NOTE 1) | | +| afId | string | M | 1 | Identifies the AF identifier. | | +| tscQosReq | TscQosRequirement | C | 0..1 | Contains the QoS requirements for time sensitive communication. (NOTE 2) | | +| qosReference | string | C | 0..1 | Identifies a pre-defined QoS information. (NOTE 2) (NOTE 3) | | +| altQosReferences | array(string) | C | 1..N | Identifies an ordered list of pre-defined QoS information. The lower the index of the array for a given entry, the higher the priority. (NOTE 3) | | +| altQosReqs | array(AlternativeServiceRequirementsData) | C | 1..N | Identifies an ordered list of alternative service requirements that include individual QoS parameter set(s). The lower the index of the array for a given entry, the higher the priority. (NOTE 3) | | +| sponId | SponId | O | 0..1 | Sponsor identity. | | +| aspId | AspId | O | 0..1 | Contains the Application service provider identity. It shall be included if sponsored connectivity is applicable. | | +| sponStatus | SponsoringStatus | O | 0..1 | Indication of whether sponsored connectivity is enabled or disabled/not enabled.

The absence of the attribute indicates that the sponsored connectivity is enabled. | | +| evSubsc | EventsSubscReqData | O | 0..1 | Identifies the events the application subscribes to at creation of an Individual TSC Application Session Context resource. | | +| tempInValidity | TemporalInValidity | O | 0..1 | Indicates the time interval during which the AF request is not to be applied. | GMEC | + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 6.2.8.
It shall be supplied by the NF service consumer in the POST request and response of requests a creation of an Individual TSC Application Session Context resource. | | +| NOTE 1: When the "GMEC" feature is not supported, either the "uelpAddr" attribute or the "ueMac" attribute shall be included. If IP address is provided, IP flow information shall be provided. If ipv4, the domain identifier may be provided. If mac address is provided, Ethernet flow information shall be provided. One of IP flow information, Ethernet flow information or Application Identifier shall be provided. | | | | | | +| NOTE 2: The attributes "reqGbrDI", "reqGbrUI", "reqMbrDI", "reqMbrUI", "maxTscBurstSize", "req5Gsgdelay", "reqPer" (if the ExtQoS feature is supported), and "priority" within the "tscQosReq" attribute may be provided only if the "qosReference" attribute is not provided. At least one of the "tscQosReq" attribute or the "qosReference" attribute shall be included. | | | | | | +| NOTE 3: The attributes "altQoSReferences" and "altQosReqs" are mutually exclusive. The attributes "qosReference" and "altQosReqs" are also mutually exclusive. | | | | | | +| NOTE 4: When the Ethernet flow information is provided and the Ethernet_UL/DL_Flows feature is supported, either the "ethFlowInfo" or the "enEthFlowInfo" shall be provided, but not both simultaneously. | | | | | | +| NOTE 5: When the "GMEC" feature is supported, the "ueld" attribute and the "externalGroupId" attribute are mutually exclusive. If either the "ueld" attribute or the "externalGroupId" attribute are present, then neither the "uelpAddr" attribute nor the "ueMac" attribute shall be present. | | | | | | + +### 6.2.6.2.3 Type EventsSubscReqData + +**Table 6.2.6.2.3-1: Definition of type EventsSubscReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| events | array(TscEvent) | M | 1..N | Subscribed Events. | | +| notifUri | Uri | M | 1 | Notification URI for event notification. | | +| qosMon | QosMonitoringInformation | C | 0..1 | Qos Monitoring information. It can be present when the event "QOS_MONITORING" is subscribed. | | +| usgThres | UsageThreshold | C | 0..1 | Includes the volume and/or time thresholds for sponsored data connectivity. It can be present when the event "USAGE_REPORT" is subscribed. | | +| notifCorrelId | string | M | 1 | It is used to set the value of Notification Correlation ID in the corresponding notification. | | + +#### 6.2.6.2.4 Type TscAppSessionContextUpdateData + +**Table 6.2.6.2.4-1: Definition of type TscAppSessionContextUpdateData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-------------------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| notifUri | Uri | O | 0..1 | Notification URI for Individual TSC Application Session Context termination requests. | | +| appId | string | O | 0..1 | Identifies the external Application Identifier. (NOTE 1) | | +| flowInfo | array(FlowInfo) | O | 1..N | Describe the IP data flow which requires QoS. (NOTE 1) | | +| ethFlowInfo | array(EthFlowDescription) | O | 1..N | Identifies Ethernet packet flows. (NOTE 1) (NOTE 4) | | +| enEthFlowInfo | array(EthFlowInfo) | C | 1..N | Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow identifier and the corresponding UL and/or DL flows. (NOTE 1) (NOTE 4) | Ethernet_UL/DL_Flows | +| tscQosReq | TscQosRequirementRm | C | 0..1 | Contains the QoS requirements for time sensitive communication. (NOTE 2) | | +| qosReference | string | C | 0..1 | Identifies a pre-defined QoS information. (NOTE 2) (NOTE 3) | | +| altQosReferences | array(string) | C | 1..N | Identifies an ordered list of pre-defined QoS information. The lower the index of the array for a given entry, the higher the priority. (NOTE 3) | | +| altQosReqs | array(AlternativeServiceRequirementsData) | C | 1..N | Identifies an ordered list of alternative service requirements that include individual QoS parameter set(s). The lower the index of the array for a given entry, the higher the priority. (NOTE 3) | | +| evSubsc | EventsSubscReqDataRm | O | 0..1 | Identifies the events the application subscribes to at modification of an Individual TSC Application Session Context resource. | | +| sponId | SponId | O | 0..1 | Sponsor identity. | | +| aspld | Aspld | O | 0..1 | Application service provider identity. It may be included if sponsored connectivity is applicable. | | +| sponStatus | SponsoringStatus | O | 0..1 | Indication of whether sponsored connectivity is enabled or disabled/not enabled.
The absence of the attribute indicates that the sponsored connectivity is enabled. | | +| templnValidity | TemporalInValidity | O | 0..1 | Indicates the time interval during which the AF request is not to be applied. | GMEC | + +NOTE 1: One of IP flow information, Ethernet flow information or Application Identifier may be provided. +NOTE 2: Either "tscQosReq" attribute or "qosReference" attribute may be provided. +NOTE 3: The attributes "altQoSReferences" and "altQosReqs" are mutually exclusive. The attributes "qosReference" and "altQosReqs" are also mutually exclusive. +NOTE 4: When the Ethernet flow information is provided and the Ethernet\_UL/DL\_Flows feature is supported, either the "ethFlowInfo" or the "enEthFlowInfo" may be provided, but not both simultaneously. + +#### 6.2.6.2.5 Type EventsSubscReqDataRm + +This data type is defined in the same way as the "EventsSubscReqData" data type, but: + +- with the OpenAPI "nullable: true" property; and +- the removable attribute "usgThres" is defined with the removable data type "UsageThresholdRm"; and removable attribute "qosMon" is defined with the removable data type "QosMonitoringInformationRm". + +**Table 6.2.6.2.5-1: Definition of type EventsSubscReqDataRm** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| events | array(TscEvent) | M | 1..N | Subscribed Events. | | +| notifUri | Uri | O | 0..1 | Notification URI for event notification. | | +| qosMon | QosMonitoringInformationRm | O | 0..1 | Qos Monitoring information. It can be present when the event "QOS_MONITORING" is subscribed. | | +| usgThres | UsageThresholdRm | C | 0..1 | Includes the volume and/or time thresholds for sponsored data connectivity. It can be present when the notified event is "USAGE_REPORT". | | +| notifCorreId | string | O | 0..1 | It is used to set the value of Notification Correlation ID in the corresponding notification. | | + +#### 6.2.6.2.6 Type EventsNotification + +**Table 6.2.6.2.6-1: Definition of type EventsNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|-----------------------------------------------------------------------------------------------|---------------| +| notifCorreId | string | M | 1 | It is used to set the value of Notification Correlation ID in the corresponding notification. | | +| events | array(EventNotification) | M | 1..N | Contains the reported event(s). | | + +### 6.2.6.2.7 Type EventNotification + +**Table 6.2.6.2.7-1: Definition of type EventNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| event | TscEvent | M | 1 | Indicates the event reported by the TSCTSF. | | +| flowIds | array(integer) | O | 1..N | Identifies the flows that were sent during event subscription | | +| qosMonReports | array(QosMonitoringReport) | C | 1..N | QoS Monitoring reporting information. It shall be present when the notified event is "QOS_MONITORING". | | +| appliedQosRef | string | C | 0..1 | The currently applied alternative QoS requirement referring to an alternative QoS reference or a requested alternative QoS parameter set. Applicable for event QOS_NOT_GUARANTEED or SUCCESSFUL_RESOURCES_ALLOCATION.
When it is omitted and the "event" attribute is QOS_NOT_GUARANTEED, the event report indicates that the lowest priority alternative QoS profile could not be fulfilled either. | | +| usgRep | AccumulatedUsage | C | 0..1 | Indicates the measured volume and/or time for sponsored data connectivity. Applicable for event USAGE_REPORT. | | +| altQosNotSupplnd | boolean | O | 0..1 | It may be set to true when the "event" attribute is QOS_NOT_GUARANTEED to indicate that alternative service requirements are not supported by NG-RAN. The default value false shall apply if the attribute is not present. | AltQoSProfiles SupportReport | +| batOffsetInfo | BatOffsetInfo | C | 0..1 | The offset of the BAT and the optionally adjusted periodicity.
It shall be present if available when the notified event is "BAT_OFFSET_INFO". | EnTSCAC | + +### 6.2.6.2.8 Type AdditionalInfoTsctsfQosTscac + +**Table 6.2.6.2.8-1: Definition of type AdditionalInfoTsctsfQosTscac** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| acceptableServInfo | AcceptableServiceInfo | O | 0..1 | Describes information related to the acceptable service information, i.e., the maximum acceptable bandwidth for an AF session and/or for specific media components. | | + +### 6.2.6.2.9 Type TemporalValidity + +**Table 6.2.6.2.9-1: Definition of type TemporalValidity** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| startTime | DateTime | M | 1 | Indicates the time from which the traffic routing requirements cease to apply.

The absence of this attribute indicates that the traffic routing requirements do not end at any time. | | +| stopTime | DateTime | M | 1 | Indicates the time starting from which the traffic routing requirements start to apply.

The absence of this attribute indicates the traffic routing requirements apply immediately. | | + +### 6.2.6.3 Simple data types and enumerations + +#### 6.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +**Table 6.2.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|------------------------------------------------------------------|-------------|---------------| +| | | | | + +#### 6.2.6.3.3 Enumeration: TscEvent + +The enumeration TscEvent represents event for TSC. It shall comply with the provisions defined in table 6.2.6.3.3-1. + +**Table 6.2.6.3.3-1: Enumeration TscEvent** + +| Enumeration value | Description | Applicability | +|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| FAILED_RESOURCES_ALLOCATION | Indicates that one or more of the SDFs of an Individual TSC Application Session Context are deactivated. It also indicates that the resources requested for a particular service information cannot be successfully allocated. | | +| SUCCESSFUL_RESOURCES_ALLOCATION | Indicates that the resources requested for particular service information have been successfully allocated. | | +| QOS_GUARANTEED | The QoS targets of one or more SDFs are guaranteed again. | | +| QOS_NOT_GUARANTEED | The QoS targets of one or more SDFs are not being guaranteed. | | +| QOS_MONITORING | Indicates a QoS monitoring event. | | +| USAGE_REPORT | Volume and/or time usage for sponsored data connectivity. | | +| BAT_OFFSET_INFO | Indicates the BAT offset and the optionally adjusted periodicity. | EnTSCAC | + +## 6.2.6.4 Data types describing alternative data types or combinations of data types + +### 6.2.6.4.1 Type: ProblemDetailsTsctsfQosTscac + +**Table 6.2.6.4.1-1: Definition of type ProblemDetailsTsctsfQosTscac as a list of to be combined data types** + +| Data type | Cardinality | Description | Applicability | +|------------------------------|-------------|---------------------------------------------------------------------------------------|---------------| +| ProblemDetails | 1 | Problem details when returning an error response as specified in 3GPP TS 29.571 [15]. | | +| AdditionalInfoTsctsfQosTscac | 1 | Describes additional error information specific for this API. | | + +## 6.2.7 Error Handling + +### 6.2.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +For the Ntsctsf\_QoSandTSCAssistance API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Ntsctsf\_QoSandTSCAssistance API. + +### 6.2.7.2 Protocol Errors + +No specific procedures for the Ntsctsf\_QoSandTSCAssistance service are specified. + +### 6.2.7.3 Application Errors + +The application errors defined for the Ntsctsf\_QoSandTSCAssistance service are listed in Table 6.2.7.3-1. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------------------------|---------------------------|--------------------------------------------------------------------------| +| REQUESTED_SERVICE_NOT_AUTHORIZED | 403 Forbidden | The service information provided in the request is rejected. | +| REQUESTED_SERVICE_TEMPORARILY_NOT_AUTHORIZED | 403 Forbidden | The service information provided in the request is temporarily rejected. | +| UNAUTHORIZED_SPONSORED_DATA_CONNECTIVITY | 403 Forbidden | The request for sponsored data connectivity is not authorized. | +| PDU_SESSION_NOT_AVAILABLE | 500 Internal Server Error | The PDU session is not found for the provided UE address. | + +## 6.2.8 Feature negotiation + +The optional features in table 6.2.8-1 are defined for the Ntsctsf\_QoSandTSCAssistance API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Ethernet_UL/DL_Flows | Indicates the support of the description of the Ethernet flows as the combination of Flow Identifier, and UL and/or DL Ethernet flows. | +| 2 | PacketDelayFailureReport | Indicates the support of packet delay failure report as part of QoS Monitoring procedures. | +| 3 | ExtQoS | Indicates the support of extended QoS parameters. | +| 4 | EnTSCAC | Indicates the support of extensions to TSCAC, e.g. burst arrival time window adaptation, periodicity adjustment, and subsequent BAT offset report. | +| 5 | AltQoSProfilesSupportReport | This feature indicates the support of the report of whether Alternative QoS parameters are supported by NG-RAN. | +| 6 | GMEC | This feature indicates the support of Generic Group Management, Exposure and Communication Enhancements.
The following functionalities are supported:
- AF requested QoS for a UE or a group of UE(s) not identified by UE address. | + +## 6.2.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Ntsctsf\_QoSandTSCAssistance API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Ntsctsf\_QoSandTSCAssistance API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Ntsctsf\_QoSandTSCAssistance service. + +The Ntsctsf\_QoSandTSCAssistance API defines a single scope "ntsctsf-qos-tscai" for the entire service, and it does not define any additional scopes at resource or operation level. + +## 6.3 Ntsctsf\_ASTI Service API + +### 6.3.1 Introduction + +The Ntsctsf\_ASTI service shall use the Ntsctsf\_ASTI API. + +The API URI of the Ntsctsf\_ASTI API shall be: + +**{apiRoot}//** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "ntsctsf-asti". +- The shall be "v1". +- The shall be set as described in clause 6.3.3. + +## 6.3.2 Usage of HTTP + +### 6.3.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Ntsctsf\_ASTI API is contained in Annex A. + +### 6.3.2.2 HTTP standard headers + +#### 6.3.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +#### 6.3.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +### 6.3.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +In this Release of the specification, no specific custom headers are defined for the Ntsctsf\_ASTI API. + +## 6.3.3 Resources + +### 6.3.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.2.3.1-1 depicts the resource URIs structure for the Ntsctsf\_ASTI API. + +![Diagram showing the resource URI structure of the Ntscts-f_ASTI API. The root path is {apiRoot}/ntscts-f-asti/. It branches into /configurations, which further branches into /configId and /retrieve.](da85343976fdbb19f866d9ddbdad0eae_img.jpg) + +{apiRoot}/ntscts-f-asti/ + +``` + +graph TD + Root["{apiRoot}/ntscts-f-asti/"] --> Configurations["/configurations"] + Configurations --> ConfigId["/{configId}"] + Configurations --> Retrieve["/retrieve"] + +``` + +Diagram showing the resource URI structure of the Ntscts-f\_ASTI API. The root path is {apiRoot}/ntscts-f-asti/. It branches into /configurations, which further branches into /configId and /retrieve. + +**Figure 6.3.3.1-1: Resource URI structure of the Ntscts-f\_ASTI API** + +Table 6.3.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.3.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-------------------------------|----------------------------|---------------------------------|-------------------------------------------------------------------------------| +| ASTI Configurations | /configurations | POST | Create a new configuration of the 5G access stratum time distribution. | +| | | retrieve (POST) | Request the status of the access stratum time distribution for a list of UEs. | +| Individual ASTI Configuration | /configurations/{configId} | PUT | Request to update the 5G access stratum time distribution configuration. | +| | | DELETE | Request to delete the 5G access stratum time distribution configuration. | + +**Editor's note:** It is FFS whether a new resource and applicable methods are required to support the subscription to notification of the status of the ASTI time synchronization service. + +### 6.3.3.2 Resource: ASTI Configurations + +#### 6.3.3.2.1 Description + +This resource allows a NF service consumer to create a new Individual ASTI Configuration resource. + +#### 6.3.3.2.2 Resource Definition + +Resource URI: {apiRoot}/ntscts-f-asti//configurations + +This resource shall support the resource URI variables defined in table 6.3.3.2.2-1. + +**Table 6.3.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.3.1 | + +### 6.3.3.2.3 Resource Standard Methods + +#### 6.3.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.3.3.2.3.1-1. + +**Table 6.3.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.3.3.2.3.1-2 and the response data structures and response codes specified in table 6.3.3.2.3.1-3. + +**Table 6.3.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|--------------------------------------------------------------------------------------------| +| AccessTimeDistributionData | M | 1 | Contains the information for the creation of a new Individual ASTI Configuration resource. | + +**Table 6.3.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------|---|-------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AccessTimeDistributionData | M | 1 | 201
Created | The resource was created successfully and a representation of the created resource is returned.

The URI of the created resource shall be returned in the "Location" HTTP header. | +| ProblemDetails | O | 0..1 | 403
Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: Failure cases are described in clause 6.3.7. + +**Table 6.3.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/ntscstf-asti//configurations/{configId} | + +### 6.3.3.2.4 Resource Custom Operations + +#### 6.3.3.2.4.1 Overview + +**Table 6.3.3.2.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------|--------------------------|--------------------|----------------------------------------------------------------------------------| +| retrieve | /configurations/retrieve | retrieve (POST) | Request the status of the 5G access stratum time distribution for a list of UEs. | + +6.3.3.2.4.2 Operation: retrieve + +6.3.3.2.4.2.1 Description + +6.3.3.2.4.2.2 Operation Definition + +This custom operation retrieves the status of the access stratum time distribution for a list of UEs. + +This operation shall support the request data structures specified in table 6.3.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.3.3.2.4.2.2-2. + +**Table 6.3.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| Status requestData | M | 1 | Parameters to be sent by the NF service consumer when the status of the 5G access stratum time distribution for a list of UEs is requested. | + +**Table 6.3.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------| +| Status Response Data | M | 1 | 200 OK | Status of the 5G access stratum time distribution for a list of UEs is returned. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] shall also apply. | | | | | + +6.3.3.3 Resource: Individual ASTI Configuration + +6.3.3.3.1 Description + +This resource allows a NF service consumer to read, modify or delete an existing Individual ASTI Configuration resource. + +6.3.3.3.2 Resource Definition + +Resource URI: {apiRoot}/ntscsf-asti//configurations/{configId} + +This resource shall support the resource URI variables defined in table 6.3.3.3.2-1. + +**Table 6.3.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------|-----------|----------------------------------------------------------| +| apiRoot | string | See clause 6.3.1 | +| configId | string | Identifier of an Individual ASTI Configuration resource. | + +6.3.3.3.3 Resource Standard Methods + +6.3.3.3.3.2 PUT + +This method shall support the URI query parameters specified in table 6.3.3.3.3.2-1. + +**Table 6.3.3.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.3.3.3.3.2-2 and the response data structures and response codes specified in table 6.3.3.3.3.2-3. + +**Table 6.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|--------------------------------------------------------------------------------------| +| AccessTimeDistributionData | M | 1 | Contains the modification(s) to apply to the Individual ASTI Configuration resource. | + +**Table 6.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| AccessTimeDistributionData | M | 1 | 200 OK | Successful case. The Individual ASTI Configuration resource was modified and a representation of that resource is returned. | +| n/a | | | 204 No Content | Successful case. The Individual ASTI Configuration resource was modified. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during an Individual ASTI Configuration resource modification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during an Individual ASTI Configuration resource modification.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 3) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the PUT method shall also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +NOTE 3: Failure cases are described in clause 6.3.7. + +**Table 6.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +### 6.3.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.3.3.3.3-1. + +**Table 6.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.3.3.3.3-2 and the response data structures and response codes specified in table 6.3.3.3.3-3. + +**Table 6.3.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.3.3.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The configuration was terminated successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during an Individual ASTI Configuration resource modification deletion.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during an Individual ASTI Configuration resource modification deletion.
(NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the DELETE method shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.3.3.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.3.3.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +#### 6.3.3.3.4 Resource Custom Operations + +None. + +### 6.3.4 Custom Operations without associated resources + +None. + +## 6.3.5 Notifications + +### 6.3.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 6.3.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-------------------|----------------|---------------------------------|---------------------------------| +| ASTI Notification | {astiNotifUri} | POST | ASTI notification. | + +### 6.3.5.2 ASTI Notification + +#### 6.3.5.2.1 Description + +The ASTI Notification is used by the NF service producer to report the changes on the ASTI service. + +#### 6.3.5.2.2 Target URI + +The Callback URI "{astiNotifUri}" shall be used with the callback URI variables defined in table 6.3.5.2.2-1. + +**Table 6.3.5.2.2-1: Callback URI variables** + +| Name | Definition | +|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| astiNotifUri | String formatted as URI with the Callback Uri.
The Callback Uri is assigned within the Individual ASTI Configuration resource and described within the AccessTimeDistributionData data type (see table 6.3.6.2.2-1). | + +#### 6.3.5.2.3 Standard Methods + +##### 6.3.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.3.5.2.3.1-1 and the response data structures and response codes specified in table 6.3.5.2.3.1-1. + +**Table 6.3.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|-------------------------------------------------------------------------------| +| AstiConfigNotification | M | 1 | Provides the change in the 5G Access Stratum Time Distribution configuration. | + +**Table 6.3.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------| +| n/a | | | 204 No Content | The event notification is received successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during event notification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.3.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +**Table 6.3.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +## 6.3.6 Data Model + +### 6.3.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.3.6.1-1 specifies the data types defined for the Ntsctsf\_ASTI service based interface protocol. + +**Table 6.3.6.1-1: Ntsctsf\_ASTI specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-----------------------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------| +| AccessTimeDistributionData | 6.3.6.2.2 | Contains the parameters for the creation of 5G access stratum time distribution configuration. | | +| ActiveUe | 6.3.6.2.6 | Contains the UE identifier whose status of the access stratum time distribution is active and the optional requested time synchronization error budget. | | +| AstiConfigNotification | 6.3.6.2.7 | Contains the report of a change in the 5G Access Stratum Time Distribution parameters applied to the UE(s). | ASTIConfigReport | +| AstiConfigStateNotification | 6.3.6.2.8 | Contains the report about a change in the 5G Access Stratum Time Distribution parameters for a UE. | ASTIConfigReport
NetTimeSyncStatus | +| AstiEvent | 6.3.6.3.3 | ASTI Event. | ASTIConfigReport
NetTimeSyncStatus | +| AsTimeDistributionParam | 6.3.6.2.3 | Contains the 5G access stratum time distribution parameters. | | +| StatusRequestData | 6.3.6.2.4 | Contains the parameters for retrieval of the status of the access stratum time distribution for a list of UEs. | | +| StatusResponseData | 6.3.6.2.5 | Contains the parameters for the status of the access stratum time distribution for a list of UEs. | | + +Table 6.3.6.1-2 specifies data types re-used by the Ntsctsf\_ASTI service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Ntsctsf\_ASTI service based interface. + +**Table 6.3.6.1-2: Ntsctsf\_ASTI re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|---------------------------------|---------------------|----------------------------------------------------------------------------------------|---------------------------------------| +| ClockQualityAcceptanceCriterion | 3GPP TS 29.571 [15] | Identifies clock quality acceptance criteria information. | NetTimeSyncStatus | +| ClockQualityDetailLevel | 3GPP TS 29.571 [15] | Indicates the clock quality detail level information. | NetTimeSyncStatus | +| ExternalGroupId | 3GPP TS 29.571 [15] | Identifies an External Group. | | +| Gpsi | 3GPP TS 29.571 [15] | The external identification of the user (i.e., an External Id or an MSISDN). | | +| GroupId | 3GPP TS 29.571 [15] | Identifies a group of internal globally unique ID. | | +| ProblemDetails | 3GPP TS 29.571 [15] | Problem Details when returning an error response. | | +| RedirectResponse | 3GPP TS 29.571 [15] | Contains redirection related information. | | +| ServiceAreaCoverageInfo | 3GPP TS 29.534 [14] | It represents a list of Tracking Areas within a serving network. | CoverageAreaSupport | +| Supi | 3GPP TS 29.571 [15] | The identification of the user (i.e. IMSI, NAI). | | +| SupportedFeatures | 3GPP TS 29.571 [15] | Used to negotiate the applicability of the optional features defined in table 6.3.8-1. | | +| TemporalValidity | 3GPP TS 29.514 [20] | TemporalValidity | | +| Uinteger | 3GPP TS 29.571 [15] | Unsigned integer. | | +| Uri | 3GPP TS 29.571 [15] | Identifies a referenced resource. | ASTIConfigReport
NetTimeSyncStatus | + +### 6.3.6.2 Structured data types + +#### 6.3.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +#### 6.3.6.2.2 Type: AccessTimeDistributionData + +**Table 6.3.6.2.2-1: Definition of type AccessTimeDistributionData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| supis | array(Supi) | C | 1..N | Subscription Permanent Identifier(s). (NOTE 1) | | +| gpsi | array(Gpsi) | C | 1..N | Public user Identifier(s). (NOTE 1) | | +| interGrpId | GroupId | C | 0..1 | The internal Group Id(s). (NOTE 1) | | +| exterGrpId | ExternalGroupId | C | 0..1 | The external Group Id(s). (NOTE 1) | | +| asTimeDisParam | AsTimeDistributionParam | M | 1 | 5G access stratum time distribution parameters. (NOTE 2) | | +| covReq | array(ServiceAreaCoverageInfo) | O | 1..N | Identifies a list of Tracking Areas per serving network where the 5GS access stratum time distribution service is allowed. | CoverageAreaSupport | +| astiNotifUri | Uri | C | 0..1 | Notification URI for reporting changes in 5G access stratum time distribution status, and/or reporting the 5G access stratum time distribution information. It shall be provided if the ASTIConfigReport feature is supported and/or the NetTimeSyncStatus feature is supported. | ASTIConfigReport | +| astiNotifId | string | C | 0..1 | Notification Correlation ID assigned by the NF service consumer. It shall be provided if the ASTIConfigReport feature is supported. | ASTIConfigReport | +| suppFeat | SupportedFeatures | C | 0..1 | Represents the features supported by the NF service consumer. This parameter shall be supplied by the NF service consumer in the POST request and the response that requested the creation of an Individual ASTI Configuration resource. | | + +NOTE 1: One of "supis", "gpsi", "exterGroupId" or "interGrpId" attributes shall be provided. + +NOTE 2: If the feature "NetTimeSyncStatus" is supported, the "clkQltDetLvl" and "clkQltAcptCri" attributes within the AsTimeDistributionParam data type shall be present together with the "astiNotifUri" attribute. + +## 6.3.6.2.3 Type: AsTimeDistributionParam + +Table 6.3.6.2.3-1: Definition of type AsTimeDistributionParam + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| asTimeDisEnabled | boolean | O | 0..1 | When this attribute is included and set to true, it indicates that the access stratum time distribution via Uu reference point is activated.
When present it shall be set as follows:
- true: activated.
- false (default): deactivated. | | +| timeSyncErrBdgt | UInteger | O | 0..1 | Indicates the time synchronization error budget in terms of time units of nanoseconds. | | +| tempValidity | TemporalValidity | O | 0..1 | Indicates the time interval during which the AF request is to be applied. | | +| clkQltDetLvl | ClockQualityDetailLevel | O | 0..1 | For ASTI services, its value, if provided, shall be set to "ACCEPT_INDICATION" | NetTimeSyncStatus | +| clkQltAcptCri | ClockQualityAcceptanceCriterion | C | 0..1 | It indicates the acceptable clock quality acceptance criteria for the UE, and it is used to determine whether the time synchronization status for the ASTI service is acceptable/not acceptable. It shall be present when the "clkQltDetLvl" attribute is present. | NetTimeSyncStatus | + +## 6.3.6.2.4 Type: Status requestData + +Table 6.3.6.2.4-1: Definition of type Status requestData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------------------------------------------|-------------|---|-------------|---------------------------------------|---------------| +| supis | array(Supi) | C | 1..N | Subscription Permanent Identifier(s). | | +| gpsi | array(Gpsi) | C | 1..N | Public User Identifier(s). | | +| NOTE: Either the "supis" or the "gpsi" attribute is included. | | | | | | + +## 6.3.6.2.5 Type: StatusResponseData + +Table 6.3.6.2.5-1: Definition of type StatusResponseData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| inactiveUes | array(Supi) | O | 1..N | Indicate the SUPI(s) whose status of the access stratum time distribution is inactive. (NOTE) | | +| inactiveGpsis | array(Gpsi) | O | 1..N | Indicate the GPSI(s) whose status of the access stratum time distribution is inactive. (NOTE) | | +| activeUes | array(ActiveUe) | O | 1..N | Contains the UE identifier(s) whose status of the access stratum time distribution is active and the optional requested time synchronization error budget. | | + +NOTE: Either the "inactiveUes" or the "inactiveGpsis" attribute is included, based on whether the request contained an internal or an external identifier. + +## 6.3.6.2.6 Type: ActiveUe + +Table 6.3.6.2.6-1: Definition of type ActiveUe + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------|---|-------------|------------------------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | Indicate the SUPI whose status of the access stratum time distribution is active. (NOTE) | | +| gpsi | Gpsi | C | 0..1 | Indicate the GPSI whose status of the access stratum time distribution is active. (NOTE) | | +| timeSyncErrBdgt | Uinteger | O | 0..1 | Indicates the time synchronization error budget in terms of time units of nanoseconds. | | + +NOTE: Either the "supi" or the "gpsi" attribute is included, based on whether the request contained an internal or an external identifier. + +## 6.3.6.2.7 Type: AstiConfigNotification + +Table 6.3.6.2.7-1: Definition of type AstiConfigNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------------------|---|-------------|-----------------------------------------------------------------------------------------------|------------------| +| astiNotifId | string | M | 1 | It is used to set the value of Notification Correlation ID in the corresponding notification. | | +| stateConfigs | array(AstiConfigEventNotification) | O | 1..N | Contains change of state of 5G access stratum time distribution configuration. | ASTIConfigReport | + +### 6.3.6.2.8 Type AstiConfigStateNotification + +**Table 6.3.6.2.8-1: Definition of type AstiConfigStateNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------------------------------------------------|-----------|---|-------------|----------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | Identifies the UE to which the status below apply. | | +| gpsi | Gpsi | C | 0..1 | Identifies the UE to which the status below apply. | | +| event | AstiEvent | M | 1 | Indicates the reported event. | | +| NOTE: Only one of the properties "supi" or "gpsi" shall be included. | | | | | | + +### 6.3.6.3 Simple data types and enumerations + +#### 6.3.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 6.3.6.3.2 Simple data types + +The simple data types defined in table 6.3.6.3.2-1 shall be supported. + +**Table 6.3.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +#### 6.3.6.3.3 Enumeration: AstiEvent + +The enumeration AstiEvent represents event for ASTI service. It shall comply with the provisions defined in table 6.3.6.3.3-1. + +**Table 6.3.6.3.3-1: Enumeration AstiEvent** + +| Enumeration value | Description | Applicability | +|---------------------------|--------------------------------------------------------------------------------------------|---------------| +| ASTI_ENABLED | Indicates that the access stratum time distribution via Uu reference point is activated. | | +| ASTI_DISABLED | Indicates that the access stratum time distribution via Uu reference point is deactivated. | | +| CLOCK_QUAL_ACCEPTABLE | Indicates the UE meets the clock quality acceptance criteria. | | +| CLOCK_QUAL_NON_ACCEPTABLE | Indicates the UE does not meet the clock quality acceptance criteria | | + +## 6.3.7 Error Handling + +### 6.3.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [5]. + +For the Ntscstf\_ASTI API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an + +HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Ntsctsf\_ASTI API. + +### 6.3.7.2 Protocol Errors + +No specific procedures for the Ntsctsf\_ASTI service are specified. + +### 6.3.7.3 Application Errors + +The application errors defined for the Ntsctsf\_ASTI service are listed in Table 6.3.7.3-1. + +**Table 6.3.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------|------------------|----------------------------------------------------------| +| UE_SERVICE_NOT_AUTHORIZED | 403 Forbidden | The request service for the target UE is not authorized. | + +## 6.3.8 Feature negotiation + +The optional features in table 6.3.8-1 are defined for the Ntsctsf\_ASTI API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.3.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | CoverageAreaSupport | Indicates the support of time synchronization coverage area conditions for the activation/deactivation of the time synchronization service.
It requires the support of ASTIConfigReport feature. | +| 2 | ASTIConfigReport | Indicates the support of the report of ASTI service status information and/or ASTI configuration changes. | +| 3 | NetTimeSyncStatus | Indicates the time synchronization service status | + +## 6.3.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Ntsctsf\_ASTI API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Ntsctsf\_ASTI API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Ntsctsf\_ASTI service. + +The Ntsctsf\_ASTI API defines a single scope "ntsctsf-asti" for the entire service, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## A.2 Ntsctsf\_TimeSynchronization API + +``` +openapi: 3.0.0 + +info: + title: Ntsctsf_TimeSynchronization Service API + version: 1.1.0-alpha.5 + description: | + TSCTSF Time Synchronization Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.565 V18.4.0; 5G System; Time Sensitive Communication and Time Synchronization +Function + Services; Stage 3. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.565/' +servers: + - url: '{apiRoot}/ntsctsf-time-sync/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - ntsctsf-time-sync + +paths: + /subscriptions: + post: + summary: Creates a new subscription to notification of capability of time synchronization + service resource + operationId: TimeSynchronizationExposureSubscriptions + tags: + - Time Synchronization Exposure Subscriptions (Collection) + requestBody: + description: Contains the information for the creation the resource. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TimeSyncExposureSubsc' + responses: + '201': + description: Successful creation of the resource. +``` + +``` +content: + application/json: + schema: + $ref: '#/components/schemas/TimeSyncExposureSubsc' +headers: + Location: + description: > + Contains the URI of the created individual time synchronization exposure + subscription resource, according to the structure + {apiRoot}/ntsctsf-time-sync/{apiVersion}/subscriptions/{subscriptionId} + required: true + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + subsEventNotification: + "{$request.body#/subsNotifUri": + post: + requestBody: + description: Notification of an event occurrence in the TSCTSF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TimeSyncExposureSubsNotif' +responses: + '204': + description: The receipt of the notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}: + get: + summary: "Reads an existing Individual Time Synchronization Exposure Subscription" + operationId: GetIndividualTimeSynchronizationExposureSubscription + tags: + - Individual Time Synchronization Exposure Subscription (Document) + parameters: + - name: subscriptionId + description: String identifying an Individual Time Synchronization Exposure Subscription + in: path + required: true + schema: + type: string + responses: + '200': + description: A representation of the resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/TimeSyncExposureSubsc' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + put: + operationId: ReplaceIndividualTimeSynchronizationExposureSubscription + summary: Replace an individual Time Synchronization Exposure Subscription + tags: + - IndividualTimeSynchronizationExposureSubscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/TimeSyncExposureSubsc' + parameters: + - name: subscriptionId + description: String identifying an Individual Time Synchronization Exposure Subscription. + in: path + required: true + schema: + type: string + responses: + '200': + description: OK. Resource was successfully modified and representation is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/TimeSyncExposureSubsc' + '204': + description: No Content. Resource was successfully modified. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + operationId: DeleteIndividualTimeSynchronizationExposureSubscription + summary: Delete an Individual Time Synchronization Exposure Subscription + tags: + - Individual Time Synchronization Exposure Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: String identifying an Individual Time Synchronization Exposure Subscription. + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}/configurations: + post: + summary: "Create a new Individual Time Synchronization Exposure Configuration" + operationId: CreateIndividualTimeSynchronizationExposureConfiguration + tags: + - Individual Time Synchronization Exposure Configuration (Document) + parameters: + - name: subscriptionId + description: String identifying an Individual Time Synchronization Exposure Subscription. + in: path + required: true + schema: + type: string + requestBody: + description: Contains the information for the creation the resource. + required: true + content: +``` + +``` + application/json: + schema: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/TimeSyncExposureConfig' +responses: + '201': + description: Successful creation of the resource. + content: + application/json: + schema: + $ref: '#/components/schemas/TimeSyncExposureConfig' + headers: + Location: + description: > + Contains the URI of the created individual time synchronization exposure + configuration resource, according to the structure + {apiRoot}/ntsctsf-time-sync/{apiVersion}/subscriptions/{subscriptionId} + /configurations/{configurationId} + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + configEventNotification: + '{ $request.body#/configNotifUri ': + post: + requestBody: + description: Notification of an event occurrence in the TSCTSF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TimeSyncExposureConfigNotif' + responses: + '204': + description: The receipt of the notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +``` + +``` + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}/configurations/{configurationId}: + get: + summary: "Reads an existing Individual Time Synchronization Exposure Configuration" + operationId: GetIndividualTimeSynchronizationExposureConfiguration + tags: + - Individual Time Synchronization Exposure Configuration (Document) + parameters: + - name: subscriptionId + description: String identifying an Individual Time Synchronization Exposure Subscription. + in: path + required: true + schema: + type: string + - name: configurationId + description: String identifying an Individual Time Synchronization Exposure Configuration. + in: path + required: true + schema: + type: string + responses: + '200': + description: A representation of the resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/TimeSyncExposureConfig' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + put: + operationId: ReplaceIndividualTimeSynchronizationExposureConfiguration + summary: Replace an individual Time Synchronization Exposure Configuration + tags: + - IndividualTimeSynchronizationExposureConfiguration (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/TimeSyncExposureConfig' + parameters: + - name: subscriptionId + description: String identifying an Individual Time Synchronization Exposure Subscription. + in: path +``` + +``` + required: true + schema: + type: string +- name: configurationId + description: String identifying an Individual Time Synchronization Exposure Configuration. + in: path + required: true + schema: + type: string +responses: + '200': + description: OK. Resource was successfully modified and representation is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/TimeSyncExposureConfig' + '204': + description: No Content. Resource was successfully modified. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + operationId: DeleteIndividualTimeSynchronizationExposureConfiguration + summary: Delete an Individual Time Synchronization Exposure Configuration + tags: + - Individual Time Synchronization Exposure Configuration (Document) + parameters: + - name: subscriptionId + in: path + description: String identifying an Individual Time Synchronization Exposure Subscription. + required: true + schema: + type: string + - name: configurationId + description: String identifying an Individual Time Synchronization Exposure Configuration. + in: path + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + ntscsf-timesynchronization: Access to the Ntscsf_TimeSynchronization API + +schemas: + TimeSyncExposureSubsc: + description: > + Contains the parameters for the subscription to notification of capability of time + synchronization service. + type: object + properties: + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + gpsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + interGrpId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + exterGrpId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalGroupId' + anyUeInd: + type: boolean + description: > + Identifies whether the request applies to any UE. This attribute shall set to "true" if + applicable for any UE, otherwise, set to "false". + notifMethod: + $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/NotificationMethod' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + subscribedEvents: + type: array + items: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/SubscribedEvent' + minItems: 1 + eventFilters: + type: array + items: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/EventFilter' + minItems: 1 + subsNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + subsNotifId: + type: string + description: Notification Correlation ID assigned by the NF service consumer. + maxReportNbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + repPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +``` + +``` + +required: + - subsNotifUri + - subsNotifId + - dnn + - snssai + - subscribedEvents +oneOf: + - required: [supis] + - required: [interGrpId] + - required: [gpsis] + - required: [exterGrpId] + - required: [anyUeInd] + +TimeSyncExposureSubsNotif: + description: Contains the notification of time synchronization service. + type: object + properties: + subsNotifId: + type: string + description: Notification Correlation ID assigned by the NF service consumer. + eventNotifs: + type: array + items: + $ref: '#/components/schemas/SubsEventNotification' + minItems: 1 + +SubsEventNotification: + description: > + Contains the notification of capability of time synchronization for a list of UEs. + type: object + properties: + event: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/SubscribedEvent' + timeSyncCapas: + type: array + items: + $ref: '#/components/schemas/TimeSyncCapability' + minItems: 1 + required: + - event + +TimeSyncCapability: + description: Contains the capability of time synchronization service. + type: object + properties: + upNodeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + gmCapables: + type: array + items: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/GmCapable' + minItems: 1 + asTimeRes: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/AsTimeResource' + ptpCapForUes: + type: object + additionalProperties: + $ref: '#/components/schemas/PtpCapabilitiesPerUe' + minProperties: 1 + description: > + Contains the PTP capabilities supported by each of the SUPI(s). The key of the map is +the + SUPI. + ptpCapForGpsis: + type: object + additionalProperties: + $ref: '#/components/schemas/PtpCapabilitiesPerUe' + minProperties: 1 + description: > + Contains the PTP capabilities supported by each of the GPSI(s). The key of the map is + the GPSI. + required: + - upNodeId + anyOf: + - required: [gmCapables] + - required: [asTimeRes] + +PtpCapabilitiesPerUe: + +``` + +``` +description: Contains the supported PTP capabilities per UE. +type: object +properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + ptpCaps: + type: array + items: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/EventFilter' + minItems: 1 + required: + - ptpCaps + oneOf: + - required: [supi] + - required: [gpsi] + +TimeSyncExposureConfigNotif: + description: Contains the notification of time synchronization service state. + type: object + properties: + configNotifId: + type: string + description: Notification Correlation ID assigned by the NF service consumer. + stateOfConfig: + $ref: '#/components/schemas/StateOfConfiguration' + required: + - configNotifId + - stateOfConfig + +StateOfConfiguration: + description: > + Contains the state of the time synchronization configuration and the clock quality + acceptance criteria result. + type: object + properties: + stateNwtt: + type: boolean + description: > + When any of the PTP port state(s) in NW-TT is Leader, Follower or Passive, it is + included and set to true to indicate the current state of the time synchronization + configuration for the NW-TT port(s) of the PTP instance is active; when + PTP port state is in any other case, it is included and set to false to indicate + the state of configuration for the NW-TT port(s) of the PTP instance + is inactive. Default value is false. + stateOfDstts: + description: > + Contains the PTP port states and the clock quality acceptance criteria result of the + DS-TT(s). + type: array + items: + $ref: '#/components/schemas/StateOfDstt' + minItems: 1 + +StateOfDstt: + description: Contains the PTP port state of a DS-TT. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + state: + type: boolean + description: > + When the PTP port state is Leader, Follower or Passive, it is included and set to true + to indicate the state of configuration for DS-TT port is active; when PTP port state is + in any other case, it is included and set to false to indicate the state of + configuration for DS-TT port is inactive. Default value is false. + clkQltIndOfDstts: + $ref: + 'TS29522_TimeSyncExposure.yaml#/components/schemas/AcceptanceCriteriaResultIndication' + required: + - state + oneOf: + - required: [supi] + - required: [gpsi] +``` + +``` +TimeSyncExposureConfig: + description: Contains the Time Synchronization Configuration parameters. + type: object + properties: + upNodeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + reqPtpIns: + $ref: '#/components/schemas/PtpInstance' + gmEnable: + type: boolean + description: > + Indicates that the AF requests 5GS to act as a grandmaster for PTP or gPTP if it is + included and set to true. + gmPrio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + timeDom: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + timeSyncErrBdgt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + configNotifId: + type: string + description: Notification Correlation ID assigned by the NF service consumer. + configNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + tempValidity: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity' + covReq: + type: array + description: > + Identifies a list of Tracking Areas per serving network where time + synchronization service configuration is allowed. + items: + $ref: 'TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/ServiceAreaCoverageInfo' + minItems: 1 + clkQltDetLvl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityDetailLevel' + clkQltAcptCri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityAcceptanceCriterion' + required: + - upNodeId + - reqPtpIns + - timeDom + - configNotifId + - configNotifUri + +PtpInstance: + description: Contains PTP instance configuration and activation requested by the AF. + type: object + properties: + instanceType: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/InstanceType' + protocol: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/Protocol' + ptpProfile: + type: string + portConfigs: + type: array + items: + $ref: '#/components/schemas/ConfigForPort' + minItems: 1 + required: + - instanceType + - protocol + - ptpProfile + +ConfigForPort: + description: Contains configuration for each port. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + n6Ind: + type: boolean + ptpEnable: +``` + +``` + + type: boolean + logSyncInter: + type: integer + logSyncInterInd: + type: boolean + logAnnouInter: + type: integer + logAnnouInterInd: + type: boolean + oneOf: + - required: [supi] + - required: [gpsi] + - required: [n6Ind] + +``` + +## A.3 Ntsctsf\_QoSandTSCAssistance API + +openapi: 3.0.0 + +``` + +info: + title: Ntsctsf_QoSandTSCAssistance Service API + version: 1.1.0-alpha.4 + description: | + TSCTSF QoS and TSC Assistance Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +``` + +``` + +externalDocs: + description: > + 3GPP TS 29.565 V18.3.0; 5G System; Time Sensitive Communication and Time Synchronization +function + Services; Stage 3. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.565/' + +``` + +``` + +servers: +- url: '{apiRoot}/ntsctsf-qos-tscai/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +``` + +``` + +security: +- {} +- oAuth2ClientCredentials: +- ntsctsf-qos-tscai + +``` + +``` + +paths: + /tsc-app-sessions: + post: + summary: Creates a new Individual TSC Application Session Context resource + operationId: PostTSCAppSessions + tags: + - TSC Application Sessions (Collection) + requestBody: + description: Contains the information for the creation the resource. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TscAppSessionContextData' + responses: + '201': + description: Successful creation of the resource. + content: + application/json: + schema: + $ref: '#/components/schemas/TscAppSessionContextData' + headers: + Location: + description: > + Contains the URI of the created individual TSC application session context resource, + according to the structure + {apiRoot}/ntsctsf-qos-tscai//tsc-app-sessions/{appSessionId} or the + URI of the created events subscription sub-resource, according to the structure + {apiRoot}/ntsctsf-qos-tscai//tsc-app-sessions/{appSessionId}/ + events-subscription} + required: true + +``` + +``` + + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetailsTsctsfQosTscac' + headers: + Retry-After: + description: > + Indicates the time the AF has to wait before making a new request. It can be a + non-negative integer (decimal number) indicating the number of seconds the AF + has to wait before making a new request or an HTTP-date after which the AF can + retry a new request. + schema: + type: string +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + terminationRequest: + '{$request.body#/notifUri}/terminate': + post: + requestBody: + description: > + Request of the termination of the Individual TSC Application Session Context + required: true + content: + application/json: + schema: + $ref: +'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TerminationInfo' + responses: + '204': + description: The receipt of the notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + eventNotification: + '{ $request.body#/evSubsc/notifUri }/notify': + post: + requestBody: + description: Notification of an event occurrence in the TSCTSF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventsNotification' + responses: + '204': + description: The receipt of the notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/tsc-app-sessions/{appSessionId}: + get: + summary: Reads an existing Individual TSC Application Session Context + operationId: GetTSCAppSession + tags: + - Individual TSC Application Session Context (Document) + parameters: + - name: appSessionId + description: String identifying the resource. + in: path + required: true + schema: + type: string + responses: + '200': + description: A representation of the resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/TscAppSessionContextData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + +``` + +``` + + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: Modifies an existing Individual TSC Application Session Context + operationId: ModAppSession + tags: + - Individual TSC Application Session Context (Document) + parameters: + - name: appSessionId + description: String identifying the resource. + in: path + required: true + schema: + type: string + requestBody: + description: Modification of the resource. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/TscAppSessionContextUpdateData' + responses: + '200': + description: > + successful modification of the resource and a representation of that resource is + returned. + content: + application/json: + schema: + $ref: '#/components/schemas/TscAppSessionContextData' + '204': + description: The successful modification. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetailsTsctsfQoSTscac' + headers: + Retry-After: + description: > + Indicates the time the AF has to wait before making a new request. It can be a + non-negative integer (decimal number) indicating the number of seconds the AF + has to wait before making a new request or an HTTP-date after which the AF can + retry a new request. + schema: + type: string + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + eventNotification: + '{ $request.body#/evSubsc/notifUri }/notify': + post: + requestBody: + description: Notification of an event occurrence in the TSCTSF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventsNotification' + responses: + '204': + description: The receipt of the notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/tsc-app-sessions/{appSessionId}/delete: + post: + summary: Deletes an existing Individual TSC Application Session Context + operationId: DeleteTSCAppSession + tags: + - Individual TSC Application Session Context (Document) + parameters: + - name: appSessionId + description: String identifying the Individual TSC Application Session Context resource. + in: path + required: true + schema: + type: string + requestBody: + description: > + Deletion of the Individual TSC Application Session Context resource, request notification. + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/EventsSubscReqData' + responses: + '200': + description: The deletion of the resource is confirmed and a resource is returned + content: + application/json: + schema: + $ref: '#/components/schemas/EventsNotification' + '204': + description: The deletion is confirmed without returning additional data. + '307': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/tsc-app-sessions/{appSessionId}/events-subscription: + put: + summary: Creates or modifies an Events Subscription subresource + operationId: putEventsSubsc + tags: + - Events Subscription (Document) + parameters: + - name: appSessionId + description: String identifying the Events Subscription resource + in: path + required: true + schema: + type: string + requestBody: + description: Creation or modification of an Events Subscription resource. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventsSubscReqData' + responses: + '201': + description: > + The creation of the Events Subscription resource is confirmed and its representation is + returned. + content: + application/json: + schema: + $ref: '#/components/schemas/EventsSubscReqData' + headers: + Location: + description: > + Contains the URI of the created Events Subscription resource, + according to the structure + {apiRoot}/ntscts-f-qos-tscai//tsc-app-sessions/{appSessionId}/ + events-subscription + required: true + schema: + type: string + '200': + description: > + The modification of the Events Subscription resource is confirmed and its representation + is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/EventsSubscReqData' + '204': + description: > + The modification of the Events Subscription subresource is confirmed without returning + additional data. + +``` + +``` + + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + eventNotification: + '{$request.body#/notifyUri}/notify': + post: + requestBody: + description: > + Contains the information for the notification of an event occurrence in the +TSCTSF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventsNotification' + responses: + '204': + description: The receipt of the notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Deletes the Events Subscription subresource. + operationId: DeleteEventsSubsc + tags: + - Events Subscription (Document) + parameters: + +``` + +``` + +- name: appSessionId + description: String identifying the Individual TSC Application Session Context resource + in: path + required: true + schema: + type: string +responses: + '204': + description: > + The deletion of the of the Events Subscription sub-resource is confirmed without +returning + additional data. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + ntscts-f-qos-tscai: Access to the Ntscts-f_QoSAndTSCAssistance API + +schemas: + TscAppSessionContextData: + description: Represents an Individual TSC Application Session Context resource. + type: object + required: + - notifUri + - afId + - qosReference + allOf: + - oneOf: + - required: [ueIpAddr] + - required: [ueMac] + - required: [ueId] + - required: [externalGroupId] + - not: + required: [ethFlowInfo, enEthFlowInfo] + - not: + required: [altQosReqs, altQosReferences] + - not: + required: [qosReference, altQosReqs] + properties: + ueIpAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + ipDomain: + type: string + description: The IPv4 address domain identifier. + ueMac: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + ueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + externalGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalGroupId' + +``` + +``` + +dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +appId: + type: string + description: Identifies the Application Identifier. +ethFlowInfo: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + minItems: 1 +enEthFlowInfo: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/EthFlowInfo' + minItems: 1 + description: > + Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow + identifier and the corresponding UL and/or DL flows. +flowInfo: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 +afId: + type: string + description: Identifies the AF identifier. +tscQosReq: + $ref: 'TS29122_AsSessionWithQoS.yaml#/components/schemas/TscQosRequirement' +qosReference: + type: string + description: Identifies a pre-defined QoS information. +altQosReferences: + type: array + items: + type: string + minItems: 1 + description: Identifies an ordered list of pre-defined QoS information. +altQosReqs: + type: array + items: + $ref: + 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AlternativeServiceRequirementsData' + minItems: 1 + description: > + Identifies an ordered list of alternative service requirements that include individual + QoS parameter sets. The lower the index of the array for a given entry, the higher the + priority. +aspId: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AspId' +sponId: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/SponId' +sponStatus: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/SponsoringStatus' +evSubsc: + $ref: '#/components/schemas/EventsSubscReqData' +tempInValidity: + $ref: '#/components/schemas/TemporalInValidity' +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +TscAppSessionContextUpdateData: + description: > + Describes the authorization data of an Individual TSC Application Session Context created by + the PCF. + type: object + properties: + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + appId: + type: string + description: Identifies the Application Identifier. + ethFlowInfo: + type: array + items: + +``` + +``` + + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + minItems: 1 + enEthFlowInfo: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/EthFlowInfo' + minItems: 1 + description: > + Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow + identifier and the corresponding UL and/or DL flows. + flowInfo: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 + tscQosReq: + $ref: 'TS29122_AsSessionWithQoS.yaml#/components/schemas/TscQosRequirementRm' + qosReference: + type: string + description: Identifies a pre-defined QoS information. + altQosReferences: + type: array + items: + type: string + minItems: 1 + description: Identifies an ordered list of pre-defined QoS information. + altQosReqs: + type: array + items: + $ref: +'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AlternativeServiceRequirementsData' + minItems: 1 + description: > + Identifies an ordered list of alternative service requirements that include individual + QoS parameter sets. The lower the index of the array for a given entry, the higher the + priority. + aspId: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AspId' + sponId: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/SponId' + sponStatus: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/SponsoringStatus' + evSubsc: + $ref: '#/components/schemas/EventsSubscReqDataRm' + tempInvalidity: + $ref: '#/components/schemas/TemporalInvalidity' + allOf: + - not: + required: [ethFlowInfo, enEthFlowInfo] + - not: + required: [altQosReqs, altQosReferences] + - not: + required: [qosReference, altQosReqs] + +EventsSubscReqData: + description: Identifies the events the application subscribes to. + type: object + required: + - events + - notifUri + - notifCorreId + properties: + events: + type: array + items: + $ref: '#/components/schemas/TscEvent' + minItems: 1 + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + qosMon: + $ref: 'TS29122_AsSessionWithQoS.yaml#/components/schemas/QosMonitoringInformation' + usgThres: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + notifCorreId: + type: string + +EventsSubscReqDataRm: + description: > + +``` + +``` + +This data type is defined in the same way as the EventsSubscReqData data type, but with the +OpenAPI nullable property set to true. +type: object +required: +- events +properties: + events: + type: array + items: + $ref: '#/components/schemas/TscEvent' + minItems: 1 + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + qosMon: + $ref: 'TS29122_AsSessionWithQoS.yaml#/components/schemas/QosMonitoringInformationRm' + usgThres: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThresholdRm' + notifCorreId: + type: string +nullable: true + +EventsNotification: + description: Describes the notification of matched events. + type: object + required: + - notifCorreId + - events + properties: + notifCorreId: + type: string + events: + type: array + items: + $ref: '#/components/schemas/EventNotification' + minItems: 1 + +EventNotification: + description: Describes a notification of an matched event. + type: object + required: + - event + properties: + event: + $ref: '#/components/schemas/TscEvent' + flowIds: + type: array + items: + type: integer + minItems: 1 + description: Identifies the IP flows that were sent during event subscription. + qosMonReports: + type: array + items: + $ref: 'TS29122_AsSessionWithQoS.yaml#/components/schemas/QosMonitoringReport' + minItems: 1 + usgRep: + $ref: 'TS29122_CommonData.yaml#/components/schemas/AccumulatedUsage' + appliedQosRef: + type: string + description: > + The currently applied alternative QoS requirement referring to an alternative QoS + reference or a requested alternative QoS parameter set. Applicable for + event QOS_NOT_GUARANTEED or SUCCESSFUL_RESOURCES_ALLOCATION. + altQosNotSuppInd: + type: boolean + description: > + When present and set to true it indicates that the Alternative QoS profiles are not + supported by NG-RAN. Applicable for + event QOS_NOT_GUARANTEED or SUCCESSFUL_RESOURCES_ALLOCATION. + +AdditionInfoTsctsfQosTscac: + description: Describes additional error information specific for this API. + type: object + properties: + acceptableServInfo: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AcceptableServiceInfo' + batOffsetInfo: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/BatOffsetInfo' + +``` + +``` + +TemporalInvalidity: + description: Indicates the time interval(s) during which the AF request is not to be applied. + type: object + properties: + startTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + stopTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - startTime + - stopTime + +# +# ENUMERATIONS DATA TYPES +# +TscEvent: + description: Represents an event to notify to the AF. + anyOf: + - type: string + enum: + - FAILED_RESOURCES_ALLOCATION + - QOS_MONITORING + - QOS_GUARANTEED + - QOS_NOT_GUARANTEED + - SUCCESSFUL_RESOURCES_ALLOCATION + - USAGE_REPORT + - BAT_OFFSET_INFO + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + +# +# ALTERNATIVE DATA TYPES OR COMBINATIONS OF DATA TYPES +# +ProblemDetailsTsctsfQosTscac: + description: Extends ProblemDetails to also include the acceptable service info. + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/AdditionInfoTsctsfQosTscac' + +``` + +## A.4 Ntsctsf\_ASTI API + +openapi: 3.0.0 + +``` + +info: + title: Ntsctsf_ASTI Service API + version: 1.1.0-alpha.3 + description: | + TSCTSF Access Stratum time distribution configuration Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.565 V18.4.0; 5G System; Time Sensitive Communication and + Time Synchronization Function Services; Stage 3. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.565/' + +servers: + - url: '{apiRoot}/ntsctsf-asti/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - ntsctsf-asti + +paths: + /configurations: + post: + summary: Creates a new Individual ASTI Configuration resource. + operationId: ASTIConfiguration + +``` + +``` + +tags: + - ASTI Configurations (Collection) +requestBody: + description: Contains the information for the creation the resource. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AccessTimeDistributionData' +responses: + '201': + description: Successful creation of the resource. + content: + application/json: + schema: + $ref: '#/components/schemas/AccessTimeDistributionData' + headers: + Location: + description: > + Contains the URI of the created individual ASTI Configuration resource, + according to the structure + {apiRoot}/ntscstsf-asti/{apiVersion}/configurations/{configId} + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + astiNotification: + "{$request.body#/astiNotifUri}": + post: + requestBody: + description: Notification of an ASTI configuration change event. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AstiConfigNotification' + responses: + '204': + description: The receipt of the notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/configurations/retrieve: + post: + summary: Request the status of the 5G access stratum time distribution for a list of UEs. + operationId: RequestStatusof5GAccessStratumTimeDistribution + tags: + - ASTI Configurations + requestBody: + description: > + Contains the information for the status of the 5G access stratum time distribution. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Status requestData' + responses: + '200': + description: > + Successful retrieval of the status of the 5G access stratum time distribution. + content: + application/json: + schema: + $ref: '#/components/schemas/StatusResponseData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/configurations/{configId}: + put: + summary: Modifies an existing Individual ASTI Configuration resource. + operationId: ModifyIndividualASTIConfiguration + tags: + - Individual ASTI Configuration (Document) + parameters: + - name: configId + description: String identifying an Individual ASTI Configuration. + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + +``` + +``` + application/json: + schema: + $ref: '#/components/schemas/AccessTimeDistributionData' +responses: + '200': + description: OK. Resource was successfully modified and representation is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AccessTimeDistributionData' + '204': + description: No Content. Resource was successfully modified. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + operationId: DeleteIndividualASTIConfiguration + summary: Delete an Individual ASTI Configuration + tags: + - Individual ASTI Configuration (Document) + parameters: + - name: configId + in: path + description: String identifying an Individual ASTI Configuration. + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +``` + +## components: + +``` +securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + ntsctsf-asti: Access to the Ntsctsf_ASTI API +``` + +## schemas: + +``` +AccessTimeDistributionData: + description: > + Contains the parameters for the creation of 5G access stratum time distribution + configuration. + type: object + properties: + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + gpsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + interGrpId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + exterGrpId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalGroupId' + asTimeDisParam: + $ref: '#/components/schemas/AsTimeDistributionParam' + covReq: + type: array + description: > + Identifies a list of Tracking Areas per serving network where 5GS + Access Stratum Time Distribution parameters are allowed. + items: + $ref: 'TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/ServiceAreaCoverageInfo' + minItems: 1 + astiNotifId: + type: string + description: Notification Correlation ID assigned by the NF service consumer. + astiNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - asTimeDisParam + oneOf: + - required: [supis] + - required: [interGrpId] + - required: [gpsis] + - required: [exterGrpId] + +AsTimeDistributionParam: + description: Contains the 5G access stratum time distribution parameters. + type: object + properties: + asTimeDisEnabled: + type: boolean + description: > + When this attribute is included and set to true, it indicates that the access stratum + time distribution via Uu reference point is activated. + timeSyncErrBdgt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + tempValidity: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity' + clkQltDetLvl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityDetailLevel' + clkQltAcptCri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityAcceptanceCriterion' + +StatusRequestData: + description: > +``` + +``` + Contains the parameters for retrieval of the status of the access stratum time distribution + for a list of UEs. + type: object + properties: + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + gpsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + oneOf: + - required: [supis] + - required: [gpsis] + +StatusResponseData: + description: > + Contains the parameters for the status of the access stratum time distribution for a list of + UEs. + type: object + properties: + inactiveUes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + inactiveGpsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + activeUes: + type: array + items: + $ref: '#/components/schemas/ActiveUe' + minItems: 1 + +ActiveUe: + description: > + Contains the UE identifier whose status of the access stratum time distribution is active + and the optional requested time synchronization error budget. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + timeSyncErrBdgt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + oneOf: + - required: [supi] + - required: [gpsi] + +AstiConfigNotification: + description: > + Contains the report of a change in the 5G Access Stratum Time Distribution + parameters applied to the UE(s). + type: object + properties: + astiNotifId: + type: string + stateConfigs: + type: array + items: + $ref: '#/components/schemas/AstiConfigStateNotification' + minItems: 1 + description: > + It is FFS the parameters of the AstiConfigEventNotification data type. + required: + - astiNotifId + - stateConfigs + +AstiConfigStateNotification: + description: > + Contains the report of a change in the 5G Access Stratum Time Distribution +``` + +``` + + parameters applied to a UE. +type: object +properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + event: + $ref: '#/components/schemas/AstiEvent' +required: + - event +oneOf: + - required: [supi] + - required: [gpsi] +# +# ENUMERATIONS DATA TYPES +# +AstiEvent: + anyOf: + - type: string + enum: + - ASTI_ENABLED + - ASTI_DISABLED + - CLOCK_QUAL_ACCEPTABLE + - CLOCK_QUAL_NON_ACCEPTABLE + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + description: | + Represents an ASTI event to notify to the AF/NEF. + Possible values are: + - ASTI_ENABLED: Access stratum time distribution via Uu reference point is activated. + - ASTI_DISABLED: Access stratum time distribution via Uu reference point is deactivated. + - CLOCK_QUAL_ACCEPTABLE: The UE meets the clock quality acceptance criteria. + - CLOCK_QUAL_NON_ACCEPTABLE: The UE does not meet the clock quality acceptance criteria. + +``` + +--- + +## Annex B (normative): 3GPP extensions for DetNet integration with 5GS + +### B.1 3GPP extensions for DetNet integration with 5GS + +#### B.1.1 Introduction + +The 5G System is integrated with the Deterministic Networking as defined in IETF RFC 8655[63] as a logical DetNet transit node as specified in 3GPP TS 23.501 [2], clause 4.4.8.4. + +The support of deterministic networking is achieved by reusing the TSC framework for deterministic QoS and time synchronization services. To enable deterministic networking in 5GS, the DetNet controller collects interface information from the 5GS DetNet node via the TSCTSF using the 5GS DetNet node information reporting procedure described in clause 5.5.12.2 of 3GPP TS 23.513 [31] and provides DetNet Yang configurations for DetNet flow(s) as described in clause 5.5.12.3 of 3GPP TS 23.513 [31]. + +The TSCTSF offers to the DetNet controller RESTCONF (IETF RFC 8040 [30]) and/or NETCONF (IETF RFC 6241 [29]) interfaces and the data schema defined by the 3GPP Extended Deterministic Networking (DetNet) YANG model. The 3GPP Extended DetNet YANG model is based on the DetNet YANG model specified in IETF draft-ietf-detnet-yang [28] and extended by 3GPP Extensions described in table B.1.1-1. + +The 3GPP Extended DetNet YANG Model offered by the TSCTSF is accessed by the DetNet controller as shown in figure B.1.1-1 + +![Diagram showing the access to the 3GPP Extended DetNet YANG Model. A box labeled 'TSCTSF' is connected by a horizontal line to a box labeled 'DetNet controller'. Above the line, text indicates the model is '3GPP Extended DetNet YANG model over RESTCONF/NETCONF'.](27c9c38b326b85de631d54a9ff1e2bd4_img.jpg) + +3GPP Extended DetNet YANG model +over RESTCONF/NETCONF + +``` + +graph LR + TSCTSF[TSCTSF] --- DetNet[DetNet controller] + subgraph Model + direction TB + M1[3GPP Extended DetNet YANG model] + M2[over RESTCONF/NETCONF] + end + Model --- DetNet + +``` + +Diagram showing the access to the 3GPP Extended DetNet YANG Model. A box labeled 'TSCTSF' is connected by a horizontal line to a box labeled 'DetNet controller'. Above the line, text indicates the model is '3GPP Extended DetNet YANG model over RESTCONF/NETCONF'. + +**Figure B.1.1-1: Representation of the access to 3GPP Extended DetNet YANG Model.** + +Table B.1.1-1 summarizes the 3GPP extensions to the DetNet YANG model defined in this specification. + +**Table B.1.1-1: 3GPP Extensions Descriptions** + +| 3GPP Extension | Clause | Description | YANG File | Module Name | Annex | +|----------------------|--------|----------------------------------------------------------------------------------------------------------------------------------|---------------------------|----------------------|-------| +| 3gpp-5gs-detnet-node | B.1.2 | Enables the report of 5GS DetNet node interface information and the provisioning and configuration of data for the DetNet flows. | 3gpp-5gs-detnet-node.yang | 3gpp-5gs-detnet-node | C.2 | + +## B.1.2 3GPP Extension 3gpp-5gs-detnet-node + +### B.1.2.1 Description + +Deterministic Networking parameter provisioning allows a DetNet controller to configure deterministic networking parameters in 5GS and provide time-sensitive features that guarantee almost zero packet loss rates and bounded latency. + +The DetNet controller communicates with the 5GS system through the TSCTSF as specified in 3GPP TS 29.513 [31] to collect 5GS DetNet node interface information and to provide DetNet flow-related parameters to configure the DetNet traffic in 5GS. + +The TSCTSF may receive DetNet YANG configuration for DetNet flows as described in IETF draft-ietf-detnet-yang [28], that describes the traffic characteristics and QoS requirements for the DetNet flows. Additionally, when both, the TSCTSF and the DetNet controller support the 3GPP Extension 3gpp-5gs-detnet-node, the configuration of the DetNet traffic in 5GS also enable that: + +- The DetNet controller may provide the maximum latency and/or maximum loss requirements the 5GS system needs to apply, as specified in clause B.1.2.2. +- The TSCTSF may provide to the DetNet controller 5GS specific status code information on the status of the configuration requested by the DetNet controller for the DetNet flow(s), as specified in clause B.1.2.3. + +To enable the DetNet controller builds up network topology information, the 5GS DetNet node exposes interface information to the DetNet controller through the TSCTSF. When both, the TSCTSF and the DetNet controller support the 3GPP Extension 3gpp-5gs-detnet-node, the TSCTSF may provide to the DetNet controller 5GS DetNet node identification as specified in clause B.1.2.4. + +### B.1.2.2 Provisioning of 5GS specific traffic characteristics and requirements + +When both, the DetNet controller and the TSCTSF support the 3GPP Extension 3gpp-5gs-detnet-node, the DetNet controller may provide the following 5GS specific traffic characteristics and requirements within the "\_3gpp-5gs-node-requirements" YANG container: + +- the maximum latency from 5GS node ingress to 5GS node egress(es) of a DetNet flow by providing the "\_3gpp-5gs-node-max-latency" attribute; and/or + +- the maximum packet loss ratio parameter for the DetNet service between the 5G node ingress and the 5GS node egress(es) by providing the "\_3gpp-5gs-node-max-latency" attribute; and +- a reference to the DetNet flow identification within the "forwarding-sub-layer" attribute. + +When the DetNet controller does not provide the "\_3gpp-5gs-node-max-latency" attribute and/or the "\_3gpp-5gs-node-max-latency" attribute but instead provides the IETF draft-ietf-detnet-yang [28] "max-latency" and/or "max-loss" attributes for the end-to-end flow, the TSCTSF may determine the corresponding maximum latency and/or maximum packet loss values based on a preconfigured mapping and applicable to the 5GS specific deployment. + +NOTE: If the DetNet controller does not include the 5GS specific "\_3gpp-5gs-node-max-latency" nor the end-to-end "max-latency", the TSCTSF can derive the Requested 5GS Delay or, alternatively, the PCF can derive the PDB. Similarly, if the DetNet YANG configuration does not include the 5GS specific "\_3gpp-5gs-node-max-loss" nor the end-to-end "max-loss", the TSCTSF can derive the Requested Packet Error Rate or, alternatively, the PCF can derive the PER. + +### B.1.2.3 Report of 5GS DetNet flow(s) status + +The DetNet controller may be informed about the following 5GS specific events about status change of the configured DetNet flows: + +- Notification about DetNet flow(s) deactivation in 5GS node. To notify the DetNet controller about DetNet flow deactivation in 5GS, the TSCTSF shall subscribe with the PCF to service data flow deactivation as specified in 3GPP TS 29.514 [20]. +- Notification about resource allocation outcome in 5GS node. The TSCTSF shall subscribe with the PCF to notifications about the unsuccessful and/or successful resource allocation outcome as specified in 3GPP TS 29.514 [20]. +- Notification about PDU session release. + +When the TSCTSF receives from the PCF the notification about service data flow deactivation, or the notification about unsuccessful or successful resource allocation, or the notification about PDU session release and both, the DetNet controller and the TSCTSF support the 3GPP Extension 3gpp-5gs-detnet-node, the TSCTSF may notify the DetNet controller by including the following 3GPP 5GS specific failure reason: + +- "3gpp-5gs-node-resource-allocation-failure", to notify about the failed resource allocation in the 5G System; +- "3gpp-5gs-node-resource-allocation-success", to notify about the successful resource allocation in the 5G System; or +- "3gpp-5gs-node-pdu-session-release", to notify about PDU session release. + +When the TSCTSF or the DetNet controller do not support the 3GPP Extension 3gpp-5gs-detnet-node, the TSCTSF provides an IETF draft-ietf-detnet-yang [28] defined failure-reason, e.g. "resource-unavailable". + +### B.1.2.4 Exposure of 5GS DetNet Node Identification + +The TSCTSF collects 5GS DetNet node interface information from the NW-TT/UPF using Time Synchronization procedures as described in 3GPP TS 29.513[31]. When both, the TSCTSF and the DetNet controller support the 3GPP Extension 3gpp-5gs-detnet-node, the TSCTSF may provide to the DetNet controller 5GS DetNet node identification. + +During PDU session establishment, i.e., when the TSCTSF receives the Npcf\_PolicyAuthorization\_Notify service operation defined in clause 4.2.5.16 of 3GPP TS 29.514 [20], the TSCTSF may use the received user-plane node Id to generate an identifier of the 5GS DetNet node and provide it to the DetNet controller within the "5GS-node-id" attribute. + +## B.2 YANG Module Definitions + +### B.2.1 Introduction + +#### B.2.1.1 General + +As specified in IETF RFC 7590 [33], a YANG model is defined in a YANG module and is stored in a file with file extension ".yang". An extension to an existing YANG model is done via the definition of a new YANG module that contains the definitions of the new components. + +A YANG module typically has the following layout: + +``` +module { + // header information + + + + + // linkage statements + + + + // meta-information + + + + + + // revision history + + + // module definitions + +} +``` + +The YANG module with the 3GPP extensions for the DetNet YANG model shall follow the YANG model layout defined in clause 7.1 of IETF RFC 7590 [33] and represented above, where the `linkage` and `module definitions` statements contain the definition of the new components that represent the 5GS specifics. + +#### B.2.1.2 Module name + +``` +module +``` + +To differentiate from other YANG modules, 3GPP extensions to DetNet YANG model module(s) shall start with the "3gpp-5gs-detnet" prefix. + +#### B.2.1.3 Header information + +##### B.2.1.3.1 + +According to IETF RFC 7590 [33], YANG version 1.1 shall be used. + +##### B.2.1.3.2 + +The namespace for a YANG module's namespace shall follow section 4.9 of IETF RFC 8407. + +The 3GPP extensions to DetNet YANG model shall follow the following form: + +``` +urn:3gpp:node:detnet: +``` + +### B.2.1.3.3 + +To ensure uniqueness of the prefix defined in the 3GPP extensions for the DetNet YANG model, the module(s) shall use prefixes ending with "3gppdnet". Prefixes should be short preferably not longer than 10 characters, but 13 characters at most. + +## B.2.1.4 Meta-information + +### B.2.1.4.1 + +The organization statement shall contain the organization developing and maintaining the YANG file with the 3GPP extensions for the DetNet YANG model, i.e. the string "3GPP CT3 Working Group". + +### B.2.1.4.2 + +The contact statement contains contact information for the person or persons to whom technical queries concerning this module should be sent. + +For the 3GPP extensions to YANG DetNet model it shall include a string with the CT3 WG web link. + +``` +contact + "CT3 WG Web: "; +``` + +### B.2.1.4.3 + +The description statement contains human-readable textual description for the module definition. + +In addition, the YANG module with 3GPP extensions to YANG DetNet model shall also include the copyright notice as included in the front page of the present document and a reference to the present document. + +#### EXAMPLE: + +``` +description + "3gpp-5gs-detnet-node module contains an extension of ietf-detnet YANG module with + additional parameters defined for interworking with 3GPP 5GS. + + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + + This version of this YANG module is specified in: + 3GPP TS 29.565 V18.1.0; 5G System; + Time Sensitive Communication and Time Synchronization Function Services. + url: http://www.3gpp.org/ftp/Specs/archive/29\_series/29.565/"; +``` + +### B.2.1.4.4 + +This statement contains a human-readable cross reference to an external document that defines related information or additional information. + +When included, it refers e.g., to other 3GPP Technical Specifications with related information. + +#### EXAMPLE: + +``` +reference + "Additional information to this YANG module is specified in: + 3GPP TS 23.501, System architecture for the 5G System (5GS) + 3GPP TS 23.502, Procedures for the 5G System (5GS) + 3GPP TS 23.503, Policy and charging control framework (5GS) + url: http://www.3gpp.org/ftp/Specs/archive/23\_series/"; +``` + +#### B.2.1.4.5 + +This statement contains the revision history of the module, including the initial revision. A series of *revision* statements detail the changes in the module's definition. The argument is a date string in the format "YYYY-MM-DD" followed by a block of sub-statements with detailed revision information. A module should have at least one *revision* statement. + +For the YANG module(s) with the 3GPP extensions to YANG DetNet model: + +1. For a frozen release, only one revision statement shall be included and shall indicate the last revision of the module for that release version of the TS. +2. A non-frozen release may contain a series of revision statements that represent the list of changes approved in that release. At the freeze of the release, only the last revision statement shall be kept. +3. The date argument of the revision statement(s) shall contain a value corresponding to the CT plenary date that approved the latest changes to the YANG module. +4. To allow the YANG module could be updated with new components in new releases or with corrections in a frozen release, a version control mechanism is enabled. The *description* sub-statement shall be used to contain a string with the YANG module version. Version control for the 3GPP Extensions for the DetNet YANG shall follow the version control rules for SBI APIs specified in 3GPP TS 29.501 [5], clause 4.3. + +EXAMPLE 1: Series of revision published by 3GPP of the 3GPP extension YANG module before the freeze of the Rel-18, with version included. + +``` +revision 2024-012-dd +// optional +{ + description "version: v1.0.0-alpha.3"; +} + +revision 2023-09-dd +// optional +{ + description "version: v1.0.0-alpha.2"; +} + +revision 2023-06-dd +// optional +{ + description "version: v1.0.0-alpha.1"; +} +``` + +EXAMPLE 2: Final revision of the 3GPP extension of the YANG module published by 3GPP, with version included, published at the freeze of Rel-18. + +``` +revision 2024-06-dd +{ + description "version: v1.0.0"; +} +``` + +EXAMPLE 3: The YANG module is evolved during the first plenary cycle corresponding to Rel-19, . + +``` +revision 2024-09-dd +{ + description "version: v1.1.0-alpha.1"; +} +``` + +#### B.2.1.2 Formatting rules + +The following 3GPP specific guidelines should be used when documenting the YANG module for the 3GPP extensions to the DetNet YANG model: + +- The YANG module should be considered a code component. The strings "" and "" are used to identify each code component. + +- The "" tag is followed by a string identifying the file name as specified in section 5.2 of IETF RFC 6020 [35]. +- The YANG data nodes (leaf, leaf-list, container, list) shall be used for data modelling of the new YANG components. +- The style used for the specification of the YANG module shall be "PL" (Programming Language). +- Comments may be added by following the standard YANG 1.1 syntax ("//" or "/\*" and "\*/"). +- Tabs shall not be used (e.g. within description fields). +- "Unbreakable" spaces (UTF-8 'NO-BREAK SPACE' (U+00A0)) shall not be used (e.g. within description fields). Only "normal" spaces (UTF-8 'SPACE' (U+0020)) shall be allowed. +- Trailing spaces (i.e. white spaces at the end of a line) should not be used. + +## B.2.2 3gpp-5gs-detnet-node Module definition + +### B.2.2.1 Introduction + +The 3GPP extension to the IETF draft-ietf-detnet-yang [37] is defined in 3GPP as a YANG module which imports draft-ietf-detnet-yang [37] and adds the 3GPP specific parameters. + +The module name shall be set to "3gpp-5gs-detnet-node". + +The YANG version shall be set to "1.1". + +The namespace for the 3gpp-5gs-detnet-node YANG module shall be set to "urn:3gpp:node:detnet:3gpp-5gs-detnet-node". + +The prefix statement for the 3gpp-5gs-detnet-node YANG module shall be set to "5gs3gppdnet". + +### B.2.2.2 Data Model + +#### B.2.2.2.1 General + +Table B.2.2.2.1-1 specifies the data types defined for the 3gpp-5gs-detnet-node Module. + +**Table B.2.2.2.1-1: 3gpp-5gs-detnet-node Module specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|--------------------------------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| _3gpp-5gs-node-configuration-outcome | B.2.2.2.2.3 | It is a container that represents the additional outcome the 5GS may provide to a configuration request. | | +| _3gpp-5gs-node-configuration-status | B.2.2.2.3.3 | It is an enumeration that represents the 3GPP specific configuration status that may be reported by the 5GS node. | | +| _3gpp-5gs-node-identity | B.2.2.2.2.4 | It is a container that represents the user-plane node Id handling the traffic of the reported DetNet flows/PDU session. | | +| _3gpp-5gs-node-requirements | B.2.2.2.2.2 | It is a container that represents the maximum delay and/or the maximum loss the 5GS needs to satisfy for the traffic of the DetNet flows indicated by the forwarding sublayer. | | + +Table B.2.2.2.1-2 specifies data types re-used by the \_3gpp-5gs-detnet-node Module from other YANG modules, including a reference to their respective specifications and when needed, a short description of their use. + +**Table BA.2.2.2.1-2: \_3gpp-5gs-detnet-node Module re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|--------------------------|----------------------------------|--------------------------------------------------------------------------------------------------------|---------------| +| forwarding-sub-layer-ref | IETF draft-ietf-detnet-yang [28] | Contains a reference to the forwarding sublayer as specified in draft-ietf-detnet-yang-17 YANG module. | | + +## B.2.2.2.2 Structured data types + +### B.2.2.2.2.1 Introduction + +This clause defines the YANG structures to be used in 3gpp-5gs-detnet-node YANG Module. + +### B.2.2.2.2.2 Type: \_3gpp-5gs-node-requirements + +The \_3gpp-5gs-node-requirements type is a YANG container that defines the maximum delay and/or the maximum loss the 5GS needs to satisfy for the traffic of the DetNet flows indicated by the forwarding sublayer. + +**Table B.2.2.2.2.2-1: Definition of type \_3gpp-5gs-node-requirements** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------|--------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| _forwarding-sub-layer | forwarding-sub-layer-ref | M | 1 | The _forwarding-sublayer leaf contains a reference to the forwarding sub-layer that the maximum delay and/or the maximum loss applies to. | +| _3gpp-5gs-node-max-latency | uint32 | O | 0..1 | The _3gpp-5gs-node-max-latency leaf contains the maximum latency from 5GS node ingress to 5GS node egress(es) for a single packet of the DetNet flow. It is specified as an integer number of nanoseconds. | +| _3gpp-5gs-node-max-loss | uint32 | O | 0..1 | The _3gpp-5gs-node-max-loss leaf contains the maximum Packet Loss Ratio (PLR) parameter for the DetNet service between the 5GS node ingress and the 5GS node egress(es). | + +### B.2.2.2.2.3 Type: \_3gpp-5gs-node-configuration-outcome + +The \_3gpp-5gs-node-configuration-outcome type is a YANG container that defines the additional outcome the 5GS may provide to a configuration request for the DetNet flows comprised by the forwarding sublayer. + +**Table B.2.2.2.2.3-1: Definition of type \_3gpp-5gs-node-configuration-outcome** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------------|-------------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| _forwarding-sub-layer | forwarding-sub-layer-ref | M | 1 | The _forwarding-sublayer leaf contains a reference to the forwarding sub-layer that the reported configuration status applies to. | +| _3gpp-5gs-node-configuration-status | _3gpp-5gs-node-configuration-status | O | 0..1 | The _3gpp-5gs-node-configuration-status leaf contains 3GPP specific configuration status codes that may be reported by the 3GPP 5GS node. | + +#### B.2.2.2.2.4 Type: \_3gpp-5gs-node-identity + +The \_3gpp-5gs-node-identity type is a YANG container that defines the 5GS node identity handling the traffic of the DetNet flows comprised by the forwarding sublayer. + +**Table B.2.2.2.2.3-1: Definition of type \_3gpp-5gs-node-configuration-outcome** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|--------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| _forwarding-sub-layer | forwarding-sub-layer-ref | M | 1 | The _forwarding-sublayer leaf contains a reference to the forwarding sub-layer the _3gpp-5gs-node-id applies to. | +| _3gpp-5gs-node-id | string | O | 0..1 | The _3gpp-5gs-node-id leaf contains 3GPP 5GS node identity (DetNet router identity). | + +#### B.2.2.2.3 Simple data types and enumerations + +##### B.2.2.2.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### B.2.2.2.3.2 Simple data types + +The simple data types defined in table B.2.2.2.3.2-1 shall be supported. + +**Table B.2.2.2.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-------------------------|-------------|---------------| +| | | | | + +##### B.2.2.2.3.3 Enumeration: \_3gpp-5gs-node-configuration-status + +The enumeration \_3gpp-5gs-node-configuration-status represents the configuration status that may be reported by the 3GPP 5GS node. It shall comply with the provisions defined in table B.2.2.2.3.3-1. + +**Table B.2.2.2.3.3-1: Enumeration \_3gpp-5gs-node-configuration-status** + +| Enumeration value | Description | Applicability | +|--------------------------------------------|------------------------------------------------------------------------------------------|----------------------| +| _3gpp-5gs-node-resource-allocation-success | Successful resource allocation within 5GS for the requested configuration. | | +| _3gpp-5gs-node-resource-allocation-failure | Failed resource allocation within 5GS for the requested configuration. | | +| _3gpp-5gs-node-port-release | Port release due to the termination of PDU session with the requested 5GS configuration. | | + +## Annex C (normative): YANG module specification + +### C.1 General + +The present Annex contains the YANG file for the `_3gpp-5gs-detnet-node` YANG module, that specifies the 3GPP extensions to support: + +- The indication of the maximum loss and maximumd latency the 5GS system shall apply for the provided DetNet flows. +- 5GS specific status codes with information about the status of the configuration requested by the DetNet controller. +- Exposure of 5GS DetNet node identification. + +### C.2 YANG module `_3gpp-5gs-detnet-node` + +``` + file "_3gpp-5gs-detnet-node.yang" +module _3gpp-5gs-detnet-node { + yang-version 1.1; + namespace "urn:3gpp:node:detnet:_3gpp-5gs-detnet-node"; + prefix _5gs3gppdnet; + + import ietf-detnet { + prefix dnet; + reference + "draft-ietf-detnet-yang-18"; + } + + organization "3GPP CT3 Working Group"; + + contact + "CT3 WG Web: "; + + description + "_3gpp-5gs-detnet-node module contains an extension of ietf-detnet YANG module with + additional parameters defined for interworking with 3GPP 5GS. + + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + + This version of this YANG module is specified in: + 3GPP TS 29.565 V18.4.0; 5G System; + Time Sensitive Communication and Time Synchronization Function Services. + url: https://www.3gpp.org/ftp/Specs/archive/29\_series/29.565/"; + + reference + "Additional information to this YANG module is specified in: + + 3GPP TS 23.501, System architecture for the 5G System (5GS); + url: https://www.3gpp.org/ftp/Specs/archive/23\_series/23.501/ + + 3GPP TS 23.503, Policy and charging control framework (5GS) + url: https://www.3gpp.org/ftp/Specs/archive/23\_series/23.503/ + + 3GPP TS 29.513, Policy and Charging Control signalling flows and QoS parameter mapping + url: https://www.3gpp.org/ftp/Specs/archive/29\_series/29.513/"; + + revision 2023-12-12 { + description "version: v1.0.0-alpha.2"; + } + + revision 2023-06-13 { + description "version: v1.0.0-alpha.1"; + } + + typedef _3gpp-5gs-node-configuration-status { +``` + +``` + +type enumeration { + enum _3gpp-5gs-node-resource-allocation-success { + description + "Successful configuration request. + Successful resource allocation within 5GS for the requested configuration"; + } + enum _3gpp-5gs-node-resource-allocation-failure { + description + "Unsuccessful configuration request. + Failed resource allocation within 5GS for the requested configuration"; + } + enum _3gpp-5gs-node-port-release { + description + "Port release due to the termination of PDU session with the requested + 5GS configuration"; + } + description + "_3gpp-5gs-node-configuration-status type identifies the 3GPP specific configuration + status that may be reported by the 3GPP 5GS node."; +} + +container _3gpp-5gs-node-requirements { + description + "This container defines the maximum delay and/or the maximum loss the 5GS needs to satisfy"; + leaf _forwarding-sub-layer { + type dnet:forwarding-sub-layer-ref; + description + "Reference to the forwarding sub-layer that the maximum delay and/or the maximum loss + applies to"; + } + leaf _3gpp-5gs-node-max-latency { + type uint32; + units "nanoseconds"; + description + "Maximum latency from 5GS node ingress to 5GS node egress(es) for a single packet of the + DetNet flow. It is specified as an integer number of nanoseconds"; + } + leaf _3gpp-5gs-node-max-loss { + type uint32; + description + "Maximum Packet Loss Ration (PLR) parameter for the DetNet service between the 5GS node + ingress and 5GS node egress(es)"; + } +} + +container _3gpp-5gs-node-configuration-outcome { + description + "This container defines the additional outcome the 5GS may provide to a configuration + request"; + leaf _forwarding-sub-layer { + type dnet:forwarding-sub-layer-ref; + description + "Reference to the forwarding sub-layer the outcome to a configuration request applies to"; + } + leaf _3gpp-5gs-node-configuration-status { + type _3gpp-5gs-node-configuration-status; + description "Changes on configuration status reported by the 3GPP 5GS node"; + } +} + +container _3gpp-5gs-node-identity { + description + "This container defines the 5GS Node identity the 5GS provides to the DetNet controller"; + leaf _forwarding-sub-layer { + type dnet:forwarding-sub-layer-ref; + description + "Reference to the forwarding sub-layer that the 5GS node Id applies to"; + } + leaf _3gpp-5gs-node-id { + type string; + description + "5GS node identity. It is the user-plane node Id handling the traffic of the indicated + DetNet flows"; + } +} +} + + +``` + + + +## Annex D (informative): Change history + +| Change history | | | | | | | | +|----------------|--------------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2021-08 | | | | | | TS skeleton | 0.0.0 | +| 2021-08 | CT3#117e | C3-214576 | | | | Inclusion of documents agreed in CT3#117e:
C3-214145, C3-214149, C3-214154, C3-214466, C3-214467, C3-214468, C3-214469, C3-214505, C3-214506, C3-214507, C3-214508, C3-214509, C3-214510 | 0.1.0 | +| 2021-10 | CT3#118e | C3-215473 | | | | Inclusion of documents agreed in CT3#118e:
C3-215347, C3-215348, C3-215349, C3-215350, C3-215351, C3-215352, C3-215353, C3-215354, C3-215356, C3-215357, C3-215358, C3-215470 | 0.2.0 | +| 2021-11 | CT3#119e | C3-216517 | | | | Inclusion of documents agreed in CT3#119e:
C3-216114, C3-216115, C3-216116, C3-216121, C3-216397, C3-216398, C3-216399, C3-216400, C3-216401, C3-216402, C3-216426, C3-216594, C3-215357, C3-216595 | 0.3.0 | +| 2021-12 | CT#94-e | CP-213208 | | | | Presentation for information | 1.0.0 | +| 2022-01 | CT3#119bis-e | C3-220449 | | | | Inclusion of documents agreed in CT3#119bis-e:
C3-220424, C3-220165, C3-220166, C3-220167, C3-220425, C3-220423, C3-220415, C3-220359, C3-220172 | 1.1.0 | +| 2022-02 | CT3#120e | C3-221512 | | | | Inclusion of documents agreed in CT3#120e:
C3-221181, C3-221184, C3-221185, C3-221186, C3-221187, C3-221189, C3-221190, C3-221191, C3-221192, C3-221237, C3-221445, C3-221446, C3-221469, C3-221552, C3-221606, C3-221650 | 1.2.0 | +| 2022-04 | CT3#121e | C3-222482 | | | | Inclusion of documents agreed in CT3#121e:
C3-222176, C3-222177, C3-222178, C3-222179, C3-222181, C3-222182, C3-222183, C3-222295, C3-222420, C3-222424, C3-222435, C3-222489, C3-222503, C3-222507, C3-222555, C3-222556, C3-222564, | 1.3.0 | +| 2022-05 | CT3#122e | C3-223505 | | | | Inclusion of documents agreed in CT3#122e:
C3-223121, C3-223122, C3-223124, C3-223126, C3-223229, C3-223230, C3-223131, C3-223132, C3-223283, C3-223286, C3-223469, C3-223471, C3-223472, C3-223490, C3-223494, C3-223495, C3-223660, C3-223661, C3-223693, C3-223739, C3-223744, C3-223749, | 1.4.0 | +| 2022-06 | CT#96 | CP-221099 | | | | Presentation to TSG CT for approval | 2.0.0 | +| 2022-06 | CT#96 | CP-221099 | | | | Approved by TSG CT | 17.0.0 | +| 2022-09 | CT#97e | CP-222113 | 0001 | - | F | Add PUT method in table 6.1.3.1-1 | 17.1.0 | +| 2022-09 | CT#97e | CP-222113 | 0002 | 1 | F | Correction to 5G access time distribution | 17.1.0 | +| 2022-09 | CT#97e | CP-222114 | 0003 | 1 | F | Correction to initial provisioning of TSC related service information | 17.1.0 | +| 2022-09 | CT#97e | CP-222113 | 0004 | - | F | Correction to notification about TSC application session context event | 17.1.0 | +| 2022-09 | CT#97e | CP-222113 | 0005 | - | F | Correction to notification about TSC application session context termination | 17.1.0 | +| 2020-09 | CT#97e | CP-222113 | 0006 | 1 | F | Correction to subscription to events for the existing TSC application session context | 17.1.0 | +| 2022-09 | CT#97e | CP-222114 | 0007 | 1 | F | Correction to the procedure of creating a new subscription | 17.1.0 | +| 2022-09 | CT#97e | CP-222113 | 0009 | 1 | F | Corrections to the methods of Ntsctsf_ASTI Service API | 17.1.0 | +| 2022-09 | CT#97e | CP-222113 | 0010 | 1 | F | Corrections to the methods of Ntsctsf_QoSandTSCAssistance API | 17.1.0 | +| 2022-09 | CT#97e | CP-222113 | 0011 | - | F | Corrections to the methods of Ntsctsf_TimeSynchronization API | 17.1.0 | +| 2022-09 | CT#97e | CP-222114 | 0013 | 1 | F | Handling of temporal validity condition | 17.1.0 | +| 2022-09 | CT#97e | CP-222113 | 0018 | - | F | Support of sponsored connectivity | 17.1.0 | +| 2022-09 | CT#97e | CP-222114 | 0019 | 1 | F | Correction to the references | 17.1.0 | +| 2022-09 | CT#97e | CP-222114 | 0020 | 1 | F | Correction to time synchronization capabilities subscription | 17.1.0 | +| 2022-09 | CT#97e | CP-222114 | 0021 | 1 | F | Data Model corrections | 17.1.0 | +| 2022-09 | CT#97e | CP-222114 | 0022 | 1 | F | Correction of the association of Time Sync Exposure subscriptions to AF sessions | 17.1.0 | +| 2022-09 | CT#97e | CP-222114 | 0023 | 1 | F | Correction of the handling of AM policies upon Time Sync configuration | 17.1.0 | +| 2022-09 | CT#97e | CP-222114 | 0024 | 1 | F | TSCTSF API corrections | 17.1.0 | +| 2022-09 | CT#97e | CP-222183 | 0025 | 1 | F | Mapping of GPSIs and Group Identifiers to a SUPI list | 17.1.0 | +| 2022-09 | CT#97e | CP-222113 | 0026 | - | F | Definitions of HTTP "403 Forbidden" response | 17.1.0 | +| 2022-09 | CT#97e | CP-222113 | 0027 | - | F | Initial provisioning of TSC related service information | 17.1.0 | +| 2022-09 | CT#97e | CP-222121 | 0028 | - | F | Update of info and externalDocs fields | 17.1.0 | +| 2022-12 | CT#98 | CP-223181 | 0029 | 1 | F | Corrections in the error budget calculation | 17.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------------------------------|--------| +| 2022-12 | CT#98 | CP-223181 | 0030 | - | F | Miscellaneous corrections in the Time Synchronization API | 17.2.0 | +| 2022-12 | CT#98 | CP-223181 | 0033 | - | F | Correction to Ethernet flows | 17.2.0 | +| 2022-12 | CT#98 | CP-223188 | 0034 | - | F | Update of info and externalDocs fields | 17.2.0 | +| 2022-12 | CT#98 | CP-223191 | 0031 | - | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98 | CP-223192 | 0032 | 1 | F | TscEvent enumeration definition in the OpenAPI file | 18.0.0 | +| 2022-12 | CT#98 | CP-223190 | 0035 | - | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230179 | 0036 | 1 | B | Adding PER to TSC QoS inputs | 18.1.0 | +| 2023-03 | CT#99 | CP-230154 | 0038 | 1 | A | Correction to Ntsctsf_TimeSynchronization Service | 18.1.0 | +| 2023-03 | CT#99 | CP-230154 | 0040 | | A | Correction to Ntsctsf_TSCQoSAndAssistance Service | 18.1.0 | +| 2023-03 | CT#99 | CP-230154 | 0042 | | A | Correction to Ntsctsf_ASTI Service | 18.1.0 | +| 2023-03 | CT#99 | CP-230174 | 0043 | | F | Generalization of QoS monitoring control description | 18.1.0 | +| 2023-03 | CT#99 | CP-230179 | 0044 | 1 | B | Service description – support of network timing synchronization status and reporting | 18.1.0 | +| 2023-03 | CT#99 | CP-230179 | 0045 | 1 | B | Provisioning of coverage area filters for ASTI service | 18.1.0 | +| 2023-03 | CT#99 | CP-230179 | 0046 | 1 | B | Notification of 5G Access Stratum Time Distribution enabled/disabled | 18.1.0 | +| 2023-03 | CT#99 | CP-230179 | 0047 | | B | Provisioning of coverage area and notification of changes of capabilities configuration | 18.1.0 | +| 2023-03 | CT#99 | CP-230175 | 0048 | | B | Specification of application errors for TSC QoS requests | 18.1.0 | +| 2023-03 | CT#99 | CP-230175 | 0049 | 1 | B | Indication of Alternative Service Requirements not supported | 18.1.0 | +| 2023-03 | CT#99 | CP-230154 | 0051 | 1 | A | Correction to QoS notification control | 18.1.0 | +| 2023-03 | CT#99 | CP-230179 | 0053 | 1 | B | Support of BAT window and capability for BAT adaptation | 18.1.0 | +| 2023-03 | CT#99 | CP-230162 | 0055 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231143 | 0057 | 1 | B | Adding PER to QoS service operation description | 18.2.0 | +| 2023-06 | CT#100 | CP-231143 | 0058 | 1 | B | Network determined BAT offset and periodicity adaption | 18.2.0 | +| 2023-06 | CT#100 | CP-231143 | 0059 | 1 | B | The correction on the BAT window and BAT adaptation capability | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0060 | 3 | B | Support for network timing synchronization status and reporting | 18.2.0 | +| 2023-06 | CT#100 | CP-231131 | 0061 | 1 | F | Adding missing presence conditions | 18.2.0 | +| 2023-06 | CT#100 | CP-231149 | 0062 | 3 | B | Support of traffic characteristics and monitoring of performance characteristics | 18.2.0 | +| 2023-06 | CT#100 | CP-231143 | 0065 | 3 | F | Adding description for controlling time synchronization service | 18.2.0 | +| 2023-06 | CT#100 | CP-231180 | 0068 | 1 | A | Correction on setting Packet Delay Failure report Threshold | 18.2.0 | +| 2023-06 | CT#100 | CP-231134 | 0071 | 1 | F | Adding the time domain to procedures for provisioning TSC information | 18.2.0 | +| 2023-06 | CT#100 | CP-231131 | 0072 | | F | Corrections to the redirection mechanism description | 18.2.0 | +| 2023-06 | CT#100 | CP-231151 | 0073 | 1 | B | 3GPP extensions to DetNet YANG model to support 5GS specifics | 18.2.0 | +| 2023-06 | CT#100 | CP-231151 | 0074 | 1 | B | Definition of 3gpp-5gs-detnet-node YANG file | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 0075 | | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232105 | 0077 | 1 | B | TSCTSF handling when it receives the time sync request from AF and subscription from UDM and the data model definition | 18.3.0 | +| 2023-09 | CT#101 | CP-232098 | 0078 | | F | Remove the trailing slash in the relative path after API URI | 18.3.0 | +| 2023-09 | CT#101 | CP-232185 | 0079 | 2 | F | Corrections to the definition of AF requested QoS for a UE or group of UEs | 18.3.0 | +| 2023-09 | CT#101 | CP-232098 | 0080 | | F | Corrections to the redirection mechanism description | 18.3.0 | +| 2023-09 | CT#101 | CP-232098 | 0081 | | F | Update the apiVersion in the QoSAndTSCAssistance Service API | 18.3.0 | +| 2023-09 | CT#101 | CP-232105 | 0082 | 1 | B | Resource and data model for the Ntsctsf_ASTI API | 18.3.0 | +| 2023-09 | CT#101 | CP-232105 | 0083 | 1 | B | Service description for the Ntsctsf_ASTI service | 18.3.0 | +| 2023-09 | CT#101 | CP-232085 | 0084 | - | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-12 | CT#102 | CP-233245 | 0086 | 1 | F | Reslove the EN about AF requested QoS for a UE or group of UE(s) | 18.4.0 | +| 2023-12 | CT#102 | CP-233228 | 0087 | | F | HTTP RFCs obsoleted by IETF RFC 9113 | 18.4.0 | +| 2023-12 | CT#102 | CP-233200 | 0088 | 2 | B | Support the status information on ASTI service | 18.4.0 | +| 2023-12 | CT#102 | CP-233248 | 0089 | 1 | B | Clarification on time synchronization service | 18.4.0 | +| 2023-12 | CT#102 | CP-233266 | 0091 | 3 | B | Solving remaining Editor's Note(s) for DetNet | 18.4.0 | +| 2023-12 | CT#102 | CP-233248 | 0092 | 1 | B | Correction to clock quality information | 18.4.0 | +| 2023-12 | CT#102 | CP-233248 | 0094 | 1 | B | Update to the time synchronization status and the report | 18.4.0 | +| 2023-12 | CT#102 | CP-233248 | 0095 | 1 | F | Removal of Editor's Note | 18.4.0 | +| 2023-12 | CT#102 | CP-233229 | 0096 | 1 | F | ProblemDetails RFC 7807 obsoleted by RFC 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233201 | 0097 | 1 | F | Update the time synchronization status parameters | 18.4.0 | +| 2023-12 | CT#102 | CP-233266 | 0098 | 1 | B | Completion of YANG module for 3GPP extensions to IETF DetNet | 18.4.0 | +| 2023-12 | CT#102 | CP-233269 | 0099 | 1 | A | Miscellaneous Corrections | 18.4.0 | +| 2023-12 | CT#102 | CP-233135 | 0100 | 2 | B | Notification of Access Stratum Time Distribution configuration changes | 18.4.0 | +| 2023-12 | CT#102 | CP-233269 | 0101 | 1 | F | Update of info and externalDocs fields | 18.4.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29591/raw.md b/marked/Rel-18/29_series/29591/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e778d881cffcb280cfd91fb2a9a754c4af32c088 --- /dev/null +++ b/marked/Rel-18/29_series/29591/raw.md @@ -0,0 +1,7053 @@ + + +# 3GPP TS 29.591 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Network Exposure Function Southbound Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP.. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. + +Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices + +# **3GPP** + +Postal address + +3GPP support office address +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + + +# Contents + +| | | +|---------------------------------------------------------------|----| +| Foreword..... | 10 | +| 1 Scope..... | 12 | +| 2 References..... | 12 | +| 3 Definitions, symbols and abbreviations..... | 13 | +| 3.1 Definitions..... | 13 | +| 3.2 Symbols..... | 13 | +| 3.3 Abbreviations..... | 13 | +| 4 Services offered by the NEF..... | 14 | +| 4.1 Introduction..... | 14 | +| 4.2 Nnef_EventExposure Service..... | 14 | +| 4.2.1 Service Description..... | 14 | +| 4.2.1.1 Overview..... | 14 | +| 4.2.1.2 Service Architecture..... | 15 | +| 4.2.1.3 Network Functions..... | 16 | +| 4.2.1.3.1 Network Exposure Function (NEF)..... | 16 | +| 4.2.1.3.2 NF Service Consumers..... | 16 | +| 4.2.2 Service Operations..... | 17 | +| 4.2.2.1 Introduction..... | 17 | +| 4.2.2.2 Nnef_EventExposure_Subscribe service operation..... | 17 | +| 4.2.2.2.1 General..... | 17 | +| 4.2.2.2.2 Creating a new subscription..... | 18 | +| 4.2.2.2.3 Modifying an existing subscription..... | 20 | +| 4.2.2.3 Nnef_EventExposure_Unsubscribe service operation..... | 21 | +| 4.2.2.3.1 General..... | 21 | +| 4.2.2.3.2 Unsubscription from event notifications..... | 21 | +| 4.2.2.4 Nnef_EventExposure_Notify service operation..... | 22 | +| 4.2.2.4.1 General..... | 22 | +| 4.2.2.4.2 Notification about subscribed events..... | 22 | +| 4.3 Nnef_EASDeployment Service..... | 24 | +| 4.3.1 Service Description..... | 24 | +| 4.3.1.1 Overview..... | 24 | +| 4.3.1.2 Service Architecture..... | 24 | +| 4.3.1.3 Network Functions..... | 25 | +| 4.3.1.3.1 Network Exposure Function (NEF)..... | 25 | +| 4.3.1.3.2 NF Service Consumers..... | 25 | +| 4.3.2 Service Operations..... | 25 | +| 4.3.2.1 Introduction..... | 25 | +| 4.3.2.2 Nnef_EASDeployment_Subscribe service operation..... | 26 | +| 4.3.2.2.1 General..... | 26 | +| 4.3.2.2.2 Creating a new subscription..... | 26 | +| 4.3.2.3 Nnef_EASDeployment_Unsubscribe service operation..... | 26 | +| 4.3.2.3.1 General..... | 26 | + +###### Copyright Notification + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +| | | | +|-----------|-------------------------------------------------------------------------------|----| +| 4.3.2.3.2 | Unsubscription of notification of changes of EAS Deployment Information..... | 27 | +| 4.3.2.4 | Nnef_EASDeployment_Notify service operation..... | 27 | +| 4.3.2.4.1 | General..... | 27 | +| 4.3.2.4.2 | Notification of changes of EAS Deployment Information..... | 27 | +| 4.4 | Nnef_TrafficInfluenceData Service..... | 27 | +| 4.4.1 | Service Description..... | 27 | +| 4.4.1.1 | Overview..... | 27 | +| 4.4.1.2 | Service Architecture..... | 27 | +| 4.4.1.3 | Network Functions..... | 28 | +| 4.4.1.3.1 | Network Exposure Function (NEF)..... | 28 | +| 4.4.1.3.2 | NF Service Consumers..... | 28 | +| 4.4.2 | Service Operations..... | 28 | +| 4.4.2.1 | Introduction..... | 28 | +| 4.4.2.2 | Nnef_TrafficInfluenceData_Subscribe service operation..... | 29 | +| 4.4.2.2.1 | General..... | 29 | +| 4.4.2.2.2 | Creating a new subscription..... | 29 | +| 4.4.2.2.3 | Modifying an existing subscription..... | 30 | +| 4.4.2.3 | Nnef_TrafficInfluenceData_Unsubscribe service operation..... | 31 | +| 4.4.2.3.1 | General..... | 31 | +| 4.4.2.3.2 | Unsubscription of notification of Traffic Influence Data..... | 31 | +| 4.4.2.4 | Nnef_TrafficInfluenceData_Notify service operation..... | 31 | +| 4.4.2.4.1 | General..... | 31 | +| 4.4.2.4.2 | Notification of changes of Traffic Influence Data..... | 31 | +| 4.5 | Nnef_ECSAddress Service..... | 32 | +| 4.5.1 | Service Description..... | 32 | +| 4.5.1.1 | Overview..... | 32 | +| 4.5.1.2 | Service Architecture..... | 32 | +| 4.5.1.3 | Network Functions..... | 33 | +| 4.5.1.3.1 | Network Exposure Function (NEF)..... | 33 | +| 4.5.1.3.2 | NF Service Consumers..... | 33 | +| 4.5.2 | Service Operations..... | 33 | +| 4.5.2.1 | Introduction..... | 33 | +| 4.5.2.2 | Nnef_ECSAddress_Subscribe service operation..... | 34 | +| 4.5.2.2.1 | General..... | 34 | +| 4.5.2.2.2 | Creating a new subscription..... | 34 | +| 4.5.2.2.3 | Modifying an existing subscription..... | 35 | +| 4.5.2.3 | Nnef_ECSAddress_Unsubscribe service operation..... | 36 | +| 4.5.2.3.1 | General..... | 36 | +| 4.5.2.3.2 | Unsubscription of notification of ECS Address Configuration Information..... | 36 | +| 4.5.2.4 | Nnef_ECSAddress_Notify service operation..... | 36 | +| 4.5.2.4.1 | General..... | 36 | +| 4.5.2.4.2 | Notification of changes of ECS Address Configuration Information..... | 36 | +| 4.6 | Nnef_DNAIMapping Service..... | 37 | +| 4.6.1 | Service Description..... | 37 | +| 4.6.1.1 | Overview..... | 37 | +| 4.6.1.2 | Service Architecture..... | 37 | +| 4.6.1.3 | Network Functions..... | 38 | +| 4.6.1.3.1 | Network Exposure Function (NEF)..... | 38 | +| 4.6.1.3.2 | NF Service Consumers..... | 38 | +| 4.6.2 | Service Operations..... | 38 | +| 4.6.2.1 | Introduction..... | 38 | +| 4.6.2.2 | Nnef_DNAIMapping_Subscribe service operation..... | 39 | +| 4.6.2.2.1 | General..... | 39 | +| 4.6.2.2.2 | Creating a new subscription for notification of DNAI Mapping Information..... | 39 | +| 4.6.2.3 | Nnef_DNAIMapping_Unsubscribe service operation..... | 40 | +| 4.6.2.3.1 | General..... | 40 | +| 4.6.2.3.2 | Unsubscription of notification of DNAI Mapping Information..... | 40 | +| 4.6.2.4 | Nnef_DNAIMapping_Notify service operation..... | 40 | +| 4.6.2.4.1 | General..... | 40 | +| 4.6.2.4.2 | Notification of changes of DNAI Mapping Information..... | 40 | +| 4.7 | Nnef_UEId Service..... | 41 | + +| | | | +|-------------|---------------------------------------------------------------|----| +| 4.7.1 | Service Description..... | 41 | +| 4.7.1.1 | Overview..... | 41 | +| 4.7.1.2 | Service Architecture..... | 41 | +| 4.7.1.3 | Network Functions..... | 42 | +| 4.7.1.3.1 | Network Exposure Function (NEF)..... | 42 | +| 4.7.1.3.2 | NF Service Consumers..... | 42 | +| 4.7.2 | Service Operations..... | 42 | +| 4.7.2.1 | Introduction..... | 42 | +| 4.7.2.2 | Nnef_UEId_Fetch service operation..... | 43 | +| 4.7.2.2.1 | General..... | 43 | +| 4.7.2.2.2 | Fetch internal UE ID for roaming UE..... | 43 | +| 5 | API Definitions..... | 44 | +| 5.1 | Nnef_EventExposure Service API..... | 44 | +| 5.1.1 | Introduction..... | 44 | +| 5.1.2 | Usage of HTTP..... | 44 | +| 5.1.2.1 | General..... | 44 | +| 5.1.2.2 | HTTP standard headers..... | 44 | +| 5.1.2.2.1 | General..... | 44 | +| 5.1.2.2.2 | Content type..... | 44 | +| 5.1.2.3 | HTTP custom headers..... | 44 | +| 5.1.3 | Resources..... | 45 | +| 5.1.3.1 | Overview..... | 45 | +| 5.1.3.2 | Resource: Network Exposure Event Subscriptions..... | 45 | +| 5.1.3.2.1 | Description..... | 45 | +| 5.1.3.2.2 | Resource Definition..... | 45 | +| 5.1.3.2.3 | Resource Standard Methods..... | 46 | +| 5.1.3.2.3.1 | POST..... | 46 | +| 5.1.3.3 | Resource: Individual Network Exposure Event Subscription..... | 46 | +| 5.1.3.3.1 | Description..... | 46 | +| 5.1.3.3.2 | Resource Definition..... | 46 | +| 5.1.3.3.3 | Resource Standard Methods..... | 47 | +| 5.1.3.3.3.1 | GET..... | 47 | +| 5.1.3.3.3.2 | PUT..... | 48 | +| 5.1.3.3.3.3 | DELETE..... | 49 | +| 5.1.4 | Custom Operations without associated resources..... | 50 | +| 5.1.5 | Notifications..... | 50 | +| 5.1.5.1 | General..... | 50 | +| 5.1.5.2 | Network Exposure Event Notification..... | 51 | +| 5.1.5.2.1 | Description..... | 51 | +| 5.1.5.2.2 | Target URI..... | 51 | +| 5.1.5.2.3 | Standard Methods..... | 51 | +| 5.1.5.2.3.1 | POST..... | 51 | +| 5.1.6 | Data Model..... | 52 | +| 5.1.6.1 | General..... | 52 | +| 5.1.6.2 | Structured data types..... | 56 | +| 5.1.6.2.1 | Introduction..... | 56 | +| 5.1.6.2.2 | Type: NefEventExposureSubsc..... | 56 | +| 5.1.6.2.3 | Type: NefEventExposureNotif..... | 57 | +| 5.1.6.2.4 | Type: NefEventNotification..... | 57 | +| 5.1.6.2.5 | Type NefEventSubs..... | 60 | +| 5.1.6.2.6 | Type UeCommunicationInfo..... | 60 | +| 5.1.6.2.7 | Type NefEventFilter..... | 61 | +| 5.1.6.2.8 | Type TargetUeIdentification..... | 62 | +| 5.1.6.2.9 | Type: ServiceExperienceInfo..... | 62 | +| 5.1.6.2.10 | Type: UeMobilityInfo..... | 63 | +| 5.1.6.2.11 | Type: UeTrajectoryInfo..... | 63 | +| 5.1.6.2.12 | Type PerformanceDataInfo..... | 63 | +| 5.1.6.2.13 | Type GNSSAssistDataInfo..... | 64 | +| 5.1.6.2.14 | Void5.1.6.2.15 Type GNSSServArea..... | 64 | +| 5.1.6.3 | Simple data types and enumerations..... | 64 | +| 5.1.6.3.1 | Introduction..... | 64 | + +| | | | +|-------------|-------------------------------------------------------------|----| +| 5.1.6.3.2 | Simple data types..... | 64 | +| 5.1.6.3.3 | Enumeration: NefEvent..... | 64 | +| 5.1.7 | Error Handling..... | 65 | +| 5.1.7.1 | General..... | 65 | +| 5.1.7.2 | Protocol Errors..... | 65 | +| 5.1.7.3 | Application Errors..... | 65 | +| 5.1.8 | Feature negotiation..... | 66 | +| 5.1.9 | Security..... | 67 | +| 5.2 | Nnef_EASDeployment Service API..... | 67 | +| 5.2.1 | Introduction..... | 67 | +| 5.2.2 | Usage of HTTP..... | 68 | +| 5.2.2.1 | General..... | 68 | +| 5.2.2.2 | HTTP standard headers..... | 68 | +| 5.2.2.2.1 | General..... | 68 | +| 5.2.2.2.2 | Content type..... | 68 | +| 5.2.2.3 | HTTP custom headers..... | 68 | +| 5.2.3 | Resources..... | 68 | +| 5.2.3.1 | Overview..... | 68 | +| 5.2.3.2 | Resource: EAS Deployment Event Subscriptions..... | 69 | +| 5.2.3.2.1 | Description..... | 69 | +| 5.2.3.2.2 | Resource Definition..... | 69 | +| 5.2.3.2.3 | Resource Standard Methods..... | 69 | +| 5.2.3.2.3.1 | POST..... | 69 | +| 5.2.3.3 | Resource: Individual EAS Deployment Event Subscription..... | 70 | +| 5.2.3.3.1 | Description..... | 70 | +| 5.2.3.3.2 | Resource Definition..... | 70 | +| 5.2.3.3.3 | Resource Standard Methods..... | 70 | +| 5.2.3.3.3.1 | GET..... | 70 | +| 5.2.3.3.3.2 | PUT..... | 71 | +| 5.2.3.3.3.3 | DELETE..... | 71 | +| 5.2.4 | Custom Operations without associated resources..... | 72 | +| 5.2.5 | Notifications..... | 72 | +| 5.2.5.1 | General..... | 72 | +| 5.2.5.2 | EAS Deployment Event Notification..... | 73 | +| 5.2.5.2.1 | Description..... | 73 | +| 5.2.5.2.2 | Target URI..... | 73 | +| 5.2.5.2.3 | Standard Methods..... | 73 | +| 5.2.5.2.3.1 | POST..... | 73 | +| 5.2.6 | Data Model..... | 74 | +| 5.2.6.1 | General..... | 74 | +| 5.2.6.2 | Structured data types..... | 75 | +| 5.2.6.2.1 | Introduction..... | 75 | +| 5.2.6.2.2 | Type: EasDeploySubData..... | 75 | +| 5.2.6.2.3 | Type: EasDeployInfoNotif..... | 76 | +| 5.2.6.2.4 | Type: EasDepNotification..... | 76 | +| 5.2.6.2.5 | Type: EasDeployInfoData..... | 76 | +| 5.2.6.3 | Simple data types and enumerations..... | 76 | +| 5.2.6.3.1 | Introduction..... | 76 | +| 5.2.6.3.2 | Simple data types..... | 77 | +| 5.2.6.3.3 | Enumeration: EasEvent..... | 77 | +| 5.2.7 | Error Handling..... | 77 | +| 5.2.7.1 | General..... | 77 | +| 5.2.7.2 | Protocol Errors..... | 77 | +| 5.2.7.3 | Application Errors..... | 77 | +| 5.2.8 | Feature negotiation..... | 77 | +| 5.2.9 | Security..... | 78 | +| 5.3 | Nnef_TrafficInfluenceData Service API..... | 78 | +| 5.3.1 | Introduction..... | 78 | +| 5.3.2 | Usage of HTTP..... | 78 | +| 5.3.2.1 | General..... | 78 | +| 5.3.2.2 | HTTP standard headers..... | 78 | + +| | | | +|-------------|------------------------------------------------------------------------------|----| +| 5.3.2.2.1 | General..... | 78 | +| 5.3.2.2.2 | Content type..... | 79 | +| 5.3.2.3 | HTTP custom headers..... | 79 | +| 5.3.3 | Resources..... | 79 | +| 5.3.3.1 | Overview..... | 79 | +| 5.3.3.2 | Resource: Traffic Influence Data Subscriptions..... | 80 | +| 5.3.3.2.1 | Description..... | 80 | +| 5.3.3.2.2 | Resource Definition..... | 80 | +| 5.3.3.2.3 | Resource Standard Methods..... | 80 | +| 5.3.3.2.3.1 | POST..... | 80 | +| 5.3.3.3 | Resource: Individual Traffic Influence Data Subscription..... | 81 | +| 5.3.3.3.1 | Description..... | 81 | +| 5.3.3.3.2 | Resource Definition..... | 81 | +| 5.3.3.3.3 | Resource Standard Methods..... | 81 | +| 5.3.3.3.3.1 | GET..... | 81 | +| 5.3.3.3.3.2 | PUT..... | 82 | +| 5.3.3.3.3.3 | DELETE..... | 83 | +| 5.3.4 | Custom Operations without associated resources..... | 84 | +| 5.3.5 | Notifications..... | 84 | +| 5.3.5.1 | General..... | 84 | +| 5.3.5.2 | Traffic Influence Data Notification..... | 85 | +| 5.3.5.3.1 | Description..... | 85 | +| 5.3.5.3.2 | Target URI..... | 85 | +| 5.3.5.3.3 | Standard Methods..... | 85 | +| 5.3.5.3.3.1 | POST..... | 85 | +| 5.3.6 | Data Model..... | 86 | +| 5.3.6.1 | General..... | 86 | +| 5.3.6.2 | Structured data types..... | 87 | +| 5.3.6.2.1 | Introduction..... | 87 | +| 5.3.6.2.2 | Type: TrafficInfluDataSub..... | 87 | +| 5.3.6.2.3 | Type: TrafficInfluDataNotify..... | 88 | +| 5.3.6.3 | Simple data types and enumerations..... | 88 | +| 5.3.6.3.1 | Introduction..... | 88 | +| 5.3.6.3.2 | Simple data types..... | 88 | +| 5.3.7 | Error Handling..... | 88 | +| 5.3.7.1 | General..... | 88 | +| 5.3.7.2 | Protocol Errors..... | 88 | +| 5.3.7.3 | Application Errors..... | 88 | +| 5.3.8 | Feature negotiation..... | 89 | +| 5.3.9 | Security..... | 89 | +| 5.4 | Nnef_ECSAddress Service API..... | 89 | +| 5.4.1 | Introduction..... | 89 | +| 5.4.2 | Usage of HTTP..... | 89 | +| 5.4.2.1 | General..... | 89 | +| 5.4.2.2 | HTTP standard headers..... | 90 | +| 5.4.2.2.1 | General..... | 90 | +| 5.4.2.2.2 | Content type..... | 90 | +| 5.4.2.3 | HTTP custom headers..... | 90 | +| 5.4.3 | Resources..... | 90 | +| 5.4.3.1 | Overview..... | 90 | +| 5.4.3.2 | Resource: ECS Address Configuration Information Subscriptions..... | 91 | +| 5.4.3.2.1 | Description..... | 91 | +| 5.4.3.2.2 | Resource Definition..... | 91 | +| 5.4.3.2.3 | Resource Standard Methods..... | 91 | +| 5.4.3.2.3.1 | POST..... | 91 | +| 5.4.3.3 | Resource: Individual ECS Address Configuration Information Subscription..... | 92 | +| 5.4.3.3.1 | Description..... | 92 | +| 5.4.3.3.2 | Resource Definition..... | 92 | +| 5.4.3.3.3 | Resource Standard Methods..... | 92 | +| 5.4.3.3.3.1 | GET..... | 92 | +| 5.4.3.3.3.2 | PUT..... | 93 | + +| | | | +|-------------|---------------------------------------------------------|-----| +| 5.4.3.3.3.3 | DELETE..... | 94 | +| 5.4.4 | Custom Operations without associated resources..... | 95 | +| 5.4.5 | Notifications..... | 95 | +| 5.4.5.1 | General..... | 95 | +| 5.4.5.2 | ECS Address Configuration Information Notification..... | 96 | +| 5.4.5.4.1 | Description..... | 96 | +| 5.4.5.4.2 | Target URI..... | 96 | +| 5.4.5.4.3 | Standard Methods..... | 96 | +| 5.4.5.4.3.1 | POST..... | 96 | +| 5.4.6 | Data Model..... | 97 | +| 5.4.6.1 | General..... | 97 | +| 5.4.6.2 | Structured data types..... | 98 | +| 5.4.6.2.1 | Introduction..... | 98 | +| 5.4.6.2.2 | Type: EcsAddrCfgInfoSub..... | 98 | +| 5.4.6.2.3 | Type: EcsAddrCfgInfoNotification..... | 98 | +| 5.4.6.3 | Simple data types and enumerations..... | 99 | +| 5.4.6.3.1 | Introduction..... | 99 | +| 5.4.6.3.2 | Simple data types..... | 99 | +| 5.4.7 | Error Handling..... | 99 | +| 5.4.7.1 | General..... | 99 | +| 5.4.7.2 | Protocol Errors..... | 99 | +| 5.4.7.3 | Application Errors..... | 99 | +| 5.4.8 | Feature negotiation..... | 99 | +| 5.4.9 | Security..... | 99 | +| 5.5 | Nnef_DNAIMapping Service API..... | 100 | +| 5.5.1 | Introduction..... | 100 | +| 5.5.2 | Usage of HTTP..... | 100 | +| 5.5.2.1 | General..... | 100 | +| 5.5.2.2 | HTTP standard headers..... | 100 | +| 5.5.2.2.1 | General..... | 100 | +| 5.5.2.2.2 | Content type..... | 100 | +| 5.5.2.3 | HTTP custom headers..... | 101 | +| 5.5.3 | Resources..... | 101 | +| 5.5.3.1 | Overview..... | 101 | +| 5.5.3.2 | Resource: DNAI Mapping Subscriptions..... | 101 | +| 5.5.3.2.1 | Description..... | 101 | +| 5.5.3.2.2 | Resource Definition..... | 101 | +| 5.5.3.2.3 | Resource Standard Methods..... | 102 | +| 5.5.3.2.3.1 | POST..... | 102 | +| 5.5.3.3 | Resource: Individual DNAI Mapping Subscription..... | 102 | +| 5.5.3.3.1 | Description..... | 102 | +| 5.5.3.3.2 | Resource Definition..... | 102 | +| 5.5.3.3.3 | Resource Standard Methods..... | 103 | +| 5.5.3.3.3.1 | GET..... | 103 | +| 5.5.3.3.3.2 | DELETE..... | 104 | +| 5.5.4 | Custom Operations without associated resources..... | 105 | +| 5.5.5 | Notifications..... | 105 | +| 5.5.5.1 | General..... | 105 | +| 5.5.5.2 | DNAI Mapping Notification..... | 105 | +| 5.5.5.2.1 | Description..... | 105 | +| 5.5.5.2.2 | Target URI..... | 105 | +| 5.5.5.2.3 | Standard Methods..... | 105 | +| 5.5.5.2.3.1 | POST..... | 105 | +| 5.5.6 | Data Model..... | 106 | +| 5.5.6.1 | General..... | 106 | +| 5.5.6.2 | Structured data types..... | 107 | +| 5.5.6.2.1 | Introduction..... | 107 | +| 5.5.6.3 | Simple data types and enumerations..... | 107 | +| 5.5.6.3.1 | Introduction..... | 107 | +| 5.5.6.3.2 | Simple data types..... | 107 | +| 5.5.7 | Error Handling..... | 107 | + +| | | | +|--------------------------------------------------------|-----------------------------------------------------|------------| +| 5.5.7.1 | General..... | 107 | +| 5.5.7.2 | Protocol Errors..... | 107 | +| 5.5.7.3 | Application Errors..... | 108 | +| 5.5.8 | Feature negotiation..... | 108 | +| 5.5.9 | Security..... | 108 | +| 5.6 | Nnef_UEId Service API..... | 108 | +| 5.6.1 | Introduction..... | 108 | +| 5.6.2 | Usage of HTTP..... | 108 | +| 5.6.2.1 | General..... | 108 | +| 5.6.2.2 | HTTP standard headers..... | 109 | +| 5.6.2.2.1 | General..... | 109 | +| 5.6.2.2.2 | Content type..... | 109 | +| 5.6.2.3 | HTTP custom headers..... | 109 | +| 5.6.3 | Resources..... | 109 | +| 5.6.4 | Custom Operations without associated resources..... | 109 | +| 5.6.4.1 | Overview..... | 109 | +| 5.6.4.2 | Operation: Fetch..... | 110 | +| 5.6.4.2.1 | Description..... | 110 | +| 5.6.4.2.2 | Operation Definition..... | 110 | +| 5.6.5 | Notifications..... | 111 | +| 5.6.6 | Data Model..... | 111 | +| 5.6.6.1 | General..... | 111 | +| 5.6.6.2 | Structured data types..... | 111 | +| 5.6.6.2.1 | Introduction..... | 111 | +| 5.6.6.2.2 | Type: UeIdReq..... | 111 | +| 5.6.6.2.3 | Type: UeIdInfo..... | 112 | +| 5.6.6.3 | Simple data types and enumerations..... | 112 | +| 5.6.6.3.1 | Introduction..... | 112 | +| 5.6.6.3.2 | Simple data types..... | 112 | +| 5.6.7 | Error Handling..... | 112 | +| 5.6.7.1 | General..... | 112 | +| 5.6.7.2 | Protocol Errors..... | 112 | +| 5.6.7.3 | Application Errors..... | 112 | +| 5.6.8 | Feature negotiation..... | 112 | +| 5.6.9 | Security..... | 113 | +| Annex A (normative): OpenAPI specification..... | | 114 | +| A.1 | General..... | 114 | +| A.2 | Nnef_EventExposure API..... | 114 | +| A.3 | Nnef_EASDeployment API..... | 123 | +| A.4 | Nnef_TrafficInfluenceData API..... | 127 | +| A.5 | Nnef_ECSAddress API..... | 132 | +| A.6 | Nnef_DNAIMapping API..... | 137 | +| A.7 | Nnef_UEId API..... | 139 | +| Annex B (informative): Change history..... | | 142 | + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, certain modal verbs have the following meanings: + +**shall** indicates a mandatory requirement to do something + +**shall not** indicates an interdiction (prohibition) to do something + +NOTE 1: The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +NOTE 2: The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +**should** indicates a recommendation to do something + +**should not** indicates a recommendation not to do something + +**may** indicates permission to do something + +**need not** indicates permission not to do something + +NOTE 3: The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +**can** indicates that something is possible + +**cannot** indicates that something is impossible + +NOTE 4: The constructions "can" and "cannot" shall not to be used as substitutes for "may" and "need not". + +**will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document + +**will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document + +**might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +NOTE 5: The constructions "is" and "is not" do not indicate requirements. + +--- + +# 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nnef southbound Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the Network Exposure Function (NEF). + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.288 [14]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +--- + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "HTTP/2". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". +- [15] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [16] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [17] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". +- [18] 3GPP TS 29.517: "5G System; Application Function Event Exposure Service; Stage 3". +- [19] 3GPP TS 29.551: "5G System; Packet Flow Description Management Service; Stage 3". + +- [20] 3GPP TS 29.541: "5G System; Network Exposure (NE) function services for Non-IP Data Delivery (NIDD) and Short Message Services (SMS); Stage 3". +- [21] 3GPP TS 29.554: "5G System; Background Data Transfer Policy Control Service; Stage 3". +- [22] 3GPP TS 29.523: "5G System; Policy Control Event Exposure Service; Stage 3". +- [23] 3GPP TS 29.256: "Uncrewed Aerial Systems Network Function (UAS-NF); Aerial Management Services; Stage 3". +- [24] 3GPP TS 26.531: "Data Collection and Reporting; General Description and Architecture". +- [25] 3GPP TS 26.501: "5G Media Streaming (5GMS); General description and architecture". +- [26] 3GPP TS 26.512: "5G Media Streaming (5GMS); Protocols". +- [27] 3GPP TS 23.273: "5G System (5GS) Location Services (LCS); Stage 2". +- [28] 3GPP TS 29.572: "5G System; Location Management Services; Stage 3". +- [29] 3GPP TS 29.122: "T8 reference point for northbound Application Programming Interfaces (APIs)". +- [30] 3GPP TS 29.519: "5G System; Usage of the Unified Data Repository service for Policy Control Data, Application Data and Structured Data for Exposure; Stage 3". +- [31] 3GPP TS 37.355: "LTE Positioning Protocol (LPP)". + +--- + +## 3 Definitions, symbols and abbreviations + +### 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +### 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +### 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|----------------------------------------------------------------------| +| 5GMS | 5G Media Streaming | +| AF | Application Function | +| API | Application Programming Interface | +| ASP | Application Service Provider | +| DCCF | Data Collection Coordination Function | +| EAS | Edge Application Server | +| EHE | Edge Hosting Environment | +| LCS | LoCation Services | +| LMF | Location Management FunctionMFAFMessaging Framework Adaptor Function | +| NEF | Network Exposure Function | +| NF | Network Function | +| NWDAF | Network Data Analytics Function | +| SMF | Session Management Function | + +| | | +|------|-----------------------------------| +| SUPI | Subscription Permanent Identifier | +| URI | Uniform Resource Identifier | + +## 4 Services offered by the NEF + +### 4.1 Introduction + +The NEF offers to other NFs the following southbound services: + +- Nnef\_EventExposure +- Nnef\_PFDManagement +- Nnef\_SMContext +- Nnef\_SMService +- Nnef\_Authentication +- Nnef\_EASDeployment +- Nnef\_TrafficInfluenceData +- Nnef\_ECSAddress +- Nnef\_UEId + +NOTE 1: The northbound services offered by the NEF are defined in 3GPP TS 29.522 [15], e.g. the northbound requirement of Nnef\_EventExposure service or Nnef\_EASDeployment. + +NOTE 2: The services offered by the NEF (e.g. Nnef\_EventExposure service) as specified in the present specification are only applicable for Nnef southbound services. + +NOTE 3: The Nnef\_PFDManagement service offered by the NEF southbound is defined in 3GPP TS 29.551 [19]. + +NOTE 4: The Nnef\_SMContext service and the Nnef\_SMService offered by the NEF southbound is defined in 3GPP TS 29.541 [20]. + +NOTE 5: The Nnef\_Authentication service offered by the NEF southbound is defined in 3GPP TS 29.256 [23]. + +### 4.2 Nnef\_EventExposure Service + +#### 4.2.1 Service Description + +##### 4.2.1.1 Overview + +The Nnef\_EventExposure service, as defined in 3GPP TS 23.502 [3], is provided by the Network Exposure Function (NEF). When the UE Application data is collected via the Data Collection AF, the Application Function Exposure Service, as defined in 3GPP TS 26.531 [24], 3GPP TS 26.501 [25] and 3GPP TS 26.512 [26], is provided by the Data Collection AF instantiated in the 5GMS AF for the Event Consumer AF instantiated in the 5GMS ASP. + +This service: + +- allows NF service consumers to subscribe to, modify and unsubscribe from application events reporting; and +- notifies NF service consumers with a corresponding subscription about observed events at the NEF. + +The types of observed events applicable for the NEF include: + +AF application events exposed by an AF: + +- Service experience; +- UE mobility; +- UE communication; +- Exceptions; +- User Data Congestion; +- Dispersion; +- Performance Data information; and +- Collective Behaviour information +- GNSS Assistance Data information + +UE application events exposed via the Data Collection AF: + +- Media Streaming QoE metrics; +- Media Streaming Consumption reports; +- Media Streaming Network Assistance invocation; +- Media Streaming Dynamic Policy invocation; and +- Media Streaming access activity. + +The target of the event reporting may include one or more UE(s), a group of UEs or any UE (i.e. all UEs). When an event to which the NF service consumer has subscribed occurs, the NEF reports the requested information to the NF service consumer based on the event reporting information definition requested by the NF service consumer. + +#### 4.2.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Network Data Analytics Exposure architecture is defined in 3GPP TS 23.288 [14]. The Media Streaming UE application data collection via the Data Collection AF is defined in 3GPP TS 26.531 [24]. The architecture for GNSS Assistance Data Collection for LCS is defined in 3GPP TS 23.273 [27]. + +The Nnef\_EventExposure service is part of the Nnef service-based interface exhibited by the Network Exposure Function (NEF). + +Known consumers of the Nnef\_EventExposure service are: + +- Network Data Analytics Function (NWDAF) +- Data Collection Coordination Function (DCCF) +- Messaging Framework Adaptor Function (MFAF) +- Location Management Function (LMF) +- Event Consumer AF in the 5GMS ASP + +The Nnef\_EventExposure service is provided by the NEF and consumed by NF service consumers (e.g. NWDAF, LMF, DCCF, MFAF, Event Consumer AF), as shown in figure 4.2.1.2-1 for the SBI representation model and in figure 4.2.1.2-2 for reference point representation model. + +![Figure 4.2.1.2-1: Reference Architecture for the Nnef_EventExposure Service; SBI representation. The diagram shows a central NEF box containing an oval labeled 'Nnef'. Below the NEF, five boxes are arranged horizontally: NWDAF, DCCF, MFAF, LMF, and Event Consumer AF. Lines connect the 'Nnef' oval to each of these five boxes. The label 'Nnef_EventExposure' is placed above the rightmost line connecting to the Event Consumer AF.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +Figure 4.2.1.2-1: Reference Architecture for the Nnef\_EventExposure Service; SBI representation. The diagram shows a central NEF box containing an oval labeled 'Nnef'. Below the NEF, five boxes are arranged horizontally: NWDAF, DCCF, MFAF, LMF, and Event Consumer AF. Lines connect the 'Nnef' oval to each of these five boxes. The label 'Nnef\_EventExposure' is placed above the rightmost line connecting to the Event Consumer AF. + +**Figure 4.2.1.2-1: Reference Architecture for the Nnef\_EventExposure Service; SBI representation** + +![Figure 4.2.1.2-2: Reference Architecture for the Nnef_EventExposure Service: reference point representation. The diagram shows a central NEF box. Below the NEF, five boxes are arranged horizontally: NWDAF, DCCF, MFAF, LMF, and Event Consumer AF. Lines connect the bottom of the NEF box to each of these five boxes. Each of these lines has a small horizontal tick mark in the middle, representing a reference point.](a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg) + +Figure 4.2.1.2-2: Reference Architecture for the Nnef\_EventExposure Service: reference point representation. The diagram shows a central NEF box. Below the NEF, five boxes are arranged horizontally: NWDAF, DCCF, MFAF, LMF, and Event Consumer AF. Lines connect the bottom of the NEF box to each of these five boxes. Each of these lines has a small horizontal tick mark in the middle, representing a reference point. + +**Figure 4.2.1.2-2: Reference Architecture for the Nnef\_EventExposure Service: reference point representation** + +#### 4.2.1.3 Network Functions + +##### 4.2.1.3.1 Network Exposure Function (NEF) + +The Network Exposure Function (NEF) is a functional element that provides application or user related information to the NF service consumers as defined in this specification. + +The NEF allows the NF consumer(s) to (un)subscribe to notifications of monitoring observed event, and sends the notification to the NF consumer(s) when a subscribed event is detected. + +##### 4.2.1.3.2 NF Service Consumers + +The known NF service consumers are as follows: + +The Network Data Analytics Function (NWDAF), the Data Collection Coordination Function (DCCF), the Messaging Framework Adaptor Function (MFAF) or the Location Management Function (LMF): + +- supports (un)subscribing to notifications of subscribed event(s) from the NEF; +- supports receiving the notifications of subscribed event(s) from the NEF. + +The Event Consumer Application Function (Event Consumer AF): + +- supports (un)subscribing to notifications of service experience information from the NEF; +- supports receiving the notifications of subscribed event(s) from the NEF. + +## 4.2.2 Service Operations + +### 4.2.2.1 Introduction + +Service operations defined for the Nnef\_EventExposure Service are shown in table 4.2.2.1-1. + +**Table 4.2.2.1-1: Nnef\_EventExposure Service Operations** + +| Service Operation Name | Description | Initiated by | +|--------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Nnef_EventExposure_Subscribe | This service operation is used by an NF service consumer to subscribe to, or modify a subscription in the NEF for event notifications on a specified application or user related event. | NF service consumer | +| Nnef_EventExposure_Unsubscribe | This service operation is used by an NF service consumer to unsubscribe from event notifications. | NF service consumer | +| Nnef_EventExposure_Notify | This service operation is used by the NEF to report application or user related event(s) to the NF service consumer which has subscribed to the event report service. | NEF | + +### 4.2.2.2 Nnef\_EventExposure\_Subscribe service operation + +#### 4.2.2.2.1 General + +This service operation is used by an NF service consumer to subscribe to notifications on specified event(s) or modify an existing subscription. + +The following are the types of events for which a subscription to notifications can be created by the NWDAF, the DCCF, or the MFAF as the NF service consumer: + +- Service experience; +- UE mobility; +- UE communication; +- Exceptions; +- User Data Congestion; +- Dispersion; +- Performance Data information; and +- Collective Behaviour information. + +The following are the types of events for which a subscription can be made by the NWDAF, DCCF, MFAF, or Event Consumer AF as the NF service consumer: + +- Media Streaming QoE metrics; + +The following are the types of events for which a subscription to notifications can be created by the LMF as the NF service consumer: + +- GNSS Assistance Data information. + +The following are the types of events for which a subscription can be made by the Event Consumer AF as the NF service consumer: + +- Media Streaming Consumption reports; +- Media Streaming Network Assistance invocation; + +- Media Streaming Dynamic Policy invocation; and +- Media Streaming access activity. + +The following procedures using the Nnef\_EventExposure\_Subscribe service operation are supported: + +- creating a new subscription; +- modifying an existing subscription. + +#### 4.2.2.2.2 Creating a new subscription + +Figure 4.2.2.2.2-1 illustrates the creation of a Network Exposure Event Subscription. + +![Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to the NEF, and the NEF responds with a 201 Created status.](51db757d054ce1ce83c436a3578b56ca_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NEF + Note right of NF service consumer: 1. POST « /subscriptions » + NF service consumer->>NEF: Request + Note left of NEF: 2. "201 Created" + NEF-->>NF service consumer: Response + +``` + +Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to the NEF, and the NEF responds with a 201 Created status. + +**Figure 4.2.2.2.2-1: Creation of a subscription** + +To subscribe to event notifications, the NF service consumer shall send an HTTP POST request to the NEF with: "{apiRoot}/nnef-eventexposure//subscriptions" as request URI as shown in step 1 of figure 4.2.2.2.2-1, and the "NefEventExposureSubsc" data structure as request body. + +The "NefEventExposureSubsc" data structure shall include: + +- a URI where to receive the requested notifications as "notifUri" attribute; +- a Notification Correlation Identifier assigned by the NF service consumer for the requested notifications as "notifId" attribute; and +- description of subscribed event information as "eventsSubs" attribute by using one or more "NefEventSubs" data. + +The "NefEventExposureSubsc" data structure may also include: + +- the description of the event reporting information as "eventsRepInfo" attribute. +- a specific Authorization AS provisioned Data Access Profile Identifier as "dataAccProfId" attribute, if the feature "DataAccProfileId" is supported and the subscribed events including "MS\_QOE\_METRICS", "MS\_CONSUMPTION", "MS\_NET\_ASSIST\_INVOCATION", "MS\_DYN\_POLICY\_INVOCATION", and/or "MS\_ACCESS\_ACTIVITY". + +NOTE: The optional Data Access Profile Identifier provisioned by the Authorization AS procedures are specified in clause 5.8 of 3GPP TS 26.531 [28]. + +The "NefEventSubs" data structure shall include: + +- an event to subscribe to as a "event" attribute; and +- event filter information as "eventFilter" attribute associated with the event. + +The "eventsRepInfo" attribute may include: + +- event notification method (periodic, one time, on event detection) as "notifMethod" attribute; +- Maximum Number of Reports as "maxReportNbr" attribute; +- Monitoring Duration as "monDur" attribute; +- repetition period for periodic reporting as "repPeriod" attribute; +- immediate reporting indication as "immRep" attribute; +- sampling ratio as "sampRatio" attribute; +- partitioning criteria for partitioning the UEs before performing sampling as "partitionCriteria" attribute if the EneNA feature is supported; +- group reporting guard time as "grpRepTime" attribute; +- a notification flag as "notifFlag" attribute if the EneNA feature is supported; and/or +- notification muting exception instructions within the "notifFlagInstruct" attribute, if the EnhDataMgmt feature is supported and the "notifFlag" attribute is provided and set to "DEACTIVATE". + +If the NEF cannot successfully fulfil the received HTTP POST request due to an internal error or an error in the HTTP POST request, the NEF shall send an HTTP error response as specified in clause 5.1.7. + +Upon successful reception of an HTTP POST request with "{apiRoot}/nnef-eventexposure//subscriptions" as request URI and "NefEventExposureSubsc" data structure as request body, the NEF shall create a new "Individual Network Exposure Event Subscription" resource, store the subscription and send an HTTP "201 Created" response, as shown in step 2 of figure 4.2.2.2.2-1. The NEF shall include in the "201 Created" response: + +- a Location header field; and +- an "NefEventExposureSubsc" data type in the content. + +The Location header field shall contain the URI of the created individual application session context resource i.e. "{apiRoot}/nnef-eventexposure//subscriptions/{subscriptionId}". + +The "NefEventExposureSubsc" data type content shall contain the representation of the created "Individual Network Exposure Event Subscription". + +When the "monDur" attribute is included in the response by the NEF, it represents NEF selected expiry time that is equal or less than the expiry time received in the request. + +When the "immRep" attribute is included and set to "true" in the subscription and the subscribed events are available, the NEF shall include the reports of the events subscribed, if available, in the HTTP POST response. + +When the sampling ratio attribute, as "sampRatio", is included in the subscription without a "partitionCriteria" attribute, the NEF shall select a random subset of UEs among the target UEs according to the sampling ratio and only report the event(s) related to the selected subset of UEs. If the "partitionCriteria" attribute is additionally included, then the NEF shall first partition the UEs according to the value of the "partitionCriteria" attribute and then select a random subset of UEs from each partition according to the sampling ratio and only report the event(s) related to the selected subsets of UEs. + +When the group reporting guard time, as "grpRepTime" attribute, is included in the subscription, the NEF shall accumulate all the event reports for the target UEs until the group reporting guard time expires. Then, the NEF shall notify the NF service consumer using the Nnef\_EventExposure\_Notify service operation, as described in clause 4.2.2.4. + +When the "notifFlag" attribute is included and set to "DEACTIVATE" in the request, the NEF shall mute the event notification and store the available events until the NF service consumer requests to retrieve them by setting the "notifFlag" attribute to "RETRIEVAL" or until a muting exception occurs (e.g. full buffer). When a muting exception occurs, the NEF may consider the contents of the "notifFlagInstruct" attribute (if provided) and/or local configuration to determine its actions. + +If the EnhDataMgmt feature is supported and the NEF accepts the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes, it may indicate the applied muting notification settings within the + +"mutingSetting" attribute in the response. If the NEF does not accept the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes, it shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "MUTING\_INSTR\_NOT\_ACCEPTED". + +#### 4.2.2.2.3 Modifying an existing subscription + +Figure 4.2.2.2.3-1 illustrates the modification of an existing subscription. + +![Sequence diagram illustrating the modification of an existing subscription. The NF service consumer sends a PUT request to the NEF. The NEF responds with either a 200 OK or a 204 No Content.](2eb23c2210154279f8013a1594fbcc5a_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NEF + Note right of NF service consumer: 1. PUT « /subscriptions/{subscriptionId} » + NF service consumer->>NEF: Request + Note left of NEF: 2a. 200 OK +2b. 204 No Content + NEF-->>NF service consumer: Response + +``` + +Sequence diagram illustrating the modification of an existing subscription. The NF service consumer sends a PUT request to the NEF. The NEF responds with either a 200 OK or a 204 No Content. + +**Figure 4.2.2.2.3-1: Modification of an existing subscription** + +To modify an existing subscription to event notifications, the NF service consumer shall send an HTTP PUT request with: "{apiRoot}/nnelf-eventexposure//subscriptions/{subscriptionId}" as request URI, as shown in step 1 of figure 4.2.2.2.3-1, where "{subscriptionId}" is the subscription correlation ID of the existing subscription. The "NefEventExposureSubsc" data structure is included as request body as described in clause 4.2.2.2.2. + +NOTE 1: An alternate NF service consumer than the one that requested the generation of the subscription resource can send the PUT request. + +NOTE 2: The "notifUri" attribute within the NefEventExposureSubsc data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +NOTE 3: The "monDur" attribute within the NefEventExposureSubsc data structure can be modified to extend the expiry time to keep receiving notifications. + +If the NEF cannot successfully fulfil the received HTTP PUT request due to an internal error or an error in the HTTP PUT request, the NEF shall send an HTTP error response as specified in clause 5.1.7. + +If the feature "ES3XX" is supported, and the NEF determines the received HTTP PUT request needs to be redirected, the NEF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +Upon successful reception of an HTTP PUT request with: + +"{apiRoot}/nnelf-eventexposure//subscriptions/{subscriptionId}" as request URI and "NefEventExposureSubsc" data structure as request body, the NEF shall update the subscription and send an HTTP "200 OK" response with the "NefEventExposureSubsc" data structure as response body containing the representation of the modified "Individual Network Exposure Event Subscription", or an HTTP "204 No Content" response, as shown in step 2 of figure 4.2.2.2.3-1. + +When the "monDur" attribute is included in the response by the NEF, it represents NEF selected expiry time that is equal or less than the expiry time received in the request. + +When the "immRep" attribute is included and sets to "true" in the subscription and the subscribed events are available, the NEF shall include the reports of the events subscribed, if available, in the HTTP PUT response. + +When the sampling ratio, as "sampRatio" attribute, is included in the subscription without a "partitionCriteria" attribute, the NEF shall select a random subset of UEs among the target UEs according to the sampling ratio and only report the event(s) related to the selected subset of UEs. If the "partitionCriteria" attribute is additionally included, then the NEF shall first partition the UEs according to the value of the "partitionCriteria" attribute and then select a random subset of + +UEs from each partition according to the sampling ratio and only report the event(s) related to the selected subsets of UEs. + +When the group reporting guard time, as "grpRepTime" attribute, is included in the subscription, the NEF shall accumulate all the event reports for the target UEs until the group reporting guard time expires. Then, the NEF shall notify the NF service consumer using the Nnef\_EventExposure\_Notify service operation, as described in clause 4.2.2.4. + +When the "notifFlag" attribute is included, and set to "DEACTIVATE" in the request, the NEF shall mute the event notification and store the available events until the NF service consumer requests to retrieve them by setting the "notifFlag" attribute to "RETRIEVAL" or until a muting exception occurs (e.g. full buffer). When a muting exception occurs, the NEF may consider the contents of the "notifFlagInstruct" attribute (if provided) and/or local configuration to determine its actions; if the "notifFlag" attribute is set to "RETRIEVAL" in the request, the NEF shall send the stored events to the NF service consumer, and mute the event notification again and store available events; if the "notifFlag" attribute is set to "ACTIVATE" and the event notifications are muted (due to a previously received "DEACTIVATE" value), the NEF shall unmute the event notification, i.e. start sending again notifications for available events. + +If the EnhDataMgmt feature is supported and the NEF accepts the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes, it may indicate the applied muting notification settings within the "mutingSetting" attribute in the response. If the NEF does not accept the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes, it shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "MUTING\_INSTR\_NOT\_ACCEPTED". + +#### 4.2.2.3 Nnef\_EventExposure\_Unsubscribe service operation + +##### 4.2.2.3.1 General + +This service operation is used by an NF service consumer to unsubscribe from event notifications. + +The following procedure using the Nnef\_EventExposure\_Unsubscribe service operation is supported: + +- unsubscribe from event notifications. + +##### 4.2.2.3.2 Unsubscription from event notifications + +Figure 4.2.2.3.2-1 illustrates the unsubscription from event notifications. + +![Sequence diagram illustrating the unsubscription from event notifications. The NF service consumer sends a DELETE request to the NEF, and the NEF responds with a 204 No Content.](2876be3592c7b4878400b85f209b2b6a_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NEF + Note right of NF service consumer: 1. DELETE ../subscriptions/{subscriptionId} + NF service consumer->>NEF: Request + Note left of NEF: 2. "204 No Content" + NEF-->>NF service consumer: Response +``` + +Sequence diagram illustrating the unsubscription from event notifications. The NF service consumer sends a DELETE request to the NEF, and the NEF responds with a 204 No Content. + +Figure 4.2.2.3.2-1: Unsubscription from event notifications + +To unsubscribe from event notifications, the NF service consumer shall send an HTTP DELETE request with "{apiRoot}/nnef-eventexposure/{apiVersion}/subscriptions/{subscriptionId}" as request URI, as shown in step 1 of figure 4.2.2.3.2-1, where "{subscriptionId}" is the subscription correlation identifier of the existing subscription resource that is to be deleted. + +If the NEF cannot successfully fulfil the received HTTP DELETE request due to an internal error or an error in the HTTP DELETE request, the NEF shall send an HTTP error response as specified in clause 5.1.7. + +If the feature "ES3XX" is supported, and the NEF determines the received HTTP DELETE request needs to be redirected, the NEF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +Upon successful reception of an HTTP DELETE request with: + +"`{apiRoot}/nnef-eventexposure/{apiVersion}/subscriptions/{subscriptionId}`" as request URI, the NEF shall remove the corresponding subscription and send an HTTP "204 No Content" response, as shown in step 2 of figure 4.2.2.3.2-1. + +#### 4.2.2.4 Nnef\_EventExposure\_Notify service operation + +##### 4.2.2.4.1 General + +The Nnef\_EventExposure\_Notify service operation enables the NEF to notify the NF service consumer(s) that the previously subscribed application related event occurred. + +The following procedure using the Nnef\_EventExposure\_Notify service operation is supported: + +- notification about subscribed events. + +##### 4.2.2.4.2 Notification about subscribed events + +Figure 4.2.2.4.2-1 illustrates the notification about subscribed events. + +![Sequence diagram showing the notification process between NEF and NF service consumer.](8ed7f57cc317f6574bec781d01ae6ad2_img.jpg) + +``` +sequenceDiagram + participant NEF + participant NF_service_consumer as NF service consumer + Note right of NEF: 1. POST {notifUri} + NEF->>NF_service_consumer: 1. POST {notifUri} + Note left of NF_service_consumer: 2. "204 No Content" + NF_service_consumer-->>NEF: 2. "204 No Content" +``` + +The diagram illustrates a sequence of interactions between the NEF and an NF service consumer. The NEF sends a POST request with the URI {notifUri} to the NF service consumer. The NF service consumer responds with a "204 No Content" status. + +Sequence diagram showing the notification process between NEF and NF service consumer. + +**Figure 4.2.2.4.2-1: Notification about subscribed events** + +If the NEF observes application related event(s) for which an NF service consumer has subscribed, the NEF shall send an HTTP POST request as shown in step 1 of figure 4.2.2.4.2-1, with the "`{notifUri}`" as request URI containing the value previously provided by the NF service consumer within the corresponding subscription, and the "NefEventExposureNotif" data structure. + +The "NefEventExposureNotif" data structure shall include: + +- notification correlation ID provided by the NF service consumer during the subscription as "notifId" attribute; and +- information about the observed event(s) within the "eventNotifs" attribute that shall contain for each observed event an "NefEventNotification" data structure that shall include: + - the application related event as "event" attribute; + - the time at which the event was observed encoded as "timeStamp" attribute; + - if the "event" attribute is "SVC\_EXPERIENCE", service experience information about the application involved in the reported event in the "svcExprcInfos" attribute; + - if the "event" attribute is "UE\_MOBILITY", UE mobility information associated with the application as "ueMobilityInfos" attribute; + +- if the "event" attribute is "UE\_COMM", UE communication information associated with the application as "ueCommInfos" attribute; +- if the "event" attribute is "EXCEPTIONS", exceptions information associated with a service flow as "excepInfos" attribute; +- if the "event" attribute is "PERF\_DATA", Performance Data Analytics related information as "perfDataInfos" attribute; +- if the "event" attribute is "COLLECTIVE\_BEHAVIOUR", collective behaviour information associated with the UEs and its applications as "collBhvrInfos" attribute; +- if the "event" attribute is "USER\_DATA\_CONGESTION", user data congestion information collected for an AF application as "congestionInfos" attribute; +- if the "event" attribute is "DISPERSION", UE dispersion information collected for an AF as "dispersionInfos" attribute; +- if the "event" attribute is "MS\_QOE\_METRICS", + - Media Streaming QoE metrics information collected for an UE application via the Data Collection AF as "msQoeMetrInfos" attribute; This attribute is deprecated; the attribute "msQoeMetrics" should be used instead; + - if the "MSEventExposure" feature is supported, the Media Streaming QoE metrics information collected for an UE application via the Data Collection AF as "msQoeMetrics" attribute; +- if the "event" attribute is "MS\_CONSUMPTION", + - Media Streaming Consumption reports information collected for an UE application via the Data Collection AF as "msConsumpInfos" attribute; This attribute is deprecated; the attribute "msConsumpReports" should be used instead; + - if the "MSEventExposure" feature is supported, the Media Streaming Consumption reports collected for an UE application via the Data Collection AF as "msConsumpReports" attribute; +- if the "event" attribute is "MS\_NET\_ASSIST\_INVOCATION", + - Media Streaming Network Assistance invocation information collected for an UE application via the Data Collection AF as "msNetAssInvInfos" attribute; This attribute is deprecated; the attribute "msNetAssistInvocation" should be used instead; + - if the "MSEventExposure" feature is supported, the Media Streaming Network Assistance invocation collected for an UE application via the Data Collection AF as "msNetAssistInvocation" attribute; +- if the "event" attribute is "MS\_DYN\_POLICY\_INVOCATION", + - Media Streaming Dynamic Policy invocations information collected for an UE application via the Data Collection AF as "msDynPlyInvInfos" attribute; This attribute is deprecated; the attribute "msDynPlyInvocation" should be used instead; + - if the "MSEventExposure" feature is supported, the Media Streaming Dynamic Policy invocation collected for an UE application via the Data Collection AF as "msDynPlyInvocation" attribute; +- if the "event" attribute is "MS\_ACCESS\_ACTIVITY", + - Media Streaming access activity information collected for an UE application via the Data Collection AF as "msAccActInfos" attribute; This attribute is deprecated; the attribute "msAccess" should be used instead. + - if the "MSEventExposure" feature is supported, the Media Streaming access activity collected for an UE application via the Data Collection AF as "msAccess" attribute; and +- if the "event" attribute is "GNSS\_ASSISTANCE\_DATA", GNSS Assistance Data information within the "gnssAssistDataInfo" attribute; + +- if the "event" attribute is "E2E\_DATA\_VOL\_TRANS\_TIME", data volume transfer time information associated with the application as "datVolTransTimeInfos" attribute. + +If the NF service consumer cannot successfully fulfil the received HTTP POST request due to an internal error or an error in the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.1.7. + +If the feature "ES3XX" is supported, and the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +Upon successful reception of an HTTP POST request with "{notifiUri}" as request URI and "NefEventExposureNotif" data structure as request body, the NF service consumer shall send an HTTP "204 No Content" response, as shown in step 2 of figure 4.2.2.4.2-1, in case of a successful processing. + +## 4.3 Nnef\_EASDeployment Service + +### 4.3.1 Service Description + +#### 4.3.1.1 Overview + +The Nnef\_EASDeployment service, as defined in 3GPP TS 23.502 [3], is provided by the Network Exposure Function (NEF). This service allows the SMF to subscribe/unsubscribe the notification of AF provisioned EAS Deployment information, and for the NEF to notify the AF provisioned EAS Deployment information to the subscribed SMF. + +#### 4.3.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. + +The Nnef\_EASDeployment service is part of the Nnef service-based interface exhibited by the Network Exposure Function (NEF). + +Known consumer of the Nnef\_EASDeployment service is: + +- Session Management Function (SMF) + +![Reference Architecture for the Nnef_EASDeployment Service; SBI representation diagram](73da53f7da73c0e2ead71eb1e2f746fb_img.jpg) + +The diagram illustrates the service-based interface (SBI) representation for the Nnef\_EASDeployment service. At the top, a rectangular box labeled "NEF" contains an oval labeled "Nnef". A vertical line descends from the "Nnef" oval to a rectangular box at the bottom labeled "SMF". The vertical line is labeled "Nnef\_EASDeployment" to its right. + +Reference Architecture for the Nnef\_EASDeployment Service; SBI representation diagram + +**Figure 4.3.1.2-1: Reference Architecture for the Nnef\_EASDeployment Service; SBI representation** + +![Diagram showing the reference architecture for the Nnef_EASDeployment Service. It consists of two rectangular boxes, 'NEF' at the top and 'SMF' at the bottom, connected by a vertical line. A horizontal tick mark is placed on the vertical line, and the label 'N29' is positioned to the right of this tick mark.](26d664119ad25250780f554633444e54_img.jpg) + +``` + +graph TD + NEF[NEF] --- N29((N29)) + N29 --- SMF[SMF] + +``` + +Diagram showing the reference architecture for the Nnef\_EASDeployment Service. It consists of two rectangular boxes, 'NEF' at the top and 'SMF' at the bottom, connected by a vertical line. A horizontal tick mark is placed on the vertical line, and the label 'N29' is positioned to the right of this tick mark. + +**Figure 4.3.1.2-2: Reference Architecture for the Nnef\_EASDeployment Service: reference point representation** + +#### 4.3.1.3 Network Functions + +##### 4.3.1.3.1 Network Exposure Function (NEF) + +The Network Exposure Function (NEF) is a functional element that support for the NF service consumer (i.e SMF) subscribing to the notification of the AF provisioned EAS Deployment Information and provide EAS Deployment Information change notification to the NF service consumer as defined in this specification. + +##### 4.3.1.3.2 NF Service Consumers + +The known NF service consumers are as follows: + +The Session Management Function (SMF): + +- supports (un)subscribing to notifications of subscribed event(s) from the NEF. +- supports receiving the notifications of subscribed event(s) from the NEF. + +#### 4.3.2 Service Operations + +##### 4.3.2.1 Introduction + +Service operations defined for the Nnef\_EASDeployment Service are shown in table 4.3.2.1-1. + +**Table 4.3.2.1-1: Nnef\_EventExposure Service Operations** + +| Service Operation Name | Description | Initiated by | +|--------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Nnef_EASDeployment_Subscribe | This service operation is used by an NF service consumer to explicitly subscribe the notification of changes of EAS Deployment Information. | NF service consumer | +| Nnef_EASDeployment_Unsubscribe | This service operation is used by an NF service consumer to explicitly unsubscribe the notification of changes of EAS Deployment Information. | NF service consumer | +| Nnef_EASDeployment_Notify | This service operation is used by the NEF to provide subscribed event information, e.g.updated EAS Deployment Information to the NF service consumer. | NEF | + +### 4.3.2.2 Nnef\_EASDeployment\_Subscribe service operation + +#### 4.3.2.2.1 General + +This service operation is provided by the NEF for NF consumers to explicitly subscribe the notification of changes of EAS Deployment Information. + +#### 4.3.2.2.2 Creating a new subscription + +In order to subscribe to EAS Deployment Information change event, the SMF shall send an HTTP POST request message to the NEF for the "EAS Deployment Event Subscriptions" resource. The HTTP POST message shall include EasDeploySubData data structure as request body. The EasDeploySubData data structure shall include: + +- Event Id in the "eventId" attribute; +- An notification correlation ID provided by the NF service consumer during the subscription as "notifId" attribute; and +- An URI to receive the subscribed EAS Deployment information change notifications as "notifUri" attribute. + +and may include: + +- an indicator to immediately report the current status of EAS Deployment Information if available, as "immRep" attribute; +- (list of) DNN and/or S-NSSAI combination as "dnnSnssaiInfos" attribute; +- identification of an application as "appId" attribute; and/or +- an internal Group Identifier as "interGroupId" attribute. + +Upon receipt of the HTTP request from the SMF, if the SMF is validated, the NEF shall interact with the UDR by invoking the Nudr\_DataRepository service as described in 3GPP TS 29.504 [20] to fetch the EAS Deployment Information in the application data in the UDR. + +After receiving a successful response from the UDR, the NEF shall create a new subscription and assign a subscription identifier for the "Individual EAS Deployment Event Subscription" resource. Then the NEF shall send a HTTP "201 Created" response with EASDeploySubData data structure as response body and a Location header field containing the URI of the created individual subscription resource to the NF service consumer. If the immediate report indicator is included in the subscription request, the NEF shall include in the response body the currently available EAS Deployment Information that match the subscription. + +NOTE: When the "targetAfId" attribute is included in the EAS Deployment Information, then all DNAI(s) correspond to the same EHE provider. The "targetAfId" attribute can be used in case of AF(s) involving different EHE providers, and the source EHE is unaware of other/target EHE specific deployment details. + +If the NEF receives an error code from the UDR, the NEF shall take proper error handling actions and shall respond to the SMF with a proper error status code. + +### 4.3.2.3 Nnef\_EASDeployment\_Unsubscribe service operation + +#### 4.3.2.3.1 General + +This service operation is used by an NF service consumer (i.e. SMF) to explicitly unsubscribe the notification of changes of EAS Deployment Information. + +The following procedure using the Nnef\_EASDeployment\_Unsubscribe service operation is supported: + +- unsubscribe from the notification of changes of EAS Deployment Information. + +#### 4.3.2.3.2 Unsubscription of notification of changes of EAS Deployment Information + +In order to delete an existing subscription to EAS Deployment Information change event, the NF service consumer shall send an HTTP DELETE request message to the individual resource URI "{apiRoot}/nnef-eas-deployment/v1/subscriptions/{subscriptionId}" in which the "{subscriptionId}" is the subscription correlation identifier of the existing subscription resource that is to be deleted. + +The NEF shall delete the individual resource and shall respond to the NF service consumer with an HTTP "204 No Content" response message. + +If the NEF cannot delete the individual resource, shall take proper error handling actions and shall respond to the NF service consumer with a proper error status code. + +#### 4.3.2.4 Nnef\_EASDeployment\_Notify service operation + +##### 4.3.2.4.1 General + +The Nnef\_EASDeployment\_Notify service operation enables the NEF to notify the subscribed event information, e.g. updated EAS Deployment Information to the NF Consumer. + +The following procedure using the Nnef\_EASDeployment\_Notify service operation is supported: + +- notification about subscribed EAS Deployment Information change. + +##### 4.3.2.4.2 Notification of changes of EAS Deployment Information + +When the EAS Deployment information is changed, the NEF shall provide a notification to the subscribed NF service consumer by sending an HTTP POST message that include the EasDeployInfoNotif data structure in the request body to notify the EAS Deployment information changes to the NF service consumer. + +The EasDeployInfoNotif data structure shall include the subscribed Event ID and the EAS Deployment Information. + +NOTE: When the "targetAflId" attribute is included in the EAS Deployment Information, then all DNAI(s) correspond to the same EHE provider. The "targetAflId" attribute can be used in case of AF(s) involving different EHE providers, and the source EHE is unaware of other/target EHE specific deployment details. + +Upon receipt of the EAS Deployment event notification, the NF service consumer shall respond with a "204 No Content" status code to confirm the received notification. + +### 4.4 Nnef\_TrafficInfluenceData Service + +#### 4.4.1 Service Description + +##### 4.4.1.1 Overview + +The Nnef\_TrafficInfluenceData service, as defined in 3GPP TS 23.502 [3], is provided by the Network Exposure Function (NEF). This service allows the V-SMF supporting HR-SBO to subscribe/unsubscribe the notification of Traffic Influence from AF in VPLMN, and for the V-NEF to notify the Traffic Influence to the subscribed V-SMF. + +##### 4.4.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. + +The Nnef\_TrafficInfluenceData service is part of the Nnef service-based interface exhibited by the Network Exposure Function (NEF). + +Known consumer of the Nnef\_TrafficInfluenceData service is: + +- Session Management Function (SMF) + +![Reference Architecture for the Nnef_TrafficInfluenceData Service; SBI representation](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +A diagram showing the Service Based Interface (SBI) representation. At the top is a rectangular box labeled 'NEF'. Inside this box is an oval labeled 'Nnef'. A vertical line connects the 'Nnef' oval to a rectangular box at the bottom labeled 'SMF'. The line is labeled 'Nnef\_TrafficInfluenceData'. + +Reference Architecture for the Nnef\_TrafficInfluenceData Service; SBI representation + +**Figure 4.4.1.2-1: Reference Architecture for the Nnef\_TrafficInfluenceData Service; SBI representation** + +![Reference Architecture for the Nnef_TrafficInfluenceData Service: reference point representation](759c7d62402f0b4651ddce292be5bdef_img.jpg) + +A diagram showing the reference point representation. At the top is a rectangular box labeled 'NEF'. A vertical line connects it to a rectangular box at the bottom labeled 'SMF'. A horizontal tick mark is placed on the vertical line, and the label 'N29' is placed to the right of the tick mark. + +Reference Architecture for the Nnef\_TrafficInfluenceData Service: reference point representation + +**Figure 4.4.1.2-2: Reference Architecture for the Nnef\_TrafficInfluenceData Service: reference point representation** + +#### 4.4.1.3 Network Functions + +##### 4.4.1.3.1 Network Exposure Function (NEF) + +The Network Exposure Function (NEF) allows the NF service consumer (i.e. SMF) to subscribe to and unsubscribe from the NEF for the Traffic Influence Data from AF. + +##### 4.4.1.3.2 NF Service Consumers + +The known NF service consumers are as follows: + +The Session Management Function (SMF): + +- supports (un)subscribing to notifications of Traffic Influence Data from the NEF. +- supports receiving the notifications of Traffic Influence Data from the NEF. + +#### 4.4.2 Service Operations + +##### 4.4.2.1 Introduction + +Service operations defined for the Nnef\_TrafficInfluenceData Service are shown in table 4.4.2.1-1. + +**Table 4.4.2.1-1: Nnef\_TrafficInfluenceData Service Operations** + +| Service Operation Name | Description | Initiated by | +|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Nnef_TrafficInfluenceData_Subscribe | This service operation is used by an NF service consumer to explicitly subscribe the notification of Traffic Influence Data. | NF service consumer | +| Nnef_TrafficInfluenceData_Unsubscribe | This service operation is used by an NF service consumer to explicitly unsubscribe the notification of Traffic Influence Data. | NF service consumer | +| Nnef_TrafficInfluenceData_Notify | This service operation is used by the NEF to provide Traffic Influence Data to the NF service consumer. | NEF | + +#### 4.4.2.2 Nnef\_TrafficInfluenceData\_Subscribe service operation + +##### 4.4.2.2.1 General + +This service operation is provided by the NEF for NF consumers to explicitly subscribe the notification of Traffic Influence Data. + +##### 4.4.2.2.2 Creating a new subscription + +Figure 4.4.2.2.2-1 illustrates the creation of a Individual Traffic Influence Data Subscription. + +![Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to the NEF, and the NEF responds with a 201 Created status.](84e5b251aa38db522f76f5cc3afcb853_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NEF + Note right of NF service consumer: 1. POST « /subscriptions » + NF service consumer->>NEF: Request + Note left of NEF: 2. "201 Created" + NEF-->>NF service consumer: Response + +``` + +Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to the NEF, and the NEF responds with a 201 Created status. + +**Figure 4.4.2.2.2-1: Creation of a subscription** + +In order to subscribe to Traffic Influence Data, the SMF shall send an Nnef\_TrafficInfluenceData\_Subscribe request using the HTTP POST method to the NEF with "{apiRoot}/nnef-traffic-influence-data//subscriptions" as request URI as shown in step 1 of figure 4.4.2.2.2-1. The HTTP POST message shall include TrafficInfluDataSub data structure as request body. The TrafficInfluDataSub data structure shall include: + +- the notification URI in the "notifUri" attribute; +- the notification correlation identifier in the "notifCorrId" attribute; + +and may include: + +- the identifications of DNN in "dnns" attribute; +- the identifications of network slice in "snssais" attribute; +- the internal Group Identifier in "internalGroupIds" attribute; +- the identifications of target UE(s) in "supis" attribute; +- the any UE indication in "anyUe" attribute; +- the reporting requirements of the subscription in "rptInfo" attribute; + +Upon receipt of the HTTP request from the SMF, the NEF shall interact with the UDR by invoking the Nudr\_DataRepository service as described in 3GPP TS 29.504 [20] to retrieve and subscribe to the Traffic Influence Data in the application data in the UDR. + +After receiving a successful response from the UDR, the NEF shall create a new subscription and assign a subscription identifier for the "Individual Traffic Influence Data Subscription" resource. Then the NEF shall send an HTTP "201 Created" response with TrafficInfluDataSub data structure as response body and a Location header field containing the URI of the created individual subscription resource to the NF service consumer. + +If the immediate report indication is included in the subscription request, the NEF shall include the currently available Traffic Influence Data in the response body. + +If errors occur when processing the HTTP POST request or receiving an error code from the UDR, the NEF shall send an HTTP error response as specified in clause 5.3.7. + +#### 4.4.2.2.3 Modifying an existing subscription + +Figure 4.4.2.2.3-1 illustrates the modification of an existing subscription. + +![Sequence diagram illustrating the modification of an existing subscription. The NF service consumer sends a PUT request to the NEF. The NEF responds with either a 200 OK or a 204 No Content.](7fe7bcb3d40736e0b29d9f48ff3cc026_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NEF + Note right of NF service consumer: 1. PUT « /subscriptions/{subscriptionId} » + NF service consumer->>NEF: Request + Note left of NEF: 2a. 200 OK +2b. 204 No Content + NEF-->>NF service consumer: Response +``` + +Sequence diagram illustrating the modification of an existing subscription. The NF service consumer sends a PUT request to the NEF. The NEF responds with either a 200 OK or a 204 No Content. + +**Figure 4.4.2.2.3-1: Modification of an existing subscription** + +To modify an existing subscription to event notifications, the NF service consumer shall send an HTTP PUT request with: "{apiRoot}/nnef-traffic-influence-data//subscriptions/{subscriptionId}" as request URI, as shown in step 1 of figure 4.4.2.2.3-1, where "{subscriptionId}" is the subscription ID of the existing subscription. The TrafficInfluDataSub data structure is included as request body as described in clause 4.4.2.2.2. + +Upon successful reception of an HTTP PUT request with: "{apiRoot}/nnef-traffic-influence-data//subscriptions/{subscriptionId}" as request URI and TrafficInfluDataSub data structure as request body, the NEF shall interact with the UDR by invoking the Nudr\_DataRepository service as described in 3GPP TS 29.504 [20] to retrieve and subscribe to the Traffic Influence Data in the application data in the UDR. + +After receiving a successful response from the UDR, the NEF shall: + +- send HTTP "200 OK" response (as shown in figure 4.4.2.2.3-1, step 2a) with a response body containing a representation of the updated subscription in the TrafficInfluDataSub data type; or +- send HTTP "204 No Content" response (as shown in figure 4.4.2.2.3-1, step 2b). + +If the immediate report indication is included in the subscription request, the NEF shall include the currently available Traffic Influence Data in the response body. + +If the received HTTP PUT request needs to be redirected, the NEF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +If errors occur when processing the HTTP PUT request or receiving an error code from the UDR, the NEF shall send an HTTP error response as specified in clause 5.3.7. + +#### 4.4.2.3 Nnef\_TrafficInfluenceData\_Unsubscribe service operation + +##### 4.4.2.3.1 General + +This service operation is used by an NF service consumer (i.e. SMF) to explicitly unsubscribe the notification of Traffic Influence Data. + +The following procedure using the Nnef\_TrafficInfluenceData\_Unsubscribe service operation is supported: + +- unsubscription from the notification of Traffic Influence Data. + +##### 4.4.2.3.2 Unsubscription of notification of Traffic Influence Data + +Figure 4.4.2.3.2-1 illustrates the unsubscription of event notifications from NEF. + +![Sequence diagram showing the unsubscription process. An NF service consumer sends a DELETE request to the NEF, and the NEF responds with a 204 No Content.](f64e1e0997695248c0cd4122c5b1a170_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NEF + Note right of NF service consumer: 1. DELETE .../subscriptions/{subscriptionId} + NF service consumer->>NEF: Request + Note left of NEF: 2. "204 No Content" + NEF-->>NF service consumer: Response +``` + +Sequence diagram showing the unsubscription process. An NF service consumer sends a DELETE request to the NEF, and the NEF responds with a 204 No Content. + +**Figure 4.4.2.3.2-1: NF service consumer unsubscribes from notifications** + +In order to delete an existing subscription to Traffic Influence Data, the NF service consumer shall send an HTTP DELETE request message with "{apiRoot}/nnef-traffic-influence-data//subscriptions/{subscriptionId}" as request URI, as shown in step 1 of figure 4.4.2.3.2-1, where "{subscriptionId}" is the subscription identifier of the existing subscription resource that is to be deleted. + +Upon successful reception of an HTTP DELETE, the NEF shall delete the individual resource and shall respond to the NF service consumer with an HTTP "204 No Content" response message, as shown in step 2 of figure 4.4.2.3.2-1. + +If the received HTTP DELETE request needs to be redirected, the NEF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +If errors occur when processing the HTTP DELETE request, the NEF shall send an HTTP error response as specified in clause 5.3.7. + +#### 4.4.2.4 Nnef\_TrafficInfluenceData\_Notify service operation + +##### 4.4.2.4.1 General + +The Nnef\_TrafficInfluenceData\_Notify service operation enables the NEF to notify the Traffic Influence Data to the NF Consumer. + +The following procedure using the Nnef\_TrafficInfluenceData\_Notify service operation is supported: + +- notification about subscribed Traffic Influence Data. + +##### 4.4.2.4.2 Notification of changes of Traffic Influence Data + +Figure 4.4.2.4.2-1 illustrates the notification about Traffic Influence Data. + +![Sequence diagram showing notification about Traffic Influence Data between NEF and NF service consumer.](e05b36c0d46549e681ce6581422c66b2_img.jpg) + +``` +sequenceDiagram + participant NEF + participant NF_service_consumer as NF service consumer + Note right of NEF: 1. POST {notifUri} + NEF->>NF_service_consumer: 1. POST {notifUri} + Note left of NF_service_consumer: 2. "204 No Content" + NF_service_consumer-->>NEF: 2. "204 No Content" +``` + +The diagram illustrates a sequence of two messages between the NEF and the NF service consumer. The first message is a POST request from the NEF to the NF service consumer, labeled "1. POST {notifUri}". The second message is a response from the NF service consumer to the NEF, labeled "2. "204 No Content"". The NEF is on the left and the NF service consumer is on the right. + +Sequence diagram showing notification about Traffic Influence Data between NEF and NF service consumer. + +**Figure 4.4.2.4.2-1: Notification about Traffic Influence Data** + +If the NEF observes Traffic Influence Data that an NF service consumer has subscribed, the NEF shall send an HTTP POST request as shown in step 1 of figure 4.4.2.4.2-1, with the "{notifUri}" as request URI containing the value previously provided by the NF service consumer within the corresponding subscription, and the TrafficInfluDataNotify data structure as request body. + +The TrafficInfluDataNotify data structure shall include: + +- the notification correlation identifier in the "notifCorrId" attribute; +- Traffic Influence Data within the "eventNotifications" attribute. + +Upon successful reception of an HTTP POST request with "{notifUri}" as request URI and TrafficInfluDataNotify data structure as request body, the NF service consumer shall send an HTTP "204 No Content" response, as shown in step 2 of figure 4.4.2.4.2-1. + +## 4.5 Nnef\_ECSAddress Service + +### 4.5.1 Service Description + +#### 4.5.1.1 Overview + +The Nnef\_ECSAddress service, as defined in 3GPP TS 23.502 [3], is provided by the Network Exposure Function (NEF). This service allows the V-SMF to subscribe/unsubscribe the notification of ECS Address Configuration Information from AF in VPLMN, and for the V-NEF to notify the ECS Address Configuration Information to the subscribed V-SMF. + +#### 4.5.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. + +The Nnef\_ECSAddress service is part of the Nnef service-based interface exhibited by the Network Exposure Function (NEF). + +Known consumer of the Nnef\_ECSAddress service is: + +- Session Management Function (SMF) + +![Figure 4.5.1.2-1: Reference Architecture for the Nnef_ECSAddress Service; SBI representation. The diagram shows a Network Exposure Function (NEF) at the top, represented by a rectangle containing an oval labeled 'Nnef'. Below it is a Session Management Function (SMF), represented by a rectangle. A vertical line connects the NEF and the SMF, with the label 'Nnef_ECSAddress' to the right of the connection line.](b5335262987c819d7f71ce40f99cb71b_img.jpg) + +Figure 4.5.1.2-1: Reference Architecture for the Nnef\_ECSAddress Service; SBI representation. The diagram shows a Network Exposure Function (NEF) at the top, represented by a rectangle containing an oval labeled 'Nnef'. Below it is a Session Management Function (SMF), represented by a rectangle. A vertical line connects the NEF and the SMF, with the label 'Nnef\_ECSAddress' to the right of the connection line. + +**Figure 4.5.1.2-1: Reference Architecture for the Nnef\_ECSAddress Service; SBI representation** + +![Figure 4.5.1.2-2: Reference Architecture for the Nnef_ECSAddress Service: reference point representation. The diagram shows a Network Exposure Function (NEF) at the top, represented by a rectangle. Below it is a Session Management Function (SMF), represented by a rectangle. A vertical line connects the NEF and the SMF, with a small horizontal tick mark on the line and the label 'N29' to the right of the connection line.](5478f70a6cef3e5672b2b22d28830cfb_img.jpg) + +Figure 4.5.1.2-2: Reference Architecture for the Nnef\_ECSAddress Service: reference point representation. The diagram shows a Network Exposure Function (NEF) at the top, represented by a rectangle. Below it is a Session Management Function (SMF), represented by a rectangle. A vertical line connects the NEF and the SMF, with a small horizontal tick mark on the line and the label 'N29' to the right of the connection line. + +**Figure 4.5.1.2-2: Reference Architecture for the Nnef\_ECSAddress Service: reference point representation** + +#### 4.5.1.3 Network Functions + +##### 4.5.1.3.1 Network Exposure Function (NEF) + +The Network Exposure Function (NEF) allows the NF service consumer (i.e. SMF) to subscribe to and unsubscribe from the NEF for the ECS Address Configuration Information from the AF. + +##### 4.5.1.3.2 NF Service Consumers + +The known NF service consumers are as follows: + +The Session Management Function (SMF): + +- supports (un)subscribing to notifications of ECS Address Configuration Information from the NEF. +- supports receiving the notifications of ECS Address Configuration Information from the NEF. + +#### 4.5.2 Service Operations + +##### 4.5.2.1 Introduction + +Service operations defined for the Nnef\_ECSAddress Service are shown in table 4.5.2.1-1. + +**Table 4.5.2.1-1: Nnef\_ECSAddress Service Operations** + +| Service Operation Name | Description | Initiated by | +|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Nnef_ECSAddress_Subscribe | This service operation is used by an NF service consumer to explicitly subscribe the notification of ECS Address Configuration Information. | NF service consumer | +| Nnef_ECSAddress_Unsubscribe | This service operation is used by an NF service consumer to explicitly unsubscribe the notification of ECS Address Configuration Information. | NF service consumer | +| Nnef_ECSAddress_Notify | This service operation is used by the NEF to provide ECS Address Configuration Information to the NF service consumer. | NEF | + +#### 4.5.2.2 Nnef\_ECSAddress\_Subscribe service operation + +##### 4.5.2.2.1 General + +This service operation is provided by the NEF for NF consumers to explicitly subscribe the notification of ECS Address Configuration Information. + +##### 4.5.2.2.2 Creating a new subscription + +Figure 4.5.2.2.2-1 illustrates the creation of a Individual ECS Address Configuration Information Subscription. + +![Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to the NEF, and the NEF responds with a 201 Created status.](f732d3320afe06d979aabbd366184254_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NEF + Note right of NF service consumer: 1. POST « /subscriptions » + NF service consumer->>NEF: Request + Note left of NEF: 2. "201 Created" + NEF-->>NF service consumer: Response + +``` + +Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to the NEF, and the NEF responds with a 201 Created status. + +**Figure 4.5.2.2.2-1: Creation of a subscription** + +In order to subscribe to ECS Address Configuration Information, the SMF shall send an Nnef\_ECSAddress\_Subscribe request using the HTTP POST method to the NEF with "{apiRoot}/nnef-ecs-addr-cfg-info//subscriptions" as request URI as shown in step 1 of figure 4.5.2.2.2-1. The HTTP POST message shall include EcsAddrCfgInfoSub data structure as request body. The EcsAddrCfgInfoSub data structure shall include: + +- the notification URI in the "notifUri" attribute; +- the notification correlation identifier in the "notifCorrId" attribute; + +and may include: + +- the identifications of DNN in "dnns" attribute; +- the identifications of network slice in "snssais" attribute; +- the internal Group Identifier in "internalGroupId" attribute; +- an indicator to immediately report the currently available ECS Address Configuration Information in "immRepInd" attribute; + +Upon receipt of the HTTP request from the SMF, the NEF shall interact with the UDR by invoking the Nudr\_DataRepository service as described in 3GPP TS 29.504 [20] to fetch the ECS Address Configuration Information in the application data in the UDR. + +After receiving a successful response from the UDR, the NEF shall create a new subscription and assign a subscription identifier for the "Individual ECS Address Configuration Information Subscription" resource. Then the NEF shall send an HTTP "201 Created" response with EcsAddrCfgInfoSub data structure as response body and a Location header field containing the URI of the created individual subscription resource to the NF service consumer. + +If the immediate report indication is included in the subscription request, the NEF shall include the currently available ECS Address Configuration Information in "immReports" attribute in the response body. + +If errors occur when processing the HTTP POST request or receiving an error code from the UDR, the NEF shall send an HTTP error response as specified in clause 5.3.7. + +#### 4.5.2.2.3 Modifying an existing subscription + +Figure 4.5.2.2.3-1 illustrates the modification of an existing subscription. + +![Sequence diagram showing the modification of an existing subscription. The NF service consumer sends a PUT request to the NEF. The NEF responds with either a 200 OK or a 204 No Content.](b2ddf2a678bd20b1b491023eb1db6458_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NEF + Note right of NEF: 1. PUT « /subscriptions/{subscriptionId} » + NEF->>NF service consumer: 2a. 200 OK + Note right of NEF: 2b. 204 No Content + +``` + +Sequence diagram showing the modification of an existing subscription. The NF service consumer sends a PUT request to the NEF. The NEF responds with either a 200 OK or a 204 No Content. + +**Figure 4.5.2.2.3-1: Modification of an existing subscription** + +To modify an existing subscription to event notifications, the NF service consumer shall send an HTTP PUT request with: "{apiRoot}/nnef-ecs-addr-cfg-info//subscriptions/{subscriptionId}" as request URI, as shown in step 1 of figure 4.5.2.2.3-1, where "{subscriptionId}" is the subscription ID of the existing subscription. The EcsAddrCfgInfoSub data structure is included as request body as described in clause 4.5.2.2.2. + +Upon successful reception of an HTTP PUT request with: + +"{apiRoot}/nnef-ecs-addr-cfg-info//subscriptions/{subscriptionId}" as request URI and EcsAddrCfgInfoSub data structure as request body, the NEF shall interact with the UDR by invoking the Nudr\_DataRepository service as described in 3GPP TS 29.504 [20] to fetch the ECS Address Configuration Information in the application data in the UDR. + +After receiving a successful response from the UDR, the NEF shall: + +- send HTTP "200 OK" response (as shown in figure 4.5.2.2.3-1, step 2a) with a response body containing a representation of the updated subscription in the EcsAddrCfgInfoSub data type; or +- send HTTP "204 No Content" response (as shown in figure 4.5.2.2.3-1, step 2b). + +If the immediate report indication is included in the subscription request, the NEF shall include the current available ECS Address Configuration Information in the response body. + +If the received HTTP PUT request needs to be redirected, the NEF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +If errors occur when processing the HTTP PUT request or receiving an error code from the UDR, the NEF shall send an HTTP error response as specified in clause 5.3.7. + +#### 4.5.2.3 Nnef\_ECSAddress\_Unsubscribe service operation + +##### 4.5.2.3.1 General + +This service operation is used by an NF service consumer (i.e. SMF) to explicitly unsubscribe the notification of ECS Address Configuration Information. + +The following procedure using the Nnef\_ECSAddress\_Unsubscribe service operation is supported: + +- unsubscription from the notification of ECS Address Configuration Information. + +##### 4.5.2.3.2 Unsubscription of notification of ECS Address Configuration Information + +Figure 4.5.2.3.2-1 illustrates the unsubscription of event notifications from NEF. + +![Sequence diagram showing the unsubscription process. An NF service consumer sends a DELETE request to the NEF, and the NEF responds with a 204 No Content.](3db5d62ad46e33647ec2b1ad6d2703bb_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NEF + Note right of NF service consumer: 1. DELETE .. /subscriptions/{subscriptionId} + NF service consumer->>NEF: Request + Note left of NEF: 2. "204 No Content" + NEF-->>NF service consumer: Response +``` + +Sequence diagram showing the unsubscription process. An NF service consumer sends a DELETE request to the NEF, and the NEF responds with a 204 No Content. + +**Figure 4.5.2.3.2-1: NF service consumer unsubscribes from notifications** + +In order to delete an existing subscription to ECS Address Configuration Information, the NF service consumer shall send an HTTP DELETE request message with "{apiRoot}/nnef-ecs-addr-cfg-info//subscriptions/{subscriptionId}" as request URI, as shown in step 1 of figure 4.5.2.3.2-1, where "{subscriptionId}" is the subscription identifier of the existing subscription resource that is to be deleted. + +Upon successful reception of an HTTP DELETE, the NEF shall delete the individual resource and shall respond to the NF service consumer with an HTTP "204 No Content" response message, as shown in step 2 of figure 4.5.2.3.2-1. + +If the received HTTP DELETE request needs to be redirected, the NEF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +If errors occur when processing the HTTP DELETE request, the NEF shall send an HTTP error response as specified in clause 5.3.7. + +#### 4.5.2.4 Nnef\_ECSAddress\_Notify service operation + +##### 4.5.2.4.1 General + +The Nnef\_ECSAddress\_Notify service operation enables the NEF to notify the ECS Address Configuration Information to the NF Consumer. + +The following procedure using the Nnef\_ECSAddress\_Notify service operation is supported: + +- notification about subscribed ECS Address Configuration Information. + +##### 4.5.2.4.2 Notification of changes of ECS Address Configuration Information + +Figure 4.5.2.4.2-1 illustrates the notification about ECS Address Configuration Information. + +![Sequence diagram showing notification about ECS Address Configuration Information between NEF and NF service consumer.](78ff716475b2f65bf01c3a4d02d89fc4_img.jpg) + +``` +sequenceDiagram + participant NEF + participant NF_service_consumer as NF service consumer + Note right of NEF: 1. POST {notifUri} + NEF->>NF_service_consumer: 1. POST {notifUri} + Note left of NF_service_consumer: 2. "204 No Content" + NF_service_consumer-->>NEF: 2. "204 No Content" +``` + +The diagram illustrates a sequence of interactions between the Network Exposure Function (NEF) and an NF service consumer. The NEF sends a POST request to the NF service consumer, labeled '1. POST {notifUri}'. The NF service consumer responds with a '204 No Content' status, labeled '2. "204 No Content"'. The arrows indicate the direction of the messages: the first arrow points from the NEF to the NF service consumer, and the second arrow points from the NF service consumer back to the NEF. + +Sequence diagram showing notification about ECS Address Configuration Information between NEF and NF service consumer. + +**Figure 4.5.2.4.2-1: Notification about ECS Address Configuration Information** + +If the NEF observes ECS Address Configuration Information that an NF service consumer has subscribed, the NEF shall send an HTTP POST request as shown in step 1 of figure 4.5.2.4.2-1, with the "{notifUri}" as request URI containing the value previously provided by the NF service consumer within the corresponding subscription, and the EcsAddrCfgInfoNotification data structure as request body. + +The EcsAddrCfgInfoNotification data structure shall include: + +- the notification correlation identifier in the "notifCorrId" attribute; +- ECS Address Configuration Information within the "ecsAddrCfgInfo" attribute. + +Upon successful reception of an HTTP POST request with "{notifUri}" as request URI and EcsAddrCfgInfoNotification data structure as request body, the NF service consumer shall send an HTTP "204 No Content" response, as shown in step 2 of figure 4.5.2.4.2-1. + +## 4.6 Nnef\_DNAIMapping Service + +### 4.6.1 Service Description + +#### 4.6.1.1 Overview + +The Nnef\_DNAIMapping service, as defined in 3GPP TS 23.502 [3], is provided by the Network Exposure Function (NEF). This service allows the NEF service consumer (e.g. NWDAF) to create or delete subscription(s) of DNAI Mapping information to NEF and also by NEF to notify the NF service consumer about the update of the DNAI Mapping information. + +#### 4.6.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. + +The Nnef\_DNAIMapping service is part of the Nnef service-based interface exhibited by the Network Exposure Function (NEF). + +Known consumer of the Nnef\_DNAIMapping service is: + +- Network Data Analytics Function (NWDAF) + +![Figure 4.6.1.2-1: Reference Architecture for the Nnef_DNAIMapping Service; SBI representation. The diagram shows a Network Exposure Function (NEF) box containing an oval labeled 'Nnef'. A vertical line labeled 'DNAIMapping' connects the 'Nnef' oval to a Network Data Analytics Function (NWDAF) box below it.](6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg) + +``` + +graph TD + subgraph NEF + Nnef((Nnef)) + end + Nnef -- DNAIMapping --> NWDAF[NWDAF] + +``` + +Figure 4.6.1.2-1: Reference Architecture for the Nnef\_DNAIMapping Service; SBI representation. The diagram shows a Network Exposure Function (NEF) box containing an oval labeled 'Nnef'. A vertical line labeled 'DNAIMapping' connects the 'Nnef' oval to a Network Data Analytics Function (NWDAF) box below it. + +**Figure 4.6.1.2-1: Reference Architecture for the Nnef\_DNAIMapping Service; SBI representation** + +![Figure 4.6.1.2-2: Reference Architecture for the Nnef_DNAIMapping Service: reference point representation. The diagram shows a Network Exposure Function (NEF) box connected by a vertical line to a Network Data Analytics Function (NWDAF) box below it. There is a small horizontal tick mark on the vertical line between the two boxes.](382a9c9e4816bd229191ab4591424dd8_img.jpg) + +``` + +graph TD + NEF[NEF] --> NWDAF[NWDAF] + +``` + +Figure 4.6.1.2-2: Reference Architecture for the Nnef\_DNAIMapping Service: reference point representation. The diagram shows a Network Exposure Function (NEF) box connected by a vertical line to a Network Data Analytics Function (NWDAF) box below it. There is a small horizontal tick mark on the vertical line between the two boxes. + +**Figure 4.6.1.2-2: Reference Architecture for the Nnef\_DNAIMapping Service: reference point representation** + +#### 4.6.1.3 Network Functions + +##### 4.6.1.3.1 Network Exposure Function (NEF) + +The Network Exposure Function (NEF) allows the NF service consumer (e.g. NWDAF) to subscribe to and unsubscribe from the NEF for the DNAI Mapping information and also by NEF to notify the NF service consumer about the update of the DNAI Mapping information. + +##### 4.6.1.3.2 NF Service Consumers + +The known NF service consumers are as follows: + +The Network Data Analytics Function (NWDAF): + +- supports (un)subscribing to notifications of DNAI Mapping information from the NEF. +- supports receiving the notifications of Update of DNAI Mapping Information from the NEF. + +#### 4.6.2 Service Operations + +##### 4.6.2.1 Introduction + +Service operations defined for the Nnef\_DNAIMapping Service are shown in table 4.6.2.1-1. + +**Table 4.6.2.1-1: Nnef\_DNAIMapping Service Operations** + +| Service Operation Name | Description | Initiated by | +|------------------------------|----------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Nnef_DNAIMapping_Subscribe | This service operation is used by an NF service consumer to explicitly subscribe the notification of DNAI Mapping Information. | NF service consumer | +| Nnef_DNAIMapping_Unsubscribe | This service operation is used by an NF service consumer to explicitly unsubscribe the notification of DNAI Mapping Information. | NF service consumer | +| Nnef_DNAIMapping_Notify | This service operation is used by the NEF to provide Update DNAI Mapping Information to the NF service consumer. | NEF | + +#### 4.6.2.2 Nnef\_DNAIMapping\_Subscribe service operation + +##### 4.6.2.2.1 General + +This service operation is provided by the NEF for the NF service consumers to explicitly subscribe the notification of DNAI Mapping Information. + +##### 4.6.2.2.2 Creating a new subscription for notification of DNAI Mapping Information + +Figure 4.6.2.2.2-1 illustrates the creation of a Individual DNAI Mapping Information Subscription. + +![Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to the NEF, and the NEF responds with a 201 Created status.](b560268ea8f6526970f23f0da225b099_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NEF + Note right of NF service consumer: 1. POST « /subscriptions » + NF service consumer->>NEF: Request + Note left of NEF: 2. "201 Created" + NEF-->>NF service consumer: Response + +``` + +Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to the NEF, and the NEF responds with a 201 Created status. + +**Figure 4.6.2.2.2-1: Creation of a subscription** + +In order to subscribe to DNAI Mapping Information, the NF service consumer shall send an Nnef\_DNAIMapping\_Subscribe request using the HTTP POST method to the NEF with "{apiRoot}/nnef-dnai-mapping//subscriptions" as request URI as shown in step 1 of figure 4.6.2.2.2-1. The HTTP POST message shall include DnaiMapSub data structure as request body. The contents of the DnaiMapSub data structure are as described in clause 4.4.34.2 of 3GPP TS 29.522 [15]. + +Upon receipt of the corresponding HTTP POST message, the NEF shall interact with the UDR by invoking the Nudr\_DataRepository service as described in 3GPP TS 29.504 [20], if the NEF receives an error response from the UDR, the NEF shall not create the resource and shall respond to the NF service consumer with a proper error status code. If the NEF received within an error response a "ProblemDetails" data structure with a "cause" attribute indicating an application error, the NEF shall relay this error response to the NF service consumer with a corresponding application error, when applicable. + +On successful DNAI Mapping subscription creation, the NEF shall return an HTTP POST response with an HTTP "201 Created" status code to the NF service consumer, including a "Location" header containing the URI of the created "Individual DNAI Mapping Subscription" resource and the response body containing a representation of the created resource within the DnaiMapSub data structure. The contents of the DnaiMapSub data structure in the response are as described for the subscription response in clause 4.4.34.2 of 3GPP TS 29.522 [15]. + +On failure, the NEF shall take proper error handling actions, as specified in clause 5.5.7, and respond to the NF service consumer with an appropriate error status code. + +#### 4.6.2.3 Nnef\_DNAIMapping\_Unsubscribe service operation + +##### 4.6.2.3.1 General + +This service operation is used by an NF service consumer (e.g. NWDAF) to explicitly unsubscribe the notification of DNAI Mapping information. + +The following procedure using the Nnef\_DNAIMapping\_Unsubscribe service operation is supported: + +- unsubscribe from the notification of DNAI Mapping information. + +##### 4.6.2.3.2 Unsubscription of notification of DNAI Mapping Information + +Figure 4.6.2.3.2-1 illustrates the unsubscription of event notifications from NEF. + +![Sequence diagram showing the unsubscription of event notifications from NEF. An NF service consumer sends a DELETE request to the NEF, and the NEF responds with a 204 No Content.](eb1a67ebd688e354edaacb7ec2abf5ad_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NEF + Note right of NF service consumer: 1. DELETE .. /subscriptions/{subscriptionId} + NF service consumer->>NEF: Request + Note left of NEF: 2. "204 No Content" + NEF-->>NF service consumer: Response +``` + +Sequence diagram showing the unsubscription of event notifications from NEF. An NF service consumer sends a DELETE request to the NEF, and the NEF responds with a 204 No Content. + +**Figure 4.6.2.3.2-1: NF service consumer unsubscribes from notifications** + +In order to delete an existing subscription to DNAI Mapping Information, the NF service consumer shall send an HTTP DELETE request message with "{apiRoot}/nnef-dnai-mapping/{apiVersion}/subscriptions/{subscriptionId}" as request URI, as shown in step 1 of figure 4.6.2.3.2-1, where "{subscriptionId}" is the subscription identifier of the existing subscription resource that is to be deleted. + +Upon successful reception of an HTTP DELETE, the NEF shall delete the individual resource and shall respond to the NF service consumer with an HTTP "204 No Content" response message, as shown in step 2 of figure 4.6.2.3.2-1. + +If the received HTTP DELETE request needs to be redirected, the NEF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +If errors occur when processing the HTTP DELETE request, the NEF shall send an HTTP error response as specified in clause 5.3.7. + +#### 4.6.2.4 Nnef\_DNAIMapping\_Notify service operation + +##### 4.6.2.4.1 General + +The Nnef\_DNAIMapping\_Notify service operation enables the NEF to notify the DNAI Mapping Information to the NF Consumer. + +The following procedure using the Nnef\_DNAIMapping\_Notify service operation is supported: + +- notification about subscribed DNAI Mapping Information. + +##### 4.6.2.4.2 Notification of changes of DNAI Mapping Information + +Figure 4.6.2.4.2-1 illustrates the notification about DNAI Mapping Information. + +![Sequence diagram showing notification about changes of DNAI Mapping Information between NEF and NF service consumer.](c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg) + +``` +sequenceDiagram + participant NEF + participant NF_service_consumer as NF service consumer + Note right of NEF: 1. POST {notifUri} + NEF->>NF_service_consumer: 1. POST {notifUri} + Note left of NF_service_consumer: 2. "204 No Content" + NF_service_consumer-->>NEF: 2. "204 No Content" +``` + +The diagram illustrates a sequence of interactions between the Network Exposure Function (NEF) and an NF service consumer. The NEF sends a POST request with the URI {notifUri} to the NF service consumer. The NF service consumer responds with a "204 No Content" status code. + +Sequence diagram showing notification about changes of DNAI Mapping Information between NEF and NF service consumer. + +**Figure 4.6.2.4.2-1: Notification about changes of DNAI Mapping Information** + +If the NEF observes DNAI Mapping Information that an NF service consumer has subscribed, the NEF shall send an HTTP POST request as shown in step 1 of figure 4.6.2.4.2-1, with the "{notifUri}" as request URI containing the value previously provided by the NF service consumer within the corresponding subscription, and the DnaiMapUpdateNotif data structure as request body. + +Upon successful reception of an HTTP POST request with "{notifUri}" as request URI and DnaiMapUpdateNotif data structure as request body, the NF service consumer shall send an HTTP "204 No Content" response, as shown in step 2 of figure 4.6.2.4.2-1. + +On failure, the NF service consumer shall take proper error handling actions, as specified in clause 5.5.7, and respond to the NEF with an appropriate error status code. + +## 4.7 Nnef\_UEId Service + +### 4.7.1 Service Description + +#### 4.7.1.1 Overview + +The Nnef\_UEId service is provided by the Network Exposure Function (NEF). This service allows the NF service consumer (e.g. V-NEF) providing the external UE identifier to fetch the internal UE identifier used for e.g. the V-NEF to fetch the SUPI from the H-NEF for the roaming UE under the roaming agreement with the roaming partner(s). + +#### 4.7.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. + +The Nnef\_UEId service is part of the Nnef service-based interface exhibited by the Network Exposure Function (NEF). + +Known consumer of the Nnef\_UEId service is: + +- Visited Network Exposure Function (V-NEF) + +![Figure 4.7.1.2-1: Reference Architecture for the Nnef_UEId Service; SBI representation](9252ccfbbe9e34cb108f0060f2b563f1_img.jpg) + +A diagram showing the SBI representation of the Nnef\_UEId Service. At the top is a rectangular box labeled 'H-NEF'. Inside this box is an oval labeled 'Nnef'. A vertical line extends downwards from the 'Nnef' oval to a rectangular box at the bottom labeled 'V-NEF'. To the right of this vertical line is the label 'UEId'. + +Figure 4.7.1.2-1: Reference Architecture for the Nnef\_UEId Service; SBI representation + +Figure 4.7.1.2-1: Reference Architecture for the Nnef\_UEId Service; SBI representation + +![Figure 4.7.1.2-2: Reference Architecture for the Nnef_UEId Service: reference point representation](e05122559f56af5699789b7118d8fe87_img.jpg) + +A diagram showing the reference point representation of the Nnef\_UEId Service. At the top is a rectangular box labeled 'H-NEF'. A vertical line extends downwards from this box to another rectangular box at the bottom labeled 'V-NEF'. In the middle of this vertical line is a small horizontal tick mark, representing a reference point. + +Figure 4.7.1.2-2: Reference Architecture for the Nnef\_UEId Service: reference point representation + +Figure 4.7.1.2-2: Reference Architecture for the Nnef\_UEId Service: reference point representation + +#### 4.7.1.3 Network Functions + +##### 4.7.1.3.1 Network Exposure Function (NEF) + +The Network Exposure Function (NEF) allows the NF service consumer (e.g. V-NEF) providing the external UE identifier to fetch the internal UE identifier from the H-NEF for the roaming UE under the roaming agreement with the roaming partner(s). + +##### 4.7.1.3.2 NF Service Consumers + +The known NF service consumers are as follows: + +The Visited Network Exposure Function (V-NEF): + +- providing the external UE identifier to fetch the internal UE identifier from the H-NEF for the roaming UE under the roaming agreement with the roaming partner(s). + +#### 4.7.2 Service Operations + +##### 4.7.2.1 Introduction + +Service operations defined for the Nnef\_UEId Service are shown in table 4.7.2.1-1. + +**Table 4.7.2.1-1: Nnef\_UEId Service Operations** + +| Service Operation Name | Description | Initiated by | +|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| Nnef_UEId_Get | This service operation is used by the V-NEF providing the external UE identifier to fetch the internal UE identifier from the H-NEF for the roaming UE under the roaming agreement with the roaming partner(s). | V-NEF | + +#### 4.7.2.2 Nnef\_UEId\_Fetch service operation + +##### 4.7.2.2.1 General + +The Nnef\_UEId\_Get service operation enables the V-NEF provisioning the external UE identifier to fetch the internal UE identifier from the H-NEF for roaming UE under the roaming agreement with the roaming partner(s). + +The following procedure using the Nnef\_UEId\_Get service operation is supported: + +- to fetch the internal UE identifier for the roaming UE. + +##### 4.7.2.2.2 Fetch internal UE ID for roaming UE + +Figure 4.6.2.2.2-1 illustrates the retrieval of internal UE ID for roaming UE. + +![Sequence diagram showing the interaction between an NF service consumer and an NEF to fetch the internal UE ID for a roaming UE. The consumer sends a POST request to the NEF, and the NEF responds with either a 200 OK or a 204 No Content.](ddd86d7df6cf14d68c0faf111c1e8fae_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NEF + Note right of NEF: 1. POST « fetch » + NEF->>NF service consumer: 2a. 200 OK or 2b. 204 No Content + +``` + +Sequence diagram showing the interaction between an NF service consumer and an NEF to fetch the internal UE ID for a roaming UE. The consumer sends a POST request to the NEF, and the NEF responds with either a 200 OK or a 204 No Content. + +**Figure 4.7.2.2.2-1: Fetch internal UE ID for roaming UE** + +In order to fetch the internal UE identifier for the roaming UE, the NF service consumer (e.g. V-NEF) shall send an HTTP POST request as shown in step 1 of figure 4.7.2.2.2-1 targeting the custom operation URI "{apiRoot}/nnef-ueid//fetch" to fetch the internal UE identifier according to the provided UeIdReq data type which shall include: + +external UE identification of an individual UE via a "gsi" attribute. + +When receiving the HTTP POST request message, the NEF shall verify the NF service consumer (e.g. V-NEF) whether belong to the roaming partner(s) under roaming agreement. + +On success, the NEF shall respond with "200 OK" status code with the message body containing the UeIdInfo data structure in the response body shall include: + +- internal UE identification of an individual UE via a "supi" attribute. + +If the requested internal UE identifier does not exist, the NEF shall respond with "204 No Content" status code. + +If the NEF cannot successfully fulfil the received HTTP POST request due to an internal error or an error in the HTTP POST request, the NEF shall send an HTTP error response as specified in clause 5.6.7. + +## 5 API Definitions + +### 5.1 Nnef\_EventExposure Service API + +#### 5.1.1 Introduction + +The Nnef\_EventExposure service shall use the Nnef\_EventExposure API. + +The API URI of the Nnef\_EventExposure API shall be: + +**{apiRoot}** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nnef-eventexposure". +- The shall be "v1". +- The shall be set as described in clause 5.1.3. + +#### 5.1.2 Usage of HTTP + +##### 5.1.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nnef\_EventExposure API is contained in Annex A. + +##### 5.1.2.2 HTTP standard headers + +###### 5.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +###### 5.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +##### 5.1.2.3 HTTP custom headers + +The Nnef\_EventExposure API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4]. + +In this Release of the specification, no specific custom headers are defined for the Nnef\_EventExposure API. + +## 5.1.3 Resources + +### 5.1.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 5.1.3.1-1 depicts the resource URIs structure for the Nnef\_EventExposure API. + +![Figure 5.1.3.1-1: Resource URI structure of the Nnef_EventExposure API. The diagram shows a hierarchical tree structure of URIs. The root is {apiRoot}/nnef-eventexposure/. It branches to /subscriptions, which in turn branches to /{subscriptionId}.](ff5f89b660edddb67971d7d3d4ce87ef_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nnef-eventexposure/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Figure 5.1.3.1-1: Resource URI structure of the Nnef\_EventExposure API. The diagram shows a hierarchical tree structure of URIs. The root is {apiRoot}/nnef-eventexposure/. It branches to /subscriptions, which in turn branches to /{subscriptionId}. + +**Figure 5.1.3.1-1: Resource URI structure of the Nnef\_EventExposure API** + +Table 5.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|------------------------------------------------|---------------------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Network Exposure Event Subscriptions | /subscriptions | POST | Creates a subscription to notifications on application or user related event(s), i.e. creation of an Individual Network Exposure Event Subscription resource. | +| Individual Network Exposure Event Subscription | /subscriptions/{subscriptionId} | GET | Reads an Individual Network Exposure Event Subscription resource. | +| | | PUT | Modifies an Individual Network Exposure Event Subscription. | +| | | DELETE | Cancels an individual subscription to notifications of subscribed event. | + +### 5.1.3.2 Resource: Network Exposure Event Subscriptions + +#### 5.1.3.2.1 Description + +The resource represents the collection of Network Exposure Event subscriptions of the Nnef\_EventExposure service. It allows NF service consumers to create a new subscription to notifications on application or user related event(s). + +#### 5.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnef-eventexposure//subscriptions + +This resource shall support the resource URI variables defined in table 5.1.3.2.2-1. + +**Table 5.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.1.1 | + +### 5.1.3.2.3 Resource Standard Methods + +#### 5.1.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.1.3.2.3.1-1. + +**Table 5.1.3.2.3.1-1: URI query parameters supported by the method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.1.3.2.3.1-2 and the response data structures and response codes specified in table 5.1.3.2.3.1-3. + +**Table 5.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------| +| NefEventExposureSubsc | M | 1 | Contains the information required for the creation of a new Individual Network Exposure Event Subscription resource. | + +**Table 5.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------|---------------------------------------------------------------------------------------------| +| NefEventExposureSubsc | M | 1 | 201
Created | Contains the representation of the Individual Network Exposure Event Subscription resource. | +| ProblemDetails | O | 0..1 | 403
Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: Failure cases are described in clause 5.1.7. + +**Table 5.1.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nnelf-eventexposure//subscriptions/{subscriptionId}. | + +### 5.1.3.3 Resource: Individual Network Exposure Event Subscription + +#### 5.1.3.3.1 Description + +The resource represents an individual Network Exposure Event subscription of the Nnef\_EventExposure service. It allows NF service consumers to read/modify/cancel a subscription to notifications on application or user related event(s). + +#### 5.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nnelf-eventexposure//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 5.1.3.3.2-1. + +**Table 5.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|--------------------------------------------------------------| +| apiRoot | string | See clause 5.1.1 | +| subscriptionId | string | Identifies a subscription to the NEF event exposure service. | + +### 5.1.3.3.3 Resource Standard Methods + +#### 5.1.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.1.3.3.3.1-1. + +**Table 5.1.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|----------------------------------------------------| +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer. | + +This method shall support the request data structures specified in table 5.1.3.3.3.1-2 and the response data structures and response codes specified in table 5.1.3.3.3.1-3. + +**Table 5.1.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.1.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------| +| NefEventExposureS
ubsc | M | 1 | 200 OK | Contains the representation of the Individual Network Exposure Event Subscription resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription retrieval. Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription retrieval. Applicable if the feature "ES3XX" is supported.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.1.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +**Table 5.1.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +#### 5.1.3.3.3.2 PUT + +This method shall support the URI query parameters specified in table 5.1.3.3.3.2-1. + +**Table 5.1.3.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.1.3.3.3.2-2 and the response data structures and response codes specified in table 5.1.3.3.3.2-3. + +**Table 5.1.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|--------------------------------------------------------------------------------| +| NefEventExposureSubsC | M | 1 | Modifies the existing Individual Network Exposure Event Subscription resource. | + +**Table 5.1.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| NefEventExposureSubsC | M | 1 | 200 OK | Successful case.
The Individual Network Exposure Event Subscription resource was modified and a representation is returned. | +| n/a | | | 204 No Content | Successful case.
The Individual Network Exposure Event Subscription resource was modified. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription modification.
Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription modification.
Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: Failure cases are described in clause 5.1.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.1.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +**Table 5.1.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +#### 5.1.3.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 5.1.3.3.3.3-1. + +**Table 5.1.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.1.3.3.3.3-2 and the response data structures and response codes specified in table 5.1.3.3.3.3-3. + +**Table 5.1.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.1.3.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The Individual Network Exposure Event Subscription resource matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription termination. Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription termination. Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.1.3.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +**Table 5.1.3.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +## 5.1.4 Custom Operations without associated resources + +None. + +## 5.1.5 Notifications + +### 5.1.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 5.1.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-------------------------------------|--------------|---------------------------------|---------------------------------------------| +| Network Exposure Event Notification | {notifUri} | POST | Provides Information about observed events. | + +### 5.1.5.2 Network Exposure Event Notification + +#### 5.1.5.2.1 Description + +The Network Exposure Event Notification is used by the NEF to report one or several observed Events to a NF service consumer that has subscribed to such Notifications. + +#### 5.1.5.2.2 Target URI + +The Notification URI "{notifUri}" shall be used with the callback URI variables defined in table 5.1.5.2.2-1. + +**Table 5.1.5.2.2-1: Callback URI variables for this resource** + +| Name | Data type | Definition | +|----------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | The Notification Uri as assigned by the NF service consumer during the subscription service operation and described within the NefEventExposureSubsc data type (see table 5.1.6.2.2-1). | + +### 5.1.5.2.3 Standard Methods + +#### 5.1.5.2.3.1 POST + +This method shall support the request data structures specified in table 5.1.5.2.3.1-1 and the response data structures and response codes specified in table 5.1.5.2.3.1-1. + +**Table 5.1.5.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|---------------------------------------------| +| NefEventExposureNotif | M | 1 | Provides Information about observed events. | + +**Table 5.1.5.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during event notification.
Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during event notification.
Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.1.5.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +**Table 5.1.5.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +## 5.1.6 Data Model + +### 5.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.1.6.1-1 specifies the data types defined for the Nnef\_EventExposure service based interface protocol. + +**Table 5.1.6.1-1: Nnef\_EventExposure specific Data Types** + +| Data type | Section defined | Description | Applicability | +|---------------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| GNSSAssistData | 5.1.6.3.2 | Represents GNSS Assistance Data. | GNSSAssistData | +| GNSSAssistDataInfo | 5.1.6.2.13 | Represents GNSS Assistance Data related information. | GNSSAssistData | +| GNSSServArea | 5.1.6.2.14 | Represents the serving area of the GNSS Assistance Data. | GNSSAssistData | +| NefEvent | 5.1.6.3.3 | Represents Network Exposure Events. | | +| NefEventExposureNotif | 5.1.6.2.3 | Represents notifications on network exposure event(s) that occurred for an Individual Network Exposure Event Subscription resource. | | +| NefEventExposureSubs
c | 5.1.6.2.2 | Represents an Individual Network Exposure Event Subscription resource. | | +| NefEventFilter | 5.1.6.2.7 | Represents event filter information for an event. | | +| NefEventNotification | 5.1.6.2.4 | Represents information related to an event to be reported. | | +| NefEventSubs | 5.1.6.2.5 | Represents an event to be subscribed and the related event filter information | | +| PerformanceDataInfo | 5.1.6.2.12 | Contains Performance Data Analytics related information collection | PerformanceData | +| ServiceExperienceInfo | 5.1.6.2.9 | Contains service experience information associated with an application. | ServiceExperience | +| TargetUeIdentification | 5.1.6.2.8 | Identifies the UE to which the request applies. | | +| UeCommunicationInfo | 5.1.6.2.6 | Contains UE communication information associated with an application. | UeCommunication | +| UeMobilityInfo | 5.1.6.2.10 | Contains UE mobility information associated with an application. | UeMobility | +| UeTrajectoryInfo | 5.1.6.2.11 | Contains UE trajectory information. | UeMobility | + +Table 5.1.6.1-2 specifies data types re-used by the Nnef\_EventExposure service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nnef\_EventExposure service based interface. + +**Table 5.1.6.1-2: Nnef\_EventExposure re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------------------------|---------------------|--------------------------------------------------------------------------------------------------------|----------------------| +| AddrFqdn | 3GPP TS 29.517 [18] | IP address and/or FQDN. | | +| ApplicationId | 3GPP TS 29.571 [16] | Application identifier | | +| CollectiveBehaviourFilter | 3GPP TS 29.517 [18] | Contains the parameter type and value pair to express the collective behaviour event filters. | CollectiveBehaviour | +| CollectiveBehaviourInfo | 3GPP TS 29.517 [18] | Contains the collective behaviour analytics information. | CollectiveBehaviour | +| CommunicationCollection | 3GPP TS 29.517 [18] | Contains communication information. | UeCommunication | +| ConsumptionReportingUnitsCollection | 3GPP TS 26.512 [30] | Represents the Media Streaming Consumption. | MSEventExposure | +| DateTime | 3GPP TS 29.571 [16] | Contains a date and a time. | | +| DatVolTransTimeCollection | 3GPP TS 29.517 [18] | Contains data volume transfer time information. | DataVolTransferTime | +| Dnai | 3GPP TS 29.571 [16] | | | +| DispersionCollection | 3GPP TS 29.517 [18] | Contains dispersion collection information. | Dispersion | +| DurationSec | 3GPP TS 29.571 [16] | Indicates a period of time in units of seconds. | DataVolTransferTime | +| DynamicPolicyInvocationsCollection | 3GPP TS 26.512 [30] | Represents the Media Streaming Dynamic Policy invocation. | MSEventExposure | +| ExceptionInfo | 3GPP TS 29.517 [18] | Represents exception information for a service flow. | Exceptions | +| GeographicArea | 3GPP TS 29.572 [28] | Represents a geographic area. | | +| GeographicalCoordinates | 3GPP TS 29.572 [28] | Represents geographical coordinates. | | +| GroupId | 3GPP TS 29.571 [16] | Contains a Group identifier. | | +| IpAddr | 3GPP TS 29.571 [16] | Identifies the IP address of a UE. | PerformanceData | +| MediaStreamingAccessesCollection | 3GPP TS 26.512 [30] | Represents the Media Streaming access. | MSEventExposure | +| MSAccessActivityCollection | 3GPP TS 29.517 [18] | Represents the Media Streaming access activity of UE Application collected via Data Collection AF. | MSAccessActivity | +| MsConsumptionCollection | 3GPP TS 29.517 [18] | Represents the Media Streaming Consumption reports of UE Application collected via Data Collection AF. | MSConsumption | + +| | | | | +|----------------------------------------|---------------------|------------------------------------------------------------------------------------------------------------------|--------------------------| +| MsDynPolicyInvocationCollection | 3GPP TS 29.517 [18] | Represents the Media Streaming Dynamic Policy Invocation of UE Application collected via Data Collection AF. | MSDynPolicyInvocation | +| MsQoeMetricsCollection | 3GPP TS 29.517 [18] | Represents the Media Streaming QoE Metrics of UE Application collected via Data Collection AF. | MSQoeMetrics | +| MsNetAssInvocationCollection | 3GPP TS 29.517 [18] | Represents the Media Streaming Network Assistance invocation of UE Application collected via Data Collection AF. | MSNetAssInvocation | +| NetworkAreaInfo | 3GPP TS 29.554 [21] | Represents a network area information. | | +| NetworkAssistanceInvocationsCollection | 3GPP TS 26.512 [30] | Represents the Media Streaming Network Assistance invocation. | MSEventExposure | +| PacketDelBudget | 3GPP TS 29.571 [16] | Indicates average Packet Delay. | PerformanceData | +| PacketLossRate | 3GPP TS 29.571 [16] | Indicates average Loss Rate. | PerformanceData | +| PerformanceData | 3GPP TS 29.517 [18] | Contains Performance Data | PerformanceData | +| QoEMetricsCollection | 3GPP TS 26.512 [30] | Represents the Media Streaming QoE metrics. | MSEventExposure | +| RedirectResponse | 3GPP TS 29.571 [16] | Contains redirection related information. | ES3XX | +| ReportingInformation | 3GPP TS 29.523 [22] | Represents the type of reporting the subscription requires. | | +| Supi | 3GPP TS 29.571 [16] | Contains a SUPI. | | +| SupportedFeatures | 3GPP TS 29.571 [16] | Indicates the features supported. | | +| ServiceExperienceInfoPerFlow | 3GPP TS 29.517 [18] | Contains service experience information associated with a service flow. | ServiceExperience | +| Tai | 3GPP TS 29.571 [16] | Represents the identifier of a tracking area. | | +| Uinteger | 3GPP TS 29.571 [16] | Unsigned integer. | ServiceExperienceExt_eNA | +| UserDataCongestionCollection | 3GPP TS 29.517 [18] | Contains User Data Congestion Analytics related information collection. | UserDataCongestion | +| UserLocation | 3GPP TS 29.571 [16] | Contains user location information. | UeMobility | +| Uri | 3GPP TS 29.571 [16] | Contains a URI. | | +| Volume | 3GPP TS 29.122 [29] | Unsigned integer identifying a volume in units of | DataVolTransferTime | + +| | | | | +|--|--|--------|--| +| | | bytes. | | +|--|--|--------|--| + +## 5.1.6.2 Structured data types + +### 5.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 5.1.6.2.2 Type: NefEventExposureSubsc + +**Table 5.1.6.2.2-1: Definition of type NefEventExposureSubsc** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| dataAccProfileId | string | O | 0..1 | Represents a unique identifier for the Data Access Profile. | DataAccProfileId | +| eventsSubs | array(NefEventSubs) | M | 1..N | Subscribed events and the related event filters. | | +| eventsReplInfo | ReportingInformation | O | 0..1 | Represents the reporting requirements of the subscription. If omitted, the default values within the ReportingInformation data type apply. (NOTE 2) | | +| notifUri | Uri | M | 1 | Notification URI for event reporting. | | +| eventNotifs | array(NefEventNotification) | C | 1..N | Represents the Events to be reported. Shall only be present if the immediate reporting indication in the "immRep" attribute within the "eventsReplInfo" attribute sets to true in the event subscription, and the reports are available. | | +| notifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 5.8. Shall be present in the HTTP POST request/response; or in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. (NOTE 1) | | + +NOTE 1: In the HTTP POST request it represents the set of NF service consumer supported features. In the HTTP POST and GET responses it represents the set of features supported by both the NF service consumer and the NEF. + +NOTE 2: The "eventsReplInfo" attribute may include muting instructions within the "notifFlagInstruct" attribute and/or muting notifications settings within the "mutingSetting" attribute only if the EnhDataMgmt feature is supported. + +### 5.1.6.2.3 Type: NefEventExposureNotif + +**Table 5.1.6.2.3-1: Definition of type NefEventExposureNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------|---------------| +| notifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | +| eventNotifs | array(NefEventNotification) | M | 1..N | Represents the Events to be reported according to the subscription corresponding to the Notification Correlation ID. | | + +## 5.1.6.2.4 Type: NefEventNotification + +Table 5.1.6.2.4-1: Definition of type NefEventNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| event | NefEvent | M | 1 | Represents the reported application related event. | | +| timeStamp | DateTime | M | 1 | Time at which the event is observed. | | +| svcExprcInfos | array(ServiceExperienceInfo) | C | 1..N | Contains the service experience information.
Shall be present if the "event" attribute sets to "SVC_EXPERIENCE" | ServiceExperience | +| ueMobilityInfos | array(UeMobilityInfo) | C | 1..N | Contains the UE mobility information.
Shall be present if the "event" attribute sets to "UE_MOBILITY" | UeMobility | +| ueCommInfos | array(UeCommunicationInfo) | C | 1..N | Contains the application communication information.
Shall be present if the "event" attribute sets to "UE_COMM" | UeCommunication | +| excepInfos | array(ExceptionInfo) | C | 1..N | Each element represents the exception information for a service flow.
Shall be present if the "event" attribute sets to "EXCEPTIONS". | Exceptions | +| congestionInfos | array(UserDataCongestionCollection) | C | 1..N | Each element represents the user data congestion information for an AF application.
Shall be present if the "event" attribute sets to "USER_DATA_CONGESTION". | UserDataCongestion | +| perfDataInfos | array(PerformanceDataInfo) | C | 1..N | Each element represents the performance data information collected for an AF application. | PerformanceData | +| dispersionInfos | array(DispersionCollection) | C | 1..N | Each element represents the UE dispersion information collected for an AF.

Shall be present if the "event" attribute sets to "DISPERSION". | Dispersion | +| collBhvrInfos | array(CollectiveBehaviourInfo) | C | 1..N | Each element represents the collective behaviour information related to a set of UEs, applications. Shall be present if the "event" attribute sets to "COLLECTIVE_BEHAVIOUR". | CollectiveBehaviour | +| msQoeMetrInfos | array(MsQoeMetricsCollection) | C | 1..N | Each element represents the Media Streaming QoE metrics information collected for an UE application via the Data Collection AF.
Shall be present if the "event" attribute sets to "MS_QOE_METRICS".

This attribute is deprecated; the attribute "msQoeMetrics" should be used instead. | MSQoeMetrics | +| msQoeMetrics | array(QoEMetricsCollection) | C | 1..N | Each element represents the Media Streaming QoE metrics event notification.
Shall be present if the "event" | MSEventExposure | + +| | | | | | | +|-----------------------|----------------------------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| | | | | attribute sets to "MS_QOE_METRICS".

This attribute deprecates "msQoeMetrInfos" attribute. | | +| msConsumpInfos | array(MsConsumptionCollection) | C | 1..N | Each element represents the Media Streaming Consumption reports information collected for an UE application via the Data Collection AF.
Shall be present if the "event" attribute sets to "MS_CONSUMPTION".

This attribute is deprecated; the attribute "msConsumpReports" should be used instead. | MSConsumption | +| msConsumpReports | array(ConsumptionReportingUnits Collection) | C | 1..N | Each element represents the Media Streaming Consumption event notification.
Shall be present if the "event" attribute sets to "MS_CONSUMPTION".

This attribute deprecates "msConsumpInfos" attribute. | MSEventExposure | +| msNetAssInvInfos | array(MsNetAssInvocationCollection) | C | 1..N | Each element represents the Media Streaming Network Assistance invocation information collected for an UE application via the Data Collection AF.
Shall be present if the "event" attribute sets to "MS_NET_ASSIST_INVOCATION".

This attribute is deprecated; the attribute "msNetAssistInvocation" should be used instead. | MSNetAssInvocation | +| msNetAssistInvocation | array(NetworkAssistanceInvocationCollection) | C | 1..N | Each element represents the Media Streaming Network Assistance invocation event notification.
Shall be present if the "event" attribute sets to "NET_ASSIST_INVOCATION".

This attribute deprecates "msNetAssInvInfos" attribute. | MSEventExposure | +| msDynPlyInvInfos | array(MsDynPolicyInvocationCollection) | C | 1..N | Each element represents the Media Streaming Dynamic Policy Invocation information collected for an UE application via the Data Collection AF.
Shall be present if the "event" attribute sets to "MS_DYN_POLICY_INVOCATION".

This attribute is deprecated; the attribute "msDynPlyInvocation" should be used instead. | MSDynPolicyInvocation | +| msDynPlyInvocation | array(DynamicPolicyInvocationsCollection) | C | 1..N | Each element represents the Media Streaming Dynamic Policy invocation event notification.
Shall be present if the "event" attribute sets to "MS_DYN_POLICY_INVOCATION". | MSEventExposure | + +| | | | | | | +|----------------------|-----------------------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| | | | | N".

This attribute deprecates "msDynPlyInvInfos" attribute. | | +| msAccActInfos | array(MSAccessActivityCollection) | C | 1..N | Each element represents the Media Streaming access activity collected for an UE application via the Data Collection AF. Shall be present if the "event" attribute sets to "MS_ACCESS_ACTIVITY".

This attribute is deprecated; the attribute "msAccess" should be used instead. | MSAccessActivity | +| msAccess | array(MediaStreamingAccessesCollection) | C | 1..N | Each element represents the Media Streaming access event notification. Shall be present if the "event" attribute sets to "MS_ACCESS_ACTIVITY".

This attribute deprecates "msAccActInfos" attribute. | MSEventExposure | +| gnssAssistDataInfo | GNSSAssistDataInfo | C | 0..1 | Represents the GNSS Assistance data information.

This attribute shall be present only if the "event" attribute is set to "GNSS_ASSISTANCE_DATA". | GNSSAssistData | +| datVolTransTimeInfos | array(DatVolTransTimeCollection) | C | 1..N | Each element represents the data volume transfer time information related to an UE. The "gps" attribute within the DatVolTransTimeCollection data type is not applicable.

This attribute shall be present if the "event" attribute sets to "DATA_VOLUME_TRANSFER_TIME". | DataVolTransferTime | + +## 5.1.6.2.5 Type NefEventSubs + +Table 5.1.6.2.5-1: Definition of type NefEventSubs + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| event | NefEvent | M | 1 | Subscribed event. | | +| eventFilter | NefEventFilter | C | 0..1 | Represents the event filter information associated with each event.
Shall be present if "event" sets to "SVC_EXPERIENCE", "UE_MOBILITY", "UE_COMM", "EXCEPTIONS", "USER_DATA_CONGESTION", "PERF_DATA", "COLLECTIVE_BEHAVIOUR", "DISPERSION", "MS_QOE_METRICS", "MS_CONSUMPTION", "MS_NET_ASSIST_INVOCATION", "MS_DYN_POLICY_INVOCATION", "MS_ACCESS_ACTIVITY" or "E2E_DATA_VOL_TRANS_TIME". | ServiceExperience
UeCommunication
UeMobility
Exceptions
UserDataCongestion
PerformanceData
Dispersion
CollectiveBehaviour
MSQoeMetrics
MSConsumption
MSNetAssInvocation
MSDynPolicyInvocation
MSAccessActivity
DataVolTransferTime | + +## 5.1.6.2.6 Type UeCommunicationInfo + +Table 5.1.6.2.6-1: Definition of type UeCommunicationInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------|---|-------------|--------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | Identifies an UE.
Shall be present if the event exposure request applies to more than one UE. | | +| interGroupId | GroupId | O | 0..1 | Identifies an UE group. | | +| appId | ApplicationId | O | 0..1 | Identifies an application identifier. | | +| comms | array(CommunicationCollection) | M | 1..N | This attribute contains a list of communication information. | | + +## 5.1.6.2.7 Type NefEventFilter + +Table 5.1.6.2.7-1: Definition of type NefEventFilter + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| tgtUe | TargetUeIdentification | M | 1 | Represents the UE information to which the request applies. | (NOTE 1) | +| appIds | array(ApplicationId) | C | 1..N | Each element indicates an application identifier.
If absent, the NefEventFilter data applies to any application (i.e. all applications).
(NOTE 2) | ServiceExperience
Exceptions
UeCommunication
UeMobility
UserDataCongestion
PerformanceData
Dispersion
CollectiveBehaviour
MSQoeMetrics
MSConsumption
MSNetAssInvocation
MSDynPolicyInvocation
MSAccessActivity
DataVolTransferTime | +| locArea | NetworkAreaInfo | O | 0..1 | Represents an area of interest.
(NOTE 3) | ServiceExperience
Exceptions
UeCommunication
UeMobility
UserDataCongestion
Dispersion
CollectiveBehaviour
MSQoeMetrics
MSConsumption
MSNetAssInvocation
MSDynPolicyInvocation
MSAccessActivity
DataVolTransferTime | +| collAttrs | array(CollectiveBehaviourFilter) | O | 1..N | Each element indicates a collective attribute parameter type and value. (NOTE 4) | CollectiveBehaviour | + +NOTE 1: Applicability is further described in the corresponding data type. +NOTE 2: For the events "EXCEPTIONS", "UE\_MOBILITY", "UE\_COMM", and "PERF\_DATA", if present, the "appIds" attribute shall include only one element. +NOTE 3: For event "SVC\_EXPERIENCE", only the "tais" attribute within the NetworkAreaInfo data is applicable. +NOTE 4: The attributes "collBehAttr" and "dataProcType" within this attribute may be used to indicate values of collective behaviour attributes to be matched only if the feature "ExtEventFilters" is supported. + +## 5.1.6.2.8 Type TargetUeIdentification + +Table 5.1.6.2.8-1: Definition of type TargetUeIdentification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supis | array(Supi) | O | 1..N | Each element identifies a SUPI for an UE. | ServiceExperience
Exceptions
UeMobility
UeCommunication
UserDataCongestion
Dispersion
MSQoeMetrics
MSConsumption
MSNetAssInvocation
MSDynPolicyInvocation
MSAccessActivity
DataVolTransferTime | +| interGroupIds | array(GroupId) | O | 1..N | Each element represents an internal group identifier which identifies a group of UEs. | ServiceExperience
Exceptions
UeMobility
UeCommunication
MSQoeMetrics
MSConsumption
MSNetAssInvocation
MSDynPolicyInvocation
MSAccessActivity | +| anyUeId | boolean | O | 0..1 | Identifies whether the request applies to any UE.
This attribute shall set to "true" if applicable for any UE, otherwise, set to "false". | ServiceExperience
Exceptions
UserDataCongestion | +| ueIpAddr | IpAddr | O | 0..1 | Identifies the UE IP address. | EnPerformanceData | + +NOTE: For an applicable feature, only one attribute identifying the target UE shall be provided. + +## 5.1.6.2.9 Type: ServiceExperienceInfo + +Table 5.1.6.2.9-1: Definition of type ServiceExperienceInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| appId | ApplicationId | C | 0..1 | Identifies an application identifier. Shall be present if the event exposure service request applies to more than one application. | ServiceExperience | +| supis | array(Supi) | C | 1..N | Each element represents the internal UE identifier. | ServiceExperience | +| svcExpPerFlows | array(ServiceExperienceInfoPerFlow) | M | 1..N | Each element indicates service experience for each service flow. | ServiceExperience | +| contrWeights | array(UInteger) | C | 1..N | Indicates the Service Experience Contribution Weights of a list of UEs in the same sequence as in the presented gpsi or supis list of UEs. The weights indicate the relative importance among the elements of this array. The higher the number, the higher the importance. | ServiceExperienceExt_eNA | + +## 5.1.6.2.10 Type: UeMobilityInfo + +Table 5.1.6.2.10-1: Definition of type UeMobilityInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------|---|-------------|--------------------------------------------------------------------------------------------------|--------------------| +| supi | Supi | M | 1 | Identifies an UE.
Shall be present if the event exposure request applies to more than one UE. | | +| appId | ApplicationId | O | 0..1 | Identifies an application identifier.
(NOTE) | | +| ueTrajs | array(UeTrajectoryInfo) | M | 1..N | Identifies an UE moving trajectory. | | +| areas | array(NetworkAreaInfo) | O | 1..N | Indicates a list of areas used by the AF for the application service. | UeMobilityExt_AIML | + +NOTE: If the "appId" attribute is not present, then indicates the collected UE mobility information is applicable to all the applications for the UE. + +## 5.1.6.2.11 Type: UeTrajectoryInfo + +Table 5.1.6.2.11-1: Definition of type UeTrajectoryInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|--------------------------------------------------------|---------------| +| ts | DateTime | M | 1 | Identifies the timestamp when the UE enters this area. | | +| location | UserLocation | M | 1 | Includes the location of the UE.
(NOTE) | | + +NOTE: Only EutraLocation data and/or NrLocation data in UserLocation data are applicable to the property. + +## 5.1.6.2.12 Type: PerformanceDataInfo + +Table 5.1.6.2.12-1: Definition of type PerformanceDataInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------|---|-------------|-----------------------------------------------------------------------|---------------| +| appId | ApplicationId | O | 0..1 | Indicates an application identifier. | | +| uelpAddr | IpAddr | O | 0..1 | Identifies the IP address of a UE. | | +| ipTrafficFilter | FlowInfo | O | 0..1 | Identifies IP packet filter. | | +| userLoc | UserLocation | O | 0..1 | Represents the user location. | | +| appLocs | array(Dnai) | O | 1..N | Represents the application locations. | | +| asAddr | AddrFqdn | O | 0..1 | Represents the IP address or FQDN of the Application Server. (NOTE 1) | | +| perfData | PerformanceData | M | 1 | Indicates the performance data.
(NOTE 2) | | +| timeStamp | DateTime | M | 1 | It defines the timestamp of analytics generation. | | + +NOTE 1: If the "asAddr" attribute is included, either the "ipAddr" attribute or the "fqdn" attribute in the AddrFqdn data type shall be provided. + +NOTE 2: If the feature "PerformanceDataExt\_AIML" is supported, the attribute "perfData" indicates the UL/DL performance data. The "pdbDI", "maxPdbUI", "maxPdbDI", "plrDI", "maxPlrUI", "maxPlrDI", "maxThrputUI", "minThrputUI", "maxThrputDI" and "minThrputDI" attribute(s) within the PerformanceData data type is applicable only if the "PerformanceDataExt\_AIML" feature is supported. + +## 5.1.6.2.13 Type GNSSAssistDataInfo + +Table 5.1.6.2.13-1: Definition of type GNSSAssistDataInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------|---------------| +| gnssAssistData | GNSSAssistData | M | 1 | Contains the GNSS Assistance Data. | | +| servArea | GNSSServArea | M | 1 | Contains the serving area of the provided GNSS Assistance Data. | | +| sourceInfo | GeographicalCoordinates | O | 0..1 | Contains the global geographical coordinates of the source of the GNSS assistance data provided within the "gnssAssistData" attribute. | | + +## 5.1.6.2.14 Void 5.1.6.2.15 Type GNSSServArea + +Table 5.1.6.2.14-1: Definition of type GNSSServArea + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|----------------|---|-------------|-------------------------------------------------------------------------------------|---------------| +| geographicalArea | GeographicArea | C | 0..1 | Contains the GNSS Service Area in the form of a geographical area.
(NOTE) | | +| tailList | array(Tai) | C | 1..N | Contains the GNSS Service Area in the form of a list of tracking area(s).
(NOTE) | | + +NOTE: These attributes are mutually exclusive. Either one of them shall be provided. + +## 5.1.6.3 Simple data types and enumerations + +## 5.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 5.1.6.3.2 Simple data types + +The simple data types defined in table 5.1.6.3.2-1 shall be supported. + +Table 5.1.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|----------------|-----------------|------------------------------------------------------------------------------------------------|----------------| +| GNSSAssistData | string | Represents GNSS Assistance Data encoded as specified in clause 6.5.2.1 of 3GPP TS 37.355 [31]. | GNSSAssistData | + +## 5.1.6.3.3 Enumeration: NefEvent + +The enumeration NefEvent represents the subscribed/notified event to be monitored. It shall comply with the provisions defined in table 5.1.6.3.3-1. + +**Table 5.1.6.3.3-1: Enumeration NefEvent** + +| Enumeration value | Description | Applicability | +|---------------------------|-----------------------------------------------------------------------------------------------------|-----------------------| +| SVC_EXPERIENCE | Indicates that the subscribed/notified event is service experience information. | ServiceExperience | +| UE_COMM | Indicates that the subscribed/notified event is UE communication information. | UeCommunication | +| UE_MOBILITY | Indicates that the subscribed/notified event is UE mobility information. | UeMobility | +| EXCEPTIONS | Indicates that the subscribed/notified event is exceptions information. | Exceptions | +| USER_DATA_CONGESTION | Indicates that the subscribed/notified event is user data congestion analytics related information. | UserDataCongestion | +| PERF_DATA | Indicates that the subscribed/notified event is performance data information. | PerformanceData | +| DISPERSION | Indicates that the event subscribed is dispersion information. | Dispersion | +| COLLECTIVE_BEHAVIOUR | Indicates that the subscribed/notified event is collective behaviour information. | CollectiveBehaviour | +| MS_QOE_METRICS | Indicates that the subscribed/notified event is Media Streaming QoE metrics. | MSQoeMetrics | +| MS_CONSUMPTION | Indicates that the subscribed/notified event is Media Streaming Consumption reports. | MSConsumption | +| MS_NET_ASSIST_INVOCATION | Indicates that the subscribed/notified event is Media Streaming Network Assistance invocation. | MSNetAssInvocation | +| MS_DYN_POLICY_INVOCATION | Indicates that the subscribed/notified event is Media Streaming Dynamic Policy invocation. | MSDynPolicyInvocation | +| MS_ACCESS_ACTIVITY | Indicates that the subscribed/notified event is Media Streaming access activity. | MSAccessActivity | +| GNSS_ASSISTANCE_DATA | Indicates that the subscribed/notified event is GNSS Assistance Data Collection. | GNSSAssistData | +| DATA_VOLUME_TRANSFER_TIME | Indicates that the event subscribed is data volume transfer time information. | DataVolTransferTime | + +## 5.1.7 Error Handling + +### 5.1.7.1 General + +For the Nnef\_EventExposure API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nnef\_EventExposure API. + +### 5.1.7.2 Protocol Errors + +No specific procedures for the Nnef\_EventExposure service are specified. + +### 5.1.7.3 Application Errors + +The application errors defined for the Nnef\_EventExposure service are listed in Table 5.1.7.3-1. + +**Table 5.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------|------------------|------------------------------------------------------------------------------------------------| +| MUTING_INSTR_NOT_ACCEPTED | 403 Forbidden | Indicates that the muting instructions received by the NF service consumer cannot be accepted. | + +## 5.1.8 Feature negotiation + +The optional features in table 5.1.8-1 are defined for the Nnef\_EventExposure API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 5.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ServiceExperience | This feature indicates support for the "SVC_EXPERIENCE" event. | +| 2 | UeMobility | This feature indicates support for the "UE_MOBILITY" event. | +| 3 | UeCommunication | This feature indicates support for the "UE_COMM" event. | +| 4 | Exceptions | This feature indicates support for the "EXCEPTIONS" event. | +| 5 | ES3XX | Extended Support for 3xx redirections. This feature indicates the support of redirection for any service operation, according to Stateless NF procedures as specified in clauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [4] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. | +| 6 | EneNA | This feature indicates support for the enhancements of network data analytics requirements. | +| 7 | UserDataCongestion | This feature indicates support for the event related to User Data Congestion Analytics related information. | +| 8 | PerformanceData | This feature indicates support for the event related to performance data information. | +| 9 | Dispersion | This feature indicates support for the event related to Dispersion Analytics related information. | +| 10 | CollectiveBehaviour | This feature indicates support of collective behaviour information associated with the UEs and its applications. | +| 11 | MSQoeMetrics | This feature indicates support for the event related to Media Streaming QoE metrics for UE Application collected via the Data Collection AF. | +| 12 | MSConsumption | This feature indicates support for the event related to Media Streaming Consumption reports for UE Application collected via the Data Collection AF. | +| 13 | MSNetAssInvocation | This feature indicates support for the event related to Media Streaming Network Assistance invocation for UE Application collected via the Data Collection AF. | +| 14 | MSDynPolicyInvocation | This feature indicates support for the event related to Media Streaming Dynamic Policy invocation for UE Application collected via the Data Collection AF. | +| 15 | MSAccessActivity | This feature indicates support for the event related to Media Streaming access activity for UE Application collected via the Data Collection AF. | +| 16 | DataAccProfileId | This feature indicates support for Data Access Profile Identifier. | +| 17 | GNSSAssistData |

This feature indicates the support of the GNSS Assistance Data Collection functionality as part of the enhancements to the 5G LCS functionality.

The following functionalities are supported:
- GNSS Assistance Data Collection.

| + +| | | | +|----|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 18 | UeMobility_Ext | This feature indicates support for further extensions to the event related to UE mobility supporting AI/ML including support of list of application service area collection. Supporting this feature also requires the support of feature UeMobility. | +| 19 | PerformanceDataExt_AI/ML | This feature indicates the support for the extensions of the analytics related to DN performance supporting AI/ML, including support of Max/Min UL/DL data collection on packet delay, pack loss and throughput. Supporting this feature also requires the support of feature PerformanceData. | +| 20 | ServiceExperienceExt_eNA | This feature indicates support for the extensions to service experience supporting eNA, including Service Experience Contribution Weights. Supporting this feature also requires the support of feature ServiceExperience. | +| 21 | EnPerformanceData | This feature indicates support for the enhancements of performance data. It requires the support of the PerformanceData feature. | +| 22 | EnhDataMgmt | Indicates the support of enhanced data management mechanisms. Supporting this feature also requires the support of feature EneNA. | +| 23 | ExtEventFilters | Indicates supported of extended AF event filters. | +| 24 | DataVolTransferTime | This feature indicates support for the event related to data volume transfer time. | +| 25 | MSEventExposure | This feature indicates the support for Media Streaming event exposure.

This feature is recommended to be implemented to avoid the usage of the deprecated attributes. | + +## 5.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nnef\_EventExposure API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nnef\_EventExposure API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nnef\_EventExposure service. + +The Nnef\_EventExposure API defines a single scope "nnef-eventexposure" for the entire service, and it does not define any additional scopes at resource or operation level. + +## 5.2 Nnef\_EASDeployment Service API + +### 5.2.1 Introduction + +The Nnef\_EASDeployment service shall use the Nnef\_EASDeployment API. + +The API URI of the Nnef\_EASDeployment API shall be: + +**{apiRoot}** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nnef-eas-deployment". + +- The shall be "v1". +- The shall be set as described in clause 5.2.3. + +## 5.2.2 Usage of HTTP + +### 5.2.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nnef\_EASDeployment API is contained in Annex 3. + +### 5.2.2.2 HTTP standard headers + +#### 5.2.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +#### 5.2.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +### 5.2.2.3 HTTP custom headers + +The Nnef\_EASDeployment API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4]. + +In this Release of the specification, no specific custom headers are defined for the Nnef\_EASDeployment API. + +## 5.2.3 Resources + +### 5.2.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 5.2.3.1-1 depicts the resource URIs structure for the Nnef\_EASDeployment API. + +![Diagram showing the hierarchical structure of Resource URIs for the Nnef_EASDeployment API. The root URI is {apiRoot}/nnef-eas-deployment/. It branches to /subscriptions, which in turn branches to /{subscriptionId}.](d80af870e68195471418acd013389576_img.jpg) + +``` +graph TD; Root["{apiRoot}/nnef-eas-deployment/"] --> Subscriptions["/subscriptions"]; Subscriptions --> SubscriptionId["/{subscriptionId}"]; +``` + +Diagram showing the hierarchical structure of Resource URIs for the Nnef\_EASDeployment API. The root URI is {apiRoot}/nnef-eas-deployment/. It branches to /subscriptions, which in turn branches to /{subscriptionId}. + +**Figure 5.2.3.1-1: Resource URI structure of the Nnef\_EASDeployment API** + +Table 5.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.2.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------------------------|---------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EAS Deployment Event Subscriptions | /subscriptions | POST | Creates a subscription to notifications of changes of EAS Deployment Information, i.e. creation of an Individual EAS Deployment Event Subscription resource. | +| Individual EAS Deployment Event Subscription | /subscriptions/{subscriptionId} | GET | Reads an Individual EAS Deployment Event Subscription resource. | +| | | DELETE | Cancels an individual subscription to notifications of subscribed EAS Deployment changes event. | + +## 5.2.3.2 Resource: EAS Deployment Event Subscriptions + +### 5.2.3.2.1 Description + +The resource represents the collection of EAS Deployment changes Event subscriptions of the Nnef\_EASDeployment service. It allows NF service consumers to create a new subscription to notifications on EAS Deployment changes event(s). + +### 5.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnelf-eas-deployment//subscriptions + +This resource shall support the resource URI variables defined in table 5.2.3.2.2-1. + +**Table 5.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.2.1 | + +### 5.2.3.2.3 Resource Standard Methods + +#### 5.2.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.2.3.2.3.1-1. + +**Table 5.2.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.2.3.2.3.1-2 and the response data structures and response codes specified in table 5.2.3.2.3.1-3. + +**Table 5.2.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------| +| EasDeploySubData | M | 1 | Contains the information required for the creation of a new Individual EAS Deployment Event Subscription resource. | + +**Table 5.2.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response Codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------| +| EasDeploySubData | M | 1 | 201
Created | Contains the representation of the Individual EAS Deployment Event Subscription resource. | +| NOTE: The mandatory HTTP error status code for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +**Table 5.2.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nnef-eas-deployment//subscriptions/{subscriptionId}. | + +## 5.2.3.3 Resource: Individual EAS Deployment Event Subscription + +### 5.2.3.3.1 Description + +The resource represents an individual EAS Deployment Event subscription of the Nnef\_EASDeployment service. It allows NF service consumers to subscribe/unsubscribe an EAS Deployment information change event, and allows the NEF to notify EAS Deployment change event to the subscribed NF service consumer. + +### 5.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nnef-eas-deployment//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 5.2.3.3.2-1. + +**Table 5.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|--------------------------------------------------------------| +| apiRoot | string | See clause 5.2.1 | +| subscriptionId | string | Identifies a subscription to the NEF event exposure service. | + +### 5.2.3.3.3 Resource Standard Methods + +#### 5.2.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.3.3.3.1-1. + +**Table 5.2.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +This method shall support the request data structures specified in table 5.2.3.3.3.1-2 and the response data structures and response codes specified in table 5.2.3.3.3.1-3. + +**Table 5.2.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------| +| EasDeploySubData | M | 1 | 200 OK | Contains the representation of the Individual EAS Deployment information changes Event Subscription resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription retrieval.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription retrieval.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.2.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +**Table 5.2.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +#### 5.2.3.3.3.2 PUT + +This HTTP method is not supported for the resource. + +#### 5.2.3.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 5.2.3.3.3.3-1. + +**Table 5.2.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.3.3.3.3-2 and the response data structures and response codes specified in table 5.2.3.3.3.3-3. + +**Table 5.2.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.3.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The Individual EAS Deployment information changes Event Subscription resource matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription termination.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription termination.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.2.3.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +**Table 5.2.3.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +## 5.2.4 Custom Operations without associated resources + +None. + +## 5.2.5 Notifications + +### 5.2.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 5.2.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------|--------------|---------------------------------|-------------------------------------------------------------------------| +| Event Notification | {notifUri} | POST | Provides Information about EAS Deployment Information changes event(s). | + +## 5.2.5.2 EAS Deployment Event Notification + +### 5.2.5.2.1 Description + +The EAS Deployment Event Notification is used by the NEF to report the observed EAS Deployment information changes event to a NF service consumer that has subscribed to such Notifications. + +### 5.2.5.2.2 Target URI + +The Notification URI "{notifUri}" shall be used with the callback URI variables defined in table 5.2.5.2.2-1. + +**Table 5.2.5.2.2-1: Callback URI variables for this resource** + +| Name | Data type | Definition | +|----------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | The Notification Uri as assigned by the NF service consumer during the subscription service operation and described within the EasDeploySubData data type (see table 5.2.6.2.2-1). | + +### 5.2.5.2.3 Standard Methods + +#### 5.2.5.2.3.1 POST + +This method shall support the request data structures specified in table 5.2.5.2.3.1-1 and the response data structures and response codes specified in table 5.2.5.2.3.1-1. + +**Table 5.2.5.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|--------------------------------------------------------------------------| +| EasDeployInfoNotif | M | 1 | Provides Information about the EAS Deployment Information changes event. | + +**Table 5.2.5.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during event notification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.2.5.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +**Table 5.2.5.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +## 5.2.6 Data Model + +### 5.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.2.6.1-1 specifies the data types defined for the Nnef\_EASDeployment service based interface protocol. + +**Table 5.2.6.1-1: Nnef\_EASDeployment specific Data Types** + +| Data type | Section defined | Description | Applicability | +|--------------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| EasDeployInfoNotif | 5.2.6.2.3 | Represents notifications on EAS Deployment Information changes event(s) that occurred for an Individual EAS Deployment Event Subscription resource. | | +| EasDeploySubData | 5.2.6.2.2 | Represents EAS Deployment Information changes event(s) subscription data. | | +| EasDeployInfoData | 5.2.6.2.5 | Represents the EAS Deployment Information to be reported. | | +| EasDepNotification | 5.2.6.2.4 | Represents the EAS Deployment Notification. | | +| EasEvent | 5.2.6.3.3 | represents the EAS event. | | + +Table 5.2.6.1-2 specifies data types re-used by the Nnef\_EASDeployment service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nnef\_EASDeployment service based interface. + +**Table 5.2.6.1-2: Nnef\_EASDeployment re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| DnailInformation | 3GPP TS 29.522 [15] | Represents the DNAI information including the DNS server identifier (consisting of IP address and port) and/or IP address(s) of the EAS in the local DN for the DNAI. | | +| DnnSnssaiInformation | 3GPP TS 29.522 [15] | Identifies a combination of (DNN, S-NSSAI). | | +| FqdnPatternMatchingRule | 3GPP TS 29.571 [16] | Represents the FQDN pattern matching rule. | | +| GroupId | 3GPP TS 29.571 [16] | Contains a Group identifier. | | +| RedirectResponse | 3GPP TS 29.571 [16] | Contains redirection related information. | | +| Uri | 3GPP TS 29.571 [16] | Contains a URI. | | + +## 5.2.6.2 Structured data types + +### 5.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 5.2.6.2.2 Type: EasDeploySubData + +**Table 5.2.6.2.2-1: Definition of type EasDeploySubData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| appId | string | O | 0..1 | Identifies the application for which the EAS Deployment Information corresponds to. | | +| dnnSnssaiInfos | array(DnnSnssaiInformation) | O | 1..N | Each of the element identifies a combination of (DNN, S-NSSAI). | | +| eventId | EasEvent | M | 1 | Event ID assigned by the NF service consumer. | | +| eventsNotifs | array(EasDeployInfoData) | C | 1..N | Represents the EAS Deployment Information changes event(s) to be reported.
Shall only be present if the "immRep" attribute is included in the request and sets to true, and the current status of EAS Deployment Information is available. | | +| immRep | boolean | O | 0..1 | Indication of immediate reporting:
- true: requires the immediate reporting of the current status of EAS Deployment Information, if available.
- false (default): EAS Deployment Information event report occurs when the event is met. | | +| interGroupId | GroupId | O | 0..1 | Identifies an internal UE group. | | +| notifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | +| notifUri | Uri | M | 1 | Notification URI for the EAS Deployment Information event reporting. | | + +## 5.2.6.2.3 Type: EasDeployInfoNotif + +Table 5.2.6.2.3-1: Definition of type EasDeployInfoNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|------------------------------------------------------------------|---------------| +| easDepNotifs | array(EasDepNotification) | M | 1..N | Represents the EAS Deployment Notification(s). | | +| notifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | + +## 5.2.6.2.4 Type: EasDepNotification + +Table 5.2.6.2.4-1: Definition of type EasDepNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|-----------------------------------------------------------|---------------| +| easDepInfo | EasDeployInfoData | M | 1 | Represents the EAS Deployment Information to be reported. | | +| eventId | EasEvent | M | 1 | Event ID assigned by the NF service consumer. | | + +## 5.2.6.2.5 Type: EasDeployInfoData + +Table 5.2.6.2.5-1: Definition of type EasDeployInfoData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|--------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| appId | string | O | 0..1 | Identifies the application for which the EAS Deployment Information corresponds to. | | +| dnailInfos | map(DnailInformation) | O | 1..N | list of DNS server identifier (consisting of IP address and port) and/or IP address(s) of the EAS in the local DN for each DNAI. The key of map is the DNAI. | | +| dnn | Dnn | O | 0..1 | DNN for the EAS Deployment Information. | | +| fqdnPatternList | array(FqdnPatternMatchingRule) | M | 1..N | Supported FQDN pattern(s) for application(s) deployed in the Local part of the DN where each FQDN pattern is described by a FQDN Pattern Matching Rule. | | +| internalGroupId | GroupId | O | 0..1 | Internal Group ID for the EAS Deployment Information. | | +| snssai | Snssai | O | 0..1 | S-NSSAI for the EAS Deployment Information. | | +| targetAfId | string | O | 0..1 | Identifier of the AF that is responsible for the EAS associated with this EAS deployment information. | EasRelocationEnh | + +## 5.2.6.3 Simple data types and enumerations + +## 5.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +### 5.2.6.3.2 Simple data types + +The simple data types defined in table 5.2.6.3.2-1 shall be supported. + +**Table 5.2.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +### 5.2.6.3.3 Enumeration: EasEvent + +The enumeration EasEvent represents the EAS event requested by the NF service consumer. It shall comply with the provisions defined in table 5.2.6.3.3-1. + +**Table 5.1.6.3.3-1: Enumeration EasEvent** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------|---------------| +| EAS_INFO_CHG | Indicates that the EAS Deployment Information is changed. | | + +## 5.2.7 Error Handling + +### 5.2.7.1 General + +For the Nnef\_EASDeployment API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nnef\_EASDeployment API. + +### 5.2.7.2 Protocol Errors + +No specific procedures for the Nnef\_EASDeployment service are specified. + +### 5.2.7.3 Application Errors + +The application errors defined for the Nnef\_EASDeployment service are listed in Table 5.2.7.3-1. + +**Table 5.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 5.2.8 Feature negotiation + +The optional features in table 5.2.8-1 are defined for the Nnef\_EASDeployment API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 5.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | EasRelocationEnh | This feature indicates enhanced support of EAS relocation procedures via additional information about the AFs that are responsible for certain EAS. | + +## 5.2.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nnef\_EASDeployment API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nnef\_EASDeployment API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nnef\_EventExposure service. + +The Nnef\_EASDeployment API defines a single scope "nnef-eas-deployment" for the entire service, and it does not define any additional scopes at resource or operation level. + +## 5.3 Nnef\_TrafficInfluenceData Service API + +### 5.3.1 Introduction + +The Nnef\_TrafficInfluenceData service shall use the Nnef\_TrafficInfluenceData API. + +The API URI of the Nnef\_TrafficInfluenceData API shall be: + +**{apiRoot}** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nnef-traffic-influence-data". +- The shall be "v1". +- The shall be set as described in clause 5.3.3. + +### 5.3.2 Usage of HTTP + +#### 5.3.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nnef\_TrafficInfluenceData API is contained in Annex 4. + +#### 5.3.2.2 HTTP standard headers + +##### 5.3.2.2.1 General + +See clause 5.3.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +### 5.3.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +### 5.3.2.3 HTTP custom headers + +The Nnef\_TrafficInfluenceData API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4]. + +In this Release of the specification, no specific custom headers are defined for the Nnef\_TrafficInfluenceData API. + +## 5.3.3 Resources + +### 5.3.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 5.3.3.1-1 depicts the resource URIs structure for the Nnef\_TrafficInfluenceData API. + +![Diagram showing the hierarchical structure of Resource URIs for the Nnef_TrafficInfluenceData API. The root URI is {apiRoot}/nnelf-traffic-influence-data/. It branches to /subscriptions, which in turn branches to /{subscriptionId}.](c64555b7f91435b01997807dbb4bcc4c_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nnelf-traffic-influence-data/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Diagram showing the hierarchical structure of Resource URIs for the Nnef\_TrafficInfluenceData API. The root URI is {apiRoot}/nnelf-traffic-influence-data/. It branches to /subscriptions, which in turn branches to /{subscriptionId}. + +**Figure 5.3.3.1-1: Resource URI structure of the Nnef\_TrafficInfluenceData API** + +Table 5.3.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.3.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|------------------------------------------------|---------------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Traffic Influence Data Subscriptions | /subscriptions | POST | Creates a subscription to notifications of Traffic Influence Data Information, i.e. creation of an Individual Traffic Influence Data Subscription resource. | +| | | GET | Reads all subscriptions to Traffic Influence Data. | +| Individual Traffic Influence Data Subscription | /subscriptions/{subscriptionId} | PUT | Modify all of the properties of an existing subscription to Traffic Influence Data. | +| | | GET | Reads a subscription to Individual Traffic Influence Data. | +| | | DELETE | Cancels an individual subscription to notifications of Traffic Influence Data. | + +### 5.3.3.2 Resource: Traffic Influence Data Subscriptions + +#### 5.3.3.2.1 Description + +The resource represents the collection of Traffic Influence Data subscriptions of the Nnef\_TrafficInfluenceData service. It allows NF service consumers to create a new subscription to notifications on Traffic Influence Data. + +#### 5.3.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnef-traffic-influence-data//subscriptions + +This resource shall support the resource URI variables defined in table 5.3.3.2.2-1. + +**Table 5.3.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.3.1 | + +#### 5.3.3.2.3 Resource Standard Methods + +##### 5.3.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.3.2.3.1-1. + +**Table 5.3.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.3.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.3.2.3.1-3. + +**Table 5.3.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------| +| TrafficInfluDataSub | M | 1 | Contains the information required for the creation of a new Individual Traffic Influence Data Subscription resource. | + +**Table 5.3.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response Codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------| +| TrafficInfluDataSub | M | 1 | 201
Created | Contains the representation of the Individual Traffic Influence Data Subscription resource. | +| NOTE: The mandatory HTTP error status code for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +**Table 5.3.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nnef-traffic-influence-data//subscriptions/{subscriptionId}. | + +### 5.3.3.3 Resource: Individual Traffic Influence Data Subscription + +#### 5.3.3.3.1 Description + +The resource represents an individual Traffic Influence Data subscription of the Nnef\_TrafficInfluenceData service. It allows NF service consumers to subscribe/unsubscribe an Traffic Influence Data information, and allows the NEF to notify Traffic Influence Data to the NF service consumer. + +#### 5.3.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nnef-traffic-influence-data//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 5.3.3.3.2-1. + +**Table 5.3.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|---------------------------------| +| apiRoot | string | See clause 5.3.1 | +| subscriptionId | string | Identifier of the subscription. | + +#### 5.3.3.3.3 Resource Standard Methods + +##### 5.3.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.3.3.3.3.1-1. + +**Table 5.3.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.3.1-2 and the response data structures and response codes specified in table 5.3.3.3.3.1-3. + +**Table 5.3.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|------------------------|-------------------------------------------------------------------| +| TrafficInfluDataSub | M | 1 | 200 OK | The subscription information is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription retrieval.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription retrieval.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.3.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +#### 5.3.3.3.3.2 PUT + +This method shall support the URI query parameters specified in table 5.3.3.3.3.2-1. + +**Table 5.3.3.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.3.2-2 and the response data structures and response codes specified in table 5.3.3.3.3.2-3. + +**Table 5.3.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|------------------------------------------------------------| +| TrafficInfluDataSub | M | 1 | Modify an existing subscription to Traffic Influence Data. | + +**Table 5.3.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------| +| TrafficInfluDataSub | M | 1 | 200 OK | The subscription was updated successfully. | +| n/a | | | 204 No Content | The subscription has been successfully updated and no content is returned in the response body. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription retrieval.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription retrieval.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.3.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +### 5.3.3.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 5.3.3.3.3.3-1. + +**Table 5.3.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.3.3-2 and the response data structures and response codes specified in table 5.3.3.3.3.3-3. + +**Table 5.3.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The Individual Traffic Influence Data Subscription resource matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription termination.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription termination.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.3.3.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +## 5.3.4 Custom Operations without associated resources + +None. + +## 5.3.5 Notifications + +### 5.3.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 5.3.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------|--------------|---------------------------------|----------------------------------| +| Event Notification | {notifUri} | POST | Provides Traffic Influence Data. | + +### 5.3.5.2 Traffic Influence Data Notification + +#### 5.3.5.3.1 Description + +The Traffic Influence Data Notification is used by the NEF to report the observed Traffic Influence Data to an NF service consumer that has subscribed to such Notifications. + +#### 5.3.5.3.2 Target URI + +The Notification URI "{notifUri}" shall be used with the callback URI variables defined in table 5.3.5.3.2-1. + +**Table 5.3.5.3.2-1: Callback URI variables for this resource** + +| Name | Data type | Definition | +|----------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | The Notification URI as assigned by the NF service consumer during the subscription service operation and described within the TrafficInfluDataSub data type. | + +#### 5.3.5.3.3 Standard Methods + +##### 5.3.5.3.3.1 POST + +This method shall support the request data structures specified in table 5.3.5.3.3.1-1 and the response data structures and response codes specified in table 5.3.5.3.3.1-2. + +**Table 5.3.5.3.3.1-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|--------------------------------------| +| TrafficInfluDataNotify | M | 1 | Provides the Traffic Influence Data. | + +**Table 5.3.5.3.3.1-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during notification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.3.5.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +**Table 5.3.5.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +## 5.3.6 Data Model + +### 5.3.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.3.6.1-1 specifies the data types defined for the Nnef\_TrafficInfluenceData service based interface protocol. + +**Table 5.3.6.1-1: Nnef\_TrafficInfluenceData specific Data Types** + +| Data type | Section defined | Description | Applicability | +|------------------------|-----------------|---------------------------------------------------|---------------| +| TrafficInfluDataNotify | 5.3.6.2.3 | Contains traffic influence data for notification. | | +| TrafficInfluDataSub | 5.3.6.2.2 | Contains traffic influence subscription data. | | + +Table 5.3.6.1-2 specifies data types re-used by the Nnef\_TrafficInfluenceData service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nnef\_TrafficInfluenceData service based interface. + +**Table 5.3.6.1-2: Nnef\_TrafficInfluenceData re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------|---------------------|---------------------------------------------------------------------|---------------| +| Dnn | 3GPP TS 29.571 [16] | Identifies the DNN. | | +| GroupId | 3GPP TS 29.571 [16] | Identifies a group of UEs. | | +| ReportingInformation | 3GPP TS 29.523 [22] | Represents the type of reporting the subscription requires. | | +| Snssai | 3GPP TS 29.571 [16] | Identifies a Single Network Slice Selection Assistance Information. | | +| Supi | 3GPP TS 29.571 [16] | The SUPI for an UE. | | +| SupportedFeatures | 3GPP TS 29.571 [16] | Indicates the features supported. | | +| TrafficInfluData | 3GPP TS 29.519 [28] | Contains traffic influence data. | | +| Uri | 3GPP TS 29.571 [16] | Contains a URI. | | + +### 5.3.6.2 Structured data types + +#### 5.3.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 5.3.6.2.2 Type: TrafficInfluDataSub + +**Table 5.3.6.2.2-1: Definition of type TrafficInfluDataSub** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| notifUri | Uri | M | 1 | URI provided by the NF service consumer indicating where to receive the subscribed notifications from the NEF. | | +| notifCorrId | string | M | 1 | Notification correlation identifier. | | +| dnns | array(Dnn) | C | 1..N | Each element identifies a DNN.
(NOTE) | | +| snssais | array(Snssai) | C | 1..N | Each element identifies an internal slice.
(NOTE) | | +| internalGroupIds | array(GroupId) | C | 1..N | Each element identifies a group of users.
(NOTE) | | +| supis | array(Supi) | C | 1..N | Each element identifies the user.
(NOTE) | | +| anyUe | boolean | C | 0..1 | Identifies any UE when setting to "true". Default value is "false" if omitted.
(NOTE) | | +| rptInfo | ReportingInformation | O | 0..1 | Represents the reporting requirements of the subscription. | | +| immReports | array(TrafficInfluData) | O | 1..N | Contains the Traffic Influence Data that match this subscription.
It may be included only in the POST (or PUT) response body of a subscription creation (or modification), and only if the "immRep" attribute contained in "rptInfo" is set to "true" in the corresponding HTTP request. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | Used to negotiate the applicability of the optional features. This attribute shall be provided in the POST request and in the response of successful resource creation. | | + +NOTE: At least one of "dnns", "snssais", "internalGroupIds", "anyUe" or "supis" shall be provided. + +Editor's note: Whether the "internalGroupIds" is plural or single is FFS. + +### 5.3.6.2.3 Type: TrafficInfluDataNotify + +**Table 5.3.6.2.3-1: Definition of type TrafficInfluDataNotify** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------------|---|-------------|----------------------------------------|---------------| +| notifCorrId | string | M | 1 | Notification correlation identifier. | | +| eventNotifications | array(TrafficInfluData) | M | 1..N | Notifications about Individual Events. | | + +NOTE: The "upPathChgNotifCorrId", "upPathChgNotifUri", "resUri" and "resetIds" attributes contained in TrafficInfluData shall not be included. + +## 5.3.6.3 Simple data types and enumerations + +### 5.3.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +### 5.3.6.3.2 Simple data types + +The simple data types defined in table 5.3.6.3.2-1 shall be supported. + +**Table 5.3.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +## 5.3.7 Error Handling + +### 5.3.7.1 General + +For the Nnef\_TrafficInfluenceData API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.3.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nnef\_TrafficInfluenceData API. + +### 5.3.7.2 Protocol Errors + +No specific procedures for the Nnef\_TrafficInfluenceData service are specified. + +### 5.3.7.3 Application Errors + +The application errors defined for the Nnef\_TrafficInfluenceData service are listed in Table 5.3.7.3-1. + +**Table 5.3.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 5.3.8 Feature negotiation + +The optional features in table 5.3.8-1 are defined for the Nnef\_TrafficInfluenceData API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 5.3.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 5.3.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nnef\_TrafficInfluenceData API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nnef\_TrafficInfluenceData API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nnef\_TrafficInfluenceData service. + +The Nnef\_TrafficInfluenceData API defines a single scope "nnef-traffic-influence-data" for the entire service, and it does not define any additional scopes at resource or operation level. + +## 5.4 Nnef\_ECSAddress Service API + +### 5.4.1 Introduction + +The Nnef\_ECSAddress service shall use the Nnef\_ECSAddress API. + +The API URI of the Nnef\_ECSAddress API shall be: + +**{apiRoot}/** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nnef-ecs-addr-cfg-info". +- The shall be "v1". +- The shall be set as described in clause 5.4.3. + +### 5.4.2 Usage of HTTP + +#### 5.4.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.4 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nnef\_ECSAddress API is contained in Annex A.5. + +#### 5.4.2.2 HTTP standard headers + +##### 5.4.2.2.1 General + +See clause 5.4.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 5.4.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +#### 5.4.2.3 HTTP custom headers + +The Nnef\_ECSAddress API shall support mandatory HTTP custom header fields specified in clause 5.4.3.2 of 3GPP TS 29.500 [4] and may support HTTP custom header fields specified in clause 5.4.3.3 of 3GPP TS 29.500 [4]. + +In this Release of the specification, no specific custom headers are defined for the Nnef\_ECSAddress API. + +## 5.4.3 Resources + +### 5.4.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 5.4.3.1-1 depicts the resource URIs structure for the Nnef\_ECSAddress API. + +![Figure 5.4.3.1-1: Resource URI structure of the Nnef_ECSAddress API. The diagram shows a hierarchical tree structure of URIs. The root is {apiRoot}/nnef-ecs-addr-cfg-info/. A line descends from this root to a box containing /subscriptions. From /subscriptions, another line descends to a box containing /{subscriptionId}.](832a0ce332e784fe80289e9f00f56574_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nnef-ecs-addr-cfg-info/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Figure 5.4.3.1-1: Resource URI structure of the Nnef\_ECSAddress API. The diagram shows a hierarchical tree structure of URIs. The root is {apiRoot}/nnef-ecs-addr-cfg-info/. A line descends from this root to a box containing /subscriptions. From /subscriptions, another line descends to a box containing /{subscriptionId}. + +**Figure 5.4.3.1-1: Resource URI structure of the Nnef\_ECSAddress API** + +Table 5.4.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.4.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------------------------------------------------------|---------------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ECS Address Configuration Information Subscriptions | /subscriptions | POST | Creates a subscription to notifications of ECS Address Configuration Information, i.e. creation of an Individual ECS Address Configuration Information Subscription resource. | +| Individual ECS Address Configuration Information Subscription | /subscriptions/{subscriptionId} | PUT | Modify all of the properties of an existing subscription to ECS Address Configuration Information. | +| | | GET | Reads a subscription to Individual ECS Address Configuration Information. | +| | | DELETE | Cancels an individual subscription to notifications of ECS Address Configuration Information. | + +### 5.4.3.2 Resource: ECS Address Configuration Information Subscriptions + +#### 5.4.3.2.1 Description + +The resource represents the collection of ECS Address Configuration Information subscriptions of the Nnef\_ECSAddress service. It allows NF service consumers to create a new subscription to notifications on ECS Address Configuration Information. + +#### 5.4.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnef-ecs-addr-cfg-info//subscriptions + +This resource shall support the resource URI variables defined in table 5.4.3.2.2-1. + +**Table 5.4.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.4.1 | + +### 5.4.3.2.3 Resource Standard Methods + +#### 5.4.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.4.3.2.3.1-1. + +**Table 5.4.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.4.3.2.3.1-2 and the response data structures and response codes specified in table 5.4.3.2.3.1-3. + +**Table 5.4.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------| +| EcsAddrCfgInfoSub | M | 1 | Contains the information required for the creation of a new Individual ECS Address Configuration Information Subscription resource. | + +**Table 5.4.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response Codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------| +| EcsAddrCfgInfoSub | M | 1 | 201
Created | Contains the representation of the Individual ECS Address Configuration Information Subscription resource. | +| NOTE: The mandatory HTTP error status code for the POST method listed in table 5.4.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +**Table 5.4.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nnelf-ecs-addr-cfg-info//subscriptions/{subscriptionId}. | + +### 5.4.3.3 Resource: Individual ECS Address Configuration Information Subscription + +#### 5.4.3.3.1 Description + +The resource represents an individual ECS Address Configuration Information subscription of the Nnef\_ECSAddress service. It allows NF service consumers to subscribe/unsubscribe an ECS Address Configuration Information, and allows the NEF to notify ECS Address Configuration Information to the NF service consumer. + +#### 5.4.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nnelf-ecs-addr-cfg-info//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 5.4.3.3.2-1. + +**Table 5.4.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|---------------------------------| +| apiRoot | string | See clause 5.4.1. | +| subscriptionId | string | Identifier of the subscription. | + +### 5.4.3.3.3 Resource Standard Methods + +#### 5.4.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.4.3.3.3.1-1. + +**Table 5.4.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.4.3.3.3.1-2 and the response data structures and response codes specified in table 5.4.3.3.3.1-3. + +**Table 5.4.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.4.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|-------------------------------------------------------------------| +| EcsAddrCfgInfoSub | M | 1 | 200 OK | The subscription information is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription retrieval.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription retrieval.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the GET method listed in table 5.4.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.4.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | + +**Table 5.4.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +#### 5.4.3.3.3.2 PUT + +This method shall support the URI query parameters specified in table 5.4.3.3.3.2-1. + +**Table 5.4.3.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.4.3.3.3.2-2 and the response data structures and response codes specified in table 5.4.3.3.3.2-3. + +**Table 5.4.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|---------------------------------------------------------------------------| +| EcsAddrCfgInfoSub | M | 1 | Modify an existing subscription to ECS Address Configuration Information. | + +**Table 5.4.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------| +| EcsAddrCfgInfoSub | M | 1 | 200 OK | The subscription was updated successfully. | +| n/a | | | 204 No Content | The subscription has been successfully updated and no content is returned in the response body. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription retrieval.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription retrieval.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.4.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | + +**Table 5.4.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +#### 5.4.3.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 5.4.3.3.3.3-1. + +**Table 5.4.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.4.3.3.3.3-2 and the response data structures and response codes specified in table 5.4.3.3.3.3-3. + +**Table 5.4.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.4.3.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The Individual ECS Address Configuration Information Subscription resource matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription termination.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription termination.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in table 5.4.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.4.3.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +**Table 5.4.3.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +## 5.4.4 Custom Operations without associated resources + +None. + +## 5.4.5 Notifications + +### 5.4.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 5.4.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------|--------------|---------------------------------|-------------------------------------------------| +| Event Notification | {notifUri} | POST | Provides ECS Address Configuration Information. | + +### 5.4.5.2 ECS Address Configuration Information Notification + +#### 5.4.5.4.1 Description + +The ECS Address Configuration Information Notification is used by the NEF to report the observed ECS Address Configuration Information to an NF service consumer that has subscribed to such Notifications. + +#### 5.4.5.4.2 Target URI + +The Notification URI "{notifUri}" shall be used with the callback URI variables defined in table 5.4.5.4.2-1. + +**Table 5.4.5.4.2-1: Callback URI variables for this resource** + +| Name | Data type | Definition | +|----------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | The Notification URI as assigned by the NF service consumer during the subscription service operation and described within the EcsAddrCfgInfoSubdata type. | + +#### 5.4.5.4.3 Standard Methods + +##### 5.4.5.4.3.1 POST + +This method shall support the request data structures specified in table 5.4.5.4.3.1-1 and the response data structures and response codes specified in table 5.4.5.4.3.1-2. + +**Table 5.4.5.4.3.1-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|-----------------------------------------------------| +| EcsAddrCfgInfoNotification | M | 1 | Provides the ECS Address Configuration Information. | + +**Table 5.4.5.4.3.1-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during notification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.4.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.4.5.4.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +**Table 5.4.5.4.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +## 5.4.6 Data Model + +### 5.4.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.4.6.1-1 specifies the data types defined for the Nnef\_ECSAddress service based interface protocol. + +**Table 5.4.6.1-1: Nnef\_ECSAddress specific Data Types** + +| Data type | Section defined | Description | Applicability | +|----------------------------|-----------------|-------------------------------------------------------------------|---------------| +| EcsAddrCfgInfoNotification | 5.4.6.2.3 | Contains ECS Address Configuration Information for notification. | | +| EcsAddrCfgInfoSub | 5.4.6.2.2 | Contains ECS Address Configuration Information subscription data. | | + +Table 5.4.6.1-2 specifies data types re-used by the Nnef\_ECSAddress service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nnef\_ECSAddress service based interface. + +**Table 5.4.6.1-2: Nnef\_ECSAddress re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|---------------------------------------------------------------------|---------------| +| Dnn | 3GPP TS 29.571 [16] | Identifies the DNN. | | +| GroupId | 3GPP TS 29.571 [16] | Identifies a group of UEs. | | +| Snssai | 3GPP TS 29.571 [16] | Identifies a Single Network Slice Selection Assistance Information. | | +| SupportedFeatures | 3GPP TS 29.571 [16] | Indicates the features supported. | | +| Uri | 3GPP TS 29.571 [16] | Contains a URI. | | + +### 5.4.6.2 Structured data types + +#### 5.4.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 5.4.6.2.2 Type: EcsAddrCfgInfoSub + +**Table 5.4.6.2.2-1: Definition of type EcsAddrCfgInfoSub** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-----------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| notifUri | Uri | M | 1 | URI provided by the NF service consumer indicating where to receive the subscribed notifications from the NEF. | | +| notifCorrId | string | M | 1 | Notification correlation identifier. | | +| dnns | array(Dnn) | O | 1..N | Each element identifies a DNN. | | +| snssais | array(Snssai) | O | 1..N | Each element identifies an internal slice. | | +| internalGroupId | GroupId | O | 0..1 | Identifies a group of users. | | +| immReplnd | boolean | O | 0..1 | Indication of immediate reporting. If included, when it is set to true it indicates immediate reporting of the subscribed events, if available. Otherwise, reporting will occur when the event is met. | | +| immReports | array(EcsAddrCfgInfoNotification) | O | 1..N | Contains the ECS Address Configuration Information that match this subscription. It may be included only in the POST (or PUT) response body of a subscription creation (or modification), and only if the "immReplnd" attribute is set to "true" in the corresponding HTTP request. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | Used to negotiate the applicability of the optional features. This attribute shall be provided in the POST request and in the response of successful resource creation. | | + +Editor's note: Whether the "dnns", "snssais" and "internalGroupId" attributes are single or plural and if they need to be included in the notification is FFS. + +## 5.4.6.2.3 Type: EcsAddrCfgInfoNotification + +**Table 5.4.6.2.3-1: Definition of type EcsAddrCfgInfoNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-----------------------------------------------------|---------------| +| notifCorrId | string | M | 1 | Notification correlation identifier. | | +| ecsAddrCfgInfo | array(string) | M | 1..N | Contains the ECS Address Configuration Information. | | + +Editor's note: The data type of "ecsAddrCfgInfo" attribute is FFS. + +## 5.4.6.3 Simple data types and enumerations + +## 5.4.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 5.4.6.3.2 Simple data types + +The simple data types defined in table 5.4.6.3.2-1 shall be supported. + +**Table 5.4.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +## 5.4.7 Error Handling + +### 5.4.7.1 General + +For the Nnef\_ECSAddress API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.4.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.4.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nnef\_ECSAddress API. + +### 5.4.7.2 Protocol Errors + +No specific procedures for the Nnef\_ECSAddress service are specified. + +### 5.4.7.3 Application Errors + +The application errors defined for the Nnef\_ECSAddress service are listed in Table 5.4.7.3-1. + +**Table 5.4.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 5.4.8 Feature negotiation + +The optional features in table 5.4.8-1 are defined for the Nnef\_ECSAddress API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 5.4.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 5.4.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nnef\_ECSAddress API may be authorized by means of the Oauth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the “Client Credentials” authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If Oauth2 is used, an NF Service Consumer, prior to consuming services offered by the Nnef\_ECSAddress API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nnef\_ECSAddress service. + +The Nnef\_ECSAddress API defines a single scope "nnef-ecs-addr-cfg-info" for the entire service, and it does not define any additional scopes at resource or operation level. + +## 5.5 Nnef\_DNAIMapping Service API + +### 5.5.1 Introduction + +The Nnef\_DNAIMapping service shall use the Nnef\_DNAIMapping API. + +The API URI of the Nnef\_DNAIMapping API shall be: + +**{apiRoot}/** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nnef-dnai-mapping". +- The shall be "v1". +- The shall be set as described in clause 5.5.3. + +### 5.5.2 Usage of HTTP + +#### 5.5.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.6 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nnef\_DNAIMapping API is contained in Annex 7. + +#### 5.5.2.2 HTTP standard headers + +##### 5.5.2.2.1 General + +See clause 5.6.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 5.5.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.6 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +#### 5.5.2.3 HTTP custom headers + +The Nnef\_DNAIMapping API shall support mandatory HTTP custom header fields specified in clause 5.6.3.2 of 3GPP TS 29.500 [4] and may support HTTP custom header fields specified in clause 5.6.3.3 of 3GPP TS 29.500 [4]. + +In this Release of the specification, no specific custom headers are defined for the Nnef\_DNAIMapping API. + +## 5.5.3 Resources + +### 5.5.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 5.5.3.1-1 depicts the resource URIs structure for the Nnef\_DNAIMapping API. + +![Figure 5.5.3.1-1: Resource URI structure of the Nnef_DNAIMapping API. The diagram shows a hierarchical tree structure of URIs. The root is {apiRoot}/nnef-dnai-mapping/. It branches to /subscriptions, which in turn branches to /{subscriptionId}.](e35f25e0b66752d4179a4cb108a3fb5a_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nnef-dnai-mapping/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Figure 5.5.3.1-1: Resource URI structure of the Nnef\_DNAIMapping API. The diagram shows a hierarchical tree structure of URIs. The root is {apiRoot}/nnef-dnai-mapping/. It branches to /subscriptions, which in turn branches to /{subscriptionId}. + +**Figure 5.5.3.1-1: Resource URI structure of the Nnef\_DNAIMapping API** + +Table 5.5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.5.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------------------------|---------------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| DNAI Mapping Subscriptions | /subscriptions | POST | Creates a subscription to notifications of DNAI Mapping, i.e. creation of an Individual DNAI Mapping Subscription resource. | +| Individual DNAI Mapping Subscription | /subscriptions/{subscriptionId} | GET | Reads a subscription to Individual DNAI Mapping. | +| | | DELETE | Delete an individual subscription to notifications of DNAI Mapping. | + +### 5.5.3.2 Resource: DNAI Mapping Subscriptions + +#### 5.5.3.2.1 Description + +The resource represents the collection of DNAI Mapping subscriptions of the Nnef\_DNAIMapping service. It allows NF service consumers to create a new subscription to notifications on DNAI Mapping. + +#### 5.5.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnef-dnai-mapping//subscriptions + +This resource shall support the resource URI variables defined in table 5.5.3.2.2-1. + +**Table 5.5.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.5.1 | + +### 5.5.3.2.3 Resource Standard Methods + +#### 5.5.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.5.3.2.3.1-1. + +**Table 5.5.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.5.3.2.3.1-2 and the response data structures and response codes specified in table 5.5.3.2.3.1-3. + +**Table 5.5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------|---|-------------|------------------------------------------------------------------------------------------------------------| +| DnaiMapSub | M | 1 | Contains the information required for the creation of a new Individual DNAI Mapping Subscription resource. | + +**Table 5.5.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response Codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------| +| DnaiMapSub | M | 1 | 201
Created | Contains the representation of the Individual DNAI Mapping Subscription resource. | +| NOTE: The mandatory HTTP error status code for the POST method listed in table 5.6.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +**Table 5.5.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nnef-dnai-mapping//subscriptions/{subscriptionId}. | + +### 5.5.3.3 Resource: Individual DNAI Mapping Subscription + +#### 5.5.3.3.1 Description + +The resource represents an individual DNAI Mapping subscription of the Nnef\_DNAIMapping service. It allows NF service consumers to subscribe/unsubscribe DNAI Mapping information, and allows the NEF to notify DNAI Mapping Information to the NF service consumer. + +#### 5.5.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nnef-dnai-mapping//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 5.5.3.3.2-1. + +**Table 5.5.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|---------------------------------| +| apiRoot | string | See clause 5.5.1. | +| subscriptionId | string | Identifier of the subscription. | + +### 5.5.3.3.3 Resource Standard Methods + +#### 5.5.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.5.3.3.3.1-1. + +**Table 5.5.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.3.3.3.1-2 and the response data structures and response codes specified in table 5.5.3.3.3.1-3. + +**Table 5.5.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.5.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------| +| DnaiMapSub | M | 1 | 200 OK | The subscription information is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription retrieval.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription retrieval.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the GET method listed in table 5.6.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.5.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | + +**Table 5.5.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +### 5.5.3.3.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.5.3.3.3.2-1. + +**Table 5.5.3.3.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.3.3.3.2-2 and the response data structures and response codes specified in table 5.5.3.3.3.2-3. + +**Table 5.5.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.5.3.3.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The Individual DNAI Mapping Subscription resource matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription termination.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription termination.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in table 5.6.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.5.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | String | M | 1 | An alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | String | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +**Table 5.5.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | String | M | 1 | An alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | String | O | 0..1 | Identifier of the target NEF (service) instance towards which the request is redirected. | + +## 5.5.4 Custom Operations without associated resources + +None. + +## 5.5.5 Notifications + +### 5.5.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 5.5.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|----------------------------------------------------------------|--------------|---------------------------------|-------------------------------------------------------------------------------------------------------| +| Notification of the update of DNAI-EAS address(es) information | {notifUri} | POST | The update of the DNAI-EAS address(es) information is notified to the NF service consumer by the NEF. | + +### 5.5.5.2 DNAI Mapping Notification + +#### 5.5.5.2.1 Description + +The DNAI Mapping Notification is used by the NEF to report the observed DNAI Mapping to an NF service consumer that has subscribed to such Notifications. + +#### 5.5.5.2.2 Target URI + +The Notification URI "{notifUri}" shall be used with the callback URI variables defined in table 5.5.5.2.2-1. + +**Table 5.5.5.2.2-1: Callback URI variables for this resource** + +| Name | Data type | Definition | +|----------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | The Notification URI as assigned by the NF service consumer during the subscription service operation and described within the DnaiMapSub data type. | + +#### 5.5.5.2.3 Standard Methods + +##### 5.5.5.2.3.1 POST + +This method shall support the request data structures specified in table 5.5.5.2.3.1-1 and the response data structures and response codes specified in table 5.5.5.2.3.1-2. + +**Table 5.5.5.2.3.1-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|--------------------------------------------------------------------------------------------------| +| DnaiMapUpdateNotif | M | 1 | Represents the update of the DNAI Mapping information to be reported to the NF service consumer. | + +**Table 5.5.5.2.3.1-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during notification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.6.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.5.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +**Table 5.5.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +## 5.5.6 Data Model + +### 5.5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.5.6.1-1 specifies the data types defined for the Nnef\_DNAIMapping service based interface protocol. + +**Table 5.5.6.1-1: Nnef\_DNAIMapping specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| n/a | | | | + +Table 5.5.6.1-2 specifies data types re-used by the Nnef\_DNAIMapping service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nnef\_DNAIMapping service based interface. + +**Table 5.5.6.1-2: Nnef\_DNAIMapping re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|--------------------|---------------------|-----------------------------------------------------------------------------|----------------------| +| DnaiMapSub | 3GPP TS 29.522 [15] | Represents DNAI Mapping subscription data. | | +| DnaiMapUpdateNotif | 3GPP TS 29.522 [15] | Represents the notification data of the update of DNAI Mapping information. | | + +## 5.5.6.2 Structured data types + +### 5.5.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 5.5.6.3 Simple data types and enumerations + +### 5.5.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +### 5.5.6.3.2 Simple data types + +The simple data types defined in table 5.5.6.3.2-1 shall be supported. + +**Table 5.5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|------------------|------------------------|--------------------|----------------------| +| | | | | + +## 5.5.7 Error Handling + +### 5.5.7.1 General + +For the Nnef\_DNAIMapping API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.6.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.6.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nnef\_DNAIMapping API. + +### 5.5.7.2 Protocol Errors + +No specific procedures for the Nnef\_DNAIMapping service are specified. + +### 5.5.7.3 Application Errors + +The application errors defined for the Nnef\_DNAIMapping service are listed in Table 5.5.7.3-1. + +**Table 5.5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|--------------------------|-------------------------|--------------------| +| | | | + +## 5.5.8 Feature negotiation + +The optional features in table 5.5.8-1 are defined for the Nnef\_DNAIMapping API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 5.5.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 5.5.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nnef\_DNAIMapping API may be authorized by means of the Oauth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the “Client Credentials” authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If Oauth2 is used, an NF Service Consumer, prior to consuming services offered by the Nnef\_DNAIMapping API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.6.2.2. + +# 5.6 Nnef\_UEId Service API + +## 5.6.1 Introduction + +The Nnef\_UEId service shall use the Nnef\_UEId API. + +The API URI of the Nnef\_UEId API shall be: + +**{apiRoot}** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nnef-ueid". +- The shall be "v1". +- The shall be set as described in clause 5.6.3 and clause 5.6.4. + +## 5.6.2 Usage of HTTP + +### 5.6.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nnef\_UEId API is contained in Annex A.7. + +## 5.6.2.2 HTTP standard headers + +### 5.6.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +### 5.6.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +## 5.6.2.3 HTTP custom headers + +The Nnef\_UEId API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4]. + +In this Release of the specification, no specific custom headers are defined for the Nnef\_UEId API. + +## 5.6.3 Resources + +There are no resources defined for this API in this release of the specification. + +## 5.6.4 Custom Operations without associated resources + +### 5.6.4.1 Overview + +The structure of the custom operation URIs of the Nnef\_UEId API is shown in figure 5.6.4.1-1. + +![Diagram showing the custom operation URI structure of the Nnef_UEId API. The base URI is {apiRoot}/nnef-ueid/. A dashed box labeled /fetch is connected to the base URI by a line, indicating it is a custom operation URI.](d4b3677f40009dd5bd8f9852463dc942_img.jpg) + +``` + + {apiRoot}/nnef-ueid/ + | + +-- /fetch + +``` + +Diagram showing the custom operation URI structure of the Nnef\_UEId API. The base URI is {apiRoot}/nnef-ueid/. A dashed box labeled /fetch is connected to the base URI by a line, indicating it is a custom operation URI. + +**Figure 5.6.4.1-1: Custom operation URI structure of the Nnef\_UEId API** + +Table 5.6.4.1-1 provides an overview of the custom operations and applicable HTTP methods defined for the Nnef\_UEId API. + +**Table 5.6.4.1-1: Custom operations without associated resources** + +| Operation | Custom operation URI | Mapped HTTP method | Description | +|-----------|----------------------|--------------------|---------------------------------------------------------------------| +| fetch | /fetch | POST | Fetch the internal UE identifier from the H-NEF for the roaming UE. | + +## 5.6.4.2 Operation: Fetch + +### 5.6.4.2.1 Description + +The custom operation allows the NF service consumer (e.g. V-NEF) providing the external UE Identifier to fetch the internal UE Identifier from the H-NEF for the roaming UE under the roaming agreement with the roaming partner(s). + +### 5.6.4.2.2 Operation Definition + +This operation shall support the response data structures and response codes specified in tables 5.6.4.2.2-1 and 5.6.4.2.2-2. + +**Table 5.6.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|------------------------------------------------------------| +| UeldReq | M | 1 | Parameters to request to fetch the internal UE Identifier. | + +**Table 5.6.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------| +| UeldInfo | M | 1 | 200 OK | The requested internal UE Identifier was returned successfully. | +| n/a | | | 204 No Content | If the requested data does not exist, the NEF shall respond with "204 No Content". | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during fetch procedure.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection during fetch procedure.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.6.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | String | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | String | O | 0..1 | Identifier of the NEF (service) instance towards which the request is redirected. | + +**Table 5.6.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NEF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the NEF (service) instance towards which the request is redirected. | + +## 5.6.5 Notifications + +None. + +## 5.6.6 Data Model + +### 5.6.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.6.6.1-1 specifies the data types defined for the Nnef\_UEId service-based interface protocol. + +**Table 5.6.6.1-1: Nnef\_UEId specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-----------|-----------------|-----------------------------------------|---------------| +| UeldReq | 5.6.6.2.2 | Contains the UE ID request information. | | +| UeldInfo | 5.6.6.2.3 | Contains the UE ID information. | | + +Table 5.6.6.1-2 specifies data types re-used by the Nnef\_UEId service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nnef\_UEId service based interface. + +**Table 5.6.6.1-2: Nnef\_UEId re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|-----------------------------------|---------------| +| Gpsi | 3GPP TS 29.571 [16] | Identifies the GPSI of an UE. | | +| Supi | 3GPP TS 29.571 [16] | Identifies the SUPI of an UE. | | +| SupportedFeatures | 3GPP TS 29.571 [16] | Indicates the features supported. | | + +### 5.6.6.2 Structured data types + +#### 5.6.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +#### 5.6.6.2.2 Type: UeldReq + +**Table 5.6.6.2.2-1: Definition of type UeldReq** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------------|---------------| +| gpsi | Gpsi | M | 1 | The GPSI of an UE. | | + +#### 5.6.6.2.3 Type: UeldInfo + +**Table 5.6.6.2.3-1: Definition of type UeldInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------------|---------------| +| supi | Supi | M | 1 | The SUPI of an UE. | | + +### 5.6.6.3 Simple data types and enumerations + +#### 5.6.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 5.6.6.3.2 Simple data types + +The simple data types defined in table 5.6.6.3.2-1 shall be supported. + +**Table 5.6.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +## 5.6.7 Error Handling + +### 5.6.7.1 General + +For the Nnef\_UEId API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nnef\_UEId API. + +### 5.6.7.2 Protocol Errors + +No specific procedures for the Nnef\_UEId service are specified. + +### 5.6.7.3 Application Errors + +The application errors defined for the Nnef\_UEId service are listed in Table 5.6.7.3-1. + +**Table 5.6.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 5.6.8 Feature negotiation + +The optional features in table 5.6.8-1 are defined for the Nnef\_UEId API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 5.6.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 5.6.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nnef\_UEId API may be authorized by means of the Oauth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the “Client Credentials” authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If Oauth2 is used, an NF Service Consumer, prior to consuming services offered by the Nnef\_UEId API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.5.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nnef\_UEId service. + +The Nnef\_UEId API defines a single scope "nnef-ueid" for the entire service, and it does not define any additional scopes at resource or operation level. + +## Annex A (normative): OpenAPI specification + +### A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [7] and clause 5.3.1 of the 3GPP TS 29.501 [5] for further information). + +### A.2 Nnef\_EventExposure API + +``` +openapi: 3.0.0 + +info: + title: Nnef_EventExposure + version: 1.3.0-alpha.4 + description: | + NEF Event Exposure Service. + © 2023 , 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.591 V18.4.0; 5G System; Network Exposure Function Southbound Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.591/ + +servers: + - url: '{apiRoot}/nnef-eventexposure/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnef-eventexposure + +paths: + /subscriptions: + post: + summary: subscribe to notifications + operationId: CreateIndividualSubscription + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NefEventExposureSubsc' + responses: + '201': + description: Success + content: + application/json: + schema: +``` + +``` + + $ref: '#/components/schemas/NefEventExposureSubsc' +headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnef-eventexposure//subscriptions/{subscriptionId} + required: true + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + myNotification: + "{$request.body#/notifUri}": + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NefEventExposureNotif' +responses: + '204': + description: No Content, Notification was successful + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}: + get: + summary: retrieve subscription + +``` + +``` +operationId: GetIndividualSubscription +tags: + - IndividualSubscription (Document) +parameters: + - name: subscriptionId + in: path + description: Event Subscription ID + required: true + schema: + type: string + - name: supp-feat + in: query + description: Features supported by the NF service consumer + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: OK. Resource representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/NefEventExposureSubsc' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +put: + summary: update subscription + operationId: ReplaceIndividualSubscription + tags: + - IndividualSubscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NefEventExposureSubsc' + parameters: + - name: subscriptionId + in: path + description: Event Subscription ID + required: true + schema: + type: string + responses: + '200': + description: OK. Resource was successfully modified and representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/NefEventExposureSubsc' + '204': + description: No Content. Resource was successfully modified + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: unsubscribe from notifications + operationId: DeleteIndividualSubscription + tags: + - IndividualSubscription (Document) + parameters: + - name: subscriptionId + in: path + description: Event Subscription ID + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnef-eventexposure: Access to the Nnef_EventExposure API + +schemas: + NefEventExposureSubsc: + description: Represents an Individual Network Exposure Event Subscription resource. +``` + +``` + +type: object +properties: + dataAccProfId: + type: string + eventsSubs: + type: array + items: + $ref: '#/components/schemas/NefEventSubs' + minItems: 1 + eventsRepInfo: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifId: + type: string + eventNotifs: + type: array + items: + $ref: '#/components/schemas/NefEventNotification' + minItems: 1 + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +required: +- eventsSubs +- notifId +- notifUri + +NefEventExposureNotif: +description: > + Represents notifications on network exposure event(s) that occurred for an Individual +Network + Exposure Event Subscription resource. +type: object +properties: + notifId: + type: string + eventNotifs: + type: array + items: + $ref: '#/components/schemas/NefEventNotification' + minItems: 1 +required: +- notifId +- eventNotifs + +NefEventNotification: +description: Represents information related to an event to be reported. +type: object +properties: + event: + $ref: '#/components/schemas/NefEvent' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + svcExprcInfos: + type: array + items: + $ref: '#/components/schemas/ServiceExperienceInfo' + minItems: 1 + ueMobilityInfos: + type: array + items: + $ref: '#/components/schemas/UeMobilityInfo' + minItems: 1 + ueCommInfos: + type: array + items: + $ref: '#/components/schemas/UeCommunicationInfo' + minItems: 1 + excepInfos: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/ExceptionInfo' + minItems: 1 + congestionInfos: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/UserDataCongestionCollection' + minItems: 1 + +``` + +``` +perfDataInfos: + type: array + items: + $ref: '#/components/schemas/PerformanceDataInfo' + minItems: 1 +dispersionInfos: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/DispersionCollection' + minItems: 1 +collBhvrInfos: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/CollectiveBehaviourInfo' + minItems: 1 +msQoeMetrInfos: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/MsQoeMetricsCollection' + minItems: 1 + deprecated: true +msQoeMetrics: + type: array + items: + $ref: 'TS26512_EventExposure.yaml#/components/schemas/QoEMetricsCollection' + minItems: 1 + description: Represents the Media Streaming QoE metrics event notification. +msConsumpInfos: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/MsConsumptionCollection' + minItems: 1 + deprecated: true +msConsumpReports: + type: array + items: + $ref: + 'TS26512_EventExposure.yaml#/components/schemas/ConsumptionReportingUnitsCollection' + minItems: 1 + description: Represents the Media Streaming Consumption event notification. +msNetAssInvInfos: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/MsNetAssInvocationCollection' + minItems: 1 + deprecated: true +msNetAssistInvocation: + type: array + items: + $ref: + 'TS26512_EventExposure.yaml#/components/schemas/NetworkAssistanceInvocationsCollection' + minItems: 1 + description: > + Represents the Media Streaming Network Assistance Invocations event notification. +msDynPlyInvInfos: + type: array + items: + $ref: + 'TS29517_Naf_EventExposure.yaml#/components/schemas/MsDynPolicyInvocationCollection' + minItems: 1 + deprecated: true +msDynPlyInvocation: + type: array + items: + $ref: + 'TS26512_EventExposure.yaml#/components/schemas/DynamicPolicyInvocationsCollection' + minItems: 1 + description: Represents the Media Streaming Dynamic Policy Invocations event notification. +msAccActInfos: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/MsAccessActivityCollection' + minItems: 1 + deprecated: true +msAccess: + type: array + items: + $ref: 'TS26512_EventExposure.yaml#/components/schemas/MediaStreamingAccessesCollection' +``` + +``` + minItems: 1 + description: Represents the Media Streaming access event notification. + gnssAssistDataInfo: + $ref: '#/components/schemas/GNSSAssistDataInfo' + datVolTransTimeInfos: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/DatVolTransTimeCollection' + minItems: 1 + required: + - event + - timeStamp + +NefEventSubs: + description: Represents an event to be subscribed and the related event filter information. + type: object + properties: + event: + $ref: '#/components/schemas/NefEvent' + eventFilter: + $ref: '#/components/schemas/NefEventFilter' + required: + - event + +NefEventFilter: + description: Represents event filter information for an event. + type: object + properties: + tgtUe: + $ref: '#/components/schemas/TargetUeIdentification' + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + locArea: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + collAttrs: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/CollectiveBehaviourFilter' + minItems: 1 + required: + - tgtUe + +TargetUeIdentification: + description: Identifies the UE to which the request applies. + type: object + properties: + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + interGroupIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + anyUeId: + type: boolean + ueIpAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + +ServiceExperienceInfo: + description: Contains service experience information associated with an application. + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + svcExpPerFlows: + type: array + items: +``` + +``` + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/ServiceExperienceInfoPerFlow' + minItems: 1 + contrWeights: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + minItems: 1 + required: + - svcExpPerFlows + +UeMobilityInfo: + description: > + Contains UE mobility information associated with an application. If the "appId" attribute is + not present, then indicates the collected UE mobility information is applicable to all the + applications for the UE. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + ueTrajs: + type: array + items: + $ref: '#/components/schemas/UeTrajectoryInfo' + minItems: 1 + areas: + type: array + items: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + minItems: 1 + required: + - supi + - ueTrajs + +UeCommunicationInfo: + description: Contains UE communication information associated with an application. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + interGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + comms: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/CommunicationCollection' + minItems: 1 + required: + - comms + +UeTrajectoryInfo: + description: Contains UE trajectory information. + type: object + properties: + ts: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + location: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + required: + - ts + - location + +PerformanceDataInfo: + description: Contains Performance Data Analytics related information collection. + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + ueIpAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + ipTrafficFilter: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + userLoc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + appLocs: +``` + +``` + + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + asAddr: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AddrFqdn' + perfData: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/PerformanceData' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - perfData + - timeStamp + +GNSSAssistDataInfo: + description: Represents GNSS Assistance Data related information. + type: object + properties: + gnssAssistData: + $ref: '#/components/schemas/GNSSAssistData' + servArea: + $ref: '#/components/schemas/GNSSServArea' + sourceInfo: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicalCoordinates' + required: + - gnssAssistData + - servArea + +GNSSServArea: + description: Represents the serving area of the GNSS Assistance Data. + type: object + properties: + geographicalArea: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + tailList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + oneOf: + - required: [geographicalArea] + - required: [tailList] + +``` + +#### # Simple data types and Enumerations + +``` + +NefEvent: + + anyOf: + - type: string + enum: + - SVC_EXPERIENCE + - UE_MOBILITY + - UE_COMM + - EXCEPTIONS + - USER_DATA_CONGESTION + - PERF_DATA + - DISPERSION + - COLLECTIVE_BEHAVIOUR + - MS_QOE_METRICS + - MS_CONSUMPTION + - MS_NET_ASSIST_INVOCATION + - MS_DYN_POLICY_INVOCATION + - MS_ACCESS_ACTIVITY + - GNSS_ASSISTANCE_DATA + - DATA_VOLUME_TRANSFER_TIME + - type: string + description: > + 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. + description: | + Represents a Network Exposure Event. + Possible values are: + - SVC_EXPERIENCE: Indicates that the subscribed/notified event is service experience + information for an application. + - UE_MOBILITY: Indicates that the subscribed/notified event is UE mobility information. + - UE_COMM: Indicates that the subscribed/notified event is UE communication information. + - EXCEPTIONS: Indicates that the subscribed/notified event is exceptions information. + - USER_DATA_CONGESTION: Indicates that the subscribed/notified event is user data congestion + +``` + +- analytics related information. +- PERF\_DATA: Indicates that the subscribed/notified event is performance data information. +- DISPERSION: Indicates that the subscribed/notified event is dispersion information. +- COLLECTIVE\_BEHAVIOUR: Indicates that the subscribed/notified event is collective behaviour information. +- MS\_QOE\_METRICS: Indicates that the subscribed/notified event is Media Streaming QoE metrics. +- MS\_CONSUMPTION: Indicates that the subscribed/notified event is Media Streaming consumption reports. +- MS\_NET\_ASSIST\_INVOCATION: Indicates that the subscribed/notified event is Media Streaming network assistance invocation. +- MS\_DYN\_POLICY\_INVOCATION: Indicates that the subscribed/notified event is Media Streaming dynamic policy invocation. +- MS\_ACCESS\_ACTIVITY: Indicates that the subscribed/notified event is Media Streaming access activity. +- GNSS\_ASSISTANCE\_DATA: Indicates that the subscribed/notified event is GNSS Assistance Data Collection. + +``` + +GNSSAssistData: + type: string + description: > + Represents GNSS Assistance Data encoded as specified in clause 6.5.2.1 of + 3GPP TS 37.355 [31]. + +``` + +## A.3 Nnef\_EASDeployment API + +openapi: 3.0.0 + +``` + +info: + title: Nnef_EASDeployment + version: 1.1.0-alpha.3 + description: | + NEF EAS Deployment service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.591 V18.2.0; 5G System; Network Exposure Function Southbound Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.591/ + +servers: + - url: '{apiRoot}/nnef-eas-deployment/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnef-eas-deployment + +paths: + /subscriptions: + post: + summary: subscribe to notifications + operationId: CreateIndividualSubscription + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EasDeploySubData' + responses: + '201': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/EasDeploySubData' + headers: + Location: + +``` + +``` + +description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nnef-eas-deployment/{apiVersion}/subscriptions/{subscriptionId}. +required: true +schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + notifUri: + '{ $request.body#/notifUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EasDeployInfoNotif' +responses: + '204': + description: No Content, Notification was successful + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}: + get: + summary: retrieve subscription + operationId: GetIndividualSubscription + tags: + - IndividualSubscription (Document) + +``` + +``` +parameters: + - name: subscriptionId + in: path + description: Event Subscription ID + required: true + schema: + type: string +responses: + '200': + description: OK. Resource representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/EasDeploySubData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: unsubscribe from notifications + operationId: DeleteIndividualSubscription + tags: + - IndividualSubscription (Document) + parameters: + - name: subscriptionId + in: path + description: Event Subscription ID + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +``` + +``` +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnef-eas-deployment: Access to the Nnef_EASDeployment API + +schemas: + EasDeploySubData: + description: Represents an Individual EAS Deployment Event Subscription resource. + type: object + properties: + appId: + type: string + dnnSnssaiInfos: + type: array + items: + $ref: 'TS29522_AMInfluence.yaml#/components/schemas/DnnSnssaiInformation' + minItems: 1 + description: Each of the element identifies a (DNN, S-NSSAI) combination. + eventId: + $ref: '#/components/schemas/EasEvent' + eventsNotifs: + type: array + items: + $ref: '#/components/schemas/EasDeployInfoData' + minItems: 1 + description: > + Represents the EAS Deployment Information changes event(s) to be reported. + Shall only be present if the "immRep" attribute is included and sets to true, + and the current status of EAS Deployment Information is available. + immRep: + type: boolean + description: > + Indication of immediate reporting. Set to true: requires the immediate reporting of the + current status of EAS Deployment Information, if available. Set to false (default): EAS + Deployment Information event report occurs when the event is met. + interGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + notifId: + type: string + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + required: + - eventId + - notifId + - notifUri + + EasDeployInfoNotif: + description: > + Represents notifications on EAS Deployment Information changes event(s) that occurred for an + Individual EAS Deployment Event Subscription resource. + type: object + properties: + easDepNotifs: + type: array + items: + $ref: '#/components/schemas/EasDepNotification' + minItems: 1 + notifId: + type: string + required: + - easDepNotifs + - notifId + + EasDepNotification: + description: Represents the EAS Deployment Notification. + type: object + properties: + easDepInfo: + $ref: '#/components/schemas/EasDeployInfoData' + eventId: + $ref: '#/components/schemas/EasEvent' + required: + - easDepInfo +``` + +``` + +- eventId + +EasDeployInfoData: + description: Represents the EAS Deployment Information to be reported. + type: object + properties: + appId: + type: string + dnaiInfos: + type: object + additionalProperties: + $ref: 'TS29522_EASDeployment.yaml#/components/schemas/DnaiInformation' + minProperties: 1 + description: > + list of DNS server identifier (consisting of IP address and port) and/or IP address(s) + of the EAS in the local DN for each DNAI. The key of map is the DNAI. + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + fqdnPatternList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/FqdnPatternMatchingRule' + minItems: 1 + internalGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + targetAfId: + type: string + description: > + Identifier of the AF that is responsible for the EAS associated with this EAS + deployment information. + required: + - fqdnPatternList + +# Simple data types and Enumerations + +EasEvent: + anyOf: + - type: string + enum: + - EAS_INFO_CHG + - type: string + description: | + Represents the EAS event. + Possible values are: + - EAS_INFO_CHG: Indicates that the EAS Deployment Information is changed. + +``` + +## A.4 Nnef\_TrafficInfluenceData API + +``` + +openapi: 3.0.0 +info: + title: Nnef_TrafficInfluenceData + version: 1.0.0-alpha.3 + description: | + NEF Traffic Influence Data Service. + © 2023 , 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: > + 3GPP TS 29.591 V18.4.0; 5G System; Network Exposure Function Southbound Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.591/ +servers: +- url: '{apiRoot}/nnef-traffic-influence-data/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 +security: +- {} +- oAuth2ClientCredentials: + - nnef-traffic-influence-data +paths: + + /subscriptions: + +``` + +``` + +post: + summary: subscribe to notifications + operationId: CreateIndividualSubscription + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluDataSub' + responses: + '201': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluDataSub' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnelf-traffic-influence-data//subscriptions/{subscriptionId} + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + myNotification: + '{ $request.body#/notifUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluDataNotify' + responses: + '204': + description: No Content, Notification was successful + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +get: + summary: read all of the active subscriptions + operationId: ReadAllSubscriptions + tags: + - Traffic Influence Data + parameters: + - name: dnn + in: query + description: Identifies a DNN. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - name: snssai + in: query + description: Identifies a slice. + required: false + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + - name: internal-Group-Id + in: query + description: Identifies a group of users. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + - name: supi + in: query + description: Identifies a user. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + responses: + '200': + description: OK. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TrafficInfluDataSub' + '204': + description: No Content. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +``` + +``` + +/subscriptions/{subscriptionId}: + get: + summary: retrieve subscription + operationId: GetIndividualSubscription + tags: + - IndividualSubscription (Document) + parameters: + - name: subscriptionId + in: path + description: Subscription ID + required: true + schema: + type: string + responses: + '200': + description: OK. Resource representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluDataSub' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + put: + summary: update subscription + operationId: ReplaceIndividualSubscription + tags: + - IndividualSubscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluDataSub' + parameters: + - name: subscriptionId + in: path + description: Subscription ID + required: true + schema: + type: string + responses: + '200': + description: OK. Resource was successfully modified and representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluDataSub' + '204': + description: No Content. Resource was successfully modified + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + +``` + +``` +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: unsubscribe from notifications + operationId: DeleteIndividualSubscription + tags: + - IndividualSubscription (Document) + parameters: + - name: subscriptionId + in: path + description: Subscription ID + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnef-traffic-influence-data: Access to the Nnef_TrafficInfluenceData API + schemas: + TrafficInfluDataSub: + description: Represents an Individual traffic influence subscription data. + type: object + properties: + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifCorrId: + type: string +``` + +``` + + description: Notification correlation identifier. + dnns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + description: Each element identifies a DNN. + snssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + description: Each element identifies a slice. + internalGroupIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + description: Each element identifies a group of users. + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + description: Each element identifies the user. + anyUe: + type: boolean + description: > + Identifies any UE when setting to "true". Default value is "false" if omitted. + rptInfo: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + immReports: + type: array + items: + $ref: 'TS29519_Application_Data.yaml#/components/schemas/TrafficInfluData' + minItems: 1 + description: Immediate report with Traffic Influence Data that match this subscription. + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - notifUri + - notifCorrId + anyOf: + - required: [dnns] + - required: [snssais] + - required: [internalGroupIds] + - required: [supis] + - required: [anyUe] + +TrafficInfluDataNotify: + description: Represents notifications for traffic influence data. + type: object + properties: + notifCorrId: + type: string + description: Notification correlation identifier. + eventNotifications: + type: array + items: + $ref: 'TS29519_Application_Data.yaml#/components/schemas/TrafficInfluData' + minItems: 1 + description: Notifications about Individual Events. + required: + - notifCorrId + - eventNotifications + +``` + +## A.5 Nnef\_ECSAddress API + +``` + +openapi: 3.0.0 +info: + title: Nnef_ECSAddressConfigurationInformation + version: 1.0.0-alpha.2 + description: | + NEF ECS Address Service. + +``` + +``` + +© 2023 , 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. +externalDocs: + description: > + 3GPP TS 29.591 V18.3.0; 5G System; Network Exposure Function Southbound Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.591/ +servers: + - url: '{apiRoot}/nnef-ecs-addr-cfg-info/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 +security: + - {} + - oAuth2ClientCredentials: + - nnef-ecs-addr-cfg-info +paths: + + /subscriptions: + post: + summary: subscribe to notifications + operationId: CreateIndividualSubscription + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EcsAddrCfgInfoSub' + responses: + '201': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/EcsAddrCfgInfoSub' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnef-ecs-addr-cfg-info/{apiVersion}/subscriptions/{subscriptionId} + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + myNotification: + '{$request.body#/notifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + +``` + +``` + + $ref: '#/components/schemas/EcsAddrCfgInfoNotification' + responses: + '204': + description: No Content, Notification was successfull + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}: + get: + summary: retrieve subscription + operationId: GetIndividualSubscription + tags: + - IndividualSubscription (Document) + parameters: + - name: subscriptionId + in: path + description: Subscription ID + required: true + schema: + type: string + responses: + '200': + description: OK. Resource representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/EcsAddrCfgInfoSub' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + put: + +``` + +``` +summary: update subscription +operationId: ReplaceIndividualSubscription +tags: + - IndividualSubscription (Document) +requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EcsAddrCfgInfoSub' +parameters: + - name: subscriptionId + in: path + description: Subscription ID + required: true + schema: + type: string +responses: + '200': + description: OK. Resource was successfully modified and representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/EcsAddrCfgInfoSub' + '204': + description: No Content. Resource was successfully modified + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: unsubscribe from notifications + operationId: DeleteIndividualSubscription + tags: + - IndividualSubscription (Document) + parameters: + - name: subscriptionId + in: path + description: Subscription ID + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnef-ecs-addr-cfg-info: Access to the Nnef_ECSAddress API +schemas: + EcsAddrCfgInfoSub: + description: Represents an Individual ECS Address Configuration Information subscription data. + type: object + properties: + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifCorrId: + type: string + description: Notification correlation identifier. + dnns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + description: Each element identifies a DNN. + snssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + description: Each element identifies a slice. + internalGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + immRepInd: + type: boolean + description: > + Indication of immediate reporting. If included, when it is set to true it indicates + immediate reporting of the subscribed events, if available. Otherwise, reporting will + occur when the event is met. + immReports: + type: array + items: + $ref: '#/components/schemas/EcsAddrCfgInfoNotification' + minItems: 1 + description: Immediate report with ECS Address Configuration Information that + match this subscription. + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - notifUri + - notifCorrId + + EcsAddrCfgInfoNotification: + description: Represents notifications for ECS Address Configuration Information data. + type: object + properties: + notifCorrId: + type: string + description: Notification correlation identifier. + ecsAddrCfgInfo: + type: array + items: + type: string + minItems: 1 + description: Contains the ECS Address Configuration Information. + +``` + +``` +required: +- notifCorrId +- ecsAddrCfgInfo +``` + +--- + +## A.6 Nnef\_DNAIMapping API + +``` +openapi: 3.0.0 +info: + title: Nnef_DNAIMapping + version: 1.0.0-alpha.1 + description: | + NEF DNAI Mapping Service. + © 2023 , 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: > + 3GPP TS 29.591 V18.3.0; 5G System; Network Exposure Function Southbound Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.591/ +servers: +- url: '{apiRoot}/nnef-dnai-mapping/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 +security: +- {} +- oAuth2ClientCredentials: +- nnef-dnai-mapping +paths: + +/subscriptions: + post: + summary: subscribe to notifications + operationId: CreateIndividualSubscription + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29522_DNAIMapping.yaml#/components/schemas/DnaiMapSub' + responses: + '201': + description: Success + content: + application/json: + schema: + $ref: 'TS29522_DNAIMapping.yaml#/components/schemas/DnaiMapSub' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnef-dnai-mapping//subscriptions/{subscriptionId} + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +``` + +``` + + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + myNotification: + '{ $request.body#/notifUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29522_DNAIMapping.yaml#/components/schemas/DnaiMapUpdateNotif' + responses: + '204': + description: No Content, Notification was successfull + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}: + get: + summary: retrieve subscription + operationId: GetIndividualSubscription + tags: + - IndividualSubscription (Document) + parameters: + - name: subscriptionId + in: path + description: Subscription ID + required: true + schema: + type: string + responses: + '200': + description: OK. Resource representation is returned + content: + application/json: + schema: + $ref: 'TS29522_DNAIMapping.yaml#/components/schemas/DnaiMapSub' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + +``` + +``` + + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: unsubscribe from notifications + operationId: DeleteIndividualSubscription + tags: + - IndividualSubscription (Document) + parameters: + - name: subscriptionId + in: path + description: Subscription ID + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnef-dnai-mapping: Access to the Nnef_DNAIMapping API + +``` + +## A.7 Nnef\_UEId API + +``` + +openapi: 3.0.0 +info: + title: Nnef_UEId + version: 1.0.0-alpha.1 + description: | + NEF Traffic Correlation Service. + © 2023 , 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: > + 3GPP TS 29.591 V18.4.0; 5G System; Network Exposure Function Southbound Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.591/ + +``` + +``` +servers: + - url: '{apiRoot}/nnef-ueid/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 +security: + - {} + - oAuth2ClientCredentials: + - nnef-ueid + +paths: + /fetch: + post: + summary: fetch the Internal UE Identifier for roaming UE(s). + operationId: FetchUEId + tags: + - UE ID (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UEIdReq' + responses: + '200': + description: The requested information was returned successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/UEIdInfo' + '204': + description: No Content (The requested Internal UE Identifier does not exist.) + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnef-ueid: Access to the UE ID API + +schemas: + UEIdReq: + description: Contains parameters to request to fetch the Internal UE Identifier. + type: object + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + required: + - gpsi +``` + +``` +UeIdInfo: + description: Contains the UE ID Information. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + required: + - supi +``` + +--- + +## Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|----------|-----------|------|-----|-----|--------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-10 | CT3#106 | | | | | TS Skeleton | 0.0.0 | +| 2019-10 | CT3#106 | C3-194392 | | | | Removed some subclauses and editorial changes | 0.1.0 | +| 2019-10 | CT3#106 | | | | | Inclusion of C3-194271, C3-194396, C3-194397 and C3-194399. | 0.2.0 | +| 2019-11 | CT3#107 | | | | | Inclusion of C3-195234, C3-195235, C3-195236 and C3-195274. | 0.3.0 | +| 2020-02 | CT3#108e | | | | | Inclusion of C3-201284, C3-201288, C3-201367, C3-201368, C3-201370, C3-201407, C3-201409, C3-201413 and C3-201516. | 0.4.0 | +| 2020-03 | CT#87e | CP-200187 | | | | TS sent to plenary for approval | 1.0.0 | +| 2020-03 | CT#87e | CP-200187 | | | | TS approved by plenary | 16.0.0 | +| 2020-06 | CT#88e | CP-201234 | 0001 | 1 | F | Correction on resource usage | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0002 | | F | Data type used during event subscription | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0007 | 1 | F | Correction to service operation description | 16.1.0 | +| 2020-06 | CT#88e | CP-201244 | 0008 | 1 | F | Storage of YAML files in ETSI Forge | 16.1.0 | +| 2020-06 | CT#88e | CP-201210 | 0009 | 1 | F | Removal of Nnef_EventExposure service | 16.1.0 | +| 2020-06 | CT#88e | CP-201256 | 0011 | 1 | F | URI of the Nnef_EventExposure service | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0012 | | F | Event Reporting Information data usage | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0013 | | F | Support of immediate reporting | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0014 | | F | Supported features definition | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0015 | | F | Correction on the ueCommInfos | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0016 | | F | Applicabilities for UE communication | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0017 | 1 | F | Supported headers, Resource Data type and yaml mapping | 16.1.0 | +| 2020-06 | CT#88e | CP-201255 | 0018 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.1.0 | +| 2020-09 | CT#89e | CP-202066 | 0019 | 1 | F | Default value for eventsReplInfo attribute | 16.2.0 | +| 2020-09 | CT#89e | CP-202066 | 0022 | | F | Missed response code | 16.2.0 | +| 2020-09 | CT#89e | CP-202066 | 0023 | | F | Applicabilities of appIds and locArea | 16.2.0 | +| 2020-09 | CT#89e | CP-202084 | 0024 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.2.0 | +| 2020-12 | CT#90e | CP-203139 | 0025 | 1 | F | Essential Corrections and alignments | 16.3.0 | +| 2020-12 | CT#90e | CP-203139 | 0026 | | F | Storage of YAML files in 3GPP Forge | 16.3.0 | +| 2020-12 | CT#90e | CP-203139 | 0028 | 1 | F | Callback URI correction | 16.3.0 | +| 2020-12 | CT#90e | CP-203152 | 0030 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.3.0 | +| 2020-12 | CT#90e | CP-203130 | 0029 | 1 | F | Corrections to location area usage | 17.0.0 | +| 2021-03 | CT#91e | CP-210191 | 0032 | | F | Support Stateless NFs | 17.1.0 | +| 2021-03 | CT#91e | CP-210218 | 0033 | | F | OpenAPI reference | 17.1.0 | +| 2021-03 | CT#91e | CP-210230 | 0034 | 2 | F | Correction to location information usage | 17.1.0 | +| 2021-03 | CT#91e | CP-210221 | 0035 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI | 17.1.0 | +| 2021-03 | CT#91e | CP-210230 | 0036 | 1 | F | Adding description fields to the data types in the Nnef_EventExposure specific and reused Data Types tables | 17.1.0 | +| 2021-03 | CT#91e | CP-210230 | 0037 | 1 | F | Specifying the Applicability field for some data types in the Nnef_EventExposure Data Types tables | 17.1.0 | +| 2021-03 | CT#91e | CP-210220 | 0038 | | F | Optional header clarification | 17.1.0 | +| 2021-03 | CT#91e | CP-210206 | 0040 | | A | Resource URI correction | 17.1.0 | +| 2021-03 | CT#91e | CP-210240 | 0042 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.1.0 | +| 2021-06 | CT#92e | CP-211221 | 0043 | | B | Support of Mute reporting | 17.2.0 | +| 2021-06 | CT#92e | CP-211221 | 0044 | | B | Partitioning criteria for applying sampling in specific UE partitions in NEF event exposure | 17.2.0 | +| 2021-06 | CT#92e | CP-211220 | 0046 | 1 | A | Presence condition of eventsReplInfo attribute | 17.2.0 | +| 2021-06 | CT#92e | CP-211200 | 0048 | 1 | A | Redirection responses | 17.2.0 | +| 2021-06 | CT#92e | CP-211173 | 0049 | 2 | B | Extensions to User Data Congestion Analytics | 17.2.0 | +| 2021-06 | CT#92e | CP-211265 | 0051 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.2.0 | +| 2021-09 | CT#93e | CP-212220 | 0052 | | F | Resource URI correction on Nnef_EventExposure API | 17.3.0 | +| 2021-09 | CT#93e | CP-212245 | 0053 | 1 | B | Implementation for Performance Data event | 17.3.0 | +| 2021-09 | CT#93e | CP-212203 | 0054 | | B | Support UE data volume dispersion collection | 17.3.0 | +| 2021-09 | CT#93e | CP-214553 | 0055 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.3.0 | +| 2021-12 | CT#94e | CP-213227 | 0057 | 1 | F | Updates to User Data Congestion | 17.4.0 | +| 2021-12 | CT#94e | CP-213227 | 0058 | 1 | F | Updates to UE data volume dispersion collection | 17.4.0 | +| 2021-12 | CT#94e | CP-213227 | 0059 | 2 | F | Update of notification procedure with description of USER_DATA_CONGESTION and DISPERSION events | 17.4.0 | +| 2021-12 | CT#94e | CP-213233 | 0060 | | B | Clarification on Nnef_Authentication service | 17.4.0 | +| 2021-12 | CT#94e | CP-213223 | 0063 | | B | Procedures to support Nnef_EASDeployment_Subscribe service operation | 17.4.0 | +| 2021-12 | CT#94e | CP-213228 | 0061 | | B | Collective Behaviour Analytics | 17.4.0 | +| 2021-12 | CT#94e | CP-213246 | 0062 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.4.0 | +| 2022-03 | CT#95e | CP-220185 | 0064 | 3 | B | Procedures to support Nnef_EASDeployment_Unsubscribe service operation | 17.5.0 | +| 2022-03 | CT#95e | CP-220185 | 0065 | 4 | B | Procedures to support Nnef_EASDeployment_Notify service operation | 17.5.0 | +| 2022-03 | CT#95e | CP-220186 | 0067 | | B | Service Architecture for Nnef_EASDeployment service | 17.5.0 | +| 2022-03 | CT#95e | CP-220186 | 0068 | 1 | B | Update procedures to support Nnef_EASDeployment_Subscribe service operation | 17.5.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------------------------|--------| +| 2022-03 | CT#95e | CP-220186 | 0069 | 1 | B | API definition to support Nnef_EASDeployment service | 17.5.0 | +| 2022-03 | CT#95e | CP-220361 | 0070 | 2 | B | OpenAPI to support Nnef_EASDeployment service | 17.5.0 | +| 2022-03 | CT#95e | CP-220190 | 0071 | 1 | F | Corrections to Data Model of NEF Event Exposure service | 17.5.0 | +| 2022-03 | CT#95e | CP-220201 | 0072 | | F | Corrections to Nnef_EventExposure_Subscribe Service Operation | 17.5.0 | +| 2022-03 | CT#95e | CP-220185 | 0073 | 1 | F | Formatting of description fields | 17.5.0 | +| 2022-03 | CT#95e | CP-220194 | 0074 | | F | Update of info and externalDocs field | 17.5.0 | +| 2022-06 | CT#96 | CP-221126 | 0078 | 1 | F | Updates to EasDeploySubData data type | 17.6.0 | +| 2022-06 | CT#96 | CP-221155 | 0081 | 1 | F | Remove the apiVersion placeholder from the resource URI variables table | 17.6.0 | +| 2022-06 | CT#96 | CP-221127 | 0080 | 2 | F | Defining FQDN information for EAS deployment | 17.6.0 | +| 2022-06 | CT#96 | CP-221133 | 0079 | - | F | Muting notifications correction | 17.6.0 | +| 2022-06 | CT#96 | CP-221142 | 0082 | 1 | B | Support new NF service consumer in the Nnef_EventExposure API | 17.6.0 | +| 2022-06 | CT#96 | CP-221142 | 0083 | 1 | B | Support QoE metrics in NEF Event Exposure | 17.6.0 | +| 2022-06 | CT#96 | CP-221142 | 0084 | 1 | B | Support Consumption reports in NEF Event Exposure | 17.6.0 | +| 2022-06 | CT#96 | CP-221142 | 0085 | 1 | B | Support Network Assistance invocations in NEF Event Exposure | 17.6.0 | +| 2022-06 | CT#96 | CP-221142 | 0086 | 1 | B | Support Consumption reports in NEF Event Exposure | 17.6.0 | +| 2022-06 | CT#96 | CP-221142 | 0087 | 1 | B | Support Consumption reports in NEF Event Exposure | 17.6.0 | +| 2022-06 | CT#96 | CP-221152 | 0088 | - | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-09 | CT#97e | CP-222102 | 0094 | 1 | F | Missing description field for enumeration data types | 17.7.0 | +| 2022-09 | CT#97e | CP-222110 | 0089 | 1 | B | Updates to Media Streaming QoE metrics Event | 17.7.0 | +| 2022-09 | CT#97e | CP-222110 | 0090 | 1 | F | Updates to Media Streaming Consumption Event | 17.7.0 | +| 2022-09 | CT#97e | CP-222110 | 0091 | 1 | F | Updates to Media Streaming Network Assistance Invocation Event | 17.7.0 | +| 2022-09 | CT#97e | CP-222110 | 0092 | 1 | F | Updates to Media Streaming Dynamic Policy Event | 17.7.0 | +| 2022-09 | CT#97e | CP-222110 | 0093 | 1 | F | Updates to Media Streaming Access Event | 17.7.0 | +| 2022-09 | CT#97e | CP-222121 | 0095 | - | F | Update of info and externalDocs fields | 17.7.0 | +| 2022-12 | CT#98e | CP-223179 | 0097 | 1 | F | Corrections to procedures of MS Event Exposure | 17.8.0 | +| 2022-12 | CT#98e | CP-223179 | 0100 | - | F | Correct the data type of the attributeV | 17.8.0 | +| 2022-12 | CT#98e | CP-223179 | 0101 | - | F | Correct the events and features in the data structures | 17.8.0 | +| 2022-12 | CT#98e | CP-223191 | 0096 | - | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223198 | 0098 | - | F | Updates to introduce SMS service in NEF southbound API | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0099 | 1 | F | Corrections to UE Mobility event | 18.0.0 | +| 2022-12 | CT#98e | CP-223190 | 0104 | - | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230145 | 0106 | 1 | A | Adding DCCF and MFAF to the NF service consumers | 18.1.0 | +| 2023-03 | CT#99 | CP-230134 | 0108 | 1 | B | Updates to Data Type UeMobilityInfo for UE Mobility | 18.1.0 | +| 2023-03 | CT#99 | CP-230166 | 0109 | - | F | Correction of the description fields in enumerations | 18.1.0 | +| 2023-03 | CT#99 | CP-230125 | 0110 | 1 | B | Updates to support GNSS assistance data collection from AF via NEF | 18.1.0 | +| 2023-03 | CT#99 | CP-230162 | 0112 | - | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231127 | 0107 | 3 | B | Update to Data Type PerformanceDataInfo for DN Performance | 18.2.0 | +| 2023-06 | CT#100 | CP-231124 | 0111 | 2 | B | Improving the Correctness of Service Experience Predictions with Contribution Weights | 18.2.0 | +| 2023-06 | CT#100 | CP-231135 | 0113 | 1 | B | Adding target AF ID to the EAS deployment information | 18.2.0 | +| 2023-06 | CT#100 | CP-231137 | 0114 | 1 | B | Adding UE address to the target UE information | 18.2.0 | +| 2023-06 | CT#100 | CP-231125 | 0115 | 1 | B | Event muting enhancements for NEF event exposure | 18.2.0 | +| 2023-06 | CT#100 | CP-231137 | 0116 | 1 | B | Implementing required AF event filters | 18.2.0 | +| 2023-06 | CT#100 | CP-231131 | 0118 | 1 | F | Corrections to the description fields of the enumerations defined for the NEF southbound APIs | 18.2.0 | +| 2023-06 | CT#100 | CP-231166 | 0119 | 1 | F | Changing the feature name for the GNSS Assistance Data Collection functionality | 18.2.0 | +| 2023-06 | CT#100 | CP-231166 | 0120 | 1 | B | Continuing the definition of the content of the GNSS Assistance Data Collection information | 18.2.0 | +| 2023-06 | CT#100 | CP-231307 | 0121 | 1 | B | Define OpenAPI for the new TrafficInfluenceData API | 18.2.0 | +| 2023-06 | CT#100 | CP-231308 | 0122 | 1 | B | Define service description for the new TrafficInfluenceData API | 18.2.0 | +| 2023-06 | CT#100 | CP-231297 | 0123 | 4 | B | Definition of the new TrafficInfluenceData API | 18.2.0 | +| 2023-06 | CT#100 | CP-231154 | 0125 | - | A | Wrong attribute name for EAS deployment information | 18.2.0 | +| 2023-06 | CT#100 | CP-231154 | 0127 | - | A | EAS Deployment immediate reporting procedure correction | 18.2.0 | +| 2023-06 | CT#100 | CP-231128 | 0129 | 1 | B | Update to Nnef_EventExposure API for E2E Data Volume Transfer Time Analytics | 18.2.0 | +| 2023-06 | CT#100 | CP-231293 | 0130 | 1 | B | Definition of OpenAPI file for the new Nnef_ECSAddress API | 18.2.0 | +| 2023-06 | CT#100 | CP-231294 | 0131 | 1 | B | Definition of resource and data model for the new Nnef_ECSAddress API | 18.2.0 | +| 2023-06 | CT#100 | CP-231295 | 0132 | 1 | B | Definition of service description for the new Nnef_ECSAddress | 18.2.0 | +| 2023-06 | CT#100 | CP-231132 | 0133 | 1 | F | Corrections to the redirection mechanism description | 18.2.0 | +| 2023-06 | CT#100 | CP-231154 | 0134 | - | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232257 | 0135 | 1 | F | Data model corrections for TrafficInfluenceData and ECSAddress APIs | 18.3.0 | +| 2023-09 | CT#101 | CP-232086 | 0136 | - | F | Corrections to Nnef_EASDeployment service | 18.3.0 | +| 2023-09 | CT#101 | CP-232257 | 0140 | 1 | F | Corrections to Nnef_TrafficInfluenceData and Nnef_ECSAddress services | 18.3.0 | +| 2023-09 | CT#101 | CP-232095 | 0141 | 1 | B | Nnef_DNAIMapping service description and procedures | 18.3.0 | +| 2023-09 | CT#101 | CP-232095 | 0142 | 1 | B | Nnef_DNAIMapping API definitions | 18.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------------------------|--------| +| 2023-09 | CT#101 | CP-232095 | 0143 | 1 | B | Nnef_DNAIMapping OpenAPI file definitions | 18.3.0 | +| 2023-09 | CT#101 | CP-232106 | 0145 | - | A | aligning the name of internalGroupId attribute | 18.3.0 | +| 2023-09 | CT#101 | CP-232257 | 0146 | 1 | F | Complete description for EDGE_Ph2 | 18.3.0 | +| 2023-09 | CT#101 | CP-232257 | 0147 | 1 | F | Correction on immediate report for Nnef_TrafficInfluenceData Service | 18.3.0 | +| 2023-09 | CT#101 | CP-232180 | 0148 | 1 | F | Corrections to Nnef_ECSAddress Service | 18.3.0 | +| 2023-09 | CT#101 | CP-232109 | 0149 | 1 | F | Corrections to GNSS Assistance Data Collection | 18.3.0 | +| 2023-09 | CT#101 | CP-232085 | 0151 | | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-12 | CT#102 | CP-233239 | 0137 | 2 | B | Nnef_UEId service descriptions supporting HR-SBO | 18.4.0 | +| 2023-12 | CT#102 | CP-233239 | 0138 | 1 | B | Nnef_UEId API definitions | 18.4.0 | +| 2023-12 | CT#102 | CP-233239 | 0139 | 2 | B | Nnef_UEId API OpenAPI file definitions | 18.4.0 | +| 2023-12 | CT#102 | CP-233239 | 0152 | 1 | F | Remove the EN for the Traffic Influence Data Subscription | 18.4.0 | +| 2023-12 | CT#102 | CP-233262 | 0153 | 1 | B | Complete the definition of the content of the GNSS Assistance Data Collection information | 18.4.0 | +| 2023-12 | CT#102 | CP-233277 | 0159 | - | A | Correct the data type of eventNotifs | 18.4.0 | +| 2023-12 | CT#102 | CP-233239 | 0160 | - | F | Data types of error responses for TrafficInfluenceData | 18.4.0 | +| 2023-12 | CT#102 | CP-233249 | 0161 | - | B | Updates in the DNAIMapping procedure | 18.4.0 | +| 2023-12 | CT#102 | CP-233239 | 0163 | 1 | F | Correction to Traffic Influence Data change notification procedure | 18.4.0 | +| 2023-12 | CT#102 | CP-233249 | 0164 | - | F | Incorrect description of error handling in subscription creation procedure | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0165 | - | F | Missing applicable feature for appId | 18.4.0 | +| 2023-12 | CT#102 | CP-233229 | 0167 | 1 | B | ProblemDetails RFC 7807 obsoleted by RFC 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233229 | 0168 | 1 | B | Updating the obsoleted IETF HTTP RFC | 18.4.0 | +| 2023-12 | CT#102 | CP-233137 | 0169 | 1 | B | Update the data types of the Media Steaming attributes | 18.4.0 | +| 2023-12 | CT#102 | CP-233238 | 0170 | - | F | Update of info and externalDocs fields | 18.4.0 | \ No newline at end of file diff --git a/marked/Rel-18/37_series/37107/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/37_series/37107/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..87253f6beaf9c4ca08f8b517e8fd6df399051c8b --- /dev/null +++ b/marked/Rel-18/37_series/37107/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:69a6f4d9b2ddbc427e2845e410d4802946c4188b93eb4accfe7a4bd1aae41663 +size 9899 diff --git a/marked/Rel-18/37_series/37107/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/37_series/37107/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5793fee9744c9b5bb46d8891f962a8f7d3cab103 --- /dev/null +++ b/marked/Rel-18/37_series/37107/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6e2cc641cb453377555bba4c19ecbb47266e6f8de0a3e52a28fdae2f00848d85 +size 5236 diff --git a/marked/Rel-18/37_series/37145-2/09955ff8214ffb6947951fc0f60eb6ab_img.jpg b/marked/Rel-18/37_series/37145-2/09955ff8214ffb6947951fc0f60eb6ab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8ecc655e26c927d0c0185369f291fac987422232 --- /dev/null +++ b/marked/Rel-18/37_series/37145-2/09955ff8214ffb6947951fc0f60eb6ab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0242c4d2e51b54075192df233a01e544d58cde981c16c56519212a1106ed85d1 +size 44836 diff --git a/marked/Rel-18/37_series/37145-2/71440aab73c3d21521dba3a413e3a7ca_img.jpg b/marked/Rel-18/37_series/37145-2/71440aab73c3d21521dba3a413e3a7ca_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dd76f74980f10f14e616759707026262c63ab84e --- /dev/null +++ b/marked/Rel-18/37_series/37145-2/71440aab73c3d21521dba3a413e3a7ca_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6b17dc87a9d3f6933b3e8a82ed2b46a041631973b52071030b29ae9a8c6e9823 +size 49299 diff --git a/marked/Rel-18/37_series/37145-2/8b6f7b51bc160aa80e286e818baa7998_img.jpg b/marked/Rel-18/37_series/37145-2/8b6f7b51bc160aa80e286e818baa7998_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..71c7b09fdebdbc95050278cf077425c4f13fc0a8 --- /dev/null +++ b/marked/Rel-18/37_series/37145-2/8b6f7b51bc160aa80e286e818baa7998_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:903b934bf4d0bdf36913e9c2ce146ef4e0c760cfe26f675a397120fa2e1e7072 +size 89022 diff --git a/marked/Rel-18/37_series/37145-2/b664da64b7121b86310de02c98642405_img.jpg b/marked/Rel-18/37_series/37145-2/b664da64b7121b86310de02c98642405_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fdb6606b7bde7b42c86bc15effeb1133ee2fbc8a --- /dev/null +++ b/marked/Rel-18/37_series/37145-2/b664da64b7121b86310de02c98642405_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:075ab62b9135a775d5ba0156e7ac016a138c258bcf84d521f22eb92d82af36a3 +size 80824 diff --git a/marked/Rel-18/37_series/37145-2/c0e1c8d37f9cd96595cb6370b1b5a8c7_img.jpg b/marked/Rel-18/37_series/37145-2/c0e1c8d37f9cd96595cb6370b1b5a8c7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..89b859a0f70069f4e8b305567ea5c43c90fb02c0 --- /dev/null +++ b/marked/Rel-18/37_series/37145-2/c0e1c8d37f9cd96595cb6370b1b5a8c7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f9b57cd175b7cbfb5af9641f8b6dad37a3bbdb847e0b2afcd38d749e3fa73a94 +size 73930 diff --git a/marked/Rel-18/37_series/37145-2/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg b/marked/Rel-18/37_series/37145-2/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d99b87c91f1de40ce08a23b46bd3bef7c5a40ca0 --- /dev/null +++ b/marked/Rel-18/37_series/37145-2/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7ed8fa7c9b275b45a00686a8d871a3503af1e53eb7b8f0c407519174ec6805c7 +size 60520 diff --git a/marked/Rel-18/37_series/37145-2/eb450c92214e8409c1e0f0846e30d876_img.jpg b/marked/Rel-18/37_series/37145-2/eb450c92214e8409c1e0f0846e30d876_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..763f0f50a4e8245a2241f5ea112ff404690d49e3 --- /dev/null +++ b/marked/Rel-18/37_series/37145-2/eb450c92214e8409c1e0f0846e30d876_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aa785b3518171b563fbabfd86117b5293686ba2841065d484e785653deb77c0e +size 46325 diff --git a/marked/Rel-18/37_series/37145-2/fcc757566216206ceddbd6c775e8db02_img.jpg b/marked/Rel-18/37_series/37145-2/fcc757566216206ceddbd6c775e8db02_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..55f99daeab42d83b893950be9a24b6bf43e913c1 --- /dev/null +++ b/marked/Rel-18/37_series/37145-2/fcc757566216206ceddbd6c775e8db02_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:81919c02cd2dbc02b1f37493ef8701159c1597bc2f5c1e18d3032637d05615bf +size 57552 diff --git a/marked/Rel-18/37_series/37145-2/febfdd6a7182116484c126105b53fdaf_img.jpg b/marked/Rel-18/37_series/37145-2/febfdd6a7182116484c126105b53fdaf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3c606610cbdc8c5ef6b11fac4f0eb35dc9fdf361 --- /dev/null +++ b/marked/Rel-18/37_series/37145-2/febfdd6a7182116484c126105b53fdaf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e5a10cb58a658356d306c610d9d089d47fe2b8d02e92f67db0c1a2cc73125701 +size 82965 diff --git a/marked/Rel-18/37_series/37213/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/37_series/37213/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7c96de11c2e607cb141727c7a695baee984487f0 --- /dev/null +++ b/marked/Rel-18/37_series/37213/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2d804e3b74a3eb21d99f5733a7e0652936b16309f2924a96ae56ad800408879a +size 9635 diff --git a/marked/Rel-18/37_series/37213/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/37_series/37213/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0ad8a42d305eb60ae0eae79213fe27530a56f816 --- /dev/null +++ b/marked/Rel-18/37_series/37213/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:71b955a746a3029595390f481df96d57e030c236f73a499985b542a63c61430f +size 7171 diff --git a/marked/Rel-18/37_series/37472/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/37_series/37472/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b99a545ba093cd5fc087571c3ab3949da00f608b --- /dev/null +++ b/marked/Rel-18/37_series/37472/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3e7a280ab7adb377e4cec4f1d13f30ad3cc449111748001f1f58c226c61c0389 +size 9499 diff --git a/marked/Rel-18/37_series/37472/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/37_series/37472/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..08bc8fb77c34f38a27bc90198e5e9af64fec8499 --- /dev/null +++ b/marked/Rel-18/37_series/37472/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:857222b10b3b68fd2eb1528bca459cbe359a788b0985cbb102be9b79f96e6362 +size 6300 diff --git a/marked/Rel-18/37_series/37472/c9d8a18a6137ad054b841d7a614afb48_img.jpg b/marked/Rel-18/37_series/37472/c9d8a18a6137ad054b841d7a614afb48_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2cce1e84ad65d550ea8f033aba664c60fb754c69 --- /dev/null +++ b/marked/Rel-18/37_series/37472/c9d8a18a6137ad054b841d7a614afb48_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0a055c8214157a90b0c51b4b1bbf0784a4eb48362bd038c2dfd600b53323a2fd +size 19987 diff --git a/marked/Rel-18/37_series/37480/5e92d9e8e9ce204e405bff2367f88176_img.jpg b/marked/Rel-18/37_series/37480/5e92d9e8e9ce204e405bff2367f88176_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bc2dbe00b246a30ef9703ca2a9cccd16a90ea06f --- /dev/null +++ b/marked/Rel-18/37_series/37480/5e92d9e8e9ce204e405bff2367f88176_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:25176f7e0d8e54371246869d9f270587ddcccf5ab9da16e96a04ac49a65c5622 +size 22147 diff --git a/marked/Rel-18/37_series/37480/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/37_series/37480/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..917c8de2f1986e8b73026afb0f29c045a2e899b6 --- /dev/null +++ b/marked/Rel-18/37_series/37480/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2be5b5f8dc82b0ea46ce50f842a11e07152f697d75bb810f05723033b786ecfa +size 9581 diff --git a/marked/Rel-18/37_series/37480/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/37_series/37480/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0d413d15cf046d46ac9b31cb3f5865ccc79639cb --- /dev/null +++ b/marked/Rel-18/37_series/37480/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fe03788647836c455985efd56c7805682d17e6975c29327d2fd6939a118f306e +size 8100 diff --git a/marked/Rel-18/37_series/37481/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/37_series/37481/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d9d2513cf039cef9aac0def2bc9f0b4d23fbc565 --- /dev/null +++ b/marked/Rel-18/37_series/37481/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:04960319a82a56f29457c520fa5fb586775f78656972f5ca2c99a49ab8e07e46 +size 9536 diff --git a/marked/Rel-18/37_series/37481/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/37_series/37481/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..efb841de17ce990ac4e32f78f8f6f55d32e02c73 --- /dev/null +++ b/marked/Rel-18/37_series/37481/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c972d51cba27ecf84886c087ee11f2a761a488e067fa5e9daa5df57dcb8a0d8d +size 6931 diff --git a/marked/Rel-18/37_series/37877/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/37_series/37877/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..623b362cd02782b508a807030a378c0f620b9781 --- /dev/null +++ b/marked/Rel-18/37_series/37877/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:317a36aa8274171a8ae2e15d647a9a2bcb36cb49fc408ed3c964eeae7d1a83af +size 9335 diff --git a/marked/Rel-18/37_series/37877/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/37_series/37877/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..36c0b88af2dfdd519eab63f5dd43aee5eb8cef3c --- /dev/null +++ b/marked/Rel-18/37_series/37877/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:99a64ea3b7d5fbafbc4f7b6a07b346fa3ecc07479ea08dc72e5cc6da2a4aa3ca +size 5690 diff --git a/marked/Rel-18/37_series/37878/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/37_series/37878/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ab63acb2ed4f50412ba51bdf756acb9daf8de042 --- /dev/null +++ b/marked/Rel-18/37_series/37878/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:55fa5eecc6566f0f7f11bf9bf30066970efc60dca8652960fe5841000fa6ff5e +size 10046 diff --git a/marked/Rel-18/37_series/37878/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/37_series/37878/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..965ead69cef12ba2d673705207be944ccbc76ea3 --- /dev/null +++ b/marked/Rel-18/37_series/37878/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:87026c58388ccc3d09dd7e519808db9ff59a6e8274f091363cf84f74d5584f58 +size 5678 diff --git a/marked/Rel-18/46_series/46001/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/46_series/46001/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..49e032514ff6def4abfe7ca23cb4de2b85fdbaaa --- /dev/null +++ b/marked/Rel-18/46_series/46001/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c4df7d7c3d0f4131a2222f851016a6204be2df3c55d76b2d8910e4b7eb62e056 +size 8724 diff --git a/marked/Rel-18/46_series/46001/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/46_series/46001/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ac55d01af2599d55f833d5ac4a047bba969f4e8c --- /dev/null +++ b/marked/Rel-18/46_series/46001/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1cb23fa3b12a8d1e9cb4b9293eb744fe8ec93ee9273094b1909b9cc693e510ca +size 14671 diff --git a/marked/Rel-18/46_series/46001/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-18/46_series/46001/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..18669b640499cbd89c6c995198a47a1fc41c1627 --- /dev/null +++ b/marked/Rel-18/46_series/46001/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ec0646f36a7cfbd3c90f4470e5791afb37df2f4010d59a8a705e76150c594e37 +size 162275 diff --git a/marked/Rel-18/46_series/46002/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/46_series/46002/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..53f02895082ddde9bdb6041fa97c106fb298e65a --- /dev/null +++ b/marked/Rel-18/46_series/46002/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c9cf755010d56bdc669490c3dc6b72fcc566976bed4f36b848f9e921e0a0a665 +size 8137 diff --git a/marked/Rel-18/46_series/46002/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/46_series/46002/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5b48dc45b7ff9add7a4dfa335943624ce583d6ac --- /dev/null +++ b/marked/Rel-18/46_series/46002/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ee64c94b3dcede42072af847fc974b62adcecefbb9ccbb84a64797c451e0e021 +size 15049 diff --git a/marked/Rel-18/46_series/46002/997233d405f0d4b89ddeb7683e047f66_img.jpg b/marked/Rel-18/46_series/46002/997233d405f0d4b89ddeb7683e047f66_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..162544a8f04bb42095347d3dfd79577eba16800c --- /dev/null +++ b/marked/Rel-18/46_series/46002/997233d405f0d4b89ddeb7683e047f66_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:98a16f20d2a11c41ab10c4cfb6d1e0a971697a40795d5bf138636301a24efe51 +size 161145 diff --git a/marked/Rel-18/46_series/46006/27b06ec9f42b5d727a2630f61a5f1861_img.jpg b/marked/Rel-18/46_series/46006/27b06ec9f42b5d727a2630f61a5f1861_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..565c49f0dadeacd5fb86c5400490bdd1ed359b89 --- /dev/null +++ b/marked/Rel-18/46_series/46006/27b06ec9f42b5d727a2630f61a5f1861_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:622833caf1f3bc3372e4378332cb34cc6ed1f0d78de1c9930661ee0297613da4 +size 44511 diff --git a/marked/Rel-18/46_series/46006/5a4e62bead259c258d069fd3663ea670_img.jpg b/marked/Rel-18/46_series/46006/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5e1bd1ded91cac04f1390dcc9a84d214594e2333 --- /dev/null +++ b/marked/Rel-18/46_series/46006/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fea5fc18aba9e7ce48049d3db128b9dc5aea197658adb16954ad9b87a5c1a6ed +size 77855 diff --git a/marked/Rel-18/46_series/46006/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/46_series/46006/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..82d6d00475be0c52ab1a566a54a9248fee6b1fc0 --- /dev/null +++ b/marked/Rel-18/46_series/46006/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ab548d9cd6e97e61dd3d06e76975e9d500c33099592fcf78c5c80e663e71aeed +size 8137 diff --git a/marked/Rel-18/46_series/46006/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/46_series/46006/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5b48dc45b7ff9add7a4dfa335943624ce583d6ac --- /dev/null +++ b/marked/Rel-18/46_series/46006/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ee64c94b3dcede42072af847fc974b62adcecefbb9ccbb84a64797c451e0e021 +size 15049 diff --git a/marked/Rel-18/46_series/46006/7e670a2b556b53ea9002dfff3a420e08_img.jpg b/marked/Rel-18/46_series/46006/7e670a2b556b53ea9002dfff3a420e08_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9a4bd4185fa2690cf6fe538f9ed0d4d79e3f212d --- /dev/null +++ b/marked/Rel-18/46_series/46006/7e670a2b556b53ea9002dfff3a420e08_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cf9850fd7b0af23b0b8b189ae686fa1d2371d06eae2b9e9c79557452aeaa3841 +size 59414 diff --git a/marked/Rel-18/46_series/46006/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-18/46_series/46006/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a717d632c6c3be80a8f0e7fc3013103e9c50593a --- /dev/null +++ b/marked/Rel-18/46_series/46006/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:724cd32c84366951d08c2ee6f01e7bfdfa85479b6aa2f4987293c145c722267f +size 103761 diff --git a/marked/Rel-18/46_series/46006/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg b/marked/Rel-18/46_series/46006/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b31f197875b1eaca164f986d52e9660f25eab076 --- /dev/null +++ b/marked/Rel-18/46_series/46006/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3c142faeb7a70eae09dd6fdf0299f38d5a0be9a83838f4c513b67ab6b0f3129e +size 57036 diff --git a/marked/Rel-18/46_series/46006/d0abac95583b52a3b35f74a215567334_img.jpg b/marked/Rel-18/46_series/46006/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4f0ef0e45e1cbabe9b70fe5829cc18016ddedddb --- /dev/null +++ b/marked/Rel-18/46_series/46006/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c28574e030e75fe5095ffb46a1a6772bc0016103a082150770742a3065f1f335 +size 163244 diff --git a/marked/Rel-18/46_series/46006/e6df2733626a85205c1db682e6259c46_img.jpg b/marked/Rel-18/46_series/46006/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..230f6dbf1f6bed38a8c4ddb9538e7729276926ff --- /dev/null +++ b/marked/Rel-18/46_series/46006/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f7f57f70653731b5275ed03e5cce27ea27e729ed1f846eff01e0498c4368135a +size 66565 diff --git a/marked/Rel-18/46_series/46007/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/46_series/46007/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d632d9ba7bb182048277aae2c87d722b1ec563e8 --- /dev/null +++ b/marked/Rel-18/46_series/46007/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3c811935c6190a2387693479e5bd00fd670373f14d1102cf2214a95e44e8b649 +size 9724 diff --git a/marked/Rel-18/46_series/46007/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/46_series/46007/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b01bbbffe54f01e01ba4502816e7abbeb8166209 --- /dev/null +++ b/marked/Rel-18/46_series/46007/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:43f53d0aaafb6fb6d2bc19a67c74073e656e7227ef7a02ceda7667ffe4d3de05 +size 15188 diff --git a/marked/Rel-18/46_series/46008/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/46_series/46008/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..688f013ce7572d93db2ff8d7abb7ee33cb8191ec --- /dev/null +++ b/marked/Rel-18/46_series/46008/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:048500dba2b82dedfc0c001f157299426517b43950d492276a7f4306f633bffc +size 8084 diff --git a/marked/Rel-18/46_series/46008/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/46_series/46008/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5b48dc45b7ff9add7a4dfa335943624ce583d6ac --- /dev/null +++ b/marked/Rel-18/46_series/46008/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ee64c94b3dcede42072af847fc974b62adcecefbb9ccbb84a64797c451e0e021 +size 15049 diff --git a/marked/Rel-18/46_series/46008/cbc4516eb885829fe8c9dabc0946dcbe_img.jpg b/marked/Rel-18/46_series/46008/cbc4516eb885829fe8c9dabc0946dcbe_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..714afb0926822da8394fd7ddcd5d06765ebff2a4 --- /dev/null +++ b/marked/Rel-18/46_series/46008/cbc4516eb885829fe8c9dabc0946dcbe_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:122f0a6fdb317fecd59871656104f609e2020661a07e885791ac50f9b346ca66 +size 31890 diff --git a/marked/Rel-18/46_series/46008/fc857414626a8d94d132e12d9afe52a4_img.jpg b/marked/Rel-18/46_series/46008/fc857414626a8d94d132e12d9afe52a4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7f55754faa292ed647b820de6f4bc2b392382ecc --- /dev/null +++ b/marked/Rel-18/46_series/46008/fc857414626a8d94d132e12d9afe52a4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9832ab5c5646f006ba31826b041aa7a6e206664c3cb0f07b080dfb3bbf3eae12 +size 56740 diff --git a/marked/Rel-18/46_series/46011/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/46_series/46011/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..53f02895082ddde9bdb6041fa97c106fb298e65a --- /dev/null +++ b/marked/Rel-18/46_series/46011/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c9cf755010d56bdc669490c3dc6b72fcc566976bed4f36b848f9e921e0a0a665 +size 8137 diff --git a/marked/Rel-18/46_series/46011/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/46_series/46011/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5b48dc45b7ff9add7a4dfa335943624ce583d6ac --- /dev/null +++ b/marked/Rel-18/46_series/46011/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ee64c94b3dcede42072af847fc974b62adcecefbb9ccbb84a64797c451e0e021 +size 15049 diff --git a/marked/Rel-18/46_series/46012/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/46_series/46012/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..53f02895082ddde9bdb6041fa97c106fb298e65a --- /dev/null +++ b/marked/Rel-18/46_series/46012/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c9cf755010d56bdc669490c3dc6b72fcc566976bed4f36b848f9e921e0a0a665 +size 8137 diff --git a/marked/Rel-18/46_series/46012/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/46_series/46012/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5b48dc45b7ff9add7a4dfa335943624ce583d6ac --- /dev/null +++ b/marked/Rel-18/46_series/46012/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ee64c94b3dcede42072af847fc974b62adcecefbb9ccbb84a64797c451e0e021 +size 15049 diff --git a/marked/Rel-18/46_series/46020/1eadbbe42cfcac5c0023577110aec5e3_img.jpg b/marked/Rel-18/46_series/46020/1eadbbe42cfcac5c0023577110aec5e3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..958baf6f94ac27ea3b6a317ef8686c71ac483f68 --- /dev/null +++ b/marked/Rel-18/46_series/46020/1eadbbe42cfcac5c0023577110aec5e3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:35228b3755d53409ab05e4c8b18a7fa49307f47452db465f463744981e772dd6 +size 36969 diff --git a/marked/Rel-18/46_series/46020/3db5d62ad46e33647ec2b1ad6d2703bb_img.jpg b/marked/Rel-18/46_series/46020/3db5d62ad46e33647ec2b1ad6d2703bb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5c409378cbdb149b65283405b5bd2e6cae472036 --- /dev/null +++ b/marked/Rel-18/46_series/46020/3db5d62ad46e33647ec2b1ad6d2703bb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:41d39db5da761eea6bfd3ed7164dcdd063fc9e2db572d9c8ec62ecf3cb7f3005 +size 88396 diff --git a/marked/Rel-18/46_series/46020/5e92d9e8e9ce204e405bff2367f88176_img.jpg b/marked/Rel-18/46_series/46020/5e92d9e8e9ce204e405bff2367f88176_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7fbbeef55782035b5140cb6fb9d83fa55c502711 --- /dev/null +++ b/marked/Rel-18/46_series/46020/5e92d9e8e9ce204e405bff2367f88176_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2f2d7cd3356a59da6bad38dcef33eccc25a2060ad91e969bde3348a60623819c +size 108330 diff --git a/marked/Rel-18/46_series/46020/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/46_series/46020/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..695c090bc4049761aa3c4addfe490883c6c6b991 --- /dev/null +++ b/marked/Rel-18/46_series/46020/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0afdf9c7a1c7e58b184cf7c82221bd552c195f9bf5d4a36fed702d079526ce32 +size 8727 diff --git a/marked/Rel-18/46_series/46020/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/46_series/46020/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ac55d01af2599d55f833d5ac4a047bba969f4e8c --- /dev/null +++ b/marked/Rel-18/46_series/46020/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1cb23fa3b12a8d1e9cb4b9293eb744fe8ec93ee9273094b1909b9cc693e510ca +size 14671 diff --git a/marked/Rel-18/46_series/46020/c923e830926610e73d6cbcdedb9e5ea4_img.jpg b/marked/Rel-18/46_series/46020/c923e830926610e73d6cbcdedb9e5ea4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b0bb9a5463dcd53ce1ec7a4eb242768acf7aad59 --- /dev/null +++ b/marked/Rel-18/46_series/46020/c923e830926610e73d6cbcdedb9e5ea4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:59d515751a5045002c311009155ed1c2a3611a27152cc5924539e2e1cfd7fd23 +size 23450 diff --git a/marked/Rel-18/46_series/46020/dd5771673aececa53d42ece89218299d_img.jpg b/marked/Rel-18/46_series/46020/dd5771673aececa53d42ece89218299d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..56213ed3433206eee3a2a8a0dd020ed23243365f --- /dev/null +++ b/marked/Rel-18/46_series/46020/dd5771673aececa53d42ece89218299d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bb92af493a5a4bddae146779a7e38790d1e568de82aa49e5cf3d60f3e3ca7e9b +size 82990 diff --git a/marked/Rel-18/46_series/46021/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/46_series/46021/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..53f02895082ddde9bdb6041fa97c106fb298e65a --- /dev/null +++ b/marked/Rel-18/46_series/46021/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c9cf755010d56bdc669490c3dc6b72fcc566976bed4f36b848f9e921e0a0a665 +size 8137 diff --git a/marked/Rel-18/46_series/46021/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/46_series/46021/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5b48dc45b7ff9add7a4dfa335943624ce583d6ac --- /dev/null +++ b/marked/Rel-18/46_series/46021/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ee64c94b3dcede42072af847fc974b62adcecefbb9ccbb84a64797c451e0e021 +size 15049 diff --git a/marked/Rel-18/46_series/46022/367926125450c2bc3f4bdca9d59a62ba_img.jpg b/marked/Rel-18/46_series/46022/367926125450c2bc3f4bdca9d59a62ba_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..eac4d8c1b30049ed1c01d3581db3af5e7c53d035 --- /dev/null +++ b/marked/Rel-18/46_series/46022/367926125450c2bc3f4bdca9d59a62ba_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fc6594f80ebebee32c819ab1534e24a050f6a123c5ca8ac2e06391a9e7b0cdf6 +size 60024 diff --git a/marked/Rel-18/46_series/46022/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/46_series/46022/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..82d6d00475be0c52ab1a566a54a9248fee6b1fc0 --- /dev/null +++ b/marked/Rel-18/46_series/46022/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ab548d9cd6e97e61dd3d06e76975e9d500c33099592fcf78c5c80e663e71aeed +size 8137 diff --git a/marked/Rel-18/46_series/46022/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/46_series/46022/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5b48dc45b7ff9add7a4dfa335943624ce583d6ac --- /dev/null +++ b/marked/Rel-18/46_series/46022/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ee64c94b3dcede42072af847fc974b62adcecefbb9ccbb84a64797c451e0e021 +size 15049 diff --git a/marked/Rel-18/46_series/46031/2396add2849eccefcbcfbe1c7142a253_img.jpg b/marked/Rel-18/46_series/46031/2396add2849eccefcbcfbe1c7142a253_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..45eccfef5ca2545c15314eb1ae0216f6da189933 --- /dev/null +++ b/marked/Rel-18/46_series/46031/2396add2849eccefcbcfbe1c7142a253_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a25a9006687726b0b7854832a4860295d65c6e9137446e9635523dc067143d65 +size 68727 diff --git a/marked/Rel-18/46_series/46031/34f788b0e5bc8af774fa5561c22e6d01_img.jpg b/marked/Rel-18/46_series/46031/34f788b0e5bc8af774fa5561c22e6d01_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..264cf78052f0289c2af335cba92fd94f88c082e4 --- /dev/null +++ b/marked/Rel-18/46_series/46031/34f788b0e5bc8af774fa5561c22e6d01_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:15d57fc91098871dc7a54544eb83451a42cf73a2efd443f3bf8b71ffaff1e4ce +size 46377 diff --git a/marked/Rel-18/46_series/46031/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/46_series/46031/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..53f02895082ddde9bdb6041fa97c106fb298e65a --- /dev/null +++ b/marked/Rel-18/46_series/46031/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c9cf755010d56bdc669490c3dc6b72fcc566976bed4f36b848f9e921e0a0a665 +size 8137 diff --git a/marked/Rel-18/46_series/46031/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/46_series/46031/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5b48dc45b7ff9add7a4dfa335943624ce583d6ac --- /dev/null +++ b/marked/Rel-18/46_series/46031/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ee64c94b3dcede42072af847fc974b62adcecefbb9ccbb84a64797c451e0e021 +size 15049 diff --git a/marked/Rel-18/46_series/46031/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-18/46_series/46031/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..388f5ab124a8bf1dbe7047118a0619c347fc73c0 --- /dev/null +++ b/marked/Rel-18/46_series/46031/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:07b21e7c085fad3b0f53d18f5920dd75828675468ed0d301adc476dbe65d6617 +size 72353 diff --git a/marked/Rel-18/46_series/46031/e6df2733626a85205c1db682e6259c46_img.jpg b/marked/Rel-18/46_series/46031/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..43693b7e2e18278ed372c21f8b17cc3c9ed64d5f --- /dev/null +++ b/marked/Rel-18/46_series/46031/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:81d401484a9faee4c0ec49660341c7446a5ad396b7a0e2907df14859b2ac1a1c +size 45887 diff --git a/marked/Rel-18/46_series/46032/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/46_series/46032/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..695c090bc4049761aa3c4addfe490883c6c6b991 --- /dev/null +++ b/marked/Rel-18/46_series/46032/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0afdf9c7a1c7e58b184cf7c82221bd552c195f9bf5d4a36fed702d079526ce32 +size 8727 diff --git a/marked/Rel-18/46_series/46032/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/46_series/46032/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ac55d01af2599d55f833d5ac4a047bba969f4e8c --- /dev/null +++ b/marked/Rel-18/46_series/46032/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1cb23fa3b12a8d1e9cb4b9293eb744fe8ec93ee9273094b1909b9cc693e510ca +size 14671 diff --git a/marked/Rel-18/46_series/46032/9c1d3678db4a12d5864cb2a4def1135d_img.jpg b/marked/Rel-18/46_series/46032/9c1d3678db4a12d5864cb2a4def1135d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1bdc9d6d4c26e45631119c98af4125789a413bc1 --- /dev/null +++ b/marked/Rel-18/46_series/46032/9c1d3678db4a12d5864cb2a4def1135d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b82a7839ee2bb0fec3ddbf8111f7aa59c7f65b81df03ed2593f5ed6e2f532011 +size 40924 diff --git a/marked/Rel-18/46_series/46032/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/marked/Rel-18/46_series/46032/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..568d041ccc1d4948dd48346663a945c43a1f0d40 --- /dev/null +++ b/marked/Rel-18/46_series/46032/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0b88a5e0d6907596f8e29e99df97c033f5332f3a93f179229b217d6f6afb6464 +size 99291 diff --git a/marked/Rel-18/46_series/46032/d0abac95583b52a3b35f74a215567334_img.jpg b/marked/Rel-18/46_series/46032/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a5e51c65cd82ae04205a2c5d34abd005a4956c8d --- /dev/null +++ b/marked/Rel-18/46_series/46032/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bd05be2872a1bc27b57c547f777b706a59de1abd0cf5272005923389651240bc +size 73871 diff --git a/marked/Rel-18/46_series/46041/5860ad6bd2a2dd8d1ab12864b8f90f37_img.jpg b/marked/Rel-18/46_series/46041/5860ad6bd2a2dd8d1ab12864b8f90f37_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fe949e6173883234346a15fcaa9adc7c78a29559 --- /dev/null +++ b/marked/Rel-18/46_series/46041/5860ad6bd2a2dd8d1ab12864b8f90f37_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:90b7fd81566cfb215ac060e87d6fa61056f2dcca42937f68db6f83b2002c35db +size 36966 diff --git a/marked/Rel-18/46_series/46041/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/46_series/46041/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..695c090bc4049761aa3c4addfe490883c6c6b991 --- /dev/null +++ b/marked/Rel-18/46_series/46041/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0afdf9c7a1c7e58b184cf7c82221bd552c195f9bf5d4a36fed702d079526ce32 +size 8727 diff --git a/marked/Rel-18/46_series/46041/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/46_series/46041/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ac55d01af2599d55f833d5ac4a047bba969f4e8c --- /dev/null +++ b/marked/Rel-18/46_series/46041/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1cb23fa3b12a8d1e9cb4b9293eb744fe8ec93ee9273094b1909b9cc693e510ca +size 14671 diff --git a/marked/Rel-18/46_series/46041/7e670a2b556b53ea9002dfff3a420e08_img.jpg b/marked/Rel-18/46_series/46041/7e670a2b556b53ea9002dfff3a420e08_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c20175c111f0f95fc1ebcb04aea9e8166477fc8a --- /dev/null +++ b/marked/Rel-18/46_series/46041/7e670a2b556b53ea9002dfff3a420e08_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1c557e33272127fdd2e78852177754291ef007ec8f48c31806681e8a55cdd25d +size 44005 diff --git a/marked/Rel-18/46_series/46041/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-18/46_series/46041/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ec30496b191349f8ed91832028f3e0462e24c88c --- /dev/null +++ b/marked/Rel-18/46_series/46041/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0e3963908f1ef732dbfa711680c76d6c847576bb0bf2a7d8a4c8a8d6dacb1f17 +size 78610 diff --git a/marked/Rel-18/46_series/46041/e6df2733626a85205c1db682e6259c46_img.jpg b/marked/Rel-18/46_series/46041/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3c59cc770a124ce62af5ced66acd65bf0b432ede --- /dev/null +++ b/marked/Rel-18/46_series/46041/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9517d5c2b1ccfb76492ee06103d84ce8371a21c585478ddef703084b00a1102d +size 91447 diff --git a/marked/Rel-18/46_series/46042/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/46_series/46042/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..688f013ce7572d93db2ff8d7abb7ee33cb8191ec --- /dev/null +++ b/marked/Rel-18/46_series/46042/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:048500dba2b82dedfc0c001f157299426517b43950d492276a7f4306f633bffc +size 8084 diff --git a/marked/Rel-18/46_series/46042/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/46_series/46042/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5b48dc45b7ff9add7a4dfa335943624ce583d6ac --- /dev/null +++ b/marked/Rel-18/46_series/46042/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ee64c94b3dcede42072af847fc974b62adcecefbb9ccbb84a64797c451e0e021 +size 15049 diff --git a/marked/Rel-18/46_series/46042/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-18/46_series/46042/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..083748fa3abd7cd9d76b0e0afec436f736d75d55 --- /dev/null +++ b/marked/Rel-18/46_series/46042/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6ce71bee37d2af917da309d32aac2982ab70d6b2dda507d6127ba2215197a396 +size 61853 diff --git a/marked/Rel-18/46_series/46042/ff0952ef692c9d960ce5f6708bcc9711_img.jpg b/marked/Rel-18/46_series/46042/ff0952ef692c9d960ce5f6708bcc9711_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..476bebe5a06e907543f00e2c0a1924ea1718b111 --- /dev/null +++ b/marked/Rel-18/46_series/46042/ff0952ef692c9d960ce5f6708bcc9711_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b0e25a1fc7778518ddbed514ef8f08d295b7b50ba85d1847323235d7b0a6b174 +size 113944 diff --git a/marked/Rel-18/46_series/46051/43fec6623ab9cb223a9ff74e2d2a4402_img.jpg b/marked/Rel-18/46_series/46051/43fec6623ab9cb223a9ff74e2d2a4402_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a0dbd9bd0c4d5190eb87968c236acbed19bf4864 --- /dev/null +++ b/marked/Rel-18/46_series/46051/43fec6623ab9cb223a9ff74e2d2a4402_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:91467f3556f5f051134078b1d439926368876686895f20265fd3019db36d3caf +size 66858 diff --git a/marked/Rel-18/46_series/46051/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/46_series/46051/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..695c090bc4049761aa3c4addfe490883c6c6b991 --- /dev/null +++ b/marked/Rel-18/46_series/46051/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0afdf9c7a1c7e58b184cf7c82221bd552c195f9bf5d4a36fed702d079526ce32 +size 8727 diff --git a/marked/Rel-18/46_series/46051/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/46_series/46051/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ac55d01af2599d55f833d5ac4a047bba969f4e8c --- /dev/null +++ b/marked/Rel-18/46_series/46051/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1cb23fa3b12a8d1e9cb4b9293eb744fe8ec93ee9273094b1909b9cc693e510ca +size 14671 diff --git a/marked/Rel-18/46_series/46051/997233d405f0d4b89ddeb7683e047f66_img.jpg b/marked/Rel-18/46_series/46051/997233d405f0d4b89ddeb7683e047f66_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6917f59328d2b5306359187c0274c0455b37daa8 --- /dev/null +++ b/marked/Rel-18/46_series/46051/997233d405f0d4b89ddeb7683e047f66_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:950b21c81ac37e555eac7f8d7206d31d7d62df0cd0901406736308ad32211179 +size 64015 diff --git a/marked/Rel-18/46_series/46053/27b06ec9f42b5d727a2630f61a5f1861_img.jpg b/marked/Rel-18/46_series/46053/27b06ec9f42b5d727a2630f61a5f1861_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b9badde2f97beedc44da22b01ab710783e8abbae --- /dev/null +++ b/marked/Rel-18/46_series/46053/27b06ec9f42b5d727a2630f61a5f1861_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ac9a235dd7cb4f5ff160c0076877b4368d7e2b4113d1f3920b8a48d8304dfb92 +size 22581 diff --git a/marked/Rel-18/46_series/46053/5a4e62bead259c258d069fd3663ea670_img.jpg b/marked/Rel-18/46_series/46053/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9fd82a70f1dd16f30f3f1883a90d3272705bb49f --- /dev/null +++ b/marked/Rel-18/46_series/46053/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:99f2438676a5640afb35dc2a878e0486f5c1a74bb271feadcea07d923e669010 +size 124247 diff --git a/marked/Rel-18/46_series/46053/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/46_series/46053/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b8b95dd6ad1adf337da0f7dc8d6b97abdcea4b07 --- /dev/null +++ b/marked/Rel-18/46_series/46053/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f9a8df167ce3c9af33c0c334649e90c20cb47dfcf18aeeae8da8bf628cbfcd84 +size 8779 diff --git a/marked/Rel-18/46_series/46053/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/46_series/46053/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ac55d01af2599d55f833d5ac4a047bba969f4e8c --- /dev/null +++ b/marked/Rel-18/46_series/46053/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1cb23fa3b12a8d1e9cb4b9293eb744fe8ec93ee9273094b1909b9cc693e510ca +size 14671 diff --git a/marked/Rel-18/46_series/46053/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-18/46_series/46053/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cadc587e35f6185b3862910998edabb36823177b --- /dev/null +++ b/marked/Rel-18/46_series/46053/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3fd4a130be7f8bbe6c9174ee6d0ecb600f708e4d02a7f76385379f4e3a055008 +size 91428 diff --git a/marked/Rel-18/46_series/46053/d0abac95583b52a3b35f74a215567334_img.jpg b/marked/Rel-18/46_series/46053/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8b7404a718cd0c2461ecb522581ee2b82891b907 --- /dev/null +++ b/marked/Rel-18/46_series/46053/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:95d8275c3531f0711c18a675c7adf75e6f98a7530cf3c1e7512c87520146c6c5 +size 120766 diff --git a/marked/Rel-18/46_series/46053/e6df2733626a85205c1db682e6259c46_img.jpg b/marked/Rel-18/46_series/46053/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..aaeeced4df585496ad39fafa02ae4bdf1bbc1fa0 --- /dev/null +++ b/marked/Rel-18/46_series/46053/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c3cdd64e89f621f97bcde7149f2ba0fad8157487b82845d68b294a1fc44a26bd +size 47871 diff --git a/marked/Rel-18/46_series/46054/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/46_series/46054/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..695c090bc4049761aa3c4addfe490883c6c6b991 --- /dev/null +++ b/marked/Rel-18/46_series/46054/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0afdf9c7a1c7e58b184cf7c82221bd552c195f9bf5d4a36fed702d079526ce32 +size 8727 diff --git a/marked/Rel-18/46_series/46054/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/46_series/46054/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ac55d01af2599d55f833d5ac4a047bba969f4e8c --- /dev/null +++ b/marked/Rel-18/46_series/46054/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1cb23fa3b12a8d1e9cb4b9293eb744fe8ec93ee9273094b1909b9cc693e510ca +size 14671 diff --git a/marked/Rel-18/46_series/46061/35a7554182eb055209552843f341a1ae_img.jpg b/marked/Rel-18/46_series/46061/35a7554182eb055209552843f341a1ae_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dd3922b92cba2c79b9f85fdb0f90134248828360 --- /dev/null +++ b/marked/Rel-18/46_series/46061/35a7554182eb055209552843f341a1ae_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4c804c94233460ffd17b88e807bb5648a1cab509312b2044008864d10d1246d9 +size 62915 diff --git a/marked/Rel-18/46_series/46061/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/46_series/46061/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..695c090bc4049761aa3c4addfe490883c6c6b991 --- /dev/null +++ b/marked/Rel-18/46_series/46061/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0afdf9c7a1c7e58b184cf7c82221bd552c195f9bf5d4a36fed702d079526ce32 +size 8727 diff --git a/marked/Rel-18/46_series/46061/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/46_series/46061/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ac55d01af2599d55f833d5ac4a047bba969f4e8c --- /dev/null +++ b/marked/Rel-18/46_series/46061/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1cb23fa3b12a8d1e9cb4b9293eb744fe8ec93ee9273094b1909b9cc693e510ca +size 14671 diff --git a/marked/Rel-18/46_series/46062/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/46_series/46062/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..53f02895082ddde9bdb6041fa97c106fb298e65a --- /dev/null +++ b/marked/Rel-18/46_series/46062/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c9cf755010d56bdc669490c3dc6b72fcc566976bed4f36b848f9e921e0a0a665 +size 8137 diff --git a/marked/Rel-18/46_series/46062/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/46_series/46062/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5b48dc45b7ff9add7a4dfa335943624ce583d6ac --- /dev/null +++ b/marked/Rel-18/46_series/46062/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ee64c94b3dcede42072af847fc974b62adcecefbb9ccbb84a64797c451e0e021 +size 15049 diff --git a/marked/Rel-18/46_series/46081/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/46_series/46081/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..695c090bc4049761aa3c4addfe490883c6c6b991 --- /dev/null +++ b/marked/Rel-18/46_series/46081/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0afdf9c7a1c7e58b184cf7c82221bd552c195f9bf5d4a36fed702d079526ce32 +size 8727 diff --git a/marked/Rel-18/46_series/46081/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/46_series/46081/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ac55d01af2599d55f833d5ac4a047bba969f4e8c --- /dev/null +++ b/marked/Rel-18/46_series/46081/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1cb23fa3b12a8d1e9cb4b9293eb744fe8ec93ee9273094b1909b9cc693e510ca +size 14671 diff --git a/marked/Rel-18/46_series/46081/7e670a2b556b53ea9002dfff3a420e08_img.jpg b/marked/Rel-18/46_series/46081/7e670a2b556b53ea9002dfff3a420e08_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7e5ff295390a714f5b48a0b4d194b3993c9d5d62 --- /dev/null +++ b/marked/Rel-18/46_series/46081/7e670a2b556b53ea9002dfff3a420e08_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5d07109cafd877dc5c40c03aa58f346e7ff4beb9c645c2f7dd49eac1f8538617 +size 43936 diff --git a/marked/Rel-18/46_series/46081/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-18/46_series/46081/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8ed980dd971348d3968dffef84863798585f03f0 --- /dev/null +++ b/marked/Rel-18/46_series/46081/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7c18a5aba7283ddeeda513816ef3285944ebcc199deec0bfdb2cb252cc46cb78 +size 81624 diff --git a/marked/Rel-18/46_series/46081/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg b/marked/Rel-18/46_series/46081/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..92e8bc16f4a47240320bd5454172be9065add741 --- /dev/null +++ b/marked/Rel-18/46_series/46081/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:42e9b847f427dce505065c8ada861b184d93924702d1580614e1b75bde4bfd91 +size 40991 diff --git a/marked/Rel-18/46_series/46081/e6df2733626a85205c1db682e6259c46_img.jpg b/marked/Rel-18/46_series/46081/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..595eabf40fd8fb4b8ab5dd71aaca61836cef78cd --- /dev/null +++ b/marked/Rel-18/46_series/46081/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f869a44472972623306489e03d6bda64e59b698f49d17eeceb1ecb9ee37878fd +size 72026 diff --git a/marked/Rel-18/46_series/46082/27b06ec9f42b5d727a2630f61a5f1861_img.jpg b/marked/Rel-18/46_series/46082/27b06ec9f42b5d727a2630f61a5f1861_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..58138d972b59efa2d9866e19a39d17753985e6a8 --- /dev/null +++ b/marked/Rel-18/46_series/46082/27b06ec9f42b5d727a2630f61a5f1861_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:eccd761d3272227202d02cb50f1839a58a26e36df267e22ccb9559c73c13b528 +size 79758 diff --git a/marked/Rel-18/46_series/46082/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/46_series/46082/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..53f02895082ddde9bdb6041fa97c106fb298e65a --- /dev/null +++ b/marked/Rel-18/46_series/46082/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c9cf755010d56bdc669490c3dc6b72fcc566976bed4f36b848f9e921e0a0a665 +size 8137 diff --git a/marked/Rel-18/46_series/46082/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/46_series/46082/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5b48dc45b7ff9add7a4dfa335943624ce583d6ac --- /dev/null +++ b/marked/Rel-18/46_series/46082/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ee64c94b3dcede42072af847fc974b62adcecefbb9ccbb84a64797c451e0e021 +size 15049 diff --git a/marked/Rel-18/46_series/46082/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg b/marked/Rel-18/46_series/46082/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a1ad0dbdf72b535bfa7a7ce747057d7b739488f4 --- /dev/null +++ b/marked/Rel-18/46_series/46082/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:70a12088c79cba4180c9a315f98c62f04aaa72c59e17165f9d9d65ee8067d69a +size 61500