Agility Web Services

This section itemizes Agility Web Services, which can be used to export or import data into Agility. All available options are described in sections below.

AddReading

Web service provided to allow adding reading data for particular reading point. This endpoint is designated for IoT system to allow update readings in Agility. Import definition with code "AddReading" is responsible for handling this web service.

Currently only two fields are mandatory for import definition:

1. IotSensorCode field is related with table pmReadingPoint and is required to identify sensor.
2. ReadingValue field represent pmReading.ReadingValue field.

Other defined in WSDL fields are optional, but import definition can be easily modified to handle them according to interface agreements.

Below screen shows Reading Point Form extended with IoTSensorCode field.

To enable IoT Forms please follow Internet of Things Agility integration manual.

Sample XML Messages

Request:

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:gen="http://www.fastnetasp.com/GeneralImport" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soap:Header/>
   <soap:Body>
      <gen:AddReading>
         <gen:LoginService>
            <gen:login>user</gen:login>
            <gen:password>********</gen:password>
         </gen:LoginService>
         
         <gen:Reading>
            <gen:IotSensorCode>18fe34d62e08</gen:IotSensorCode>
            <gen:ReadingValue>44.86</gen:ReadingValue>
            <gen:ReadingDate xsi:nil="true"/>
         </gen:Reading>
         
      </gen:AddReading>
   </soap:Body>
</soap:Envelope>

Response:

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body>
      <AddReadingResponse xmlns="http://www.fastnetasp.com/GeneralImport">
         <ResponseStatus>
            <Code>OK</Code>
            <Message></Message>
         </ResponseStatus>
      </AddReadingResponse>
   </soap:Body>
</soap:Envelope>

WorkPlannerData

Web Service provided to allow getting data which are used to produced Work Planner Report in Agility. Detailed description of the web service can be found at:

Web Services Definitions page under WorkPlannerData item.

Sample XML Message

Below is the sample xml which can be passed to the WorkPlannerData web service:

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:gen="http://www.fastnetasp.com/GeneralImport">
   <soap:Header/>
   <soap:Body>
      <gen:WorkPlannerData>
         <!--Optional:-->
         <gen:LoginService>
            <!--Optional:-->
            <gen:login>LOGIN_NAME</gen:login>
            <!--Optional:-->
            <gen:password>PASSWORD</gen:password>
         </gen:LoginService>
         <gen:startDate>2015-07-07</gen:startDate>
         <gen:endDate>2015-07-07</gen:endDate>
         <!--Optional:-->
         <gen:reportType>Week</gen:reportType>
         <gen:includeStdJobs>false</gen:includeStdJobs>
         <gen:includeOpenWorkOrders>true</gen:includeOpenWorkOrders>
         <gen:includeCompletedWorkOrders>false</gen:includeCompletedWorkOrders>
         <!--Optional:-->
         <gen:filterExpression>maxresults -1</gen:filterExpression>
         <!--Optional:-->
         <gen:startAsset>a</gen:startAsset>
         <!--Optional:-->
         <gen:endAsset>z</gen:endAsset>
         <!--Optional:-->
         <gen:craftCode>Elec</gen:craftCode>
      </gen:WorkPlannerData>
   </soap:Body>
</soap:Envelope>

Parameters description

<gen:login>

Agility valid Login name

<gen:password>

valid password for the login name entered

<gen:startDade>

Beginning of the time frame to generate the data for

<gen:endDate>

End of the time frame to generate the data for

<gen:reportType>

One of the options Day,Week,Month specifying the level of granularity for the data to generate

<gen:includeStdJobs>

If the parameter is set to true, Work Orders which are due to be generated based on the PPM definition will be included in the data

<gen:includeOpenWorkOrders>

If the parameter is set to true Open Work Orders will be include in the data

<gen:includeCompletedWorkOrders>

If the parameter is set to true Completed Work Orders will be included in the data

<gen:filterExpression>

Filter Expression string describing additional filtering criteria that need to be applied for PPM-related or Work Order-related information

<gen:startAsset>

Asset code to specify the beginning of the range of assets which are going to be included in the returned data.

<gen:endAsset>

Asset code to specify the end of the range of assets which are going to be included in the returned data.

<gen:craftCode>

Code of the craft to restrict the returned data to. IF anything specified, only records which relates to a specified craft will be returned. If nothing is specified, data related to any craft will be returned

More information can be found in Work Schedule Planner report