POST Directory/SearchClientDirectory

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
APIKey	string	None.
UserId	integer	None.
CustomerId	integer	None.
VisitId	integer	None.
FromDate	date	None.
ToDate	date	None.
ExpFromDate	date	None.
ExpToDate	date	None.
SearchWord	string	None.
NoOfRecord	integer	None.
Status	string	None.
FollowUpFromDate	date	None.
FollowUpToDate	date	None.
VisitFromDate	date	None.
VisitToDate	date	None.
DocNo	string	None.
ClientId	integer	None.
FollowUpStatus	string	None.

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "sample string 1",
  "UserId": 2,
  "CustomerId": 3,
  "VisitId": 4,
  "FromDate": "2025-10-28T05:31:09.0352581+05:30",
  "ToDate": "2025-10-28T05:31:09.0352581+05:30",
  "ExpFromDate": "2025-10-28T05:31:09.0352581+05:30",
  "ExpToDate": "2025-10-28T05:31:09.0352581+05:30",
  "SearchWord": "sample string 5",
  "NoOfRecord": 6,
  "Status": "sample string 7",
  "FollowUpFromDate": "2025-10-28T05:31:09.0352581+05:30",
  "FollowUpToDate": "2025-10-28T05:31:09.0352581+05:30",
  "VisitFromDate": "2025-10-28T05:31:09.0352581+05:30",
  "VisitToDate": "2025-10-28T05:31:09.0352581+05:30",
  "DocNo": "sample string 8",
  "ClientId": 1,
  "FollowUpStatus": "sample string 9"
}

application/xml, text/xml

Sample:

<CustomClass xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DAL.Models">
  <APIKey>sample string 1</APIKey>
  <ClientId>1</ClientId>
  <CustomerId>3</CustomerId>
  <DocNo>sample string 8</DocNo>
  <ExpFromDate>2025-10-28T05:31:09.0352581+05:30</ExpFromDate>
  <ExpToDate>2025-10-28T05:31:09.0352581+05:30</ExpToDate>
  <FollowUpFromDate>2025-10-28T05:31:09.0352581+05:30</FollowUpFromDate>
  <FollowUpStatus>sample string 9</FollowUpStatus>
  <FollowUpToDate>2025-10-28T05:31:09.0352581+05:30</FollowUpToDate>
  <FromDate>2025-10-28T05:31:09.0352581+05:30</FromDate>
  <NoOfRecord>6</NoOfRecord>
  <SearchWord>sample string 5</SearchWord>
  <Status>sample string 7</Status>
  <ToDate>2025-10-28T05:31:09.0352581+05:30</ToDate>
  <UserId>2</UserId>
  <VisitFromDate>2025-10-28T05:31:09.0352581+05:30</VisitFromDate>
  <VisitId>4</VisitId>
  <VisitToDate>2025-10-28T05:31:09.0352581+05:30</VisitToDate>
</CustomClass>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

WebAPIResponse

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
Data	Object	None.
Error	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "Data": {},
  "Error": "sample string 4"
}

application/xml, text/xml

Sample:

<WebAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAL">
  <Data />
  <Error>sample string 4</Error>
  <Message>sample string 2</Message>
  <Success>true</Success>
</WebAPIResponse>