‘report’ Node
The 'report' node is an array of 'message' structures, each of which contains data on the transaction entry execution result and its specific meaning depends on the structure it appears in (parent node).
'message' structure
The 'report' node is an array of 'message' structures. At least one 'message' structure must be present. The 'message' structure contains the following elements:
The ‘message’ structure consists of the following elements:
| Name | Required | Type | Description |
|---|---|---|---|
result |
Yes |
string |
brief result of the entry processing; valid values: 'error' – the entry processing has failed 'warning' – the entry processing has been completed with result, slightly different from the expected. There may be more than one warning in a report. 'success' – the entry has been successfully processed with the expected result |
type |
No |
string |
the field is deprecated and may be empty for some messages. It should not be used for report processing. |
code |
No |
enum |
the code of the error or warning in the system |
description |
Yes/No |
string |
mandatory description of the error or warning For success messages it can contain some optional information such as record ID in the database. |
'report' Node Example 1
The following report contains the success message (shown in bold) for an 'update_appointment' command. Note that the 'appointment' node contains only activity key fields (as defined in the 'head/activity/keys' structure) and the 'report' structure:
<appointment>
<appt_number>xx03</appt_number>
<customer_number>Customer_number N61</customer_number>
<report>
<message>
<description>Appointment id = 6488526 </description>
<result>success</result>
<type>update</type>
</message>
</report>
</appointment>'report' Node Example 2
The following report contains the success message (shown in bold) and warning message (shown italics) for an 'update_inventory' command. Note that the 'inventory' node contains only inventory key fields (as defined in the 'head/inventory/keys' structure) and the 'report' structure:
<inventory>
<properties>
<property>
<label>invsn</label>
<value>insert_8888</value>
</property>
</properties>
<report>
<message>
<description>Inventory serial number = insert_8888 </description>
<result>success</result>
<type>update</type>
</message>
<message>
<result>warning</result>
<type/>
<code>69117</code> <
description>Cannot update existing inventory: inserting new- activity type does not support this</description>
</message>
</report>
</inventory>'report' Node Example 3
The following report contains the error message (shown in bold) for an 'update_appointment' command.
<appointment>
<appt_number>0013</appt_number>
<customer_number>Customer_number N54</customer_number>
<report>
<message>
<result>error</result>
<type/>
<code>69051</code>
<description>Property name is empty</description>
</message>
</report>
</appointment>'report' Node Meaning
Meaning of a specific 'report' node depends on the structure of its parent node. For example when 'report' appears inside of an 'appointment' structure, then this report contains the result of the activity transaction identified by the keys of the 'appointment' structure. The following structures in the response can contain report nodes:
| In | appears if | meaning |
|---|---|---|
inventory |
always |
'report' that appears inside the 'inventory' structure and describes the result of the inventory update command – whether it succeeded or failed and if any warning conditions were encountered |
appointment |
always |
'report' that appears inside of the 'appointment' structure and describes the result of the activity update command – whether it succeeded or failed, and if any warning conditions were encountered |
'response' node (root node) |
only when an error occurs |
when 'report' appears inside the 'inbound_interface_response' structure, it usually contains an error message means that the entire transaction failed and no individual commands were processed this can be a result of:
|
'provider' |
only when an error occurs |
when 'report' appears inside of the 'provider' structure it usually contains an error message means that all activity/inventory commands for the resource failed this can be a result of:
|
'command' |
only when an error occurs |
when 'report' appears inside the 'command' structure, it usually contains an error message this means that all activity/inventory commands for this command failed this can be result of:
|