LocationAPI_TypesAndValues.ttcn

module LocationAPI_TypesAndValues {
  
  // LibCommon
  import from LibCommon_BasicTypesAndValues all;

  /**
   * @desc
   * @member seconds The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
   * @member nanoSeconds The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
   */
  type record TimeStamp {
    UInt32 seconds,
    UInt32 nanoSeconds
  }
  
  /**
   * @desc A type containing list of users.
   * @member user Collection of the zone information list.
   * @member resourceURL Self referring URL.
   */
  type record of UserInfo UserInfos;
  type record UserList {
    UserInfos user optional,
    ResourceURL resourceURL
  }
  
  /**
   * @desc A type containing location information with latitude, longitude and altitude, in addition the accuracy of the information are provided.
   * @member latitude
   * @member longitude
   * @member altitude
   * @member accuracy
   */
  type record LocationInfo {
    float latitude,
    float longitude,
    float altitude optional,
    UInt32 accuracy
  } // End of type LocationInfo
  
  /**
   * @desc A type containing zone information.
   * @member zoneId Identifier of zone
   * @member numberOfAccessPoints The number of access points within the zone
   * @member numberOfUnservicableAccessPoints Number of inoperable access points within the zone.
   * @member numberOfUsers The number of users currently on the access point.
   * @member resourceURL Self referring URL.
   */
  type record ZoneInfo {
    ZoneId zoneId,
    NumberOfAccessPoints numberOfAccessPoints,
    NumberOfUnserviceableAccessPoints numberOfUnservicableAccessPoints,
    NumberOfUsers numberOfUsers,
    ResourceURL resourceURL
  }

  /**
   * @desc Collection of the zone information list.
   * @member zone Collection of the zone information list.
   * @member resourceURL Self referring URL.
   */
  type record of ZoneInfo ZoneInfos;
  type record ZoneList {
    ZoneInfos zone optional,
    ResourceURL resourceURL
  }

  /**
   * @desc 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 universal charstring AccessPointId;
  
  /**
   * @desc A type containing access point information.
   * @member accessPointId
   * @member connectionType The connection type for the access poin
   * @member operationStatus The operation status of the access point
   * @member numberOfUsers The number of users currently on the access point.
   * @member resourceURL Self referring URL.
   */
  type record AccessPointInfo {
    AccessPointId accessPointId,
    LocationInfo locationInfo optional,
    ConnectionType connectionType,
    OperationStatus operationStatus,
    NumberOfUsers numberOfUsers,
    InterestRealm interestRealm,
    ResourceURL resourceURL
  }
  type record of AccessPointInfo AccessPointInfos;

  /**
   * @desc A type containing list of access points.
   * @member zoneId 
   * @member accessPoint Collection of the access point information list.
   * @member resourceURL 
   */
  type record AccessPointList {
    ZoneId zoneId,
    AccessPointInfos accessPoint optional,
    ResourceURL resourceURL
  }

  /**
   * @desc Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI).
   */
  type universal charstring Address

  /**
   * @desc Reserved for future use.
   */
  type universal charstring AncillaryInfo;

  /**
   * @desc CallBackData if passed by the application during the associated ZonalTrafficSubscription and UserTrackingSubscription operation. See [\
REST_NetAPI_Common].
   */
  type universal charstring CallbackData;

  /**
   * @desc Notification callback definition.
   * @member notifyURL 
   */
  type record CallbackReference {
    NotifyURL notifyURL
  }

  /**
   * @desc 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 universal charstring ClientCorrelator;

  /**
   * @desc The connection type for the access point
   */
  type enumerated ConnectionType {
    Femto,
    LTE_femto,
    Smallcell,
    LTE_smallcell,
    Wifi,
    Pico,
    Micro,
    Macro,
    Wimax,
    Unknown
  }

  /**
   * @desc Contextual information of a user location (e.g., aisle, floor, room number, etc.)
   */
  type universal charstring ContextLocationInfo;

  /**
   * @desc Zone ID
   */
  type universal charstring CurrentAccessPointId;

  /**
   * @desc 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 universal charstring Duration;

  /**
   * @desc Interest realm of access point (e.g. geographical area, a type of industry etc.).
   */
  type universal charstring InterestRealm;

  /**
   * @desc Link to other resources
   * @member rel Describes the relationship between the URI and the resource.
   * @member href UTI
   */
  type record Link {
    universal charstring rel,
    universal charstring href
  }

  /**
   * @desc The URL of your own listener application.
   */
  type universal charstring NotifyURL;

  /**
   * @desc The number of access points within the zone
   */
  type UInt32 NumberOfAccessPoints;

  /**
   * @desc Number of inoperable access points within the zone.
   */
  type UInt32 NumberOfUnserviceableAccessPoints;

  /**
   * @desc The number of users currently on the access point.
   */
  type UInt32 NumberOfUsers;

  /**
   * @desc Threshold number of users in an access point which if crossed shall cause a notification.
   */
  type UInt32 NumberOfUsersAPThreshold;

  /**
   * @desc This element shall be present when ZoneStatusSubscription includes numberOfUsersAPThreshold element and the number of users in an access point exceeds the threshold defined in the subscription.
   */
  type UInt32 NumberOfUsersInAP;

  /**
   * @desc Threshold number of users in a zone which if crossed shall cause a notification.
   */
  type UInt32 NumberOfUsersInZone;

  /**
   * @desc Threshold number of users in a zone which if crossed shall cause a notification.
   */
  type UInt32 NumberOfUsersZoneThreshold;

  /**
   * @desc The operation status of the access point
   */
  type enumerated OperationStatus {
    Serviceable,
    Unserviceable,
    Unknown
  }

  /**
   * @desc Zone ID
   */
  type universal charstring PreviousAccessPointId;

  /**
   * @desc Self referring URL
   */
  type universal charstring ResourceURL;

  /**
   * @desc Indicates the time of day for zonal presence notification.
   */
  type universal charstring Timestamp;

  /**
   * @desc Time zone of access point
   */
  type universal charstring Timezone;

  /**
   * @desc User event
   */
  type enumerated UserEventType {
    Entering,
    Leaving,
    Transferring
  }

  /**
   * @desc 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.
   */
  type record of UserEventType UserEventCriteria;

  /**
   * @desc A type containing user information.
   * @member address_ Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI).
   * @member accessPointId Identifier of access point, <E-CGI><Cell Portion ID> (reference ETSI TS 129 171).
   * @member zoneId Identifier of zone
   * @member resourceURL Self referring URL.
   * @member locationInfo A type containing location information with latitude, longitude and altitude, in addition the accuracy of the information are provided.
   * @member contextLocationInfo 
   * @member ancillaryInfo 
   */
  type record UserInfo {
    Address address_,
    AccessPointId accessPointId,
    ZoneId zoneId,
    ResourceURL resourceURL,
    LocationInfo locationInfo optional,
    ContextLocationInfo contextLocationInfo optional,
    AncillaryInfo ancillaryInfo optional
  } with {
    variant (address_) "name as 'address'";
  } // End of type UserInfo

  /**
   * @desc A type containing user tracking subscription.
   * @member 
   */
  type record UserTrackingSubscription {
    ClientCorrelator clientCorrelator optional,
    CallbackReference callbackReference,
    Address address_,
    UserEventCriteria userEventCriteria optional,
    ResourceURL resourceURL optional
  } with {
    variant (address_) "name as 'address'";
  }

  /**
   * @desc A type containing zonal presence notification
   * @member 
   * @member link Link to other resources that are in relationship with this notification. The server SHOULD include a link to the related subscription. No other links are required or suggested by this specification.
   */
  type record ZonalPresenceNotification {
    CallbackReference callbackReference optional,
    ZoneId zoneId,
    Address address_,
    InterestRealm interestRealm optional,
    UserEventType userEventType,
    CurrentAccessPointId currentAccessPointId,
    PreviousAccessPointId previousAccessPointId optional,
    Timestamp timestamp_,
    Link link optional
  } with {
    variant (address_) "name as 'address'";
    variant (timestamp_) "name as 'timestamp'";
  }

  /**
   * @desc A type containing zonal traffic subscription
   * @member
   * @member interestRealm Interest realms of access points within a zone (e.g. geographical area, a type of industry etc.).
   * @member userEventCriteria 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.
   * @member resourceURL 
   */
  type record ZonalTrafficSubscription {
    ClientCorrelator clientCorrelator optional,
    CallbackReference callbackReference,
    ZoneId zoneId,
    InterestRealm interestRealm optional,
    UserEventCriteria userEventCriteria optional,
    Duration duration optional,
    ResourceURL resourceURL optional
  }

  /**
   * @desc Identifier of zone
   */
  type universal charstring ZoneId;

  /**
   * @desc A type containing zone status notification.
   * @member zoneId 
   * @member 
   */
  type record ZoneStatusNotification {
    CallbackData callbackData optional,
    ZoneId zoneId,
    AccessPointId accessPointId optional,
    NumberOfUsersInZone numberOfUsersInZone optional,
    NumberOfUsersInAP numberOfUsersInAP optional,
    OperationStatus operationStatus optional,
    Timestamp timestamp_,
    Link link
  } with {
    variant (timestamp_) "name as 'timestamp'";
  }

  /**
   * @desc A type containing zone status subscription.
   * @member zoneId
   * @member
   * @member
   * @member
   * @member operationStatus List of operation status values to generate notifications for (these apply to all access points within a zone).
   */
  type record ZoneStatusSubscription {
    ClientCorrelator clientCorrelator optional,
    ResourceURL resourceURL optional,
    CallbackReference callbackReference,
    ZoneId zoneId,
    NumberOfUsersZoneThreshold numberOfUsersZoneThreshold optional,
    NumberOfUsersAPThreshold numberOfUsersAPThreshold optional,
    OperationStatus operationStatus optional
  }
  
} with {
  encode "JSON"
}