1. APIs
  2. Accounts

Contents

Summary

Contains methods for working with accounts/departments.

API Methods

GET https://services.dartmouth.edu/TDWebApi/api/accounts Copy URL

Gets a list of all active accounts/departments. Will not return full account/department information.

Returns

A list of all active accounts/departments. (TeamDynamix.Api.Accounts.Account[])

Rate/Submission Limitations

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

Remarks

Results will be limited to accounts/departments that the user a member of, unless that user has the "View All Accounts/Departments" permission.

The Attributes property will not be included in the results. To retrieve such information, you must load an account individually.

POST https://services.dartmouth.edu/TDWebApi/api/accounts Copy URL

Creates a new account.

Parameters

Returns

A newly created account.

Access Restrictions

This action requires the "Acct/Dept: Create Accts/Depts" permission.

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/accounts/{id} Copy URL

Gets an account.

Parameters

Returns

The account, with full information. (TeamDynamix.Api.Accounts.Account)

Rate/Submission Limitations

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

Remarks

This action requires the user to be a member of the Account/Department requested, or have the "View All Accounts/Departments" permission.

PUT https://services.dartmouth.edu/TDWebApi/api/accounts/{id} Copy URL

Edits the account specified by the account ID.

Parameters

Returns

The updated account, if the operation was successful.

Access Restrictions

This action requires the "Acct/Dept: Edit Accts/Depts" permission.

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/accounts/search Copy URL

Gets a list of all accounts/departments. Will not return full account/department information.

Parameters

Returns

A list of accounts/departments matching the specified criteria. (TeamDynamix.Api.Accounts.Account[])

Rate/Submission Limitations

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

Remarks

Results will be limited to accounts/departments that the user a member of, unless that user has the "View All Accounts/Departments" permission.

The Attributes property will not be included in the results. To retrieve such information, you must load an account individually.