All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| get_person | GET /Persons/{name} | Get person by name. |
| get_persons | GET /Persons | Gets all persons. |
crate::models::BaseItemDto get_person(name, user_id) Get person by name.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| name | String | Person name. | [required] | |
| user_id | Option<uuid::Uuid> | Optional. Filter by user id, and attach user data. |
- Content-Type: Not defined
- Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::BaseItemDtoQueryResult get_persons(limit, search_term, fields, filters, is_favorite, enable_user_data, image_type_limit, enable_image_types, exclude_person_types, person_types, appears_in_item_id, user_id, enable_images) Gets all persons.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| limit | Option<i32> | Optional. The maximum number of records to return. | ||
| search_term | Option<String> | The search term. | ||
| fields | Option<Veccrate::models::ItemFields> | Optional. Specify additional fields of information to return in the output. | ||
| filters | Option<Veccrate::models::ItemFilter> | Optional. Specify additional filters to apply. | ||
| is_favorite | Option<bool> | Optional filter by items that are marked as favorite, or not. userId is required. | ||
| enable_user_data | Option<bool> | Optional, include user data. | ||
| image_type_limit | Option<i32> | Optional, the max number of images to return, per image type. | ||
| enable_image_types | Option<Veccrate::models::ImageType> | Optional. The image types to include in the output. | ||
| exclude_person_types | Option<Vec> | Optional. If specified results will be filtered to exclude those containing the specified PersonType. Allows multiple, comma-delimited. | ||
| person_types | Option<Vec> | Optional. If specified results will be filtered to include only those containing the specified PersonType. Allows multiple, comma-delimited. | ||
| appears_in_item_id | Option<uuid::Uuid> | Optional. If specified, person results will be filtered on items related to said persons. | ||
| user_id | Option<uuid::Uuid> | User id. | ||
| enable_images | Option<bool> | Optional, include image information in output. | [default to true] |
crate::models::BaseItemDtoQueryResult
- Content-Type: Not defined
- Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase
[Back to top] [Back to API list] [Back to Model list] [Back to README]