Product List Inquiry

Retrieves the list of product offered by a given manufacturer based on the product type

Query Parameters

productSubGroupId Productsubgroupid
manufacturerId Manufacturerid required

System generated unique id to identify a manufacturer

productId Productid

Unique identifier of product

searchString Searchstring

Search parameter, name of the strategy to narrow down the list of strategies in the response

pageNumber Pagenumber required
Page number for which the request is made
Example: 1
pageSize Pagesize required
Number of responses to be returned in a given page
Example: 20

Responses

• 200
• 422

---

Successful Response

application/json

Schema

Example (from schema)

---

Schema

reqId Reqid required
errors undefined[] required
data object[] required
Array [
totalItems Totalitems
Number of responses to be returned in a given page
totalPages Totalpages
Count of total pages
currentPage Currentpage
Page number of current page
products object[]
Array [
createdOn Createdon
User id of the employee updating the AMC record
productSubGroupId Productsubgroupid
Sub type of product
productId Productid
System generated unique id to identify a strategy
productGroupId Productgroupid
manufacturerId Manufacturerid
System generated unique id to identify a AMC
productDescription Productdescription
Brief description of the strategy
status Status
Current status of the strategy
productShortName Productshortname
Short name of the strategy
productSubGroupName Productsubgroupname
product sub type name
productName Productname
Name of the strategy
productGroupName Productgroupname
]
]

{
  "reqId": "string",
  "errors": [
    null
  ],
  "data": [
    {
      "totalItems": 0,
      "totalPages": 0,
      "currentPage": 0,
      "products": [
        {
          "createdOn": "string",
          "productSubGroupId": 0,
          "productId": 0,
          "productGroupId": 0,
          "manufacturerId": 0,
          "productDescription": "string",
          "status": "string",
          "productShortName": "string",
          "productSubGroupName": "string",
          "productName": "string",
          "productGroupName": "string"
        }
      ]
    }
  ]
}

Validation Error

application/json

Schema

Example (from schema)

---

Schema

detail object[]
Array [
loc object[] required
Array [
anyOf
MOD1
MOD2
---
string
integer
]
msg Message required
type Error Type required
]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...