SOAP Documentation: Method Responses

Attribute Result

Generally used as the result of a Get request from the Attributes or related resources. Also used as the base object of a Create or Update request on the Attributes resource.

Element Type Description
ID String The ID of the Attribute.
Name String The Name of the Attribute.
Group String The name of the Attribute Group. The ListGroups method of the Attributes resource returns the active list of Attribute Groups.
DataType AttributeDataType The data type of values stored in the attribute.
Use AttributeUseType The data collection object assignment of the Attribute.
StorageGroup String A sub-group of the type AttributeUseType where raw data values are stored. Note: These sub-groups are created by TraceGains on an as-needed basis to extend storage in a specific TraceGains instance.
ColumnName ReadOnly The name of the column in the database for this Attribute. This name is derived from the Attribute ID, but may not be identical due to naming restrictions in the database schema.
Description String The Description of the Attribute.
Script String The script to execute for Derived and IsComputed attributes. Otherwise, a data normalization script that is applied on Create and Update of the attribute value.
IsSystem Boolean An attribute that is required by the TraceGains system.
IsKey Boolean Indicates the attribute value will be used to determine when to create a new row of data or update an existing row of data.
IsComputed Boolean An attribute where the value of Script is only run on Create or Update of a row of data and the resulting value is stored as the attribute value.
AppliesToAll Boolean Indicates that the attribute applies to all records (Items) in the data collection object.
BusinessRuleHeader ReadOnly Only populated on a Get request. Business Rules cannot be created or updated using the Attributes resource.

Account Result

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.
Account EnterpriseAccount Enterprise Account

COA Result

Element Type Description
ID Integer The ID of the COA record.
SupplierID String The Supplier ID of the record.
SupplierName String The Supplier Name of the record.
ItemID String The Item ID of the record.
ItemName String The Item Name of the record.
PoNumber String The PO Number of the record. Optional, only if this attribute is being captured during data collection.
PoLineNumber String The PO Line Number of the record. Optional, only if this attribute is being captured during data collection.
Action String A value from the Action rules attribute value list for the COA object.
Status String A value from the Status rules attribute value list for the COA object.
Attributes
repeating		 AttributeValue The list of Attributes requested for the COA. Attributes will be of type Coa as defined in AttributeUseType.

Controls Result

Element Type Description
ID Integer The ID of the Controls record.
ControlID String The Control ID of the record.
ControlName String The Control Name of the record.
PreshipSignoffID Integer The ID of a linked Preship & Signoff record.
VerifyValidateID Integer The ID of a linked Verify & Validate record.
Action String A value from the Action rules attribute value list for the Controls object.
Status String A value from the Status rules attribute value list for the Controls object.
Attributes
repeating		 AttributeValue The list of Attributes requested for the Controls record. Attributes will be of type DataCollection as defined in AttributeUseType.

Document Result

Generally used as the result of a Get request from the Documents resource. Also used as the base object of a Create or Update request on the Documents resource.

Element Type Description
ID Integer The ID of the document.
SupplierID String The Supplier ID of the document.
ItemID String The Item ID of the document.
Type String The Type of the document.
Status String The Status of the document.
Workflow String A Workflow of the document.
EffectiveDate Date The effective date of the document.
ExpirationDate Date The date the document will expire.
DownloadLink String A public link to download the most current version of the document from your TraceGains instance.

Notes:
  • This link downloads the document without authentication!
  • Use of this public link should be used with caution.
  • Download links are not generated for all document types.
Description Date The description of the document.
FileName String The original file name of the document.
ByteArray Base64Binary The document data as a Base64Binary byte array.

Notes:
  • This element is only provided in the Get request of the Documents endpoint.
CreationDate ReadOnly ISO 8601 formatted date/time string. The date and time the document was created in Coordinated Universal Time (UTC).
CreatedBy ReadOnly The email address of the logged in user that created the document or the Application Name of the Application Key that created the document.
UpdatedDate ReadOnly ISO 8601 formatted date/time string. The date and time the document was last updated in Coordinated Universal Time (UTC).
UpdatedBy ReadOnly The email address of the logged in user that last updated the document or the Application Name of the Application Key that last updated the document.

Item Datasheet Result

Element Type Description
ID Integer The ID of the Item Datasheet record.
ItemID String The Item ID of the record.
ItemName String The Item Name of the record.
Version String The version of the record.
InredientDeclaration String The ingredient details for the record.
ApprovedBy String The email address of the account that approved the record.
ApprovedDate String The date and time stamp in UTC when the record was approved.
Attributes
repeating		 AttributeValue The list of Attributes requested for the Item Datasheet. Attributes will be of type ItemDatasheet as defined in AttributeUseType.

Item Result

This object is often used an Item and ItemResult in both requests and responses.

Element Type Description
ID String The ID of the Item.
Name String The Name of the Item.
Description String The Description of the Item.
Group String The Item Group. The ListGroups method of the Items resource returns the active list of Item Groups.
Attributes
repeating		 AttributeUse The list of Attributes requested for the Item.

List Result

A generic result format used when returning alphabetical lists of lookup values.

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.
Values
repeating		 String The returned list values by name.

PO Result

Element Type Description
ID Integer The ID of the PO record.
PoNumber String The PO Number of the record.
SupplierID String The Supplier ID of the record.
SupplierName String The Supplier Name of the record.
LineNumber String The PO Line Number of the record.
ItemID String The Item ID of the record.
ItemName String The Item Name of the record.
Action String A value from the Action rules attribute value list for the PO object.
Status String A value from the Status rules attribute value list for the PO object.
Attributes
repeating		 AttributeValue The list of Attributes requested for the PO. Attributes will be of type Po as defined in AttributeUseType.

Preship & Signoff Result

Element Type Description
ID Integer The ID of the Preship & Signoff record.
ControlID String The Control ID of the record.
ControlName String The Control Name of the record.
Action String A value from the Action rules attribute value list for the Preship & Signoff object.
Status String A value from the Status rules attribute value list for the Preship & Signoff object.
Attributes
repeating		 AttributeValue The list of Attributes requested for the Preship & Signoff record. Attributes will be of type PreshipSignoff as defined in AttributeUseType.

Request Result (Default)

This is the default response for many methods. Note, depending on the toolset being used during development, this response can take on a different XML element name by method.

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.

Specification Result

Element Type Description
ID Integer The ID of the specification record.
Name String The name of the specification.
ApprovedBy String The email address of the approver.
ApprovedDate DateTime The date and time the specification was last approved.
Version String The version of the specification.
VersionName String The version name of the specification.
IsReadOnly Boolean Indicates the specification is read only.
IsDocumentsOnly Boolean Indicates the specification is read only when shared and documents are allowed to be read.
ItemID String The Item ID of the record.
ItemName String The Item Name of the record.
SupplierID String The Supplier ID of the record when the specification has been shared.
SupplierName String The Supplier Name of the record when the specification has been shared.
Level String Indicates wether the specification is Master or Shared.
RequestStatus String Indicates the current request status of the specification.
Action String A value from the Action rules attribute value list for the specification object.
Status String A value from the Status rules attribute value list for the specification object.
Attributes
repeating		 AttributeValue The list of Attributes requested for the specification. Attributes will be of type Specification as defined in AttributeUseType.
Tables
repeating		 TableDataValue The list of Table Templates, returned as individual table elements, that currently contain data in at least 1 cell for at least 1 row in at least 1 table section.

Note: Only user data is returned in this method!

Supplier Result

Element Type Description
ID String The ID of the Supplier.
Name String The Name of the Supplier.
Action String A value from the Action rules attribute value list for the Supplier object.
Status String A value from the Status rules attribute value list for the Supplier object.
IsActive Boolean True if Supplier active, False if Supplier is inactive.
Attributes
repeating		 AttributeValue The list of Attributes requested for the Supplier.

Supplier Item Result

Element Type Description
ID Integer The ID of the Supplier Item.
SupplierID String The ID of the Supplier.
SupplierName String The Name of the Supplier.
ItemID String The ID of the Item.
ItemName String The Name of the Item.
Action String A value from the Action rules attribute value list for the Supplier Item object.
Status String A value from the Status rules attribute value list for the Supplier Item object.
IsActive Boolean True if Supplier Item active, False if Supplier Item is inactive.
Attributes
repeating		 AttributeValue The list of Attributes requested for the Supplier Item.

Verify & Validate Result

Element Type Description
ID Integer The ID of the Verify & Validate record.
ControlID String The Control ID of the record.
ControlName String The Control Name of the record.
Action String A value from the Action rules attribute value list for the Verify & Validate object.
Status String A value from the Status rules attribute value list for the Verify & Validate object.
Attributes
repeating		 AttributeValue The list of Attributes requested for the Verify & Validate record. Attributes will be of type VerifyValidate as defined in AttributeUseType.