[Fiware-ngsi] reference for JSON structure

[Fermín Galán Márquez]

Dear Tarek,

Please find my comments inline.

El 23/02/2015 a las 21:36, t.elsaleh at surrey.ac.uk<mailto:t.elsaleh at surrey.ac.uk> escribió:
Hello Ken, Fermin,

I would like to share some points about the JSON representation you have documented in the Orion UPG.


·         The structure for NGSI-9 in JSON is a bit different that in XML. I guess this has been done intentionally to make it easier. Wouldn’t it make sense to have it aligned with the XML version, in the sense that the XML version is also simplified? Because this just makes the mapping between XML and JSON more complex.

[FGM1] In fact, I would suggest a more radical approach: remove completely the XML binding and keep only the JSON option. Nobody in modern REST APIs is using XML and after attending ~10 FIWARE events last year where I had the oportunity to talk with developers, I checked that everybody is interested in NGSI JSON and nobody is interested in XML. Let's face the reality.

·         By the way, does your version in JSON consider contextMetadata in the “attributes”? if so, what is it called.

[FGM2] An example of metadata in attributes follows, based in updateContextRequest payload (https://forge.fiware.org/plugins/mediawiki/wiki/fiware/index.php/Publish/Subscribe_Broker_-_Orion_Context_Broker_-_User_and_Programmers_Guide#Custom_attribute_metadata):


{
  "contextElements": [
  {
    "type": "Room",
    "isPattern": "false",
    "id": "Room1",
    "attributes": [
    {
      "name": "temperature",
      "type": "float",
      "value": "26.5",
      "metadatas": [
      {
        "name": "accuracy",
        "type": "float",
        "value": "0.8"
      }
      ]
    }
    ]
  }
  ],
  "updateAction": "APPEND"
}

Although I'm not sure if you refer to that... :)

·         The “s” in “metadatas”, when metadata is already a plural term.

[FGM3] I think you are right, it should be 'metadata' to be correct English. However, changing it now could involve backward compatibility issues in Orion clients using the current syntax. Thus, in this case, probably it doesn't worth to change.

It would be very useful to have a complete JSON example.
[FGM4] The Orion User Manual is plenty of JSON examples, so I'm not sure what do you mean by "complete JSON example"...

Please let me know what you think.

Best regards,
Tarek




From: Ken Zangelin [mailto:kengunnar.zangelin at telefonica.com]
Sent: 01 December 2014 10:19
To: Elsaleh T Mr (Electronic Eng); fermin.galanmarquez at telefonica.com<mailto:fermin.galanmarquez at telefonica.com>
Cc: fiware-ngsi at lists.fi-ware.org<mailto:fiware-ngsi at lists.fi-ware.org>
Subject: Re: [Fiware-ngsi] reference for JSON structure

Hi Tarek,

Fermin is on a short vacation until Thursday.
Your best source for the orion JSON is the wiki:
https://forge.fi-ware.org/plugins/mediawiki/wiki/fiware/index.php/Publish/Subscribe_Broker_-_Orion_Context_Broker_-_User_and_Programmers_Guide

All examples are in XML and JSON.

BR,

/KZ


On 30/11/14 22:35, t.elsaleh at surrey.ac.uk<mailto:t.elsaleh at surrey.ac.uk> wrote:
Hello Fermin,

Could you please point me to where I can find the agreed JSON structure for NGSI-9? …I believe it is not a direct mapping to the XML version.

Best regards,
Tarek





_______________________________________________

Fiware-ngsi mailing list

Fiware-ngsi at lists.fi-ware.org<mailto:Fiware-ngsi at lists.fi-ware.org>

https://lists.fi-ware.org/listinfo/fiware-ngsi

Best regards,

------
Fermín

________________________________

Este mensaje y sus adjuntos se dirigen exclusivamente a su destinatario, puede contener información privilegiada o confidencial y es para uso exclusivo de la persona o entidad de destino. Si no es usted. el destinatario indicado, queda notificado de que la lectura, utilización, divulgación y/o copia sin autorización puede estar prohibida en virtud de la legislación vigente. Si ha recibido este mensaje por error, le rogamos que nos lo comunique inmediatamente por esta misma vía y proceda a su destrucción.

The information contained in this transmission is privileged and confidential information intended only for the use of the individual or entity named above. If the reader of this message is not the intended recipient, you are hereby notified that any dissemination, distribution or copying of this communication is strictly prohibited. If you have received this transmission in error, do not read it. Please immediately reply to the sender that you have received this communication in error and then delete it.

Esta mensagem e seus anexos se dirigem exclusivamente ao seu destinatário, pode conter informação privilegiada ou confidencial e é para uso exclusivo da pessoa ou entidade de destino. Se não é vossa senhoria o destinatário indicado, fica notificado de que a leitura, utilização, divulgação e/ou cópia sem autorização pode estar proibida em virtude da legislação vigente. Se recebeu esta mensagem por erro, rogamos-lhe que nos o comunique imediatamente por esta mesma via e proceda a sua destruição
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.fiware.org/private/fiware-ngsi/attachments/20150224/91cd2408/attachment.html>