Overview
Configuration is provided for establishing connections with the Fleet Complete service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Configuration
Base URL address: https://tlshosted.fleetcomplete.com/v8_3_0/Integration/WebAPI.
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- ClientID: Required. Specify client identifier.
- User: Required. Specify user name.
- Password: Required. Specify password.
The following request parameters will be automatically processed during the authentication process:
-
Token:
{{=token.Access}} -
UserID:
{{=token.UserID}} -
ClientID:
{{=connection.user.ClientID}}
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/GPS/Asset.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Asset/Asset_GetAssets.
- [Create] action
-
Endpoint URL address:
/GPS/Asset.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Asset/Asset_Post.
- [Update] action
-
Endpoint URL address:
/GPS/Asset/{{=item.ID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Asset/Asset_Put.
- [Delete] action
-
Endpoint URL address:
/GPS/Asset/{{=item.ID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Asset/Asset_Delete.
- ID
A key field. Template: ShortText.
- DeviceID
Template: ShortText.
- IsRecordOnDirectionChange
Data type: DT_BOOL
- LastUpdatedTimeStamp
Template: DateTime.
- VIN
Template: ShortText.
- Make
Template: ShortText.
- Model
Template: ShortText.
- Year
Data type: DT_I4
- Manufacturer
Template: ShortText.
- HasMDT
Data type: DT_BOOL
- AlternateDDSConfigured
Data type: DT_BOOL
- IsDeleted
Data type: DT_BOOL A read-only field.
- Position
Field components:
-
Uses template:
ShortText. - Contains the following components: Latitude, Longitude, Address.
-
Uses template:
- Branch
Template: Reference.
- Description
Template: LongText.
- Resource
Template: Reference. The value is gathered from
/GPS/Asset/{{=item.ID}}/Resourceaddress. The gathered value is processed with{{=response.Data}}expression.- AssetType
Template: Reference. The value is gathered from
/GPS/Asset/{{=item.ID}}/Typeaddress. The gathered value is processed with{{=response.Data}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: MapImage.
-
Uses template:
- HomeBase
Template: Reference. The value is gathered from
/GPS/Asset/{{=item.ID}}/Homebaseaddress. The gathered value is processed with{{=response.Data}}expression.- WorkSchedule
Template: Reference. The value is gathered from
/GPS/Asset/{{=item.ID}}/WorkScheduleaddress. The gathered value is processed with{{=response.Data}}expression.- RelatedAssetInfo
Template: LongText. A composite field. The value is gathered from
/GPS/Asset/{{=item.ID}}/RelatedAssetaddress. The gathered value is processed with{{=response.Data}}expression.- Advanced
The value is gathered from
/GPS/Asset/{{=item.ID}}/Advancedaddress. The gathered value is processed with{{=response.Data}}expression. Field components:- Contains the following components: AltDDS, Satellite, AssetPoiAlert.
- Sensors
The value is gathered from
/GPS/Asset/{{=item.ID}}/Sensoraddress. The gathered value is processed with{{=response.Data}}expression. Field components:- An array.
-
Uses template:
Sensor.
- Rules
The value is gathered from
/GPS/Asset/{{=item.ID}}/Ruleaddress. The gathered value is processed with{{=response.Data}}expression. Field components:- An array.
- Contains the following components: ID, Sensor, OutputSensor, Description.
- ECM
The value is gathered from
/GPS/Asset/{{=item.ID}}/ECMaddress. The gathered value is processed with{{=response.Data}}expression. The value is sent to/GPS/Asset/{{=item.ID}}/ECMaddress. Field components:-
Uses template:
ShortText. - Contains the following components: EngineType, FuelType, EngineEfficiency, EngineDisplacement.
-
Uses template:
- VehicleDetails
The value is gathered from
/GPS/Asset/{{=item.ID}}/Vehicleaddress. The gathered value is processed with{{=response.Data}}expression. The value is sent to/GPS/Asset/{{=item.ID}}/Vehicleaddress. Field components:-
Uses template:
ShortText. - Contains the following components: IsEngineDisabled, FuelTankOneCapacity, FuelTankTwoCapacity, IsFuelTankCapacityMetric, FuelEconomyManufacturer, IsFuelEconomyManufacturerMetric, FuelEconomy, IsFuelEconomyMetric, VIN, LicensePlate, IsOdometerMetric, Odometer, Make, Model, Manufacturer, Year, OperatingSeconds, Type, IsHeavyDuty.
-
Uses template:
- VehicleType
Template: Reference. The value is gathered from
/GPS/Asset/{{=item.ID}}/VehicleTypeaddress. The gathered value is processed with{{=response.Data}}expression. The value is sent to/GPS/Asset/{{=item.ID}}/VehicleTypeaddress.- DeviceDataSetting
Template: Reference. The value is gathered from
/GPS/Asset/{{=item.ID}}/DDSaddress. The gathered value is processed with{{=response.Data}}expression. The value is sent to/GPS/Asset/{{=item.ID}}/DDSaddress.- MDT
The value is gathered from
/GPS/Asset/{{=item.ID}}/MDTaddress. The gathered value is processed with{{=response.Data}}expression. The value is sent to/GPS/Asset/{{=item.ID}}/MDTaddress. Field components:-
Uses template:
ShortText. - Contains the following components: IsMDTEnabled, MDTDeviceType, CannedMessageGroupID, CannedReplyGroupID, MessageGroup, ReplyGroup.
-
Uses template:
- Run
Template: Reference. The value is gathered from
/GPS/Asset/{{=item.ID}}/Runaddress. The gathered value is processed with{{=response.Data}}expression. The value is sent to/GPS/Asset/{{=item.ID}}/Runaddress.- Trip
The value is gathered from
/GPS/Asset/{{=item.ID}}/Tripaddress. Field components:- An array.
- Contains the following components: ID, AssetID, StartOdometer, EndOdometer, StartFuelLevel, EndFuelLevel, TotalDistance, TotalFuelConsumption, FuelEconomy, StartTimeStamp, EndTimeStamp, StartAtHomeBase, EndAtHomeBase, BranchStartTimeStamp, BranchEndTimeStamp, TimeZone, BranchTimeZone, StartFuelLevel2, EndFuelLevel2, FuelEconomyECM, StartSnapShotID, EndSnapShotID.
- [External]
-
The external fields URL address:
/GPS/CustomField/2.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/GPS/Asset/{{=parameters.AssetId}}/Sensor.The action has the following user-defined parameters:
- AssetId: Required. Specifies asset identifier to return sensors for.
Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Asset/Asset_GetAssetSensors.
- [Create] action
-
Endpoint URL address:
/GPS/Asset/{{=item.AssetId}}/Sensor.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Asset/Asset_PostSensor.
- [Update] action
-
Endpoint URL address:
/GPS/Asset/{{=item.AssetId}}/Sensor/{{=item.ID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Asset/Asset_PutSensor.
- [Delete] action
-
Endpoint URL address:
/GPS/Asset/{{=item.AssetId}}/Sensor/{{=item.ID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Asset/Asset_DeleteAssetSensor.
The resource includes the fields from the Sensor template.
- AssetId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/GPS/Asset/{{=parameters.AssetId}}/Rule.The action has the following user-defined parameters:
- AssetId: Required. Specifies asset identifier to return rules for.
Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Asset/Asset_GetAssetRules.
- [Update] action
-
Endpoint URL address:
/GPS/Asset/{{=item.AssetId}}/Rule/{{=item.ID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Asset/Asset_PutAssetRule.
- ID
A key field. Template: ShortText.
- Sensor
Template: Sensor.
- OutputSensor
Template: Sensor.
- AssetId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/GPS/Asset/Type.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/AssetType/AssetType_GetAssetTypes.
- [Create] action
-
Endpoint URL address:
/GPS/Asset/Type.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/AssetType/AssetType_Post.
- [Update] action
-
Endpoint URL address:
/GPS/Asset/Type/{{=item.ID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/AssetType/AssetType_Put.
- [Delete] action
-
Endpoint URL address:
/GPS/Asset/Type/{{=item.ID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/AssetType/AssetType_Delete.
- ID
A key field. Template: ShortText.
- MapImage
Template: ShortText.
- Description
Template: LongText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/GPS/Branch.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Branch/Branch_GetBranches.
- ID
A key field. Template: ShortText.
- ParentBranchID
Template: ShortText.
- BranchLevelNumber
Data type: DT_I4
- IsPhysical
Data type: DT_BOOL
- LastUpdatedTimeStamp
Template: DateTime.
- Description
Template: LongText.
- [Read] action
-
Endpoint URL address:
/Common/TimeWindowTypes.
The result is extracted from:{{=response.Data}}.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Common/Common_GetTimeWindowTypes.
-
_includeUserParameters:
- TimeWindowTypeID
Data type: DT_I4
- Description
Template: LongText.
- [Read] action
-
Endpoint URL address:
/Common/Countries.
The result is extracted from:{{=response.Data}}.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Common/Common_GetCountries.
-
_includeUserParameters:
- CountryCode
Template: ShortText.
- CountryName
Template: ShortText.
- [Read] action
-
Endpoint URL address:
/Common/{{=parameters.CountryCode}}/ProvinceStates.
The result is extracted from:{{=response.Data}}.The action has the following user-defined parameters:
- CountryCode: Required. Specifies 3 digit country code to return provinces or states for.
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Common/Common_GetProvinceStates.
- ProvinceStateCode
Template: ShortText.
- ProvinceStateName
Template: ShortText.
- Country
Template: ShortText.
- [Read] action
-
Endpoint URL address:
/Common/Timezones.
The result is extracted from:{{=response.Data}}.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Common/Common_GetTimezones.
-
_includeUserParameters:
- TimezoneID
Template: ShortText.
- Abbreviation
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/GPS/CustomField/{{=parameters.Type}}.The action has the following user-defined parameters:
- Type: Required. Specifies type to return custom fields for.
Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/CustomField/CustomField_GetCustomFieldsByType.
- [Create] action
-
Endpoint URL address:
/GPS/CustomField/{{=item.Type}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/CustomField/CustomField_Post.
- [Update] action
-
Endpoint URL address:
/GPS/CustomField/{{=item.Type}}/{{item.ID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/CustomField/CustomField_Put.
- [Delete] action
-
Endpoint URL address:
/GPS/CustomField/{{=item.Type}}/{{item.ID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/CustomField/CustomField_Delete.
- ID
A key field. Data type: DT_I4
- FieldLabel
Template: ShortText.
- FieldDataType
Data type: DT_I4
- IsRequiredOnNew
Data type: DT_BOOL
- IsRequiredOnComplete
Data type: DT_BOOL
- IsEditableOnDevice
Data type: DT_BOOL
- DefaultValue
Template: ShortText.
- InputMask
Template: ShortText.
- CategoryID
Data type: DT_I4
- IsDeleted
Data type: DT_BOOL A read-only field.
- IsRequiredOnStart
Data type: DT_BOOL
- EntityType
Data type: DT_I4
- Ordinal
Data type: DT_I4
- IsVisibleOnDevice
Data type: DT_BOOL
- IsVisibleInDispatch
Data type: DT_BOOL
- IsVisibleInMapInfoPane
Data type: DT_BOOL
- IsVisibleInMapLabel
Data type: DT_BOOL
- IsVisibleInNotifications
Data type: DT_BOOL
- IsVisibleInReports
Data type: DT_BOOL
- IsEnabled
Data type: DT_BOOL
- MaximumLength
Data type: DT_I4
- TaskTemplateID
Data type: DT_I4
- LastUpdatedTimeStamp
Template: DateTime.
- IsEmailed
Data type: DT_BOOL
- ActionAssembly
Template: ShortText.
- ShortcutKey
Template: ShortText.
- ClientID
Template: ShortText.
- Type
A key field. Data type: DT_I4
Based on resource template Base.
- ID
A key field. Template: ShortText.
- Type
Data type: DT_I4
- PhoneNumber
Template: ShortText.
- ProductID
Template: ShortText.
- GPSCapability
Data type: DT_I4
- IsAdvancedFeaturesSupported
Data type: DT_BOOL
- PingInterval
Data type: DT_I4
- FCWorkforceConfiguration
Template: ShortText.
- IsDeleted
Data type: DT_BOOL A read-only field.
- Sensors
The value is gathered from
/GPS/Device/{{=item.ID}}/Sensoraddress. Field components:- An array.
- Contains the following components: SensorName, SensorType, Description.
- [Read] action
-
Endpoint URL address:
/GPS/DDS.
The result is extracted from:{{=response.Data}}.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/DeviceDataSetting/DeviceDataSetting_GetAvailableTypes.
-
_includeUserParameters:
- Type
Template: ShortText.
- ProductID
Template: ShortText.
- Description
Template: LongText.
Based on resource template DDS.
- [Read] action
-
Endpoint URL address:
/GPS/DDS/InVehicleTrackingDds.
- [Create] action
-
Endpoint URL address:
/GPS/DDS/InVehicleTrackingDds.
- [Update] action
-
Endpoint URL address:
/GPS/DDS/InVehicleTrackingDds/{{=item.DeviceDataSettingID}}.
- [Delete] action
-
Endpoint URL address:
/GPS/DDS/InVehicleTrackingDds/{{=item.DeviceDataSettingID}}.
- IsDataConservationModeDisabled
Data type: DT_BOOL
- RecordTime
Data type: DT_I4
- RecordTimeUnit
Data type: DT_I4
- TransmitTime
Data type: DT_I4
- TransmitTimeUnit
Data type: DT_I4
Based on resource template DDS.
- [Read] action
-
Endpoint URL address:
/GPS/DDS/MgsDds.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/DeviceDataSetting/DeviceDataSetting_GetMgsDdss.
- [Create] action
-
Endpoint URL address:
/GPS/DDS/MgsDds.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/DeviceDataSetting/DeviceDataSetting_InsertMgsDds.
- [Update] action
-
Endpoint URL address:
/GPS/DDS/MgsDds/{{=item.DeviceDataSettingID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/DeviceDataSetting/DeviceDataSetting_UpdateMgsDds.
- [Delete] action
-
Endpoint URL address:
/GPS/DDS/MgsDds/{{=item.DeviceDataSettingID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/DeviceDataSetting/DeviceDataSetting_DeleteMgsDds.
- RecordTime
Data type: DT_I4
- RecordTimeUnit
Data type: DT_I4
- TransmitTime
Data type: DT_I4
- TransmitTimeUnit
Data type: DT_I4
Based on resource template DDS.
- [Read] action
-
Endpoint URL address:
/GPS/DDS/At1000Dds.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/DeviceDataSetting/DeviceDataSetting_GetAt1000Ddss.
- [Create] action
-
Endpoint URL address:
/GPS/DDS/At1000Dds.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/DeviceDataSetting/DeviceDataSetting_InsertAt1000Dds.
- [Update] action
-
Endpoint URL address:
/GPS/DDS/At1000Dds/{{=item.DeviceDataSettingID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/DeviceDataSetting/DeviceDataSetting_UpdateAt1000Dds.
- [Delete] action
-
Endpoint URL address:
/GPS/DDS/At1000Dds/{{=item.DeviceDataSettingID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/DeviceDataSetting/DeviceDataSetting_DeleteAt1000Dds.
- StationaryTransmitIntervalPowerConnected
Data type: DT_I4
- StationaryTransmitIntervalPowerConnectedUnit
Data type: DT_I4
- StationaryTransmitIntervalPowerDisconnected
Data type: DT_I4
- StationaryTransmitIntervalPowerDisconnectedUnit
Data type: DT_I4
- IsMotionDetectionEnabled
Data type: DT_BOOL
- MovingTransmitIntervalPowerConnected
Data type: DT_I4
- MovingTransmitIntervalPowerConnectedUnit
Data type: DT_I4
- MovingTransmitIntervalPowerDisconnected
Data type: DT_I4
- MovingTransmitIntervalPowerDisconnectedUnit
Data type: DT_I4
Based on resource template DDS.
- [Read] action
-
Endpoint URL address:
/GPS/DDS/LbsDds.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/DeviceDataSetting/DeviceDataSetting_GetLbsDdss.
- [Create] action
-
Endpoint URL address:
/GPS/DDS/LbsDds.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/DeviceDataSetting/DeviceDataSetting_InsertLbsDds.
- [Update] action
-
Endpoint URL address:
/GPS/DDS/LbsDds/{{=item.DeviceDataSettingID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/DeviceDataSetting/DeviceDataSetting_UpdateLbsDds.
- [Delete] action
-
Endpoint URL address:
/GPS/DDS/LbsDds/{{=item.DeviceDataSettingID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/DeviceDataSetting/DeviceDataSetting_DeleteLbsDds.
- TimeZoneName
Template: ShortText.
- WeekDaysSchedule
Field components:
-
Uses template:
ScheduleTime. - Contains the following components: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/HOS/Resource.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/HOS/HOS_GetHOSResources.
- Id
A key field. Template: ShortText.
- HOSUserId
Template: ShortText.
- Description
Template: LongText.
- CoDrivers
Template: LongText. A composite field.
- Branch
Field components:
-
Uses template:
ShortText. - Contains the following components: key, value.
-
Uses template:
- DutyStatus
Field components:
-
Uses template:
ShortText. - Contains the following components: key, value.
-
Uses template:
- LastUpdatedTimeStamp
Template: DateTime.
- TimeZone
Template: ShortText.
- BranchTimeZone
Template: ShortText.
- DriveTimeRemaining
Data type: DT_I4
- DriveTime
Data type: DT_I4
- CycleOnDutyRemaining
Data type: DT_I4
- CycleOnDuty
Data type: DT_I4
- PendingLogEditRequests
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/GPS/POI.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/POI/POI_GetPois.
- [Create] action
-
Endpoint URL address:
/GPS/POI.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/POI/POI_Post.
- [Update] action
-
Endpoint URL address:
/GPS/POI/{{=item.ID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/POI/POI_Put.
- [Delete] action
-
Endpoint URL address:
/GPS/POI/{{=item.ID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/POI/POI_Delete.
- ID
A key field. Template: ShortText.
- AssignedBranchID
Template: ShortText.
- CategoryType
Data type: DT_I4
- AddressInformation
Field components:
-
Uses template:
ShortText. - Contains the following components: Street, Street2, City, County, PostalCode, ProvinceCode, CountryCode, AddressCode, Notes.
-
Uses template:
- GeofenceTypeID
Template: ShortText.
- GeofenceTypeDescription
Template: LongText.
- IsShared
Data type: DT_BOOL
- TimeZone
Template: ShortText.
- ContactInformation
Field components:
-
Uses template:
ShortText. - Contains the following components: ContactName, ContactPhone, ContactTitle, ContactFax, ContactEmail, ContactMobile, ContactInfo.
-
Uses template:
- Description
Template: LongText.
- GeoData
The value is gathered from
/GPS/POI/{{=item.ID}}/GeoDataaddress. The gathered value is processed with{{=response.Data}}expression. Field components:- Contains the following components: Buffer, IsBufferMetric, Zoneshape, Coordinates.
- Notification
The value is gathered from
/GPS/POI/{{=item.ID}}/Notificationaddress. The gathered value is processed with{{=response.Data}}expression. Field components:-
Uses template:
LongText. - Contains the following components: IsContactEmailed, ExitEmailText, EnterEmailText, ExitEmailSubject, EnterEmailSubject, EmailNotificationDelay, EmailNotificationRestrictionType, WorkSchedule.
-
Uses template:
- GeofenceType
A read-only field. The value is gathered from
/GPS/POI/{{=item.ID}}/GeofenceTypeaddress. The gathered value is processed with{{=response.Data}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: ID, MapImage, LineWeight, POIColor, Description.
-
Uses template:
- [Read] action
-
Endpoint URL address:
/GPS/POI/CategoryTypes.
The result is extracted from:{{=response.Data}}.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/POI/POI_GetCategoryTypes.
-
_includeUserParameters:
- CategoryTypeID
Data type: DT_I4
- Description
Template: LongText.
- [Read] action
-
Endpoint URL address:
/GPS/POI/ZoneShapes.
The result is extracted from:{{=response.Data}}.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/POI/POI_GetZoneShapes.
-
_includeUserParameters:
- ZoneshapeID
Data type: DT_I4
- Description
Template: LongText.
- [Read] action
-
Endpoint URL address:
/GPS/POI/ZoneShapes.
The result is extracted from:{{=response.Data}}.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/POI/POI_GetEmailNotificationRestrictionTypes.
-
_includeUserParameters:
- EmailNotificationRestrictionTypeID
Data type: DT_I4
- Description
Template: LongText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/GPS/POI/Type.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/POIType/POIType_GetPoiTypes.
- [Create] action
-
Endpoint URL address:
/GPS/POI/Type.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/POIType/POIType_Post.
- [Update] action
-
Endpoint URL address:
/GPS/POI/Type/{{=item.ID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/POIType/POIType_Put.
- [Delete] action
-
Endpoint URL address:
/GPS/POI/Type/{{=item.ID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/POIType/POIType_Delete.
- ID
A key field. Template: ShortText.
- MapImage
Template: ShortText.
- LineWeight
Data type: DT_I4
- POIColor
Template: ShortText.
- Description
Template: LongText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/GPS/Resource.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Resource/Resource_GetResources.
- [Create] action
-
Endpoint URL address:
/GPS/Resource.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Resource/Resource_Post.
- [Update] action
-
Endpoint URL address:
/GPS/Resource/{{=item.ID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Resource/Resource_PutResource.
- [Delete] action
-
Endpoint URL address:
/GPS/Resource/{{=item.ID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Resource/Resource_DeleteResource.
- ID
A key field. Template: ShortText.
- Description
Template: LongText.
- Code
Template: ShortText.
- IsActive
Data type: DT_BOOL
- IsSettlementOnly
Data type: DT_BOOL
- IsSuspended
Data type: DT_BOOL
- IsShared
Data type: DT_BOOL
- LastUpdatedTimeStamp
Template: DateTime.
- AssignedBranchID
Template: ShortText.
- Branch
Template: Reference.
- Parents
Template: LongText. A composite field.
- DriverName
Template: ShortText.
- ResourceCode
Template: ShortText.
- WorkStatus
Data type: DT_I4
- BranchDescription
Template: LongText.
- IsDeleted
Data type: DT_BOOL A read-only field.
- LicenseExpiryDate
Template: DateTime.
- InsuranceExpiryDate
Template: DateTime.
- IsStrongBox
Data type: DT_BOOL
- ResourceTypeID
Template: ShortText.
- ResourceCategory
Data type: DT_I4
- ResourceTypeDescription
Template: LongText.
- Company
Template: ShortText.
- HasDevice
Data type: DT_BOOL
- KodiakNumber
Template: ShortText.
- DailyExpectedRevenue
Data type: DT_CY
- GuaranteeAmount
Data type: DT_CY
- SettlementFrequency
Data type: DT_I4
- WorkScheduleID
Template: ShortText.
- ActiveWork
Data type: DT_I4
- Details
The value is gathered from
/GPS/Resource/{{=item.ID}}/Detailsaddress. The gathered value is processed with{{=response.Data}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: LanguagePreference, Company, IsStrongBox, OutsideCode, InsideCode, Communication, Insurance, License, WorkInfo, AssignedCrewID, WorkScheduleID, HomeBaseID, ResourceTypeID, Picture, HomeBase, Assets, ResourceType, HOS, WorkSchedule, Routes, SettlementOptions, TaskLegs, DeductionAssignments.
-
Uses template:
- EquipmentTypes
The value is gathered from
/GPS/Resource/{{=item.ID}}/EquipmentTypesaddress. The gathered value is processed with{{=response.Data}}expression. Field components:- An array.
- Contains the following components: ID, Code, Description.
- VehicleTypes
The value is gathered from
/GPS/Resource/{{=item.ID}}/VehicleTypesaddress. The gathered value is processed with{{=response.Data}}expression. Field components:- An array.
-
Uses template:
Reference.
- Certifications
The value is gathered from
/GPS/Resource/{{=item.ID}}/Certificationsaddress. The gathered value is processed with{{=response.Data}}expression. Field components:- An array.
-
Uses template:
Reference.
- [External]
-
The external fields URL address:
/GPS/CustomField/5.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/GPS/Rule.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Rule/Rule_GetRules.
- [Create] action
-
Endpoint URL address:
/GPS/Rule/{{=item.Type}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Rule/Rule_Post.
- [Update] action
-
Endpoint URL address:
/GPS/Rule/{{=item.ID}}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Rule/Rule_Put.
- [Delete] action
-
Endpoint URL address:
/GPS/Rule/{{=item.ID}}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/Rule/Rule_Delete.
- ID
A key field. Template: ShortText.
- LastUpdatedTimeStamp
Template: DateTime.
- AssignedBranchID
Template: ShortText.
- IsAutoAssign
Data type: DT_BOOL
- IsSystem
Data type: DT_BOOL
- Detail
Field components:
-
Uses template:
LongText. - Contains the following components: Description, Value, SecondaryValue.
-
Uses template:
- Notification
Field components:
-
Uses template:
ShortText. - Contains the following components: SoundAlarm, SoundFile, Initial, Repeat.
-
Uses template:
- EmailOptions
Field components:
-
Uses template:
ShortText. - Contains the following components: NotificationLanguage, SubjectField1, SubjectField2, SubjectField3, BodyFields.
-
Uses template:
- Restrictions
Field components:
- Contains the following components: GeofenceRestrictionType, WorkScheduleEnforcementType, Geofences, GeofenceTypes.
- Type
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/GPS/WorkSchedule.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/WorkSchedule/WorkSchedule_GetWorkSchedules.
- [Create] action
-
Endpoint URL address:
/GPS/WorkSchedule.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/WorkSchedule/WorkSchedule_InsertWorkSchedule.
- [Update] action
-
Endpoint URL address:
/GPS/WorkSchedule/{{=item.ID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/WorkSchedule/WorkSchedule_UpdateWorkSchedule.
- [Delete] action
-
Endpoint URL address:
/GPS/WorkSchedule/{{=item.ID}}.Documentation: http://hosted.fleetcomplete.com/v8_3_0/Integration/WebAPI/fleet-docs/dist/index.html#!/WorkSchedule/WorkSchedule_DeleteWorkSchedule.
- ID
A key field. Template: ShortText.
- Grace
Field components:
- Contains the following components: DepartureGrace, ReturnGrace.
- AssignedBranchID
Template: ShortText.
- ScheduleList
Field components:
- An array.
- Contains the following components: WeekDay, StartTime, EndTime, IsActive, TimeWindowType.
- Description
Template: LongText.
- [Read] action
-
The result is extracted from:{{=response.Data}}.
The result is paginated.The following request parameters will be automatically processed:
-
top:
{{=parameters.batchSize}} -
skip:
{{=parameters.iterator}} -
_includeUserParameters:
{{=parameters}}
-
top:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
- [External]
-
The external fields list is extracted from:
{{=_.filter(response.Data, function(field) { return field.IsEnabled && !field.IsDeleted; })}}.- {{=external.FieldLabel}}
Data type: {{=FleetComplete.getDataType(external.FieldDataType)}} ( length {{=external.MaximumLength}} )
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Reference
Field components:
-
Uses template:
ShortText. - Contains the following components: ID, Description.
-
Uses template:
- Sensor
Field components:
-
Uses template:
ShortText. - Contains the following components: ID, PhysicalSensor, Type, SensorUnit, DefaultStateUnit, PartnerUnit, Description.
-
Uses template:
- ScheduleTime
Field components:
- Contains the following components: Active12AM, Active01AM, Active02AM, Active03AM, Active04AM, Active05AM, Active06AM, Active07AM, Active08AM, Active09AM, Active10AM, Active11AM, Active12PM, Active01PM, Active01PM, Active02PM, Active03PM, Active04PM, Active05PM, Active06PM, Active07PM, Active08PM, Active09PM, Active10PM, Active11PM.
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.