--- title: "Get Service Request Info Without Dashboard Settings" method: GET path: "/subscribers/current/servicerequest/info/nosettings" tags: ["ServiceRequest"] --- # Get Service Request Info Without Dashboard Settings `GET /subscribers/current/servicerequest/info/nosettings` ## Request - Base URL: `https://sb2api.servicechannel.com/v3` - URL: `https://sb2api.servicechannel.com/v3/subscribers/current/servicerequest/info/nosettings` - Auth: OAuth 2 - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize` - Token URL: `https://sb2login.servicechannel.com/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Retrieves supporting info for "Create Work Order" operation.

This method can only be used for subscriber's users that have assigned dashboard. ## Query parameters - `areaName` string - `problemType` string - `equipmentType` string - `problemCode` string - `locationId` integer - `setupId` integer - `callDate` string, date-time - `version` 'Undefined' | 'V1' | 'V2' ## Response `200` Request succeeded and the requested information is in the response. - ServiceChannelServicesMessagingWorkordersGetServiceRequestInfoResponse - `IssueChoice` ServiceChannelServicesMessagingIssueListsGetIssueChoiceResponse - `ProblemType` string - `EquipmentType` string - `ProblemCode` string - `Trade` string - `TradeId` integer - `IsTradeDeleted` boolean - `Priority` string - `AllowPriorityUpgrade` boolean - `RequireAttachment` boolean - `EquipmentId` string - `EquipmentEntry` string - `Category` string - `Comments` string - `TroubleshootingMessage` string - `ProviderRank` integer - `LabelRanks` integer[] - `Currency` string - `ApprovalCode` string - `LinkToMedia` string - `AdditionalFields` ServiceChannelServicesMessagingIssueListsIssueFieldResponse[] - `ProblemType` string: Gets or sets the problem type. - `Item` string: Gets or sets the item. - `Problem` string: Gets or sets the problem. - `For` string: Gets or sets the for. - `Id` string: Gets or sets the id. - `Header` string: Gets or sets the header. - `ErrorText` string: Gets or sets the error text. - `AreaName` string: Gets or sets the area name. - `Exclude` string: Gets or sets the exclude. - `Min` string: Gets or sets the min. - `Max` string: Gets or sets the max. - `Step` string: Gets or sets the step. - `Helptip` string: Gets or sets the helptip. - `Type` 'textbox' | 'select' | 'size' | 'label' | 'stop' | 'datepicker' | 'timepicker': Gets or sets the type. - `Allow` 'numbers' | 'decimals' | 'all': Gets or sets the allow. - `ExpectedValue` string: Gets or sets the expected value. - `Options` string[]: Gets or sets the options. - `Required` boolean: Determines whether this field is required to fill or not - `Decisions` ServiceChannelServicesMessagingIssueListsDecisionModelResponse[] - `OptionValue` string: OptionValue - `NextQuestion` string: NextQuestion - `OriginalNextQuestion` string: Original NextQuestion - `TradeOverride` string: TradeOverride - `CategoryOverride` string: CategoryOverride - `PriorityOverride` string: PriorityOverride - `NTEOverride` string: NTEOverride - `ProviderRankOverride` string: ProviderRankOverride - `WoLabelOverride` string: WoLabelOverride - `EtcOverride` string: EtcOverride - `LinkToMedia` string - `DisableFilter` boolean: Gets a value indicating whether disable filter. - `AllAdditionalFields` ServiceChannelServicesMessagingIssueListsIssueFieldResponse[] - `ProblemType` string: Gets or sets the problem type. - `Item` string: Gets or sets the item. - `Problem` string: Gets or sets the problem. - `For` string: Gets or sets the for. - `Id` string: Gets or sets the id. - `Header` string: Gets or sets the header. - `ErrorText` string: Gets or sets the error text. - `AreaName` string: Gets or sets the area name. - `Exclude` string: Gets or sets the exclude. - `Min` string: Gets or sets the min. - `Max` string: Gets or sets the max. - `Step` string: Gets or sets the step. - `Helptip` string: Gets or sets the helptip. - `Type` 'textbox' | 'select' | 'size' | 'label' | 'stop' | 'datepicker' | 'timepicker': Gets or sets the type. - `Allow` 'numbers' | 'decimals' | 'all': Gets or sets the allow. - `ExpectedValue` string: Gets or sets the expected value. - `Options` string[]: Gets or sets the options. - `Required` boolean: Determines whether this field is required to fill or not - `Decisions` ServiceChannelServicesMessagingIssueListsDecisionModelResponse[] - `OptionValue` string: OptionValue - `NextQuestion` string: NextQuestion - `OriginalNextQuestion` string: Original NextQuestion - `TradeOverride` string: TradeOverride - `CategoryOverride` string: CategoryOverride - `PriorityOverride` string: PriorityOverride - `NTEOverride` string: NTEOverride - `ProviderRankOverride` string: ProviderRankOverride - `WoLabelOverride` string: WoLabelOverride - `EtcOverride` string: EtcOverride - `LinkToMedia` string - `DisableFilter` boolean: Gets a value indicating whether disable filter. - `IsNewIssueList` boolean - `WoStatusId` integer - `Note` string - `DashOverrideApplied` boolean - `Nte` string - `WoLabel` string - `AttachmentName` string - `PinWoNote` boolean - `EtcMinutes` integer - `ProjComplDate` string, date-time - `CategoryId` integer - `ContractService` string - `ContractServiceId` integer - `Providers` ServiceChannelServicesMessagingProvidersServiceRequestProvider[] - `Rank` integer: Rank - `Category` string: Category - `Priority` string: Priority - `Nte` number, double: Nte - `GeneralEmail` string: General Email - `IsDefault` boolean: Is Default - `ServiceRequestEmails` string: ServiceRequestEmails - `Phone` string - `FullName` string: Full Name - `Address1` string: Address1 - `Address2` string: Adress2 - `City` string: City - `State` string: State - `Zip` string: Zip - `Country` string: Country - `MainContact` string: Main Contact - `DateCreated` string, date-time: Date Created - `LastUserDate` string: Last User Date - `SuperUser` string: SuperUser - `WebSite` string: WebSite - `Email` string: Email - `TaxId` string: Tax Id - `Trade` string: Trade - `ProcessingEmail` string: Processing Email - `FaxNumber` string: Fax Number - `SuiteFloor` string: Suite Floor - `MailInfo` string: Mail Info - `ImageFile` string: Image File - `ReturnMail` string: Return Mail - `MailFrequency` integer: Mail Frequency - `FormId` integer: Form Id - `Pager` string: Pager - `NightRequest` integer: NightRequest - `ShortFormatEmail` string: Short Format Email - `LastTrainingDate` string, date-time: Last Training Date - `LastTrainingDateStr` string: Last Training Date as a string - `IsInternal` boolean: Is Internal - `IsOnOffShoreFeatureEnabled` boolean: Is OnOffShoreFeature Enabled - `Id` integer: Id - `Name` string: Name - `DoNotDispatch` boolean: DoNotDispatch enabled? - `ProvidersNotFoundMessage` string - `CallerName` string - `ScheduledDateOffsetFromCallDate` integer - `AssetsInfo` ServiceChannelServicesMessagingAssetsAssetsInfoResponse - `Assets` ServiceChannelServicesMessagingAssetsAssetResponse[] - `Id` integer: Unique numeric asset identifier assigned by the system. - `Tag` string: Alphanumeric asset identifier assigned by the client. - `Manufacturer` string: Company name that produces an asset. - `ModelNo` string: Asset model number. - `SerialNo` string: Asset serial number. - `LocationId` integer: Unique numeric identifier of a location an asset is assigned to. - `Area` string: Place where an asset is physically located. - `WorkOrderArea` string: Work order area, such as *Dining Room*, *Kitchen*, *Storage*. - `StoreId` string: Alphanumeric location identifier assigned by the client. - `Trade` string: Trade of an asset type the asset is assigned to, for example, *HVAC*, *DOORS*, *ELECTRICAL*. - `TradeId` integer: Numeric identifier of the primary trade of an asset. - `Type` string: Asset type, for example, *Refrigerator*, *Computer Monitor*, etc. - `AssetTypeId` integer: Unique numeric identifier of an asset type. - `BrandId` integer: Unique numeric identifier of a manufacturer that produces an asset. - `InstallDate` string: Date and time when an asset was installed at the current location. - `InstallDateVal` string, date-time: Date and time when an asset was installed at the current location. - `ManufacturerDate` string, date-time: Date and time when an asset was produced. - `ManufacturerDateStr` string: Date and time when an asset was produced by the manufacturer. - `PurchaseDate` string: Date and time when an asset was purchased. - `UsesRefrigerant` integer: Defines whether an asset uses a refrigerant. **Possible values**: 0 - no, 1 - yes. - `Active` boolean: Shows whether an asset is still in use. **Possible values**: *true*, *false*. - `IsLeased` boolean: Defines whether an asset is leased. **Possible values**: *true*, *false*. - `LifeExpectancy` integer: Estimated useful life of an asset in months. - `OriginalValue` number, double: Original asset price. - `LeaseDate` string: Date and time when a lease was signed. - `LeasePeriod` integer: Period of time in months a contracted lease is in place. - `Condition` integer: Value representation of an asset condition. **Possible values**: `0` - *broken*, `25` - *poor*, `50` - *average*, `75` - *good*, `100` - *excellent*. - `ConditionString` string: Current condition of an asset. **Possible values**: *broken*, *poor*, *average*, *good*, *excellent*. - `EnergyEfficiency` string: Provides information on energy efficiency of a particular asset. Maximum is 150 characters. - `Capacity` string: Provides information on the maximum amount of the refrigerant an asset can contain. Maximum is 150 characters. - `HasLeakDetector` boolean: Defines whether an asset has a leak detector and belongs to the Leak Detector asset type. **Possible values**: *true*, *false*. - `AssetLeakDetectorConnectionId` integer: ID of the leak detector that is connected to an asset. - `Location` string: Place where an asset is physically located. - `Warranty` ServiceChannelServicesMessagingAssetsWarranty: Object containing warranty parameters. - `ExpirationDate` string, date-time: Warranty expiration date based on the warranty expiration settings. - `ProviderId` integer: ID of a provider who is in charge of warranty services. - `NTE` number, double: Maximum amount of money to be spent on warranty services in USD. Value -1 means that the amount is not applicable. - `Priority` string: Defines how quickly warranty services should be provided, for example, *Emergency-4 Hours*, *Normal-48 Hours*, *7 Days*. - `PriorityId` integer - `Category` string: Warranty category, for example, *ADVISE ONLY*, *REPAIR*, *DISASTER*. - `CategoryId` integer - `Provider` ServiceChannelServicesMessagingAssetsWarrantyProvider: Object containing warranty provider details. - `Type` 'Fixed' | 'PrimaryRanked' | 'FixedRanked': Defines the provider type responsible for warranty services. **Possible values**: `0` - Fixed provider, `1`- Primary rank provider, `2` - Fixed rank provider. - `Value` integer: Provider type value. Displays provider ID for the fixed provider type; provider rank number — from 1 to 100 — for the fixed rank type; 1 for a primary rank provider. - `ProviderName` string: Name of the provider who is in charge of warranty services. - `Expiration` ServiceChannelServicesMessagingAssetsWarrantyExpiration: Object containing warranty expiration details. - `Type` 'FromPurchaseDate' | 'FromInstallDate': Warranty expiration calculation type. **Possible values**: 0 - the expiration date is calculated starting from the asset purchase data; 1 - the expiration date is calculated starting from the asset installation date. - `Period` integer: Warranty period in months. - `IsReplaceEquipment` boolean: Defines if the current asset is a replacement for another on condition that a tracking number is provided. **Possible values**: *true*, *false*. - `HasTagged` boolean: Defines if an asset contains ‘Asset Tag’. - `LastModifiedUseDate` string, date-time: Date and time when an asset was last updated. - `LastModifiedUserName` string: Name of the user who updated an asset. - `SubName` string: Subscriber’s name who added an asset. - `AssetRefrigerant` ServiceChannelServicesMessagingRefrigerantTrackingAssetRefrigerant - `Id` integer - `AssetId` integer - `RefrigerantUsageType` integer - `RackId` string - `RackEntityId` integer - `CarbID` string - `IsCarbReporting` boolean - `SystemLocation` string, byte - `OperationalStatus` string, byte - `RefrigerantPartNumber` string - `PartNumberId` integer - `RackTypeId` integer - `CurrentCharge` number, double - `CurrentChargeMetrics` number, double - `CurrentChargeOunces` number, double - `ChargeDescriptionId` integer - `ChargeProviderName` string - `EffectiveChargeDate` string, date-time - `RefrigerantChargeOptionId` integer - `RackTypeName` string - `UserId` integer - `TagId` string - `AssetTypeId` integer - `RefrigerantPurposeId` integer - `RefrigerantPurposeName` string - `ParentId` integer - `CreateOperationalStatusHistory` boolean - `OperationStatusDate` string, date-time - `HasLeakDetector` boolean - `AssetLeakDetectorId` integer - `InitialCharge` boolean - `RackType` string, byte - `NeedsRetrofitRetirement` boolean - `RequiresAutomaticLeakDetector` boolean - `ConnectedRackId` integer - `PreviousConnectedRackId` integer - `UpdatedDate` string, date-time - `AssetAttributesMap` ServiceChannelServicesMessagingAssetsAssetAttributesMap - `StandardAttributesMap` integer - `ViewableForProvidersAttributesMap` integer - `EditableForProvidersAttributesMap` integer - `RequiredStandardAttributesMap` integer - `AssetTag` string: Unique alphanumeric decoded value contained in a barcode, QR code, or NFC tag of an asset. It is used to scan assets via [ServiceChannel Mobile](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/575341308/Asset+Tagging#AssetTagging-AccessingtheAssetScanningModuleinSCMobile) and [ServiceChannel Provider](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/1181745372/Scanning+and+Validating+Assets+via+SC+Provider+for+FTM+Internal+Techs). - `ImportedFrom` integer: Provides the number of the template an asset was imported from. - `ParentId` integer: Unique numeric identification of an asset that has a circuit or component. - `Description` string: Comment created by a user when adding an asset. - `HasComponents` boolean: Defines whether an asset has components. **Possible values**: *true*, *false*. - `HasCircuits` boolean: Defines if an asset has an added circuit. **Possible values**: *true*, *false*. - `IsCircuit` boolean: Defines whether an asset is a circuit. **Possible values**: *true*, *false*. - `SubscriberId` integer: Unique numeric ID of the subscriber an asset belongs to. - `AssetValidated` boolean: Defines whether the asset has been validated by a technician. **Possible values**: *true*, *false*. - `ValidationRequired` boolean: Defines whether an asset needs to be validated by a technician upon check-in. - `IsLeakDetector` boolean: Defines whether an asset belongs to the *Leak Detector* asset type. - `AssetStatus` string, byte: Defines an asset repair status. **Possible values**: `0` - *In Use*, `1` - *Out For Repair*, `2` - *Replacement Recommended*, `3` - *Repaired*. - `AssetUpdatesStatus` string, byte: Defines the asset update status. **Possible values**: 0 - Attributes updated by provider, 1- New unconfirmed - asset created by provider, 2 - Rejected, 3 - Asset change confirmed. - `AdditionalTradesNames` string: Names of the additional trades for an asset type. - `AdditionalTradeIds` integer[] - `CreatedDate` string, date-time: Date and time of the asset creation. - `ModifiedDate` string, date-time: Date and time of the last asset update. - `AssetTypeGroupId` integer: Unique ID of an asset type group. - `Spend` number, double: Total asset cost. Can be calculated if the *IncludeTotalCostOfOwnership* feature flag is enabled. - `IsCarbReporting` boolean: Defines whether an asset is included in a CARB report. **Possible values**: *true*, *false*. - `AssetValidationStatus` integer - `UnableToScanReason` string: Asset tag not scanned reason - `UnableToScanReasonCustomText` string: Asset tag not scanned reason custom text - `UnableToScanReasonId` integer: Asset tag not scanned reason id - `CustomAttributes` ServiceChannelServicesMessagingEquipmentsEquipmentAttributeDescription[]: Custom Attributes - `EquipmentAttributeId` integer - `EquipmentTypeAttributeId` integer - `ValueType` integer - `EquipmentId` integer - `Value` SystemObject - `ValueText` string - `SelectedOptionsText` string - `Visible` boolean - `Editable` boolean - `Required` boolean - `Name` string - `Custom` boolean - `HasChilds` boolean - `Currency` integer - `ModifiedDateDto` string, date-time: ModifiedDate datetime offset - `RetiredDate` string, date-time: Date and time of the asset deactivation. - `AssetRequired` boolean - `AssetEntry` string - `SetupRequestConfirm` ServiceChannelServicesMessagingDashboardSettingsSetupRequestConfirmResponse - `ChangeableCategory` boolean - `ChangeablePriority` boolean - `ChangeablePrioritySetDefault` boolean - `ChangeableNte` boolean - `AllowChangeableCurrency` boolean - `ChangeableScheduledDate` boolean - `ChangeableProvider` boolean - `EnableAdditionalCodes` boolean - `ChangeableGlCode` boolean - `CreateLinkedRequest` boolean - `AvoidDispatching` boolean - `ShowRecipients` boolean - `AddCopyRecipient` boolean - `DeleteCopyRecipients` boolean - `EmptyProviderEmailNotification` boolean - `EnablePO` boolean - `RequirePO` boolean - `EnableWO` boolean - `EnableLabels` boolean - `LabelsAsSelectOnly` boolean - `EditWeatherType` boolean - `MaintainOrDecreasePriority` boolean - `DisplayAssignedTechnician` boolean - `ChangeableProjectedCompletionDate` boolean - `SetupRequest` ServiceChannelServicesMessagingDashboardSettingsSetupRequestResponse - `SetupId` integer: Store Dashboard Setup ID. - `EnableRequestWizard` boolean: This flag enables/disables request wizard for the dashboard. - `ShowPrivateStoreNotes` boolean: Show/hide private store notes in the 'location notes' field on the first step of the service request wizard page. - `ShowProviderPhoneNumber` boolean: Show/hide provider phone number on the confirmation step after an issue has been submitted. - `ShowLastServiceCall` boolean: Show last service call and last description in the body of alert email. - `SetOriginalVendorForRecalls` boolean: This option controls whether original vendor is assigned to the work order in case of a recall. - `NteToZeroForRecalls` boolean: Set NTE to zero if a new service request is marked as a recall. - `SendAlertToFM` boolean: This flag controls whether service request email will be sent to the facility managers or not. - `TurnOffDescription` boolean: Show/hide problem description field. - `DaysOfHistoryToDisplay` integer: How many days of work order history to display on the dublicates warning report. - `ShowStoreWarrantyStr` string: 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. - `StoreWarrantyMessage` string: A store warranty message to show on the first step of the request wizard page. - `ConfirmationMessage` string: This message is shown on the confirmation page after the user submits their request. - `ProviderNotFoundMessage` string: An error message to show when provider is not found for the specified issue choice. - `EnableEquipment` boolean: Show equipment - `DuplicateFilters` string[] - `ExcludedCategoriesOpenDup` string[] - `ExcludedCategoriesClosedDup` string[] - `ExcludedStatuses` string[] - `ExcludedTradesOpenDup` string[] - `EnableEquipmentReplacementFlag` boolean - `EnableRequestWizardMobile` boolean: This flag enables/disables request wizard for the SC Mobile. - `EnableLocationNotes` boolean - `AlwaysShowLocationNotes` boolean - `SkipTroubleshootingStep` boolean - `HidePriority` boolean - `EnableIssueListKeywordSearch` boolean: 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. - `HideGPSRadius` boolean - `AssetFirstWorkOrderCreation` boolean: Enables asset-first approach for work order creation. - `EnableEquipmentReplacement` boolean - `AssetNotListedFlag` boolean - `Categories` ServiceChannelServicesMessagingCategoryCategoryResponse[] - `Id` integer: Category ID. - `SubscriberId` integer: Unique numeric subscriber ID. - `Name` string: Category name. - `HasDependency` boolean: Parameter is not populated. The only value is "false". - `PrimaryCategoryID` integer: Primary category ID. - `PrimaryCategoryName` string: Primary category name. - `Priorities` ServiceChannelServicesMessagingPrioritiesPriorityResponse[] - `Id` integer: UID of priority. Can be null - `Name` string: Priority name - `SubscriberId` integer: UID of subscriber. Can be null - `Eta` string: ETA - `SkipNights` boolean: Skip nights while calculating scheduled date - `SkipWeekends` boolean: Skip weekends while calculating scheduled date - `LocationId` integer: If priority is associated with location - assiciated location - `Trade` string: If priority is associated with trade - assiciated trade - `ScheduledDate` string, date-time: Calculated WO Scheduled Date - `ScheduledDate_DTO` string, date-time: Calculated WO Scheduled Date with time zone offset - `ProjectComplDate` string, date-time - `IsSelectable` boolean: IsSelectable - `SetupGeneral` ServiceChannelServicesMessagingDashboardSettingsSetupGeneralResponse - `AllowAddingAttachments` boolean - `UserSettings` ServiceChannelServicesMessagingDashboardSettingsUserSettingsResponse - `MaximumNteAmount` number, double - `Currency` ServiceChannelServicesMessagingCurrenciesCurrency - `Id` integer - `AlphabeticalCode` string - `DecimalCount` integer - `Entity` string - `CurrencyName` string - `NumericCode` string - `Rate` number, double - `AreaId` integer - `TradeId` integer - `CategoryId` integer - `SetupId` integer - `EasierAssetAttachmentEnabled` boolean - `TradeExcluded` boolean ## Other responses - `400`: Bad Request - the request could not be understood or was missing required parameters.
Error codes:
917 - Invalid work order identifier. Returned if workorderId is <= 0; - `401`: Unauthorized indicates that the requested resource requires authentication.
Error codes:
504 - API call rejected by security permissions; --- [API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)