POST api/forms/visits?fromDate={fromDate}&toDate={toDate}&page={page}&perPage={perPage}&sort={sort}&count={count}
Gets all past visits that match the search parameters.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| fromDate |
the search will include results that were created or updated since this date time. |
date |
None. |
| toDate |
the search will include results that were created or updated up to this date time. |
date |
None. |
| page |
the number of the page to get. |
integer |
None. |
| perPage |
the number of results on each page. |
integer |
None. |
| sort |
the name of a property in the model used to sort; include a "-" before the name to sort in descending order. |
string |
None. |
| count |
1 to include the total count in a header. |
integer |
None. |
Body Parameters
The input data of this operation.
SearchVisitsInput| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientIdList | Collection of integer |
Required |
Request Formats
application/json, text/json
{
"ClientIdList": [
1,
2
]
}
application/xml, text/xml
<SearchVisitsInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CWI.Mobile.Domain.DTO.ActionInputs">
<ClientIdList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</ClientIdList>
</SearchVisitsInput>
application/x-www-form-urlencoded
Response Information
Resource Description
An Http response message with the folliwing status codes: 200 = success (always includes a list of past visits; however this list can be empty), 400 = bad request (the request is malformed or with invalid data), 500 = something went wrong (the request was not processed)
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. |