eQuipAPI

<back to all web services

FindDlmsBlockedAssetList

Returns matching dlms blocked asset list; Requires a valid user to complete this request. Returns matching dlms blocked asset list.

The following routes are available for this service:
POST/dlms/transactions/blockedassetsReturns matching dlms blocked asset listWe used POST in lieu of GET as the request can exceed the allowable GET size threshold.
GET/dlms/transactions/blockedassetsReturns matching dlms blocked asset listWe used POST in lieu of GET as the request can exceed the allowable GET size threshold.
FindDlmsBlockedAssetList Parameters:
NameParameterData TypeRequiredDescription
UserIDqueryGuidYesThe UserID that authorizes the caller to complete the request. Contact your eQuip admin.
SearchCriteriaCollectionbodyList<SearchParam>NoSearch criteria collection of 846P 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 .csv suffix or ?format=csv

HTTP + CSV

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

POST /csv/reply/FindDlmsBlockedAssetList HTTP/1.1 
Host: equipstage3.e-isg.com 
Content-Type: text/csv
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/csv
Content-Length: length

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