LookUpPersonByName

Description

This method is used to search for a person by either their full or partial name.

Request

ParameterTypeMandatory/OptionalMaximum character length/limitDescription
namestringMandatoryNot RelevantThe full name or part of the name needs to be search.
applicationNamestringMandatoryShould be less than or equal to 10 charactersThe name of the integration partner.

Request - Input Sample

<LookUpPersonByName>
	<MethodParameters>
		<UserAuthentication>
      		<UserName>?</UserName>
      		<Password>?</Password>
      		<AnyAttr attr0="XmlAttributeArray" isNull="false">
        		<XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      		</AnyAttr>
    	</UserAuthentication>
    	<lookUpPersonByNameInput>
      		<name>?</name>
    	</lookUpPersonByNameInput>
    	<applicationName>?</applicationName>
	</MethodParameters>
</LookUpPersonByName>

Response

TypeDescription
List<LookUpPersonByNameOutPut>List of persons

Response - Output Sample

<LookUpPersonByNameResult>
	<LookUpPersonByNameOutput>
		<PersonId>--</PersonId>
        <FirstName>--</FirstName>
        <LastName>--</LastName>
        <DOB>YYYY-dd-mm</DOB>
        <Address>
        	<street>--</street>
            <addressNumber>--</addressNumber>
            <postalCode>--</postalCode>
           	<postalPlace>--</postalPlace>
       	</Address>
 	</LookUpPersonByNameOutput>
	<LookUpPersonByNameOutput>
		<PersonId>--</PersonId>
        <FirstName>--</FirstName>
        <LastName>--</LastName>
        <DOB>YYYY-dd-mm</DOB>
        <Address>
        	<street>--</street>
            <addressNumber>-</addressNumber>
            <postalCode>--</postalCode>
           	<postalPlace>--</postalPlace>
       	</Address>
 	</LookUpPersonByNameOutput>
	...
</LookUpPersonByNameResult>

Exceptions

Error CodeDescription
104Third-party services are not available
123An exception occurred while processing your request
146The applicationName is not set
138applicationName length has exceeded the maximum character limit allowed (10) 
167You are not authorized to use this method
424One or more required fields are empty or null