SOAP Documentation: Accounts

Overview

This resource provides methods to manage your TraceGains Enterprise Accounts. An Enterprise Account is defined as an Account that has been granted Enterprise level Portal Access in a TraceGains instance.

Notes:

  • This resource does not support accounts that have been granted Enterprise level Portal Access to more than 1 TraceGains instance.
  • This resource does not support accounts with Supplier level Portal Access to any TraceGains instance.

Operations List

The Operations List for this resource: Accounts Operations List.

Resource WSDL

The WSDL for this resource: Accounts WSDL.

Endpoint URLs

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

Create

Enterprise | SM SC QM

 Creates a new Account with Enterprise level Portal Access.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
account EnterpriseAccount The Enterprise Account definition of the account to create.

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

Delete

Enterprise | SM SC QM

 Deletes an account with Enterprise level Portal Access.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
emailAddress String The email address of the account to delete.

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

Get

Enterprise | SM SC QM

 Gets an account with Enterprise level Portal Access.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
emailAddress String The email address of the account to get.

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

List

Enterprise | SM SC QM

 Returns a list of User Accounts.


Request:

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

Response:

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

ResetPassword

Enterprise | SM SC QM

 Initiates the password reset process of an account with Enterprise level Portal Access.

Notes:

  • The account owner will be required to complete the password reset process.

Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
emailAddress String The email address of the account to initiate the password reset process.

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

Update

Enterprise | SM SC QM

 Updates an existing Account with Enterprise level Portal Access.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
account EnterpriseAccount The Enterprise Account definition of the account to update.

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

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.