API protocol documents.

* wip, transferred over from old system so some documentation might be lacking
  or out of date for the general system.

Documentation/API-acos.txt

@@ -0,0 +1,210 @@
+org_db
+org_db/create
+org_db/read
+org_db/update
+org_db/delete
+org_db/user_card
+org_db/user_card/create
+org_db/user_card/read
+org_db/user_card/update
+org_db/user_card/delete
+org_db/user_card/create/SUPERUSERS
+org_db/user_card/create/ORG
+org_db/user_card/create/SCHOOL
+org_db/user_card/create/GOV
+org_db/user_card/create/ORGINT
+org_db/user_card/create/ORGTEST
+org_db/user_card/read/SUPERUSERS
+org_db/user_card/read/ORG
+org_db/user_card/read/SCHOOL
+org_db/user_card/read/GOV
+org_db/user_card/read/ORGINT
+org_db/user_card/read/ORGTEST
+org_db/user_card/update/SUPERUSERS
+org_db/user_card/update/ORG
+org_db/user_card/update/SCHOOL
+org_db/user_card/update/GOV
+org_db/user_card/update/ORGINT
+org_db/user_card/update/ORGTEST
+org_db/user_card/delete/SUPERUSERS
+org_db/user_card/delete/ORG
+org_db/user_card/delete/SCHOOL
+org_db/user_card/delete/GOV
+org_db/user_card/delete/ORGINT
+org_db/user_card/delete/ORGTEST
+org_db/user_pass
+org_db/user_pass/create
+org_db/user_pass/read
+org_db/user_pass/update
+org_db/user_pass/delete
+org_db/user_pass/create/SUPERUSERS
+org_db/user_pass/create/ORG
+org_db/user_pass/create/SCHOOL
+org_db/user_pass/create/GOV
+org_db/user_pass/create/ORGINT
+org_db/user_pass/create/ORGTEST
+org_db/user_pass/read/SUPERUSERS
+org_db/user_pass/read/ORG
+org_db/user_pass/read/SCHOOL
+org_db/user_pass/read/GOV
+org_db/user_pass/read/ORGINT
+org_db/user_pass/read/ORGTEST
+org_db/user_pass/update/SUPERUSERS
+org_db/user_pass/update/ORG
+org_db/user_pass/update/SCHOOL
+org_db/user_pass/update/GOV
+org_db/user_pass/update/ORGINT
+org_db/user_pass/update/ORGTEST
+org_db/user_pass/delete/SUPERUSERS
+org_db/user_pass/delete/ORG
+org_db/user_pass/delete/SCHOOL
+org_db/user_pass/delete/GOV
+org_db/user_pass/delete/ORGINT
+org_db/user_pass/delete/ORGTEST
+org_db/admins
+org_db/admins/create
+org_db/admins/read
+org_db/admins/update
+org_db/admins/delete
+org_db/admins/create/SUPERUSERS
+org_db/admins/create/ORG
+org_db/admins/create/SCHOOL
+org_db/admins/create/GOV
+org_db/admins/create/ORGINT
+org_db/admins/create/ORGTEST
+org_db/admins/read/SUPERUSERS
+org_db/admins/read/ORG
+org_db/admins/read/SCHOOL
+org_db/admins/read/GOV
+org_db/admins/read/ORGINT
+org_db/admins/read/ORGTEST
+org_db/admins/update/SUPERUSERS
+org_db/admins/update/ORG
+org_db/admins/update/SCHOOL
+org_db/admins/update/GOV
+org_db/admins/update/ORGINT
+org_db/admins/update/ORGTEST
+org_db/admins/delete/SUPERUSERS
+org_db/admins/delete/ORG
+org_db/admins/delete/SCHOOL
+org_db/admins/delete/GOV
+org_db/admins/delete/ORGINT
+org_db/admins/delete/ORGTEST
+org_db/users
+org_db/users/create
+org_db/users/read
+org_db/users/update
+org_db/users/delete
+org_db/users/create/SUPERUSERS
+org_db/users/create/ORG
+org_db/users/create/SCHOOL
+org_db/users/create/GOV
+org_db/users/create/ORGINT
+org_db/users/create/ORGTEST
+org_db/users/read/SUPERUSERS
+org_db/users/read/ORG
+org_db/users/read/SCHOOL
+org_db/users/read/GOV
+org_db/users/read/ORGINT
+org_db/users/read/ORGTEST
+org_db/users/update/SUPERUSERS
+org_db/users/update/ORG
+org_db/users/update/SCHOOL
+org_db/users/update/GOV
+org_db/users/update/ORGINT
+org_db/users/update/ORGTEST
+org_db/users/delete/SUPERUSERS
+org_db/users/delete/ORG
+org_db/users/delete/SCHOOL
+org_db/users/delete/GOV
+org_db/users/delete/ORGINT
+org_db/users/delete/ORGTEST
+org_db/rule_mappings
+org_db/rule_mappings/create
+org_db/rule_mappings/read
+org_db/rule_mappings/update
+org_db/rule_mappings/delete
+org_db/rule_mappings/create/SUPERUSERS
+org_db/rule_mappings/create/ORG
+org_db/rule_mappings/create/SCHOOL
+org_db/rule_mappings/create/GOV
+org_db/rule_mappings/create/ORGINT
+org_db/rule_mappings/create/ORGTEST
+org_db/rule_mappings/read/SUPERUSERS
+org_db/rule_mappings/read/ORG
+org_db/rule_mappings/read/SCHOOL
+org_db/rule_mappings/read/GOV
+org_db/rule_mappings/read/ORGINT
+org_db/rule_mappings/read/ORGTEST
+org_db/rule_mappings/update/SUPERUSERS
+org_db/rule_mappings/update/ORG
+org_db/rule_mappings/update/SCHOOL
+org_db/rule_mappings/update/GOV
+org_db/rule_mappings/update/ORGINT
+org_db/rule_mappings/update/ORGTEST
+org_db/rule_mappings/delete/SUPERUSERS
+org_db/rule_mappings/delete/ORG
+org_db/rule_mappings/delete/SCHOOL
+org_db/rule_mappings/delete/GOV
+org_db/rule_mappings/delete/ORGINT
+org_db/rule_mappings/delete/ORGTEST
+org_db/user_card/userid
+org_db/user_pass/userid
+org_db/admins/userid
+org_db/users/userid
+api
+api/AdminGetCard
+api/AdminGetCards
+api/AdminGetUser
+api/AdminGetPassesOnCard
+api/AdminGetPendingQueue
+api/AdminUpdatePass
+api/AdminUpdateCard
+api/AdminUpdateUser
+api/AdminAddPass
+api/AdminAddCard
+api/AdminAddUser
+api/AdminRemovePass
+api/AdminRemoveUser
+api/AdminRemoveCard
+api/AdminTransferCard
+api/AdminAddAdmin
+api/AdminRemoveAdmin
+api/AdminUpdateAdmin
+api/AdminGetPass
+api/AdminGetAdmin
+api/AdminProcessPendingQueue
+api/AdminRemovePendingQueue
+api/AdminCreateCardBlock
+api/AdminCreateCard
+api/AdminSetUser
+api/AdminSetAdmin
+api/AdminRemovePasses
+api/AdminTransferPass
+api/AdminAddCardToUser
+api/AdminRemoveCardFromUser
+api/AdminGetAdminPermissions
+api/AdminAddAdminPermissions
+api/AdminRemoveAdminPermissions
+api/AdminGetCustomCard
+api/AdminSearchCards
+api/AdminSearchUsers
+api/AdminSearchAdmins
+api/AdminGetPassOptions
+api/AddUser
+api/GetUser
+api/SetUser
+api/GetCard
+api/GetCards
+api/AddCard
+api/RemoveCard
+api/RemovePass
+api/GetPassesOnCard
+api/GetPass
+api/TransferPass
+api/AddPass
+api/SendEmailVerification
+api/SendEmailPasswordReset
+api/PasswordReset
+api/Log
+api/GetCardPricePoints

Documentation/API-aros.txt

@@ -0,0 +1,9 @@
+admins
+admins/org
+admins/school0
+admins/school1
+admins/org_test
+admins/school0_test
+admins/school1_test
+admins/testadmin
+users