LocationAPI.yaml 123 KB
Newer Older
Michel Roy's avatar
Michel Roy committed
2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000
        interestRealm:
          description: Interest realm of access point.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        locationInfo:
          allOf:
          - $ref: '#/components/schemas/LocationInfo'
          description: The coordinates of the access point.
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: LocationInfo
        numberOfUsers:
          description: Number of users currently on the access point.
          type: integer
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: integer
        operationStatus:
          allOf:
          - $ref: '#/components/schemas/OperationStatus'
          description: Operation status of access point.
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: OperationStatus
        resourceURL:
          description: Self referring URL
          type: string
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: anyURI
        timezone:
          description: Time zone of access point.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: dateTimeStamp
      required:
      - accessPointId
      - connectionType
      - operationStatus
      - numberOfUsers
      - resourceURL
      type: object
    AccessPointList:
      description: A type containing list of access points.
      properties:
        accessPoint:
          description: Collection of the access point information list.
          items:
            $ref: '#/components/schemas/AccessPointInfo'
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: AccessPointInfo
        resourceURL:
          description: Self referring URL
          type: string
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: anyURI
        zoneId:
          description: Identifier of zone
          type: string
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: string
      required:
      - zoneId
      - resourceURL
      type: object
    CallbackReference:
      properties:
        callbackData:
          description: Data the application can register with the server when subscribing
            to notifications, and that are passed back unchanged in each of the related
            notifications. These data can be used by the application in the processing
            of the notification, e.g. for correlation purposes.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        notificationFormat:
          allOf:
          - $ref: '#/components/schemas/NotificationFormat'
          description: Application can specify format of the resource representation
            in notifications that are related to this subscription. The choice is
            between {XML, JSON}
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        notifyURL:
          description: Notify Callback URL
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: anyURI
      required:
      - notifyURL
      type: object
    CircleNotificationSubscription:
      description: A type containing data for notifications, when the area is defined
        as a circle.
      properties:
        address:
          description: Address of terminals to monitor (e.g. "sip" URI, "tel" URI,
            "acr" URI)
          items:
            type: string
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: anyURI
        callbackReference:
          allOf:
          - $ref: '#/components/schemas/CallbackReference'
          description: Notification callback definition
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: string
        checkImmediate:
          description: Check location immediately after establishing notification.
          type: boolean
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: boolean
        clientCorrelator:
          description: A correlator that the client can use to tag this particular
            resource representation during a request to create a resource on the server.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        count:
          description: Maximum number of notifications per individual address. For
            no maximum, either do not include this element or specify a value of zero.
            Default value is 0.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: int
        duration:
          description: "Period of time (in seconds) notifications are provided for.\
            \ If set to \u201C0\u201D (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."
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: int
        enteringLeavingCriteria:
          allOf:
          - $ref: '#/components/schemas/EnteringLeavingCriteria'
          description: Indicates whether the notification should occur when the
            terminal enters or leaves the target area.
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: EnteringLeavingCriteria
        frequency:
          description: Maximum frequency (in seconds) of notifications per subscription
            (can also be considered minimum time between notifications).
          type: integer
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: int
        latitude:
          description: Latitude of center point.
          format: float
          type: number
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: float
        link:
          description: Link to other resources that are in relationship with the resource.
          items:
            $ref: '#/components/schemas/Link'
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Link
        longitude:
          description: Longitude of center point.
          format: float
          type: number
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: float
        radius:
          description: Radius circle around center point in meters.
          format: float
          type: number
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: float
        requester:
          description: Identifies the entity that is requesting the information (e.g.
            "sip" URI, "tel" URI, "acr" URI)
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: anyURI
        resourceURL:
          description: Self referring URL
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: anyURI
        trackingAccuracy:
          description: Number of meters of acceptable error in tracking distance.
          format: float
          type: number
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: float
      required:
      - callbackReference
      - address
      - latitude
      - longitude
      - radius
      - trackingAccuracy
      - enteringLeavingCriteria
      - checkImmediate
      - frequency
      type: object
    ConnectionType:
      description: The connection type for the access point
      enum:
      - Femto
      - LTE-femto
      - Smallcell
      - LTE-smallcell
      - Wifi
      - Pico
      - Micro
      - Macro
      - Wimax
      - Unknown
      type: string
    DistanceCriteria:
      enum:
      - AllWithinDistance
      - AnyWithinDistance
      - AllBeyondDistance
      - AnyBeyondDistance
      type: string
    DistanceNotificationSubscription:
      description: A type containing data for distance subscription, with reference
        to other devices.
      properties:
        callbackReference:
          allOf:
          - $ref: '#/components/schemas/CallbackReference'
          description: Notification callback definition
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: string
        checkImmediate:
          description: Check location immediately after establishing notification.
          type: boolean
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: boolean
        clientCorrelator:
          description: A correlator that the client can use to tag this particular
            resource representation during a request to create a resource on the server.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        count:
          description: Maximum number of notifications per individual address. For
            no maximum, either do not include this element or specify a value of zero.
            Default value is 0.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: int
        criteria:
          allOf:
          - $ref: '#/components/schemas/DistanceCriteria'
          description: Indicates whether the notification should occur when the
            geographical relationship between monitored and referenced devices changes.
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: DistanceCriteria
        distance:
          description: Distance between devices that shall be monitored.
          format: float
          type: number
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: float
        duration:
          description: "Period of time (in seconds) notifications are provided for.\
            \ If set to \u201C0\u201D (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."
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: int
        frequency:
          description: Maximum frequency (in seconds) of notifications per subscription
            (can also be considered minimum time between notifications).
          type: integer
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: int
        link:
          description: Link to other resources that are in relationship with the resource.
          items:
            $ref: '#/components/schemas/Link'
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Link
        monitoredAddress:
          description: Contains addresses of devices to monitor (e.g., 'sip' URI,
            'tel' URI, 'acr' URI)
          items:
            type: string
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: anyURI
        referenceAddress:
          description: Indicates address of each device that will be used as reference
            devices from which the distances towards monitored devices indicated in
            the Addresses will be monitored (e.g., 'sip' URI, 'tel' URI, 'acr' URI)
          items:
            type: string
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: anyURI
        requester:
          description: Identifies the entity that is requesting the information (e.g.
            "sip" URI, "tel" URI, "acr" URI)
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: anyURI
        resourceURL:
          description: Self referring URL
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: anyURI
        trackingAccuracy:
          description: Number of meters of acceptable error in tracking distance.
          format: float
          type: number
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: float
      required:
      - callbackReference
      - monitoredAddress
      - distance
      - trackingAccuracy
      - criteria
      - checkImmediate
      - frequency
      type: object
    EnteringLeavingCriteria:
      enum:
      - Entering
      - Leaving
      type: string
    Link:
      description: Link to other resources
      properties:
        href:
          description: URI
          format: anyURI
          type: string
        rel:
          description: Describes the relationship between the URI and the resource.
          type: string
      required:
      - rel
      - href
      type: object
    LocationInfo:
      properties:
        accuracy:
          description: Horizontal accuracy / (semi-major) uncertainty of location
            provided in meters, as defined in [14]. Present only if "shape" equals
            4, 5 or 6
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: UnsignedInt
        accuracyAltitude:
          description: Altitude accuracy / uncertainty of location provided in meters,
            as defined in [14]. Present only if "shape" equals 3 or 4
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: UnsignedInt
        accuracySemiMinor:
          description: Horizontal accuracy / (semi-major) uncertainty of location
            provided in meters, as defined in [14]. Present only if "shape" equals
            4, 5 or 6
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: UnsignedInt
        altitude:
          description: Location altitude relative to the WGS84 ellipsoid surface.
          format: float
          type: number
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Float
        confidence:
          description: Confidence by which the position of a target entity is known
            to be within the shape description, expressed as a percentage and defined
            in [14]. Present only if "shape" equals 1, 4 or 6
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: UnsignedInt
        includedAngle:
          description: Present only if "shape" equals 6
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: UnsignedInt
        innerRadius:
          description: Present only if "shape" equals 6
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: UnsignedInt
        latitude:
          description: "Location latitude, expressed in the range -90\xB0 to +90\xB0\
            . Cardinality greater than one only if \"shape\" equals 7."
          items:
            format: float
            type: number
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: Float
        longitude:
          description: "Location longitude, expressed in the range -180\xB0 to +180\xB0\
            . Cardinality greater than one only if \"shape\" equals 7."
          items:
            format: float
            type: number
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: Float
        offsetAngle:
          description: Present only if "shape" equals 6
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: UnsignedInt
        orientationMajorAxis:
          description: "Angle of orientation of the major axis, expressed in the range\
            \ 0\xB0 to 180\xB0, as defined in [14]. Present only if \"shape\" equals\
            \ 4 or 6"
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: UnsignedInt
        shape:
          description: 'Shape information, as detailed in [14], associated with the
            reported location coordinate:

            1 = ELLIPSOID_ARC

            2 = ELLIPSOID_POINT

            3 = ELLIPSOID_POINT_ALTITUDE

            4 = ELLIPSOID_POINT_ALTITUDE_UNCERT_ELLIPSOID

            5 = ELLIPSOID_POINT_UNCERT_CIRCLE

            6 = ELLIPSOID_POINT_UNCERT_ELLIPSE

            7 = POLYGON'
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Enum_inlined
        timestamp:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          description: Date and time that location was collected.
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: TimeStamp
        uncertaintyRadius:
          description: Present only if "shape" equals 6
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: UnsignedInt
        velocity:
          description: "Structure with attributes relating to the target entity\u2019\
            s velocity, as defined in [14]."
          properties:
            bearing:
              description: "Bearing, expressed in the range 0\xB0 to 360\xB0, as defined\
                \ in [14]."
              type: integer
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: UnsignedInt
            horizontalSpeed:
              description: Horizontal speed, expressed in km/h and defined in [14].
              type: integer
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: UnsignedInt
            uncertainty:
              description: Horizontal uncertainty, as defined in [14]. Present only
                if "velocityType" equals 3 or 4
              type: integer
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: UnsignedInt
            velocityType:
              description: 'Velocity information, as detailed in [14], associated
                with the reported location coordinate:

                1 = HORIZONTAL

                2 = HORIZONTAL_VERTICAL

                3 = HORIZONTAL_UNCERT

                4 = HORIZONTAL_VERTICAL_UNCERT'
              type: string
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: Enum_inlined
            verticalSpeed:
              description: Vertical speed, expressed in km/h and defined in [14].
                Present only if "velocityType" equals 2 or 4
              type: integer
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: Int
            verticalUncertainty:
              description: Vertical uncertainty, as defined in [14]. Present only
                if "velocityType" equals 4
              type: integer
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: UnsignedInt
          required:
          - velocityType
          - bearing
          - horizontalSpeed
          type: object
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Structure (inlined)
      required:
      - latitude
      - longitude
      - shape
      - timestamp
      type: object
      x-etsi-ref: 6.5.3
    NotificationFormat:
      enum:
      - XML
      - JSON
      type: string
    NotificationSubscriptionList:
      properties:
        circleNotificationSubscription:
          description: Collection of CircleNotificationSubscription elements, see
            note 2.
          items:
            $ref: '#/components/schemas/CircleNotificationSubscription'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0.. N
          x-etsi-mec-origin-type: CircleNotificationSubscription
        distanceNotificationSubscription:
          description: Collection of DistanceNotificationSubscription elements, see
            note 2.
          items:
            $ref: '#/components/schemas/DistanceNotificationSubscription'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0.. N
          x-etsi-mec-origin-type: DistanceNotificationSubscription
        periodicNotificationSubscription:
          description: Collection of PeriodicNotificationSubscription elements, see
            note 2.
          items:
            $ref: '#/components/schemas/PeriodicNotificationSubscription'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0.. N
          x-etsi-mec-origin-type: PeriodicNotificationSubscription
        resourceURL:
          description: Self-referring URL, see note 1.
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: AnyURI
        userTrackingSubscription:
          description: Collection of UserTrackingSubscription elements, see note 1.
          items:
            $ref: '#/components/schemas/UserTrackingSubscription'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0.. N
          x-etsi-mec-origin-type: UserTrackingSubscription
        zonalTrafficSubscription:
          description: Collection of ZonalTrafficSubscription elements, see note 1.
          items:
            $ref: '#/components/schemas/ZonalTrafficSubscription'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0.. N
          x-etsi-mec-origin-type: ZonalTrafficSubscription
        zoneStatusSubscription:
          description: Collection of ZoneStatusSubscription elements, see note 1.
          items:
            $ref: '#/components/schemas/ZoneStatusSubscription'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0.. N
          x-etsi-mec-origin-type: ZoneStatusSubscription
      required:
      - resourceURL
      type: object
      x-etsi-notes: "NOTE 1:\tAs specified in [5], clause 5.2.2.8.\nNOTE 2: \tAs specified\
        \ in [6], clause 5.2.2.7."
      x-etsi-ref: 6.3.3
    OperationStatus:
      enum:
      - Serviceable
      - Unserviceable
      - Unknown
      type: string
    PeriodicNotificationSubscription:
      description: A type containing data for periodic subscription.
      properties:
        address:
          description: Address of terminals to monitor (e.g. "sip" URI, "tel" URI,
            "acr" URI)
          items:
            type: string
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: anyURI
        callbackReference:
          allOf:
          - $ref: '#/components/schemas/CallbackReference'
          description: Notification callback definition
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: string
        clientCorrelator:
          description: A correlator that the client can use to tag this particular
            resource representation during a request to create a resource on the server.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        duration:
          description: "Period of time (in seconds) notifications are provided for.\
            \ If set to \u201C0\u201D (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."
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: int
        frequency:
          description: Maximum frequency (in seconds) of notifications (can also be
            considered minimum time between notifications) per subscription.
          type: integer
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: int
        link:
          description: Link to other resources that are in relationship with the resource.
          items:
            $ref: '#/components/schemas/Link'
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Link
        requestedAccuracy:
          description: Accuracy of the provided distance in meters.
          type: integer
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: int
        requester:
          description: Identifies the entity that is requesting the information (e.g.
            "sip" URI, "tel" URI, "acr" URI)
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: anyURI
        resourceURL:
          description: Self referring URL
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: anyURI
      required:
      - callbackReference
      - address
      - requestedAccuracy
      - frequency
      type: object
    ProblemDetails:
      properties:
        detail:
          description: A human-readable explanation specific to this occurrence of
            the problem
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        instance:
          description: A URI reference that identifies the specific occurrence of
            the problem
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
        status:
          description: The HTTP status code for this occurrence of the problem
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        title:
          description: A short, human-readable summary of the problem type
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        type:
          description: A URI reference according to IETF RFC 3986 that identifies
            the problem type
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
      type: object
    RetrievalStatus:
      enum:
      - Retrieved
      - NotRetrieved
      - Error
      type: string
    SerializerTypes:
      type: string
    ServiceError:
      description: used to indicate a notification termination or cancellation.
      properties:
        messageId:
          description: Message identifier, either with prefix SVC or with prefix POL
          type: string
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: string
        text:
          description: Message text, with replacement variables marked with %n, where
            n is an index into the list of <variables> elements, starting at 1
          type: string
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: string
        variables:
          description: Variables to substitute into text string
          items:
            type: string
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: string
      required:
      - messageId
      - text
      type: object
    SubscriptionCancellationNotification:
      description: A type containing the subscription cancellation notification.
      properties:
        address:
          description: Address of terminal if the error applies to an individual terminal.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: anyURI
        callbackData:
          description: CallbackData if passed by the application in the receiptRequest
            element during the associated subscription operation
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        link:
          description: Link to other resources that are in relationship with the resource.
          items:
            $ref: '#/components/schemas/Link'
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Link
        reason:
          allOf:
          - $ref: '#/components/schemas/ServiceError'
          description: Reason notification is being discontinued.
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: ServiceError
      required:
      - terminalLocation
      type: object
    SubscriptionNotification:
      description: A type containing the notification subscription.
      properties:
        callbackData:
          description: CallbackData if passed by the application in the receiptRequest
            element during the associated subscription operation
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        distanceCriteria:
          allOf:
          - $ref: '#/components/schemas/DistanceCriteria'
          description: Indicates which distance criteria that caused the notification.
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: DistanceCriteria
        enteringLeavingCriteria:
          allOf:
          - $ref: '#/components/schemas/EnteringLeavingCriteria'
          description: Indicates whether the notification was caused by the terminal
            entering or leaving the target area.
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: EnteringLeavingCriteria
        isFinalNotification:
          description: Set to true if it is a final notification about location change.
          type: boolean
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: boolean
        link:
          description: Link to other resources that are in relationship with the resource.
          items:
            $ref: '#/components/schemas/Link'
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Link
        terminalLocation:
          description: Collection of the terminal locations.
          items:
            $ref: '#/components/schemas/TerminalLocation'
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: TerminalLocation
      required:
      - terminalLocation
      type: object
    TerminalDistance:
      description: A type containing information about the distance from a terminal
        to a location or between two terminals, in addition the accuracy and a timestamp
        of the information are provided.
      properties:
        accuracy:
          description: Accuracy of the provided distance in meters
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: integer
        distance:
          description: Distance from terminal to a location or between two terminals
            specified in meters
          type: integer
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: integer
        timestamp:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          description: Date and time that location from which distance is calculated
            was collected.
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: TimeStamp
      required:
      - distance
      type: object
    TerminalLocation:
      description: A type containing device address, retrieval status and location
        information.
      properties:
        address:
          description: Address of the terminal to which the location information applies
            (e.g., 'sip' URI, 'tel' URI, 'acr' URI).
          type: string
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: anyURI
        currentLocation:
          allOf:
          - $ref: '#/components/schemas/LocationInfo'
          description: Location of terminal.
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: LocationInfo
        errorInformation:
          allOf:
          - $ref: '#/components/schemas/ServiceError'
          description: This is the reason for error.
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: ServiceError
        locationRetrievalStatus:
          allOf:
          - $ref: '#/components/schemas/RetrievalStatus'
          description: Status of retrieval for this terminal address.
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: RetrievalStatus
      required:
      - address
      - locationRetrievalStatus
      type: object
    TerminalLocationList:
      description: Collection of the terminal locations.
      items:
        $ref: '#/components/schemas/TerminalLocation'
      type: array
      x-etsi-mec-cardinality: 1..N
      x-etsi-mec-origin-type: TerminalLocation
    TimeStamp:
      properties:
        nanoSeconds:
          type: integer
          format: uint32
          description: 'The nanoseconds part of the time. Time is defined as
            Unix-time since January 1, 1970, 00:00:00 UTC.'
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
        seconds:
          type: integer
          format: uint32
          description: 'The seconds part of the time. Time is defined as
            Unix-time since January 1, 1970, 00:00:00 UTC.'
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
      required:
      - seconds
      - nanoSeconds
      type: object
      x-etsi-ref: 6.5.2
    UserEventType:
      enum:
      - Entering
      - Leaving
      - Transferring
      type: string
    UserInfo:
      properties:
        accessPointId:
          description: The identity of the access point the user is currently on,
            see note 1.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        address:
          description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI) currently
            on the access point, see note 1.
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: AnyURI
        ancillaryInfo:
          description: Reserved for future use.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        contextLocationInfo:
          description: Contextual information of a user location (e.g. aisle, floor,
            room number, etc.).
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        locationInfo:
          allOf:
          - $ref: '#/components/schemas/LocationInfo'
          description: The geographical coordinates where the user is, see note 2.
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: LocationInfo
        resourceURL:
          description: Self-referring URL, see note 1.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        timestamp:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          description: Date and time that location was collected.
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: TimeStamp
        zoneId:
          description: The identity of the zone the user is currently within, see
            note 1.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - address
      - accessPointId
      - zoneId
      - resourceURL
      - timeStamp
      type: object
      x-etsi-notes: "NOTE 1:\tAs specified in [5], clause 5.2.2.7.\nNOTE 2: \tAs specified\
        \ in [5], clause 5.2.2.5."
      x-etsi-ref: 6.2.2
    UserList:
      description: A type containing list of users.
      properties:
        resourceURL:
          description: Self referring URL
          type: string
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: anyURI
        user:
          description: Collection of the zone information list.
          items:
            $ref: '#/components/schemas/UserInfo'
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: UserInfo
      required:
      - resourceURL
      type: object
    UserTrackingSubscription:
      description: A type containing user tracking subscription.
      properties:
        address:
          description: Address of user (e.g. "sip" URI, "tel" URI, "acr" URI) to monitor
          type: string
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: anyURI
        callbackReference:
          allOf:
          - $ref: '#/components/schemas/CallbackReference'
          description: Notification callback definition
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: CallbackReference
        clientCorrelator:
          description: A correlator that the client can use to tag this particular
            resource representation during a request to create a resource on the server.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        resourceURL:
          description: Self referring URL
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: anyURI
        userEventCriteria:
          description: List of user event values to generate notifications for (these
            apply to address specified). If this element is missing, a notification
            is requested to be generated for any change in user event.