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 .xml suffix or ?format=xml

HTTP + XML

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

POST /xml/reply/FindDlmsBlockedAssetList HTTP/1.1 
Host: equipstage2.e-isg.com 
Content-Type: application/xml
Content-Length: length

<FindDlmsBlockedAssetList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel.Dlms.Transactions">
  <SearchCriteriaCollection xmlns:d2p1="http://schemas.datacontract.org/2004/07/eQuipModel">
    <d2p1:SearchParam>
      <d2p1:FieldID>String</d2p1:FieldID>
      <d2p1:FieldName>String</d2p1:FieldName>
      <d2p1:FieldType>0</d2p1:FieldType>
      <d2p1:FieldValue />
      <d2p1:IsSearchAsTextbox>false</d2p1:IsSearchAsTextbox>
      <d2p1:IsSubTransactionDetailSearch>false</d2p1:IsSubTransactionDetailSearch>
      <d2p1:IsTransactionDetailSearch>false</d2p1:IsTransactionDetailSearch>
      <d2p1:Operator>String</d2p1:Operator>
      <d2p1:SecondDateRangeValue>String</d2p1:SecondDateRangeValue>
      <d2p1:UseMultiSelect>false</d2p1:UseMultiSelect>
    </d2p1:SearchParam>
  </SearchCriteriaCollection>
  <UserID>String</UserID>
  <filter xmlns:d2p1="http://schemas.datacontract.org/2004/07/Kendo.DynamicLinq">
    <d2p1:field>String</d2p1:field>
    <d2p1:filters i:nil="true" />
    <d2p1:logic>String</d2p1:logic>
    <d2p1:operator>String</d2p1:operator>
    <d2p1:value />
  </filter>
  <skip>0</skip>
  <sort xmlns:d2p1="http://schemas.datacontract.org/2004/07/Kendo.DynamicLinq" i:nil="true" />
  <take>0</take>
</FindDlmsBlockedAssetList>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DataSourceResultResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
  <Aggregates />
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <IncludeLinkTotal>0</IncludeLinkTotal>
  <Total>0</Total>
</DataSourceResultResponse>