|
|
# WebServices
|
|
|
|
|
|
Für den Zugriff via WebService ist eine Berechtigung mit WebService-Zugriff für die gewünschte Organisation notwendig.
|
|
|
Ein Demo-Projekt ist auf [Github](https://github.com/scoreg/WebServiceDemoJava) verfügbar.
|
|
|
|
|
|
## REST Services
|
|
|
The base URL for REST services is `ScoregWebServer/services/v1/`
|
|
|
|
|
|
*Authentication*
|
|
|
Currently the authentication credentials are passed as path parameters within the request. The current WebService URL is built up with the pattern `<host>/ScoregWebServer/services/v1/<service>/<method>/<username>/<password>/<organizationId>/<webserviceId>/<parameter>`
|
|
|
Starting with Release 17.03 all REST Services will require authentication via HTTP Basic Auth and passing the Access Key (new and different to the current webServiceId) as HTTP Header accessKey.
|
|
|
For compatibility reasons the current behavior will remain for a while.
|
|
|
|
|
|
See `RestServiceTest` and `RestServiceAuthTest` for details on building the request URL and creating authentication HTTP headers.
|
|
|
|
|
|
### MemberService
|
|
|
The MemberService is located at `/memberV2`. Access is restricted to user roles "WS_MEMBER_TROOP", "WS_MEMBER_DIVISION", "WS_MEMBER_FEDERATION".
|
|
|
|
|
|
#### Method findScoutIdsForOrganization
|
|
|
`https://www.scoreg.at/ScoregWebServer/services/v1/memberV2/findScoutIdsForOrganization`
|
|
|
|
|
|
#### Method findMemberCompleteByScoutId
|
|
|
`https://www.scoreg.at/ScoregWebServer/services/v1/memberV2/findMemberCompleteByScoutId/<scoutId>`
|
|
|
|
|
|
#### Method findMemberByScoutId
|
|
|
`https://www.scoreg.at/ScoregWebServer/services/v1/memberV2/findMemberByScoutId/<scoutId>`
|
|
|
|
|
|
### AusbildungService
|
|
|
The AusbildungService is located at `/ausbildung`. This is used for Division-level API access and limited to users with Role "WS_AUSBILDUNG_DIVISION".
|
|
|
|
|
|
#### Method findScoutIdsForOrganization
|
|
|
`https://www.scoreg.at/ScoregWebServer/services/v1/ausbildung/findScoutIdsForOrganization`
|
|
|
|
|
|
#### Method findMemberByScoutId
|
|
|
`https://www.scoreg.at/ScoregWebServer/services/v1/ausbildung/findMemberByScoutId/<scoutId>`
|
|
|
|
|
|
|