Newer
Older
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
<wsdl:output message="tns:userExistsResponse" />
<wsdl:fault name="authenticationFault" message="tns:authenticationFault" />
</wsdl:operation>
<wsdl:operation name="getNames">
<wsdl:documentation>
Returns user records for a list of ePPNs
<ul>
<li>
<b>Input Parameters</b>
getNamesRequest, with elements
<ul>
<li>auth - String, SessionID of user that wants to query for
names</li>
<li>log - String,</li>
<li>ePPN - List of Strings</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
getNamesResponse. It contains 0...n userDetails, which themselves
have elements
<ul>
<li>ePPN - String holding ePPN of user </li>
<li>name - String holding Name (cn) of user </li>
<li>mail - String holding E-Mail address of user </li>
<li>organisation - String holding user' affiliation </li>
<li>agreesearch - Boolean, whether user wants his ID to be found
be a search for name or mail address </li>
<li>usersupplieddata - Boolean, whether user himself or his
organisation supplied these data </li>
</ul>
</li>
<li>
<b>Faults</b>
none
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:getNamesRequest" />
<wsdl:output message="tns:getNamesResponse" />
</wsdl:operation>
<wsdl:operation name="getIDs">
<wsdl:documentation>
Returns user records for a name or mail address.
<ul>
<li>
<b>Input Parameters</b>
getIDsRequest, with elements
<ul>
<li>auth - String, SessionID of user that wants to query for
names</li>
<li>log - String,</li>
<li>name - String with Name</li>
<li>mail - String with E-Mail Address</li>
<li>organisation - String with Organisation</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
getIDsResponse. It contains 0...n userDetails, which themselves
have elements
<ul>
<li>ePPN - String holding ePPN of user </li>
<li>name - String holding Name (cn) of user </li>
<li>mail - String holding E-Mail address of user </li>
<li>organisation - String holding user' affiliation </li>
<li>agreesearch - Boolean, whether user wants his ID to be found
be a search for name or mail address </li>
<li>usersupplieddata - Boolean, whether user himself or his
organisation supplied these data </li>
</ul>
</li>
<li>
<b>Faults</b>
none
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:getIDsRequest" />
<wsdl:output message="tns:getIDsResponse" />
</wsdl:operation>
<wsdl:operation name="getObjects">
<wsdl:documentation>
Returns URIs of all resources in project. Caller must have
some role
in the project.
<ul>
<li>
<b>Input Parameters</b>
getObjectsRequest, with elements
<ul>
<li>auth - String, SessionID of user</li>
<li>log - String for log information, optional</li>
<li>project - String with projectID</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
resourcesetResponse, with element
<ul>
<li>resource - String with URI of resource in
project. Can occur
multiple times</li>
</ul>
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:getObjectsRequest" />
<wsdl:output message="tns:getObjectsResponse" />
</wsdl:operation>
<wsdl:operation name="tgCheckAccess">
<wsdl:documentation>
Returns access decision for given operation on given resource
for
session.
<ul>
<li>
<b>Input Parameters</b>
tgCheckAccessRequest, with elements
<ul>
<li>auth - String, SessionID of user (or service) that
wants to
intitiate the check</li>
<li>log - String for log information, optional</li>
<li>
sid - String, SessionID of user for whom the check
is to be done.
Leave empty if check is to be done for
user's own session given
under
<em>auth</em>
</li>
<li>operation - String, such as "read", "write"</li>
<li>resource - String, name of project or role, or URI of
TgObject resource</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
booleanResponse, with element
<ul>
<li>result - boolean, true if operation was successful,
false
otherwise</li>
</ul>
</li>
<li>
<b>Faults</b>
<ul>
<li>unknownResourceFault</li>
</ul>
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:tgCheckAccessRequest" />
<wsdl:output message="tns:tgCheckAccessResponse" />
<wsdl:fault name="unknownResourceFault" message="tns:unknownResourceFault" />
</wsdl:operation>
<wsdl:operation name="tgAssignedRoles">
<wsdl:documentation>
Returns the roles the requesting user has, in any project. Can
be
called for another user by project leaders, then roles will
be
limited to the intersection of those projects
where
<em>auth</em>
is leader AND
<em>username</em>
has some
role in.
<ul>
<li>
<b>Input Parameters</b>
tgAssignedRolesRequest, with elements
<ul>
<li>auth - String, SessionID of user that wants to
query for roles</li>
<li>log - String for log information, optional</li>
<li>username - String, ePPN of user for whom the
query is to be
done. Can be empty.</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
rolesetResponse, with element
<ul>
<li>role - String with full-qualified role name of the
role. The
full-qualified role name has the form
"Administrator,TGPR3,Projekt-Teilnehmer". Can occur
multiple
times.</li>
</ul>
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:tgAssignedRolesRequest" />
<wsdl:output message="tns:tgAssignedRolesResponse" />
</wsdl:operation>
<wsdl:operation name="tgAssignedProjects">
<wsdl:documentation>
Returns projectIDs of all projects the user has some role in.
<ul>
<li>
<b>Input Parameters</b>
tgAssignedProjectsRequest, with elements
<ul>
<li>auth - String, SessionID of user that wants to
query for roles</li>
<li>log - String for log information, optional</li>
<li>
level - Integer. Can be either empty (= level 0) or one of
the
following:
<ul>
<li>0 - Returns all projects the user has any
role in (default).</li>
<li>
1 - Returns only projects where the user has
read access, i.e.
<ul>
<li>she is Beobachter
(observer) or</li>
<li>she is Bearbeiter (editor)
or</li>
<li>there are any public resources in the
project</li>
</ul>
</li>
<li>2 - like level 1, but public resources do not
count</li>
<li>3 - Returns only projects where the user has
write access,
i.e. she is Bearbeiter (editor)</li>
<li>4 - Returns only projects where the user has
delegate
access, i.e. she is Projektleiter (project
leader)</li>
</ul>
</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
rolesetResponse, with element
<ul>
<li>role - String with projectID (no full-qualified role
name is
needed here). Can occur multiple times.</li>
</ul>
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:tgAssignedProjectsRequest" />
<wsdl:output message="tns:tgAssignedProjectsResponse" />
</wsdl:operation>
<wsdl:operation name="getAllProjects">
<wsdl:documentation>
Returns all projects stored in this RBAC instance with ID,
name, and
description. See also getProjectDescription().
<ul>
<li>
<b>Input Parameters</b>
getAllProjectsRequest, with elements
<ul>
<li>auth - String, SessionID of user that wants to query
for
projects. Can be omitted as this information can be
reviewed
publicly</li>
<li>log - String for log information, optional</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
getAllProjectsResponse, with element
<ul>
<li>
project - projectInfo, can occur multiple
times.
<br />
The type projectInfo consists of the following elements:
<ul>
<li>id - String, project ID, such as "TGPR123"</li>
<li>description - String, project description</li>
<li>name - String, project name</li>
<li>file - String with URI of project file for
project-specific
settings. </li>
</ul>
</li>
</ul>
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:getAllProjectsRequest" />
<wsdl:output message="tns:getAllProjectsResponse" />
</wsdl:operation>
<wsdl:operation name="getDeactivatedProjects">
<wsdl:documentation>
Returns all projects stored in this RBAC instance with ID,
name, and
description that are deactivated and can be
reactivated by the
current user.
<ul>
<li>
<b>Input Parameters</b>
getAllProjectsRequest, with elements
<ul>
<li>auth - String, SessionID of user that wants to query
for
projects. Can be omitted as this information can be
reviewed
publicly</li>
<li>log - String for log information, optional</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
getDeactivatedProjectsResponse, with element
<ul>
<li>
project - projectInfo, can occur multiple
times.
<br />
The type projectInfo consists of the following elements:
<ul>
<li>id - String, project ID, such as "TGPR123"</li>
<li>description - String, project description</li>
<li>name - String, project name</li>
<li>file - String with URI of project file for
project-specific
settings. </li>
</ul>
</li>
</ul>
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:getDeactivatedProjectsRequest" />
<wsdl:output message="tns:getDeactivatedProjectsResponse" />
</wsdl:operation>
<wsdl:operation name="getLeader">
<wsdl:documentation>
Returns Project Leader/s (i.e. who have delegate right on the
respective project resource).
<ul>
<li>
<b>Input Parameters</b>
getLeaderRequest, with elements
<ul>
<li>auth - String, SessionID of user that wants to query
for
projects. Can be omitted as this information can be
reviewed
publicly</li>
<li>log - String for log information, optional</li>
<li>project - String with project ID, such as "TGPR123"</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
usersetResponse, with element
<ul>
<li>username - String holding ePPN of user, can occur
multiple
times.
</li>
</ul>
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:getLeaderRequest" />
<wsdl:output message="tns:getLeaderResponse" />
</wsdl:operation>
<wsdl:operation name="filterBySid">
<wsdl:documentation>
This is tgCheckAccess in batch operation: Returns a list of
the
resources where a given operation with this SessionID is
allowed. The
resource parameter must contain a list of
resources, and the subset
of this list that matches
will be returned.
<ul>
<li>
<b>Input Parameters</b>
filterBySidRequest, with elements
<ul>
<li>auth - String, SessionID of user that wants to
do the check</li>
<li>log - String for log information, optional</li>
<li>resource - String with projectID, or URI of
TgObject resource.
Can occur multiple times.</li>
<li>operation - String, such as "read", "write"</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
filterResponse, with element
<ul>
<li>resource - String with projectID, or URIs that
match. Can
occur multiple times.</li>
</ul>
</li>
<li>
<b>Faults</b>
<ul>
<li>authenticationFault</li>
</ul>
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:filterBySidRequest" />
<wsdl:output message="tns:filterBySidResponse" />
<wsdl:fault name="authenticationFault" message="tns:authenticationFault" />
</wsdl:operation>
<wsdl:operation name="getOwner">
<wsdl:documentation>
Returns ePPN of owner that was set in registerResource. User
must
have read permission on the resource, or resource must be
public.
<ul>
<li>
<b>Input Parameters</b>
getOwnerRequest, with elements
<ul>
<li>auth - String, SessionID of user that wants to query
for the
owner</li>
<li>log - String for log information, optional</li>
<li>resource - String, URI of TgObject</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
getOwnerResponse, with element
<ul>
<li>owner - String, ePPN of owner.</li>
</ul>
</li>
<li>
<b>Faults</b>
<ul>
<li>authenticationFault</li>
</ul>
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:getOwnerRequest" />
<wsdl:output message="tns:getOwnerResponse" />
<wsdl:fault name="authenticationFault" message="tns:authenticationFault" />
</wsdl:operation>
<wsdl:operation name="getMembers">
<wsdl:documentation>
Returns ePPNs of all members in the project, caller must be
member
herself.
<ul>
<li>
<b>Input Parameters</b>
getMembersRequest, with elements
<ul>
<li>auth - String, SessionID of user that wants to query
for
members</li>
<li>log - String for log information, optional</li>
<li>project - String, ProjectID, such as "TGPR123"</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
usersetResponse, with element
<ul>
<li>username - String holding ePPN of user, can occur
multiple
times.</li>
</ul>
</li>
<li>
<b>Faults</b>
<ul>
<li>authenticationFault</li>
</ul>
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:getMembersRequest" />
<wsdl:output message="tns:getMembersResponse" />
<wsdl:fault name="authenticationFault" message="tns:authenticationFault" />
</wsdl:operation>
<wsdl:operation name="getUserRole">
<wsdl:documentation>
Returns ePPNs plus Array of Roles of all members in the project,
caller must be member herself.
<ul>
<li>
<b>Input Parameters</b>
getUserRoleRequest, with elements
<ul>
<li>auth - String, SessionID of user that wants to query
for roles</li>
<li>log - String for log information, optional</li>
<li>project - String, ProjectID, such as "TGPR123"</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
getUserRoleResponse. It contains 0...n userRoles, which themselves
have elements
<ul>
<li>username - String holding ePPN of user </li>
<li>roles - array of Strings with roles the user has (e.g.
"Bearbeiter").</li>
</ul>
</li>
<li>
<b>Faults</b>
<ul>
<li>authenticationFault</li>
<li>unknownProjectFault</li>
</ul>
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:getUserRoleRequest" />
<wsdl:output message="tns:getUserRoleResponse" />
<wsdl:fault name="authenticationFault" message="tns:authenticationFault" />
<wsdl:fault name="unknownProjectFault" message="tns:unknownProjectFault" />
</wsdl:operation>
<wsdl:operation name="getFriends">
<wsdl:documentation>
Returns ePPNs of the users the authenticated user has
relations with,
i.e. they are signed into the same project role. Each
user name has a
score which shows how many roles the requester shares
with that user.
<ul>
<li>
<b>Input Parameters</b>
getFriendsRequest, with element
<ul>
<li>auth - String, SessionID of user that wants to query
for
friends</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
getFriendsResponse. It contains 0...n friends, which themselves
have elements
<ul>
<li>username - String holding ePPN of user </li>
<li>score - Integer with the users' number of common roles with
the requester</li>
</ul>
</li>
<li>
<b>Faults</b>
none
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:getFriendsRequest" />
<wsdl:output message="tns:getFriendsResponse" />
</wsdl:operation>
<wsdl:operation name="getRights">
<wsdl:documentation>
Returns permissions for given resource or projectID. Can be
used by
project leaders to check permissions for another
project member.
<ul>
<li>
<b>Input Parameters</b>
getRightsRequest, with elements
<ul>
<li>auth - String, SessionID of user that wants to query
the
rights</li>
<li>log - String for log information, optional</li>
<li>resource - String, URI of TgObject or ProjectID</li>
<li>username - ePPN of user whose rights shall be
queried. Leave
empty to get rights of user authenticated
by the auth parameter.</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
operationsetResponse, with element
<ul>
<li>operation - String with a right, such as "read" or
"delegate". Can occur multiple times.</li>
</ul>
</li>
<li>
<b>Faults</b>
<ul>
<li>authenticationFault</li>
</ul>
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:getRightsRequest" />
<wsdl:output message="tns:getRightsResponse" />
<wsdl:fault name="authenticationFault" message="tns:authenticationFault" />
</wsdl:operation>
<wsdl:operation name="isPublic">
<wsdl:documentation>
Returns status of isPublic flag for a TextGridObject.
<ul>
<li>
<b>Input Parameters</b>
isPublicRequest, with elements
<ul>
<li>auth - String, SessionID of user that wants to
query. Can be
empty.</li>
<li>log - String for log information, optional</li>
<li>resource - String, URI of TgObject</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
booleanResponse, with element
<ul>
<li>result - boolean, true if resource has the isPublic
flag set
to TRUE, i.e. has been published, false
otherwise</li>
</ul>
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:isPublicRequest" />
<wsdl:output message="tns:isPublicResponse" />
</wsdl:operation>
<wsdl:operation name="getNumberOfResources">
<wsdl:documentation>
Returns the total number of resources and the number of public ones
in this project. Can be called by anyone.
<ul>
<li>
<b>Input Parameters</b>
getNumberOfResourcesRequest, with elements
<ul>
<li>auth - String, SessionID of user that wants to
query. Can be
empty.</li>
<li>log - String for log information, optional</li>
<li>project - String</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
getNumberOfResourcesResponse, with elements
<ul>
<li>allresources - integer</li>
<li>publicresources - integer</li>
</ul>
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:getNumberOfResourcesRequest" />
<wsdl:output message="tns:getNumberOfResourcesResponse" />
</wsdl:operation>
<wsdl:operation name="getProjectDescription">
<wsdl:documentation>
Returns name and description of project identified by ID. See
also
getAllProjects().
<ul>
<li>
<b>Input Parameters</b>
getProjectDescriptionRequest, with elements
<ul>
<li>auth - String, SessionID of user. Can be empty.</li>
<li>log - String for log information, optional</li>
<li>project - String, ProjectID</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
getProjectDescriptionResponse, with element
<ul>
<li>
project - projectInfo
<br />
The type projectInfo consists of the following elements:
<ul>
<li>id - String, project ID, such as "TGPR123"</li>
<li>description - String, project description</li>
<li>name - String, project name</li>
<li>file - String with URI of project file for
project-specific
settings. </li>
</ul>
</li>
</ul>
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:getProjectDescriptionRequest" />
<wsdl:output message="tns:getProjectDescriptionResponse" />
</wsdl:operation>
<wsdl:operation name="getSid">
<wsdl:documentation>
Returns some random SessionID suitable for RBAC.
<ul>
<li>
<b>Input Parameters</b>
empty
</li>
<li>
<b>Output Parameters</b>
getSidResponse, with element
<ul>
<li>sid - String, approximately 60-70 bytes long, consisting of
random characters taken from a-zA-Z0-9.</li>
</ul>
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:getSidRequest" />
<wsdl:output message="tns:getSidResponse" />
</wsdl:operation>
<wsdl:operation name="getSupportedUserAttributes">
<wsdl:documentation>TODO</wsdl:documentation>
<wsdl:input message="tns:getSupportedUserAttributesRequest" />
<wsdl:output message="tns:getSupportedUserAttributesResponse" />
</wsdl:operation>
<wsdl:operation name="getMyUserAttributes">
<wsdl:documentation>TODO</wsdl:documentation>
<wsdl:input message="tns:getMyUserAttributesRequest" />
<wsdl:output message="tns:getMyUserAttributesResponse" />
<wsdl:fault name="authenticationFault" message="tns:authenticationFault" />
</wsdl:operation>

Stefan E. Funk
committed
<!-- ############################################################### -->
<!-- ## Port-Type-Definitionen -->
<!-- ############################################################### -->
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
<wsdl:operation name="authenticate">
<wsdl:documentation>
Internal function used by applications to identify themselves (via
shared secret between RBAC and WebAuth).
<ul>
<li>
<b>Input Parameters</b>
authenticateRequest, with elements
<ul>
<li>username - String with name of application</li>
<li>password - String with password for this application</li>
<li>log - String for log information, optional</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
authenticateResponse, with element
<ul>
<li>auth - String, SessionID of authenticated application
(See
getSid() for format.)</li>
</ul>
</li>
<li>
<b>Faults</b>
<ul>
<li>authenticationFault</li>
</ul>
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:authenticateRequest" />
<wsdl:output message="tns:authenticateResponse" />
<wsdl:fault name="authenticationFault" message="tns:authenticationFault" />
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
<wsdl:operation name="createProject">
<wsdl:documentation>
Creates a project. Projects are roles with various sub-roles,
i.e
Leader, Administrator... Creates default roles with
default
permissions:
<table>
<tr>
<td>Role</td>
<td>Right on Project</td>
</tr>
<tr>
<td>Projektleiter (project leader)</td>
<td>delegate</td>
</tr>
<tr>
<td>Administrator</td>
<td>-none-</td>
</tr>
<tr>
<td>Bearbeiter (editor)</td>
<td>create</td>
</tr>
<tr>
<td>Beobachter (observer)</td>
<td>-none-</td>
</tr>
</table>
These permissions can be adapted afterwards. For the rights
on
resources, see registerResource().
<ul>
<li>
<b>Input Parameters</b>
createProjectRequest, with elements
<ul>
<li>auth - String, SessionID of future project
leader</li>
<li>log - String for log information, optional</li>
<li>name - String with name of project</li>
<li>description - String with description of
project</li>
<li>
file - String with URI of project file
-
<em>currently unused, omit or leave empty and use
setProjectFile( ) once the file resource has been
created</em>
</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
createProjectResponse, with element
<ul>
<li>projectId - String with the newly assigned project
ID, such as
"TGPR123"</li>
</ul>
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:createProjectRequest" name="createProjectInput" />
<wsdl:output message="tns:createProjectResponse" />
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
<wsdl:operation name="setProjectFile">
<wsdl:documentation>
Registers the URI of a TextGridObject to be the project file
for
project-specific settings. The URI must be registered at
RBAC
beforehand.
<ul>
<li>
<b>Input Parameters</b>
setProjectFileRequest, with elements
<ul>
<li>auth - String, SessionID of Project Leader</li>
<li>log - String for log information, optional</li>
<li>project - String with projectID</li>
<li>file - String with URI of project file</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
booleanResponse, with element
<ul>
<li>result - boolean, true if operation was successful,
false
otherwise</li>
</ul>
</li>
<li>
<b>Faults</b>
<ul>
<li>authenticationFault</li>
</ul>
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:setProjectFileRequest" />
<wsdl:output message="tns:setProjectFileResponse" />
<wsdl:fault name="authenticationFault" message="tns:authenticationFault" />
</wsdl:operation>
<wsdl:operation name="setName">
<wsdl:documentation>
Supply user-specific information for display instead of the ePPN.
<ul>
<li>
<b>Input Parameters</b>
setNameRequest, with elements
<ul>
<li>auth - String, SessionID of User who wants to set their name</li>
<li>log - String for log information, optional</li>
<li>webAuthSecret - String that is known by the Web
Authentication which will assure that the data are correct. If
the secret is not given, the user entry will be marked as a
volunteered one, where the users gave their details themselves.</li>
<li>name - String with User Name, preferredly in the form of
"givenname surname"</li>
<li>mail - String with User's E-Mail address</li>
<li>organisation - String with Affiliation of the User</li>
<li>agreeSerach - Boolean telling whether the user agrees to be
searchable by the getIDs function.</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
booleanResponse, with element
<ul>
<li>result - boolean, true if operation was successful,
false
otherwise</li>
</ul>
</li>
<li>
<b>Faults</b>
<ul>
</ul>
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:setNameRequest" />
<wsdl:output message="tns:setNameResponse" />
</wsdl:operation>
<wsdl:operation name="addMember">
<wsdl:documentation>
Project leaders can assign users into specific roles. This
still does
not effect
<em>activation</em>
of the role in the
user(s)' session(s).
<ul>
<li>
<b>Input Parameters</b>
addMemberRequest, with elements
<ul>
<li>auth - String, SessionID of project leader</li>
<li>log - String for log information, optional</li>
<li>username - String with ePPN of user to be added</li>
<li>role - String with full-qualified role name of the
role the
user is to be signed into. The full-qualified
role name has the
form
"Administrator,TGPR3,Projekt-Teilnehmer"</li>
</ul>
</li>
<li>
<b>Output Parameters</b>
booleanResponse, with element
<ul>
<li>result - boolean, true if operation was successful,
false
otherwise</li>
</ul>
</li>
<li>
<b>Faults</b>
<ul>
<li>rbacFault</li>
</ul>
</li>
</ul>
</wsdl:documentation>
<wsdl:input message="tns:addMemberRequest" />
<wsdl:output message="tns:addMemberResponse" />
<wsdl:fault name="rbacFault" message="tns:rbacFault" />
</wsdl:operation>
<wsdl:operation name="deleteMember">
<wsdl:documentation>
Project leaders can delete a role from a user. This
still does not
effect
<em>(de-)activation</em>
of the role in the
user(s)' session(s).
<ul>
<li>
<b>Input Parameters</b>
deleteMemberRequest, with elements
<ul>
<li>auth - String, SessionID of project leader</li>
<li>log - String for log information, optional</li>
<li>username - String with ePPN of user to be signed off</li>
<li>role - String with full-qualified role name of the
role the
user is to be signed off. The full-qualified
role name has the
form
"Administrator,TGPR3,Projekt-Teilnehmer"</li>