SOAP Documentation: Supplier Items

Overview

This resource provides methods to manage your TraceGains Supplier Items.

Operations List

The Operations List for this resource: Supplier Items Operations List.

Resource WSDL

The WSDL for this resource can be found here: Supplier Items WSDL.

Endpoint URLs

All requests should be sent to one of the following:
      Production Environment: https://api.tracegains.net/v7/soap/SupplierItems.asmx.
      Test Environment: https://api-test.tracegains.net/v7/soap/SupplierItems.asmx.

Activate

Enterprise | SM QM

 Activates an inactive Supplier Item by its ID.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
supplierId String The ID of the Supplier assigned to the Item.
itemId String The ID of the Item to activate.

Response:
RequestResult The default response. This response can take on a different XML element name depending on the development IDE/toolset being used.

AssignRequirements

Enterprise | SM

 Assigns one or more document types as requirements for a Supplier ID and Item ID combination.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
supplierId String The ID of the Supplier to update.
itemId String The ID of the Item to update.
requirementTemplates
repeating		 String A list of document requirement template names to include in the assignment.
documentTypes
repeating		 String A list of document type names to include in the assignment.
requirementType RequirementType Determines how the provided types are applied to the Supplier Item requirement.

Response:
RequestResult The default response. This response can take on a different XML element name depending on the development IDE/toolset being used.

Deactivate

Enterprise | SM QM

 Deactivates an Item that is currently active for a Supplier.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
supplierId String The ID of the Supplier assigned to the Item.
itemId String The ID of the Item to deactivate.

Response:
RequestResult The default response. This response can take on a different XML element name depending on the development IDE/toolset being used.

Delete

Enterprise | SM QM

 Removes an Item from a Supplier.

Notes:

  • All documents for this Supplier Item will be deleted.
  • All TraceGains GatherTM data for this Supplier Item will be deleted.

Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
supplierId String The ID of the Supplier assigned to the Item.
itemId String The ID of the Item to delete.

Response:
RequestResult The default response. This response can take on a different XML element name depending on the development IDE/toolset being used.

Get

Enterprise | SM QM

 Returns a single Item for a Supplier.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
supplierId String The ID of the Supplier assigned to the Item.
itemId String The ID of the Item to return.
attributeType AttributeRequestType Determines what type of Attributes to return.

Response:

Element Type Description
ResponseCode ResponseCode A valid HTTP status code.
Message String A log friendly message.
Supplier SupplierItemResult The returned Supplier Item.

List

Enterprise | SM QM

 Returns a paged list of Supplier Items using basic request parameters.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
includeInactive Boolean False to return only active Supplier Items. True to return both active and inactive Supplier Items.
fromModifiedDate DateTime ISO 8601 formatted date/time string in Coordinated Universal Time (UTC). Returns Supplier Item records that have been modified after this date and time.
toModifiedDate DateTime ISO 8601 formatted date/time string in Coordinated Universal Time (UTC). Returns Supplier Item records that have been modified before this date and time.
pageCriteria PagingCriteria Row index paging criteria.
attributeType AttributeRequestType Determines what type of Attributes to return.

Response:

Element Type Description
ResponseCode ResponseCode A valid HTTP status code.
Message String A log friendly message.
Supplier
repeating 		SupplierItemResult The list of returned Supplier Items.

ListSupplierIds

Enterprise | SM QM

 Returns a list of Item IDs assigned to a Supplier.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
itemId String The ID of a valid Item.
includeInactive Boolean Indicates whether or not to include inactive records in the result.

Response:
ListResult This response could take on a different XML element name by method.

Query

Enterprise | SM QM

 Returns a paged list of Supplier Items using more advanced request parameters.

Notes:

This method queries raw record data in your TraceGains instance using contains or partial match filtering for all attribute data provided in the filterValues parameter. This behavior is consistent with grid view filtering in the TraceGains UI and reduces the amount of calls to the method required to find similarly sequenced data.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
includeInactive Boolean False to return only active Supplier Items. True to return both active and inactive Supplier Items.
fromModifiedDate DateTime ISO 8601 formatted date/time string in Coordinated Universal Time (UTC). Returns Supplier Item records that have been modified after this date and time.
toModifiedDate DateTime ISO 8601 formatted date/time string in Coordinated Universal Time (UTC). Returns Supplier Item records that have been modified before this date and time.
pageCriteria PagingCriteria Row index paging criteria.
attributeType AttributeRequestType Determines what type of Attributes to return.
filterValues
repeating		 AttributeValue A list of attribute-value pairs to filter returned Supplier Item data records. Attributes must be of type SupplierItem as defined in AttributeUseType. All others will be ignored.

Response:

Element Type Description
ResponseCode ResponseCode A valid HTTP status code.
Message String A log friendly message.
Supplier
repeating 		SupplierItemResult The list of returned Supplier Items.

Update

Enterprise | SM QM

 Adds/updates attribute values for a single Supplier Item.

Adds values to empty attributes or updates existing attribute values for a Supplier Item. It is important to include any key attributes that have been defined for the AttributeUseType of type SupplierItem in Attribute configuration.

Notes:

  • All key attributes should be included in the itemData attribute-value pairs list.

Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
supplierId String The ID of the Supplier assigned to the Item.
itemId String The ID of the Item to update.
itemData
repeating		 AttributeValue A list of attribute-value pairs to add/update for the Supplier Item. Attributes must be of type SupplierItem as defined in AttributeUseType. All others will be ignored.

Response:
RequestResult The default response. This response can take on a different XML element name depending on the development IDE/toolset being used.

Version

 Reports the version information of this resource.


Request:

No Parameters


Response:

Element Type Description
ResponseCode ResponseCode A valid HTTP Status Code
Message String A log friendly message that can be used in troubleshooting a failed response.
Version String The major, minor, and build number of this resource.