3.1.4.3 ReadEntityInstance

  • Article

This operation is used to retrieve the data values of the EntityInstance Identifiers and the display name value of the EntityInstance identified by the input criteria.

The following is the WSDL port type specification of the ReadEntityInstance WSDL operation.

 <wsdl:operation name="ReadEntityInstance" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
   <wsdl:input wsaw:Action="http://tempuri.org/IResolverPickerService/ReadEntityInstance" message="tns1:IResolverPickerService_ReadEntityInstance_InputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:output wsaw:Action="http://tempuri.org/IResolverPickerService/ReadEntityInstanceResponse" message="tns1:IResolverPickerService_ReadEntityInstance_OutputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
 </wsdl:operation>

The input criteria for this operation are the reference to the EntityInstance and the name of display Field.

The protocol client sends an IResolverPickerService_ReadEntityInstance_InputMessage request message and the protocol server responds with an IResolverPickerService_ReadEntityInstance_OutputMessage response message, as follows:

  • The caller of this operation MUST specify:

    • The reference to the EntityInstance which is to be retrieved.

    • The name of a Field of the EntityInstance whose value is to be retrieved as the display name value.

  • If the referenced EntityInstance is found, the protocol server MUST return the data values of the EntityInstance Identifiers corresponding to the identified EntityInstance and MUST return the success status set to true.

  • If the referenced EntityInstance is not found, the protocol server MUST return an empty array of data values of the EntityInstance Identifiers and the success status set to true

This operation MUST return ReadEntityInstanceResponse (section 3.1.4.3.2.2).

If any unexpected error condition is met, the protocol server MUST respond with a SOAP fault, which MUST comply with the SOAP fault specification in section 4.4 of [SOAP1.1]. The faultcode MUST be set to InternalServiceFault. The faultstring MUST be set to an implementation specific string indicating that an error has occurred.