SOAP Users API with Web Services 2.0

This topic discusses Web Services 2.0. For information on Web Services 1.0, see Web Services 1.0.

Overview

You can generate a skeleton input for each operation in the Users WSDL, which contains the following operations:

For each operation, the following fields are always required in the header:

ClosedUsers SOAP API Details

For all SOAP APIs, the Failure Response Variables are exceptionCode and exceptionMessage.


Administration

ClosedAccessing the Users WSDL and Generating Skeleton Input

  1. Click Admin to go to the Admin Home Page.
  2. Click Web Services in the Integration Platform section.

    The Web Services Test page opens.

  3. Confirm that the Web Service Version is 2.0.
  4. Click the Users tab.
  5. Select an API from the drop-down.
  6. Enter data for the User Login.
  7. Click Generate Input to retrieve the skeleton.

    For more information on the body of the Users Web Service, and for code examples, see the topic SOAP Users API with Web Services 1.0. With the exception of the header, the Web Services 1.0 code examples are valid in Web Services 2.0.


ClosedHeader Information for Web Services 2.0

For each API, the body of the SOAP XML is the same as it was for Web Services 1.0. This is the information contained between the <soapenv:Body> and </soapenv:Body> tags.

The header, contained between the <soapenv:Header> and </soapenv:Header> header, has changed with Web Services 2.0.
Comment Header: Web Services 1.0 Header: Web Services 2.0
No change <soapenv:Header> <soapenv:Header>
New tags  

<wsse:Security xmlns:wsse= "http://docs.oasis-open.org/wss/2004/
01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">

New user information replaces sessionId

<bm:userInfo . . . >

<bm:sessionId>

. . . . .
</bm:sessionId>

</bm:userInfo>

<wsse:UsernameToken wsu:Id="UsernameToken-2">

<wsse:Username/><wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText"/>

</wsse:UsernameToken>

This is now in the URL, with the unique end point specified. <bm:category
xmlns:bm="urn:soap.bigmachines.com">
Commerce
</bm:category>
Now reflected in the SOAP Server URL field.
No longer needed

<bm:xsdInfo

. . . . .

</bm:xsdInfo>

 
Ending the new authentication  

</wsse:Security>

No change </soapenv:Header> </soapenv:Header>

Related Topics

Related Topics Link IconSee Also