added depth and flat parameter to getByParent

added depth and flat parameter to getByParent:

- [x] test coverage
- [x] finish the code
- [ ] gather feedback for my changes
- [x] submit changes to the documentation


| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | yes
| Tests pass?   | yes
| Fixed tickets | none
| Doc           | none