Skip to content

Commit 176c6f5

Browse files
ehrenfeuehrenfeu
committed
Add mapping table from PUMAPI to pyppms commands
1 parent 7b853bc commit 176c6f5

File tree

1 file changed

+77
-0
lines changed

1 file changed

+77
-0
lines changed

‎MAPPING.md

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Mapping of PUMAPI to `pyppms` commands
2+
3+
Assuming you have instantiated a connection object like:
4+
5+
```Python
6+
import pyppmsconf
7+
from pyppms import ppms
8+
9+
conn = ppms.PpmsConnection(
10+
url=pyppmsconf.PUMAPI_URL,
11+
api_key=pyppmsconf.PPMS_API_KEY,
12+
timeout=pyppmsconf.TIMEOUT,
13+
)
14+
```
15+
16+
| PUMAPI | `pyppms` |
17+
|-----------------------|------------------------------------------|
18+
| addprojectentry | |
19+
| addrebateonsession | |
20+
| addsampleresult | |
21+
| addvalidbcode | |
22+
| auth | (done in `conn`'s constructor) |
23+
| createinc | |
24+
| createorder | |
25+
| createprojectmember | |
26+
| createsys | |
27+
| deleteprojectmember | |
28+
| delvalidbcode | |
29+
| getadmins | `conn.get_admins()` |
30+
| getaffiliationsummary | |
31+
| getbcodes | |
32+
| getbooking | |
33+
| getgroup | `conn.get_group()` |
34+
| getgroupprojects | |
35+
| getgroups | `conn.get_groups()` |
36+
| getgroupusers | `conn.get_group_users()` |
37+
| getinc | |
38+
| getint | |
39+
| getinvoice | |
40+
| getinvoicedetails | |
41+
| getinvoicelist | |
42+
| getinvtracklist | |
43+
| getmanifest | |
44+
| getmanifestlist | |
45+
| getorderlines | |
46+
| getorders | |
47+
| getprepaidaccounts | |
48+
| getpriceslist | |
49+
| getprojectgroups | |
50+
| getprojectmember | |
51+
| getprojects | |
52+
| getprojectusers | |
53+
| getrunningsheet | `conn.get_running_sheet()` |
54+
| getservices | |
55+
| getsessionnote | |
56+
| getsysrights | `conn.get_users_with_access_to_system()` |
57+
| getsystems | `conn.get_systems()` |
58+
| getuser | `conn.get_user()` |
59+
| getuserexp | `conn.get_user_experience()` |
60+
| getuserprojects | |
61+
| getuserrights | |
62+
| getusers | `conn.get_user_ids()` |
63+
| getvalidbcodes | |
64+
| listpubmed | |
65+
| newgroup | |
66+
| newproject | |
67+
| newuser | `conn.new_user()` |
68+
| nextbooking | |
69+
| rightcheck | |
70+
| setinvtracksent | |
71+
| setright | `conn.set_system_booking_permissions()` |
72+
| setsessionnote | |
73+
| updateorderphase | |
74+
| updatesys | |
75+
| updgroup | |
76+
| updproject | |
77+
| upduser | |

0 commit comments

Comments
 (0)