SOAP Documentation: Suppliers

Overview

This resource provides methods to manage your TraceGains Suppliers.

Operations List

The Operations List for this resource: Suppliers Operations List.

Resource WSDL

The WSDL for this resource can be found here: Suppliers WSDL.

Endpoint URLs

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

Activate

Enterprise | SM

 Activates an inactive Supplier 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 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 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 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 requirement.

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

Create

Enterprise | SM

 Creates a new Supplier or Partner record.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
supplierId String The ID of the new Supplier.
supplierName String The Name of the new Supplier.
attributeList
repeating		 AttributeValue A list of attribute-value pairs to add to the new Supplier. Attributes must be of type Supplier as defined in AttributeUseType. All others will be ignored.
isPartner Boolean True to create a Partner record. False to create a Supplier record.

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

 Deactivates an active Supplier 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 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

 Deletes a Supplier by its ID.

Notes:

  • Linked Items will be unmapped.
  • All documents for this Supplier will be deleted.
  • Connected Supplier Groups from TraceGains GatherTM will be unmapped.
  • All TraceGains GatherTM data for this Supplier 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 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

 Returns a single Supplier by an 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 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 SupplierResult The returned Supplier.

List

Enterprise | SM

 Returns a paged list of Suppliers 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 Suppliers. True to return both active and inactive Suppliers.
fromModifiedDate DateTime ISO 8601 formatted date/time string in Coordinated Universal Time (UTC). Returns Suppliers that have been modified after this date and time.
toModifiedDate DateTime ISO 8601 formatted date/time string in Coordinated Universal Time (UTC). Returns Suppliers 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 		SupplierResult The list of returned Suppliers.

ListGroups

Enterprise | SM

 Lists all active Supplier Groups.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.

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

ListItemIds

Enterprise | SM

 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.
supplierId String The ID of a valid Supplier.
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

 Returns a paged list of Suppliers 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 Suppliers. True to return both active and inactive Suppliers.
fromModifiedDate DateTime ISO 8601 formatted date/time string in Coordinated Universal Time (UTC). Returns Suppliers that have been modified after this date and time.
toModifiedDate DateTime ISO 8601 formatted date/time string in Coordinated Universal Time (UTC). Returns Suppliers 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 Suppliers. Attributes must be of type Supplier 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 		SupplierResult The list of returned Suppliers.

Update

Enterprise | SM

 Updates an existing 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 new Supplier.
attributeList
repeating		 AttributeValue A list of attribute-value pairs to add/update for the Supplier. Attributes must be of type Supplier 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.