Jump to

• Request
• Response

Adds a new relationship master

post

/service/v1/relationshipRecords

This API adds a new relationship master.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
  appId
• branchCode: string
  branchCode
• userId: string
  userId

Body ()

Request Body that contains data required for creating a new relationshipmaster

Root Schema : RelationshipmasterWebModelCollection

Type: object

Collection of datasegment.

Show Source

• data(optional): array data

{
    "description":"Collection of datasegment.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RelationshipmasterWebModel"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object RelationshipmasterWebModel
  RelationshipmasterAggregateModel

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/RelationshipmasterWebModel"
    }
}

Nested Schema : RelationshipmasterWebModel

Type: object

RelationshipmasterAggregateModel

Show Source

• approverRemarks(optional): string
  approver remarks
• authStatus(optional): string
  auth status flag
• checkerDateStamp(optional): string(date-time)
  checker date stamp
• checkerId(optional): string
  check id
• doerRemarks(optional): string
  doer remarks
• extendedDatasegments(optional): array extendedDatasegments
  data for the extended datasegment operation
• makerDateStamp(optional): string(date-time)
  make date stamp
• makerId(optional): string
  maker id
• modNo(optional): integer
  mod no
• obcmTmRelationshipMaster(optional): object ObcmTmRelationshipMasterDTO
• onceAuth(optional): string
  once auth flag
• operationType(optional): string
  operation type
• recordStatus(optional): string
  record status flag
• resourceId(optional): string
  resource id
• resourceName(optional): string
  resource name

{
    "description":"RelationshipmasterAggregateModel",
    "type":"object",
    "properties":{
        "resourceId":{
            "description":"resource id",
            "type":"string"
        },
        "resourceName":{
            "description":"resource name",
            "type":"string"
        },
        "operationType":{
            "description":"operation type",
            "type":"string"
        },
        "makerId":{
            "description":"maker id",
            "type":"string"
        },
        "makerDateStamp":{
            "description":"make date stamp",
            "type":"string",
            "format":"date-time"
        },
        "checkerId":{
            "description":"check id",
            "type":"string"
        },
        "checkerDateStamp":{
            "description":"checker date stamp",
            "type":"string",
            "format":"date-time"
        },
        "modNo":{
            "description":"mod no",
            "type":"integer"
        },
        "recordStatus":{
            "description":"record status flag",
            "type":"string"
        },
        "authStatus":{
            "description":"auth status flag",
            "type":"string"
        },
        "onceAuth":{
            "description":"once auth flag",
            "type":"string"
        },
        "doerRemarks":{
            "description":"doer remarks",
            "type":"string"
        },
        "approverRemarks":{
            "description":"approver  remarks",
            "type":"string"
        },
        "obcmTmRelationshipMaster":{
            "$ref":"#/definitions/ObcmTmRelationshipMasterDTO"
        },
        "extendedDatasegments":{
            "description":"data for the extended datasegment operation",
            "type":"array",
            "items":{
                "type":"object"
            },
            "required":[
                "resourceId",
                "operationType"
            ]
        }
    }
}

Nested Schema : extendedDatasegments

Type: array

data for the extended datasegment operation

Show Source

• Array of: object items

{
    "description":"data for the extended datasegment operation",
    "type":"array",
    "items":{
        "type":"object"
    },
    "required":[
        "resourceId",
        "operationType"
    ]
}

Nested Schema : ObcmTmRelationshipMasterDTO

Type: object

Match All

Show Source

• allOf GenericDto
  Generic DTO
• object ObcmTmRelationshipMasterDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Id"
                },
                "action":{
                    "type":"string",
                    "description":"Action"
                },
                "autoAuth":{
                    "type":"string",
                    "description":"Auto Auth"
                },
                "modificationStatus":{
                    "type":"string",
                    "description":"Modification Status"
                },
                "datasegmentCode":{
                    "type":"string",
                    "description":"Datasegment Code"
                },
                "checkerRemarks":{
                    "type":"string",
                    "description":"checkerRemarks"
                },
                "makerRemarks":{
                    "type":"string",
                    "description":"makerRemarks"
                },
                "autoAcceptance":{
                    "type":"string",
                    "description":"Auto Acceptance"
                },
                "corporateId":{
                    "type":"string",
                    "description":"Corporate Id"
                },
                "corporateName":{
                    "type":"string",
                    "description":"Corporate Name"
                },
                "effFromDate":{
                    "type":"string",
                    "description":"Effective From Date"
                },
                "relationshipCode":{
                    "type":"string",
                    "description":"Relationship Code"
                },
                "relationshipName":{
                    "type":"string",
                    "description":"Relationship Name"
                },
                "expiresOn":{
                    "type":"string",
                    "description":"Expires On"
                },
                "product":{
                    "type":"string",
                    "description":"Product"
                },
                "holidayTreatment":{
                    "type":"string",
                    "description":"Holiday Treatment"
                },
                "autoDebitApplicable":{
                    "type":"string",
                    "description":"Auto Debit Applicable"
                },
                "noOfDays":{
                    "type":"integer",
                    "description":"Number of Days"
                },
                "maxDate":{
                    "type":"string",
                    "description":"Maximum Date"
                },
                "allowOverdueRcv":{
                    "type":"string",
                    "description":"Allow Overdue Receivables"
                },
                "maxDaysOverdue":{
                    "type":"integer",
                    "description":"Maximum Days Overdue"
                },
                "excessHandling":{
                    "type":"string",
                    "description":"Excess Handling"
                },
                "excessRefundParty":{
                    "type":"string",
                    "description":"Excess Refund Party"
                },
                "excessRefundPaymentMode":{
                    "type":"string",
                    "description":"Excess Refund Payment Mode"
                },
                "txnControllerRefNo":{
                    "type":"string",
                    "description":"Transaction Controller Reference Number"
                },
                "ObcmTmRelationshipDetailsDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ObcmTmRelationshipDetailsDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : items

Type: object

Nested Schema : GenericDto

Generic DTO

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "description":"Generic DTO",
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : ObcmTmRelationshipMasterDTO-allOf[1]

Type: object

Show Source

• action(optional): string
  Action
• allowOverdueRcv(optional): string
  Allow Overdue Receivables
• autoAcceptance(optional): string
  Auto Acceptance
• autoAuth(optional): string
  Auto Auth
• autoDebitApplicable(optional): string
  Auto Debit Applicable
• checkerRemarks(optional): string
  checkerRemarks
• corporateId(optional): string
  Corporate Id
• corporateName(optional): string
  Corporate Name
• datasegmentCode(optional): string
  Datasegment Code
• effFromDate(optional): string
  Effective From Date
• excessHandling(optional): string
  Excess Handling
• excessRefundParty(optional): string
  Excess Refund Party
• excessRefundPaymentMode(optional): string
  Excess Refund Payment Mode
• expiresOn(optional): string
  Expires On
• holidayTreatment(optional): string
  Holiday Treatment
• id(optional): string
  Id
• makerRemarks(optional): string
  makerRemarks
• maxDate(optional): string
  Maximum Date
• maxDaysOverdue(optional): integer
  Maximum Days Overdue
• modificationStatus(optional): string
  Modification Status
• noOfDays(optional): integer
  Number of Days
• ObcmTmRelationshipDetailsDTO(optional): array ObcmTmRelationshipDetailsDTO
• product(optional): string
  Product
• relationshipCode(optional): string
  Relationship Code
• relationshipName(optional): string
  Relationship Name
• txnControllerRefNo(optional): string
  Transaction Controller Reference Number

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "action":{
            "type":"string",
            "description":"Action"
        },
        "autoAuth":{
            "type":"string",
            "description":"Auto Auth"
        },
        "modificationStatus":{
            "type":"string",
            "description":"Modification Status"
        },
        "datasegmentCode":{
            "type":"string",
            "description":"Datasegment Code"
        },
        "checkerRemarks":{
            "type":"string",
            "description":"checkerRemarks"
        },
        "makerRemarks":{
            "type":"string",
            "description":"makerRemarks"
        },
        "autoAcceptance":{
            "type":"string",
            "description":"Auto Acceptance"
        },
        "corporateId":{
            "type":"string",
            "description":"Corporate Id"
        },
        "corporateName":{
            "type":"string",
            "description":"Corporate Name"
        },
        "effFromDate":{
            "type":"string",
            "description":"Effective From Date"
        },
        "relationshipCode":{
            "type":"string",
            "description":"Relationship Code"
        },
        "relationshipName":{
            "type":"string",
            "description":"Relationship Name"
        },
        "expiresOn":{
            "type":"string",
            "description":"Expires On"
        },
        "product":{
            "type":"string",
            "description":"Product"
        },
        "holidayTreatment":{
            "type":"string",
            "description":"Holiday Treatment"
        },
        "autoDebitApplicable":{
            "type":"string",
            "description":"Auto Debit Applicable"
        },
        "noOfDays":{
            "type":"integer",
            "description":"Number of Days"
        },
        "maxDate":{
            "type":"string",
            "description":"Maximum Date"
        },
        "allowOverdueRcv":{
            "type":"string",
            "description":"Allow Overdue Receivables"
        },
        "maxDaysOverdue":{
            "type":"integer",
            "description":"Maximum Days Overdue"
        },
        "excessHandling":{
            "type":"string",
            "description":"Excess Handling"
        },
        "excessRefundParty":{
            "type":"string",
            "description":"Excess Refund Party"
        },
        "excessRefundPaymentMode":{
            "type":"string",
            "description":"Excess Refund Payment Mode"
        },
        "txnControllerRefNo":{
            "type":"string",
            "description":"Transaction Controller Reference Number"
        },
        "ObcmTmRelationshipDetailsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObcmTmRelationshipDetailsDTO"
            }
        }
    }
}

Nested Schema : ObcmTmRelationshipDetailsDTO

Type: array

Show Source

• Array of: object ObcmTmRelationshipDetailsDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ObcmTmRelationshipDetailsDTO"
    }
}

Nested Schema : ObcmTmRelationshipDetailsDTO

Type: object

Show Source

• allowOverdueRcv(optional): string
  Allow Overdue Receivables
• autoAcceptance(optional): string
  Auto Acceptance
• autoDebitApplicable(optional): string
  Auto Debit Applicable
• counterpartyid(optional): string
  Counterparty Id
• counterpartyname(optional): string
  Counterparty Name
• excessHandling(optional): string
  Excess Handling
• excessRefundParty(optional): string
  Excess Refund Party
• excessRefundPaymentMode(optional): string
  Excess Refund Payment Mode
• expiresOn(optional): string
  Expires On
• externalCodes(optional): array externalCodes
  External Codes
• holidayTreatment(optional): string
  Holiday Treatment
• id(optional): string
  Id
• maxDaysOverdue(optional): integer
  Maximum Days Overdue
• nonCust(optional): object ScfTmNonCustomerMasterDTO
• noOfDays(optional): integer
  Number of Days
• partyType(optional): string
  Party Type
• programCode(optional): string
  Program Code
• registrationNumber(optional): string
  registrationNumber
• relationsMasterId(optional): string
  Relations Master Id
• status(optional): string
  Status

{
    "type":"object",
    "properties":{
        "autoAcceptance":{
            "type":"string",
            "description":"Auto Acceptance"
        },
        "counterpartyid":{
            "type":"string",
            "description":"Counterparty Id"
        },
        "counterpartyname":{
            "type":"string",
            "description":"Counterparty Name"
        },
        "id":{
            "type":"string",
            "description":"Id"
        },
        "partyType":{
            "type":"string",
            "description":"Party Type"
        },
        "relationsMasterId":{
            "type":"string",
            "description":"Relations Master Id"
        },
        "expiresOn":{
            "type":"string",
            "description":"Expires On"
        },
        "noOfDays":{
            "type":"integer",
            "description":"Number of Days"
        },
        "holidayTreatment":{
            "type":"string",
            "description":"Holiday Treatment"
        },
        "autoDebitApplicable":{
            "type":"string",
            "description":"Auto Debit Applicable"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "programCode":{
            "type":"string",
            "description":"Program Code"
        },
        "registrationNumber":{
            "type":"string",
            "description":"registrationNumber"
        },
        "allowOverdueRcv":{
            "type":"string",
            "description":"Allow Overdue Receivables"
        },
        "maxDaysOverdue":{
            "type":"integer",
            "description":"Maximum Days Overdue"
        },
        "excessHandling":{
            "type":"string",
            "description":"Excess Handling"
        },
        "excessRefundParty":{
            "type":"string",
            "description":"Excess Refund Party"
        },
        "excessRefundPaymentMode":{
            "type":"string",
            "description":"Excess Refund Payment Mode"
        },
        "externalCodes":{
            "type":"array",
            "description":"External Codes",
            "items":{
                "$ref":"#/definitions/ObcmTmRelationshipDetailsExternalCodeDTO"
            }
        },
        "nonCust":{
            "$ref":"#/definitions/ScfTmNonCustomerMasterDTO"
        }
    }
}

Nested Schema : externalCodes

Type: array

External Codes

Show Source

• Array of: object ObcmTmRelationshipDetailsExternalCodeDTO

{
    "type":"array",
    "description":"External Codes",
    "items":{
        "$ref":"#/definitions/ObcmTmRelationshipDetailsExternalCodeDTO"
    }
}

Nested Schema : ScfTmNonCustomerMasterDTO

Type: object

Match All

Show Source

• allOf GenericDto
  Generic DTO
• object ScfTmNonCustomerMasterDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "category":{
                    "type":"string",
                    "description":"Category"
                },
                "cif":{
                    "type":"string",
                    "description":"Cif"
                },
                "countryCode":{
                    "type":"string",
                    "description":"Country Code"
                },
                "email":{
                    "type":"string",
                    "description":"Email"
                },
                "faxNumber":{
                    "type":"string",
                    "description":"Fax Number"
                },
                "giin":{
                    "type":"string",
                    "description":"Giin"
                },
                "industry":{
                    "type":"string",
                    "description":"Industry"
                },
                "mobileNumber":{
                    "type":"string",
                    "description":"Mobile Number"
                },
                "name":{
                    "type":"string",
                    "description":"Name"
                },
                "nonCustomerId":{
                    "type":"string",
                    "description":"Non Customer Id"
                },
                "phoneNumber":{
                    "type":"string",
                    "description":"Phone Number"
                },
                "prefferedCommMode":{
                    "type":"string",
                    "description":"Preffered Comm Mode"
                },
                "registrationNumber":{
                    "type":"string",
                    "description":"Registration Number"
                },
                "shortName":{
                    "type":"string",
                    "description":"Short Name"
                },
                "taxRefNo1":{
                    "type":"string",
                    "description":"Tax Reference No1"
                },
                "taxRefNo2":{
                    "type":"string",
                    "description":"Tax Reference No2"
                },
                "fatca":{
                    "type":"string",
                    "description":"Fatca"
                },
                "ScfTmNcAddressMasterDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ScfTmNcAddressMasterDTO"
                    }
                },
                "ScfTmNcRequestMasterDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ScfTmNcRequestMasterDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : ObcmTmRelationshipDetailsExternalCodeDTO

Type: object

Show Source

• corporateDivisionCode(optional): string
  Corporate Division Code
• divisionCode(optional): string
  Division Code
• externalCode(optional): string
  External Code
• id(optional): string
  Id
• modNo(optional): integer
• relationshipDetailId(optional): string
  Relationship Detail Id

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "modNo":{
            "type":"integer"
        },
        "corporateDivisionCode":{
            "type":"string",
            "description":"Corporate Division Code"
        },
        "divisionCode":{
            "type":"string",
            "description":"Division Code"
        },
        "externalCode":{
            "type":"string",
            "description":"External Code"
        },
        "relationshipDetailId":{
            "type":"string",
            "description":"Relationship Detail Id"
        }
    }
}

Nested Schema : ScfTmNonCustomerMasterDTO-allOf[1]

Type: object

Show Source

• category(optional): string
  Category
• cif(optional): string
  Cif
• countryCode(optional): string
  Country Code
• email(optional): string
  Email
• fatca(optional): string
  Fatca
• faxNumber(optional): string
  Fax Number
• giin(optional): string
  Giin
• industry(optional): string
  Industry
• mobileNumber(optional): string
  Mobile Number
• name(optional): string
  Name
• nonCustomerId(optional): string
  Non Customer Id
• phoneNumber(optional): string
  Phone Number
• prefferedCommMode(optional): string
  Preffered Comm Mode
• registrationNumber(optional): string
  Registration Number
• ScfTmNcAddressMasterDTO(optional): array ScfTmNcAddressMasterDTO
• ScfTmNcRequestMasterDTO(optional): array ScfTmNcRequestMasterDTO
• shortName(optional): string
  Short Name
• taxRefNo1(optional): string
  Tax Reference No1
• taxRefNo2(optional): string
  Tax Reference No2

{
    "type":"object",
    "properties":{
        "category":{
            "type":"string",
            "description":"Category"
        },
        "cif":{
            "type":"string",
            "description":"Cif"
        },
        "countryCode":{
            "type":"string",
            "description":"Country Code"
        },
        "email":{
            "type":"string",
            "description":"Email"
        },
        "faxNumber":{
            "type":"string",
            "description":"Fax Number"
        },
        "giin":{
            "type":"string",
            "description":"Giin"
        },
        "industry":{
            "type":"string",
            "description":"Industry"
        },
        "mobileNumber":{
            "type":"string",
            "description":"Mobile Number"
        },
        "name":{
            "type":"string",
            "description":"Name"
        },
        "nonCustomerId":{
            "type":"string",
            "description":"Non Customer Id"
        },
        "phoneNumber":{
            "type":"string",
            "description":"Phone Number"
        },
        "prefferedCommMode":{
            "type":"string",
            "description":"Preffered Comm Mode"
        },
        "registrationNumber":{
            "type":"string",
            "description":"Registration Number"
        },
        "shortName":{
            "type":"string",
            "description":"Short Name"
        },
        "taxRefNo1":{
            "type":"string",
            "description":"Tax Reference No1"
        },
        "taxRefNo2":{
            "type":"string",
            "description":"Tax Reference No2"
        },
        "fatca":{
            "type":"string",
            "description":"Fatca"
        },
        "ScfTmNcAddressMasterDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfTmNcAddressMasterDTO"
            }
        },
        "ScfTmNcRequestMasterDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfTmNcRequestMasterDTO"
            }
        }
    }
}

Nested Schema : ScfTmNcAddressMasterDTO

Type: array

Show Source

• Array of: object ScfTmNcAddressMasterDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ScfTmNcAddressMasterDTO"
    }
}

Nested Schema : ScfTmNcRequestMasterDTO

Type: array

Show Source

• Array of: object ScfTmNcRequestMasterDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ScfTmNcRequestMasterDTO"
    }
}

Nested Schema : ScfTmNcAddressMasterDTO

Type: object

Show Source

• addressLine1(optional): string
  Address Line1
• addressLine2(optional): string
  Address Line2
• addressLine3(optional): string
  Address Line3
• addressLine4(optional): string
  Address Line4
• addressType(optional): string
  Address Type
• country(optional): string
  Country
• id(optional): string
  Id
• nonCustMasterId(optional): string
  Non Customer Master Id
• nonCustomerId(optional): string
  Non Customer Id
• pin(optional): string
  Pin
• street(optional): string
  Street

{
    "type":"object",
    "properties":{
        "addressLine1":{
            "type":"string",
            "description":"Address Line1"
        },
        "addressLine2":{
            "type":"string",
            "description":"Address Line2"
        },
        "addressLine3":{
            "type":"string",
            "description":"Address Line3"
        },
        "addressLine4":{
            "type":"string",
            "description":"Address Line4"
        },
        "addressType":{
            "type":"string",
            "description":"Address Type"
        },
        "country":{
            "type":"string",
            "description":"Country"
        },
        "id":{
            "type":"string",
            "description":"Id"
        },
        "nonCustMasterId":{
            "type":"string",
            "description":"Non Customer Master Id"
        },
        "pin":{
            "type":"string",
            "description":"Pin"
        },
        "street":{
            "type":"string",
            "description":"Street"
        },
        "nonCustomerId":{
            "type":"string",
            "description":"Non Customer Id"
        }
    }
}

Nested Schema : ScfTmNcRequestMasterDTO

Type: object

Show Source

• anchorId: string
  Anchor Id
• anchorName(optional): string
  Anchor Name
• id(optional): string
  Id
• nonCustMasterId(optional): string
  Non Customer Master Id
• nonCustomerCode(optional): string
  Non Customer Code
• nonCustomerId(optional): string
  Non Customer Id
• status(optional): string
  Status

{
    "type":"object",
    "properties":{
        "anchorId":{
            "type":"string",
            "description":"Anchor Id"
        },
        "anchorName":{
            "type":"string",
            "description":"Anchor Name"
        },
        "id":{
            "type":"string",
            "description":"Id"
        },
        "nonCustomerCode":{
            "type":"string",
            "description":"Non Customer Code"
        },
        "nonCustMasterId":{
            "type":"string",
            "description":"Non Customer Master Id"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "nonCustomerId":{
            "type":"string",
            "description":"Non Customer Id"
        }
    },
    "required":[
        "anchorId"
    ]
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string
  URL of newly created relationshipmaster

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Response DTO Wrapper

Show Source

• data(optional): object ResponseResourceSupport
  Response Resource Support
• messages(optional): object ResponseDto
  Response DTO

{
    "description":"Response DTO Wrapper",
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Response Resource Support

Nested Schema : ResponseDto

Type: object

Response DTO

Show Source

• codes(optional): array codes
  Codes
• id(optional): string
  ID
• requestId(optional): string
  Request ID
• status(optional): string
  Status

{
    "description":"Response DTO",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "codes":{
            "type":"array",
            "description":"Codes",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string",
            "description":"Request ID"
        }
    }
}

Nested Schema : codes

Type: array

Codes

Show Source

• Array of: object ResponseCode
  Response Code

{
    "type":"array",
    "description":"Codes",
    "items":{
        "$ref":"#/definitions/ResponseCode"
    }
}

Nested Schema : ResponseCode

Type: object

Response Code

Show Source

• arg(optional): string
  Arg
• args(optional): array args
  Args
• Code(optional): string
  Code
• Desc(optional): string
  Description
• Language(optional): string
  Language
• Type(optional): string
  Type

{
    "description":"Response Code",
    "type":"object",
    "properties":{
        "Code":{
            "type":"string",
            "description":"Code"
        },
        "Desc":{
            "type":"string",
            "description":"Description"
        },
        "Type":{
            "type":"string",
            "description":"Type"
        },
        "Language":{
            "type":"string",
            "description":"Language"
        },
        "args":{
            "type":"array",
            "description":"Args",
            "items":{
                "type":"object",
                "description":"Items"
            }
        },
        "arg":{
            "type":"string",
            "description":"Arg"
        }
    }
}

Nested Schema : args

Type: array

Args

Show Source

• Array of: object items
  Items

{
    "type":"array",
    "description":"Args",
    "items":{
        "type":"object",
        "description":"Items"
    }
}

Nested Schema : items

Type: object

Items

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top