eQuipAPI

<back to all web services

FindDlmsCatalogTransactionSets

Returns matching dlms transactions for 832N catalog; Requires a valid user to complete this request. Returns a list of DlmsTransactionSet for 832N catalog.

Returns matching dlms transactions for 832N catalogWe used POST in lieu of GET as the request can exceed the allowable GET size threshold.
FindDlmsCatalogTransactionSets Parameters:
NameParameterData TypeRequiredDescription
UserIDqueryGuidYesThe UserID that authorizes the caller to complete the request. Contact your eQuip admin.
SearchCriteriaCollectionbodyList<SearchParam>NoSearch criteria collection of dlms transactions
takebodyintNoThe number of 832N catalog transactions 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 832N catalog transactions
filterbodyFilterNoThe parameters collection to filter 832N catalog transactions
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 .soap12 suffix or ?format=soap12

HTTP + SOAP12

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

POST /soap12 HTTP/1.1 
Host: equipstage2.e-isg.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<FindDlmsCatalogTransactionSets 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>
</FindDlmsCatalogTransactionSets>

    </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<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>

    </soap12:Body>
</soap12:Envelope>