Response формат

Банкруу хүсэлт явуулахад хариу болгож явуулах мэдээллийн форматууд ижил байх бөгөөд дараахтай адил байна.

Response json-ны ерөнхий бүтэц

{
  "header": {
    "code": 0,
    "status": "string",
    "date": "2020-02-06T05:08:41.974Z",
    "message": "string"
  },
  "body": {
    "response": {},
    "error": {},
    "success": {}
  }
}

header

Parameter	Type	Definition
code	Integer	Тухайн хүсэлт бүх шалгалтуудаа давж үндсэн үйлдэл хийгдсэн эсэхийг илэрхийлэх 3 оронтой тоо байна. 200 Request validated 400 Request invalidated 500 системийн алдаа
status	String	Тухайн хүсэлт шалгалтуудаа давсан эсэхийг text-ээр илэрхийлэх success бүх шалгалтуулдыг давсан (validated) failed ямар нэгэн нөхцөлийг хангаагүй (invalidated)
date
message	String

body

header-н code-оос хамаарч body дотор ирэх object нь error эсвэл response байна.

"code": 200 үед body дотор response гэсэн object буцна. response object дотор ирэх утгууд нь тухайн хүсэлт шидэж байгаа function-уудаас хамаарч өөр өөр утга агуулна.

Жишээ

{
  "header": {
    "code": 200,
    "status": "success"
  },
  "body": {
    "response": {
      "checksum": "9ac76e1ecd0cb23b25cf2dbf976de7bc4d6ff11aebfbd83216aae29be16534b8",
      "transactionId": "P544F455K809",
      "invoice": "d7fb2858-df36-469e-b40d-2815fe9215cf"
    }
  }
}

"code": 400 болон "code": 500 үед body дотор error гэсэн object буцна. error object дотор errorType errorDesc гэсэн parameter-үүд ирнэ.

Parameter	Type	Definition
errorType	String	Тухайн шалгуурын төрлийн заасан байна. validation талбар, checksum гэх мэт ерөнхий шалгалт хангаагүй үед notfound мерчант, гүйлгээ, key олдоогүй үед exception систем унтрах, доголдох, таамаглаагүй алдаа гарах үед
errorDesc	String	errorType-н дэлгэрэнгүй мэдээлэл байна.

Жишээ

{
  "header": {
    "code": 400,
    "status": "failed"
  },
  "body": {
    "error": {
      "errorDesc": "Merchant is empty",
      "errorType": "validation"
    }
  }
}

{
  "header": {
    "code": 500,
    "status": "failed"
  },
  "body": {
    "error": {
      "errorDesc": "SQL exception",
      "errorType": "exception"
    }
  }
}