Jump to

• Request
• Response

Fetch the corporate enrichment products

get

/service/v1/corporateinformation/products

This API fetches corporate enrichment products based on given parameters.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• partyId: string
  filter by corporate code/id
• productCategory: string
  filter by product category
• productCode: string
  filter by product code

Header Parameters

• appId(required): string
  appId
• branchCode(required): string
  branchCode
• userId(required): string
  userId

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string
  Returns products information

Body ()

Root Schema : ObcmTmCorpEnrchProdListCollection

Type: object

Collection of Corporate Enrichment product Data.

Show Source

• data: array data

{
    "description":"Collection of Corporate Enrichment product Data.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObcmTmCorpEnrchProdListDTO"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object ObcmTmCorpEnrchProdListDTO
  List of Corporate Enrichment Product data

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

Nested Schema : ObcmTmCorpEnrchProdListDTO

Type: object

List of Corporate Enrichment Product data

Show Source

• partyId: string
  Party id used for corporate enrichment product data
• productCategory: string
  Product Category used for corporate enrichment product data
• productCode: string
  ProductCode used for corporate enrichment product data
• productDesc: string
  ProductDesc used for corporate enrichment product data
• productType: string
  ProductType used for corporate enrichment product data

{
    "type":"object",
    "description":"List of Corporate Enrichment Product data",
    "properties":{
        "productCode":{
            "type":"string",
            "description":"ProductCode used for corporate enrichment product data"
        },
        "productDesc":{
            "type":"string",
            "description":"ProductDesc used for corporate enrichment product data"
        },
        "productCategory":{
            "type":"string",
            "description":"Product Category used for corporate enrichment product data"
        },
        "productType":{
            "type":"string",
            "description":"ProductType used for corporate enrichment product data"
        },
        "partyId":{
            "type":"string",
            "description":"Party id used for corporate enrichment product data"
        }
    }
}

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