Cmdlets for TSheets

Build 23.0.8839

Locations

Retrieves a list of all locations associated with your company.

Table Specific Information

Select

Query the Locations table. The cmdlet will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the cmdlet.

  • Id and GeoCodingStatus fields support the '=' and IN operators.
  • ActiveStatus filter supports the '=' operator.
  • LastModified field supports the <=,<,>=,>,= operators.

For example, the following queries are processed server side:

SELECT * FROM Locations WHERE GeoCodingStatus IN ('in_progress', 'retry')

SELECT * FROM Locations WHERE ByJobcodeAssignment = true

Insert

Insert can be executed by specifying any columns. Following is an example of how to insert into this table

INSERT INTO Locations (Address1, City, State, Country) VALUES ('CData office', 'Bangalore', 'KA', 'IN')

INSERT INTO Locations (Address1, City, State, Country, Zip) VALUES ('CData office', 'Bangalore', 'KA', 'IN', '560100')

Update

Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE Locations SET Address1 = 'Microsoft' WHERE Id = '10055' 

Columns

Name Type ReadOnly Description
Id [KEY] String True

Id of location.

Address1 String False

The first line of the location's address.

Address2 String False

The second line of the location's address.

City String False

The city of the location's address.

State String False

The state of the location's address.

Zip String False

The postal code of the location's address.

Country String False

The country of the location's address.

FormattedAddress String True

Formatted address built from the objects addr1, addr2, city, state, and zip. If the location doesn't contain addr1, addr2, or city properties, the value will default what is set in the label property.

Active Boolean False

Whether this location is active. If false, this location is archived.

Latitude Double False

The latitude of the location (in signed degrees format).

Longitude Double False

The longitude of the location (in signed degrees format).

PlaceIdHash String False

The MD5 hash of the unique id for the location returned from the geocoding service.

Label String True

The formated name for the location. If the location was found using the geocode service the formated address will be saved in this field, otherwise it will be what the user has named the location.

Notes String False

Notes related to the location.

GeoCodingStatus String False

The geocoding status of this address. Will be one of: 'none', 'in_progress', 'retry', 'error', or 'complete'.

Created Datetime True

Date/time when this location was created

LastModified Datetime True

Date/time when this customfield was last modified.

LinkedObjects String False

A key/value map of all the objects linked to this location and the corresponding object ids.

GeofenceConfigId Int True

Id of the geofence_config associated with this location.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ByJobcodeAssignment Boolean

If specified, only locations mapped to a jobcode the user is assigned to will be returned.

ActiveStatus String

Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839