SOAP Documentation: COA

Overview

This resource provides methods to create, read, update and delete attribute data from the COA data collection object in a Supplier Compliance instance of TraceGains.


Operations List

The Operations List for this resource: COAs Operations List.


Resource WSDL

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


Endpoint URLs

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


Delete

Enterprise | SC

 Deletes a COA data record by its ID.

The methods List or Query can be used to retrieve the IDs of COA data records.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
coaId Integer The ID of the COA data record 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.

List

Enterprise | SC

 Returns a paged list of COA data records using basic request parameters.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
fromModifiedDate DateTime ISO 8601 formatted date/time string in Coordinated Universal Time (UTC). Returns COA data records that have been modified after this date and time.
toModifiedDate DateTime ISO 8601 formatted date/time string in Coordinated Universal Time (UTC). Returns COA data 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.
Coas
repeating
Coa The list of returned COA data records.

ListDocuments

Enterprise | SC

 Returns a paged list of documents for a COA ID.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
coaId Integer The ID of a COA data record.
includeArchived Boolean Indicates whether to return archived documents in the result.
pageCriteria PagingCriteria Row index paging criteria.

Response:

Element Type Description
ResponseCode ResponseCode A valid HTTP status code.
Message String A log friendly message.
Document
repeating
DocumentResult The list of returned Document records.

Query

Enterprise | SC

 Returns a paged list of COA data records 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.
fromModifiedDate DateTime ISO 8601 formatted date/time string in Coordinated Universal Time (UTC). Returns COA data records that have been modified after this date and time.
toModifiedDate DateTime ISO 8601 formatted date/time string in Coordinated Universal Time (UTC). Returns COA data 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 COA data records. Attributes must be of type Coa 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.
Coas
repeating
Coa The list of returned COA data records.

Upload

Enterprise | SC

 Creates/updates COA data records based on key attribute configuration.

This method will create or update existing COA data records based on the key attributes provided in the coaData attribute list. It is recommend that all currently configured key attributes be included in each call to this method, or unexpected results could occur.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
coaData
repeating
AttributeValue A list of attribute-value pairs to add/update for the COA. Attributes must be of type Coa 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.