POST Program/Get

Documentation for 'Get'.

Request Information

Parameters

NameDescriptionAdditional information
jqgridValue
Documentation for 'jqgridValue'.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "Page": 1,
  "Rows": 2,
  "Sidx": "sample string 3",
  "Sord": "sample string 4",
  "Criteria": {
    "$id": "2",
    "ProgramID": 1,
    "ProgramCode": "sample string 1",
    "ProgramTitle": "sample string 2",
    "ProductLine": "sample string 3",
    "ExpiryDate": "2026-04-03T01:47:21.0917699-04:00",
    "Keyword": "sample string 4",
    "RateCalculatorID": 1,
    "IncludeExpiredPromotion": 5,
    "IncludeInactiveCalculator": 6,
    "IncludePromotionsWithoutCalculator": 7,
    "IsDeleted": 1,
    "IsActive": 1,
    "IsProgram": true,
    "FromDate": "2026-04-03T01:47:21.0917699-04:00",
    "ToDate": "2026-04-03T01:47:21.0927731-04:00",
    "PriceFrom": 1.0,
    "PriceTo": 1.0
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "Page": 1,
  "Rows": [
    {
      "$id": "2",
      "ProgramID": 1,
      "IsPublic": true,
      "IsProgram": true,
      "ProgramTitle": "sample string 4",
      "Description": "sample string 5",
      "Status": "sample string 6",
      "IsShowExpiryDate": 1,
      "ThumbnailDocumentID": 1,
      "ThumbnailURL": "sample string 7",
      "DocumentID": 1,
      "DocumentURL": "sample string 8",
      "ExpiryDate": "sample string 9",
      "CalculatorID": 1
    },
    {
      "$ref": "2"
    },
    {
      "$ref": "2"
    }
  ],
  "Total": 2,
  "Records": 3
}