POST api/Client/GetAll
Request Information
URI Parameters
None.
Body Parameters
ClientLister| Name | Description | Type | Additional information |
|---|---|---|---|
| List | Collection of Client |
None. |
|
| SearchCriteria | Client |
None. |
|
| Pagination | Pagination |
None. |
Request Formats
application/json, text/json
Sample:
{
"List": [
{
"Id": 1,
"GroupId": 2,
"CompanyId": 3,
"Group": "sample string 4",
"FirstName": "sample string 5",
"MiddleName": "sample string 6",
"LastName": "sample string 7",
"EmailAddress": "sample string 8",
"PhoneNumber": "sample string 9",
"DOB": "2026-11-17T09:23:03.9991588+05:30",
"Gender": "sample string 10",
"MaritalStatus": "sample string 11",
"Occupation": "sample string 12",
"IsActive": true,
"AddressId": 1,
"CreatedBy": 14,
"LastModifiedBy": 1,
"Status": "sample string 15",
"Address": "sample string 16",
"AddressLine1": "sample string 17",
"AddressLine2": "sample string 18",
"Area": "sample string 19",
"City": "sample string 20",
"State": "sample string 21",
"ZipCode": "sample string 22"
},
{
"Id": 1,
"GroupId": 2,
"CompanyId": 3,
"Group": "sample string 4",
"FirstName": "sample string 5",
"MiddleName": "sample string 6",
"LastName": "sample string 7",
"EmailAddress": "sample string 8",
"PhoneNumber": "sample string 9",
"DOB": "2026-11-17T09:23:03.9991588+05:30",
"Gender": "sample string 10",
"MaritalStatus": "sample string 11",
"Occupation": "sample string 12",
"IsActive": true,
"AddressId": 1,
"CreatedBy": 14,
"LastModifiedBy": 1,
"Status": "sample string 15",
"Address": "sample string 16",
"AddressLine1": "sample string 17",
"AddressLine2": "sample string 18",
"Area": "sample string 19",
"City": "sample string 20",
"State": "sample string 21",
"ZipCode": "sample string 22"
}
],
"SearchCriteria": {
"Id": 1,
"GroupId": 2,
"CompanyId": 3,
"Group": "sample string 4",
"FirstName": "sample string 5",
"MiddleName": "sample string 6",
"LastName": "sample string 7",
"EmailAddress": "sample string 8",
"PhoneNumber": "sample string 9",
"DOB": "2026-11-17T09:23:03.9991588+05:30",
"Gender": "sample string 10",
"MaritalStatus": "sample string 11",
"Occupation": "sample string 12",
"IsActive": true,
"AddressId": 1,
"CreatedBy": 14,
"LastModifiedBy": 1,
"Status": "sample string 15",
"Address": "sample string 16",
"AddressLine1": "sample string 17",
"AddressLine2": "sample string 18",
"Area": "sample string 19",
"City": "sample string 20",
"State": "sample string 21",
"ZipCode": "sample string 22"
},
"Pagination": {
"PageSize": 1,
"Take": 2,
"Skip": 3,
"CurrentPage": 4,
"TotalPage": 5,
"TotalRecord": 6
}
}
application/xml, text/xml
Sample:
<ClientLister xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgentDeskWebService.Domain">
<List>
<Client>
<Address>sample string 16</Address>
<AddressId>1</AddressId>
<AddressLine1>sample string 17</AddressLine1>
<AddressLine2>sample string 18</AddressLine2>
<Area>sample string 19</Area>
<City>sample string 20</City>
<CompanyId>3</CompanyId>
<CreatedBy>14</CreatedBy>
<DOB>2026-11-17T09:23:03.9991588+05:30</DOB>
<EmailAddress>sample string 8</EmailAddress>
<FirstName>sample string 5</FirstName>
<Gender>sample string 10</Gender>
<Group>sample string 4</Group>
<GroupId>2</GroupId>
<Id>1</Id>
<IsActive>true</IsActive>
<LastModifiedBy>1</LastModifiedBy>
<LastName>sample string 7</LastName>
<MaritalStatus>sample string 11</MaritalStatus>
<MiddleName>sample string 6</MiddleName>
<Occupation>sample string 12</Occupation>
<PhoneNumber>sample string 9</PhoneNumber>
<State>sample string 21</State>
<Status>sample string 15</Status>
<ZipCode>sample string 22</ZipCode>
</Client>
<Client>
<Address>sample string 16</Address>
<AddressId>1</AddressId>
<AddressLine1>sample string 17</AddressLine1>
<AddressLine2>sample string 18</AddressLine2>
<Area>sample string 19</Area>
<City>sample string 20</City>
<CompanyId>3</CompanyId>
<CreatedBy>14</CreatedBy>
<DOB>2026-11-17T09:23:03.9991588+05:30</DOB>
<EmailAddress>sample string 8</EmailAddress>
<FirstName>sample string 5</FirstName>
<Gender>sample string 10</Gender>
<Group>sample string 4</Group>
<GroupId>2</GroupId>
<Id>1</Id>
<IsActive>true</IsActive>
<LastModifiedBy>1</LastModifiedBy>
<LastName>sample string 7</LastName>
<MaritalStatus>sample string 11</MaritalStatus>
<MiddleName>sample string 6</MiddleName>
<Occupation>sample string 12</Occupation>
<PhoneNumber>sample string 9</PhoneNumber>
<State>sample string 21</State>
<Status>sample string 15</Status>
<ZipCode>sample string 22</ZipCode>
</Client>
</List>
<Pagination>
<CurrentPage>4</CurrentPage>
<PageSize>1</PageSize>
<Skip>3</Skip>
<Take>2</Take>
<TotalPage>5</TotalPage>
<TotalRecord>6</TotalRecord>
</Pagination>
<SearchCriteria>
<Address>sample string 16</Address>
<AddressId>1</AddressId>
<AddressLine1>sample string 17</AddressLine1>
<AddressLine2>sample string 18</AddressLine2>
<Area>sample string 19</Area>
<City>sample string 20</City>
<CompanyId>3</CompanyId>
<CreatedBy>14</CreatedBy>
<DOB>2026-11-17T09:23:03.9991588+05:30</DOB>
<EmailAddress>sample string 8</EmailAddress>
<FirstName>sample string 5</FirstName>
<Gender>sample string 10</Gender>
<Group>sample string 4</Group>
<GroupId>2</GroupId>
<Id>1</Id>
<IsActive>true</IsActive>
<LastModifiedBy>1</LastModifiedBy>
<LastName>sample string 7</LastName>
<MaritalStatus>sample string 11</MaritalStatus>
<MiddleName>sample string 6</MiddleName>
<Occupation>sample string 12</Occupation>
<PhoneNumber>sample string 9</PhoneNumber>
<State>sample string 21</State>
<Status>sample string 15</Status>
<ZipCode>sample string 22</ZipCode>
</SearchCriteria>
</ClientLister>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |