Expanded usage docs

amabnl · Jan 27, 2016 · 7319e53 · 7319e53
1 parent 3165e39
commit 7319e53
Showing 1 changed file with 9 additions and 9 deletions.
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -4,7 +4,7 @@ Usage
 ***********************
 Get access from Amadeus
 ***********************
-First, get a WSDL for your project from Amadeus. You will probably have to go through your Amadeus sales channel and start a web services project with Amadeus.
+First, get a WSDL by requesting a WSAP (Web Service Access Point) for your project from Amadeus. You will probably have to go through your Amadeus sales channel and start a web services project with Amadeus.
 
 See `the Amadeus Web Services website <https://webservices.amadeus.com/>`_ for more information.
 
@@ -37,22 +37,22 @@ Set up a test client
 
     $params = new ClientParams([
         'sessionHandlerParams' => [
-            'soapHeaderVersion' => Client::HEADER_V4,
+            'soapHeaderVersion' => Client::HEADER_V4, //This is the default value, can be omitted.
             'wsdl' => '/home/user/mytestproject/data/amadeuswsdl/1ASIWXXXXXX_PDT_20160101_080000.wsdl',
             'stateful' => false,
             'logger' => new Psr\Log\NullLogger(),
             'authParams' => [
-                'officeId' => 'BRUXX1111',
-                'originator' => 'WSBENXXX',
-                'organizationId' => 'NMC-BENELU',
-                'passwordLength' => '12',
+                'officeId' => 'BRUXX1111', //The Amadeus Office Id you want to sign in to - must be open on your WSAP.
+                'originator' => 'WSBENXXX', // also known as 'User ID' for Soap Header 4 WSDL's
                 'passwordData' => 'dGhlIHBhc3N3b3Jk', // base 64 encoded password
-                'nonceBase' => 'random string for generating unique nonce'
+                'nonceBase' => 'random string for generating unique nonce' //optional but recommended - to avoid collisions with other users of this library.
+                'organizationId' => 'NMC-BENELU', // Soap Header 1&2 only!
+                'passwordLength' => '12', // Soap Header 1&2 only!
             ]
         ],
         'requestCreatorParams' => [
-            'originatorOfficeId' => 'BRUXX1111',
-            'receivedFrom' => 'my test project'
+            'originatorOfficeId' => 'BRUXX1111', // Same office ID as in authParams
+            'receivedFrom' => 'my test project' // The "Received From" string that will be visible in PNR History
         ]
     ]);