pub struct PersonRelationshipTypesResource<'a> { /* private fields */ }Expand description
client.person().relationship_types()
Implementations§
Source§impl<'a> PersonRelationshipTypesResource<'a>
impl<'a> PersonRelationshipTypesResource<'a>
Sourcepub fn create(&self, body: &RelationshipTypeCreate) -> Result<RelationshipType>
pub fn create(&self, body: &RelationshipTypeCreate) -> Result<RelationshipType>
Create a person relationship type
POST /person/relationshiptypes
Creates a relationship-type catalog definition. Requires “edit masterdata” permission in churchdb.
§Example
let body = models::RelationshipTypeCreate {
degree_name_a: "Parent".into(),
degree_name_b: "Child".into(),
security_level_id: 1,
..Default::default()
};
let result = client.person().relationship_types().create(&body)?;
println!("{:?}", result.name);Sourcepub fn delete(&self, id: impl Display) -> Result<()>
pub fn delete(&self, id: impl Display) -> Result<()>
Delete a relationship type and its person relationships
DELETE /person/relationshiptypes/{id}
Deletes the relationship-type definition and every stored person-to-person relationship referencing it. Requires “edit masterdata” permission in churchdb. Types with the built-in nodelete flag cannot be deleted.
Use Self::delete_with to pass query parameters.
§Example
client.person().relationship_types().delete(4)?;Sourcepub fn delete_with(
&self,
id: impl Display,
query: &DeletePersonRelationshiptypesIdQuery,
) -> Result<()>
pub fn delete_with( &self, id: impl Display, query: &DeletePersonRelationshiptypesIdQuery, ) -> Result<()>
Delete a relationship type and its person relationships
Like Self::delete, with query parameters.
DELETE /person/relationshiptypes/{id}
Deletes the relationship-type definition and every stored person-to-person relationship referencing it. Requires “edit masterdata” permission in churchdb. Types with the built-in nodelete flag cannot be deleted.
Sourcepub fn get(&self, id: impl Display) -> Result<RelationshipType>
pub fn get(&self, id: impl Display) -> Result<RelationshipType>
Get a person relationship type
GET /person/relationshiptypes/{id}
Returns one relationship-type catalog definition, not a relationship between two persons.
§Example
let relationship_type = client.person().relationship_types().get(4)?;
println!("{:?}", relationship_type.name);Sourcepub fn list(&self) -> Result<Vec<RelationshipType>>
pub fn list(&self) -> Result<Vec<RelationshipType>>
List person relationship types
GET /person/relationshiptypes
Lists relationship-type definitions, ordered by sortKey and stored name. This is a catalog, not the relationships between individual persons.
§Example
for relationship_type in client.person().relationship_types().list()? {
println!("{:?}", relationship_type.name);
}Sourcepub fn update(
&self,
id: impl Display,
body: &RelationshipTypeUpdate,
) -> Result<RelationshipType>
pub fn update( &self, id: impl Display, body: &RelationshipTypeUpdate, ) -> Result<RelationshipType>
Update a person relationship type
PUT /person/relationshiptypes/{id}
Replaces the editable fields of an existing relationship-type definition. Requires “edit masterdata” permission in churchdb. Existing person-to-person relationships retain their IDs and use the updated definition.
§Example
let body = models::RelationshipTypeUpdate {
degree_name_a: "Parent".into(),
degree_name_b: "Child".into(),
security_level_id: 1,
..Default::default()
};
let result = client.person().relationship_types().update(4, &body)?;
println!("{:?}", result.name);