Description
This method is used to search for a person by either their full or partial name.
Request
| Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
|---|
| name | string | Mandatory | Not Relevant | The full name or part of the name needs to be search. |
| applicationName | string | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner. |
<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
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 Code | Description |
|---|
| 104 | Third-party services are not available |
| 123 | An exception occurred while processing your request |
| 146 | The applicationName is not set |
| 138 | applicationName length has exceeded the maximum character limit allowed (10) |
| 167 | You are not authorized to use this method |
| 424 | One or more required fields are empty or null |