API Explorer 896 endpoints

Get Public obp_developer_faq by id

GET /obp/dynamic-entity/public/obp_developer_faq/OBP_DEVELOPER_FAQ_ID

OBPv4.0.0-dynamicEntity_getSinglePublicobp_developer_faq_ No role required _Obp_developer_faqDynamic-EntityDynamic

Get Public obp_developer_faq by id.

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

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

Example success response
{
  "obp_developer_faq": {
    "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_getSinglePublicobp_developer_faq_ Originally /public/obp_developer_faq/OBP_DEVELOPER_FAQ_ID