0
No votes yet
HelpDesk Services for External incoming requests
Endpoints url
discount sandbox
https://mtls-api-nonprod.discountbank.co.il/devapi/cert
discount prod
https://mtls-api.discountbank.co.il/prod/d
mercantile sandbox
https://mtls-api-nonprod.mercantile.co.il/devapi/cert
mercantile prod
https://mtls-api.mercantile.co.il/prod/d
production
development
https://mtls-api.discountbank.co.il/prod/d
Paths
/callRequest
post /callRequest
CreateCallRequest
Oauth 2.1 B2B
Oauth 2.1 B2B
(oauth2 application)
B2B Authorization
Token URL
https://$(api.endpoint.hostname)/$(api.org.name)/$(env.path)/b2b/token
Scopes
B2B_infra
body
Optional in body
object
Authorization
Optional in header
string
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
201
Example Request
Example Response
POST https://mtls-api.discountbank.co.il/prod/d/HelpDeskServices/callRequest
Try this operation
No response. This is a mixed content call. It is not possible to test HTTP APIs from an HTTPS secured Portal site and vice versa.
No response. This is a cross-origin call. Make sure the server accepts requests from this portal. Or if using self-signed SSL certificates then paste the URL above into your browser to accept the certificate before trying again (On Internet Explorer it must be the same browser tab.).
/changeRequest
post /changeRequest
CreateChangeRequest
Oauth 2.1 B2B
Oauth 2.1 B2B
(oauth2 application)
B2B Authorization
Token URL
https://$(api.endpoint.hostname)/$(api.org.name)/$(env.path)/b2b/token
Scopes
B2B_infra
body
Optional in body
object
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
201
Example Request
Example Response
POST https://mtls-api.discountbank.co.il/prod/d/HelpDeskServices/changeRequest
Try this operation
No response. This is a mixed content call. It is not possible to test HTTP APIs from an HTTPS secured Portal site and vice versa.
No response. This is a cross-origin call. Make sure the server accepts requests from this portal. Or if using self-signed SSL certificates then paste the URL above into your browser to accept the certificate before trying again (On Internet Explorer it must be the same browser tab.).
/callRequest/{callRequestID}
get /callRequest/{callRequestID}
GetCallRequest
Oauth 2.1 B2B
Oauth 2.1 B2B
(oauth2 application)
B2B Authorization
Token URL
https://$(api.endpoint.hostname)/$(api.org.name)/$(env.path)/b2b/token
Scopes
B2B_infra
callRequestID
Required in path
string
מזהה פנייה
{
"maxLength": 20
}
Accept
Optional in header
string
application/json
200
Example Request
Example Response
GET https://mtls-api.discountbank.co.il/prod/d/HelpDeskServices/callRequest/{callRequestID}
Try this operation
No response. This is a mixed content call. It is not possible to test HTTP APIs from an HTTPS secured Portal site and vice versa.
No response. This is a cross-origin call. Make sure the server accepts requests from this portal. Or if using self-signed SSL certificates then paste the URL above into your browser to accept the certificate before trying again (On Internet Explorer it must be the same browser tab.).
put /callRequest/{callRequestID}
UpdateCallRequest
Oauth 2.1 B2B
Oauth 2.1 B2B
(oauth2 application)
B2B Authorization
Token URL
https://$(api.endpoint.hostname)/$(api.org.name)/$(env.path)/b2b/token
Scopes
B2B_infra
callRequestID
Required in path
string
מזהה פנייה
body
Optional in body
object
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
Example Request
Example Response
PUT https://mtls-api.discountbank.co.il/prod/d/HelpDeskServices/callRequest/{callRequestID}
Try this operation
No response. This is a mixed content call. It is not possible to test HTTP APIs from an HTTPS secured Portal site and vice versa.
No response. This is a cross-origin call. Make sure the server accepts requests from this portal. Or if using self-signed SSL certificates then paste the URL above into your browser to accept the certificate before trying again (On Internet Explorer it must be the same browser tab.).
Definitions
{
"properties": {
"error": {
"type": "array",
"items": {
"type": "object",
"properties": {
"httpCode": {
"type": "integer",
"description": "קוד החזר",
"example": 400
},
"httpMessage": {
"type": "string",
"description": "הודעה",
"example": "Bad Request"
},
"code": {
"type": "string",
"description": "קוד ממערכת המקור"
},
"message": {
"type": "string",
"description": "הודעה ממערכת המקור"
},
"moreInformation": {
"type": "string",
"description": "מידע נוסף ממערכת המקור"
}
}
}
},
"warning": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "קוד החזר",
"example": "MC101"
},
"message": {
"type": "string",
"description": "הודעה",
"example": "הוחלף יום עסקים..."
},
"moreInformation": {
"type": "string",
"description": "מידע נוסף",
"example": "יש לעדכן את הלקוח"
}
}
}
}
},
"additionalProperties": false,
"required": [
"error"
]
}
{
"properties": [],
"additionalProperties": false
}
{
"properties": {
"callRequestSeverity": {
"title": "callRequestSeverity",
"description": "חומרת הקריאה",
"type": "string",
"enum": [
"CriticalSystem",
"UnitDisabled",
"NotDisabled",
"WorkStationDisabled",
"LegacySystemDisabled",
"Critical",
"SafetyHazard",
"BranchDisabled",
"DisablingEvent",
"NoEmail",
"SeriousBusinessHazard",
"Low",
"Medium",
"BranchClient"
]
},
"environment": {
"title": "environment",
"description": "סביבה",
"type": "string",
"enum": [
"Production",
"Sandbox"
]
},
"softwareIssueType": {
"title": "softwareIssueType",
"description": "סוג בקשה",
"type": "string",
"enum": [
"Bug",
"Question",
"Remark"
]
},
"reportingUserID": {
"title": "reportingUserID",
"description": "מזהה המשתמש המדווח",
"type": "string",
"example": "D123456"
},
"impact": {
"title": "impact",
"description": "השפעה",
"type": "string",
"enum": [
"MediumHigh",
"SingleEffect",
"Low",
"Medium",
"OverallEffect",
"SmallGroup",
"EntireOrganization",
"NoEffect"
]
},
"categoryCode": {
"title": "categoryCode",
"description": "קוד קטגוריית הפנייה",
"type": "string",
"maxLength": 100,
"example": "pcat:1234569"
},
"deviceVersion": {
"title": "deviceVersion",
"description": "גרסת השירות",
"type": "string",
"example": "V4"
},
"callRequestDescription": {
"title": "callRequestDescription",
"description": "תיאור הפניה",
"type": "string",
"maxLength": 4000,
"example": "יש לי בעיה במחשב"
},
"userID": {
"title": "userID",
"description": "מזהה משתמש פנים ארגוני",
"type": "string",
"example": "D123456"
},
"deviceName": {
"title": "deviceName",
"description": "שם הרכיב",
"type": "string",
"maxLength": 20,
"example": "i342-sys-01"
}
},
"required": [
"userID",
"categoryCode",
"reportingUserID"
]
}
{
"properties": {
"data": {
"title": "data",
"description": "אובייקט אב",
"type": "object",
"properties": {
"callRequestID": {
"title": "callRequestID",
"description": "מזהה פנייה",
"type": "string"
}
},
"required": [
"callRequestID"
]
}
}
}
{
"properties": {
"data": {
"title": "data",
"description": "אובייקט אב",
"type": "object",
"properties": {
"changeRequestID": {
"title": "changeRequestID",
"description": "מזהה הדרישה",
"type": "integer",
"minimum": 0
}
}
}
}
}
{
"properties": {
"changeRequestDescription": {
"title": "changeRequestDescription",
"description": "תיאור הדרישה",
"type": "string",
"maxLength": 4000,
"example": "יש לי בעיה במחשב"
},
"entitlementSetting": {
"title": "entitlementSetting",
"description": "הגדרת זכאות",
"type": "object",
"properties": {
"entitlementDate": {
"title": "entitlementDate",
"description": "תאריך תפוגה להרשאות",
"type": "string",
"format": "date"
},
"entitlementCodes": {
"type": "array",
"items": {
"title": "entitlementCodes",
"description": "מספרי קודים של הרשאות",
"type": "integer",
"maximum": 4000,
"minimum": 0
}
}
},
"required": [
"entitlementCodes"
]
},
"reportingUserID": {
"title": "reportingUserID",
"description": "מזהה המשתמש המדווח",
"type": "string",
"example": "D123456"
},
"categoryCode": {
"title": "categoryCode",
"description": "קוד קטגוריית הפנייה",
"type": "string",
"maxLength": 20,
"example": "pcat:1234569"
},
"divisionReferent": {
"title": "divisionReferent",
"description": "מזהה רפרנט חטיבתי",
"type": "string",
"example": "d641104"
},
"userID": {
"title": "userID",
"description": "מזהה משתמש פנים ארגוני",
"type": "string"
}
},
"required": [
"userID",
"reportingUserID",
"categoryCode"
]
}
{
"properties": {
"data": {
"title": "data",
"description": "אובייקט אב",
"type": "object",
"properties": {
"reportingUserID": {
"title": "reportingUserID",
"description": "מזהה המשתמש המדווח",
"type": "string",
"maxLength": 8,
"example": "D123456"
},
"categoryCode": {
"title": "categoryCode",
"description": "קוד קטגוריית הפנייה",
"type": "string",
"maxLength": 20,
"example": "pcat:1234569"
},
"callRequestDescription": {
"title": "callRequestDescription",
"description": "תיאור הפניה",
"type": "string",
"maxLength": 4000,
"example": "יש לי בעיה במחשב"
},
"callRequestID": {
"title": "callRequestID",
"description": "מזהה פנייה",
"type": "string",
"maxLength": 20,
"example": "1425"
},
"userID": {
"title": "userID",
"description": "מזהה משתמש פנים ארגוני",
"type": "string"
},
"deviceName": {
"title": "deviceName",
"description": "שם הרכיב",
"type": "string",
"maxLength": 20,
"example": "i342-sys-01"
}
},
"required": [
"callRequestID"
]
}
}
}
{
"properties": {
"data": {
"title": "data",
"description": "אובייקט אב",
"type": "object",
"properties": {
"resultDescription": {
"title": "resultDescription",
"description": "פלט התוצאה של עדכון הקריאה",
"type": "string",
"example": "updated"
}
},
"required": [
"resultDescription"
]
}
}
}
{
"properties": {
"callRequestSeverity": {
"title": "callRequestSeverity",
"description": "חומרת הקריאה",
"type": "string",
"enum": [
"CriticalSystem",
"UnitDisabled",
"NotDisabled",
"WorkStationDisabled",
"LegacySystemDisabled",
"Critical",
"SafetyHazard",
"BranchDisabled",
"DisablingEvent",
"NoEmail",
"SeriousBusinessHazard",
"Low",
"Medium",
"BranchClient"
]
},
"callRequestAssignee": {
"title": "callRequestAssignee",
"description": "מספר עובד גורם מטפל",
"type": "string",
"maxLength": 7,
"example": "d298035"
},
"callRequestStatus": {
"title": "callRequestStatus",
"description": "סטטוס הפניה",
"type": "string",
"enum": [
"PastHandling",
"Duplication",
"Solving",
"Reopened",
"Closed",
"EndHandling",
"Holding",
"Cancelled",
"Open",
"Waiting"
]
},
"helpDeskTeam": {
"title": "helpDeskTeam",
"description": "צוות מטפל בקריאה",
"type": "string",
"maxLength": 20,
"example": "טכנאים"
},
"callRequestCloseDescription": {
"title": "callRequestCloseDescription",
"description": "תיאור סגירת הפניה",
"type": "string",
"maxLength": 4000,
"example": "פנייתך נסגרה"
},
"categoryCode": {
"title": "categoryCode",
"description": "קוד קטגוריית הפנייה",
"type": "string",
"maxLength": 100,
"example": "pcat:1234569"
},
"callRequestDescription": {
"title": "callRequestDescription",
"description": "תיאור הפניה",
"type": "string",
"maxLength": 4000,
"example": "יש לי בעיה במחשב"
},
"deviceName": {
"title": "deviceName",
"description": "שם הרכיב",
"type": "string",
"maxLength": 20,
"example": "i342-sys-01"
}
}
}