Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GenericResponse

Hierarchy

  • GenericResponse

Index

Properties

detail

detail: string

Message text that the system may send. The content of this parameter is usually null.

type

{string}

memberof

GenericResponse

Optional errorcode

errorcode: number

A successful receipt of the call returns 0. An unsuccessful receipt of the call returns one of the errorcodes shown in the errormsg list.

  • Not Authorized (errorcode 20)
  • Invalid Request (errorcode 100)
  • Operation Failed (errorcode 101)
  • Server Error (errorcode 102)
  • Resource Not Found (errorcode 104)
type

{number}

memberof

GenericResponse

errormsg

errormsg: string

A successful receipt of the call returns null; the errormsg parameter for an unsuccessful call returns one of the following messages:

  • Not Authorized (errorcode 20)
  • Invalid Request (errorcode 100)
  • Operation Failed (errorcode 101)
  • Server Error (errorcode 102)
  • Resource Not Found (errorcode 104)
type

{string}

memberof

GenericResponse

result

result: boolean

If the call has been successfully received by the Order Management System, result is true; otherwise, it is false.

type

{boolean}

memberof

GenericResponse

Generated using TypeDoc