1. APIs
  2. Vendors

Contents

Summary

Contains methods for working with asset vendors.

Application Identifier Use

This set of APIs uses a application identifier parameter, named appId and of type Int32, which specifies the corresponding application in which actions should be performed.

For the sake of brevity, it is omitted from the parameter list of the API methods below, but still needs to be included whenever there is an {appId} placeholder in the URL for the API method.

API Methods

GET https://services.dartmouth.edu/TDWebApi/api/{appId}/assets/vendors Copy URL

Gets a list of all active vendors. Will not return full vendor information.

Returns

A list of all active vendors. (TeamDynamix.Api.Assets.Vendor[])

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

Remarks

The following properties will not be included in the results:
  • AssetsSuppliedCount
  • Attributes
  • ContractsCount
  • ProductModelsCount
To retrieve such information, you must load a vendor individually.

POST https://services.dartmouth.edu/TDWebApi/api/{appId}/assets/vendors Copy URL

Creates a new vendor.

Parameters

Returns

The created vendor, if the operation was successful.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

GET https://services.dartmouth.edu/TDWebApi/api/{appId}/assets/vendors/{id} Copy URL

Gets a vendor.

Parameters

Returns

The vendor if it was found. (TeamDynamix.Api.Assets.Vendor)

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

PUT https://services.dartmouth.edu/TDWebApi/api/{appId}/assets/vendors/{id} Copy URL

Edits the vendor specified by the vendor ID.

Parameters

Returns

The updated vendor, if the operation was successful. (TeamDynamix.Api.Assets.Vendor)

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

POST https://services.dartmouth.edu/TDWebApi/api/{appId}/assets/vendors/search Copy URL

Gets a list of vendors. Will not return full vendor information.

Parameters

Returns

A list of vendors matching the provided criteria. (TeamDynamix.Api.Assets.Vendor[])

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

Remarks

The following properties will not be included in the results:
  • AssetsSuppliedCount
  • Attributes
  • ContractsCount
  • ProductModelsCount
To retrieve such information, you must load a vendor individually.