ICM’s OpenApi provides a connection between TeeSheet applications and the ICM TeeTime and Reservation engines.
\nThe ICM core functionality is to have Golfcourse Booking Channels communicate with GolfCourses through the TeeSheet application. Your effort in connecting to our ICM is very much appreciated and please feel free to contact us should you have any questions or suggestions. You can reach us on openapi@icm.golf
\nFor validation the OpenApi security key is added to the header.
\nWhen the ICM Reservation engine receives a booking from a Channel, it creates a reservation. This reservation goes into Status 1, which is a holding status. The Reservation engine will send a trigger to the callback url of the TeeTime. The callback url will use method POST, and in it's body there will be a json object with an id. This id is the internal id of the reservation, and is needed to use the OpenApi function reservation/get. With reservation/get the reservation can be retrieved from the ICM and will provide all information of the reservation. When the reservation is retrieved and the processed in the TeeSheet of the corresponding course, the OpenApi function reservation/put is used to update the reservation and set it’s status to either Status 2 (“confirmed by course”) or to Status 3 (“rejected by course”) . In both cases the party making the reservation will need to be informed by the TeeSheet application on the status of the reservation.
\nTo get started with the OpenApi a security key is required. To receive a security key we need the following documents:
\nRetrieves a list of TeeTimes for a specific day.
\n","urlObject":{"protocol":"https","path":["external","teetimes","get"],"host":["www","icm","golf"],"query":[{"description":{"content":"Date of teetimes
\n","type":"text/plain"},"key":"date","value":"2020-05-29"}],"variable":[]}},"response":[{"id":"4696d848-642e-47ba-bb17-b9cabdd97ea5","name":"teetimes get example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://www.icm.golf/external/teetimes/get?date=2020-05-29","protocol":"https","host":["www","icm","golf"],"path":["external","teetimes","get"],"query":[{"key":"date","value":"2020-05-29","description":"Date of teetimes"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 04 Jun 2020 06:38:42 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"773"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"function\": \"get\",\n \"start\": \"2020-06-04 08:38:42.494920\",\n \"end\": \"2020-06-04 08:38:42.494950\",\n \"error\": {\n \"code\": 0,\n \"message\": \"none\"\n },\n \"payload\": [\n {\n \"icmId\": 22,\n \"id\": 1,\n \"datetime\": {\n \"date\": \"2020-05-29 07:00:00.000000\",\n \"timezone_type\": 3,\n \"timezone\": \"Europe/Amsterdam\"\n },\n \"daysFrom\": 4,\n \"price9\": \"20.00\",\n \"price18\": \"40.00\",\n \"minHoles\": 9,\n \"maxHoles\": 18,\n \"slots\": 4,\n \"loopOut\": 1,\n \"loopIn\": 2,\n \"callbackUrl\": \"https://www.yoururl.com/callback_url?your_params\",\n \"status\": 1\n }\n ]\n}"}],"_postman_id":"f34f9b01-4c88-4e77-91b3-03feafff1acd"},{"name":"teetimes post","id":"46a11167-4ec5-4216-88d0-d39c02341cf0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":"Post TeeTimes to the ICM TeeTime database.
\nThis function expects a json body with two arrays:
\nGet a TeeTime from the ICM TeeTime database. The TeeTime is retrieved by it's external id. The external id is the id that was provided during the TeeTimes/post action.
\n","urlObject":{"protocol":"https","path":["external","teetime","get"],"host":["www","icm","golf"],"query":[{"description":{"content":"Course internal teetime id provide during teetimes post
\n","type":"text/plain"},"key":"id","value":"22"}],"variable":[]}},"response":[{"id":"3b610b7e-f223-420e-a983-108eae791e33","name":"teetime get example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://www.icm.golf/external/teetime/get?id=22","protocol":"https","host":["www","icm","golf"],"path":["external","teetime","get"],"query":[{"key":"id","value":"22","description":"Course internal teetime id provide during teetimes post"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 04 Jun 2020 06:33:27 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"685"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"function\": \"get\",\n \"start\": \"2020-06-04 08:33:27.574655\",\n \"end\": \"2020-06-04 08:33:27.577370\",\n \"error\": {\n \"code\": 0,\n \"message\": \"none\"\n },\n \"payload\": {\n \"icmId\": 22,\n \"id\": 1,\n \"datetime\": {\n \"date\": \"2020-05-29 07:00:00.000000\",\n \"timezone_type\": 3,\n \"timezone\": \"Europe/Amsterdam\"\n },\n \"daysFrom\": 4,\n \"price9\": \"20.00\",\n \"price18\": \"40.00\",\n \"minHoles\": 9,\n \"maxHoles\": 18,\n \"slots\": 4,\n \"loopOut\": 1,\n \"loopIn\": 2,\n \"callbackUrl\": \"https://www.yoururl.com/callback_url?your_params\",\n \"status\": 1\n }\n}"}],"_postman_id":"1a6cf8d9-0881-4ca1-8bde-f31639de7fca"},{"name":"teetime put","id":"47459d9f-4803-448f-b775-a4c00bb9b914","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":"Update a TeeTime based on it's external id. The external id is the id that was provided during the TeeTimes/post action.
\nMain functionality here is to set the status of the TeeTime.
\nRetrieves a list of reservations for a specific day.
\n","urlObject":{"protocol":"https","path":["external","reservations","get"],"host":["www","icm","golf"],"query":[{"key":"date","value":"2020-05-29"}],"variable":[]}},"response":[],"_postman_id":"1b44f72d-874a-4bdb-9e1a-6331f57cb245"},{"name":"reservation get","id":"57ea47dd-614d-4448-844f-6092a99eac7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":"Get a specific Reservation from the ICM Reservation database.
\nThe Reservation is retrieved by it's internal id. The internal id is the id that was posted in the callback body that was send to the callback-url provided during the TeeTimes/POST.
\n","urlObject":{"protocol":"https","path":["external","reservation","get"],"host":["www","icm","golf"],"query":[{"key":"id","value":"2"}],"variable":[]}},"response":[],"_postman_id":"57ea47dd-614d-4448-844f-6092a99eac7a"},{"name":"reservation put","id":"9a70dd7d-1380-486e-9183-b9702369528a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":"When a TeeTime is booked a reservation is created and the callback is triggered, ICM adds it’s internal id to the callback. This id can be used by this version to update the status of the reservation to Status 2 (“confirmed by course”) or to Status 3 (“rejected by course”).
\nIn the case the TeeTime is rejected (Status 3), use reservation/get to retrieve the reservation, and send an email to the booker that the reservation was rejected.
\n","urlObject":{"protocol":"https","path":["external","reservation","put"],"host":["www","icm","golf"],"query":[],"variable":[]}},"response":[],"_postman_id":"9a70dd7d-1380-486e-9183-b9702369528a"},{"name":"loops get","id":"ac8174fc-58a7-4a47-9d4b-1b0a2d52002e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":"During TeeTimes/POST loops are automatically generated based on the loops array provided in the json body. Use this function to retrieve a list op loops from the ICM loop database.
\n","urlObject":{"protocol":"https","path":["external","loops","get"],"host":["www","icm","golf"],"query":[],"variable":[]}},"response":[],"_postman_id":"ac8174fc-58a7-4a47-9d4b-1b0a2d52002e"}]}