Guide: REST-API for accounting and resource management: Difference between revisions
Created page with "The bwCloud-OS provides an RESTful API that allows our customers to overview and manage the accounting data and resources of their memebers. == Testing == {| class="mw-message-box mw-message-box-warning" | style="vertical-align:middle;" |'''⚠️ Please Note:''' This API-Service is in a late testing phase and will be available soon. |} == Entitlement == === Entitlement validation === This endpoint can be used for validating syntax and checking the interpretation of a..." |
No edit summary |
||
| Line 1: | Line 1: | ||
The bwCloud-OS provides an RESTful API that allows our customers to overview and manage the accounting data and resources of their memebers. | The bwCloud-OS provides an RESTful API that allows our customers to overview and manage the accounting data and resources of their memebers. | ||
== Entitlement == | == Entitlement == | ||
=== Entitlement validation === | === Entitlement validation === | ||
This endpoint can be used for validating syntax and checking the interpretation of an entitlement string. | {| class="mw-message-box mw-message-box-warning" | ||
| style="vertical-align:middle;" |'''⚠️ Please Note:''' This endpoint is in a late testing phase and will be available soon. | |||
|}This endpoint can be used for validating syntax and checking the interpretation of an entitlement string. | |||
==== Entitlement validation example 2 ==== | ==== Entitlement validation example 2 ==== | ||
| Line 31: | Line 28: | ||
=== Eligibility validation === | === Eligibility validation === | ||
This endpoint can be used for validating syntax and checking the interpretation of eligibility data. | {| class="mw-message-box mw-message-box-warning" | ||
| style="vertical-align:middle;" |'''⚠️ Please Note:''' This endpoint is in a late testing phase and will be available soon. | |||
|}This endpoint can be used for validating syntax and checking the interpretation of eligibility data. | |||
'''Eligibility validation example 1''' | '''Eligibility validation example 1''' | ||
Revision as of 08:08, 29 January 2026
The bwCloud-OS provides an RESTful API that allows our customers to overview and manage the accounting data and resources of their memebers.
Entitlement
Entitlement validation
This endpoint can be used for validating syntax and checking the interpretation of an entitlement string.
Entitlement validation example 2
JSON Data: {"entitlement": "urn:geant:dfn.de:bwidm:bwcloud-os:group:xtiny_1:hfu_netze2"}
Return: {'quota_flavor': 'xtiny_1', 'cost_center_id': 'hfu_netze2', 'first_day_of_validation': '2025-12-19', 'last_day_of_validation': 'inf', 'max_number_of_booking_units': 'inf'}
Entitlement validation example 2
JSON Data: {"entitlement": "urn:geant:dfn.de:bwidm:bwcloud-os:group:xtiny_1:hfu_netze2"}
Return: {'quota_flavor': 'xtiny_1', 'cost_center_id': 'hfu_netze2', 'first_day_of_validation': '2026-02-01', 'last_day_of_validation': '2027-01-31', 'max_number_of_booking_units': 'inf'}
Entitlement validation example 3
JSON Data: {"entitlement": "urn:geant:dfn.de:bwidm:bwcloud-os:group:xtiny_1:hfu_netze2:null:2027-01-32:null"}
Return: Error parsing eligibility. Invalid last day of validation format: 2027-01-32.
Eligibility
Eligibility validation
This endpoint can be used for validating syntax and checking the interpretation of eligibility data.
Eligibility validation example 1
JSON Data: {"quota_flavor": "large_1", "cost_center_id": "student", "first_day": "2026-01-01", "last_day": "2026-12-31", "max_booking_units": 5000}
Return: {'quota_flavor': 'large_1', 'cost_center_id': 'student', 'first_day_of_validation': '2026-01-01', 'last_day_of_validation': '2026-12-31', 'max_number_of_booking_units': 5000}
Eligibility validation example 2
JSON Data: {"quota_flavor": "large_1", "cost_center_id": "student", "first_day": "2026-01-01", "last_day": "2027-12-32", "max_booking_units": 5000}
Return: Error parsing eligibility. Invalid last day of validation format: 2027-01-32.