Open APIs

 View Only
  • 1.  Can 674 Open API used to represent sub address of site or relationship site within same site address?

    Posted 23 days ago

    Dear All,

    Need your urgent input/comment. We are implementing TMF 674 open AOI To represent Geographic site however if within particular site address if i need to represent particular room where actual server/device is placed then can we add multiple address under place object with different @type / name etc. OR under site relationship we can reference to same site address describing address of respective room.

    Here is our sample API in which we need to add site address room details.

    In this payload we need to add or provide relationship to one more address on same site.. for example we have network site at say X address within that we have node at X floor in Y room address. OR we can add siteCharacteristics as additional object array with name /value pair describing additional details something like that?

    Kindly advise.

    {
      "eventId": "00001",
      "eventTime": "2015-11-16T16:42:25-04:00",
      "eventType": "GeographicSiteCreateEvent",
      "event": {
        "geographicSite": {
          "id": "sd65-8874",
          "href": "https://host:port/geographicSiteManagement/v4/geographicSite/sd65-8874",
          "code": "Network PoP",
          "description": "PoP Center in London",
          "@baseType": "NetworkSite",
          "@type": "GeographicSite",
          "name": "NetworkSite",
          "status": "active",
          "calendar": [ ],
          "place": [
            {
              "id": "9912",
              "@type": "GeographicSite",
              "@baseType": "NetworkSite",
              "name": "NetworkSite",
              "address": {
                "streetNr": "56",
                "streetName": "Arlington",
                "streetType": "Road",
                "postcode": "W45E02",
                "locality": "London",
                "city": "London",
                "stateOrProvince": "Great London",
                "country": "England",
                "geographicLocation": {
                  "geometryType": "point",
                  "accuracy": "",
                  "spatialRef": "WGS84",
                  "geometry": [
                    {
                      "x": " 1.430937",
                      "y": " 43.597208",
                      "z": ""
                    }
                  ]
                }
              }
            }
          ],
          "relatedParty": [
            {
              "id": "45",
              "name": "Jean Pontus",
              "role": "PoP Center manager",
              "@type": "Individual"
            },
            {
              "id": "46",
              "name": "PoP Network Team",
              "role": "PoP Center manager",
              "@type": "Organization"
            }
          ],
          "siteRelationship": [
            {
              "id": "4589-jj65",
              "href": "https://host:port/geographicSiteManagement/v4/geographicSite/4589-jj65",
              "relationshipType": "support",
              "role": "emergency available office",
              "@type": "SiteRelationship"
              "validFor": {
                "endDateTime": "2019-01-02T09:33:35.749Z",
                "startDateTime": "2023-12-31T09:33:35.749Z"
              },
            }
          ]
        }
      }
    }

    @Jonathan Goldberg will you be able to advise anything on this?



    ------------------------------
    Mahesh Choudhari
    OSS solution architect.
    ------------------------------


  • 2.  RE: Can 674 Open API used to represent sub address of site or relationship site within same site address?

    Posted 23 days ago

    I have object as geoGraphicSubAddress to represent related sub address under place address object array which is nothing but part of 673 Open API. So basically, instead giving placeByRef we have given placeByvalue for geogprahic address to represent address and Sub address. Is it fine to implement this way and compliance to TMF guidelines?

    Kindly advise.



    ------------------------------
    Mahesh Choudhari
    UNSPECIFIED
    ------------------------------



  • 3.  RE: Can 674 Open API used to represent sub address of site or relationship site within same site address?

    Posted 4 days ago

    Dear All,

    Further to my earlier question/query i am planning to use following structure under 674 to represent geographicAddress, geographicSubAddress, location etc. by value.

    Kindly provide your views please to comply with TMF API guidelines.

    {
      "eventId": "xxxxx3",
      "eventTime": "2015-11-16T16:42:25-04:00",
      "eventType": "GeographicSiteCreateEvent",
      "event": {
        "geographicSite": {
          "id": "1232131",
          "name": "Sydney",
          "status": "active",
          "href": "https://host:port/geographicSiteManagement/v4/geographicSite/AU007",
          "code": "PoP",
          "description": "PoP Center in Sydney",
          "@baseType": "NetworkSite",
          "@type": "GeographicSite",
          "calendar": [],
          "place": [
            {
              "id": "AUS007",
              "name": "Sydney SY2",
              "@type": "GeographicSite",
              "@baseType": "NetworkSite",
              "geographicAddress": {
                "streetNr": "56",
                "streetName": "Unit C",
                "streetType": "Road",
                "postcode": "W45E02",
                "locality": "Sydney",
                "city": "Sydney",
                "stateOrProvince": "Sydney",
                "country": "Australia",
                "streetNrSuffix": "B",
                "streetNrLast": "",
                "streetNrLastSuffix": "",
                "streetSuffix": "",
                "@type": "GeographicAddress ",
                "geographicLocation": {
                  "geometryType": "point",
                  "accuracy": "Nearest Address (GPS accurate to 100m)",
                  "spatialRef": "WGS84",
                  "geometry": [
                    {
                      "x": "151.188056",
                      "y": "-33.920581"
                    }
                  ]
                },
                "geographicSubAddress": [
                  {
                    "id": "AUSYDB008",
                    "name": "AUS-SYD10",
                    "href": "https://host:port/geographicSiteManagement/v4/geographicSubAddress/AUSYDB008",
                    "levelNumber": "1",
                    "levelType": "floor",
                    "privateStreetNumber": "1",
                    "privateStreetName": "sydenyroad",
                    "subAddressType": "typeOfRoom",
                    "type": "SubUnit",
                    "subUnitType": "Equipment Room",
                    "subUnitNumber": "239",
                    "buildingName": "Sydney SY2",
                    "subUnitState": "Active",
                    "subUnitOwner":"org",
                    "subUnitSupplier":"Equinix",
                    "@type": "GeographicSubAddress"
                  },
                  {
                    "id": "AUSY009",
                    "name": "AUS-SYD11",
                    "href": "https://host:port/geographicSiteManagement/v4/geographicSubAddress/AUS009",
                    "levelNumber": "1",
                    "levelType": "floor",
                    "privateStreetNumber": "1",
                    "privateStreetName": "sydenyroad",
                    "subAddressType": "typeOfRoom",
                    "type": "SubUnit",
                    "subUnitType": "Equipment Room",
                    "subUnitNumber": "239",
                    "buildingName": "Equinix SY2",
                    "subUnitState": "Active",
                    "subUnitOwner":"org",
                    "subUnitSupplier":"Equinix",
                    "@type": "GeographicSubAddress"
                  }
                ]
              }
            }
          ],
          "relatedParty": [
            {
              "id": "Equinix",
              "name": "Equinix",
              "role": "siteSupplier",
              "@type": "Individual"
            },
            {
              "id": "org",
              "name": "org",
              "role": "siteOwner",
              "@type": "Organization"
            }
          ],
          "siteRelationship": []
        }
      }
    }



    ------------------------------
    Mahesh Choudhari
    UNSPECIFIED
    ------------------------------