ServiceChannel ServiceRequest API
The ServiceRequest API from ServiceChannel — 10 operation(s) for servicerequest.
OpenAPI Specification
swagger: '2.0'
info:
version: bearer.v1
title: Fixxbook.Bearer.Api.V1 AfterHours ServiceRequest API
isOdataApi: false
relativePath: ''
discoveryPath: docs/bearer.v1
_isAuthorizedAccess: true
host: sb2fixxbook.servicechannel.com:443
basePath: /api
schemes:
- https
security:
- oauth2: []
tags:
- name: ServiceRequest
paths:
/servicerequest/providers:
get:
tags:
- ServiceRequest
summary: Get list of providers per service request
description: "Returns providers for specified location and trade or equipment. If no location, trade specified in request equipment values are used.\r\n <br /><br />Available for provider and subscriber usage."
operationId: GETv3_servicerequest_providers?locationId={locationId}&tradeId={tradeId}&trade={trade}&equipmentType={equipmentType}&providerRank={providerRank}&equipmentId={equipmentId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: locationId
in: query
description: Location Id
required: false
type: integer
format: int32
- name: tradeId
in: query
description: Trade Id
required: false
type: integer
format: int32
- name: trade
in: query
description: Trade
required: false
type: string
- name: equipmentType
in: query
description: Equipment type
required: false
type: string
- name: providerRank
in: query
description: Sets default provider with specified rank
required: false
type: integer
format: int32
- name: equipmentId
in: query
description: Sets default provider for specified equipment id
required: false
type: integer
format: int32
responses:
'200':
description: Request succeeded and the requested information is in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Providers.GetServiceRequestProvidersResponse'
'400':
description: Bad Request - the request could not be understood or was missing required parameters.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/subscribers/current/servicerequest/info:
get:
tags:
- ServiceRequest
summary: Get Service Request Info
description: "Retrieves supporting info for \"Create Work Order\" operation.\r\n <br /><br />This method can only be used for subscriber's users that have assigned dashboard."
operationId: GETv3_subscribers_current_servicerequest_info?AreaName={AreaName}&ProblemType={ProblemType}&EquipmentType={EquipmentType}&ProblemCode={ProblemCode}&LocationId={LocationId}&SetupId={SetupId}&CallDate={CallDate}&Version={Version}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: areaName
in: query
description: Name of the area
required: false
type: string
- name: problemType
in: query
description: Problem type
required: false
type: string
- name: equipmentType
in: query
description: Equipment type
required: false
type: string
- name: problemCode
in: query
description: Problem name
required: false
type: string
- name: locationId
in: query
description: ID of a location
required: false
type: integer
format: int32
- name: setupId
in: query
description: SetupId
required: false
type: integer
format: int32
- name: callDate
in: query
description: Call Date
required: false
type: string
format: date-time
- name: version
in: query
required: false
type: string
enum:
- Undefined
- V1
- V2
responses:
'200':
description: Request succeeded and the requested information is in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.GetServiceRequestInfoResponse'
'400':
description: "Bad Request - the request could not be understood or was missing required parameters.\r\n <br/>Error codes:\r\n <br/> 917 - Invalid work order identifier. Returned if workorderId is <= 0;"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Unauthorized indicates that the requested resource requires authentication.\r\n <br/>Error codes:\r\n <br/> 504 - API call rejected by security permissions;"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Subscribers
/subscribers/current/servicerequest/info/nosettings:
get:
tags:
- ServiceRequest
summary: Get Service Request Info Without Dashboard Settings
description: "Retrieves supporting info for \"Create Work Order\" operation.\r\n <br /><br />This method can only be used for subscriber's users that have assigned dashboard."
operationId: GETv3_subscribers_current_servicerequest_info_nosettings?AreaName={AreaName}&ProblemType={ProblemType}&EquipmentType={EquipmentType}&ProblemCode={ProblemCode}&LocationId={LocationId}&SetupId={SetupId}&CallDate={CallDate}&Version={Version}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: areaName
in: query
description: Name of the area
required: false
type: string
- name: problemType
in: query
description: Problem type
required: false
type: string
- name: equipmentType
in: query
description: Equipment type
required: false
type: string
- name: problemCode
in: query
description: Problem name
required: false
type: string
- name: locationId
in: query
description: ID of a location
required: false
type: integer
format: int32
- name: setupId
in: query
description: SetupId
required: false
type: integer
format: int32
- name: callDate
in: query
description: Call Date
required: false
type: string
format: date-time
- name: version
in: query
required: false
type: string
enum:
- Undefined
- V1
- V2
responses:
'200':
description: Request succeeded and the requested information is in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.GetServiceRequestInfoResponse'
'400':
description: "Bad Request - the request could not be understood or was missing required parameters.\r\n <br/>Error codes:\r\n <br/> 917 - Invalid work order identifier. Returned if workorderId is <= 0;"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Unauthorized indicates that the requested resource requires authentication.\r\n <br/>Error codes:\r\n <br/> 504 - API call rejected by security permissions;"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Subscribers
/subscribers/current/servicerequest/addresses:
get:
tags:
- ServiceRequest
summary: ''
operationId: GETv3_subscribers_current_servicerequest_addresses?SubscriberId={SubscriberId}&SetupId={SetupId}&LocationId={LocationId}&ProviderId={ProviderId}&Trade={Trade}&TradeId={TradeId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: subscriberId
in: query
required: true
type: integer
format: int32
- name: setupId
in: query
required: true
type: integer
format: int32
- name: locationId
in: query
required: true
type: integer
format: int32
- name: providerId
in: query
required: true
type: integer
format: int32
- name: trade
in: query
required: false
type: string
- name: tradeId
in: query
required: false
type: integer
format: int32
responses:
'200':
description: Indicates that the request succeeded and that the requested information is in the response.
'400':
description: "Bad Request - the request could not be understood or was missing required parameters.\r\n <br/>Error codes:\r\n <br/> 503 - Request data is empty;"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Indicates that the requested resource requires authentication.\r\n <br/>Error codes:\r\n <br/> 504 - API call rejected by security permissions;"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'404':
description: Indicates that the requested resource does not exist on the server.
deprecated: false
x-access: Any
/providers/current/subscribers/{subscriberId}/applicationissuechoice/servicerequest/info:
get:
tags:
- ServiceRequest
operationId: GETv3_providers_current_subscribers_{subscriberId}_applicationissuechoice_servicerequest_info?AreaName={AreaName}&ProblemType={ProblemType}&EquipmentType={EquipmentType}&ProblemCode={ProblemCode}&LocationId={LocationId}&SetupId={SetupId}&CallDate={CallDate}&Version={Version}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: subscriberId
in: path
required: true
type: integer
format: int32
- name: areaName
in: query
description: Name of the area
required: false
type: string
- name: problemType
in: query
description: Problem type
required: false
type: string
- name: equipmentType
in: query
description: Equipment type
required: false
type: string
- name: problemCode
in: query
description: Problem name
required: false
type: string
- name: locationId
in: query
description: ID of a location
required: false
type: integer
format: int32
- name: setupId
in: query
description: SetupId
required: false
type: integer
format: int32
- name: callDate
in: query
description: Call Date
required: false
type: string
format: date-time
- name: version
in: query
required: false
type: string
enum:
- Undefined
- V1
- V2
responses:
'200':
description: Request succeeded and the requested information is in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.GetServiceRequestInfoRequest'
'400':
description: Bad Request - the request could not be understood or was missing required parameters.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Unauthorized indicates that the requested resource requires authentication.\r\n <br/>Error codes:\r\n <br/> 504 - API call rejected by security permissions;"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Providers
/providers/current/subscriber/{subscriberId}/location/{locationId}/applicationissuechoice/servicerequest/info:
get:
tags:
- ServiceRequest
operationId: GETv3_providers_current_subscriber_{subscriberId}_location_{locationId}_applicationissuechoice_servicerequest_info
consumes: []
produces:
- application/json
- text/json
parameters:
- name: subscriberId
in: path
required: true
type: integer
format: int32
- name: locationId
in: path
required: true
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Providers
/subscribers/current/servicerequest/overrides/props:
post:
tags:
- ServiceRequest
summary: Get WorkOrder properties with overrides
operationId: POSTv3_subscribers_current_servicerequest_overrides_props
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: request
in: body
description: Properties request
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.GetWorkOrderPropertiesRequest'
responses:
'200':
description: WorkOrder properties with overrides are provided in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.RequestHandlers.WorkOrders.GetWorkOrderPropertiesWithOverridesResponse'
'400':
description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n <br/>Error codes:\r\n 503 - Bad Request - validation fails"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "The request is not authorized.\r\n <br/>Error codes:\r\n 504 - Missing or incorrect authentication credentials"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: "The server was unable to complete the request due to an internal error.\r\n <br/>Error codes:\r\n 501 - Unspecified internal server error occurred"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Subscribers
/providers/current/subscribers/{subscriberId}/servicerequest/overrides/props:
post:
tags:
- ServiceRequest
summary: Get WorkOrder properties with overrides
operationId: POSTv3_providers_current_subscribers_{subscriberId}_servicerequest_overrides_props
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: subscriberId
in: path
description: Subscriber Id
required: true
type: integer
format: int32
- name: request
in: body
description: Properties request
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.GetWorkOrderPropertiesRequest'
responses:
'200':
description: WorkOrder properties with overrides are provided in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.RequestHandlers.WorkOrders.GetWorkOrderPropertiesWithOverridesResponse'
'400':
description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n <br/>Error codes:\r\n 503 - Bad Request - validation fails"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "The request is not authorized.\r\n <br/>Error codes:\r\n 504 - Missing or incorrect authentication credentials"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: "The server was unable to complete the request due to an internal error.\r\n <br/>Error codes:\r\n 501 - Unspecified internal server error occurred"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Providers
/subscribers/current/servicerequest/duplicates/completed:
post:
tags:
- ServiceRequest
operationId: POSTv3_subscribers_current_servicerequest_duplicates_completed
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: request
in: body
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.Dashboard.Requests.GetWarningTicketsPagedRequest'
responses:
'200':
description: Completed duplicate work orders are provided in the response.
schema:
type: array
items:
$ref: '#/definitions/ServiceChannel.Api.Model.Dashboard.WorkOrderViewModel'
deprecated: false
x-access: Subscribers
/subscribers/current/servicerequest/duplicates/open:
post:
tags:
- ServiceRequest
operationId: POSTv3_subscribers_current_servicerequest_duplicates_open
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: request
in: body
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.Dashboard.Requests.GetWarningTicketsPagedRequest'
responses:
'200':
description: Open duplicate work orders are provided in the response.
schema:
type: array
items:
$ref: '#/definitions/ServiceChannel.Api.Model.Dashboard.WorkOrderViewModel'
deprecated: false
x-access: Subscribers
definitions:
ServiceChannel.Services.Messaging.RefrigerantTracking.AssetRefrigerant:
type: object
properties:
Id:
format: int32
type: integer
AssetId:
format: int32
type: integer
RefrigerantUsageType:
format: int32
type: integer
RackId:
type: string
RackEntityId:
format: int32
type: integer
CarbID:
type: string
IsCarbReporting:
default: false
type: boolean
SystemLocation:
format: byte
type: string
OperationalStatus:
format: byte
type: string
RefrigerantPartNumber:
type: string
PartNumberId:
format: int32
type: integer
RackTypeId:
format: int32
type: integer
CurrentCharge:
format: double
type: number
CurrentChargeMetrics:
format: double
type: number
CurrentChargeOunces:
format: double
type: number
ChargeDescriptionId:
format: int32
type: integer
ChargeProviderName:
type: string
EffectiveChargeDate:
format: date-time
type: string
RefrigerantChargeOptionId:
format: int32
type: integer
RackTypeName:
type: string
UserId:
format: int32
type: integer
TagId:
type: string
AssetTypeId:
format: int32
type: integer
RefrigerantPurposeId:
format: int32
type: integer
RefrigerantPurposeName:
type: string
ParentId:
format: int32
type: integer
CreateOperationalStatusHistory:
default: false
type: boolean
OperationStatusDate:
format: date-time
type: string
HasLeakDetector:
default: false
type: boolean
AssetLeakDetectorId:
format: int32
type: integer
InitialCharge:
default: false
type: boolean
RackType:
format: byte
type: string
NeedsRetrofitRetirement:
default: false
type: boolean
RequiresAutomaticLeakDetector:
default: false
type: boolean
ConnectedRackId:
format: int32
type: integer
PreviousConnectedRackId:
format: int32
type: integer
UpdatedDate:
format: date-time
type: string
ServiceChannel.Api.Model.Dashboard.WorkOrderFeedbackViewModel:
type: object
properties:
Id:
format: int32
type: integer
TrackingNumber:
format: int32
type: integer
RateStars:
format: int32
type: integer
Description:
type: string
CreatedDate:
type: string
UserName:
type: string
ReviewedUser:
type: string
IsSelfReviewed:
default: false
type: boolean
ServiceChannel.Services.Messaging.Workorders.GetServiceRequestInfoRequest:
type: object
properties:
AreaName:
description: Name of the area
type: string
ProblemType:
description: Problem type
type: string
EquipmentType:
description: Equipment type
type: string
ProblemCode:
description: Problem name
type: string
LocationId:
format: int32
description: ID of a location
type: integer
SetupId:
format: int32
description: SetupId
type: integer
CallDate:
format: date-time
description: Call Date
type: string
Version:
enum:
- Undefined
- V1
- V2
type: string
ServiceChannel.Services.Messaging.IssueLists.DecisionModelResponse:
description: Decision Model
type: object
properties:
OptionValue:
description: OptionValue
type: string
NextQuestion:
description: NextQuestion
type: string
OriginalNextQuestion:
description: Original NextQuestion
type: string
readOnly: true
TradeOverride:
description: TradeOverride
type: string
CategoryOverride:
description: CategoryOverride
type: string
PriorityOverride:
description: PriorityOverride
type: string
NTEOverride:
description: NTEOverride
type: string
ProviderRankOverride:
description: ProviderRankOverride
type: string
WoLabelOverride:
description: WoLabelOverride
type: string
EtcOverride:
description: EtcOverride
type: string
ServiceChannel.Services.Messaging.Assets.Warranty:
description: Object containing warranty parameters.
type: object
properties:
ExpirationDate:
format: date-time
description: Warranty expiration date based on the warranty expiration settings.
type: string
ProviderId:
format: int32
description: ID of a provider who is in charge of warranty services.
type: integer
NTE:
format: double
description: Maximum amount of money to be spent on warranty services in USD. Value -1 means that the amount is not applicable.
type: number
Priority:
description: Defines how quickly warranty services should be provided, for example, *Emergency-4 Hours*, *Normal-48 Hours*, *7 Days*.
type: string
PriorityId:
format: int32
type: integer
Category:
description: Warranty category, for example, *ADVISE ONLY*, *REPAIR*, *DISASTER*.
type: string
CategoryId:
format: int32
type: integer
Provider:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Assets.WarrantyProvider'
description: Rules to choose Warranty Provider
Expiration:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Assets.WarrantyExpiration'
description: Rules for Warranty Expiration
ServiceChannel.Api.Model.Workorders.OverrideProperties.Trade:
type: object
properties:
Id:
format: int32
type: integer
Name:
type: string
ServiceChannel.Services.Messaging.Providers.ServiceRequestProvider:
type: object
properties:
Rank:
format: int32
description: Rank
type: integer
Category:
description: Category
type: string
Priority:
description: Priority
type: string
Nte:
format: double
description: Nte
type: number
GeneralEmail:
description: General Email
type: string
IsDefault:
description: Is Default
default: false
type: boolean
ServiceRequestEmails:
description: ServiceRequestEmails
type: string
Phone:
type: string
FullName:
description: Full Name
type: string
Address1:
description: Address1
type: string
Address2:
description: Adress2
type: string
City:
description: City
type: string
State:
description: State
type: string
Zip:
description: Zip
type: string
Country:
description: Country
type: string
MainContact:
description: Main Contact
type: string
DateCreated:
format: date-time
description: Date Created
type: string
LastUserDate:
description: Last User Date
type: string
SuperUser:
description: SuperUser
type: string
WebSite:
description: WebSite
type: string
Email:
description: Email
type: string
TaxId:
description: Tax Id
type: string
Trade:
description: Trade
type: string
ProcessingEmail:
description: Processing Email
type: string
FaxNumber:
description: Fax Number
type: string
SuiteFloor:
description: Suite Floor
type: string
MailInfo:
description: Mail Info
type: string
ImageFile:
description: Image File
type: string
ReturnMail:
description: Return Mail
type: string
MailFrequency:
format: int32
description: Mail Frequency
type: integer
FormId:
format: int32
description: Form Id
type: integer
Pager:
description: Pager
type: string
NightRequest:
format: int32
description: NightRequest
type: integer
ShortFormatEmail:
description: Short Format Email
type: string
LastTrainingDate:
format: date-time
description: Last Training Date
type: string
LastTrainingDateStr:
description: Last Training Date as a string
type: string
IsInternal:
description: Is Internal
default: false
type: boolean
IsOnOffShoreFeatureEnabled:
description: Is OnOffShoreFeature Enabled
default: false
type: boolean
Id:
format: int32
description: Id
type: integer
Name:
description: Name
type: string
DoNotDispatch:
description: DoNotDispatch enabled?
default: false
type: boolean
ServiceChannel.Services.Messaging.Workorders.GetWorkOrderPropertiesRequest:
type: object
properties:
AreaName:
description: Name of the area
type: string
ProblemType:
description: Problem type
type: string
EquipmentType:
description: Equipment type
type: string
ProblemCode:
description: Problem name
type: string
LocationId:
format: int32
description: ID of a location
type: integer
SetupId:
format: int32
description: SetupId
type: integer
AssetId:
format: int32
description: Id of an Asset
type: integer
DecisionAnswers:
description: DescisionTree answers made by the user
type: array
items:
$ref: '#/definitions/DecisionAnswer'
CorrelationId:
description: Key to find the selected issue choice
type: string
ServiceChannel.Services.Messaging.DashboardSettings.SetupRequestResponse:
type: object
properties:
SetupId:
format: int32
description: Store Dashboard Setup ID.
type: integer
EnableRequestWizard:
description: This flag enables/disables request wizard for the dashboard.
default: false
type: boolean
ShowPrivateStoreNotes:
description: Show/hide private store notes in the 'location notes' field on the first step of the service request wizard page.
default: false
type: boolean
ShowProviderPhoneNumber:
description: Show/hide provider phone number on the confirmation step after an issue has been submitted.
default: false
type: boolean
ShowLastServiceCall:
description: Show last service call and last description in the body of alert email.
default: false
type: boolean
SetOriginalVendorForRecalls:
description: This option controls whether original vendor is assigned to the work order in case of a recall.
default: false
type: boolean
NteToZeroForRecalls:
description: Set NTE to zero if a new service request is marked as a recall.
default: false
type: boolean
SendAlertToFM:
description: This flag controls whether service request email will be sent to the facility managers or not.
default: false
type: boolean
TurnOffDescription:
description: Show/hide problem description field.
default: false
type: boolean
DaysOfHistoryToDisplay:
format: int32
description: How many days of work order history to display on the dublicates warning report.
type: integer
ShowStoreWarrantyStr:
description: "There are three possible options: 1) 'none' hides a StoreWarrantyMessage on the first step of the Request Wizard;\r\n 2) 'show' shows a StoreWarrantyMessage on the first step of the Request Wizard;\r\n 3) 'stop' shows a StoreWarrantyMessage without a possibility to move to the next step."
type: string
StoreWarrantyMessage:
description: A store warranty message to show on the first step of the request wizard page.
type: string
ConfirmationMessage:
description: This message is shown on the confirmation page after the user submits their request.
type: string
ProviderNotFoundMessage:
description: An error message to show when provider is not found for the specified issue choice.
type: string
EnableEquipment:
description: Show equipment
default: false
type: boolean
DuplicateFilters:
type: array
items:
type: string
ExcludedCategoriesOpenDup:
type: array
items:
type: string
ExcludedCategoriesClosedDup:
type: array
items:
type: string
ExcludedStatuses:
type: array
items:
type: string
ExcludedTradesOpenDup:
type: array
items:
type: string
EnableEquipmentReplacementFlag:
default: false
type: boolean
EnableRequestWizardMobile:
description: This flag enables/disables request wizard for the SC Mobile.
default: false
type: boolean
EnableLocationNotes:
default: false
type: boolean
AlwaysShowLocationNotes:
default: false
type: boolean
SkipTroubleshootingStep:
default: false
type: boolean
HidePriority:
default: false
# --- truncated at 32 KB (127 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/servicechannel/refs/heads/main/openapi/servicechannel-servicerequest-api-openapi.yml