LocationAPI.yaml 127 KB
Newer Older
        - ENTERING_AREA_EVENT
        - LEAVING_AREA_EVENT
      type: string

    NotificationResult:
      description: This enumeration represents the result of a localization associated with a notification
      enum:
        - SUCCESS
        - ABNORMAL
      type: string

    OccurrenceInfo:
      description: The enumeration OccurrenceInfo indicates whether event reporting is one time. 
      enum:
        - ONE_TIME_EVENT
        - MULTIPLE_TIME_EVENT
      type: string

    CivicAddress:
      description: Indicates a Civic address
      type: object
      required:
        - country
      properties:
        country:
          description: The two-letter ISO 3166 country code in capital ASCII letters, e.g., DE or US 
          type: string
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: String
        A1:
          description: National subdivisions (state, canton, region, province, prefecture)
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        A2:
          description: County, parish, gun (JP), district (IN)
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        A3:
          description: City, township, shi (JP) 
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        A4:
          description: City division, borough, city district, ward, chou (JP)
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        A5:
          description: Neighbourhood, block 
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        A6:
          description: Group of streets below the neighbourhood level
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        PRD:
          description: Leading street direction
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        POD:
          description: Trailing street suffix
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        STS:
          description: Street suffix or type
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        HNO:
          description: House number
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        HNS:
          description: House number suffix
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        LMK:
          description: Landmark or vanity address 
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        LOC:
          description: Additional location information
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        NAM:
          description: Name (residence and office occupant)
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        PC:
          description: Postal/zip code 
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        BLD:
          description: Building (structure) 
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        UNIT:
          description: Unit (apartment, suite)
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        FLR:
          description: Floor
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ROOM:
          description: Room
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        PLC:
          description: Place-type 
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        PCN:
          description: Postal community name
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        POBOX:
          description: Post office box (P.O. box) 
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ADDCODE:
          description: Additional code
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        SEAT:
          description: Seat (desk, cubicle, workstation)
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        RD:
          description: Primary road or street 
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        RDSEC:
          description: Road clause 
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        RDBR:
          description: Road branch
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        RDSUBBR:
          description: Road sub-branch
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        PRM:
          description: Road pre-modifier
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        POM:
          description: Road post-modifier
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        usageRules:
          description: When present, this IE shall carry the value of "usagerules" Element of the PIDL-LO XML document, with UTF-8 encoding.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        method:
          description: When present, this IE shall contain the method token, carried by the "method" Element of the PIDLLO XML document. 
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        providedBy:
          description: When present, this IE shall carry the value of "provided-by" Element of the PIDL-LO XML document, with UTF-8 encoding. 
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String