NameDescriptionTypeAdditional information
Id

Match Client by specific Id

integer

None.

FirstName

Match clients with firstname (can match a s single "name" OR list (i.e. "name,name,...") OR range of names (i.e. "name:name"))

string

None.

Surname

Match clients with surname (can match a s single "name" OR list (i.e. "name,name,...") OR range of names (i.e. "name:name"))

string

None.

FirstNameLike

Match clients with first matching given pattern

string

None.

LastNameLike

Match clients with surname matching given pattern

string

None.

Postcode

Match clients with postcode (can match a s single "code" OR list (i.e. "code,code,...") OR range of names (i.e. "code:code"))

string

None.

MainLanguage

Get clients that have ABS code for Language as the main language spoken at home

integer

None.

LanguageLike

Matches clients that the ability to speak language (matching pattern)

string

None.

DOB

Match clients with specified date of birth

string

None.

Phone

Match clients with given phone number. Will pattern match based on only digits substrings found in pattern (e.g. "07 111" will match "%07%111%")

string

None.

Gender

Retrieve clients with gender specified as one of a comma separated list (unknown,male,female)

string

None.

Mobile

Match clients with given mobile phone number. Will pattern match based on only digits substrings found in pattern (e.g. "0044 111" will match "%0400%111%")

string

None.

Limit

Limit to number of rows returned by request (default is 100)

integer

None.

Skip

Number of rows to skip (so we can skip 10 get next 10 etc)

integer

None.