ServiceChannel IssueList API
The IssueList API from ServiceChannel — 36 operation(s) for issuelist.
OpenAPI Specification
swagger: '2.0'
info:
version: bearer.v1
title: Fixxbook.Bearer.Api.V1 AfterHours IssueList API
isOdataApi: false
relativePath: ''
discoveryPath: docs/bearer.v1
_isAuthorizedAccess: true
host: sb2fixxbook.servicechannel.com:443
basePath: /api
schemes:
- https
security:
- oauth2: []
tags:
- name: IssueList
paths:
/api/subscribers/{subscriberId}/storedashboards/{dashboardId}/issuelist:
get:
tags:
- IssueList
summary: The get.
operationId: GETv3_api_subscribers_{subscriberId}_storedashboards_{dashboardId}_issuelist
consumes: []
produces:
- application/json
- text/json
parameters:
- name: subscriberId
in: path
description: The subscriber id.
required: true
type: integer
format: int32
- name: dashboardId
in: path
description: The dashboard id.
required: true
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Any
/api/subscribers/{subscriberId}/issuelists:
get:
tags:
- IssueList
summary: The post.
operationId: GETv3_api_subscribers_{subscriberId}_issuelists?keyword={keyword}&pageIndex={pageIndex}&pageSize={pageSize}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: subscriberId
in: path
description: The subscriber Id.
required: true
type: integer
format: int32
- name: keyword
in: query
required: false
type: string
- name: pageIndex
in: query
description: The page index.
required: false
type: integer
format: int32
- name: pageSize
in: query
description: The page size.
required: false
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Any
post:
tags:
- IssueList
summary: The post.
operationId: POSTv3_api_subscribers_{subscriberId}_issuelists
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: request
in: body
description: The request.
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.IssueLists.PostIssueListRequest'
- name: subscriberId
in: path
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Any
/api/subscribers/{subscriberId}/issuelists/history:
get:
tags:
- IssueList
summary: The get issue list history.
operationId: GETv3_api_subscribers_{subscriberId}_issuelists_history?pageIndex={pageIndex}&pageSize={pageSize}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: subscriberId
in: path
description: The subscriber id.
required: true
type: integer
format: int32
- name: pageIndex
in: query
description: The page index.
required: false
type: integer
format: int32
- name: pageSize
in: query
description: The page size.
required: false
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Any
/api/subscribers/{subscriberId}/storedashboards/{dashboardId}/issuelist/{issueListId}:
put:
tags:
- IssueList
summary: The set issue list for dashboard.
operationId: PUTv3_api_subscribers_{subscriberId}_storedashboards_{dashboardId}_issuelist_{issueListId}
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: request
in: body
description: The request.
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.IssueLists.SetIssueListForDashboardRequest'
- name: subscriberId
in: path
required: true
type: string
- name: dashboardId
in: path
required: true
type: string
- name: issueListId
in: path
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Any
/api/subscribers/{subscriberId}/storedashboards/{dashboardId}/issuelist/fields:
get:
tags:
- IssueList
summary: The get global fields.
operationId: GETv3_api_subscribers_{subscriberId}_storedashboards_{dashboardId}_issuelist_fields
consumes: []
produces:
- application/json
- text/json
parameters:
- name: subscriberId
in: path
description: The subscriber id.
required: true
type: integer
format: int32
- name: dashboardId
in: path
description: The dashboard id.
required: true
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Any
/issuelist/globalfields:
get:
tags:
- IssueList
summary: The get global fields. Authorized version of 'storedashboards/{dashboardId:int}/issuelist/fields'
operationId: GETv3_issuelist_globalfields?locationId={locationId}&subscriberId={subscriberId}&setupId={setupId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: locationId
in: query
required: false
type: integer
format: int32
- name: subscriberId
in: query
required: false
type: integer
format: int32
- name: setupId
in: query
required: false
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Subscribers
/providers/current/subscribers/{subscriberId}/applicationissuelist/globalfields:
get:
tags:
- IssueList
summary: The get global fields. Authorized version of 'storedashboards/{dashboardId:int}/issuelist/fields'
operationId: GETv3_providers_current_subscribers_{subscriberId}_applicationissuelist_globalfields?locationId={locationId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: subscriberId
in: path
description: The subscriber id is required.
required: true
type: integer
format: int32
- name: locationId
in: query
description: Numeric id of location.
required: false
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Providers
/api/subscribers/{subscriberId}/storedashboards/{dashboardId}/issuelist/areas/{areaId}/problemtypes:
get:
tags:
- IssueList
summary: The get problem types.
operationId: GETv3_api_subscribers_{subscriberId}_storedashboards_{dashboardId}_issuelist_areas_{areaId}_problemtypes
consumes: []
produces:
- application/json
- text/json
parameters:
- name: subscriberId
in: path
description: The subscriber id.
required: true
type: integer
format: int32
- name: dashboardId
in: path
description: The dashboard id.
required: true
type: integer
format: int32
- name: areaId
in: path
description: The area id.
required: true
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Any
/subscribers/current/storedashboards/current/issuelist/areas/{areaId}/problemtypes:
get:
tags:
- IssueList
summary: Get Problem types
description: List Problem types. Returns Problem types for successful request.
operationId: GETv3_subscribers_current_storedashboards_current_issuelist_areas_{areaId}_problemtypes?locationId={locationId}&setupId={setupId}&subscriberId={subscriberId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: areaId
in: path
description: Numeric id of the Location Area.
required: true
type: integer
format: int32
- name: locationId
in: query
description: Numeric id of location.
required: false
type: integer
format: int32
- name: setupId
in: query
description: Numeric id of the Store Dashboard setup.
required: false
type: integer
format: int32
- name: subscriberId
in: query
description: Numeric id of subscriber.
required: false
type: integer
format: int32
responses:
'200':
description: Indicates that the request succeeded and that the requested information is in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.IssueLists.GetProblemTypesResponse'
'400':
description: "Bad Request - the request could not be understood or was missing required parameters.\r\n <br/>Error codes:\r\n <br/> 1000 - Invalid setupId(dashboard) for current user;\r\n <br/> 1001 - No issue list is available, please load it through issue list converter;"
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/current/applicationissuelist/areas/{areaId}/problemtypes:
get:
tags:
- IssueList
summary: Get Problem types
description: List Problem types. Returns Problem types for successful request.
operationId: GETv3_providers_current_applicationissuelist_areas_{areaId}_problemtypes?locationId={locationId}&setupId={setupId}&subscriberId={subscriberId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: areaId
in: path
description: Numeric id of the Location Area.
required: true
type: integer
format: int32
- name: locationId
in: query
description: Numeric id of location.
required: false
type: integer
format: int32
- name: setupId
in: query
description: Numeric id of the Store Dashboard setup.
required: false
type: integer
format: int32
- name: subscriberId
in: query
description: Numeric id of subscriber.
required: false
type: integer
format: int32
responses:
'200':
description: Indicates that the request succeeded and that the requested information is in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.IssueLists.GetProblemTypesResponse'
'400':
description: "Bad Request - the request could not be understood or was missing required parameters.\r\n <br/>Error codes:\r\n <br/> 1000 - Invalid setupId(dashboard) for current user;\r\n <br/> 1001 - No issue list is available, please load it through issue list converter;"
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
/issuelist/problemtypes:
get:
tags:
- IssueList
summary: Get Problem types
description: List Problem types. Returns Problem types for successful request.
operationId: GETv3_issuelist_problemtypes?areaId={areaId}&locationId={locationId}&setupId={setupId}&subscriberId={subscriberId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: areaId
in: query
description: Numeric id of the Location Area.
required: true
type: integer
format: int32
- name: locationId
in: query
description: Numeric id of location.
required: false
type: integer
format: int32
- name: setupId
in: query
description: Numeric id of the Store Dashboard setup.
required: false
type: integer
format: int32
- name: subscriberId
in: query
description: Numeric id of subscriber.
required: false
type: integer
format: int32
responses:
'200':
description: Indicates that the request succeeded and that the requested information is in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.IssueLists.GetProblemTypesResponse'
'400':
description: "Bad Request - the request could not be understood or was missing required parameters.\r\n <br/>Error codes:\r\n <br/> 1000 - Invalid setupId(dashboard) for current user;\r\n <br/> 1001 - No issue list is available, please load it through issue list converter;"
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
/api/subscribers/{subscriberId}/storedashboards/{dashboardId}/issuelist/areas/{areaId}/items:
get:
tags:
- IssueList
summary: The get items filtered by area type and location.
operationId: GETv3_api_subscribers_{subscriberId}_storedashboards_{dashboardId}_issuelist_areas_{areaId}_items?problemType={problemType}&locationId={locationId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: subscriberId
in: path
description: The subsriber id.
required: true
type: integer
format: int32
- name: dashboardId
in: path
description: The dashboard id.
required: true
type: integer
format: int32
- name: areaId
in: path
description: The area Id.
required: true
type: integer
format: int32
- name: problemType
in: query
description: The problem type.
required: true
type: string
- name: locationId
in: query
description: The location id.
required: true
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Any
/api/subscribers/{subscriberId}/issuelist/headers:
get:
tags:
- IssueList
operationId: GETv3_api_subscribers_{subscriberId}_issuelist_headers
consumes: []
produces:
- application/json
- text/json
parameters:
- name: subscriberId
in: path
required: true
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Any
/api/subscribers/{subscriberId}/storedashboards/{dashboardId}/issuelist/areas/{areaId}/problems:
get:
tags:
- IssueList
summary: The get problems filtered by area type and location.
operationId: GETv3_api_subscribers_{subscriberId}_storedashboards_{dashboardId}_issuelist_areas_{areaId}_problems?problemType={problemType}&item={item}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: subscriberId
in: path
description: The subsriber id.
required: true
type: integer
format: int32
- name: dashboardId
in: path
description: The dashboard id.
required: true
type: integer
format: int32
- name: areaId
in: path
description: The area id.
required: true
type: integer
format: int32
- name: problemType
in: query
description: The problem type.
required: true
type: string
- name: item
in: query
description: The item.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Any
/api/subscribers/{subscriberId}/storedashboards/{dashboardId}/issuelist/issuechoice:
get:
tags:
- IssueList
summary: The get issue choice.
operationId: GETv3_api_subscribers_{subscriberId}_storedashboards_{dashboardId}_issuelist_issuechoice
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: request
in: body
description: Get Issue Choice request
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.IssueLists.GetIssueChoiceRequest'
- name: subscriberId
in: path
required: true
type: string
- name: dashboardId
in: path
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Any
post:
tags:
- IssueList
summary: Find issue choice.
operationId: POSTv3_api_subscribers_{subscriberId}_storedashboards_{dashboardId}_issuelist_issuechoice
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: request
in: body
description: Get Issue Choice request
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.IssueLists.GetIssueChoiceRequest'
- name: subscriberId
in: path
required: true
type: string
- name: dashboardId
in: path
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Any
/subscribers/current/storedashboards/current/issuelist/issuechoice:
get:
tags:
- IssueList
operationId: GETv3_subscribers_current_storedashboards_current_issuelist_issuechoice?problemType={problemType}&equipmentType={equipmentType}&problemCode={problemCode}&locationId={locationId}&setupId={setupId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: problemType
in: query
required: true
type: string
- name: equipmentType
in: query
required: true
type: string
- name: problemCode
in: query
required: true
type: string
- name: locationId
in: query
required: true
type: integer
format: int32
- name: setupId
in: query
required: false
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Subscribers
/issuelist/issuechoice:
get:
tags:
- IssueList
operationId: GETv3_issuelist_issuechoice?problemType={problemType}&equipmentType={equipmentType}&problemCode={problemCode}&locationId={locationId}&setupId={setupId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: problemType
in: query
required: true
type: string
- name: equipmentType
in: query
required: true
type: string
- name: problemCode
in: query
required: true
type: string
- name: locationId
in: query
required: true
type: integer
format: int32
- name: setupId
in: query
required: false
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Subscribers
/subscribers/current/storedashboards/current/issuelist/specific/issuechoice:
get:
tags:
- IssueList
summary: Get specific issue choice
operationId: GETv3_subscribers_current_storedashboards_current_issuelist_specific_issuechoice?SubscriberId={SubscriberId}&DashboardSetupId={DashboardSetupId}&Trade={Trade}&Priority={Priority}&Category={Category}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: subscriberId
in: query
required: true
type: integer
format: int32
- name: dashboardSetupId
in: query
required: true
type: integer
format: int32
- name: trade
in: query
required: true
type: string
- name: priority
in: query
required: true
type: string
- name: category
in: query
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Any
/api/subscribers/{subscriberId}/storedashboards/{dashboardId}/issuelist/issuechoice/fields:
get:
tags:
- IssueList
summary: The get issue choice fiels.
operationId: GETv3_api_subscribers_{subscriberId}_storedashboards_{dashboardId}_issuelist_issuechoice_fields?problemType={problemType}&item={item}&problem={problem}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: subscriberId
in: path
description: The subscriber id.
required: true
type: integer
format: int32
- name: dashboardId
in: path
description: The dashboard id.
required: true
type: integer
format: int32
- name: problemType
in: query
description: The problem type.
required: true
type: string
- name: item
in: query
description: The item.
required: true
type: string
- name: problem
in: query
description: The problem.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Any
/subscribers/current/storedashboards/current/issuelist/areas:
get:
tags:
- IssueList
summary: Get Areas
description: "List Issue Areas. Returns Issue Areas for successful request.\r\n <br /><br />Available for subscriber usage."
operationId: GETv3_subscribers_current_storedashboards_current_issuelist_areas?locationId={locationId}&setupId={setupId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: locationId
in: query
description: selected locationId.
required: false
type: integer
format: int32
- name: setupId
in: query
description: Numeric id of the Store Dashboard setup.
required: false
type: integer
format: int32
responses:
'200':
description: Indicates that the request succeeded and that the requested information is in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.IssueLists.GetIssueAreasResponse'
'400':
description: "Bad Request - the request could not be understood or was missing required parameters.\r\n <br/>Error codes:\r\n <br/> 1000 - Invalid setupId(dashboard) for current user;"
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'
'500':
description: Indicates that a generic error has occurred on the server.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Subscribers
/issuelist/areas:
get:
tags:
- IssueList
summary: Get Areas
description: "List Issue Areas. Returns Issue Areas for successful request.\r\n <br /><br />Available for subscriber usage."
operationId: GETv3_issuelist_areas?locationId={locationId}&setupId={setupId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: locationId
in: query
description: selected locationId.
required: false
type: integer
format: int32
- name: setupId
in: query
description: Numeric id of the Store Dashboard setup.
required: false
type: integer
format: int32
responses:
'200':
description: Indicates that the request succeeded and that the requested information is in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.IssueLists.GetIssueAreasResponse'
'400':
description: "Bad Request - the request could not be understood or was missing required parameters.\r\n <br/>Error codes:\r\n <br/> 1000 - Invalid setupId(dashboard) for current user;"
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'
'500':
description: Indicates that a generic error has occurred on the server.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Subscribers
/providers/current/subscribers/{subscriberId}/applicationissuelist/areas:
get:
tags:
- IssueList
summary: Get Areas
description: "List Issue Areas. Returns Issue Areas for successful request.\r\n <br /><br />Available for provider usage."
operationId: GETv3_providers_current_subscribers_{subscriberId}_applicationissuelist_areas?locationId={locationId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: subscriberId
in: path
description: The subscriber id is required.
required: true
type: integer
format: int32
- name: locationId
in: query
description: Numeric id of location.
required: false
type: integer
format: int32
responses:
'200':
description: Indicates that the request succeeded and that the requested information is in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.IssueLists.GetIssueAreasResponse'
'400':
description: "Bad Request - the request could not be understood or was missing required parameters.\r\n <br/>Error codes:\r\n <br/> 1000 - Invalid setupId(dashboard) for current user;"
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'
'500':
description: Indicates that a generic error has occurred on the server.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Providers
/providers/current/subscriber/{subscriberId}/location/{locationId}/applicationissuelist/problemtypes:
get:
tags:
- IssueList
operationId: GETv3_providers_current_subscriber_{subscriberId}_location_{locationId}_applicationissuelist_problemtypes
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/storedashboards/current/issuelist/areas/{areaId}/equipmenttypes:
get:
tags:
- IssueList
summary: Get Equipment items
description: "List equipment items.\r\n <br /><br />Available for subscriber usage."
operationId: GETv3_subscribers_current_storedashboards_current_issuelist_areas_{areaId}_equipmenttypes?locationId={locationId}&problemType={problemType}&setupId={setupId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: locationId
in: query
description: Numeric id of the Location.
required: true
type: integer
format: int32
- name: areaId
in: path
description: Numeric id of the Location Area.
required: true
type: integer
format: int32
- name: problemType
in: query
description: Problem type.
required: true
type: string
- name: setupId
in: query
description: Numeric id of the Store Dashboard setup.
required: false
type: integer
format: int32
responses:
'200':
description: Indicates that the request succeeded and that the requested information is in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.IssueLists.GetIssueEquipmentTypesResponse'
'400':
description: "Bad Request - the request could not be understood or was missing required parameters.\r\n <br/>Erro
# --- truncated at 32 KB (116 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/servicechannel/refs/heads/main/openapi/servicechannel-issuelist-api-openapi.yml