API Explorer 896 endpoints

Get Public obp_developer_faq List

GET /obp/dynamic-entity/public/obp_developer_faq

OBPv4.0.0-dynamicEntity_getPublicobp_developer_faqList_ No role required _Obp_developer_faqDynamic-EntityDynamic

Get Public obp_developer_faq List.

Frequently asked questions shown on the Portal's /faq page. Public: anyone can read the records; editing needs the entity's roles. Answers are Markdown. A visitor's 'Start a chat' creates a group chat for the question: the Portal links it with its consumer's Update scope.

Property List:

  • question: The question, as shown.
  • answer: The answer, Markdown allowed.
  • opey_prompt: Optional: what the 'Ask Opey' button sends to Opey for this question. Empty means Opey is asked the question itself.
  • category: Groups questions under a heading on the page. Empty means General.
  • chat_room_id: Optional: the chat_room_id of a Portal group chat about this question; shown as a 'Discuss in the group chat' link.
  • chat_joining_key: The joining key of that chat room, so a visitor can join it from the FAQ. Public by design: the room is meant for everyone.
  • sort_order: Position within its category, lowest first.

MethodRouting settings example:

<details>

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"obp_developer_faq"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

</details>

Authentication is Optional

Filtering, sorting and pagination on the list endpoint:

(no fields on this entity are declared indexed, so only the legacy bare-parameter filter below is available.)

  • Filter: ?obp_filter[FIELD]=OP:VALUE. Operators: eq, ne, in, lt, gt, le, ge, between, like, is_null, not_set. in / between take comma-separated values; is_null / not_set take no value. Repeat the same key to AND several constraints on one field. e.g. ?obp_filter[status]=eq:active&obp_filter[amount]=between:10,100 or ?obp_filter[closed_date]=not_set
  • Legacy filter (still supported): bare field parameters, e.g. ?name=James%20Brown&number=123.456&number=11.11 filters by name == "James Brown" && (number == 123.456 || number == 11.11).
  • Sort: ?obp_sort_by=FIELD[,FIELD2]&obp_sort_direction=ASC|DESC.
  • Paginate: ?obp_limit=20&obp_offset=40.

Filtering, sorting, pagination and is_null / not_set work on every deployment (no special backend required).

One-hop join queries (obp_exists / obp_not_exists) are not available on this endpoint.

User Authentication is Optional. The User need not be logged in.

Example success response
{
  "obp_developer_faq_list": [
    {
      "obp_developer_faq_id": "d8839721-ad8f-45dd-9f78-2080414b93f9",
      "question": "What are rate limits?",
      "answer": "Rate limits control how many API requests you can make in a period. **Higher tiers** include more generous limits.",
      "opey_prompt": "Explain rate limits on this API and how I can see my consumer's current limits.",
      "category": "Products and pricing",
      "chat_room_id": "",
      "chat_joining_key": "",
      "sort_order": 10
    }
  ]
}
Possible errors (1)
  • OBP-50000: Unknown Error.
Implemented by OBPv4.0.0 dynamicEntity_getPublicobp_developer_faqList_ Originally /public/obp_developer_faq