ServiceChannel Providers API
The Providers API from ServiceChannel — 15 operation(s) for providers.
OpenAPI Specification
swagger: '2.0'
info:
version: bearer.v1
title: Fixxbook.Bearer.Api.V1 AfterHours Providers API
isOdataApi: false
relativePath: ''
discoveryPath: docs/bearer.v1
_isAuthorizedAccess: true
host: sb2fixxbook.servicechannel.com:443
basePath: /api
schemes:
- https
security:
- oauth2: []
tags:
- name: Providers
paths:
/providers/ProviderData:
put:
tags:
- Providers
operationId: Providers_ProviderData
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: model
in: body
required: true
schema:
$ref: '#/definitions/UpdateProviderDataModel'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Object'
deprecated: false
x-access: Subscribers
/providers/subscribers:
get:
tags:
- Providers
summary: Retrieve the list of subscribers
description: Returns the names and IDs of subscribers whose private network the provider is in.
operationId: Providers_Subscribers
consumes: []
produces:
- application/json
- text/json
parameters:
- name: providerId
in: query
description: Unique numeric identifier of the provider.
required: true
type: integer
format: int32
responses:
'200':
description: The list of subscribers is in the response.
schema:
$ref: '#/definitions/SubscriberApiModel'
'400':
description: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.
'401':
description: The requested resource requires authentication.
'500':
description: Something went wrong, and the server was unable to complete your request.
deprecated: false
x-access: Providers
/api/providers/info/{id}:
get:
tags:
- Providers
operationId: GETv3_api_providers_info_{id}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: id
in: path
required: true
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Subscribers
/providers/RemoveProviderSubscriberLink:
post:
tags:
- Providers
summary: Delete provider of subscriber
description: Delete provider of subscriber.
operationId: POSTv3_providers_RemoveProviderSubscriberLink
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: request
in: body
description: ''
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Providers.RemoveProviderSubscriberLinkRequest'
responses:
'200':
description: Request succeeded and the requested information is in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Providers.CreateBlankProviderResponse'
'400':
description: "Bad Request - the request could not be understood or was missing required parameters.\r\n <br/>Error codes:\r\n <br/> 100 - Invalid provider id passed;\r\n <br/> 400 - Invalid subscriber id passed;\r\n <br/> 503 - Empty Request;\r\n <br/> 500 - Provider subscriber link has not been deleted;\r\n <br/> 1217 - Proccess provider subscriber link error text;"
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: Any
/providers:
post:
tags:
- Providers
summary: Create blank provider
description: Create blank provider.
operationId: POSTv3_providers
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: request
in: body
description: ''
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Providers.CreateBlankProviderRequest'
responses:
'200':
description: Request succeeded and the requested information is in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Providers.CreateBlankProviderResponse'
'400':
description: "Bad Request - the request could not be understood or was missing required parameters.\r\n <br/>Error codes:\r\n <br/> 103 - Provider already exists;\r\n <br/> 802 - Invalid user name;\r\n <br/> 806 - User already exists;\r\n <br/> 1150 - User does not exist;"
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: Any
/providers/current/problemtypes:
get:
tags:
- Providers
operationId: GETv3_providers_current_problemtypes?subscriberId={subscriberId}&dashboardId={dashboardId}&locationId={locationId}&areaId={areaId}&trade={trade}&problemType={problemType}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: subscriberId
in: query
required: true
type: integer
format: int32
- name: dashboardId
in: query
required: true
type: integer
format: int32
- name: locationId
in: query
required: true
type: integer
format: int32
- name: areaId
in: query
required: true
type: integer
format: int32
- name: trade
in: query
required: true
type: string
- name: problemType
in: query
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Any
/providers/getbytrade:
get:
tags:
- Providers
summary: Providers For Subscriber User by Trade
description: List of Providers.
operationId: GETv3_providers_getbytrade?trade={trade}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: trade
in: query
required: true
type: string
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Providers.ProviderInfo'
deprecated: false
x-access: Subscribers
/providers/getbytradeid:
get:
tags:
- Providers
summary: Providers For Subscriber User by Trade
description: List of Providers.
operationId: GETv3_providers_getbytradeid?tradeId={tradeId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: tradeId
in: query
required: true
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ServiceChannel.Services.WebApi.Models.Response.Providers.GetProvidersByTradeIdResponse'
deprecated: false
x-access: Subscribers
/providers/{providerId}/feedback:
post:
tags:
- Providers
operationId: POSTv3_providers_{providerId}_feedback
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: providerId
in: path
required: true
type: integer
format: int32
- name: request
in: body
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Providers.ProviderFeedbackRequest'
responses:
'200':
description: Indicates that the request succeeded and that the requested information is in the response.
schema:
$ref: '#/definitions/System.Object'
'400':
description: Bad Request - the request could not be understood or was missing required parameters.
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'
deprecated: false
x-access: Any
/providers/updateDispatchSetting:
post:
tags:
- Providers
summary: Set isDoNotDispatch value for providers
operationId: POSTv3_providers_updateDispatchSetting
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: updateDispatchSettingModel
in: body
description: ''
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.WebApi.Models.UpdateDispatchSettingModel'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Any
/api/providers/IsSdiMobileEnabled:
get:
tags:
- Providers
summary: Allows one to get information whether the SDIMobileInt flag is enabled.
description: "True - if the FF is enabled for a provider and subscriber or for a provider and location.\r\n Otherwise it returns false."
operationId: GETv3_api_providers_IsSdiMobileEnabled?subscriberId={subscriberId}&locationId={locationId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: subscriberId
in: query
description: Subscriber id
required: false
type: integer
format: int32
- name: locationId
in: query
description: Location id
required: false
type: integer
format: int32
responses:
'200':
description: The request succeeded and the information is retrieved.
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Providers
/providers/GetProvidersRankingStatus:
post:
tags:
- Providers
summary: Returns provider ranks for specified Fixxbook primary trade and locations
operationId: POSTv3_providers_GetProvidersRankingStatus
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: request
in: body
description: ''
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Providers.GetProvidersRankingStatusRequest'
responses:
'200':
description: The request succeeded and the information is retrieved.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Providers.GetProvidersRankingStatusRequest'
'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: Subscribers
/odata/locations({locationId})/providers/Service.GetRecent(days={days}):
get:
tags:
- Providers
summary: "Get recent providers for the given location.\r\n \"Recent\" means a provider has completed WOs for a certain time."
operationId: Providers_GetRecent
consumes:
- application/json
produces:
- application/json
parameters:
- name: days
in: path
required: true
type: integer
format: int32
default: 30
- name: locationId
in: path
required: true
type: integer
format: int32
- name: $expand
in: query
description: Expand a navigation property.
required: false
type: string
- name: $select
in: query
description: Select a set of properties to return.
required: false
type: string
- name: $filter
in: query
description: Filter a collection of resources addressed by a request URL.
required: false
type: string
- name: $orderby
in: query
description: Order resources by the specified property in the response.
required: false
type: string
- name: $top
in: query
description: Return the specified number of items in the response.
required: false
type: integer
- name: $skip
in: query
description: Skip the specified number of items in the response.
required: false
type: integer
- name: $count
in: query
description: Include the count of the matching resources in the response.
required: false
type: boolean
responses:
'200':
description: The request succeeded and providers are returned.
schema:
type: array
items:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Providers.ReviewedProvider'
'400':
description: The request parameters are not valid.
'401':
description: An unauthorized request.
'403':
description: Providers cannot use this method.
'404':
description: The location wasn't found.
'500':
description: Something went wrong.
deprecated: false
x-access: Any
/odata/detailedProviders/Service.Get(providerId={providerId}):
get:
tags:
- Providers
summary: Get provider by provider id.
operationId: Providers_GetProvider
consumes:
- application/json
produces:
- application/json
parameters:
- name: providerId
in: path
required: true
type: integer
format: int32
- name: $expand
in: query
description: Expand a navigation property.
required: false
type: string
- name: $select
in: query
description: Select a set of properties to return.
required: false
type: string
- name: $filter
in: query
description: Filter a collection of resources addressed by a request URL.
required: false
type: string
- name: $orderby
in: query
description: Order resources by the specified property in the response.
required: false
type: string
- name: $top
in: query
description: Return the specified number of items in the response.
required: false
type: integer
- name: $skip
in: query
description: Skip the specified number of items in the response.
required: false
type: integer
- name: $count
in: query
description: Include the count of the matching resources in the response.
required: false
type: boolean
responses:
'200':
description: The request succeeded and the provider is returned.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Providers.DetailedProvider'
'401':
description: Unauthorized request.
'403':
description: Providers cannot use this method.
'404':
description: The provider wasn't found.
'500':
description: Something went wrong.
deprecated: false
x-access: Any
/odata/locations({locationId})/providers/Service.GetLast(days={days}):
get:
tags:
- Providers
summary: Retrieve providers feedback rating data.
operationId: Providers_GetLast
consumes:
- application/json
produces:
- application/json
parameters:
- name: days
in: path
required: true
type: integer
format: int32
default: 30
- name: locationId
in: path
required: true
type: integer
format: int32
- name: $expand
in: query
description: Expand a navigation property.
required: false
type: string
- name: $select
in: query
description: Select a set of properties to return.
required: false
type: string
- name: $filter
in: query
description: Filter a collection of resources addressed by a request URL.
required: false
type: string
- name: $orderby
in: query
description: Order resources by the specified property in the response.
required: false
type: string
- name: $top
in: query
description: Return the specified number of items in the response.
required: false
type: integer
- name: $skip
in: query
description: Skip the specified number of items in the response.
required: false
type: integer
- name: $count
in: query
description: Include the count of the matching resources in the response.
required: false
type: boolean
responses:
'200':
description: The request succeeded and providers are returned.
schema:
type: array
items:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Providers.ExtendedReviewedProvider'
'400':
description: The request parameters are not valid.
'401':
description: An unauthorized request.
'403':
description: Providers cannot use this method.
'404':
description: The location wasn't found.
'500':
description: Something went wrong.
deprecated: false
x-access: Any
definitions:
PaymentTermsModel:
type: object
properties:
Period:
format: int32
type: integer
Description:
maxLength: 50
minLength: 0
type: string
ServiceChannel.Services.Messaging.Providers.DetailedProvider:
description: Provider with detailed information according to the current subscriber.
type: object
properties:
Contracts:
description: Contracts provider working at for the current subscriber.
type: array
items:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Contracts.Contract'
ReviewsInfo:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Feedback.ReviewsInfo'
description: Provider reviews information.
MyProviderReview:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Feedback.UserReview'
description: My review for the current provider.
ContactEmail:
description: Provider Contact email.
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.Providers.Provider:
type: object
properties:
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.WebApi.Models.UpdateDispatchSettingModel:
description: The model for update isDoNotDispatch value for providers.
type: object
properties:
SubscriberId:
format: int32
description: "The id of a calling subscriber.\r\n This id is the one who sets isDoNotDispatch value or is an aggregator of other subscribers.\r\n If it is the aggregator then subscriberId and subscriberIds from SubscriberProviders pairs do not match."
type: integer
DoNotDispatch:
description: The flag to set isDoNotDispatch value for providers.
default: false
type: boolean
SubscriberIdProviderIds:
description: The list of pairs subscriber and providers to set isDoNotDispatch value.
type: array
items:
$ref: '#/definitions/ServiceChannel.Services.WebApi.Models.SubscriberIdProviderIdsPair'
AddressInformationModel:
type: object
properties:
Address1:
maxLength: 50
minLength: 0
type: string
Address2:
maxLength: 50
minLength: 0
type: string
City:
maxLength: 50
minLength: 0
type: string
Country:
maxLength: 50
minLength: 0
type: string
State:
maxLength: 100
minLength: 0
type: string
PostalCode:
maxLength: 10
minLength: 0
type: string
ServiceChannel.Services.Messaging.Providers.ExtendedReviewedProvider:
description: A provider entity with common reviews information
type: object
properties:
ReviewsInfo:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Feedback.ReviewsInfo'
description: Stores common provider reviews information.
MyProviderReview:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Feedback.UserReview'
description: Whether the provider has the current user review or not.
AnyMyReviews:
description: Whether the provider has any reviews with current user
default: false
type: boolean
Trades:
description: Trades which the provider serves for the current subscriber.
type: array
items:
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.WebApi.Models.Response.Providers.GetProvidersByTradeIdResponseItem:
type: object
properties:
Id:
format: int32
type: integer
readOnly: true
Name:
type: string
readOnly: true
DoNotDispatch:
default: false
type: boolean
readOnly: true
ServiceChannel.Services.Messaging.Users.MlpUserInfo:
type: object
properties:
Id:
format: int32
type: integer
MlpLevel:
type: string
MlpLocations:
type: array
items:
format: int32
type: integer
ServiceChannel.Services.Messaging.Users.AccessOptions:
description: Object listing locations, districts, regions, and trades a subscriber user has access to. Learn more about [granting access based on locations, districts, and regions](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/585107276/Location+District+Region+Access+Tab) in ServiceChannel University.
type: object
properties:
Locations:
description: Locations a user has access to.
type: array
items:
type: string
Districts:
description: Districts a user has access to.
type: array
items:
type: string
Regions:
description: Regions a user has access to.
type: array
items:
type: string
Trades:
description: Trades a user is permitted to work with.
type: array
items:
type: string
ServiceChannel.Services.Messaging.Providers.RemoveProviderSubscriberLinkRequest:
type: object
properties:
ProviderId:
format: int32
type: integer
SubscriberId:
format: int32
type: integer
ServiceChannel.Services.Messaging.Providers.ProviderInfo:
type: object
properties:
Id:
format: int32
description: Id
type: integer
Name:
description: Name
type: string
DoNotDispatch:
description: DoNotDispatch enabled?
default: false
type: boolean
ServiceChannel.Services.Messaging.Users.User:
description: User details object.
type: object
properties:
Id:
format: int32
description: Unique user identifier.
type: integer
SubscriberId:
format: int32
description: Unique subscriber ID.
type: integer
UserName:
description: Userna
# --- truncated at 32 KB (116 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/servicechannel/refs/heads/main/openapi/servicechannel-providers-api-openapi.yml