eQuipAPI

<back to all web services

FindLegacyWorkOrders

Returns a list of LegacyWorkOrders; Requires a valid user to complete this request.

The following routes are available for this service:
POST/maintenancemanagement/legacyworkordersReturns list of legacy work ordersWe used POST in lieu of GET as the request can exceed the allowable GET size threshold.
FindLegacyWorkOrders Parameters:
NameParameterData TypeRequiredDescription
UserIDqueryGuidYesThe UserID that authorizes the caller to complete the request. Contact your eQuip admin.
SearchCriteriaCollectionbodyList<SearchParam>NoSearch criteria collection of legacy work orders
takebodyintNoThe number of work orders to return. 0 returns all entries;Used only by Telerik UI components
skipbodyintNoThe page offset to start retrieving data. 0 returns first page entries;Used only by Telerik UI components
sortbodyIEnumerable<Sort>NoThe collection of field and direction to sort legacy work orders;Used only by Telerik UI components
filterbodyFilterNoThe parameters collection to filter legacy work orders;Used only by Telerik UI components
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 .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /jsv/reply/FindLegacyWorkOrders HTTP/1.1 
Host: equipstage3.e-isg.com 
Content-Type: text/jsv
Content-Length: length

{
	UserID: String,
	SearchCriteriaCollection: 
	[
		{
			FieldID: String,
			FieldName: String,
			FieldValue: {},
			Operator: String,
			FieldType: 0,
			UseMultiSelect: False,
			IsSearchAsTextbox: False,
			IsTransactionDetailSearch: False,
			IsSubTransactionDetailSearch: False,
			SecondDateRangeValue: String
		}
	],
	take: 0,
	skip: 0,
	filter: 
	{
		field: String,
		operator: String,
		value: {},
		logic: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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