TravelTrack:CommunicationAPI
From OpenBrainstem
The basic communications API for TravelTrack will be built on XML-RPC using SSL/TLS encrypted HTTP. The plan is to not support unencrypted connections.
Contents |
[edit] API Call List
This is the preliminary list of communication API calls. At this time, the communications API is still very much in flux and will most likely change, perhaps dramitically:
[edit] Data Interactions
These calls handle all data entry and retrieval for itineraries, transactions, expense reports, locations and reviews.
- GetEventList
- GetEvent
- GetItineraryList
- GetItineraryItem
- GetTransactionList
- GetTransaction
- GetExpenseReportsList
- GetExpenseReport
- GetLocationsList
- GetLocation
- GetReviewsList
- GetReview
- NewEvent
- NewItineraryItem
- NewTransaction
- NewExpenseReport
- NewLocation
- NewReview
- UpdateEvent
- UpdateItineraryItem
- UpdateTransaction
- UpdateExpenseReport
- UpdateLocation
- UpdateReview
- DeleteEvent
- DeleteItineraryItem
- DeleteTransaction
- DeleteExpenseReport
- DeleteLocation
- DeleteReview
[edit] User Management
All user administration is managed via the TravelTrack Client
- GetUsersList
- GetUsers
- GetGroupsList
- GetGroups
- NewUser
- NewGroup
- UpdateUser
- UpdateGroup
- DeleteUser
- DeleteGroup
I am considering implementing an ACL permissions system. If I do, these calls will be implemented to support it:
- GetACLsList
- GetACLs
- ProcessACLMatch (this one means that server logic will make the decision, which might be useful to test for access)
[edit] Server Configuration
This includes calls to support features such as expense report manager sign-off document flow. There are also several server-side configuration options, such as whether delete operations actually remove data from the DB or not.
[edit] Data Processing
Miscellaneous reports and other maintenance type chores.
