eQuipAPI

<back to all web services

FindDlmsNotificationMappings

Returns Configure Dlms Notification details; requires a valid user to complete this request

The following routes are available for this service:
POST/dlms/notifications/mappingsReturns a dlms Notifications confuration details.
GET/dlms/notifications/mappingsReturns a dlms Notifications confuration details.
FindDlmsNotificationMappings Parameters:
NameParameterData TypeRequiredDescription
UserIDqueryGuidYesThe UserID that authorizes the caller to complete the request. Contact your eQuip admin.
takebodyintNoThe number of requisitions 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 requisitions
filterbodyFilterNoThe parameters collection to filter requisitions
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/FindDlmsNotificationMappings HTTP/1.1 
Host: equipstage3.e-isg.com 
Content-Type: application/xml
Content-Length: length

<FindDlmsNotificationMappings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
  <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>
</FindDlmsNotificationMappings>
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/eQuip.Domain">
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <Total>0</Total>
</DataSourceResultResponse>