InternalLocationWithBusinessHours
This entity describes key business details for the Autotask Zero Company, that is, the Autotask user's company account, which is identified by the account number 0. The entity provides an efficient way to access the details, via the API, to assist with the customer's Autotask implementation.
NOTE You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.
Entity details
Entity Name: | InternalLocationWithBusinessHours |
Entity Path: |
/atservicesrest/v1.0/InternalLocationWithBusinessHours |
Can Create: | |
Can Update: | |
Can Query: | |
Can Delete: | |
Can Have UDFs: |
Conditions and requirements
- Requires security level access to Admin >Features & Settings > Your Organization
- The API expects date and time for a datetime value.
Special field attributes
Field | Conditions and Requirements |
---|---|
...Extended Hour... |
Extended Hours Start cannot be between HoursStart and HoursEnd. Extended Hours End cannot be between HoursStart and HoursEnd. |
...HoursEnd... |
HoursEnd cannot be empty if a value exists for HoursStart. HoursEnd cannot be before HoursEnd. |
...HoursStart... |
HoursStart cannot be empty if a value exists for HoursEnd. |
isDefault |
isDefault is set to False on create. Only one InternalLocationWithBusinessHours can be isDefault = True. |
firstDayOfWeek |
First day of week defaults to Sunday. Options are Sunday or Monday. |
holidayHoursType |
None: no holiday hours Normal: same hours as on regular business days Specified: If holidayHoursType = Specified, then the user must supply values for the holiday hours start/end times (either extended or normal). |
noHoursOnHolidays |
noHoursOnHolidays defaults to False. If no Holiday Set is specified, defaults to None Selected. |
Field definitions
The following table describes the standard Autotask fields for this entity. Refer to the following articles for more information about working with these fields:
- The entityInformation REST API call
- Making basic query calls to the REST API
- Advanced query features of the REST API
To learn how to query picklist endpoints, refer to Understanding picklists.
Notes
- For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
- LT indicates Local Term.
- If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
- You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
Field Name | Datatype |
Read-Only | Is Required | Reference Name | Picklist |
---|---|---|---|---|---|
additionalAddressInfo | string (100) | ||||
address1 | string (100) | ||||
address2 | string (100) | ||||
city | string (50) | ||||
countryID | integer | Countries | |||
dateFormat | string (50) | ||||
firstDayOfWeek | integer | ||||
fridayBusinessHoursEndTime | datetime | ||||
fridayBusinessHoursStartTime | datetime | ||||
fridayExtendedHoursEndTime | datetime | ||||
fridayExtendedHoursStartTime | datetime | ||||
holidayExtendedHoursEndTime | datetime | ||||
holidayExtendedHoursStartTime | datetime | ||||
holidayHoursEndTime | datetime | ||||
holidayHoursStartTime | datetime | ||||
holidayHoursType | integer | ||||
holidaySetID | integer | HolidaySets | |||
id | long | ||||
isDefault | boolean | ||||
mondayBusinessHoursEndTime | datetime | ||||
mondayBusinessHoursStartTime | datetime | ||||
mondayExtendedHoursEndTime | datetime | ||||
mondayExtendedHoursStartTime | datetime | ||||
name | string (100) | ||||
noHoursOnHolidays | boolean | ||||
numberFormat | string (50) | ||||
postalCode | string (20) | ||||
saturdayBusinessHoursEndTime | datetime | ||||
saturdayBusinessHoursStartTime | datetime | ||||
saturdayExtendedHoursEndTime | datetime | ||||
saturdayExtendedHoursStartTime | datetime | ||||
state | string (25) |
|
|
|
|
sundayBusinessHoursEndTime | datetime | ||||
sundayBusinessHoursStartTime | datetime | ||||
sundayExtendedHoursEndTime | datetime | ||||
sundayExtendedHoursStartTime | datetime | ||||
thursdayBusinessHoursEndTime | datetime | ||||
thursdayBusinessHoursStartTime | datetime | ||||
thursdayExtendedHoursEndTime | datetime | ||||
thursdayExtendedHoursStartTime | datetime | ||||
timeFormat | string (50) | ||||
timeZoneID | integer | ||||
tuesdayBusinessHoursEndTime | datetime | ||||
tuesdayBusinessHoursStartTime | datetime | ||||
tuesdayExtendedHoursEndTime | datetime | ||||
tuesdayExtendedHoursStartTime | datetime | ||||
wednesdayBusinessHoursEndTime | datetime | ||||
wednesdayBusinessHoursStartTime | datetime | ||||
wednesdayExtendedHoursEndTime | datetime |
|
|||
wednesdayExtendedHoursStartTime | datetime |