pub struct StatusesResource<'a> { /* private fields */ }Expand description
client.statuses()
Implementations§
Source§impl<'a> StatusesResource<'a>
impl<'a> StatusesResource<'a>
Sourcepub fn create(&self, body: &StatusCreate) -> Result<Status>
pub fn create(&self, body: &StatusCreate) -> Result<Status>
Save new status
POST /statuses
Creates a person-status definition. Requires “edit masterdata” permission in churchdb.
§Example
let body = models::StatusCreate {
name: "Member".into(),
security_level_id: 2,
..Default::default()
};
let result = client.statuses().create(&body)?;
println!("{}", result.name);Sourcepub fn delete(&self, id: impl Display) -> Result<()>
pub fn delete(&self, id: impl Display) -> Result<()>
Delete a status
DELETE /statuses/{id}
Deletes the status definition after checking dependent references. Requires “edit masterdata” permission in churchdb. Person assignments and other configuration can block deletion.
§Example
client.statuses().delete(1)?;Sourcepub fn get(&self, id: impl Display) -> Result<Status>
pub fn get(&self, id: impl Display) -> Result<Status>
Get a specific status
GET /statuses/{id}
Returns one person-status definition, including its translated name and abbreviation.
§Example
let status = client.statuses().get(1)?;
println!("{}", status.name);Sourcepub fn list(&self) -> Result<Vec<Status>>
pub fn list(&self) -> Result<Vec<Status>>
Get all statuses
GET /statuses
Returns all person-status definitions, ordered by sortKey and then name.
§Example
for status in client.statuses().list()? {
println!("{}", status.name);
}Sourcepub fn patch(&self, id: impl Display, body: &StatusUpdate) -> Result<Status>
pub fn patch(&self, id: impl Display, body: &StatusUpdate) -> Result<Status>
Update status
PATCH /statuses/{id}
Updates the supplied fields of the specified person-status definition. Requires “edit masterdata” permission in churchdb. Omitted fields remain unchanged.
§Example
let body = models::StatusUpdate {
name: Some("Member".into()),
..Default::default()
};
let result = client.statuses().patch(1, &body)?;
println!("{}", result.name);Sourcepub fn update(&self, id: impl Display, body: &StatusCreate) -> Result<Status>
👎Deprecated: PUT /statuses/{id} is deprecated in the ChurchTools API. Use PATCH /statuses/{id} instead.
pub fn update(&self, id: impl Display, body: &StatusCreate) -> Result<Status>
PUT /statuses/{id} is deprecated in the ChurchTools API. Use PATCH /statuses/{id} instead.
Update status
PUT /statuses/{id}
Replaces a person-status definition. Requires “edit masterdata” permission in churchdb. Existing persons retain the status ID. Use PATCH /statuses/{id} instead.
§Example
let body = models::StatusCreate {
name: "Member".into(),
security_level_id: 2,
..Default::default()
};
let result = client.statuses().update(1, &body)?;
println!("{}", result.name);