eQuipAPI

<back to all web services

GetExportTemplateData

Returns matching Work Orders; Requires a valid user to complete this request. Returns a list of LegacyWorkOrders.

The following routes are available for this service:
POST/maintenancemanagement/legacyworkorders/fileReturns matching work ordersWe used POST in lieu of GET as the request can exceed the allowable GET size threshold.
GetExportTemplateData Parameters:
NameParameterData TypeRequiredDescription
UserIDqueryGuidYesThe UserID that authorizes the caller to complete the request. Contact your eQuip admin.
holdingTableIDbodyintNo
tableNamebodystringNo
SearchParamCollectionbodyList<SearchParam>No
RefineFilterbodystringNo
SearchParam Parameters:
NameParameterData TypeRequiredDescription
FieldIDbodystringNo
FieldNamebodystringNo
FieldValuebodyObjectNo
OperatorbodystringNo
FieldTypebodyshortNo
FieldTextbodystringNo
UseMultiSelectbodyboolNo
IsSearchAsTextboxbodyboolNo
FileDownloadDto Parameters:
NameParameterData TypeRequiredDescription
NamepathstringNoFile name

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

<GetExportTemplateData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
  <RefineFilter>String</RefineFilter>
  <SearchParamCollection xmlns:d2p1="http://schemas.datacontract.org/2004/07/eQuipLib">
    <d2p1:Common.SearchParam>
      <d2p1:_x003C_FieldID_x003E_k__BackingField>String</d2p1:_x003C_FieldID_x003E_k__BackingField>
      <d2p1:_x003C_FieldName_x003E_k__BackingField>String</d2p1:_x003C_FieldName_x003E_k__BackingField>
      <d2p1:_x003C_FieldText_x003E_k__BackingField>String</d2p1:_x003C_FieldText_x003E_k__BackingField>
      <d2p1:_x003C_FieldType_x003E_k__BackingField>0</d2p1:_x003C_FieldType_x003E_k__BackingField>
      <d2p1:_x003C_FieldValue_x003E_k__BackingField />
      <d2p1:_x003C_IsSearchAsTextbox_x003E_k__BackingField>false</d2p1:_x003C_IsSearchAsTextbox_x003E_k__BackingField>
      <d2p1:_x003C_Operator_x003E_k__BackingField>String</d2p1:_x003C_Operator_x003E_k__BackingField>
      <d2p1:_x003C_UseMultiSelect_x003E_k__BackingField>false</d2p1:_x003C_UseMultiSelect_x003E_k__BackingField>
    </d2p1:Common.SearchParam>
  </SearchParamCollection>
  <UserID>String</UserID>
  <holdingTableID>0</holdingTableID>
  <tableName>String</tableName>
</GetExportTemplateData>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FileDownloadDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel.Dto">
  <Name>String</Name>
</FileDownloadDto>