https://github.com/simonit/renz-tanzplaner-java-sdk
https://github.com/simonit/renz-tanzplaner-java-sdk
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/simonit/renz-tanzplaner-java-sdk
- Owner: SimonIT
- Created: 2022-02-27T21:40:12.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-01T00:28:29.000Z (over 4 years ago)
- Last Synced: 2025-01-24T17:18:16.726Z (over 1 year ago)
- Language: Java
- Size: 104 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# renz-tanzplaner-java-sdk
Tanzplaner
- API version: 1.0
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*
## Requirements
Building the API client library requires:
1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)
## Installation
To install the API client library to your local Maven repository, simply execute:
```shell
mvn clean install
```
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
```shell
mvn clean deploy
```
Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
### Maven users
Add this dependency to your project's POM:
```xml
de.tanzschulerenz.tanzplaner
renz-tanzplaner-java-sdk
1.0
compile
```
### Gradle users
Add this dependency to your project's build file:
```groovy
repositories {
mavenCentral() // Needed if the 'renz-tanzplaner-java-sdk' jar has been published to maven central.
mavenLocal() // Needed if the 'renz-tanzplaner-java-sdk' jar has been published to the local maven repo.
}
dependencies {
implementation "de.tanzschulerenz.tanzplaner:renz-tanzplaner-java-sdk:1.0"
}
```
### Others
At first generate the JAR by executing:
```shell
mvn clean package
```
Then manually install the following JARs:
* `target/renz-tanzplaner-java-sdk-1.0.jar`
* `target/lib/*.jar`
## Getting Started
Please follow the [installation](#installation) instruction and execute the following Java code:
```java
// Import classes:
import de.tanzschulerenz.tanzplaner.client.ApiClient;
import de.tanzschulerenz.tanzplaner.client.ApiException;
import de.tanzschulerenz.tanzplaner.client.Configuration;
import de.tanzschulerenz.tanzplaner.client.models.*;
import de.tanzschulerenz.tanzplaner.client.api.DefaultApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://www.tanzschule-renz.de/tanzplaner");
DefaultApi apiInstance = new DefaultApi(defaultClient);
Integer id = 56; // Integer |
Integer withEntries = 1; // Integer |
String category = "category_example"; // String |
Integer showEntryDetails = 1; // Integer |
try {
CoursesResponse result = apiInstance.coursesGet(id, withEntries, category, showEntryDetails);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#coursesGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
```
## Documentation for API Endpoints
All URIs are relative to *https://www.tanzschule-renz.de/tanzplaner*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**coursesGet**](docs/DefaultApi.md#coursesGet) | **GET** /courses/ |
*DefaultApi* | [**entriesGet**](docs/DefaultApi.md#entriesGet) | **GET** /entries/ |
*DefaultApi* | [**entriesViewIdGet**](docs/DefaultApi.md#entriesViewIdGet) | **GET** /entries/view/{id} |
## Documentation for Models
- [Course](docs/Course.md)
- [CoursesResponse](docs/CoursesResponse.md)
- [EntriesResponse](docs/EntriesResponse.md)
- [Entry](docs/Entry.md)
- [EntryResponse](docs/EntryResponse.md)
- [Info](docs/Info.md)
- [Locationinfo](docs/Locationinfo.md)
## Documentation for Authorization
All endpoints do not require authorization.
Authentication schemes defined for the API:
## Recommendation
It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
## Author