comment on

Imagine you need to integrate with an application that uses SOAP and the SOAP methods return things like available fields and their properties and lists of options etc. Something like this interface for posting job adverts on a site. So you need to fetch the data and display it in an easier to read format, with the option lists in whatever format your application requires, ...

This is what I just whipped up. Note especially how XML::Rules let me neatly extract just the data I need in the format that makes them easy to display.

use strict;
use warnings; no warnings 'uninitialized';
use LWP::Simple qw(get);
use CGI::Deurl qw(as q); use vars qw(%q);
use CGI::Enurl qw(enurl);
use XML::Rules;
use Data::Dumper;
use File::Basename;
use HTML::Entities;
use Interpolation '"' 
  => sub { '"' . HTML::Entities::encode($_[0], '^\r\n\t !\#\$%\(-;=?-~
+')};

print "HTTP/1.0 200 OK\n" if($ENV{'PerlXS'} eq 'PerlIS');
print "Content-type: text/html\n\n";

my $script = basename($0);

my $site;
if ($q{site} eq '' or $q{UploaderID} eq '' or $q{Password} eq '' or $q
+{back} eq 'yes') {
  print <<"*END*";
<html><head><title>Madgex info</title>
</head>
<body>
 <h1>Select the site</h1>
 <form method="get">
   <select name="site">
*END*
  foreach ( qw(
    grocerjobs.webservice.madgexjb.com
    bighospitality.webservice.madgexjb.com
    foodmanjobs.webservice.madgexjb.com
    grocerjobs.webservice.madgexjbtest.com
    bighospitality.webservice.madgexjbtest.com
    foodmanjobs.webservice.madgexjbtest.com
  )) {
    if ($q{site} eq $_) {
      print "<option selected>$_</option>";
    } else {
      print "<option>$_</option>";
    }
  }
  print <<"*END*";
   </select><br/>
   Uploader ID: <input type="text" name="UploaderID" value=$"{$q{Uploa
+derID}}"><br/>
   Password: <input type="text" name="Password" value=$"{$q{Password}}
+"><br/>
   <input type="submit"><br/>
 </form>
 <small>All fields are required!</small>
</body>
</html>
*END*
    exit;
} else {
    $site = $q{site};
}

print <<"*END*";
<html><head><title>Madgex info</title>
<style>
td { padding: 2px;}
th { padding: 2px;}
h2 { margin-bottom: 3px;}
p { margin-top: 3px;}
</style>
</head>
<body>
*END*


my $uploaderID = $q{UploaderID};
my $password = $q{Password};

my $xml = get(
 "http://$site/jobposting.asmx/Logon?"
  . enurl({sUploaderID => $uploaderID, sPassword => $password})
);

if (! $xml) {
  print <<"*END*";
<h1 style="color: Red;">Invalid Uploader ID or Password for site $site
+</h1>

<p>Go <a href="$script?back=yes&$ENV{QUERY_STRING}">back</a></p>
</body>
</html>
*END*
  exit;
}

my $token = eval {XML::Rules->new(
  rules => {string => 'content'}, stripspaces => 7
)->parse($xml)->{string}};
#print "token=" . $token . "\n";

if (! $token) {
  my $err = $@;
  $xml = HTML::Entities::encode( $xml, '^\r\n\t !\#\$%\(-;=?-~');
  $xml =~ s{^( +)}{ '&nbsp;' x length($1) }gme;
  $xml =~ s/\n/<br\/>\n/sg;

  print <<"*END*";
<h1 style="color: Red;">Invalid login response</h1>
<p>
$xml
</p>

<p style="color: Red;">Error: $err</p>

<p>Go <a href="$script?back=yes&$ENV{QUERY_STRING}">back</a></p>
</body>
</html>
*END*
  exit;
}


$xml = get(
 "http://$site/jobposting.asmx/GetApplicationMethodTypes?"
  . enurl({uiSecurityToken => $token})
);

my $ApplicationMethods = XML::Rules->new(
  rules => {string => 'content array', ArrayOfString => sub {return $_
+[1]->{string}}},
  stripspaces => 7
)->parse($xml);

print "<h2>Application Methods</h2>\n<p>";
print join( "<br/>\n", @$ApplicationMethods);
print "</p>\n\n";

$xml = get(
 "http://$site/jobposting.asmx/GetAvailableRecruiters?"
  . enurl({uiSecurityToken => $token})
);
my $Recruiters = XML::Rules->new(
  rules => {
    'Name,ID' => 'content', 
    WSRecruiter => 'no content array', 
    ArrayOfWSRecruiter => sub {return $_[1]->{WSRecruiter}}},  
  stripspaces => 7
)->parse($xml);

print <<"*END*";
<h2>Recruiters</h2>
<table border="1">
<tr><th>ID</th><th>Name</th></tr>
*END*
foreach (@$Recruiters) {
    print "<tr><td>$_->{ID}</td><td>$_->{Name}</td></tr>\n";
}
print "</table>\n\n";

$xml = get(
 "http://$site/jobposting.asmx/GetJobProperties?"
  . enurl({uiSecurityToken => $token})
);
my $JobProperties = XML::Rules->new(
  rules => {
    '_default' => 'content',
    Mandatory => sub { return Mandatory => ($_[1]->{_content} eq 'true
+' ? 'mandatory' : 'optional')},
    WSJobProperty => 'no content array', 
    ArrayOfWSJobProperty => sub {return $_[1]->{WSJobProperty}}
  }, 
  stripspaces => 7
)->parse($xml);

print <<"*END*";
<h2>Job Properties</h2>
<table border="1">
<tr><th>Name</th><th>Length</th><th>Description</th><th> </th></tr>
*END*
foreach (@$JobProperties) {
  print "<tr><td><b>$_->{Name}</b></td><td>$_->{MaxLen}</td><td>$_->{D
+esc}</td><td>$_->{Mandatory}</td></tr>\n";
}
print "</table>\n\n";

$xml = get(
 "http://$site/jobposting.asmx/GetActiveUpsellPackages?"
  . enurl({uiSecurityToken => $token})
);
my $Upsells = XML::Rules->new(
  rules => {'_default' => 'content', WSUpsell => 'no content array', A
+rrayOfWSUpsell => sub {return $_[1]->{WSUpsell}}},
  stripspaces => 7
)->parse($xml);

print <<"*END*";
<h2>Upsells</h2>
<table border="1">
<tr><th>ID</th><th>Name</th></tr>
*END*
foreach (@$Upsells) {
  print "<tr><td>$_->{ID}</td><td>$_->{Name}</td></tr>\n";
}
print "</table>\n\n";


$xml = get(
 "http://$site/jobposting.asmx/GetCategories?"
  . enurl({uiSecurityToken => $token})
);
#print $xml;
#exit;
my $Categories = XML::Rules->new(
  rules => {
    '_default' => 'content',
    Mandatory => sub { return Mandatory => ($_[1]->{_content} eq 'true
+' ? 'mandatory' : 'optional')},
    MultiSelect => sub { return MultiSelect => ($_[1]->{_content} eq '
+true' ? 'multiple' : 'single')},
    WSCategory => 'no content array', 
    ArrayOfWSCategory => sub {return $_[1]->{WSCategory}}
  },
  stripspaces => 7
)->parse($xml);

#print Dumper($Categories);

print <<"*END*";
<h2>Categories</h2>
<table border="1">
<tr><th>ID</th><th>Name</th><th>Select</th><th>Req?</th><th>Options</t
+h></tr>
*END*

my $catParser = XML::Rules->new(
  rules => {
    '_default' => 'content',
    WSTerm => sub {'@list' => qq{$_[1]->{ID},"$_[1]->{Name}"}},
    ArrayOfWSTerm => sub {return $_[1]->{list}},
  }, 
  stripspaces => 7
);

foreach my $Category (@$Categories) {
  $xml = get(
    "http://$site/jobposting.asmx/GetCategoryTerms?"
    . enurl({uiSecurityToken => $token, sCategoryID => $Category->{ID}
+})
  );
  my $Terms = $catParser->parse($xml);
  if ($Terms and @$Terms) {
    $Terms = join( "<br/>\n", @$Terms)
  } else {
    $Terms = '';
  }

  print "<tr><td><b>$Category->{ID}</b></td><td><b>$Category->{Name}</
+b></td>
<td>$Category->{MultiSelect}</td><td>$Category->{Mandatory}</td>
<td>$Terms</td></tr>\n";
}

print <<"*END*";
</table>
<p>Go <a href="$script?back=yes&$ENV{QUERY_STRING}">back</a></p>
</body>
</html>
*END*

$xml = get( "http://$site/jobposting.asmx/Logoff?" . enurl({uiSecurity
+Token => $token}) );
[download]

Sorry I can't give you a working username and password so this is what the result looks like:

Application Methods

AutoForwardedApplications
ResponseManagement
ExternalRedirect
OfflineApplications

Recruiters

ID	Name
303908	Madgex

Job Properties

Name	Length	Description
JobTitle	255	Mandatory string(255). Title of the job.	mandatory
JobDescription	-1	Mandatory string. Description of the job.	mandatory
ShortJobDescription	255	Optional string(255). Short job description	optional
JobRef	50	Optional string(50). Recruiter's job reference string	optional
JobPostCode	50	Optional string(50). Post code location of the job, which must be either a full, valid UK postcode or outcode only - used for radial searching	optional
LocationDescription	30	Optional string (30). Location description shown on job details	optional
SalaryDescription	30	Mandatory string(30). Salary description shown on job details	mandatory
ContactTitle	50	Optional string(50). Recruiter contact details	optional
ContactFirstName	50	Optional string(50). Recruiter contact details	optional
ContactLastName	50	Optional string(50). Recruiter contact details	optional
Telephone	50	Optional string(50). Recruiter contact details	optional
Fax	50	Optional string(50). Recruiter contact details	optional
Address1	50	Optional string(50). Recruiter contact address details	optional
Address2	50	Optional string(50). Recruiter contact address details	optional
Address3	50	Optional string(50). Recruiter contact address details	optional
CityTown	50	Optional string(50). Recruiter contact address details	optional
County	50	Optional string(50). Recruiter contact address details	optional
PostCode	50	Optional string(50). Recruiter contact address details	optional
Country	50	Optional string(50). Recruiter contact address details	optional

Upsells

ID	Name
2	Featured Job
5	Premium Job

Categories

ID	Name	Select	Req?	Options
104	Job Function	single	mandatory	104001,"Buying" 104002,"Category Management" 104003,"Customer Service" 104004,"Finance" 104005,"Human Resources" 104006,"Marketing" 104007,"Merchandising" 104008,"National Account Management" 104009,"Retail Management" 104010,"Sales" 104011,"Student" 104012,"Other Job Sector"
103	Salary	multiple	optional	103001,"Ł10,000 or below" 103002,"Ł10,001 - Ł15,000" 103003,"Ł15,001 - Ł20,000" 103004,"Ł20,001 - Ł25,000" 103005,"Ł25,001 - Ł30,000" 103006,"Ł30,001 - Ł40,000" 103007,"Ł40,001 - Ł50,000" 103008,"Ł50,001 - Ł60,000" 103009,"Ł60,001 - Ł80,000" 103010,"Ł80,001 - Ł100,000" 103011,"Over Ł100,000" 103012,"Commission only"
106	Location	multiple	mandatory	106001,"East Anglia" 106002,"East Midlands" 106003,"London" 106004,"North East" 106005,"North West" 106006,"Northern Ireland" 106007,"Scotland" 106008,"South East" 106009,"South West" 106010,"Wales" 106011,"West Midlands" 106012,"Yorkshire/Humberside" 106013,"EU" 106014,"Outside EU"
105	Business Sector	single	optional	105001,"Retail" 105002,"Manufacturing" 105003,"Wholesalers" 105004,"Recruitment" 105005,"Other"
102	Hours	single	mandatory	102001,"Full Time" 102002,"Part Time"
101	Contract	single	mandatory	101001,"Permanent" 101002,"Interim"

Jenda
Enoch was right!
Enjoy the last years of Rome.

In reply to Display info from SOAP APIs by Jenda

Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!

Titles consisting of a single word are discouraged, and in most cases are disallowed outright.

Read Where should I post X? if you're not absolutely sure you're posting in the right place.

Please read these before you post! —

Posts may use any of the Perl Monks Approved HTML tags:

a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr

You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)

	For:		Use:
	&		`&`
	<		`<`
	>		`>`
	[		`[`
	]		`]`

Link using PerlMonks shortcuts! What shortcuts can I use for linking?

See Writeup Formatting Tips and other pages linked from there for more info.