eQuipAPI

FindDlmsTransactionSets

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

The following routes are available for this service:
POST	/dlms/transactions	Returns matching dlms transactions	We used POST in lieu of GET as the request can exceed the allowable GET size threshold.

**FindDlmsTransactionSets** Parameters:
Name	Parameter	Data Type	Required	Description
UserID	query	Guid	Yes	The UserID that authorizes the caller to complete the request. Contact your eQuip admin.
SearchCriteriaCollection	body	List<SearchParam>	No	Search criteria collection of dlms transactions
take	body	int	No	The number of dlms transactions to return. 0 returns all entries.
skip	body	int	No	The page offset to start retrieving data. 0 returns first page entries.
sort	body	IEnumerable<Sort>	No	The collection of field and direction to sort dlms transactions
filter	body	Filter	No	The parameters collection to filter dlms transactions
DlmsTransactionRequestID	query	Guid	Yes	SourceID or RequestID to get list of responses for 846P request.
IsFromViewDPASNotifications	body	string	Yes	To check if View DPAS Notifications button is clicked.
IsFor846PHistory	query	bool	No	To check if the request is for 846P History Responses.

**SearchParam** Parameters:
Name	Parameter	Data Type	Required
FieldID	body	string	No
FieldName	body	string	No
FieldValue	body	Object	No
Operator	body	string	No
FieldType	body	short	No
UseMultiSelect	body	bool	No
IsSearchAsTextbox	body	bool	No
IsTransactionDetailSearch	body	bool	No
IsSubTransactionDetailSearch	body	bool	No
SecondDateRangeValue	body	string	No

**Sort** Parameters:
Name	Parameter	Data Type	Required	Description
Field	body	string	No
Dir	body	string	No

**Filter** Parameters:
Name	Parameter	Data Type	Required
Field	body	string	No
Operator	body	string	No
Value	body	Object	No
Logic	body	string	No
Filters	body	IEnumerable<Filter>	No

**DataSourceResultResponse** Parameters:
Name	Parameter	Data Type	Required
Data	body	IEnumerable	No
Total	body	int	No
IncludeLinkTotal	body	int	No
Aggregates	body	Object	No

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/FindDlmsTransactionSets HTTP/1.1 
Host: equipstage3.e-isg.com 
Content-Type: application/xml
Content-Length: length

<FindDlmsTransactionSets xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel.Dlms.Transactions">
  <DlmsTransactionRequestID>String</DlmsTransactionRequestID>
  <IsFor846PHistory>false</IsFor846PHistory>
  <IsFromViewDPASNotifications>false</IsFromViewDPASNotifications>
  <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>
</FindDlmsTransactionSets>

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>