Consume Web Service

chickensoup64 · 2012-12-11 00:44:34 UTC

Hi

I think this topic may be similar to http://forums.squizsuite.net/index.php?showtopic=8509 but not entirely sure so didn't want to hijack that thread.

Is it possible in Matrix to consume a web service and use that information? I'm pretty new to the web service side of things. What I want to be able to do in particular is use http://abr.business.gov.au/abrxmlsearch/Forms/ABRSearchByABN.aspx in a Custom Form so that the user enters information that will be retrieved from the web service, and the data retrieved will used as part of the Custom Form.

It seems from the sample code provided that the HTTP GET option would be the most suitable for Matrix is it is what I am leaning towards if any one can help.

I've looked at the SOAP options in Matrix but realised from the other thread and manuals that it is only for internal Matrix operations, and I'm not sure if/how this can be done with REST assets.

The WSDL is located at http://abr.business.gov.au/abrxmlsearch/AbrXmlSearch.asmx?WSDL

Edison_Wang · 2012-12-12 05:33:41 UTC

SOAP web service is supported in Matrix, and it is NOT only for internal operations, otherwise, it would be a waste of purpose of web service which is the communication channel of 2 systems.

SOAP web service is actually just the exchange of XML messages using HTTP POST protocol. So in theory, you can just use JS to make a POST request with the request message XML, and then got the response from remote server. But the SOAP message could be complicated enough sometime, that you don't want to hand code the XML.

There is SOAP Make SOAP call trigger action and SOAP form submission action asset in Matrix, which support making a SOAP call to remote web service.

I have checked the WSDL you are trying to use, it's a very simple SOAP service without any kind of authentication. So i *guess* those 2 assets should be more than enough to handle it.

One way of implementation, could be setting up the trigger action to fire and make a SOAP call to get results, The results will be stored in global session sandbox, and can be printed using globals_session keyword. So you can pre-filled the form with those keywords. The session data will be wiped when user logs out.

I haven't tested it, it's just my assumption.

Or otherwise, you may try Ajax POST request to directly send the SOAP call. The service doesn't even use authentication, so in theory it should work straightaway.

chickensoup64 · 2012-12-12 10:46:24 UTC

Hey Ed

Thanks for that info, its helped me get a bit further. You mention that the data is wiped when a user logs out but will the session variables still be available for users accessing the form who are not logged in? The site does not intend to have user login.

I've tried using Make SOAP Call on the Submission Actions screen of a custom form and am having some difficulty with it.

EDIT: ~~Using the follow XML doesn't ever seem to return any results, however replacing the form response keyword with a hard coded value such as "51835430479" works perfectly fine. What am I doing wrong?~~

<?xml version="1.0" encoding="utf-8"?>
<ABRSearchByABN>
 <searchString>%response_100_q1%</searchString>
 <includeHistoricalDetails>N</includeHistoricalDetails>
 <authenticationGuid>123456789123456789-123456789</authenticationGuid>
</ABRSearchByABN>

Additionally when the SOAP response works ~~(with a hard coded value)~~ and I run Test Response I get the "Response:" below that which includes the information I am after. For example:

<organisationName>DEPARTMENT  OF  INDUSTRY  TOURISM  AND  RESOURCES</organisationName>

Yet none of the keywords listed in the Keywords Available section allows me to grab that information but that one piece of data is what I am after. Again - am I doing something wrong?

One last thing is related to the AJAX call. Using the below jQuery makes the AJAX call but loads up another new instance of the Custom Form, instead of the Thank You page of that form.

function submitABN(){
	var ABN = $("#searchString").val();
	console.log(ABN);
	$.ajax({
	  type: 'POST',
	  url: "http://www.example.com/form",
	  data: {searchString : ABN},
	  success: function(data){$('.result').html(data);$('#orgName').val(data);console.log('Load was performed.');},
	  dataType: "text"
	});
}

Really all I need is for the AJAX to load the value returned in the XML <organisationName> as outlined above so perhaps my implementation for this is way off?

Edison_Wang · 2012-12-12 23:24:22 UTC

I tested it that API call with submission action. I made up the authenticationGUID so it gives me an error message in response instead.

So i can't really fully test it for you.

But other than that, i can see heaps of keywords are listed on the screen to print response.

organisationName doesn't look like to be a response element of ABRSearchByABN API. You can see the response definition in their WSDL file.

or in this page

http://abr.business.gov.au/abrxmlsearch/Forms/ABRSearchByABN.aspx

The keywords are formated to represent the structure of result XML.

Below is some keywords example. You can see the first one represents the xml structure of ABRPayloadSearchResults => exception => exceptionDescription

%globals_session_soap_ABRPayloadSearchResultsresponseexceptionexceptionDescription% %globals_session_soap_ABRPayloadSearchResultsresponseexceptionexceptionCode%
%globals_session_soap_ABRPayloadSearchResultsresponseabnListnumberOfRecords%
%globals_session_soap_ABRPayloadSearchResultsresponseabnListabn%

Below is the my test request and response.

ABRSearchByABN
Request:

<?xml  version=“1.0”  encoding=“UTF-8”?>

<SOAP-ENV:Envelope  xmlns:SOAP-ENV=“http://schemas.xmlsoap.org/soap/envelope/”  xmlns:ns1=“http://abr.business.gov.au/ABRXMLSearch/”><SOAP-ENV:Body><ns1:ABRSearchByABN><ns1:searchString>52826727261</ns1:searchString><ns1:includeHistoricalDetails>N</ns1:includeHistoricalDetails><ns1:authenticationGuid></ns1:authenticationGuid></ns1:ABRSearchByABN></SOAP-ENV:Body></SOAP-ENV:Envelope>
Response:

<?xml  version=“1.0”  encoding=“utf-8”?><soap:Envelope  xmlns:soap=“http://schemas.xmlsoap.org/soap/envelope/”  xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance”  xmlns:xsd=“http://www.w3.org/2001/XMLSchema”><soap:Body><ABRSearchByABNResponse  xmlns=“http://abr.business.gov.au/ABRXMLSearch/”><ABRPayloadSearchResults><request><identifierSearchRequest><authenticationGUID  /><identifierType>ABN</identifierType><identifierValue>52826727261</identifierValue><history>N</history></identifierSearchRequest></request><response><dateRegisterLastUpdated>0001-01-01</dateRegisterLastUpdated><dateTimeRetrieved>2012-12-13T10:05:25.9648289+11:00</dateTimeRetrieved><exception><exceptionDescription>The  GUID  entered  is  not  recognised  as  a  Registered  Party.  :  </exceptionDescription><exceptionCode>WebServices</exceptionCode></exception></response></ABRPayloadSearchResults></ABRSearchByABNResponse></soap:Body></soap:Envelope

chickensoup64 · 2012-12-12 23:52:12 UTC

I've sent you a GUID that you can use to test with.

In the response on the ABR site it includes <organisationName>

<mainName>
  <organisationName>DEPARTMENT OF INDUSTRY TOURISM AND RESOURCES</organisationName>
  <effectiveFrom>2002-11-26</effectiveFrom>
</mainName>

Using the same request that you have in your example with a GUID will give the correct response with the organisationName displayed so I would have thought it would be available.

I'm basically trying to recreate what is on the Telstra site minus the ACN aspect https://store.t-suite.telstra.com/jsdn/web/login/loginview.jsp?view=.view.jsdn.store.enduser.register

Edison_Wang · 2012-12-12 23:57:35 UTC

Everything works for me.

Something to note for you.

The keyword for question response ( %response_100_q1%), would have to be the your specific question asset's id. You can't just use that example one. In my case, it's %response_15097_q4%. 15097 is the form section id. You can see the question asset id by hovering mouse on the question asset.

In the Thank you page, i use below keyword to print out the family name of the ABN search result. This keyword is also listed in the available response keyword section.

It also makes sense when you look at the sample request and response.

%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntitylegalNamefamilyName%

I think if you can get the hand coded ABN working, it might be just a matter of getting the global session keyword right, to print the exact result you want.

I used my ABN to test, there is no orgnanisation name element in the response. only legal name. But it might not be the case for you. You can only use the keywords to print whatever in the actual response, which should be same as your hand coded sample request/response.

Edison_Wang · 2012-12-12 23:58:36 UTC

http://abr.business.gov.au/ the website is down now.

chickensoup64 · 2012-12-13 00:12:23 UTC

Yea I noticed the site went down while I was writing my last response.

I've got the %response% keyword pointing to the correct field and I've even tried printing all the available listed keywords but none return the name. Are the listed keywords the only available ones? Or are there some which do not appear in that list but are still accessible?

chickensoup64 · 2012-12-13 07:23:22 UTC

Sorry in advance for the long post.

My request is as follows (the authenticationGuid is dummy text for this post, and the searchString will become dynamic in production):

<?xml version="1.0"?>
<ABRSearchByABN>
 <searchString>51835430479</searchString>
 <includeHistoricalDetails>N</includeHistoricalDetails>
 <authenticationGuid>111-111-111-111-111</authenticationGuid>
</ABRSearchByABN>

Doing a test response sends back:

[b]Request:[/b]
<?xml  version="1.0"  encoding="UTF-8"?>
<SOAP-ENV:Envelope  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:ns1="http://abr.business.gov.au/ABRXMLSearch/"><SOAP-ENV:Body><ns1:ABRSearchByABN><ns1:searchString>51835430479</ns1:searchString><ns1:includeHistoricalDetails>N</ns1:includeHistoricalDetails><ns1:authenticationGuid>f42a23fc-63c9-463b-9507-d83c18d0f9de</ns1:authenticationGuid></ns1:ABRSearchByABN></SOAP-ENV:Body></SOAP-ENV:Envelope>
[b]Response:[/b]

<?xml  version=“1.0”  encoding=“utf-8”?><soap:Envelope  xmlns:soap=“http://schemas.xmlsoap.org/soap/envelope/”  xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance”  xmlns:xsd=“http://www.w3.org/2001/XMLSchema”><soap:Body><ABRSearchByABNResponse  xmlns=“http://abr.business.gov.au/ABRXMLSearch/”><ABRPayloadSearchResults><request><identifierSearchRequest><authenticationGUID>f42a23fc-63c9-463b-9507-d83c18d0f9de</authenticationGUID><identifierType>ABN</identifierType><identifierValue>51835430479</identifierValue><history>N</history></identifierSearchRequest></request><response><usageStatement>This  extract  is  based  on  information  supplied  by  businesses  to  the  Registrar  of  the  Australian  Business  Register.

Neither  the  Registrar  nor  the  Australian  Government  guarantee  this  information  is  accurate,  up  to  date  or  complete.

You  should  consider  verifying  this  information  from  other  sources.</usageStatement><dateRegisterLastUpdated>2012-12-13</dateRegisterLastUpdated><dateTimeRetrieved>2012-12-13T18:03:11.7419943+11:00</dateTimeRetrieved><businessEntity><recordLastUpdatedDate>2009-02-16</recordLastUpdatedDate><ABN><identifierValue>51835430479</identifierValue><isCurrentIndicator>Y</isCurrentIndicator><replacedFrom>0001-01-01</replacedFrom></ABN><entityStatus><entityStatusCode>Cancelled</entityStatusCode><effectiveFrom>2008-10-31</effectiveFrom><effectiveTo>0001-01-01</effectiveTo></entityStatus><ASICNumber  /><entityType><entityTypeCode>CGE  </entityTypeCode><entityDescription>Commonwealth  Government  Entity</entityDescription></entityType><mainName><organisationName>DEPARTMENT  OF  INDUSTRY  TOURISM  AND  RESOURCES</organisationName><effectiveFrom>2002-11-26</effectiveFrom></mainName><mainBusinessPhysicalAddress><stateCode>ACT</stateCode><postcode>2601</postcode><effectiveFrom>2005-10-02</effectiveFrom><effectiveTo>0001-01-01</effectiveTo></mainBusinessPhysicalAddress></businessEntity></response></ABRPayloadSearchResults></ABRSearchByABNResponse></soap:Body></soap:Envelope>

Notice in the Response section that organisationName returns a value which in this example is "DEPARTMENT OF INDUSTRY TOURISM AND RESOURCES". That's perfect!

Edit (just noticed the code highlighting didn't work first time):

<organisationName>DEPARTMENT  OF  INDUSTRY  TOURISM  AND  RESOURCES</organisationName>

In the Keywords Available (keywords listed below) section, there is no way for me reference this value. From reading the WDSL and confirming with the ABR Lookup support staff I can confirm:

If an entity is an individual/sole trader, the name displayed as Entity Name on ABN Lookup comes through as LegalName in the XML
If an entity is an organisation, the name displayed as Entity Name on ABN Lookup comes through as MainName in the XML

That information is outlined in Chapter 8 (Search Response) in http://abr.business.gov.au/Downloads/UsingABNLookupwebservices.pdf.

So I must be doing something wrong if you can get yours to work Ed and I can't. I've uploaded a screenshot of my Form Action page for reference. If you have a working copy that I can view and feel generous are you able to share it via something like the XML Export tool? :D

Keywords Available

%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestauthenticationGUID%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestname%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestfiltersnameTypetradingName%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestfiltersnameTypelegalName%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestfilterspostcode%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestfiltersstateCodeQLD%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestfiltersstateCodeNT%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestfiltersstateCodeSA%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestfiltersstateCodeWA%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestfiltersstateCodeVIC%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestfiltersstateCodeACT%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestfiltersstateCodeTAS%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestfiltersstateCodeNSW%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestAdvancedsearchWidth%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestAdvancedminimumScore%
%globals_session_soap_ABRPayloadSearchResultsrequestidentifierSearchRequestauthenticationGUID%
%globals_session_soap_ABRPayloadSearchResultsrequestidentifierSearchRequestidentifierType%
%globals_session_soap_ABRPayloadSearchResultsrequestidentifierSearchRequestidentifierValue%
%globals_session_soap_ABRPayloadSearchResultsrequestidentifierSearchRequesthistory%
%globals_session_soap_ABRPayloadSearchResultsrequestexternalRequestABNCharityFilterstate%
%globals_session_soap_ABRPayloadSearchResultsrequestexternalRequestABNCharityFiltercharityTypeCode%
%globals_session_soap_ABRPayloadSearchResultsrequestexternalRequestABNCharityFilterconcessionTypeCode%
%globals_session_soap_ABRPayloadSearchResultsrequestexternalRequestABNUpdateEventFilterstate%
%globals_session_soap_ABRPayloadSearchResultsrequestexternalRequestABNUpdateEventFilterupdateDate%
%globals_session_soap_ABRPayloadSearchResultsrequestexternalRequestABNStatusFilteractiveABNs%
%globals_session_soap_ABRPayloadSearchResultsrequestexternalRequestABNStatusFiltercurrentGSTRegistrationOnly%
%globals_session_soap_ABRPayloadSearchResultsrequestexternalRequestABNEventFilterstate%
%globals_session_soap_ABRPayloadSearchResultsrequestexternalRequestABNEventFiltermonth%
%globals_session_soap_ABRPayloadSearchResultsrequestexternalRequestABNEventFilteryear%
%globals_session_soap_ABRPayloadSearchResultsrequestexternalRequestABNFilterauthenticationGUID%
%globals_session_soap_ABRPayloadSearchResultsrequestexternalRequestABNFilterpostcode%
%globals_session_soap_ABRPayloadSearchResultsrequestexternalRequestABNFilterentityTypeCode%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestAdvanced2012authenticationGUID%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestAdvanced2012name%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestAdvanced2012filtersnameTypetradingName%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestAdvanced2012filtersnameTypelegalName%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestAdvanced2012filtersnameTypebusinessName%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestAdvanced2012filterspostcode%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestAdvanced2012filtersstateCodeQLD%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestAdvanced2012filtersstateCodeNT%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestAdvanced2012filtersstateCodeSA%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestAdvanced2012filtersstateCodeWA%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestAdvanced2012filtersstateCodeVIC%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestAdvanced2012filtersstateCodeACT%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestAdvanced2012filtersstateCodeTAS%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestAdvanced2012filtersstateCodeNSW%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestAdvanced2012searchWidth%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestAdvanced2012minimumScore%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestAdvanced2012maxSearchResults%
%globals_session_soap_ABRPayloadSearchResultsrequestnameSearchRequestAdvanced2006maxSearchResults%
%globals_session_soap_ABRPayloadSearchResultsresponseusageStatement%
%globals_session_soap_ABRPayloadSearchResultsresponsedateRegisterLastUpdated%
%globals_session_soap_ABRPayloadSearchResultsresponsedateTimeRetrieved%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntity200506charityTypecharityTypeDescription%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntity200506charityTypeeffectiveFrom%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntity200506charityTypeeffectiveTo%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntity200506taxConcessionCharityEndorsementendorsementType%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntity200506taxConcessionCharityEndorsementeffectiveFrom%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntity200506taxConcessionCharityEndorsementeffectiveTo%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntity200506publicBenevolentInstitutionEmployerpbiNamescore%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntity200506publicBenevolentInstitutionEmployerpbiNameisCurrentIndicator%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntity200506publicBenevolentInstitutionEmployereffectiveFrom%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntity200506publicBenevolentInstitutionEmployereffectiveTo%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntityrecordLastUpdatedDate%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntityABNidentifierValue%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntityABNisCurrentIndicator%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntityABNreplacedIdentifierValue%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntityABNreplacedFrom%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntityentityStatusentityStatusCode%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntityentityStatuseffectiveFrom%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntityentityStatuseffectiveTo%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntityASICNumber%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntityentityTypeentityTypeCode%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntityentityTypeentityDescription%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntitygoodsAndServicesTaxeffectiveFrom%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntitygoodsAndServicesTaxeffectiveTo%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntitydgrEndorsementendorsedFrom%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntitydgrEndorsementendorsedTo%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntitymainNameeffectiveFrom%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntitymainNameeffectiveToBlank%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntitymainNameeffectiveTo%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntitylegalNameeffectiveFrom%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntitylegalNameeffectiveTo%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntitymainTradingNameeffectiveFrom%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntitymainTradingNameeffectiveToBlank%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntitymainTradingNameeffectiveTo%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntityotherTradingNameeffectiveFrom%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntityotherTradingNameeffectiveToBlank%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntityotherTradingNameeffectiveTo%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntitymainBusinessPhysicalAddresseffectiveFrom%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntitymainBusinessPhysicalAddresseffectiveTo%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntitydgrFunddgrFundNamescore%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntitydgrFunddgrFundNameisCurrentIndicator%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntitydgrFundendorsedFrom%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntitydgrFundendorsedTo%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntity201205businessNameeffectiveFrom%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntity201205businessNameeffectiveToBlank%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntity201205businessNameeffectiveTo%
%globals_session_soap_ABRPayloadSearchResultsresponsesearchResultsListnumberOfRecords%
%globals_session_soap_ABRPayloadSearchResultsresponsesearchResultsListexceedsMaximum%
%globals_session_soap_ABRPayloadSearchResultsresponsesearchResultsListsearchResultsRecordABNidentifierValue%
%globals_session_soap_ABRPayloadSearchResultsresponsesearchResultsListsearchResultsRecordABNidentifierStatus%
%globals_session_soap_ABRPayloadSearchResultsresponsesearchResultsListsearchResultsRecordlegalNamescore%
%globals_session_soap_ABRPayloadSearchResultsresponsesearchResultsListsearchResultsRecordlegalNameisCurrentIndicator%
%globals_session_soap_ABRPayloadSearchResultsresponsesearchResultsListsearchResultsRecorddgrFundNamescore%
%globals_session_soap_ABRPayloadSearchResultsresponsesearchResultsListsearchResultsRecorddgrFundNameisCurrentIndicator%
%globals_session_soap_ABRPayloadSearchResultsresponsesearchResultsListsearchResultsRecordbusinessNamescore%
%globals_session_soap_ABRPayloadSearchResultsresponsesearchResultsListsearchResultsRecordbusinessNameisCurrentIndicator%
%globals_session_soap_ABRPayloadSearchResultsresponsesearchResultsListsearchResultsRecordPBIENamescore%
%globals_session_soap_ABRPayloadSearchResultsresponsesearchResultsListsearchResultsRecordPBIENameisCurrentIndicator%
%globals_session_soap_ABRPayloadSearchResultsresponsesearchResultsListsearchResultsRecordotherTradingNamescore%
%globals_session_soap_ABRPayloadSearchResultsresponsesearchResultsListsearchResultsRecordotherTradingNameisCurrentIndicator%
%globals_session_soap_ABRPayloadSearchResultsresponsesearchResultsListsearchResultsRecordmainTradingNamescore%
%globals_session_soap_ABRPayloadSearchResultsresponsesearchResultsListsearchResultsRecordmainTradingNameisCurrentIndicator%
%globals_session_soap_ABRPayloadSearchResultsresponsesearchResultsListsearchResultsRecordmainNamescore%
%globals_session_soap_ABRPayloadSearchResultsresponsesearchResultsListsearchResultsRecordmainNameisCurrentIndicator%
%globals_session_soap_ABRPayloadSearchResultsresponsesearchResultsListsearchResultsRecordmainBusinessPhysicalAddressisCurrentIndicator%
%globals_session_soap_ABRPayloadSearchResultsresponseexceptionexceptionDescription%
%globals_session_soap_ABRPayloadSearchResultsresponseexceptionexceptionCode%
%globals_session_soap_ABRPayloadSearchResultsresponseabnListnumberOfRecords%
%globals_session_soap_ABRPayloadSearchResultsresponseabnListabn%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntity200709superannuationStatuscomplyingCode%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntity200709superannuationStatuscomplyingDescription%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntity200709superannuationStatusregulator%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntity200709superannuationStatusexceptionMessage%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntity200709mainPostalPhysicalAddressaddressLine1%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntity200709mainPostalPhysicalAddressaddressLine2%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntity200709mainPostalPhysicalAddresssuburb%
%globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntity200709mainPostalPhysicalAddresscountryName%

Chiranjivi_Upreti · 2012-12-18 23:48:15 UTC

Hi chickensoup64,
Based on the response you are getting, try the keyword %globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntitymainNameorganisationName% to get the "organisationName" value.

I remember similar issue once when the keyword list didn't showed all the available keywords.

Chiran

chickensoup64 · 2012-12-19 00:11:55 UTC

Based on the response you are getting, try the keyword %globals_session_soap_ABRPayloadSearchResultsresponsebusinessEntitymainNameorganisationName% to get the "organisationName" value.
I remember similar issue once when the keyword list didn't showed all the available keywords.

Thanks Chiranjivi it worked!! I remember trying to make up my own keyword based on the response but obviously I didn't get it right - do capital letters matter in the keywords?. I thought I was going crazy because everything seemed like it was correct. So is this a bug with Matrix that it cannot see all the keywords - should I report to the bug tracker? I guess it just means that currently I'll need to read the WDSL more closely and try and match that response to keywords.

One last thing about the session variables - if I am using AJAX to send/get the value on a form element within the one page will the variable be able to be updated with each request? Or does the page need to reload or something?

Chiranjivi_Upreti · 2012-12-19 22:59:07 UTC

Thanks Chiranjivi it worked!! I remember trying to make up my own keyword based on the response but obviously I didn't get it right - do capital letters matter in the keywords?. I thought I was going crazy because everything seemed like it was correct. So is this a bug with Matrix that it cannot see all the keywords - should I report to the bug tracker? I guess it just means that currently I'll need to read the WDSL more closely and try and match that response to keywords.

One last thing about the session variables - if I am using AJAX to send/get the value on a form element within the one page will the variable be able to be updated with each request? Or does the page need to reload or something?

Hi chickensoup64,

Looking at SOAP action keyword replacement implementation, I can confirm that these keywords case sensitive. Yeah it will be a bug since it is supposed to list all the available keywords in the response.

Regarding your other query, as long as the form gets submitted (and hence triggering the SOAP action), the soap session variable should get updated.

Chiran