bvstone

Using the GETURI API to make a RESTful or Web Service Request

Posted:

Using the GETURI API to make a RESTful or Web Service Request

GETURI has been around for along time (over 15 years!), and has been used by thousands of companies for just about any purpose.  It is similar to the cURL command used on other platforms to make requests to web services which in turn return data.

But, what some don't realize is that GETURI has an API interface as well as a command interface.

The source below is a simple example of how to use the GETURI command to retrieve the current time calling a web service.

      ****************************************************************
      /COPY GETURI/QCOPYSRC,GETURICOPY
      ****************************************************************
     D GetUriRG        pr                  extpgm('GETURIRG')    
     D   PR_In                             like(GetUri_In)                    
     D   PR_Out                            like(GetUri_Out)                   
     D   PR_Head                           like(GetUri_Head)                  
     D   PR_Data                           like(GetUri_Data)                  
     D   PR_MsgCd                          like(GetUri_MsgCd)                 
     D   PR_Msg                            like(GetUri_Msg)                   
      ****************************************************************
      /free
       EXSR $LoadParms;
       EXSR $GETURI;

       *INLR = *ON;
       //***************************************************************
       //* Call GETUI
       //***************************************************************
       BegSr $GETURI;

         GetUriRG(GetUri_In:GetUri_Out:GetUri_Head:GetUri_Data:
                  GetUri_MsgCd:GetUri_Msg);

       EndSr;
       //***************************************************************
       //* Load Parameters to call GETURIRG
       //***************************************************************
       BegSr $LoadParms;

         Clear GetUri_In;
         GI_URI = 'http://webservice.theknot.com/Time/GetTime.asmx/currentTime';
         GI_OutType = '*RETURN';
         GI_SprHead = '*YES';

       EndSr;
      /end-free

The important pieces to recognize with this are:

  1. The /COPY statement - This brings in all the variables and data structures needed to make a call to the GETURIRG API.  This /COPY book comes standard with the GETURI software.
  2. The CLEAR operation on the GetUri_In parameter - Because the variables used are in a data structure, using the CLEAR operation on the data structure will initialize each of the values to their value and we won't run into any decimal-data errors, or similar.
  3. The use of GI_OutType = '*RETURN' - What this does is return the response from the web request to the program, specifically to the GetUri_Out parameter
  4. The use of GI_SprHead = '*YES' - This tells GETURI to suppress the HTTP headers that are returned with the data.  This makes parsing the data much easier since we don't have to deal with the headers.  And, if you need to examine or use any of the header data, it will be available in the GetUri_Head variable.

If we run our program in debug, we can see the value that is returned:

                              Evaluate Expression 

 Previous debug expressions 

 > EVAL geturi_out                                                              
   GETURI_OUT =                                                                 
             ....5...10...15...20...25...30...35...40...45...50...55...60       
        1   '<?xml version="1.0" encoding="utf-8"?>  <string xmlns="http:'      
       61   '//webservice.theknot.com/Time">09/15/2014 10:48</string>    '      
      121   '                                                            '      
      181   '                                                            '      
      241   '                                                            '      
      301   '                                                            '      
      361   '                                                            '      
      421   '                                                            '      
      481   '                                                            '      
      541   '                                                            '      
      601   '                                                            '      
                                                                        More... 
 Debug . . . 

 F3=Exit   F9=Retrieve   F12=Cancel   F16=Repeat find   F19=Left   F20=Right 
 F21=Command entry       F23=Display output 

We see that the web service we're using returns XML containing the current time.

If we want to see the headers, we can simply evaluate GetUri_Head:

                              Evaluate Expression 

 Previous debug expressions 

 > EVAL geturi_head                                                             
   GETURI_HEAD =                                                                
             ....5...10...15...20...25...30...35...40...45...50...55...60       
        1   'HTTP/1.1 200 OK  Connection: keep-alive  Date: Mon, 15 Sep 2'      
       61   '014 15:48:34 GMT  Server: Microsoft-IIS/6.0  ServerID: AUSWE'      
      121   'B14  X-Powered-By: ASP.NET  Set-Cookie: temp=T20141509154834'      
      181   '524964; path=/; domain=theknot.com;expires=Fri 22-May-2020 1'      
      241   '3:00:00 GMT;  X-AspNet-Version: 2.0.50727  Cache-Control: pr'      
      301   'ivate, max-age=0  Content-Type: text/xml; charset=utf-8  Con'      
      361   'tent-Length: 116                                            '      
      421   '                                                            '      
      481   '                                                            '      
      541   '                                                            '      
      601   '                                                            '      
                                                                        More... 
 Debug . . . 

 F3=Exit   F9=Retrieve   F12=Cancel   F16=Repeat find   F19=Left   F20=Right 
 F21=Command entry       F23=Display output 

Because the information returned will be small, we can choose to return the data to our program.

The XML can then be parsed using your favorite XML parser.  

If the data returned would be quite large, it may be a better idea to return the data to a stream file instead of the program.  Then once it is retrieved you can pass the name of your stream file to your XML parser so it can do all the dirty work and get you some usable information.

 


Last edited 03/24/2015 at 14:18:38



Latest Posts:

GreenTools For G Suite (G4G) v12.00 Released With Base OAuth 2.0 Functionality GreenTools For G Suite (G4G) v12.00 Released With Base OAuth 2.0 Functionality
Posted by July 28, 2019
BVSTools >> BVSTools Announcements >> GreenTools for G Suite (Google Apps) (G4G) Specific Announcements
BVSTools Small Price Increase in 2020 BVSTools Small Price Increase in 2020
Posted by July 26, 2019
BVSTools >> BVSTools Announcements
GreenTools for Vertex Cloud (VTXCLOUD) Now Available GreenTools for Vertex Cloud (VTXCLOUD) Now Available
Posted by July 22, 2019
BVSTools >> BVSTools Announcements >> GreenTools for Vertex Cloud (VTXCLOUD) Specific Announcements
GreenTools for Google Apps (G4G) - Drive Addon Successfully Verified by Google GreenTools for Google Apps (G4G) - Drive Addon Successfully Verified by Google
Posted by July 22, 2019
BVSTools >> BVSTools Announcements >> GreenTools for G Suite (Google Apps) (G4G) Specific Announcements
Why I Cancelled my DynDNS Service and How I Replaced It with an IBM i Application Why I Cancelled my DynDNS Service and How I Replaced It with an IBM i Application
Posted by July 17, 2019
IBM Power Systems >> (QGPL) IBM i
Green Tools for G Suite (G4G) Product Updates (Licensing, Functionality, Base Product) Green Tools for G Suite (G4G) Product Updates (Licensing, Functionality, Base Product)
Posted by July 13, 2019
BVSTools >> BVSTools Announcements >> GreenTools for G Suite (Google Apps) (G4G) Specific Announcements
Reading JSON Data from Standard Input With YAJL and RPG Reading JSON Data from Standard Input With YAJL and RPG
Posted by July 12, 2019
Programming >> Proof of Concept (POC)
MAILTOOL Updated to Allow Use of IBM Global Security Kit (GSKIT) for SSL/TLS Communications MAILTOOL Updated to Allow Use of IBM Global Security Kit (GSKIT) for SSL/TLS Communications
Posted by June 19, 2019
BVSTools >> BVSTools Announcements >> eMail Tool (MAILTOOL) Specific Announcements
GETURI v10.00 Released Supporting IBM Global Security Kit (GSKIT) and Server Name Indication (SNI) GETURI v10.00 Released Supporting IBM Global Security Kit (GSKIT) and Server Name Indication (SNI)
Posted by June 11, 2019
BVSTools >> BVSTools Announcements >> Get URI (GETURI) Specific Announcements
BVSTools Now Offers Vertex Cloud Interface BVSTools Now Offers Vertex Cloud Interface
Posted by April 15, 2019
BVSTools >> BVSTools Announcements
Token Has an Invalid Signature Error for Office 365 Email Token Has an Invalid Signature Error for Office 365 Email
Posted by March 22, 2019
BVSTools >> BVSTools Software Discussion >> GreenTools for Microsoft Apps (G4MS) Specific Discussion
Resending Emails that have Errored Out with Updated Router or Authentication Information Resending Emails that have Errored Out with Updated Router or Authentication Information
Posted by March 1, 2019
BVSTools >> BVSTools Software Discussion >> Email Tools (MAILTOOL) Specific Discussion
BVSTools Offers Toolset to Work With HubSpot OAuth 2.0 APIs On Your IBM i BVSTools Offers Toolset to Work With HubSpot OAuth 2.0 APIs On Your IBM i
Posted by January 27, 2019
BVSTools >> BVSTools Announcements
G4MSDRV Currently Not Supported G4MSDRV Currently Not Supported
Posted by January 17, 2019
BVSTools >> BVSTools Announcements >> GreenTools for Microsoft Apps (G4MS) Specific Announcements
Removing Trailing Carriage Returns and/or Line Feeds from a String with RPG Removing Trailing Carriage Returns and/or Line Feeds from a String with RPG
Posted by December 26, 2018
Programming >> RPG Programming

Reply




Copyright 1983-2019 BVSTools
GreenBoard(v3) Powered by the eRPG SDK, MAILTOOL Plus!, GreenTools for Google Apps, jQuery, jQuery UI, BlockUI, CKEditor and running on the IBM i (AKA AS/400, iSeries, System i).