Guide

Here you'll find all information about our solution!

REST API How to use our REST-full services!

Query Types

You have to options to use our REST-Service:

  • GET-Request Single Search Mode
  • GET-Request Multiple Records Search Mode
Below you'll find examples for both methods how to use them!

GET Single Search Mode

Some Information is mandantory need, some not. Here you'll find the required fields:

  • key (your API-Key which can be found on your account page: 123xx345xxx789)
  • query
So the minimal GET-Requet looks like:

https://restrictedpartyscreening.org/index.php/api/search?key=123xx345xxx789&query=bin

This will return an xml-File with the following format:

	<results>
		<result>
			<id>b78e616610428704930df2d237fb9962</id>
			<list>4</list>
			<score>4.3080683</score>
			<names>
				<name>BIN LADIN, Usama bin Muhammad bin Awad</name>
				<name>BIN LADIN, Usama</name>
			</names>
			<addresses>
				<address>
					<street/>
					<city/>
					<state/>
					<country/>
				</address>
			</addresses>
			<comment/>
		</result>
	</results>
	

GET Multiple Records Search Mode

For the multiple (packaged) search the following fields are mandantory needed:

  • key (your API-Key which can be found on your account page: 123xx345xxx789)
  • query

For the query you have to prepair an so called set of query pairs:

  • ID abccba SEARCHTEXT
  • xyzzyx
As you need a key to match the query backwards to your database, you have to pass an ID before the search text.

So the minimal GET-Requet for a multi-search (2 Packages) looks like:

https://restrictedpartyscreening.org/index.php/api/searchPackage?key=123xx345xxx789&query=1abccbaLADENxyzzyx2abccbaMURAMAR

This will return an xml-File with the following format:

	<results>
		<result>
			<id>b78e616610428704930df2d237fb9962</id>
			<list>4</list>
			<score>4.3080683</score>
			<names>
				<name>BIN LADIN, Usama bin Muhammad bin Awad</name>
				<name>BIN LADIN, Usama</name>
			</names>
			<addresses>
				<address>
					<street/>
					<city/>
					<state/>
					<country/>
				</address>
			</addresses>
			<comment/>
		</result>
		<result>
			<id>a78e616610428704930df2d229fb9962</id>
			<list>2</list>
			<score>6.412345</score>
			<names>
				<name>QADHAFI, MuammarGADDAFI, Mu'ammar</name>
				<name>QADHAFI, Muammar</name>
			</names>
			<addresses>
				<address>
					<street/>
					<city/>
					<state/>
					<country/>
				</address>
			</addresses>
			<comment/>
		</result>
	</results>