Ams_TypesAndValues.ttcn 17 KB
Newer Older
Elian Kraja's avatar
Elian Kraja committed
module Ams_TypesAndValues {

// JSON
import from JSON all;

// LibCommon
import from LibCommon_BasicTypesAndValues all;

Elian Kraja's avatar
Elian Kraja committed
type record of AppMobilityServiceInfo AppMobilityServiceInfos;
type record AppMobilityServiceInfo {
  RegistrationInfos registeredAppMobilityService ,
  String appMobilityServiceId
}

type record of RegistrationInfo RegistrationInfos;
type record RegistrationInfo {
  ServiceConsumerId serviceConsumerId,
  DeviceInformations deviceInformation optional,
  UInt32 expiryTime optional
}


type record RegistrationRequest {
  ServiceConsumerId serviceConsumerId,
  DeviceInformations deviceInformation optional,
  UInt32 expiryTime optional
}


type record RegistrationRequestWithError {
  ServiceConsumerIdWithError serviceConsumerIdWithError,
  DeviceInformations deviceInformation optional,
  UInt32 expiryTime optional
}


Elian Kraja's avatar
Elian Kraja committed
type record of ServiceConsumerId ServiceConsumerIds;
type record ServiceConsumerId {
  String appInstanceId optional,
  String mepId optional
}

type record ServiceConsumerIdWithError {
  String appId optional,
  String mepId optional
Elian Kraja's avatar
Elian Kraja committed
}

// Erroneous parameter: appInstance should be appInstanceId
type record of ServiceConsumer ServiceConsumers;
type record ServiceConsumer {
  String appInstance optional,
  String mepId optional
}

type record of DeviceInformation DeviceInformations;
type record DeviceInformation {
  String associateId
}


type JSON.AnyURI links;

type enumerated SubscriptionType {
	MobilityProcedureSubscription,
	AdjacentAppInfoSubscription
Elian Kraja's avatar
Elian Kraja committed
}

type record Subscription {
  JSON.AnyURI href,
  SubscriptionType subscriptionType
}


type record of AmsSubscriptionLinkList AmsSubscriptionLinkLists;
type record AmsSubscriptionLinkList {
  JSON.AnyURI links,
  Subscription subscription
}


type record MobilityProcedureSubscriptionError {
  SubscriptionType subscriptionType,
Elian Kraja's avatar
Elian Kraja committed
  JSON.AnyURI callbackReference,
  JSON.AnyURI links optional,
  FilterCriteria filterCriteria,
  TimeStamp expiryDeadline optional 
}


type record of MobilityProcedureSubscription_ MobilityProcedureSubscriptions;
type record MobilityProcedureSubscription_ {
Elian Kraja's avatar
Elian Kraja committed
  SubscriptionType subscriptionType,
  JSON.AnyURI callbackReference,
  JSON.AnyURI links optional,
  FilterCriteria filterCriteria,
  TimeStamp expiryDeadline optional 
}

type enumerated MobilityStatusType {
	INTERHOST_MOVEOUT_TRIGGERED,
	TARGET_APPINST_CONFIRMED,
	TARGET_TRAFFIC_RULE_ACTIVATED,
	INTERHOST_MOVEOUT_COMPLETED,
	INTERHOST_MOVEOUT_FAILED
}

type record AssociateIdList {
  String associateId
}

type record of FilterCriteria FilterCriterias;
type record FilterCriteria {
	String appInstanceId optional,
	AssociateIdList	associateId optional, 
	MobilityStatusType mobilityStatus	
}



type record AdjacentFilterCriteria {
	String appInstanceId optional
}


type record of ExpiryNotification ExpiryNotifications;
type record ExpiryNotification {
  TimeStamp timeStamp,
  JSON.AnyURI links optional,
  TimeStamp expiryDeadline
}

type record of AdjacentAppInfoSubscription_ AdjacentAppInfoSubscriptions;
type record AdjacentAppInfoSubscription_ {
Elian Kraja's avatar
Elian Kraja committed
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
  SubscriptionType subscriptionType,
  JSON.AnyURI callbackReference,
  JSON.AnyURI links optional,
  AdjacentFilterCriteria filterCriteria,
  TimeStamp expiryDeadline optional
}

  /**
   * @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 {
    Seconds seconds,
    NanoSeconds nanoSeconds
  }
  

  /**
   * @desc The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
   */
  type UInt32 Seconds;

  /**
   * @desc The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
   */
  type UInt32 NanoSeconds;

/**
* @desc Problem Details for HTTP APIs
* @member type_ A URI reference according to IETF RFC 3986 that identifies the problem type
* @member title A short, human-readable summary of the problem type
* @member status The HTTP status code for this occurrence of the problem
* @member detail A human-readable explanation specific to this occurrence of the problem
* @member instance A URI reference that identifies the specific occurrence of the problem
* @see IETF RFC 7807 Clause 3.  The Problem Details JSON Object
*/
type record ProblemDetails {
  JSON.String type_,
  JSON.String title,
  UInt32 status,
  JSON.String detail,
  JSON.String instance
} with {
  variant (type_) "name as 'type'";
}

//  
//  
//  
//  
//  
//  
//  
//  
//  
//  
//  
//  
//  
//  
//  
//  
//  
//  
//  
//  
//  /**
//   * @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 {
//    Seconds seconds,
//    NanoSeconds 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 {
//    JSON.Number latitude,
//    JSON.Number longitude,
//    JSON.Number 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 JSON.String 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 JSON.String Address
//
//  /**
//   * @desc Reserved for future use.
//   */
//  type JSON.String AncillaryInfo;
//
//  /**
//   * @desc CallBackData if passed by the application during the associated ZonalTrafficSubscription and UserTrackingSubscription operation. See [\
//REST_NetAPI_Common].
//   */
//  type JSON.String 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 JSON.String 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 JSON.String ContextLocationInfo;
//
//  /**
//   * @desc Zone ID
//   */
//  type JSON.String 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 JSON.Date Duration;
//
//  /**
//   * @desc Interest realm of access point (e.g. geographical area, a type of industry etc.).
//   */
//  type JSON.String InterestRealm;
//
//  /**
//   * @desc Link to other resources
//   * @member rel Describes the relationship between the URI and the resource.
//   * @member href UTI
//   */
//  type record Link {
//    JSON.String rel,
//    JSON.String href
//  }
//
//  /**
//   * @desc The URL of your own listener application.
//   */
//  type JSON.String 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 JSON.String PreviousAccessPointId;
//
//  /**
//   * @desc Self referring URL
//   */
//  type JSON.AnyURI ResourceURL;
//
//  /**
//   * @desc Indicates the time of day for zonal presence notification.
//   */
//  type JSON.String Timestamp;
//
//  /**
//   * @desc Time zone of access point
//   */
//  type JSON.String 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 JSON.String 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
//  }
//
//  /**
//   * @desc The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
//   */
//  type UInt32 Seconds;
//
//  /**
//   * @desc The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
//   */
//  type UInt32 NanoSeconds;

} with {
encode "JSON"
}