eQuipAPI

<back to all web services

FindReservations

Find Reservations

The following routes are available for this service:
POST/FindReservationsFind ReservationsThis is post in leave of get because the request can get to big.
FindReservations Parameters:
NameParameterData TypeRequiredDescription
UserIDpathstringYesUser Internal ID of User
SearchCriteriaCollectionpathstringNoSearch Criteria Collection
takepathintYestake items per page
skippathintNoskip
sortpathstringNoSort Parameters
filterpathstringNoFilter Parameters Collection
SearchParam Parameters:
NameParameterData TypeRequiredDescription
FieldIDbodystringNo
FieldNamebodystringNo
FieldValuebodyObjectNo
OperatorbodystringNo
FieldTypebodyshortNo
UseMultiSelectbodyboolNo
IsSearchAsTextboxbodyboolNo
IsTransactionDetailSearchbodyboolNo
IsSubTransactionDetailSearchbodyboolNo
SecondDateRangeValuebodystringNo
Sort Parameters:
NameParameterData TypeRequiredDescription
FieldbodystringNo
DirbodystringNo
Filter Parameters:
NameParameterData TypeRequiredDescription
FieldbodystringNo
OperatorbodystringNo
ValuebodyObjectNo
LogicbodystringNo
FiltersbodyIEnumerable<Filter>No
DataSourceResultResponse Parameters:
NameParameterData TypeRequiredDescription
DatabodyIEnumerableNo
TotalbodyintNo
IncludeLinkTotalbodyintNo
AggregatesbodyObjectNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/FindReservations HTTP/1.1 
Host: equipstage3.e-isg.com 
Content-Type: application/json
Content-Length: length

{"UserID":"String","SearchCriteriaCollection":[{"FieldName":"String","FieldValue":{},"Operator":"String"}],"take":0,"skip":0,"filter":{"field":"String","operator":"String","value":{},"logic":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Total":0,"IncludeLinkTotal":0,"Aggregates":{}}