Rust API client for p7m-alarm

API for generating and tracking alarms

This is the API of what P7M mainly uses within the Telfas service.

For most endpoints, the caller has to be authenticated with the system and provide a JWT token in the Authorization header of the HTTP request. If your interacting with this API using the Swagger interface, you need to set the JWT token by clicking on the Authorize button on the right side of the header. As the value don't forget that the Authorization header starts with the fixed value Bearer followed by a space followed by the actual JWT token value.

If anything is unclear or you found a bug in the documentation, please contact tech@p7m.de.

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

Installation

Put the package under your project folder in a directory named p7m-alarm and add the following to Cargo.toml under [dependencies]:

p7m-alarm = { path = "./p7m-alarm" }

Documentation for API Endpoints

All URIs are relative to https://alarm.api.p7m.de/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AlarmApi | alarmsget | GET /alarms | *AlarmApi* | alarmsiddelete | DELETE /alarms/{id} | *AlarmApi* | alarmsidget | GET /alarms/{id} | *AlarmApi* | alarmsidput | PUT /alarms/{id} | *AlarmApi* | alarmspost | POST /alarms | AlarmRecipientApi | alarmsaidrecipientsget | GET /alarms/{aid}/recipients | *AlarmRecipientApi* | alarmsaidrecipientsiddelete | DELETE /alarms/{aid}/recipients/{id} | *AlarmRecipientApi* | alarmsaidrecipientsidget | GET /alarms/{aid}/recipients/{id} | *AlarmRecipientApi* | alarmsaidrecipientsidput | PUT /alarms/{aid}/recipients/{id} | *AlarmRecipientApi* | alarmsaidrecipientspost | POST /alarms/{aid}/recipients | AlarmTypeApi | alarmtypesget | GET /alarmtypes | *AlarmTypeApi* | alarmtypesiddelete | DELETE /alarmtypes/{id} | *AlarmTypeApi* | alarmtypesidget | GET /alarmtypes/{id} | *AlarmTypeApi* | alarmtypesidput | PUT /alarmtypes/{id} | *AlarmTypeApi* | alarmtypespost | POST /alarmtypes |

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author