Difference between revisions of "NATS4 API Decode Natscode"
From TMM Wiki
Jump to navigationJump to search (Created page with '{{NATS4 Manual | show_api_admin_section = true }} To decode a nats code you must make a SOAP call with the following parameters: <pre> <?xml version="1.0" encoding="ISO-8859-1"?>…') |
TMMStephenY (talk | contribs) m |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
| − | + | ||
| + | In order to decode a [[NATS]] code, you must first make a SOAP call with the following parameter: | ||
| + | |||
| + | * '''natscode''' The NATS code you want to be decoded | ||
| + | |||
| + | You can use XML to request a decoded NATS code: | ||
| + | |||
<pre> | <pre> | ||
<?xml version="1.0" encoding="ISO-8859-1"?> | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
| − | <SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" | + | <SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="urn:natsapiadmin_wsdl"> |
| − | xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" | ||
| − | xmlns:tns="urn:natsapiadmin_wsdl"> | ||
<SOAP-ENV:Body> | <SOAP-ENV:Body> | ||
<tns:decode_natscode xmlns:tns="urn:natsapiadmin_wsdl"> | <tns:decode_natscode xmlns:tns="urn:natsapiadmin_wsdl"> | ||
| Line 16: | Line 20: | ||
</pre> | </pre> | ||
| − | + | Once you have run your code, you will get a response similar to the following: | |
| + | |||
<pre> | <pre> | ||
<?xml version="1.0" encoding="ISO-8859-1"?> | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
| − | <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" | + | <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="urn:natsapiadmin_wsdl"> |
| − | xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="urn:natsapiadmin_wsdl"> | ||
<SOAP-ENV:Body> | <SOAP-ENV:Body> | ||
<ns1:decode_natscodeResponse xmlns:ns1="urn:natsapiadmin_wsdl"> | <ns1:decode_natscodeResponse xmlns:ns1="urn:natsapiadmin_wsdl"> | ||
| Line 40: | Line 44: | ||
</SOAP-ENV:Envelope> | </SOAP-ENV:Envelope> | ||
</pre> | </pre> | ||
| + | |||
| + | NuSOAP Example (continuing from [[NATS4_API#Example|main article NuSOAP Example]]): | ||
| + | |||
| + | <pre> | ||
| + | $values = array( | ||
| + | 'natscode'=>'MS4xLjEuMS4wLjEwLjAuMA' | ||
| + | ); | ||
| + | $result = $client->call('decode_natscode', $values, 'natsapiadmin_wsdl'); | ||
| + | var_dump($result); | ||
| + | </pre> | ||
| + | Output: | ||
| + | <pre> | ||
| + | array(11) { | ||
| + | ["loginid"]=> | ||
| + | int(1) | ||
| + | ["username"]=> | ||
| + | string(13) "tmmnuph3fmaw4" | ||
| + | ["programid"]=> | ||
| + | int(1) | ||
| + | ["siteid"]=> | ||
| + | int(1) | ||
| + | ["tourid"]=> | ||
| + | int(1) | ||
| + | ["campaignid"]=> | ||
| + | int(0) | ||
| + | ["adtoolid"]=> | ||
| + | int(10) | ||
| + | ["subid1"]=> | ||
| + | int(0) | ||
| + | ["subid2"]=> | ||
| + | int(0) | ||
| + | ["is_unencoded"]=> | ||
| + | int(0) | ||
| + | ["old_code"]=> | ||
| + | string(1) "0" | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | [[Category:NATS4 API Articles]] | ||
Latest revision as of 12:04, 18 May 2011
In order to decode a NATS code, you must first make a SOAP call with the following parameter:
- natscode The NATS code you want to be decoded
You can use XML to request a decoded NATS code:
<?xml version="1.0" encoding="ISO-8859-1"?> <SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="urn:natsapiadmin_wsdl"> <SOAP-ENV:Body> <tns:decode_natscode xmlns:tns="urn:natsapiadmin_wsdl"> <natscode xsi:type="xsd:string">MS4xLjEuMS4wLjEwLjAuMA</natscode> </tns:decode_natscode> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Once you have run your code, you will get a response similar to the following:
<?xml version="1.0" encoding="ISO-8859-1"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="urn:natsapiadmin_wsdl"> <SOAP-ENV:Body> <ns1:decode_natscodeResponse xmlns:ns1="urn:natsapiadmin_wsdl"> <return xsi:type="tns:Natscode_data"> <loginid xsi:type="xsd:int">1</loginid> <username xsi:type="xsd:sting">tmmnuph3fmaw4</username> <programid xsi:type="xsd:int">1</programid> <siteid xsi:type="xsd:int">1</siteid> <tourid xsi:type="xsd:int">1</tourid> <campaignid xsi:type="xsd:int">0</campaignid> <adtoolid xsi:type="xsd:int">10</adtoolid> <subid1 xsi:type="xsd:int">0</subid1> <subid2 xsi:type="xsd:int">0</subid2> <is_unencoded xsi:type="xsd:int">0</is_unencoded> <old_code xsi:type="xsd:string">0</old_code> </return> </ns1:decode_natscodeResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
NuSOAP Example (continuing from main article NuSOAP Example):
$values = array(
'natscode'=>'MS4xLjEuMS4wLjEwLjAuMA'
);
$result = $client->call('decode_natscode', $values, 'natsapiadmin_wsdl');
var_dump($result);
Output:
array(11) {
["loginid"]=>
int(1)
["username"]=>
string(13) "tmmnuph3fmaw4"
["programid"]=>
int(1)
["siteid"]=>
int(1)
["tourid"]=>
int(1)
["campaignid"]=>
int(0)
["adtoolid"]=>
int(10)
["subid1"]=>
int(0)
["subid2"]=>
int(0)
["is_unencoded"]=>
int(0)
["old_code"]=>
string(1) "0"
}
