Skip to content

MngGetPropProgramsByFilter

Returns prop trading programs in the standard BackOffice table format.

The response contains structure, rows and count, following the same pattern as MngGetCustomersByFilter.

Access

SESSION_MANAGER, SESSION_ADMIN, SESSION_DEALER, SESSION_CRM_MANAGER, SESSION_CRM_ADMIN.

Request Parameters

Name Type Required Description
limit int Yes Maximum number of rows, 1..50000
offset int Yes Pagination offset
where array No AND filters, for example [["status", "=", 0]]
whereNot array No Negative filters
whereIn array No IN filters
whereNotIn array No NOT IN filters
whereBetween array No Range filters
whereNotBetween array No Negative range filters
orderBy array No Sort expression, for example [["sort_index", "asc"]]

Supported Filter Fields

Field Type
id int
brand string
name string
description string
demo_group string
price double
price_currency string
status int
sort_index int
created_time int64
updated_time int64

Supported string operators include =, !=, like.

Response Structure

Rows follow this structure order:

[
  "id",
  "brand",
  "name",
  "description",
  "demo_group",
  "price",
  "price_currency",
  "status",
  "sort_index",
  "phases_count",
  "created_time",
  "updated_time"
]

phases_count is calculated by the server for display in the BackOffice table.

Request

{
  "command": "MngGetPropProgramsByFilter",
  "extID": "1",
  "data": {
    "limit": 50,
    "offset": 0,
    "where": [
      ["brand", "=", "default"],
      ["status", "=", 0]
    ],
    "orderBy": [
      ["sort_index", "asc"]
    ]
  }
}

Response Data

{
  "structure": [
    "id",
    "brand",
    "name",
    "description",
    "demo_group",
    "price",
    "price_currency",
    "status",
    "sort_index",
    "phases_count",
    "created_time",
    "updated_time"
  ],
  "rows": [
    [
      1,
      "default",
      "Evaluation 100K",
      "Two phase evaluation",
      "PROP_DEMO_USD",
      499.0,
      "USD",
      0,
      100,
      2,
      1778160000,
      1778160000
    ]
  ],
  "count": 1
}