POST api/Customer/SearchCustomers
Request Information
URI Parameters
None.
Body Parameters
GetCustomerassemblyRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Businessid | integer |
None. |
|
| Searchterm | string |
None. |
|
| Id | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"Businessid": 1,
"Searchterm": "sample string 2",
"Id": 1
}
application/xml, text/xml
Sample:
<GetCustomerassemblyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TAG.ReqResp"> <Id>1</Id> <Businessid>1</Businessid> <Searchterm>sample string 2</Searchterm> </GetCustomerassemblyRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
GetCustomerResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Status | boolean |
None. |
|
| Message | string |
None. |
|
| Token | globally unique identifier |
None. |
|
| BaseObjects | Collection of BaseCustomerModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"Status": true,
"Message": "sample string 2",
"Token": "6ea94bba-c168-482a-ad12-801461a07cc5",
"BaseObjects": [
{
"UserId": 1,
"CustomerTypeId": 1,
"TitleId": 1,
"UnRegistered": true,
"AccountNo": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Mobile": "sample string 4",
"WorkNo": "sample string 5",
"Fax": "sample string 6",
"PersonalEmail": "sample string 7",
"EmailWork": "sample string 8",
"CreditLimit": 1.1,
"HearAboutUs": "sample string 9",
"DateOfBirth": "2026-03-20T14:27:36.5318854+00:00",
"LoyaltyBarcode": "sample string 10",
"TotalPoints": 1,
"PointsLastUpdated": "2026-03-20T14:27:36.5318854+00:00",
"AddressLine1": "sample string 11",
"AddressLine2": "sample string 12",
"AddressLine3": "sample string 13",
"Town": "sample string 14",
"County": "sample string 15",
"PostCode": "sample string 16",
"Country": "sample string 17",
"Latitude": "sample string 18",
"Longitude": "sample string 19",
"TotalValue": 1.1,
"LicenseExpiryDate": "2026-03-20T14:27:36.5318854+00:00",
"Active": true,
"OnHold": true,
"QRCodePath": "sample string 20",
"IsDeleted": true,
"TotalRedeemed": 1,
"table": "sample string 21",
"CreatedBy": 1,
"ModifiedBy": 1,
"CreatedDate": "2026-03-20T14:27:36.5318854+00:00",
"LastUpdated": "2026-03-20T14:27:36.5318854+00:00",
"Id": 1
},
{
"UserId": 1,
"CustomerTypeId": 1,
"TitleId": 1,
"UnRegistered": true,
"AccountNo": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Mobile": "sample string 4",
"WorkNo": "sample string 5",
"Fax": "sample string 6",
"PersonalEmail": "sample string 7",
"EmailWork": "sample string 8",
"CreditLimit": 1.1,
"HearAboutUs": "sample string 9",
"DateOfBirth": "2026-03-20T14:27:36.5318854+00:00",
"LoyaltyBarcode": "sample string 10",
"TotalPoints": 1,
"PointsLastUpdated": "2026-03-20T14:27:36.5318854+00:00",
"AddressLine1": "sample string 11",
"AddressLine2": "sample string 12",
"AddressLine3": "sample string 13",
"Town": "sample string 14",
"County": "sample string 15",
"PostCode": "sample string 16",
"Country": "sample string 17",
"Latitude": "sample string 18",
"Longitude": "sample string 19",
"TotalValue": 1.1,
"LicenseExpiryDate": "2026-03-20T14:27:36.5318854+00:00",
"Active": true,
"OnHold": true,
"QRCodePath": "sample string 20",
"IsDeleted": true,
"TotalRedeemed": 1,
"table": "sample string 21",
"CreatedBy": 1,
"ModifiedBy": 1,
"CreatedDate": "2026-03-20T14:27:36.5318854+00:00",
"LastUpdated": "2026-03-20T14:27:36.5318854+00:00",
"Id": 1
}
]
}
application/xml, text/xml
Sample:
<GetCustomerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TAG.ReqResp">
<BaseObjects xmlns:d2p1="http://schemas.datacontract.org/2004/07/TAG.DataModels">
<d2p1:BaseCustomerModel>
<d2p1:Id>1</d2p1:Id>
<d2p1:CreatedDate>2026-03-20T14:27:36.5318854+00:00</d2p1:CreatedDate>
<d2p1:LastUpdated>2026-03-20T14:27:36.5318854+00:00</d2p1:LastUpdated>
<d2p1:CreatedBy>1</d2p1:CreatedBy>
<d2p1:ModifiedBy>1</d2p1:ModifiedBy>
<d2p1:AccountNo>sample string 1</d2p1:AccountNo>
<d2p1:Active>true</d2p1:Active>
<d2p1:AddressLine1>sample string 11</d2p1:AddressLine1>
<d2p1:AddressLine2>sample string 12</d2p1:AddressLine2>
<d2p1:AddressLine3>sample string 13</d2p1:AddressLine3>
<d2p1:Country>sample string 17</d2p1:Country>
<d2p1:County>sample string 15</d2p1:County>
<d2p1:CreditLimit>1.1</d2p1:CreditLimit>
<d2p1:CustomerTypeId>1</d2p1:CustomerTypeId>
<d2p1:DateOfBirth>2026-03-20T14:27:36.5318854+00:00</d2p1:DateOfBirth>
<d2p1:EmailWork>sample string 8</d2p1:EmailWork>
<d2p1:Fax>sample string 6</d2p1:Fax>
<d2p1:FirstName>sample string 2</d2p1:FirstName>
<d2p1:HearAboutUs>sample string 9</d2p1:HearAboutUs>
<d2p1:IsDeleted>true</d2p1:IsDeleted>
<d2p1:LastName>sample string 3</d2p1:LastName>
<d2p1:Latitude>sample string 18</d2p1:Latitude>
<d2p1:LicenseExpiryDate>2026-03-20T14:27:36.5318854+00:00</d2p1:LicenseExpiryDate>
<d2p1:Longitude>sample string 19</d2p1:Longitude>
<d2p1:LoyaltyBarcode>sample string 10</d2p1:LoyaltyBarcode>
<d2p1:Mobile>sample string 4</d2p1:Mobile>
<d2p1:OnHold>true</d2p1:OnHold>
<d2p1:PersonalEmail>sample string 7</d2p1:PersonalEmail>
<d2p1:PointsLastUpdated>2026-03-20T14:27:36.5318854+00:00</d2p1:PointsLastUpdated>
<d2p1:PostCode>sample string 16</d2p1:PostCode>
<d2p1:QRCodePath>sample string 20</d2p1:QRCodePath>
<d2p1:TitleId>1</d2p1:TitleId>
<d2p1:TotalPoints>1</d2p1:TotalPoints>
<d2p1:TotalRedeemed>1</d2p1:TotalRedeemed>
<d2p1:TotalValue>1.1</d2p1:TotalValue>
<d2p1:Town>sample string 14</d2p1:Town>
<d2p1:UnRegistered>true</d2p1:UnRegistered>
<d2p1:UserId>1</d2p1:UserId>
<d2p1:WorkNo>sample string 5</d2p1:WorkNo>
<d2p1:table>sample string 21</d2p1:table>
</d2p1:BaseCustomerModel>
<d2p1:BaseCustomerModel>
<d2p1:Id>1</d2p1:Id>
<d2p1:CreatedDate>2026-03-20T14:27:36.5318854+00:00</d2p1:CreatedDate>
<d2p1:LastUpdated>2026-03-20T14:27:36.5318854+00:00</d2p1:LastUpdated>
<d2p1:CreatedBy>1</d2p1:CreatedBy>
<d2p1:ModifiedBy>1</d2p1:ModifiedBy>
<d2p1:AccountNo>sample string 1</d2p1:AccountNo>
<d2p1:Active>true</d2p1:Active>
<d2p1:AddressLine1>sample string 11</d2p1:AddressLine1>
<d2p1:AddressLine2>sample string 12</d2p1:AddressLine2>
<d2p1:AddressLine3>sample string 13</d2p1:AddressLine3>
<d2p1:Country>sample string 17</d2p1:Country>
<d2p1:County>sample string 15</d2p1:County>
<d2p1:CreditLimit>1.1</d2p1:CreditLimit>
<d2p1:CustomerTypeId>1</d2p1:CustomerTypeId>
<d2p1:DateOfBirth>2026-03-20T14:27:36.5318854+00:00</d2p1:DateOfBirth>
<d2p1:EmailWork>sample string 8</d2p1:EmailWork>
<d2p1:Fax>sample string 6</d2p1:Fax>
<d2p1:FirstName>sample string 2</d2p1:FirstName>
<d2p1:HearAboutUs>sample string 9</d2p1:HearAboutUs>
<d2p1:IsDeleted>true</d2p1:IsDeleted>
<d2p1:LastName>sample string 3</d2p1:LastName>
<d2p1:Latitude>sample string 18</d2p1:Latitude>
<d2p1:LicenseExpiryDate>2026-03-20T14:27:36.5318854+00:00</d2p1:LicenseExpiryDate>
<d2p1:Longitude>sample string 19</d2p1:Longitude>
<d2p1:LoyaltyBarcode>sample string 10</d2p1:LoyaltyBarcode>
<d2p1:Mobile>sample string 4</d2p1:Mobile>
<d2p1:OnHold>true</d2p1:OnHold>
<d2p1:PersonalEmail>sample string 7</d2p1:PersonalEmail>
<d2p1:PointsLastUpdated>2026-03-20T14:27:36.5318854+00:00</d2p1:PointsLastUpdated>
<d2p1:PostCode>sample string 16</d2p1:PostCode>
<d2p1:QRCodePath>sample string 20</d2p1:QRCodePath>
<d2p1:TitleId>1</d2p1:TitleId>
<d2p1:TotalPoints>1</d2p1:TotalPoints>
<d2p1:TotalRedeemed>1</d2p1:TotalRedeemed>
<d2p1:TotalValue>1.1</d2p1:TotalValue>
<d2p1:Town>sample string 14</d2p1:Town>
<d2p1:UnRegistered>true</d2p1:UnRegistered>
<d2p1:UserId>1</d2p1:UserId>
<d2p1:WorkNo>sample string 5</d2p1:WorkNo>
<d2p1:table>sample string 21</d2p1:table>
</d2p1:BaseCustomerModel>
</BaseObjects>
<Message>sample string 2</Message>
<Status>true</Status>
<Token>6ea94bba-c168-482a-ad12-801461a07cc5</Token>
</GetCustomerResponse>