IOS Plus Trade - Web Services Version 4 Walkthrough

Transcription

1 IOS Plus Trade - Web Services Version 4 Walkthrough Visual Basic 2008 sample to retrieve IOS Plus Trade information The purpose of this walkthrough is to build the following Windows Forms Application that will allow you to specify an IOS Plus Server and Account Code and retrieve historical trades for the current day using the TradeGetByAccount API method. 1. Create a new Visual Basic Windows Forms Application and name it IOSPlusTradeV4Example then hit OK:

2 2. Next we need to determine the full URL of the WSDL to provide later when adding a Service Reference. Visit the Web Services 4.0 Web Pages (i.e. via a Web browser and select the WSDL link. The WSDL generator will then be displayed. We then need to enter in our IRESS Username, Company and Password, and select IOSPlus as the Service. Once the IOSPlus service is selected, provide the name of the IOS Plus Server (i.e. IOSPLUSAPI) in which to generate the WSDL from in the Server edit control, then click on the WSDL button:

3 Once the WSDL appears, copy the full URL of the WSDL page as this needs to be provided in the next step when adding a Service Reference. 3. We now need to add a Service Reference to the project. To do this in Visual Studio 2008, you need to right click on the project in the Solution Explorer and select Add Service Reference.

4 4. The Add Service Reference dialog will appear. Specify the full WSDL URL obtained in step 2 as the Address and hit the Go button. If the WSDL is successfully generated the Services list will be populated with a new service called IOSPlus. Set the Namespace to IOSPlus then hit the OK button.

5 The solution should contain a new Service References folder with the IOSPlusService reference: 5. Now we need to modify some of the default values added to the app.config file after the Service Reference was added. Open up the app.config file in the solution and look for the <system.servicemodel> section. The default values given to some of the elements under the <basichttpbinding> section are too restrictive. So the following elements need to be increased to the specified value otherwise errors will occur when attempting to run the sample: maxbuffersize=" " maxreceivedmessagesize=" " maxnametablecharcount=" " Also the default Web Server endpoint URL can be specified under the address element in the <endpoint> section in the app.config file.

6 6. Set the text of Form1 to IOS Plus Trade Example and add the following controls to the form: A new label named Label1 with text IRESS UserName A new textbox named IRESSUserNameTextBox A new label named Label2 with text Company A new textbox named CompanyTextBox A new label named Label3 with text Password. A new textbox named PasswordTextBox and set the PasswordChar property of the textbox to *. A new label named Label4 with text IOS Plus Server A new textbox named IOSPlusServerTextBox A new label named Label5 with text Account Code A new textbox named AccountCodeTextBox A new label named Label6 with text Web Services URL A new textbox named WebServicesURLTextBox A new button named GetTradesButton with text Get Trades A new DataGridView named TradeDataGridView that will display the returned trades. We want to add all output columns for the TradeGetByAccount method into the DataGridView control. The easiest way to do this is by going to the Visual Studio menu Data Show Data Sources. Then drill down the data sources to TradeGetByAccountOutput, expand this and you should then see Input and Result. Drill down Result, select DataRows and drag the DataRows data source onto the DataGridView control. Arrange the controls in a similar fashion to the following:

7 7. Add the code behind Form1 to retrieve and display trades. The main bit of code which gets trades from the specified IOS Plus server is all contained within the GetTradesButton_Click event handler. The idea behind what we are doing is that we first create an IRESS session, use the session key returned by the IRESS session to create a Service session to login to the IOS Plus Server, then with the service session key we can make requests to the IOS Plus server to retrieve trades for a specified account code and date range (and to keep it simple we request trades for the current day). Public Class Form1 Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load Dim ws As IOSPlusService.IOSPLUSSoapClient = New IOSPlusService.IOSPLUSSoapClient ' Define a Web Service instance WebServicesURLTextBox.Text = ws.endpoint.address.tostring() ' The endpoint URL is defined in app.config once the Service Reference has been added IRESSUserNameTextBox.Text = "" CompanyTextBox.Text = "" PasswordTextBox.Text = "" IOSPlusServerTextBox.Text = "" AccountCodeTextBox.Text = "" End Sub Private Sub GetTradesButton_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles GetTradesButton.Click Try ' Define a Web Service instance Dim ws As IOSPlusService.IOSPLUSSoapClient = New IOSPlusService.IOSPLUSSoapClient

8 ' Set the Web Service URL ws.endpoint.address = New System.ServiceModel.EndpointAddress(WebServicesURLTextBox.Text) ' Set the Web Services request timeout to 30 seconds (greater than IDS request timeout) ws.endpoint.binding.receivetimeout = New TimeSpan(0, 0, 30) ' Create an IRESS session using the IRESSSessionStart method Dim issrequest As IOSPlusService.IRESSSessionStartInput = New IOSPlusService.IRESSSessionStartInput() ' Initialize the parameters of our IRESS session issrequest.parameters = New IOSPlusService.IRESSSessionStartInputParameters() issrequest.parameters.username = IRESSUserNameTextBox.Text issrequest.parameters.companyname = CompanyTextBox.Text issrequest.parameters.password = PasswordTextBox.Text issrequest.parameters.applicationid = "IOSPlusTradeV4Example" ' Call the IRESSSessionStart method to create the IRESS session (equivalent to logging in via the front-end) Dim issresult As IOSPlusService.IRESSSessionStartOutput = ws.iresssessionstart(issrequest) If IsNothing(issResult) Then Throw New Exception("Failed to start IRESS session") End If ' Obtain the IRESS session key from the response of the IRESSSessionStart method Dim striresssessionkey = issresult.result.datarows(0).iresssessionkey ' Create an IOS Plus session using the ServiceSessionStart method using the IRESS session key Dim sssrequest As IOSPlusService.ServiceSessionStartInput = New IOSPlusService.ServiceSessionStartInput() ' Initialize the parameters of our IOS Plus session sssrequest.parameters = New IOSPlusService.ServiceSessionStartInputParameters() sssrequest.parameters.service = "IOSPlus" sssrequest.parameters.server = IOSPlusServerTextBox.Text sssrequest.parameters.iresssessionkey = striresssessionkey ' Call the ServiceSessionStart method to create the IOS Plus session (equivalent to logging in to an IOS Plus server via the IOS Plus Status Screen) Dim sssresult As IOSPlusService.ServiceSessionStartOutput = ws.servicesessionstart(sssrequest) If IsNothing(sssResult) Then Throw New Exception(String.Format("Failed to start IOS Plus service for {0}", IOSPlusServerTextBox.Text)) End If ' Obtain the IOS Plus session key from the response of the ServiceSessionStart method Dim striosplussessionkey = sssresult.result.datarows(0).servicesessionkey

9 ' Retrieve trades using the TradeGetByAccount method Dim tgbarequest As IOSPlusService.TradeGetByAccountInput = New IOSPlusService.TradeGetByAccountInput ' Initialize the header, use the IOS session key we got earlier tgbarequest.header = New IOSPlusService.TradeGetByAccountInputHeader() tgbarequest.header.servicesessionkey = striosplussessionkey Dim guid As New Guid() ' Initialize the request options tgbarequest.header.timeout = 25 ' Timeout after 25 seconds tgbarequest.header.pagesize = 1000 ' Recommended maximum page size tgbarequest.header.updates = False ' Don't watch for updates tgbarequest.header.waitforresponse = False ' Request asynchronously to try and prevent likelihood of method call timing out tgbarequest.header.requestid = guid.newguid.tostring() ' Set the request identifier to identify our request when we page through results ' Initialize the request parameters tgbarequest.parameters = New IOSPlusService.TradeGetByAccountInputParameters() tgbarequest.parameters.tradedatetimefrom = System.DateTime.Today() tgbarequest.parameters.tradedatetimeto = System.DateTime.Today() If AccountCodeTextBox.Text = "" Then MsgBox("Please specify an Account.", MsgBoxStyle.Critical) Exit Sub End If tgbarequest.parameters.accountcodearray = New String() {AccountCodeTextBox.Text} Dim arrtraderows As List(Of IOSPlusService.TradeGetByAccountDataRow) = New List(Of IOSPlusService.TradeGetByAccountDataRow) of data ' Call the TradeGetByAccount method until we have received all pages Dim tgbaresult As IOSPlusService.TradeGetByAccountOutput Do tgbaresult = ws.tradegetbyaccount(tgbarequest) ' Add data for each page into an array for display in our DataGridView later arrtraderows.addrange(tgbaresult.result.datarows) Application.DoEvents() ' Since we're in a loop allow processing of all windows messages in message queue Loop While tgbaresult.result.header.statuscode = 1 ' Output all the data returned in the DataGridView on the main form using just a single line of code! TradeDataGridView.DataSource = arrtraderows Catch ex As Exception MsgBox("Failed to retrieve trade information. Error: " & ex.message)

10 End Try End Sub End Class 8. Compile and run the sample. 9. Fill in the IRESS Username, Company, Password, IOS Plus Server, Account, and Web Services URL and click the Get Trades button to retrieve trades from the specified server.