Version Module - Response

The Data object for a response from the Ui module is defined below, in the order the fields are returned:

The Data object for a response from the Version module is defined below:

🟥 Data

The Data object for a response from the Cd module is defined below, in the order the fields and objects are returned:

Fields: 🔸Product, 🔸Version, 🔸Rootpath, 🔸Copyright

Objects: 🟥Errors[], 🟥Warnings[],

The Data object for a response from the User Interface module is defined below:

🔸 Data.Product

For the SCE JSON, the value of this field will always be set to "SCEJSON".

🔸 Data.Version

Holds the version information for the SCE JSON.

The SCE is versioned with a number formatted as "YYYY.MM.RR". J. L. Sherman and Associates has chosen to base this number upon dates and releases, instead of arbitrary version numbers. Specifically, the first part of the version number (YYYY) refers to the year of the release. The second part of the version number (MM) refers to the month of the quarterly release. As it currently stands, the quarterly releases will be made in January, April, July and October. Thus, the value of MM will always be in {1, 4, 7, 10}. Finally, the last part of the version number (RR) signifies the release number for the given quarter, with zero (0) signifying the first release of the quarter.

Hence, a version number of 2022-01-0 refers to the first release of the SCE JSON for the January, 2022 quarter. Similarly, a version number of 2021-07-02 refers to the third release of the SCE JSON in the July, 2021 quarter.

🔸 Data.Rootpath

Contains the fully qualified path for the default directory in which the SCE JSON will look for a data/ folder containing setup files, if required by the request.

🔸 Data.Copyright

Describes the copyright information for the SCE JSON.

🟥 Data.Errors[]

The Errors[] field contains an array of Strings which describe any errors encountered while handling the request. If the length of the Errors[] Array is zero (0), then the module processed the request successfully, and the Data object can be further processed by the calling application for the returned data.

On the other hand, if the length of the Errors[] Array is greater than zero (0), then this indicates that an error condition has been detected, and the calling application should not process the respons Data object further. In this case, the contents of the Errors[] array will describe the error(s) encountered.

Typical errors include the omission of 🟥 required fields, invalid field values, etc.

🟥 Data.Warnings[]

The Warnings[] field contains an array of Strings which describe any warnings generated by the module handling the request. The most common warnings returned by modules inform the calling application that the module does not recognize a specified field (which may help to isolate a field name spelling error in the calling application's code). Note that field names which start with "//" will bre treated as comment fields by the SCE, and no warnings will be generated for these unrecognized fields.

Example - Request and response illustrating warnings when passing unrecognized fields:

{
  "Module" : "Version",
  "Data" : {
    "//" : "This is a comment.",
    "Hello" : "Friend!",
    "How" : "are you?"
  }
}

{
  "Result" : 200,
  "Module" : "Version",
  "Data" : {
    "Errors" : [
    ],
    "Warnings" : [
      "Request field 'Data.Hello' not recognized.",
      "Request field 'Data.How' not recognized."
    ],
    "Product" : "SCEJSON",
    "Version" : "2021.07.0",
    "Rootpath" : "/var/task",
    "Copyright" : "(c) 2021 J. L. Sherman and Associates, Inc."
  }
}