POST Client/Search

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ServiceUsername	string	Required
ServicePassword	string	Required
SearchValue	string	Required
SearchOption	string	None.
ReturnMultiple	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ReturnMultiple": true,
  "SearchOption": "sample string 4",
  "SearchValue": "sample string 3",
  "ServicePassword": "sample string 2",
  "ServiceUsername": "sample string 1"
}

application/xml, text/xml

Sample:

<CustomerSearchRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ServiceUsername>sample string 1</ServiceUsername>
  <ServicePassword>sample string 2</ServicePassword>
  <SearchValue>sample string 3</SearchValue>
  <SearchOption>sample string 4</SearchOption>
  <ReturnMultiple>true</ReturnMultiple>
</CustomerSearchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CustomerSearchResponse

Name	Description	Type	Additional information
CustomerDetails		Collection of CustomerDetail	None.

Response Formats

application/json, text/json

Sample:

{
  "CustomerDetails": [
    {
      "Status": 17,
      "ProductItems": [
        {
          "AccountNumber": "sample string 3",
          "ProductCode": "sample string 2",
          "ProductName": "sample string 1"
        },
        {
          "AccountNumber": "sample string 3",
          "ProductCode": "sample string 2",
          "ProductName": "sample string 1"
        }
      ],
      "DateOfBirth": "2025-04-28T11:23:54.4840179Z",
      "StatusMessage": "sample string 18",
      "RmBranch": "sample string 16",
      "RmName": "sample string 15",
      "Country": "sample string 14",
      "State": "sample string 13",
      "Address": "sample string 12",
      "EmailAddress": "sample string 11",
      "MobileNumber": "sample string 10",
      "PhoneNumber": "sample string 9",
      "Gender": "sample string 8",
      "FullName": "sample string 7",
      "LastName": "sample string 6",
      "FirstName": "sample string 5",
      "Title": "sample string 4",
      "CustomerReferenceAlternate": "sample string 3",
      "CustomerReference": "sample string 2",
      "MembershipNumber": "sample string 1"
    },
    {
      "Status": 17,
      "ProductItems": [
        {
          "AccountNumber": "sample string 3",
          "ProductCode": "sample string 2",
          "ProductName": "sample string 1"
        },
        {
          "AccountNumber": "sample string 3",
          "ProductCode": "sample string 2",
          "ProductName": "sample string 1"
        }
      ],
      "DateOfBirth": "2025-04-28T11:23:54.4840179Z",
      "StatusMessage": "sample string 18",
      "RmBranch": "sample string 16",
      "RmName": "sample string 15",
      "Country": "sample string 14",
      "State": "sample string 13",
      "Address": "sample string 12",
      "EmailAddress": "sample string 11",
      "MobileNumber": "sample string 10",
      "PhoneNumber": "sample string 9",
      "Gender": "sample string 8",
      "FullName": "sample string 7",
      "LastName": "sample string 6",
      "FirstName": "sample string 5",
      "Title": "sample string 4",
      "CustomerReferenceAlternate": "sample string 3",
      "CustomerReference": "sample string 2",
      "MembershipNumber": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

<CustomerSearchResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerDetails>
    <CustomerDetail>
      <MembershipNumber>sample string 1</MembershipNumber>
      <CustomerReference>sample string 2</CustomerReference>
      <CustomerReferenceAlternate>sample string 3</CustomerReferenceAlternate>
      <Title>sample string 4</Title>
      <FirstName>sample string 5</FirstName>
      <LastName>sample string 6</LastName>
      <FullName>sample string 7</FullName>
      <DateOfBirth>2025-04-28T12:23:54.4840179+01:00</DateOfBirth>
      <Gender>sample string 8</Gender>
      <PhoneNumber>sample string 9</PhoneNumber>
      <MobileNumber>sample string 10</MobileNumber>
      <EmailAddress>sample string 11</EmailAddress>
      <Address>sample string 12</Address>
      <State>sample string 13</State>
      <Country>sample string 14</Country>
      <RmName>sample string 15</RmName>
      <RmBranch>sample string 16</RmBranch>
      <Status>17</Status>
      <StatusMessage>sample string 18</StatusMessage>
      <ProductItems>
        <ProductItem>
          <ProductName>sample string 1</ProductName>
          <ProductCode>sample string 2</ProductCode>
          <AccountNumber>sample string 3</AccountNumber>
        </ProductItem>
        <ProductItem>
          <ProductName>sample string 1</ProductName>
          <ProductCode>sample string 2</ProductCode>
          <AccountNumber>sample string 3</AccountNumber>
        </ProductItem>
      </ProductItems>
    </CustomerDetail>
    <CustomerDetail>
      <MembershipNumber>sample string 1</MembershipNumber>
      <CustomerReference>sample string 2</CustomerReference>
      <CustomerReferenceAlternate>sample string 3</CustomerReferenceAlternate>
      <Title>sample string 4</Title>
      <FirstName>sample string 5</FirstName>
      <LastName>sample string 6</LastName>
      <FullName>sample string 7</FullName>
      <DateOfBirth>2025-04-28T12:23:54.4840179+01:00</DateOfBirth>
      <Gender>sample string 8</Gender>
      <PhoneNumber>sample string 9</PhoneNumber>
      <MobileNumber>sample string 10</MobileNumber>
      <EmailAddress>sample string 11</EmailAddress>
      <Address>sample string 12</Address>
      <State>sample string 13</State>
      <Country>sample string 14</Country>
      <RmName>sample string 15</RmName>
      <RmBranch>sample string 16</RmBranch>
      <Status>17</Status>
      <StatusMessage>sample string 18</StatusMessage>
      <ProductItems>
        <ProductItem>
          <ProductName>sample string 1</ProductName>
          <ProductCode>sample string 2</ProductCode>
          <AccountNumber>sample string 3</AccountNumber>
        </ProductItem>
        <ProductItem>
          <ProductName>sample string 1</ProductName>
          <ProductCode>sample string 2</ProductCode>
          <AccountNumber>sample string 3</AccountNumber>
        </ProductItem>
      </ProductItems>
    </CustomerDetail>
  </CustomerDetails>
</CustomerSearchResponse>