SOAP Users API with Web Services 2.0

Overview

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

• addUsers
• updateUsers
• getUser
• resetPassword

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

• UsernameToken

  • Username
  • Password Type
• category: Security
• schemaLocation

Users SOAP API Details

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

SOAP API	Description	Required Input Variables	Success Response Variables
addUsers	Adds a user through SOAP. When multiple users are created using this method, the entire request is processed before a response is sent.	category schemaLocation login company_name type first_name email super_user_access_perm unplugged_default_check_in separate_ship_addr is_notify_email   Note: These fields are the minimum requirement to add a user. The following fields will be set with default values if the values are not set in the Web Services Users API. bm_language: English currency_preference: US Dollar number_format: ####.## date_format: MM/dd/yyyy h:mm time_zone: (GMT-5:00 GMT-4:00) US Eastern Time	status success message detailedStatus record
updateUsers	Updates user information through SOAP.	category schemaLocation login super_user_access_perm unplugged_default_check_in separate_ship_addr is_notify_email	status success message detailedStatus record
getUser	Grabs user information through SOAP.	category schemaLocation login	status success message userInfo login first_name variable_name
resetPasswords	Resets user passwords through SOAP.	category schemaLocation login	status success message

---

Administration

Accessing 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.

---

Header Information for Web Services 2.0

---

Related Topics

See Also