JSON - structure parent/child with only one child

silence · December 16, 2024, 9:56am

Problem with integration. Our customer need JSON data without array mark “[” “]”.
We are using standard API page with XSL transformation + virtual output datastructure.

Standard API output from Origam is:
(there is only one child in structure)

{
    "capacity4": null,
    "capacity1": 0.0,
    "distanceCost": null,
    "maximumDistance": null,
    "mustFinishBy": null,
    "specialCodes": null,
    "capacity5": null,
    "maximumDistancePerLeg": null,
    "destination": [
        {
            "street": "Poděbradská 666",
            "postalCode": "88888",
            "longitudeX": 13.91685,
            "locationId": "Depo Sklad",
            "city": "Jirny",
            "latitudeY": 49.11772
        }
    ],
}

Our partner needs output like this:

{
    "capacity4": null,
    "capacity1": 24000.0,           
    "distanceCost": null,
    "maximumDistance": null,
    "mustFinishBy": null,
    "specialCodes": null,
    "capacity5": null,
    "maximumDistancePerLeg": null,
    "destination": {
        "street": "Poděbradská 666",
        "postalCode": "88888",
        "longitudeX": 13.91685,
        "locationId": "Depo Sklad",
        "city": "Jirny",
        "latitudeY": 49.11772
    },
}

Is there any way to get this output from Origam datapage API ?
Thanks Jiri

tvavrda · December 17, 2024, 1:55pm

This is not possible at the moment. We always write the array:

github.com

origam/origam/blob/b903d25cf80a73a1afdbba57baac5569be7abdc1/backend/Origam.Common/Json/DataRowConverter.cs#L59


      
                  serializer.Serialize(writer, row[column]);
              }
              foreach (DataRelation relation in row.Table.ChildRelations)
              {
                  if (relation.Nested)
                  {
                      string childTableName = relation.ChildTable.TableName;
                      writer.WritePropertyName((resolver != null) 
                          ? resolver.GetResolvedPropertyName(childTableName) 
                          : childTableName);
                      writer.WriteStartArray();
                      foreach (DataRow childRow in row.GetChildRows(relation))
                      {
                          this.WriteJson(writer, childRow, serializer);
                      }
                      writer.WriteEndArray();
                  }
              }            
              writer.WriteEndObject();
          }
          public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)

But we have it under control. The solution (new feature) could be to add an attribute to Data Structure Entity, something like bool JsonArray. If false it could omit the array mark. If the child would contain more than 1 record, it would fail.

silence · December 21, 2024, 8:05am

Interesting inspiration which JSON styles are used and named with differencies between. GitHub - bramstein/xsltjson: XSLTJSON - Convert XML to JSON using XSLT

urbanekv · January 22, 2025, 10:58pm

It’s prepared, the property name in the data structure entity is named “SerializeAsSingleJsonObject” so that it’s meaning is straightforward and also it has a default value false, which is needed for maintain backward compatibility for added boolean properties

Test has been added to model-tests model repo
/api/public/test-json-serialize-as-object

system · January 26, 2025, 12:42pm

This topic was automatically closed 2 days after the last reply. New replies are no longer allowed.