3.1.4.3.2.2 ReadEntityInstanceResponse

  • Article

The ReadEntityInstanceResponse element specifies the result data for the ReadEntityInstance WSDL operation.

 <xs:element name="ReadEntityInstanceResponse" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:complexType>
     <xs:sequence>
       <xs:element minOccurs="1" maxOccurs="1" name="ReadEntityInstanceResult" type="xs:boolean"/>
       <xs:element minOccurs="0" maxOccurs="1" name="ids" type="tns1:ArrayOfString"/>
       <xs:element minOccurs="0" maxOccurs="1" name="displayName" type="xs:string"/>
       <xs:element minOccurs="0" maxOccurs="1" name="message" type="xs:string"/>
       <xs:element minOccurs="1" maxOccurs="1" name="success" type="xs:boolean"/>
     </xs:sequence>
   </xs:complexType>
 </xs:element>

ReadEntityInstanceResult: MUST be set to true if an EntityInstance was identified based on the provided input.

ids: The list of serialized data values of the EntityInstance Identifiers corresponding to the retrieved EntityInstance. Each serialized data value of an EntityInstance Identifier MUST be encoded according to [XML10].

displayName: The display name corresponding to the retrieved EntityInstance. The value MUST be identified in the manner detailed in the description of the third element of the sub list contained in the values element GetEntityInstancesResponse (section 3.1.4.2.2.2). The value MUST be encoded according to [XML10].

message: Contains errors or warnings regarding the process of reading the EntityInstance according to the provided input, if any. The message MUST be encoded as specified in [XML10].

success: A flag indicating whether the operation finished without any unexpected errors. The value SHOULD<2> be set to true if the operation finished without any unexpected errors; false otherwise. The value MUST be ignored by the protocol client. The value MUST be present.