eQuipAPI

<back to all web services

FindDlmsLocationReconciliations

Returns matching DLMS 846R Location Reconciliations; Requires a valid user to complete this request. Returns a list of 846R Location Reconciliations.

The following routes are available for this service:
POST/dlms/transactions/846R/location_reconciliationsReturns matching DLMS 846R Location ReconciliationsPOST is used instead of GET as the request payload can exceed the allowable GET size threshold.
GET/dlms/transactions/846R/location_reconciliationsReturns matching DLMS 846R Location ReconciliationsPOST is preferred over GET as the request payload can exceed the allowable GET size threshold.
FindDlmsLocationReconciliations Parameters:
NameParameterData TypeRequiredDescription
UserIDqueryGuidYesThe UserID that authorizes the caller to complete the request. Contact your eQuip admin.
SearchCriteriaCollectionbodyList<SearchParam>NoSearch criteria collection of 846R requests
takebodyintNoThe number of requests to return. 0 returns all entries.
skipbodyintNoThe page offset to start retrieving data. 0 returns first page entries.
sortbodyIEnumerable<Sort>NoThe collection of field and direction to sort requests
filterbodyFilterNoThe parameters collection to filter requests
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/FindDlmsLocationReconciliations HTTP/1.1 
Host: equipstage2.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: {}
}