POST Client/SearchClient

Search for Client by FirstName, LastName, Cell, ID Number.

Request Information

URI Parameters

None.

Body Parameters

ApiClientSearchRequestFilter
NameDescriptionTypeAdditional information
searchString

Gets or sets the client search string.

 string

None.
userID

Gets or sets the user identifier.

 integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "searchString": "sample string 1",
  "userID": 2
}

application/xml, text/xml

Sample: 
<ApiClientSearchRequestFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SyX.Online.API.Models">
  <userID>2</userID>
  <searchString>sample string 1</searchString>
</ApiClientSearchRequestFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiClientListResponse
NameDescriptionTypeAdditional information
ResponseObject

Gets or sets the response object.

 Collection of ApiClientSearch

None.
ResponseType

Gets or sets the type of the response.

 integer

None.
ResponseMessage

Gets or sets the response message.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ResponseObject": [
    {
      "ClientID": 1,
      "FirstName": "sample string 1",
      "IdentityTypeValue": "sample string 2",
      "Initials": "sample string 3",
      "LastName": "sample string 4",
      "CellPhone": "sample string 5",
      "Email": "sample string 6"
    },
    {
      "ClientID": 1,
      "FirstName": "sample string 1",
      "IdentityTypeValue": "sample string 2",
      "Initials": "sample string 3",
      "LastName": "sample string 4",
      "CellPhone": "sample string 5",
      "Email": "sample string 6"
    }
  ],
  "ResponseType": 1,
  "ResponseMessage": "sample string 2"
}

application/xml, text/xml

Sample: 
<ApiClientListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SyX.Online.API.Models">
  <ResponseMessage>sample string 2</ResponseMessage>
  <ResponseType>1</ResponseType>
  <ResponseObject>
    <ApiClientSearch>
      <CellPhone>sample string 5</CellPhone>
      <ClientID>1</ClientID>
      <Email>sample string 6</Email>
      <FirstName>sample string 1</FirstName>
      <IdentityTypeValue>sample string 2</IdentityTypeValue>
      <Initials>sample string 3</Initials>
      <LastName>sample string 4</LastName>
    </ApiClientSearch>
    <ApiClientSearch>
      <CellPhone>sample string 5</CellPhone>
      <ClientID>1</ClientID>
      <Email>sample string 6</Email>
      <FirstName>sample string 1</FirstName>
      <IdentityTypeValue>sample string 2</IdentityTypeValue>
      <Initials>sample string 3</Initials>
      <LastName>sample string 4</LastName>
    </ApiClientSearch>
  </ResponseObject>
</ApiClientListResponse>