GENERAL INSTRUCTIONS

REST REQUEST PARAMETERS

Each rest call will have below compulsory request parameter in header.

Bearer (Access Token)

JSON Web Tokens Authorization header using the Bearer scheme (Example: 'Bearer 12345abcdef')

Name: Authorization

In: header

NOTE: All APIs are considered as POST method. All the input as well as output data type will JSON formatted.

‍

REST RESPONSE PARAMETERS

The response comes as JSON object and response table in each rest description explains you about JSON object parameters ->Parameter with in JSON object will be in String format.

Below parameter return in every response:

  • StatusCode [int]
  • Message [string]
  • IsError [bool]
  • ResponseException [object]
  • Result [object]

‍

WhenSuccess





{
  "StatusCode": 200,
  "Message": "Request successful.",
  "IsError": false,
  "ResponseException": null,
  "Result": {
    "Data": {      
      "ResponseId": 1,
      "ResponseMessage": " Key generated successfully."
    }
  }
}

 

‍WhenError



{
  "StatusCode": 401,
  "Message": "Fail",
  "IsError": true,
  "ResponseException": {
  	"ExceptionMessage": "InvalidAccessKey Or AccessSecret",
    "Details": null,
    "ValidationErrors": null
  },
  "Result": null
}

‍

WhenValidate



{
  "StatusCode": 400,
  "Message": "Fail",
  "IsError": true,
  "ResponseException": {
    "ExceptionMessage": "Request responded with validation error(s). Please correct the specified validation errors and try again.",
    "Details": null,
    "ValidationErrors": [
      {
        "Field": "AccessKey",
        "Message": "Access Key is required."
      },
      {
        "Field": "AccessSecret",
        "Message": "Access Secret is required."
      }
    ]
  },
  "Result": null
}

‍

‍