/**
 *  @author     ETSI / STF569
 *  @version    $URL$
 *              $Id$
 *  @desc       Module containing types and values for UeIdentiyAPI protocol
 *  @copyright   ETSI Copyright Notification
 *               No part may be reproduced except as authorized by written permission.
 *               The copyright and the foregoing restriction extend to reproduction in all media.
 *               All rights reserved.
 */
module UEidentityAPI_TypesAndValues {
  
  // JSON
  import from JSON all;
  
  // LibCommon
  import from LibCommon_BasicTypesAndValues all;
  
  /**
   * @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 Information of UE identity tag used in UE Identity feature
   * @member ueIdentityTags 1 to N tags presented by a ME Application instance to a ME Platform
   * @see ETSI GS MEC 014 Clause 7.2    Global definitions and resource structure
   */
  type record UeIdentityTagInfo {
    UeIdentityTags ueIdentityTags
  }

  /**
   * @desc Specific tag presented by a ME Application instance to a ME Platform
   * @see ETSI GS MEC 014 Clause 6.2.2  Type: UeIdentityTagInfo
   */
  type JSON.String UeIdentityTag;
  
  /**
   * @desc Status of the resource ueIdentityTagInfo
   * @see ETSI GS MEC 014 Clause 6.2.2  Type: UeIdentityTagInfo
   */
  type enumerated State {
    UNREGISTERED,
    REGISTERED,
    INVALID_STATE // Used for BI tests
  }

  /**
   * @desc ME Application instance to a ME Platform
   * @member ueIdentityTag Specific tag presented by a ME Application instance to a ME Platform
   * @member state Status of the resource ueIdentityTagInfo
   * @see ETSI GS MEC 014 Clause 6.2.2  Type: UeIdentityTagInfo
   */
  type record UeIdentityTagItem {
    JSON.String ueIdentityTag,
    State state
  }

  /**
   * @desc 1 to N tags presented by a ME Application instance to a ME Platform
   * @see ETSI GS MEC 014 Clause 6.2.2  Type: UeIdentityTagInfo
   */
  type record of UeIdentityTagItem UeIdentityTags;
  
} with {
  encode "JSON"
} // End of module UEidentityAPI_TypesAndValues