This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
intogolf_api [2013/05/23 14:22] richard created |
intogolf_api [2013/12/17 13:24] (current) richard |
||
---|---|---|---|
Line 1: | Line 1: | ||
===== Intogolf API ===== | ===== Intogolf API ===== | ||
- | De backend is available at https://backend.ikgagolfen.nl | + | De backend is available at https://backend.intogolf.com |
- | The interface can be accessed with normal use of the HTTP protocol and will return JSON formattted data. | + | The interface can be accessed with normal use of the HTTP protocol and will return JSON formatted data. |
There is no session or any other storage of user related data available. This means that each request will always have to provide all parameters needed. | There is no session or any other storage of user related data available. This means that each request will always have to provide all parameters needed. | ||
Each authorized company will receive an authorisation code which should be dealt with care. The authorisation code will be passed with each request to enable the backend to verify the origin of the request. | Each authorized company will receive an authorisation code which should be dealt with care. The authorisation code will be passed with each request to enable the backend to verify the origin of the request. | ||
- | ^/igg/ ^^ | + | ^/itg/ ^^ |
- | |[[login]] |user login interface| | + | |[[computers]]|retrieve list of computer accounts| |
- | |[[courses]] |obtain a list of available golfcourses| | + | |[[employees]]|retrieve list of user accounts| |
- | |[[courseloops]] |retrieve a list of golfcourses with their courseloops (golfcourse sections of 9 holes)| | + | |[[getflight]] |retrieve teetime reservation data| |
- | |[[coursestatus]] |retrieve a list of golfcourses with information about cosures and condition of the course| | + | |[[checkinplayer]] |check in or un-checkin a player within a flight/tee reservation| |
- | |[[teetimes]] |get available teetimes| | + | |[[getrelationbalance]]|retrieve current balance of predeposited money for a relation| |
- | |[[coplayers]] |In order to make a teetime reservation, the booker needs to provide the names of his co-players. Retrieve a lists of possible co-players| | + | |[[paymethods]]|retrieve list of available paymethods| |
- | |[[invitationoptions]] |Instead of assigning a co-player, users can also book a teetime and invite other people to come join them. This API will give you a list of available options| | + | |[[warehouses]]|retrieve list of available warehouses| |
- | |[[bookteetime]] |book a teetime| | + | |[[getrelations]]|retrieve list of updated relation data (1 relation, all relations or updates since date)| |
- | |[[cancelteetime]] |cancel a teetime| | + | |[[getmembers]]|retrieve list of updated member data (1 member, all members or updates since date)| |
- | |[[getteetime]] |Retrieve the current data of an existing teetime reservation| | + | |[[sethandicap]]|set the handicap of a specific relation or member| |
- | |[[golferregistrations]] |Gives a list of all the golfcourses and clubs at which the user is known in their local database| | + | |
- | |[[greenfeecards]] |Golfers can have bought cards to play multiple rounds of golf. This API gives a list of all registered cards and their balance| | + | |
- | |[[points]] |Golfers can save discount points when they spend money on a golfcourse (like air miles) | | + | |
- | |[[bookings]] |Retrieve a list of all bookings of a golfer. | | + | |
- | |[[lessontypes]] |Retrieve a list of all lessontypes that can be used to book a lesson at a specific course | | + | |
- | |[[pros]] |Retrieve a list of all golf professionals (tutors) for a specific course. | | + | |
- | |[[proagendas]] |Retrieve a list of all available slots for lessons for the golf professionals (tutors) of a specific course. | | + | |
- | |[[booklesson]] |Book a lesson | | + | |
- | |[[cancellesson]] |Cancel an existing lesson | | + | |
- | |[[getlesson]] |Retrieve the current data of an existing lesson | | + | |
- | |[[valuetable]] |Retreive a list of possible values for a value table | | + | |
- | |[[relationfreefielddefinition]] |Request a definition of all user defined free fields for registering Relations | | + | |
- | |[[membertypes]] |This interface provides a list of all available membertypes for registerign a new member | | + | |
- | |[[addrelation]] |Add a new relation or member to the intogolf database | | + | |
- | |[[getrelation]] |Retrieve data from existing relations | | + | |
- | |[[gethandicaphistory]] |Retrieve handicaphistory from a golfer if a member of a club that uses intogolf | | + | |
- | + | ||
- | + | ||