API Explorer 43 endpoints

Get My training_progress by id

GET /obp/dynamic-entity/my/training_progress/TRAINING_PROGRESS_ID

OBPv4.0.0-dynamicEntity_getSingleMytraining_progress_ No role required _Training_progressDynamic-EntityDynamic

Get My training_progress by id.

Training_progress entity

Property List:

  • name: Name field
  • age: Age in years
  • active: Is active
  • internal_note: Write-restricted: settable only via PATCH by a holder of the field's write role

MethodRouting settings example:

<details>

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

</details>

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

With a Consent: the consent user may use this endpoint only if the Consent lists this entity in my_resources.personal_dynamic_entities with the needed action (read for GET, write otherwise); rows written with a Consent belong to the User who granted it.

Example success response
{
  "training_progress": {
    "training_progress_id": "d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name": "Example Name",
    "age": 25,
    "active": true,
    "internal_note": "set by a privileged service"
  }
}
Possible errors (3)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-35043: The Consent does not cover this personal resource. A consent user may use a personal (my) endpoint only if the Consent lists the resource in my_resources with the needed action.
  • OBP-50000: Unknown Error.
Implemented by OBPv4.0.0 dynamicEntity_getSingleMytraining_progress_ Originally /my/training_progress/TRAINING_PROGRESS_ID