1. APIs
  2. Locations

Contents

Summary

Contains methods for working with locations.

API Methods

GET https://helpdesk.grps.org/TDWebApi/api/locations Copy URL

Gets a list of all active locations. Will not return full location information.

Returns

A list of all active locations. (TeamDynamix.Api.Locations.Location[])

Rate/Submission Limitations

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

Remarks

This endpoint will not return all location information. For example, the following properties will not be included in the results:
  • Attributes
  • AssetsCount
  • ConfigurationItemsCount
  • TicketsCount
  • RoomsCount
  • UsersCount
  • Rooms
To retrieve such information, you must load a location individually.

POST https://helpdesk.grps.org/TDWebApi/api/locations Copy URL

Creates a location.

Parameters

Returns

The created location if the operation was successful.

Access Restrictions

This action requires the "All: Create and modify the list of locations and their rooms" 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://helpdesk.grps.org/TDWebApi/api/locations/{id} Copy URL

Gets a location.

Parameters

Returns

The location. (TeamDynamix.Api.Locations.Location)

Rate/Submission Limitations

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

PUT https://helpdesk.grps.org/TDWebApi/api/locations/{id} Copy URL

Edits the specified location.

Parameters

Returns

The updated location. (TeamDynamix.Api.Locations.Location)

Access Restrictions

This action requires the "All: Create and modify the list of locations and their rooms" 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://helpdesk.grps.org/TDWebApi/api/locations/{id}/rooms Copy URL

Creates a room in a location.

Parameters

Returns

The created room if the operation was successful.

Access Restrictions

This action requires the "All: Create and modify the list of locations and their rooms" permission.

Rate/Submission Limitations

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

DELETE https://helpdesk.grps.org/TDWebApi/api/locations/{id}/rooms/{roomId} Copy URL

Deletes a room in a location. This cannot be undone.

Parameters

Returns

A response message indicating if the operation was successful or not.

Access Restrictions

This action requires the "All: Create and modify the list of locations and their rooms" 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://helpdesk.grps.org/TDWebApi/api/locations/{id}/rooms/{roomId} Copy URL

Gets a location room.

Parameters

Returns

The location room. (TeamDynamix.Api.Locations.LocationRoom)

Rate/Submission Limitations

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

PUT https://helpdesk.grps.org/TDWebApi/api/locations/{id}/rooms/{roomId} Copy URL

Edits the specified room in a location.

Parameters

Returns

The updated room. (TeamDynamix.Api.Locations.LocationRoom)

Access Restrictions

This action requires the "All: Create and modify the list of locations and their rooms" 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://helpdesk.grps.org/TDWebApi/api/locations/search Copy URL

Gets a list of locations. Will not return full location information.

Parameters

Returns

A list of locations matching the specified criteria. (TeamDynamix.Api.Locations.Location[])

Rate/Submission Limitations

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

Remarks

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