Afin d’effectuer une recherche parmi tous les utilisateurs selon des critères de recherche, le schéma suivant doit être utilisé :
<?xml version= 1.0 encoding= utf-8 ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soap:Body>
<cApiUserSearch>
<CieID></CieID>
<ApiID></ApiID>
<Login ></Login >
<LastName> </LastName>
<FirstName ></FirstName>
<Email></Email>
<UserType></UserType >
<UniqueID></UniqueID>
<InscriptionDate></InscriptionDate>
<UpdateDate></UpdateDate>
</cApiUserSearch>
</soap:Body>
</soap:Envelope>
Le schéma retourné sera le suivant. Il y aura autant de nœuds Match qu’il y a de résultats et le nœud nbrResults contiendra le nombre de résultats.
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<cApiUserSearch>
<Result>
<ResultState></ResultState>
<ResultDetail ></ResultDetail >
</Result>
<CieID></CieID>
<ApiID></ApiID>
<Login ></Login >
<LastName></LastName>
<FirstName ></FirstName >
<Email></Email>
<UserType></UserType >
<InscriptionDate></InscriptionDate>
<UpdateDate></UpdateDate>
<nbrResults></nbrResults>
<Search>
<Match UserID="" Login="" FirstName="" LastName="" Email="” UserType="" UniqueID=”” Status=”” InscriptionDate=”” UpdateDate =”” >
</Match>
</Search >
</cApiUserSearch>
</soap:Body>
</soap:Envelope>
La méthode UserSearch du service web comprend des valeurs communes déjà expliquées dans la méthode UserCreate. Il doit y avoir au moins un critère de recherche. Le nombre maximum de ligne retourné par la recherche est de 200. Si le maximum de ligne a été atteint, le message suivant sera affiché dans le « ResultDetail » : « Plus de 200 résultats ont été trouvés. Seulement 200 résultats seront affichés. »
Les paramètres InscriptionDate et UpdateDate ont été ajouté à la version 8.1 de l’API.