SOAP Parts API with Web Services 2.0

Overview

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

• addParts
• getParts
• updateParts
• modifyParts
• deleteParts

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

• UsernameToken

  • Username
  • Password Type
• category: Security
• schemaLocation

You can add, update, delete, or get parts based on the SOAP interfaces provided. In XML Integration, use this with the parts database to keep data in sync.

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

Parts SOAP API Details

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

SOAP API	Description	Required Input Variables	Success Response Variables
addParts	Adds a part. It expects input of all the part details and returns the status whether the part was successfully added or not.	category schemaLocation part_number	status success message
getParts	Returns the part details of parts which are searched, based on the given criteria (one or multiple).	category schemaLocation field value comparator	status success message parts eachRecord part_number
updateParts	Updates the details of the specified part number. The return specifies whether the operation was successful.	category schemaLocation part_number	status success message
modifyParts	The "modifyParts" action will insert or update a part based on the part number. The "modifyParts" action will add a new part if the specified part number does not exist in the Oracle CPQ parts data. When the specified part number exists, the existing part is modified.	category schemaLocation part_number	status success message
		Update Example <bm:modifyParts xmlns:bm="urn:soap.bigmachines.com"> <bm:Parts> <bm:each_record> <bm:part_number>part186342</bm:part_number> <bm:direct_buy>1</bm:direct_buy> <bm:part_display_number>Part Display 1</bm:part_display_number> <bm:price> <bm:USD>10</bm:USD> </bm:price> </bm:each_record> </bm:Parts> </bm:modifyParts>
		Insert Example <urn:modify> <bm:Parts> <bm:each_record> <bm:part_number>newpart</bm:part_number> <bm:direct_buy>1</bm:direct_buy> <bm:part_display_number>Part Display 1</bm:part_display_number> <bm:price> <bm:USD>1</bm:USD> </bm:price> </bm:each_record> </bm:Parts> </bm:modifyParts>
deleteParts	Deletes a specific part. The part(s) deletes are based on one or more specified criteria.	category schemaLocation field value comparator	status success message

---

Administration

Accessing the Parts 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 Parts tab.
5. Select an API from the drop-down.
6. Enter a Part Number.

7. Click Generate Input to retrieve the skeleton.

   For more information on the body of the Parts Web Service, and for code examples, see the topic SOAP Parts 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