<xsd:simpleType name="MessageReasonCodeEnumeratedType">
<xsd:annotation>
<xsd:documentation source="http://www.starstandard.org/">Code indicating reason for message.</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:normalizedString">
<xsd:enumeration value="Success">
<xsd:annotation>
<xsd:documentation>The operation completed successfully. This does not necessarily mean that the BOD was processed. Instead it means that the client's role is done and that it won't receive any error messages later. Type of Response Code: Success.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="Accepted">
<xsd:annotation>
<xsd:documentation>The BOD was received, validated, and accepted. However, it may not have yet been processed. The client should expect to receive a response once process is complete. If no response will be generated, use the "Success" code instead. This is typically used for batch processing. Type of Response Code: Success.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="Received">
<xsd:annotation>
<xsd:documentation>The BOD was received. However, it has not yet been validated or processed yet. The client may receive a response or a ConfirmBOD at a later time. Type of Response Code: Success.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="Other">
<xsd:annotation>
<xsd:documentation>An unspecified outcome status. The accompanying description array contains the actual text to display to the user. Type of Response Code: Error, Warning.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="Duplicate Document">
<xsd:annotation>
<xsd:documentation>This code refers to a document that already exists. This may happen for a BOD such as ProcessPartsOrder where the document identifiers to another existing parts order from the same dealer. Type of Response Code: Error, Warning.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="Invalid Required Value">
<xsd:annotation>
<xsd:documentation>One or more required data elements have invalid values. Type of Response Code: Error.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="Invalid Optional Value">
<xsd:annotation>
<xsd:documentation>One or more optional data elements have invalid values. Type of Response Code: Warning.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="Already Performed">
<xsd:annotation>
<xsd:documentation>This code refers to an operation that has already been performed on a document. This may happen for a BOD such as CancelPartsOrder where the document identifier refer to a parts order that has already been cancelled. Type of Response Code: Error.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="Cannot Perform">
<xsd:annotation>
<xsd:documentation>This code refers to an operation that cannot be performed such as Change or Cancel based on the receiver's business rules and the condition of the document. For example, the part order has already been shipped therefore the order cannot be cancelled. Type of Response Code: Error.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="Required Field Missing">
<xsd:annotation>
<xsd:documentation>This occurs when one or more required fields are missing. Type of Response Code: Error.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="Optional Field Missing">
<xsd:annotation>
<xsd:documentation>This occurs when one or more optional fields are missing. Type of Response Code: Warning.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="Not Permitted">
<xsd:annotation>
<xsd:documentation>This code occurs when the client attempts to perform an operation that is not permitted. An example of when this may occur is if the dealer attempts to order a part when their account is placed on hold. This is to be used for authorization errors. Type of Response Code: Error.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="Server Error">
<xsd:annotation>
<xsd:documentation>An error (e.g. database server is down) on the server prevented the execution of the BOD. The client will have to resend the BOD at a later time. Type of Response Code: Error.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="BOD Not Supported">
<xsd:annotation>
<xsd:documentation>The received BOD or BOD version is not supported b the receiver. Type of Response Code: Error.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="Invalid Structure">
<xsd:annotation>
<xsd:documentation>The structure of the BOD is not valid. For example, the BOD failed schema validation. Type of Response Code: Error.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
</xsd:restriction>
</xsd:simpleType>
|
XSD Schema Diagram:
Facets: