In production, ensure to replace the \"ras\" in the URL with the range name location provided to you.
\nEnsure that the \"Authorization\" tab contains your API Key as \"x-api-key\"
\nWhile Batch Start and Batch Stop are documented in separate sections for clarity, the API lets you perform both in a single call. Simply include whatever startβ―and stop commands you need in the same payloadβfor example, you could start Bayβ―1 and stop Bayβ―2 in one batch request.
\nThis section enumerates all enumeration types used by the RAS API, detailing each enumβs name, its set of valid values, and a brief description of their purpose in request and response data.
\n1.) Ball Rental
2.) Available
3.) Freeplay
4.) Time Rental
5.) Checked In
6.) Checked Out
7.) Error
9.) Manual Mode
10.) No Response
0.) No Error
\n1.) Tee Sensor
2) Bottom Sensor
3.) Chute Sensor
9.) Tee And Chute Sensor
10.) Motor Sensor
\n11.) Bottom And Chute Sensor
12.) Tee And Bottom Sensor
0.) No Error
\n4.) Drum Sensor
\n5.) Club Sensor
6.) Low Balls
7.) Low Balls And Drum Sensor
8.) Low Balls And Club Sensor
If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.
\nAn HTTP 200 response from our servers indicates your request was sent successfully
An HTTP 403 response indicates that your range name variable, or API Key are not correct
An HTTP 503 response from our servers indicates there is an unexpected spike in API access traffic.
In case you have questions, email zack.lacanna@rangesystems.com
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"32401939","collectionId":"6164af16-06db-4093-b459-e840238dc8c6","publishedId":"2sAYdfpqNw","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-02-26T19:01:50.000Z"},"item":[{"name":"RAS Commands","item":[{"name":"Get Bay Data","event":[{"listen":"test","script":{"id":"2fc09677-deb3-463b-ba17-11b922488473","exec":[""],"type":"text/javascript","packages":{}}}],"id":"3216c46f-b8a7-4f46-aa41-7d355be01808","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"url":"https://ras.rangesystems.com/api/read","description":"In production, ensure to replace the \"ras\" in the URL with the range name location provided to you.
\nEnsure that the \"Authorization\" tab contains your API Key as \"x-api-key\"
\nEnter the command information to \"Body\" tab
\nEnter a unique guid to the \"Params\" tab that concatenates to URL
\nIn production, ensure to replace the \"ras\" in the URL with the range name location provided to you.
\nEnsure that the \"Authorization\" tab contains your API Key as \"x-api-key\"
\n\"Bay Id\" : BayNumber (Integer)
\n\"TotalBalls\" : Total Balls for Session (Integer)
\n\"TotalTime\" : Total Timefor Session (Integer)
\n\"Active\" : Start or Stop Machine (Bool)
\n\"Sender\" : 3rd Party Sending the Command
\nStart Bay 1 for 60 Minutes
\n{\n \"BayId\": 1,\n \"Active\": true,\n \"TotalBalls\": 999,\n \"TotalTime\": 60,\n \"Sender\": \"InRange\"\n}\n\nStart Bay 1 for 100 Balls
\n{\n \"BayId\": 1,\n \"Active\": true,\n \"TotalBalls\": 100,\n \"TotalTime\": 0,\n \"Sender\": \"YGB\"\n}\n\nEnter the command information to \"Body\" tab
\nEnter a unique guid to the \"Params\" tab that concatenates to URL
\nIn production, ensure to replace the \"ras\" in the URL with the range name location provided to you.
\nEnsure that the \"Authorization\" tab contains your API Key as \"x-api-key\"
\n\"Bay Id\" : BayNumber (Integer)
\n\"TotalBalls\" : Updated total balls for the session. Timed sessions this does not matter (Integer)
\n\"TotalTime\" : Updated total time for the session (Integer)
\nEdit Session on Bay 1 to now have a total session length of 90 minutes
\n{\n \"BayId\": 1,\n \"TotalBalls\": 0,\n \"TotalTime\": 90,\n}\n\nEdit Session on Bay 2 to now have a total of 100 balls.
\n{\n \"BayId\": 2,\n \"TotalBalls\": 100,\n \"TotalTime\": 0,\n}\n\nEnter the command information to \"Body\" tab
\nEnter a unique guid to the \"Params\" tab that concatenates to URL
\nIn production, ensure to replace the \"ras\" in the URL with the range name location provided to you.
\nEnsure that the \"Authorization\" tab contains your API Key as \"x-api-key\"
\n\"Bay Id\" : BayNumber (Integer)
\n\"TotalBalls\" : Total Balls for Session (Integer)
\n\"TotalTime\" : Total Timefor Session (Integer)
\n\"Active\" : false
\n\"Sender\" : 3rd Party Sending the Command
\nStop Bay 1
\n{\n \"BayId\": 1,\n \"Active\": false,\n \"TotalBalls\": 0,\n \"TotalTime\": 0,\n \"Sender\": \"inrange\"\n}\n\nStop Bay 10
\n{\n \"BayId\": 10,\n \"Active\": false,\n \"TotalBalls\": 0,\n \"TotalTime\": 0,\n \"Sender\": \"inrange\"\n}\n\nEnter the command information to \"Body\" tab
\nIn production, ensure to replace the \"ras\" in the URL with the range name location provided to you.
\nEnsure that the \"Authorization\" tab contains your API Key as \"x-api-key\"
\n\"Bay Id\" : BayNumber (Integer)
\n\"TotalBalls\" : Total Balls for Session (Integer)
\n\"TotalTime\" : Total Timefor Session (Integer)
\n\"Active\" : true
\n\"Sender\" : 3rd Party Sending the Command
\nThese must be wrapped within an array labeled \"commands\" as seen in the example
\nStart Multiple Bays for 60 Minutes
\n{ \n \"commands\": [ \n { \"BayId\": \"10\", \"Active\": true, \"TotalBalls\": \"999\", \"TotalTime\": \"60\", \"Sender\": \"inrange\" }, \n { \"BayId\": \"11\", \"Active\": true, \"TotalBalls\": \"999\", \"TotalTime\": \"60\", \"Sender\": \"inrange\" }, \n { \"BayId\": \"12\", \"Active\": true, \"TotalBalls\": \"999\", \"TotalTime\": \"60\", \"Sender\": \"inrange\" } \n ] \n}\n\nStart Multiple Bays for 100 Balls
\n{ \n \"commands\": [ \n { \"BayId\": \"10\", \"Active\": true, \"TotalBalls\": \"100\", \"TotalTime\": \"0\", \"Sender\": \"inrange\" }, \n { \"BayId\": \"11\", \"Active\": true, \"TotalBalls\": \"100\", \"TotalTime\": \"0\", \"Sender\": \"inrange\" }, \n { \"BayId\": \"12\", \"Active\": true, \"TotalBalls\": \"100\", \"TotalTime\": \"0\", \"Sender\": \"inrange\" } \n ] \n}\n\nEnter the command information to \"Body\" tab
\nIn production, ensure to replace the \"ras\" in the URL with the range name location provided to you.
\nEnsure that the \"Authorization\" tab contains your API Key as \"x-api-key\"
\n\"Bay Id\" : BayNumber (Integer)
\n\"TotalBalls\" : Total Balls for Session (Integer)
\n\"TotalTime\" : Total Timefor Session (Integer)
\n\"Active\" : false
\n\"Sender\" : 3rd Party Sending the Command
\nThese must be wrapped within an array labeled \"commands\" as seen in the example
\nStop Bays 10-12
\n{ \n \"commands\": [ \n { \"BayId\": \"10\", \"Active\": false, \"TotalBalls\": \"0\", \"TotalTime\": \"0\", \"Sender\": \"inrange\" }, \n { \"BayId\": \"11\", \"Active\": false, \"TotalBalls\": \"0\", \"TotalTime\": \"0\", \"Sender\": \"inrange\" }, \n { \"BayId\": \"12\", \"Active\": false, \"TotalBalls\": \"0\", \"TotalTime\": \"0\", \"Sender\": \"inrange\" } \n ] \n}\n\nStop Bays 1-5
\n{ \n \"commands\": [ \n { \"BayId\": \"1\", \"Active\": false, \"TotalBalls\": \"0\", \"TotalTime\": \"0\", \"Sender\": \"inrange\" }, \n { \"BayId\": \"2\", \"Active\": false, \"TotalBalls\": \"0\", \"TotalTime\": \"0\", \"Sender\": \"inrange\" }, \n { \"BayId\": \"3\", \"Active\": false, \"TotalBalls\": \"0\", \"TotalTime\": \"0\", \"Sender\": \"inrange\" },\n { \"BayId\": \"4\", \"Active\": false, \"TotalBalls\": \"0\", \"TotalTime\": \"0\", \"Sender\": \"inrange\" },\n { \"BayId\": \"5\", \"Active\": false, \"TotalBalls\": \"0\", \"TotalTime\": \"0\", \"Sender\": \"inrange\" } \n ] \n}\n\nThe endpoints that let you manage pulling the current state of the bays as well as sending a command to start and stop individual machines
\n","_postman_id":"12adb5ca-2969-46cb-ac2c-9e9fcb060052","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"6164af16-06db-4093-b459-e840238dc8c6","id":"6164af16-06db-4093-b459-e840238dc8c6","name":"RAS Spectrum API Documentation","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{x-api-key}}"}]}},"event":[{"listen":"prerequest","script":{"id":"9b478d52-33e5-4131-ab10-36d56ff64c45","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5c6951f6-8c1e-43ee-aa70-b6a8761590ac","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":".rangesystems.com"},{"key":"rangename","value":"ras","type":"string"}]}