LocationAPI.yaml 123 KB
Newer Older
swagger: '2.0'
info:
  description: >-
    The MEC-013 Location API described using OpenAPI, which is
    based on the Open Mobile Alliance's specification RESTful Network API for
    Zonal Presence
  version: 1.0.0
  title: MEC Location API
  license:
    name: ETSI Forge copyright notice
    url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
externalDocs:
  description: ETSI MEC013 V1.0.1 Location Service API
  url: 'https://docbox.etsi.org/ISG/MEC/70-Draft/0013LocationApi'
host: '127.0.0.1:8081'
basePath: /exampleAPI/location/v1/
schemes:
  - http
  - https
consumes:
  - application/json
produces:
  - application/json
parameters:
  ZoneId:
    name: zoneId
    in: query
    description: Zone ID
    required: true
    type: string
  AccessPointId:
    name: accessPointId
    in: query
    description: 'Identifier of access point, reference "definitions" for string format'
    required: false
    type: string
  InterestRealm:
    name: interestRealm
    in: query
    description: >-
      Interest realm of access point (e.g. geographical area, a type of industry
      etc.).
    required: false
    type: string
paths:
  /zones:
    get:
      description: >-
        Used to get a list of identifiers for zones authorized for use by the
        application.
      produces:
        - application/json
      responses:
        '200':
          description: Successful response to a query regarding the status of a zone
          schema:
            properties:
              zoneList:
                description: Collection of the zone information list.
                required:
                  - resourceURL
                properties:
                  zone:
                    description: Collection of the zone information list.
                    type: array
                    items:
                      description: A type containing zone information.
                      required:
                        - zoneId
                        - numberOfAccessPoints
                        - numberOfUnservicableAccessPoints
                        - numberOfUsers
                        - resourceURL
                      properties:
                        zoneId:
                          description: Identifier of zone
                          type: string
                          example: zone01
                        numberOfAccessPoints:
                          description: The number of access points within the zone
                          type: integer
                          format: uint32
                          example: '10'
                        numberOfUnservicableAccessPoints:
                          description: Number of inoperable access points within the zone.
                          type: integer
                          format: uint32
                          example: '9'
                        numberOfUsers:
                          description: The number of users currently on the access point.
                          type: integer
                          format: uint32
                          example: '7'
                        resourceURL:
                          description: Self referring URL.
                          type: string
                          format: uri
                          example: >-
                            http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
                  resourceURL:
                    description: Self referring URL.
                    type: string
                    format: uri
                    example: >-
                      http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
          examples:
            application/json:
              zoneList:
                zone:
                  - zoneId: zone01
                    numberOfAccessPoints: '3'
                    numberOfUnserviceableAccessPoints: '1'
                    numberOfUsers: '10'
                    resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone01'
                  - zoneId: zone02
                    numberOfAccessPoints: '12'
                    numberOfUnserviceableAccessPoints: '0'
                    numberOfUsers: '36'
                    resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone02'
                resourceURL: 'http://example.com/exampleAPI/location/v1/zones'
  '/zones/{zoneId}':
    get:
      description: Used to get the status of a zone.
      produces:
        - application/json
      parameters:
        - name: zoneId
          in: path
          description: Zone ID
          required: true
          type: string
      responses:
        '200':
          description: Successful response to a query regarding the status of a zone
          schema:
            properties:
              zoneInfo:
                description: A type containing zone information.
                required:
                  - zoneId
                  - numberOfAccessPoints
                  - numberOfUnservicableAccessPoints
                  - numberOfUsers
                  - resourceURL
                properties:
                  zoneId:
                    description: Identifier of zone
                    type: string
                    example: zone01
                  numberOfAccessPoints:
                    description: The number of access points within the zone
                    type: integer
                    format: uint32
                    example: '10'
                  numberOfUnservicableAccessPoints:
                    description: Number of inoperable access points within the zone.
                    type: integer
                    format: uint32
                    example: '9'
                  numberOfUsers:
                    description: The number of users currently on the access point.
                    type: integer
                    format: uint32
                    example: '7'
                  resourceURL:
                    description: Self referring URL.
                    type: string
                    format: uri
                    example: >-
                      http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
          examples:
            application/json:
              zoneInfo:
                zoneId: zone01
                numberOfAccessPoints: '3'
                numberOfUnserviceableAccessPoints: '1'
                numberOfUsers: '10'
                resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone01'
  '/zones/{zoneId}/accessPoints':
    get:
      description: >-
        Access point status can be retrieved for sets of access points matching
        attribute in the request.
      produces:
        - application/json
      parameters:
        - name: zoneId
          in: path
          description: Zone ID
          required: true
          type: string
        - name: interestRealm
          in: query
          description: >-
            Interest realm of access point (e.g. geographical area, a type of
            industry etc.).
          required: false
          type: string
      responses:
        '200':
          description: >-
            Successful response to a query a named set of access point status
            request
          schema:
            properties:
              accessPointList:
                required:
                  - zoneId
                  - resourceURL
                properties:
                  zoneId:
                    description: Identifier of zone
                    type: string
                    example: zone01
                  accessPoint:
                    description: Collection of the access point information list.
                    type: array
                    items:
                      required:
                        - accessPointId
                        - connectionType
                        - operationStatus
                        - numberOfUsers
                        - resourceURL
                      properties:
                        accessPointId:
                          description: >-
                            Identifier of access point, <E-CGI><Cell Portion ID>
                            (reference ETSI TS 129 171). Where the E-CGI is made
                            up of the PLMN and Cell Identity (28 bit string).
                            Then the PLMN is made up of the 3 digit MCC & 2 or 3
                            digit MNC. The Cell Portion is an optional element
                          type: string
                          example: '001010000000000000000000000000001'
                        locationInfo:
                          description: >-
                            A type containing location information with
                            latitude, longitude and altitude, in addition the
                            accuracy of the information are provided.
                          type: object
                          required:
                            - latitude
                            - longitude
                            - accuracy
                          properties:
                            latitude:
                              type: number
                              format: float
                              example: '80.123'
                            longitude:
                              type: number
                              format: float
                              example: '70.123'
                            altitude:
                              type: number
                              format: float
                              example: '10.0'
                            accuracy:
                              type: integer
                              format: int32
                              example: '10'
                        connectionType:
                          description: The connection type for the access point
                          type: string
                          example: Macro
                        operationStatus:
                          description: The operation status of the access point
                          type: string
                          example: Serviceable
                        numberOfUsers:
                          description: The number of users currently on the access point.
                          type: integer
                          format: uint32
                          example: '7'
                        timezone:
                          description: Time zone of access point
                          type: string
                          format: date-time
                          example: '2017-01-01T02:51:43Z'
                        interestRealm:
                          description: >-
                            Interest realm of access point (e.g. geographical
                            area, a type of industry etc.).
                          type: string
                          example: LA
                        resourceURL:
                          description: Self referring URL.
                          type: string
                          format: uri
                          example: >-
                            http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
                  resourceURL:
                    description: Self referring URL.
                    type: string
                    format: uri
                    example: >-
                      http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
          examples:
            application/json:
              accessPointList:
                zoneId: zone01
                accessPoint:
                  - accessPointId: '001010000000000000000000000000001'
                    locationInfo:
                      latitude: '90.123'
                      longitude: '80.123'
                      altitude: '10.0'
                      accuracy: '0'
                    connectionType: Macro
                    operationStatus: Serviceable
                    numberOfUsers: '5'
                    interestRealm: LA
                    resourceURL: >-
                      http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints/ap001
                  - accessPointId: '001010000000000000000000000000010'
                    locationInfo:
                      latitude: '91.123'
                      longitude: '81.123'
                      altitude: '12.0'
                      accuracy: '1'
                    connectionType: Macro
                    operationStatus: Unserviceable
                    numberOfUsers: '0'
                    interestRealm: DC
                    resourceURL: >-
                      http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints/ap002
                  - accessPointId: '001010000000000000000000000000011'
                    locationInfo:
                      latitude: '93.123'
                      longitude: '83.123'
                      altitude: '16.0'
                      accuracy: '3'
                    connectionType: Macro
                    operationStatus: Serviceable
                    numberOfUsers: '5'
                    interestRealm: NJ
                    resourceURL: >-
                      http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints/ap003
                resourceURL: >-
                  http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints
  '/zones/{zoneId}/accessPoints/{accessPointId}':
    get:
      description: >-
        Access point status can be retrieved for sets of access points matching
        attribute in the request.
      produces:
        - application/json
      parameters:
        - name: zoneId
          in: path
          description: Zone ID
          required: true
          type: string
        - name: accessPointId
          in: path
          description: Access Point ID
          required: true
          type: string
      responses:
        '200':
          description: >-
            Successful response to a query a named set of access point status
            request
          schema:
            properties:
              accessPointInfo:
                required:
                  - accessPointId
                  - connectionType
                  - operationStatus
                  - numberOfUsers
                  - resourceURL
                properties:
                  accessPointId:
                    description: >-
                      Identifier of access point, <E-CGI><Cell Portion ID>
                      (reference ETSI TS 129 171). Where the E-CGI is made up of
                      the PLMN and Cell Identity (28 bit string). Then the PLMN
                      is made up of the 3 digit MCC & 2 or 3 digit MNC. The Cell
                      Portion is an optional element
                    type: string
                    example: '001010000000000000000000000000001'
                  locationInfo:
                    description: >-
                      A type containing location information with latitude,
                      longitude and altitude, in addition the accuracy of the
                      information are provided.
                    type: object
                    required:
                      - latitude
                      - longitude
                      - accuracy
                    properties:
                      latitude:
                        type: number
                        format: float
                        example: '80.123'
                      longitude:
                        type: number
                        format: float
                        example: '70.123'
                      altitude:
                        type: number
                        format: float
                        example: '10.0'
                      accuracy:
                        type: integer
                        format: int32
                        example: '10'
                  connectionType:
                    description: The connection type for the access point
                    type: string
                    example: Macro
                  operationStatus:
                    description: The operation status of the access point
                    type: string
                    example: Serviceable
                  numberOfUsers:
                    description: The number of users currently on the access point.
                    type: integer
                    format: uint32
                    example: '7'
                  timezone:
                    description: Time zone of access point
                    type: string
                    format: date-time
                    example: '2017-01-01T02:51:43Z'
                  interestRealm:
                    description: >-
                      Interest realm of access point (e.g. geographical area, a
                      type of industry etc.).
                    type: string
                    example: LA
                  resourceURL:
                    description: Self referring URL.
                    type: string
                    format: uri
                    example: >-
                      http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
          examples:
            application/json:
              accessPointInfo:
                accessPointId: '001010000000000000000000000000001'
                locationInfo:
                  latitude: '90.123'
                  longitude: '80.123'
                  altitude: '10.0'
                  accuracy: '0'
                connectionType: Macro
                operationStatus: Serviceable
                numberOfUsers: '5'
                interestRealm: LA
                resourceURL: >-
                  http://example.com/exampleAPI/location/v1/zones/zone001/accessPoints/ap001
  /users:
    get:
      description: >-
        Users currently using a zone may be retrieved for sets of access points
        matching attribute in the request
      produces:
        - application/json
      parameters:
        - name: zoneId
          in: query
          description: Zone ID
          required: true
          type: string
        - name: accessPointId
          in: query
          description: >-
            Identifier of access point, reference "definitions" for string
            format
          required: false
          type: string
      responses:
        '200':
          description: Successful response to a query users within a zone request
          schema:
            properties:
              userList:
                description: A type containing list of users.
                required:
                  - resourceURL
                properties:
                  user:
                    description: Collection of the zone information list.
                    type: array
                    items:
                      required:
                        - address
                        - accessPointId
                        - zoneId
                        - resourceURL
                      properties:
                        address:
                          description: >-
                            Address of user (e.g. "sip" URI, "tel" URI, "acr"
                            URI).
                          type: string
                          format: uri
                          example: 'acr:192.0.2.1'
                        accessPointId:
                          description: >-
                            Identifier of access point, <E-CGI><Cell Portion ID>
                            (reference ETSI TS 129 171). Where the E-CGI is made
                            up of the PLMN and Cell Identity (28 bit string).
                            Then the PLMN is made up of the 3 digit MCC & 2 or 3
                            digit MNC. The Cell Portion is an optional element
                          type: string
                          example: '001010000000000000000000000000001'
                        zoneId:
                          description: Identifier of zone
                          type: string
                          example: zone01
                        resourceURL:
                          description: Self referring URL.
                          type: string
                          format: uri
                          example: >-
                            http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
                        locationInfo:
                          description: >-
                            A type containing location information with
                            latitude, longitude and altitude, in addition the
                            accuracy of the information are provided.
                          type: object
                          required:
                            - latitude
                            - longitude
                            - accuracy
                          properties:
                            latitude:
                              type: number
                              format: float
                              example: '80.123'
                            longitude:
                              type: number
                              format: float
                              example: '70.123'
                            altitude:
                              type: number
                              format: float
                              example: '10.0'
                            accuracy:
                              type: integer
                              format: int32
                              example: '10'
                        contextLocationInfo:
                          description: >-
                            Contextual information of a user location (e.g.,
                            aisle, floor, room number, etc.)
                          type: string
                          example: GroundFoor
                        ancillaryInfo:
                          required:
                            - address
                          properties:
                            address:
                              description: >-
                                Address of user (e.g. "sip" URI, "tel" URI,
                                "acr" URI).
                              type: string
                              format: uri
                              example: 'acr:192.0.2.1'
                  resourceURL:
                    description: Self referring URL.
                    type: string
                    format: uri
                    example: >-
                      http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
          examples:
            application/json:
              userList:
                user:
                  - address: 'acr:192.0.2.1'
                    accessPointId: '001010000000000000000000000000001'
                    zoneId: zone01
                    resourceURL: >-
                      http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.1
                  - address: 'acr:192.0.2.2'
                    accessPointId: '001010000000000000000000000000001'
                    zoneId: zone01
                    resourceURL: >-
                      http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.2
                  - address: 'acr:192.0.2.3'
                    accessPointId: '001010000000000000000000000000010'
                    zoneId: zone01
                    resourceURL: >-
                      http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.3
                  - address: 'acr:192.0.2.4'
                    accessPointId: '001010000000000000000000000000001'
                    zoneId: zone02
                    resourceURL: >-
                      http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.4
                  - address: 'acr:192.0.2.5'
                    accessPointId: '001010000000000000000000000000010'
                    zoneId: zone02
                    resourceURL: >-
                      http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.5
                resourceURL: 'http://example.com/exampleAPI/location/v1/users'
  '/users/{userId}':
    get:
      description: >-
        Users currently using a zone may be retrieved for sets of access points
        matching attribute in the request
      produces:
        - application/json
      parameters:
        - name: userId
          in: path
          description: User ID
          required: true
          type: string
      responses:
        '200':
          description: Successful response to a query users within a zone request
          schema:
            properties:
              userInfo:
                required:
                  - address
                  - accessPointId
                  - zoneId
                  - resourceURL
                properties:
                  address:
                    description: 'Address of user (e.g. "sip" URI, "tel" URI, "acr" URI).'
                    type: string
                    format: uri
                    example: 'acr:192.0.2.1'
                  accessPointId:
                    description: >-
                      Identifier of access point, <E-CGI><Cell Portion ID>
                      (reference ETSI TS 129 171). Where the E-CGI is made up of
                      the PLMN and Cell Identity (28 bit string). Then the PLMN
                      is made up of the 3 digit MCC & 2 or 3 digit MNC. The Cell
                      Portion is an optional element
                    type: string
                    example: '001010000000000000000000000000001'
                  zoneId:
                    description: Identifier of zone
                    type: string
                    example: zone01
                  resourceURL:
                    description: Self referring URL.
                    type: string
                    format: uri
                    example: >-
                      http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
                  locationInfo:
                    description: >-
                      A type containing location information with latitude,
                      longitude and altitude, in addition the accuracy of the
                      information are provided.
                    type: object
                    required:
                      - latitude
                      - longitude
                      - accuracy
                    properties:
                      latitude:
                        type: number
                        format: float
                        example: '80.123'
                      longitude:
                        type: number
                        format: float
                        example: '70.123'
                      altitude:
                        type: number
                        format: float
                        example: '10.0'
                      accuracy:
                        type: integer
                        format: int32
                        example: '10'
                  contextLocationInfo:
                    description: >-
                      Contextual information of a user location (e.g., aisle,
                      floor, room number, etc.)
                    type: string
                    example: GroundFoor
                  ancillaryInfo:
                    required:
                      - address
                    properties:
                      address:
                        description: >-
                          Address of user (e.g. "sip" URI, "tel" URI, "acr"
                          URI).
                        type: string
                        format: uri
                        example: 'acr:192.0.2.1'
          examples:
            application/json:
              userInfo:
                address: 'acr:192.0.2.1'
                accessPointId: '001010000000000000000000000000001'
                zoneId: zone01
                resourceURL: >-
                  http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.1
                locationInfo:
                  latitude: '90.123'
                  longitude: '80.123'
                  altitude: '10.0'
                  accuracy: '0'
                contextLocationInfo: GroundFloor
  /subscriptions/zonalTraffic:
    get:
      description: >-
        This operation is used for retrieving all active subscriptions to zonal
        traffic change notifications.
      produces:
        - application/json
      responses:
        '200':
          description: Response to retrieve zonal traffic subscriptions
          schema:
            type: object
            properties:
              notificationSubscriptionList:
                type: object
                properties:
                  zonalTrafficSubscription:
                    type: array
                    items:
                      description: A type containing zonal traffic subscription
                      type: object
                      required:
                        - callbackReference
                        - zoneId
                      properties:
                        clientCorrelator:
                          description: >-
                            Uniquely identifies this create subscription
                            request. If there is a communication failure during
                            the request, using the same clientCorrelator when
                            retrying the request allows the operator to avoid
                            creating a duplicate subscription.
                          type: string
                          example: '0123'
                        callbackReference:
                          required:
                            - notifyURL
                          properties:
                            notifyURL:
                              description: The URL of your own listener application.
                              type: string
                              format: url
                              example: >-
                                http://clientApp.example.com/location_notifications/123456
                        zoneId:
                          description: Identifier of zone
                          type: string
                          example: zone01
                        interestRealm:
                          description: >-
                            Interest realms of access points within a zone (e.g.
                            geographical area, a type of industry etc.).
                          type: array
                          items:
                            description: >-
                              Interest realm of access point (e.g. geographical
                              area, a type of industry etc.).
                            type: string
                            example: LA
                        userEventCriteria:
                          description: >-
                            List of user event values to generate notifications
                            for (these apply to zone identifier or all interest
                            realms within zone identifier specified). If this
                            element is missing, a notification is requested to
                            be generated for any change in user event.
                          type: array
                          items:
                            description: User event
                            type: string
                            example: Entering
                        duration:
                          description: >-
                            Period (in seconds) of time notifications are
                            provided for. If set to "0" (zero), a default
                            duration time, which is specified by the service
                            policy, will be used. If the parameter is omitted,
                            the notifications will continue until the maximum
                            duration time, which is specified by the service
                            policy, unless the notifications are stopped by
                            deletion of subscription for notifications. This
                            element MAY be given by the client during resource
                            creation in order to signal the desired lifetime of
                            the subscription. The server MUST return in this
                            element the period of time for which the
                            subscription will still be valid.
                          type: string
                          example: '0'
                        resourceURL:
                          description: Self referring URL.
                          type: string
                          format: uri
                          example: >-
                            http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
                  resourceURL:
                    description: Self referring URL.
                    type: string
                    format: uri
                    example: >-
                      http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
          examples:
            application/json:
              notificationSubscriptionList:
                zonalTrafficSubscription:
                  - clientCorrelator: '0123'
                    resourceURL: >-
                      http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/subscription123
                    callbackReference:
                      notifyURL: >-
                        http://clientApp.example.com/location_notifications/123456
                    zoneId: zone01
                    interestRealm: LA
                    userEventCriteria: Transferring
                  - clientCorrelator: '0124'
                    resourceURL: >-
                      http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/subscription124
                    callbackReference:
                      notifyURL: >-
                        http://clientApp.example.com/location_notifications/123457
                    zoneId: zone02
                    interestRealm: LA
                    userEventCriteria: Transferring
                resourceURL: 'http://example.com/exampleAPI/location/v1/zonalTraffic'
    post:
      description: >-
        This operation is used for creating a new subscription to zonal traffic
        change notification.
      produces:
        - application/json
      parameters:
        - name: zonalTrafficSubscription
          in: body
          description: Zonal Traffic Subscription
          required: true
          schema:
            description: A type containing zonal traffic subscription
            type: object
            required:
              - callbackReference
              - zoneId
            properties:
              clientCorrelator:
                description: >-
                  Uniquely identifies this create subscription request. If there
                  is a communication failure during the request, using the same
                  clientCorrelator when retrying the request allows the operator
                  to avoid creating a duplicate subscription.
                type: string
                example: '0123'
              callbackReference:
                required:
                  - notifyURL
                properties:
                  notifyURL:
                    description: The URL of your own listener application.
                    type: string
                    format: url
                    example: 'http://clientApp.example.com/location_notifications/123456'
              zoneId:
                description: Identifier of zone
                type: string
                example: zone01
              interestRealm:
                description: >-
                  Interest realms of access points within a zone (e.g.
                  geographical area, a type of industry etc.).
                type: array
                items:
                  description: >-
                    Interest realm of access point (e.g. geographical area, a
                    type of industry etc.).
                  type: string
                  example: LA
              userEventCriteria:
                description: >-
                  List of user event values to generate notifications for (these
                  apply to zone identifier or all interest realms within zone
                  identifier specified). If this element is missing, a
                  notification is requested to be generated for any change in
                  user event.
                type: array
                items:
                  description: User event
                  type: string
                  example: Entering
              duration:
                description: >-
                  Period (in seconds) of time notifications are provided for. If
                  set to "0" (zero), a default duration time, which is specified
                  by the service policy, will be used. If the parameter is
                  omitted, the notifications will continue until the maximum
                  duration time, which is specified by the service policy,
                  unless the notifications are stopped by deletion of
                  subscription for notifications. This element MAY be given by
                  the client during resource creation in order to signal the
                  desired lifetime of the subscription. The server MUST return
                  in this element the period of time for which the subscription
                  will still be valid.
                type: string
                example: '0'
              resourceURL:
                description: Self referring URL.
                type: string
                format: uri
                example: >-
                  http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
      responses:
        '201':
          description: Response to create new zonal traffic subscription
          schema:
            properties:
              zonalTrafficSubscription:
                description: A type containing zonal traffic subscription
                type: object
                required:
                  - callbackReference
                  - zoneId
                properties:
                  clientCorrelator:
                    description: >-
                      Uniquely identifies this create subscription request. If
                      there is a communication failure during the request, using
                      the same clientCorrelator when retrying the request allows
                      the operator to avoid creating a duplicate subscription.
                    type: string
                    example: '0123'
                  callbackReference:
                    required:
                      - notifyURL
                    properties:
                      notifyURL:
                        description: The URL of your own listener application.
                        type: string
                        format: url
                        example: >-
                          http://clientApp.example.com/location_notifications/123456
                  zoneId:
                    description: Identifier of zone
                    type: string
                    example: zone01
                  interestRealm:
                    description: >-
                      Interest realms of access points within a zone (e.g.
                      geographical area, a type of industry etc.).
                    type: array
                    items:
                      description: >-
                        Interest realm of access point (e.g. geographical area,
                        a type of industry etc.).
                      type: string
                      example: LA
                  userEventCriteria:
                    description: >-
                      List of user event values to generate notifications for
                      (these apply to zone identifier or all interest realms
                      within zone identifier specified). If this element is
                      missing, a notification is requested to be generated for
                      any change in user event.
                    type: array
                    items:
                      description: User event
                      type: string
                      example: Entering
                  duration:
                    description: >-
                      Period (in seconds) of time notifications are provided
                      for. If set to "0" (zero), a default duration time, which
                      is specified by the service policy, will be used. If the
                      parameter is omitted, the notifications will continue
                      until the maximum duration time, which is specified by the
                      service policy, unless the notifications are stopped by
                      deletion of subscription for notifications. This element
                      MAY be given by the client during resource creation in
                      order to signal the desired lifetime of the subscription.
                      The server MUST return in this element the period of time
                      for which the subscription will still be valid.
                    type: string
                    example: '0'
                  resourceURL:
                    description: Self referring URL.
                    type: string
                    format: uri
                    example: >-
                      http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
          examples:
            application/json:
              zonalTrafficSubscription:
                clientCorrelator: '0123'
                resourceURL: >-
                  http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/subscription123
                callbackReference:
                  notifyURL: 'http://clientApp.example.com/location_notifications/123456'
                zoneId: zone01