DashboardSettings

Get Dashboard Service Request Setup

Returns a Service Request Setup for Dashboard

get/dashboardsettings/requestsetup/{setupId}

Request

Path parameters

setupIdinteger required

The numeric identifier of the Dashboard Setup Id.

Response

Indicates that the request succeeded

SetupIdinteger

Store Dashboard Setup ID.

EnableRequestWizardboolean

This flag enables/disables request wizard for the dashboard.

ShowPrivateStoreNotesboolean

Show/hide private store notes in the 'location notes' field on the first step of the service request wizard page.

ShowProviderPhoneNumberboolean

Show/hide provider phone number on the confirmation step after an issue has been submitted.

ShowLastServiceCallboolean

Show last service call and last description in the body of alert email.

SetOriginalVendorForRecallsboolean

This option controls whether original vendor is assigned to the work order in case of a recall.

NteToZeroForRecallsboolean

Set NTE to zero if a new service request is marked as a recall.

SendAlertToFMboolean

This flag controls whether service request email will be sent to the facility managers or not.

TurnOffDescriptionboolean

Show/hide problem description field.

DaysOfHistoryToDisplayinteger

How many days of work order history to display on the dublicates warning report.

ShowStoreWarrantyStrstring

There are three possible options: 1) 'none' hides a StoreWarrantyMessage on the first step of the Request Wizard; 2) 'show' shows a StoreWarrantyMessage on the first step of the Request Wizard; 3) 'stop' shows a StoreWarrantyMessage without a possibility to move to the next step.

StoreWarrantyMessagestring

A store warranty message to show on the first step of the request wizard page.

ConfirmationMessagestring

This message is shown on the confirmation page after the user submits their request.

ProviderNotFoundMessagestring

An error message to show when provider is not found for the specified issue choice.

EnableEquipmentboolean

Show equipment

DuplicateFiltersstring[]
ExcludedCategoriesOpenDupstring[]
ExcludedCategoriesClosedDupstring[]
ExcludedStatusesstring[]
ExcludedTradesOpenDupstring[]
EnableEquipmentReplacementFlagboolean
EnableRequestWizardMobileboolean

This flag enables/disables request wizard for the SC Mobile.

EnableLocationNotesboolean
AlwaysShowLocationNotesboolean
SkipTroubleshootingStepboolean
HidePriorityboolean
EnableIssueListKeywordSearchboolean

This flag enables/disables the keyword search functionality on the request wizard. When enabled, users can type keywords to more quickly identify issue list selections.

HideGPSRadiusboolean
AssetFirstWorkOrderCreationboolean

Enables asset-first approach for work order creation.

EnableEquipmentReplacementboolean
AssetNotListedFlagboolean

Changes

No recorded changes to this operation across all 1 revision of this API.