Data Structure

Data is input in the request body in one of two sections:

• Fields – Initial field data. The “fields” section is used to pass in the initial field data required by the entity. Optional fields have a default and should be omitted from the “fields” data if you with the default to be applied. Lgfapi will attempt to use any data passed in the request body over the field default.
• Options – Additional/miscellaneous data. The “options” section is used to pass in extraneous data not directly required by the entity. A common example is the need to pass in a reason code when creating certain entities for the purposes of tracking against writing inventory history records.

JSON Example

{

“fields”: {

“string_field”: “ABC”,

“decimal_field”: 1.234

},

“options”: {

“reason_code: “RC”

},

}

XML Example

<request>

<fields>

<string_field>ABC</string_field>

<decimal_field>1.234</decimal_field>

</fields>

<options>

<reason_code>RC</reason_code>

</options>

</request>

Dates/Times

Temporal data must be iso-8601 format.