API Products of the Mir payment system

Dispute API documentation

BpEngineApi Service

The BpEngineApi service provides methods for working with case samples: initiation, execution, obtaining execution options.

To execute the BpEngineApi service methods, transfer the access token parameter (X-Authorization).

GetComments Method

To get a list of case sample comments in a chat, call the GetComments method.

Method address: /webapi/v1/BpEngineApi/GetComments/{id}
Request type: post

REQUEST DETAILS
Key Data type Description
id* integer  
X-Authorization string  
RESPONSE DETAILS 200
Key Data type Description
items array of ApiCommentItem List of received comments
success boolean Action result
errorMessage string Error text

An example of HTTP request

JSON
POST http://<Имя сервера Диспут+>/webapi/v1/BpEngineApi/GetComments/<bpItemId> HTTP/1.1
Host: <Имя сервера Диспут+>
Content-Length: 0
Accept: application/json
Content-Type: application/json
Accept-Encoding: gzip, deflate
Accept-Language: ru-RU,ru;q=0.8
X-Authorization: Bearer <значение маркера доступа>

An example of HTTP response

JSON
HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 16
Content-Type: application/json; charset=utf-8
Expires: -1
Server: Microsoft-IIS/8.5
X-AspNet-Version: 4.0.30319
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: default-src 'self';script-src 'self' 'unsafe-eval' 'unsafe-inline';img-src 'self' data:;style-src 'self' 'unsafe-inline'
Strict-Transport-Security: max-age=31536000;includeSubdomains
Date: Tue, 24 Apr 2018 07:23:14 GMT
{
  "items": [
    {
      "comment": "vhjmfghjfg",
      "createdDate": "2018-04-13T14:59:11",
      "userName": "bb_FIO"
    },
    {
      "comment": "yufity",
      "createdDate": "2018-04-16T13:30:03",
      "userName": "aa_FIO2"
    },
    {
      "comment": "test",
      "createdDate": "2018-04-23T13:20:09",
      "userName": "aa_FIO2"
    }
  ],
  "success": true
}

Data types

ApiCommentItem

Code Data types Description
comment string Comments
createdDate string Creation date
userName string User's name, who posted comment
documentsInfo array of Document Attachments

Document

Code Data types Description
id string  
creationDate string  
creator string  
name string