{"docs":{"name":"pinballmap.com API","info":"\n\u003cp\u003eThe Pinball Map API is for services that want to extend beyond our offered functionality, or do something neat with the data. It is not for creating a clone where people can find machines to play. If you create a clone, that is against our data usage agreement and you will likely be blocked.\u003cbr\u003e\u003cbr\u003e API use requires a key, which can be requested here: \u003ca href=\"https://pinballmap.com/api_token\"\u003epinballmap.com/api_token\u003c/a\u003e\u003cbr\u003e\u003cbr\u003e Keep your key server-side only. Never embed it in browser JavaScript or other client-side code end users can inspect. If your app has a JS frontend, proxy requests through your own backend.\u003cbr\u003e\u003cbr\u003e If you use this data, include attribution.\u003cbr\u003e\u003cbr\u003e If you are making thousands of requests in a short amount of time, you are doing something wrong (there’s always a better way) and you might get blocked.\u003cbr\u003e\u003cbr\u003e Check \u003ca href=\"https://pinballmap.com/llms.txt\"\u003epinballmap.com/llms.txt\u003c/a\u003e for more tips.\u003cbr\u003e\u003cbr\u003e If you use this API for something cool, let us know. We like looking at interesting uses of the data.\u003cbr\u003e\u003cbr\u003e If you have any suggestions/requests for endpoints, please email: admin@pinballmap.com.\u003cbr\u003e\u003cbr\u003e If you have any patches that you’d like to submit to the API, please check out: \u003ca href=\"https://github.com/pinballmap/pbm\"\u003egithub.com/pinballmap/pbm\u003c/a\u003e.\u003c/p\u003e\n","copyright":null,"doc_url":"/api/v1/docs/1.0","api_url":"","resources":{"events":{"doc_url":"/api/v1/docs/1.0/events","id":"events","api_url":"","name":"Events","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/v1/docs/1.0/events/index","name":"index","apis":[{"api_url":"/api/v1/events.json","http_method":"GET","short_description":"Fetch upcoming events at a location, or near a point","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003ePass location_id, or lat, lon, and radius. Sorted by start date. With location_id, returns at most 500 events, each with id, name, start_date, end_date, ifpa_tournament_id, external_link, event_type, ranking, long_desc. Otherwise returns 50 events per page, with a pagy object for paging (pass page to fetch more), each with id, ifpa_tournament_id, name, start_date, end_date, address, external_location_name, external_link, event_type, ranking, long_desc, location_id, and location_name, which is null unless the event is at a Pinball Map location.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eLocation ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lat","full_name":"lat","description":"\n\u003cp\u003eLatitude\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lon","full_name":"lon","description":"\n\u003cp\u003eLongitude\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"radius","full_name":"radius","description":"\n\u003cp\u003eSearch radius (max 250)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"distance_unit","full_name":"distance_unit","description":"\n\u003cp\u003em (miles) or k (kilometers). Defaults to m\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eYYYY-MM-DD, the client’s local date, to hide events that already ended there. Must be within a day of the server’s date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, for lat, lon, and radius searches. Defaults to 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/events/show","name":"show","apis":[{"api_url":"/api/v1/events/:id.json","http_method":"GET","short_description":"Fetch an event","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eHas id, ifpa_tournament_id, name, start_date, end_date, address, external_location_name, external_link, event_type, ranking, long_desc, location_id, and location_name when the event is at a Pinball Map location.\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eEvent ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"location_machine_xrefs":{"doc_url":"/api/v1/docs/1.0/location_machine_xrefs","id":"location_machine_xrefs","api_url":"","name":"Location_machine_xrefs","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/v1/docs/1.0/location_machine_xrefs/index","name":"index","apis":[{"api_url":"/api/v1/region/:region/location_machine_xrefs.json","http_method":"GET","short_description":"Get all machines at locations in a single region. This is a legacy endpoint, and it was very bloated and has since been reduced. It is better to use the locations.json endpoint if you want more location and machine info","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"region","full_name":"region","description":"\n\u003cp\u003eName of the Region you want to see machines for\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/location_machine_xrefs/show","name":"show","apis":[{"api_url":"/api/v1/location_machine_xrefs/:id.json","http_method":"GET","short_description":"Get info about a single lmx","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eThe location machine ID (LMX ID)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eLimits scores (not comments) to a single user. If user ID param is 0, excludes all scores.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"all_scores","full_name":"all_scores","description":"\n\u003cp\u003eSet to 1 alongside user_id to return the user’s top scores under machine_score_xrefs_user and the top scores from all users under machine_score_xrefs_all (both max 10, sorted by score), instead of machine_score_xrefs. Also returns machine_score_xrefs_all_only_user, which is true when every score in machine_score_xrefs_all belongs to this user (the two lists are identical). With user_id=0, machine_score_xrefs_user is empty. Ignored without user_id.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/location_machine_xrefs/create","name":"create","apis":[{"api_url":"/api/v1/location_machine_xrefs.json","http_method":"POST","short_description":"Find or create a machine at a location","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eLocation ID to add machine to\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"machine_id","full_name":"machine_id","description":"\n\u003cp\u003eMachine ID to add to location\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"condition","full_name":"condition","description":"\n\u003cp\u003eNotes on machine’s condition\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/location_machine_xrefs/update","name":"update","apis":[{"api_url":"/api/v1/location_machine_xrefs/:id.json","http_method":"PUT","short_description":"Update a machine's condition at a location","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eLMX id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"condition","full_name":"condition","description":"\n\u003cp\u003eNotes on machine’s condition\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/location_machine_xrefs/destroy","name":"destroy","apis":[{"api_url":"/api/v1/location_machine_xrefs/:id.json","http_method":"DESTROY","short_description":"Remove a machine from a location","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eLMX id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/location_machine_xrefs/top_n_machines","name":"top_n_machines","apis":[{"api_url":"/api/v1/location_machine_xrefs/top_n_machines.json","http_method":"GET","short_description":"Show the top N machines on location","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"n","full_name":"n","description":"\n\u003cp\u003eNumber of machines to show\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/location_machine_xrefs/most_recent_by_lat_lon","name":"most_recent_by_lat_lon","apis":[{"api_url":"/api/v1/location_machine_xrefs/most_recent_by_lat_lon.json","http_method":"GET","short_description":"Returns the most recently added machines near transmitted lat/lon","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eThis sends you the most recent machines added near your lat/lon (defaults to within 50 miles).\u003c/p\u003e\n","errors":[],"params":[{"name":"lat","full_name":"lat","description":"\n\u003cp\u003eLatitude\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lon","full_name":"lon","description":"\n\u003cp\u003eLongitude\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_distance","full_name":"max_distance","description":"\n\u003cp\u003eClosest location within “max_distance” miles, with a max of 500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/location_machine_xrefs/ic_toggle","name":"ic_toggle","apis":[{"api_url":"/api/v1/location_machine_xrefs/:location_machine_xref_id/ic_toggle.json","http_method":"PUT","short_description":"Toggle a machine's Insider Connected status","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"location_machine_xref_id","full_name":"location_machine_xref_id","description":"\n\u003cp\u003eLMX id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ic_enabled","full_name":"ic_enabled","description":"\n\u003cp\u003eSets the Insider Connected status for this machine\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"location_picture_xrefs":{"doc_url":"/api/v1/docs/1.0/location_picture_xrefs","id":"location_picture_xrefs","api_url":"","name":"Location_picture_xrefs","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/v1/docs/1.0/location_picture_xrefs/show","name":"show","apis":[{"api_url":"/api/v1/location_picture_xrefs/:id.json","http_method":"GET","short_description":"Get info about a single lpx","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eLPX id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/location_picture_xrefs/create","name":"create","apis":[{"api_url":"/api/v1/location_picture_xrefs.json","http_method":"POST","short_description":"Add a picture for a location","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eLocation ID to add picture to\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"photo","full_name":"photo","description":"\n\u003cp\u003eThe picture to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a File","expected_type":"file","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/location_picture_xrefs/destroy","name":"destroy","apis":[{"api_url":"/api/v1/location_picture_xrefs/:id.json","http_method":"DESTROY","short_description":"Remove a picture from a location","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eLPX id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"location_types":{"doc_url":"/api/v1/docs/1.0/location_types","id":"location_types","api_url":"","name":"Location_types","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/v1/docs/1.0/location_types/index","name":"index","apis":[{"api_url":"/api/v1/location_types.json","http_method":"GET","short_description":"Fetch all location types","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"locations":{"doc_url":"/api/v1/docs/1.0/locations","id":"locations","api_url":"","name":"Locations","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/v1/docs/1.0/locations/suggest","name":"suggest","apis":[{"api_url":"/api/v1/locations/suggest.json","http_method":"POST","short_description":"Suggest a new location to add to the map","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eThis doesn’t actually create a new location, it just sends location information to region admins. Please send a region or lat/lon combo to get suggestions to the right people.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_name","full_name":"location_name","description":"\n\u003cp\u003eName of new location\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"region_id","full_name":"region_id","description":"\n\u003cp\u003eID of the region that the location belongs in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lat","full_name":"lat","description":"\n\u003cp\u003eLatitude\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lon","full_name":"lon","description":"\n\u003cp\u003eLongitude\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_street","full_name":"location_street","description":"\n\u003cp\u003eStreet address of new location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_city","full_name":"location_city","description":"\n\u003cp\u003eCity of new location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_state","full_name":"location_state","description":"\n\u003cp\u003eState of new location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_zip","full_name":"location_zip","description":"\n\u003cp\u003eZip code of new location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_phone","full_name":"location_phone","description":"\n\u003cp\u003ePhone number of new location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_website","full_name":"location_website","description":"\n\u003cp\u003eWebsite of new location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_type","full_name":"location_type","description":"\n\u003cp\u003eType of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_operator","full_name":"location_operator","description":"\n\u003cp\u003eMachine operator of new location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_zone","full_name":"location_zone","description":"\n\u003cp\u003eMachine operator of new location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_all_ages","full_name":"location_all_ages","description":"\n\u003cp\u003eWhether the location is all ages. One of ‘Yes’, ‘At Times’, and ‘No’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_payment_type","full_name":"location_payment_type","description":"\n\u003cp\u003eWhether the location is free to play. The only accepted value is ‘Free Play’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_comments","full_name":"location_comments","description":"\n\u003cp\u003eComments\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"place_id","full_name":"place_id","description":"\n\u003cp\u003eGoogle Maps Place ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_machines","full_name":"location_machines","description":"\n\u003cp\u003eList of machines at new location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_machines_ids","full_name":"location_machines_ids","description":"\n\u003cp\u003eList of machine ids at new location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/locations/index","name":"index","apis":[{"api_url":"/api/v1/locations.json","http_method":"GET","short_description":"Fetch locations for all regions","deprecated":null},{"api_url":"/api/v1/region/:region/locations.json","http_method":"GET","short_description":"Fetch locations for a single region","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eThis will also return a list of machines at each location\u003c/p\u003e\n","errors":[],"params":[{"name":"region","full_name":"region","description":"\n\u003cp\u003eName of the Region you want to see locations for\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_location_name","full_name":"by_location_name","description":"\n\u003cp\u003eName of location to search for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_location_id","full_name":"by_location_id","description":"\n\u003cp\u003eLocation ID to search for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_id","full_name":"by_machine_id","description":"\n\u003cp\u003eMachine ID to find in locations. Returns locations with all variant models of the machine\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_single_id","full_name":"by_machine_single_id","description":"\n\u003cp\u003eMachine ID to find in locations, returns only exact version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_group_id","full_name":"by_machine_group_id","description":"\n\u003cp\u003eMachine Group to search for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_id_ic","full_name":"by_machine_id_ic","description":"\n\u003cp\u003eMachine ID to find in locations, when Stern Insider Connected is enabled for that machine at that location. Returns locations with all variant models of the machine.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_single_id_ic","full_name":"by_machine_single_id_ic","description":"\n\u003cp\u003eMachine ID to find in locations, when Stern Insider Connected is enabled for that machine at that location. Returns locations with exact model of the machine.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"manufacturer","full_name":"manufacturer","description":"\n\u003cp\u003eLocations with machines from this manufacturer. Additional filtering required for this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_year","full_name":"by_machine_year","description":"\n\u003cp\u003eLocations with at least one machine manufacturered in this year. Additional filtering required for this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_year_gte","full_name":"by_machine_year_gte","description":"\n\u003cp\u003eLocations with at least one machine manufactured in this year or later\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_year_lte","full_name":"by_machine_year_lte","description":"\n\u003cp\u003eLocations with at least one machine manufactured in this year or earlier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_ipdb_id","full_name":"by_ipdb_id","description":"\n\u003cp\u003eIPDB ID to find in locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_opdb_id","full_name":"by_opdb_id","description":"\n\u003cp\u003eOPDB ID to find in locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_name","full_name":"by_machine_name","description":"\n\u003cp\u003eFind machine name in locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_city_id","full_name":"by_city_id","description":"\n\u003cp\u003eCity to search for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_city_no_state","full_name":"by_city_no_state","description":"\n\u003cp\u003eCity to search for when that city is in a country that does not have state/provinces in the data\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_state_id","full_name":"by_state_id","description":"\n\u003cp\u003eState to search for. Matches location state field (often an abbreviation). Additional filtering required for this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_country","full_name":"by_country","description":"\n\u003cp\u003eCountry to search for. Matches location country code, in all caps, such as ‘US’. Additional filtering required for this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_zone_id","full_name":"by_zone_id","description":"\n\u003cp\u003eZone ID to search by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_operator_id","full_name":"by_operator_id","description":"\n\u003cp\u003eOperator ID to search by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_type_id","full_name":"by_type_id","description":"\n\u003cp\u003eLocation type ID to search by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"place_id","full_name":"place_id","description":"\n\u003cp\u003eGoogle Maps Place ID for helping app to identify whether location exists\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_at_least_n_machines","full_name":"by_at_least_n_machines","description":"\n\u003cp\u003eOnly locations with N or more machines. Additional filtering required for this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_at_least_n_machines_type","full_name":"by_at_least_n_machines_type","description":"\n\u003cp\u003eOnly locations with N or more machines. Additional filtering required for this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_is_stern_army","full_name":"by_is_stern_army","description":"\n\u003cp\u003eSend only locations labeled as Stern Army\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_ic_active","full_name":"by_ic_active","description":"\n\u003cp\u003eSend only locations that have at least one machine that is tagged as Stern Insider Connected. Additional filtering required for this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_type","full_name":"by_machine_type","description":"\n\u003cp\u003eLocations with machines of this type (em, ss, me). Additional filtering required for this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_display","full_name":"by_machine_display","description":"\n\u003cp\u003eLocations with machines with this display (alphanumeric, lcd, dmd, reels, lights). Additional filtering required for this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"no_details","full_name":"no_details","description":"\n\u003cp\u003eOmit lmx/condition data from pull. Additional filtering required for this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"with_lmx","full_name":"with_lmx","description":"\n\u003cp\u003eInclude location machine details such as comments. Additional filtering required for this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"regionless_only","full_name":"regionless_only","description":"\n\u003cp\u003eShow only regionless locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_all_ages","full_name":"by_all_ages","description":"\n\u003cp\u003eSend only all ages locations. Locations tagged ‘Yes’ or ‘At Times’ are both included. ‘No’ for not all ages. Additional filtering required for this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_payment_type","full_name":"by_payment_type","description":"\n\u003cp\u003eSend only free play locations. Accepted values are ‘Free Play’ and ‘No’ (meaning not Free Play). Additional filtering required for this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/locations/update","name":"update","apis":[{"api_url":"/api/v1/locations/:id.json","http_method":"PUT","short_description":"Update attributes on a location","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"website","full_name":"website","description":"\n\u003cp\u003eWebsite of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"phone","full_name":"phone","description":"\n\u003cp\u003ePhone number of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_type","full_name":"location_type","description":"\n\u003cp\u003eID of location type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"operator_id","full_name":"operator_id","description":"\n\u003cp\u003eID of the operator\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"all_ages","full_name":"all_ages","description":"\n\u003cp\u003eWhether the location is all ages. One of ‘Yes’, ‘At Times’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payment_type","full_name":"payment_type","description":"\n\u003cp\u003eWhether the location is free to play. The only accepted value is ‘Free Play’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/locations/closest_by_lat_lon","name":"closest_by_lat_lon","apis":[{"api_url":"/api/v1/locations/closest_by_lat_lon.json","http_method":"GET","short_description":"Returns the closest location to transmitted lat/lon","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eThis sends you the closest location to your lat/lon (defaults to within 50 miles). It includes a list of machines at the location.\u003c/p\u003e\n","errors":[],"params":[{"name":"lat","full_name":"lat","description":"\n\u003cp\u003eLatitude\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lon","full_name":"lon","description":"\n\u003cp\u003eLongitude\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_type_id","full_name":"by_type_id","description":"\n\u003cp\u003eLocation type ID to search by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"manufacturer","full_name":"manufacturer","description":"\n\u003cp\u003eLocations with machines from this manufacturer\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_id","full_name":"by_machine_id","description":"\n\u003cp\u003eMachine ID to find in locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_single_id","full_name":"by_machine_single_id","description":"\n\u003cp\u003eMachine ID to find in locations, returns only exact version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_group_id","full_name":"by_machine_group_id","description":"\n\u003cp\u003eMachine Group to search for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_id_ic","full_name":"by_machine_id_ic","description":"\n\u003cp\u003eMachine ID to find in locations, when Stern Insider Connected is enabled for that machine at that location. Returns locations with all variant models of the machine\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_single_id_ic","full_name":"by_machine_single_id_ic","description":"\n\u003cp\u003eMachine ID to find in locations, when Stern Insider Connected is enabled for that machine at that location. Returns locations with exact model of the machine\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_year","full_name":"by_machine_year","description":"\n\u003cp\u003eLocations with at least one machine manufacturered in this year\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_year_gte","full_name":"by_machine_year_gte","description":"\n\u003cp\u003eLocations with at least one machine manufactured in this year or later\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_year_lte","full_name":"by_machine_year_lte","description":"\n\u003cp\u003eLocations with at least one machine manufactured in this year or earlier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_operator_id","full_name":"by_operator_id","description":"\n\u003cp\u003eOperator ID to search by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_at_least_n_machines","full_name":"by_at_least_n_machines","description":"\n\u003cp\u003eOnly locations with N or more machines\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_at_least_n_machines_type","full_name":"by_at_least_n_machines_type","description":"\n\u003cp\u003eOnly locations with N or more machines\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_type","full_name":"by_machine_type","description":"\n\u003cp\u003eLocations with machines of this type (em, ss, me)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_display","full_name":"by_machine_display","description":"\n\u003cp\u003eLocations with machines with this display (alphanumeric, lcd, dmd, reels, lights)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_distance","full_name":"max_distance","description":"\n\u003cp\u003eClosest location within “max_distance” miles, with a max of 500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"no_details","full_name":"no_details","description":"\n\u003cp\u003eOmit data that app does not need from pull\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"send_all_within_distance","full_name":"send_all_within_distance","description":"\n\u003cp\u003eSend all locations within max_distance param, or 50 miles.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_all_ages","full_name":"by_all_ages","description":"\n\u003cp\u003eSend only all ages locations. Locations tagged ‘Yes’ or ‘At Times’ are both included. ‘No’ for not all ages.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_payment_type","full_name":"by_payment_type","description":"\n\u003cp\u003eSend only free play locations. Accepted values are ‘Free Play’ and ‘No’ (meaning not Free Play).\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/locations/within_bounding_box","name":"within_bounding_box","apis":[{"api_url":"/api/v1/locations/within_bounding_box(.:format)","http_method":"GET","short_description":"Returns locations within transmitted bounding box","deprecated":null}],"formats":["json","geojson"],"full_description":"\n\u003cp\u003eThis sends locations within the sw_corner and ne_corner bounding box. It includes a list of machines at the location. If the bounding box diagonal exceeds 500 miles and no limit param and no_details != 2 is sent, results are capped at 50 and pagination metadata is included in the response.\u003c/p\u003e\n","errors":[],"params":[{"name":"swlat","full_name":"swlat","description":"\n\u003cp\u003eSW_Latitude\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"swlon","full_name":"swlon","description":"\n\u003cp\u003eSW_Longitude\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"nelat","full_name":"nelat","description":"\n\u003cp\u003eNE_Latitude\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"nelon","full_name":"nelon","description":"\n\u003cp\u003eNE_Longitude\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_type_id","full_name":"by_type_id","description":"\n\u003cp\u003eLocation type ID to search by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"manufacturer","full_name":"manufacturer","description":"\n\u003cp\u003eLocations with machines from this manufacturer. Multiple manufacturers can be chained together like manufacturer[]=Stern\u0026amp;manufacturer[]=Bally etc.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_id","full_name":"by_machine_id","description":"\n\u003cp\u003eMachine ID to find in locations, returns all versions in group. Multiple IDs can be chained together like by_machine_id[]=111\u0026amp;by_machine_id[]=222 etc.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_single_id","full_name":"by_machine_single_id","description":"\n\u003cp\u003eMachine ID to find in locations, returns only exact version. Multiple IDs can be chained together like by_machine_single_id[]=111\u0026amp;by_machine_single_id[]=22.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_group_id","full_name":"by_machine_group_id","description":"\n\u003cp\u003eMachine Group ID to find in locations. Multiple IDs can be chained together like by_machine_group_id[]=111\u0026amp;by_machine_group_id[]=22.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_id_ic","full_name":"by_machine_id_ic","description":"\n\u003cp\u003eMachine ID to find in locations, when Stern Insider Connected is enabled for that machine at that location. Returns locations with any variant models of the machine. Multiple IDs can be chained together like by_machine_id_ic[]=111\u0026amp;by_machine_id_ic[]=22.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_single_id_ic","full_name":"by_machine_single_id_ic","description":"\n\u003cp\u003eMachine ID to find in locations, when Stern Insider Connected is enabled for that machine at that location. Returns locations with exact model of the machine. Multiple IDs can be chained together like by_machine_single_id_ic[]=111\u0026amp;by_machine_single_id_ic[]=22.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_year","full_name":"by_machine_year","description":"\n\u003cp\u003eLocations with at least one machine manufacturered in this year. Multiple years can be chained together by_machine_year[]=1980\u0026amp;by_machine_year[]=1982.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_year_gte","full_name":"by_machine_year_gte","description":"\n\u003cp\u003eLocations with at least one machine manufactured in this year or later\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_year_lte","full_name":"by_machine_year_lte","description":"\n\u003cp\u003eLocations with at least one machine manufactured in this year or earlier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_operator_id","full_name":"by_operator_id","description":"\n\u003cp\u003eOperator ID to search by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_ic_active","full_name":"by_ic_active","description":"\n\u003cp\u003eSend only locations that have at least one machine that is tagged as Stern Insider Connected\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_faved","full_name":"user_faved","description":"\n\u003cp\u003eUser ID of Faved Locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_ipdb_id","full_name":"by_ipdb_id","description":"\n\u003cp\u003eIPDB ID to find in locations. Multiple IDs can be chained together like by_ipdb_id[]=4565\u0026amp;by_ipdb_id[]=2345.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_opdb_id","full_name":"by_opdb_id","description":"\n\u003cp\u003eOPDB ID to find in locations. Multiple IDs can be chained together like by_opdb_id[]=4565\u0026amp;by_opdb_id[]=2345.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_at_least_n_machines","full_name":"by_at_least_n_machines","description":"\n\u003cp\u003eOnly locations with N or more machines\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_at_least_n_machines_type","full_name":"by_at_least_n_machines_type","description":"\n\u003cp\u003eOnly locations with N or more machines\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_type","full_name":"by_machine_type","description":"\n\u003cp\u003eLocations with machines of this type (em, ss, me). Multiple types can be chained together like by_machine_type[]=ss\u0026amp;by_machine_type[]=em.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_display","full_name":"by_machine_display","description":"\n\u003cp\u003eLocations with machines with this display (alphanumeric, lcd, dmd, reels, lights). Multiple display types can be chained together like by_machine_display[]=dmd\u0026amp;by_machine_display[]=reels.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"no_details","full_name":"no_details","description":"\n\u003cp\u003eOmit data that app does not need from pull (options include ‘1’ or ‘2’)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_all_ages","full_name":"by_all_ages","description":"\n\u003cp\u003eSend only all ages locations. Locations tagged ‘Yes’ or ‘At Times’ are both included. ‘No’ for not all ages.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_payment_type","full_name":"by_payment_type","description":"\n\u003cp\u003eSend only free play locations. Accepted values are ‘Free Play’ and ‘No’ (meaning not Free Play).\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eLimit results to a quantity and include pagination metadata in response\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_by","full_name":"order_by","description":"\n\u003cp\u003eOrder results descending by a field in the locations scope. Allowed fields are updated_at, name, machine_count, distance. Otherwise, sorts by location ID. Using distance requires user_lat and user_lon params\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"machines_only","full_name":"machines_only","description":"\n\u003cp\u003eWhen set to ‘1’, returns only a flat list of unique machine_ids found across all matching locations. No location data is included.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/locations/closest_by_address","name":"closest_by_address","apis":[{"api_url":"/api/v1/locations/closest_by_address.json","http_method":"GET","short_description":"Returns the closest location to transmitted address","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eThis sends you the closest location to your address (defaults to within 50 miles). It includes a list of machines at the location.\u003c/p\u003e\n","errors":[],"params":[{"name":"address","full_name":"address","description":"\n\u003cp\u003eAddress\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_distance","full_name":"max_distance","description":"\n\u003cp\u003eClosest location within “max_distance” miles, max 500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"send_all_within_distance","full_name":"send_all_within_distance","description":"\n\u003cp\u003eSend all locations within max_distance param, or 50 miles.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"no_details","full_name":"no_details","description":"\n\u003cp\u003eOmit data that app does not need from pull\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_ic_active","full_name":"by_ic_active","description":"\n\u003cp\u003eSend only locations that have at least one machine that is tagged as Stern Insider Connected\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"manufacturer","full_name":"manufacturer","description":"\n\u003cp\u003eLocations with machines from this manufacturer\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_type","full_name":"by_machine_type","description":"\n\u003cp\u003eLocations with machines of this type (em, ss, me)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_display","full_name":"by_machine_display","description":"\n\u003cp\u003eLocations with machines with this display (alphanumeric, lcd, dmd, reels, lights)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_id","full_name":"by_machine_id","description":"\n\u003cp\u003eMachine ID to find in locations, returns all versions in group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_single_id","full_name":"by_machine_single_id","description":"\n\u003cp\u003eMachine ID to find in locations, returns only exact version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_group_id","full_name":"by_machine_group_id","description":"\n\u003cp\u003eMachine Group to search for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_id_ic","full_name":"by_machine_id_ic","description":"\n\u003cp\u003eMachine ID to find in locations, when Stern Insider Connected is enabled for that machine at that location. Returns locations with all variant models of the machine\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_single_id_ic","full_name":"by_machine_single_id_ic","description":"\n\u003cp\u003eMachine ID to find in locations, when Stern Insider Connected is enabled for that machine at that location. Returns locations with exact model of the machine\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_year","full_name":"by_machine_year","description":"\n\u003cp\u003eLocations with at least one machine manufacturered in this year\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_year_gte","full_name":"by_machine_year_gte","description":"\n\u003cp\u003eLocations with at least one machine manufactured in this year or later\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_machine_year_lte","full_name":"by_machine_year_lte","description":"\n\u003cp\u003eLocations with at least one machine manufactured in this year or earlier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_all_ages","full_name":"by_all_ages","description":"\n\u003cp\u003eSend only all ages locations. Locations tagged ‘Yes’ or ‘At Times’ are both included. ‘No’ for not all ages.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_payment_type","full_name":"by_payment_type","description":"\n\u003cp\u003eSend only free play locations. Accepted values are ‘Free Play’ and ‘No’ (meaning not Free Play).\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/locations/show","name":"show","apis":[{"api_url":"/api/v1/locations/:id.json","http_method":"GET","short_description":"Display the details of this location","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"no_details","full_name":"no_details","description":"\n\u003cp\u003eOmit lmx/condition data from pull. When no_details=1 and user_id is included, each lmx includes an in_life_list boolean; no_details=2 includes the first 5 machines and a count of machine - optimized for when you click a map marker on the app and it displays in the bottom sheet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"metadata_only","full_name":"metadata_only","description":"\n\u003cp\u003eOmit entire lmx list from pull - optimized for the app in order to refetch a small subset of location data after a particular update\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eWhen included with no_details=1, each lmx includes an in_life_list boolean for this user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/locations/picture_details","name":"picture_details","apis":[{"api_url":"/api/v1/locations/:id/picture_details.json","http_method":"GET","short_description":"Get info about all pictures at a location","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eLocation id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"thumbnail","full_name":"thumbnail","description":"\n\u003cp\u003eReturn 200x200 thumbnail variants instead of full-size\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/locations/machine_details","name":"machine_details","apis":[{"api_url":"/api/v1/locations/:id/machine_details.json","http_method":"GET","short_description":"Display the details of the machines at this location","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"machines_only","full_name":"machines_only","description":"\n\u003cp\u003eSimple list of only machine names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/locations/confirm","name":"confirm","apis":[{"api_url":"/api/v1/locations/:id/confirm.json","http_method":"PUT","short_description":"Confirm location information","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/locations/autocomplete_city","name":"autocomplete_city","apis":[{"api_url":"/api/v1/locations/autocomplete_city.json","http_method":"GET","short_description":"Send back a list of cities in the DB that fit your search criteria","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003ecity/state name part\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/locations/autocomplete","name":"autocomplete","apis":[{"api_url":"/api/v1/locations/autocomplete.json","http_method":"GET","short_description":"Send back fuzzy search results of search params","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003ename to fuzzy search with\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/locations/top_cities","name":"top_cities","apis":[{"api_url":"/api/v1/locations/top_cities.json","http_method":"GET","short_description":"Fetch top 10 cities by number of locations","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eFetch top 10 cities by number of locations\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/locations/top_cities_by_machine","name":"top_cities_by_machine","apis":[{"api_url":"/api/v1/locations/top_cities_by_machine.json","http_method":"GET","short_description":"Fetch top 10 cities by number of machines","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eFetch top 10 cities by number of machines\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/locations/type_count","name":"type_count","apis":[{"api_url":"/api/v1/locations/type_count.json","http_method":"GET","short_description":"Fetch a count of each location type","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eFetch a count of each location type\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/locations/countries","name":"countries","apis":[{"api_url":"/api/v1/locations/countries.json","http_method":"GET","short_description":"Fetch countries by number of locations","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eFetch countries by number of locations\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/locations/top_locations","name":"top_locations","apis":[{"api_url":"/api/v1/locations/top_locations.json","http_method":"GET","short_description":"Fetch biggest locations by number of number","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eFetch biggest locations by number of number\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/locations/geocode_lat_lon","name":"geocode_lat_lon","apis":[{"api_url":"/api/v1/locations/geocode_lat_lon","http_method":"GET","short_description":"Geocode address to lat/lon","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eGeocode address to lat/lon. Requires an api_token (param or X-Api-Token header).\u003c/p\u003e\n","errors":[],"params":[{"name":"address","full_name":"address","description":"\n\u003cp\u003eAddress\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"api_token","full_name":"api_token","description":"\n\u003cp\u003eAPI token (or send the X-Api-Token header)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"machine_conditions":{"doc_url":"/api/v1/docs/1.0/machine_conditions","id":"machine_conditions","api_url":"","name":"Machine_conditions","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/v1/docs/1.0/machine_conditions/update","name":"update","apis":[{"api_url":"/api/v1/machine_conditions/:id.json","http_method":"PUT","short_description":"Update attributes on a machine condition","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the machine condition you want to update\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"comment","full_name":"comment","description":"\n\u003cp\u003eUpdated condition\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/machine_conditions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/machine_conditions/:id.json","http_method":"DESTROY","short_description":"Destroy a single machine condition","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the machine condition you want to destroy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"machine_groups":{"doc_url":"/api/v1/docs/1.0/machine_groups","id":"machine_groups","api_url":"","name":"Machine_groups","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/v1/docs/1.0/machine_groups/index","name":"index","apis":[{"api_url":"/api/v1/machine_groups.json","http_method":"GET","short_description":"Fetch all machine groups","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eMachine group IDs\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"machine_score_xrefs":{"doc_url":"/api/v1/docs/1.0/machine_score_xrefs","id":"machine_score_xrefs","api_url":"","name":"Machine_score_xrefs","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/v1/docs/1.0/machine_score_xrefs/index","name":"index","apis":[{"api_url":"/api/v1/region/:region/machine_score_xrefs.json","http_method":"GET","short_description":"Fetch all high scores for a region","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"region","full_name":"region","description":"\n\u003cp\u003eName of the Region you want to see scores for\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"zone_id","full_name":"zone_id","description":"\n\u003cp\u003eID of the zone you want to see scores for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eLimit number of results returned\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/machine_score_xrefs/show","name":"show","apis":[{"api_url":"/api/v1/machine_score_xrefs/:id.json","http_method":"GET","short_description":"View all high scores for a location's machine","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eThe location machine ID (LMX ID), NOT the machine ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eLimits to scores from a single user for this machine\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/machine_score_xrefs/highest","name":"highest","apis":[{"api_url":"/api/v1/machine_score_xrefs/highest.json","http_method":"GET","short_description":"View highest high score for a machine","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"by_machine_id","full_name":"by_machine_id","description":"\n\u003cp\u003eLimit to the highest score for this machine ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_user_id","full_name":"by_user_id","description":"\n\u003cp\u003eLimit to highest score for a single user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/machine_score_xrefs/create","name":"create","apis":[{"api_url":"/api/v1/machine_score_xrefs.json","http_method":"POST","short_description":"Enter a new high score for a machine","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"location_machine_xref_id","full_name":"location_machine_xref_id","description":"\n\u003cp\u003eLocation machine identifier for high score. Required unless machine_id is provided.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"machine_id","full_name":"machine_id","description":"\n\u003cp\u003eMachine ID to record a locationless high score. Used when no location_machine_xref_id is available.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"score","full_name":"score","description":"\n\u003cp\u003eA pinball machine high score\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/machine_score_xrefs/update","name":"update","apis":[{"api_url":"/api/v1/machine_score_xrefs/:id.json","http_method":"PUT","short_description":"Update a high score","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the high score you want to update\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"score","full_name":"score","description":"\n\u003cp\u003eUpdated score\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/machine_score_xrefs/destroy","name":"destroy","apis":[{"api_url":"/api/v1/machine_score_xrefs/:id.json","http_method":"DESTROY","short_description":"Destroy a single high score","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the high score you want to destroy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"machines":{"doc_url":"/api/v1/docs/1.0/machines","id":"machines","api_url":"","name":"Machines","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/v1/docs/1.0/machines/index","name":"index","apis":[{"api_url":"/api/v1/machines.json","http_method":"GET","short_description":"Fetch all machines","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eThese are the canonical machine descriptions, not the location-centric ones\u003c/p\u003e\n","errors":[],"params":[{"name":"no_details","full_name":"no_details","description":"\n\u003cp\u003eOmit unnecessary metadata for initial app loading\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"region_id","full_name":"region_id","description":"\n\u003cp\u003eshow only machines from this region\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"machine_group_id","full_name":"machine_group_id","description":"\n\u003cp\u003eshow only machines from machine group id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eshow only this machine\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"manufacturer","full_name":"manufacturer","description":"\n\u003cp\u003eshow only machines from this manufacturer\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lmx_count","full_name":"lmx_count","description":"\n\u003cp\u003einclude lmx_count (count of locations with machine) alongside no_details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"operators":{"doc_url":"/api/v1/docs/1.0/operators","id":"operators","api_url":"","name":"Operators","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/v1/docs/1.0/operators/index","name":"index","apis":[{"api_url":"/api/v1/operators.json","http_method":"GET","short_description":"Fetch all operators for all regions","deprecated":null},{"api_url":"/api/v1/region/:region/operators.json","http_method":"GET","short_description":"Fetch all operators","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eFetch data about all operators for region\u003c/p\u003e\n","errors":[],"params":[{"name":"region","full_name":"region","description":"\n\u003cp\u003eName of the Region you want to see operators for\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"no_details","full_name":"no_details","description":"\n\u003cp\u003eOmit unnecessary metadata for initial app loading\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/operators/show","name":"show","apis":[{"api_url":"/api/v1/operators/:id.json","http_method":"GET","short_description":"Fetch information for a single operator","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns detail about a single operator\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the Operator you want to see details about\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"places":{"doc_url":"/api/v1/docs/1.0/places","id":"places","api_url":"","name":"Places","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/v1/docs/1.0/places/autocomplete","name":"autocomplete","apis":[{"api_url":"/api/v1/places/place/autocomplete/json","http_method":"GET","short_description":"Proxy for Google Places autocomplete","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eProxies Google Places autocomplete. Requires user_email and user_token (params or X-User-Email/X-User-Token headers).\u003c/p\u003e\n","errors":[],"params":[{"name":"input","full_name":"input","description":"\n\u003cp\u003eText to autocomplete\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"language","full_name":"language","description":"\n\u003cp\u003eLanguage code, e.g. en\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sessiontoken","full_name":"sessiontoken","description":"\n\u003cp\u003ePlaces session token\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/places/details","name":"details","apis":[{"api_url":"/api/v1/places/place/details/json","http_method":"GET","short_description":"Proxy for Google Places details","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eProxies Google Places details with a fixed set of fields. Requires user_email and user_token (params or X-User-Email/X-User-Token headers).\u003c/p\u003e\n","errors":[],"params":[{"name":"placeid","full_name":"placeid","description":"\n\u003cp\u003eGoogle place_id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"language","full_name":"language","description":"\n\u003cp\u003eLanguage code, e.g. en\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sessiontoken","full_name":"sessiontoken","description":"\n\u003cp\u003ePlaces session token\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"region_link_xrefs":{"doc_url":"/api/v1/docs/1.0/region_link_xrefs","id":"region_link_xrefs","api_url":"","name":"Region_link_xrefs","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/v1/docs/1.0/region_link_xrefs/index","name":"index","apis":[{"api_url":"/api/v1/region/:region/region_link_xrefs.json","http_method":"GET","short_description":"Fetch all region-centric web sites","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"region","full_name":"region","description":"\n\u003cp\u003eName of the Region you want to see links for\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"regions":{"doc_url":"/api/v1/docs/1.0/regions","id":"regions","api_url":"","name":"Regions","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/v1/docs/1.0/regions/location_and_machine_counts","name":"location_and_machine_counts","apis":[{"api_url":"/api/v1/regions/location_and_machine_counts.json","http_method":"GET","short_description":"Get location and machine counts","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eGet location and machine counts\u003c/p\u003e\n","errors":[],"params":[{"name":"region_name","full_name":"region_name","description":"\n\u003cp\u003eregion_name to limit counts to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/regions/does_region_exist","name":"does_region_exist","apis":[{"api_url":"/api/v1/regions/does_region_exist.json","http_method":"GET","short_description":"Find if name corresponds to a known region","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eFind if name corresponds to a known region\u003c/p\u003e\n","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of region\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/regions/closest_by_lat_lon","name":"closest_by_lat_lon","apis":[{"api_url":"/api/v1/regions/closest_by_lat_lon.json","http_method":"GET","short_description":"Find closest region based on lat/lon","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eFind closest region based on lat/lon\u003c/p\u003e\n","errors":[],"params":[{"name":"lat","full_name":"lat","description":"\n\u003cp\u003eLat\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lon","full_name":"lon","description":"\n\u003cp\u003eLon\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/regions/index","name":"index","apis":[{"api_url":"/api/v1/regions.json","http_method":"GET","short_description":"Fetch all regions","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eFetch data about all regions\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/regions/show","name":"show","apis":[{"api_url":"/api/v1/regions/:id.json","http_method":"GET","short_description":"Fetch information for a single region","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns detail about a single region\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the Region you want to see details about\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/regions/contact","name":"contact","apis":[{"api_url":"/api/v1/regions/contact.json","http_method":"POST","short_description":"Contact regional administrator","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eSend a message to the admins for a region\u003c/p\u003e\n","errors":[],"params":[{"name":"message","full_name":"message","description":"\n\u003cp\u003eMessage to admins\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"region_id","full_name":"region_id","description":"\n\u003cp\u003eID of the region to send a message to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lat","full_name":"lat","description":"\n\u003cp\u003eLatitude\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lon","full_name":"lon","description":"\n\u003cp\u003eLongitude\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eSender’s name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email","full_name":"email","description":"\n\u003cp\u003eSender’s email address\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"statuses":{"doc_url":"/api/v1/docs/1.0/statuses","id":"statuses","api_url":"","name":"Statuses","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/v1/docs/1.0/statuses/index","name":"index","apis":[{"api_url":"/api/v1/statuses.json","http_method":"GET","short_description":"Fetch table statuses","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"user_submissions":{"doc_url":"/api/v1/docs/1.0/user_submissions","id":"user_submissions","api_url":"","name":"User_submissions","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/v1/docs/1.0/user_submissions/index","name":"index","apis":[{"api_url":"/api/v1/region/:region/user_submissions.json","http_method":"GET","short_description":"Fetch user submissions for a single region","deprecated":null},{"api_url":"/api/v1/user_submissions.json","http_method":"GET","short_description":"Fetch global user submissions feed","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"region","full_name":"region","description":"\n\u003cp\u003eName of the Region you want to see user submissions for\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"submission_type","full_name":"submission_type","description":"\n\u003cp\u003eType of submission to filter to. Multiple filters can be formatted as ;submission_type[]=remove_machine;submission_type[]=new_lmx etc\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eLimits results to submissions from a single user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_name","full_name":"user_name","description":"\n\u003cp\u003eLimits results to submissions from a single user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"restrict_to","full_name":"restrict_to","description":"\n\u003cp\u003eRestrict this specific submission type to a single user. Requires user_id param to be included; if user_id param is not included, then the submission type specified here is excluded completely. This is used in the app to show submission types from everyone except the high scores only from the current user, or no scores if not signed in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eLimit results to a quantity and include pagination metadata in response\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"machine_id","full_name":"machine_id","description":"\n\u003cp\u003eLimit results by machine. Multiple machines can be chained as ;machine_id[]=111;machine_id[]=222 etc\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_faved","full_name":"user_faved","description":"\n\u003cp\u003eLimit results to locations favorited by this user ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_locationless","full_name":"include_locationless","description":"\n\u003cp\u003eWhen present, includes new_msx submissions that have no associated location (for app versions that support non-pressable activity items)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/user_submissions/location","name":"location","apis":[{"api_url":"/api/v1/user_submissions/location.json","http_method":"GET","short_description":"Fetch user submissions for a location","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"submission_type","full_name":"submission_type","description":"\n\u003cp\u003eType of submission to filter to. Multiple filters can be formatted as ;submission_type[]=remove_machine;submission_type[]=new_lmx etc.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eLimits results to submissions from a single user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_name","full_name":"user_name","description":"\n\u003cp\u003eLimits results to submissions from a single user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"restrict_to","full_name":"restrict_to","description":"\n\u003cp\u003eRestrict this specific submission type to a single user. Requires user_id param to be included; if user_id param is not included, then the submission type specified here is excluded completely. This is used in the app to show submission types from everyone except the high scores only from the current user, or no scores if not signed in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eLimit results to a quantity and include pagination metadata in response\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"machine_id","full_name":"machine_id","description":"\n\u003cp\u003eLimit results by machine. Multiple machines can be chained as ;machine_id[]=111;machine_id[]=222 etc\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/user_submissions/delete_location","name":"delete_location","apis":[{"api_url":"/api/v1/user_submissions/delete_location.json","http_method":"GET","short_description":"Fetch list of deleted locations from the past year","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/user_submissions/total_user_submission_count","name":"total_user_submission_count","apis":[{"api_url":"/api/v1/user_submissions/total_user_submission_count.json","http_method":"GET","short_description":"Fetch total count of user submissions","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eFetch total count of user submissions\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/user_submissions/total_user_submission_count_week","name":"total_user_submission_count_week","apis":[{"api_url":"/api/v1/user_submissions/total_user_submission_count_week.json","http_method":"GET","short_description":"Fetch total count of user submissions for the past week","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eFetch total count of user submissions\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/user_submissions/top_users","name":"top_users","apis":[{"api_url":"/api/v1/user_submissions/top_users.json","http_method":"GET","short_description":"Fetch top 25 users by submission count","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eFetch top 25 users by submission count\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/user_submissions/list_within_range","name":"list_within_range","apis":[{"api_url":"/api/v1/user_submissions/list_within_range.json","http_method":"GET","short_description":"Fetch user submissions within N miles of provided lat/lon","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"lat","full_name":"lat","description":"\n\u003cp\u003eLatitude\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lon","full_name":"lon","description":"\n\u003cp\u003eLongitude\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_distance","full_name":"max_distance","description":"\n\u003cp\u003eClosest location within “max_distance” miles, max of 250\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"min_date_of_submission","full_name":"min_date_of_submission","description":"\n\u003cp\u003eEarliest date to consider updates from, format YYYY-MM-DD\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"submission_type","full_name":"submission_type","description":"\n\u003cp\u003eType of submission to filter to. Multiple filters can be formatted as ;submission_type[]=remove_machine;submission_type[]=new_lmx etc.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"region_id","full_name":"region_id","description":"\n\u003cp\u003eLimit results to a region\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eLimits results to submissions from a single user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_name","full_name":"user_name","description":"\n\u003cp\u003eLimits results to submissions from a single user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"restrict_to","full_name":"restrict_to","description":"\n\u003cp\u003eRestrict this specific submission type to a single user. Requires user_id param to be included; if user_id param is not included, then the submission type specified here is excluded completely. This is used in the app to show submission types from everyone except the high scores only from the current user, or no scores if not signed in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eLimit results to a quantity and include pagination metadata in response\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"machine_id","full_name":"machine_id","description":"\n\u003cp\u003eLimit results by machine. Multiple machines can be chained as ;machine_id[]=111;machine_id[]=222 etc\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_faved","full_name":"user_faved","description":"\n\u003cp\u003eLimit results to locations favorited by this user ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"users":{"doc_url":"/api/v1/docs/1.0/users","id":"users","api_url":"","name":"Users","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/v1/docs/1.0/users/list_fave_locations","name":"list_fave_locations","apis":[{"api_url":"/api/v1/users/:id/list_fave_locations.json","http_method":"GET","short_description":"Fetch list of favorite locations","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eFetch list of favorite locations\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/users/total_user_count","name":"total_user_count","apis":[{"api_url":"/api/v1/users/total_user_count.json","http_method":"GET","short_description":"Fetch total count of users","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eFetch total count of users\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/users/add_fave_location","name":"add_fave_location","apis":[{"api_url":"/api/v1/users/:id/add_fave_location.json","http_method":"POST","short_description":"Adds a location to your fave list","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eAdds a location to your fave list\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/users/remove_fave_location","name":"remove_fave_location","apis":[{"api_url":"/api/v1/users/:id/remove_fave_location.json","http_method":"POST","short_description":"Removes a location from your fave list","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRemoves a location from your fave list\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location to remove\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/users/auth_details","name":"auth_details","apis":[{"api_url":"/api/v1/users/auth_details.json","http_method":"POST","short_description":"Fetch auth info for a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis info includes the user’s API token. Send login and password in the request body; GET with query params is deprecated because it exposes the password in URLs and logs.\u003c/p\u003e\n","errors":[],"params":[{"name":"login","full_name":"login","description":"\n\u003cp\u003eUser’s username or email address\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"password","description":"\n\u003cp\u003eUser’s password\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/users/forgot_password","name":"forgot_password","apis":[{"api_url":"/api/v1/users/forgot_password.json","http_method":"POST","short_description":"Password retrieval","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReset a forgotten password\u003c/p\u003e\n","errors":[],"params":[{"name":"identification","full_name":"identification","description":"\n\u003cp\u003eA username or email address\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/users/resend_confirmation","name":"resend_confirmation","apis":[{"api_url":"/api/v1/users/resend_confirmation.json","http_method":"POST","short_description":"Resend confirmation","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eResend an account confirmation\u003c/p\u003e\n","errors":[],"params":[{"name":"identification","full_name":"identification","description":"\n\u003cp\u003eA username or email address\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/users/signup","name":"signup","apis":[{"api_url":"/api/v1/users/signup.json","http_method":"POST","short_description":"Signup a new user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eSignup a new user for the PBM\u003c/p\u003e\n","errors":[],"params":[{"name":"username","full_name":"username","description":"\n\u003cp\u003eNew username\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email","full_name":"email","description":"\n\u003cp\u003eNew email address\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"password","description":"\n\u003cp\u003eNew password\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"confirm_password","full_name":"confirm_password","description":"\n\u003cp\u003eNew password confirmation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/users/profile_info","name":"profile_info","apis":[{"api_url":"/api/v1/users/:id/profile_info.json","http_method":"GET","short_description":"Fetch profile info for a user","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"new_score_list_only","full_name":"new_score_list_only","description":"\n\u003cp\u003eWhen present, the old high score list is gone (recent 50); only showing the new list of highest high score per machine, all scores per machine, and average and count\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"life_list","full_name":"life_list","description":"\n\u003cp\u003eWhen present, returns the life list (all machines the user has played) with associated score data instead of profile_machine_scores_stats\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"life_list_ids_only","full_name":"life_list_ids_only","description":"\n\u003cp\u003eWhen present, returns only id and life_list_machine_ids (the machine_ids on the user’s life list), skipping all other profile_info fields. Takes precedence over life_list and new_score_list_only.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/users/life_list_info","name":"life_list_info","apis":[{"api_url":"/api/v1/users/life_list_info.json","http_method":"GET","short_description":"Query life list membership","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eWhen no params are provided, returns all machines on at least one life list, sorted by count descending.\u003c/p\u003e\n","errors":[],"params":[{"name":"by_machine_id","full_name":"by_machine_id","description":"\n\u003cp\u003eMachine ID to query\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_user_id","full_name":"by_user_id","description":"\n\u003cp\u003eUser ID to query\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/users/add_life_list_machine","name":"add_life_list_machine","apis":[{"api_url":"/api/v1/users/:id/add_life_list_machine.json","http_method":"POST","short_description":"Add a machine to your life list","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"machine_id","full_name":"machine_id","description":"\n\u003cp\u003eID of machine to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/users/remove_life_list_machine","name":"remove_life_list_machine","apis":[{"api_url":"/api/v1/users/:id/remove_life_list_machine.json","http_method":"POST","short_description":"Remove a machine from your life list","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"machine_id","full_name":"machine_id","description":"\n\u003cp\u003eID of machine to remove\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/users/destroy","name":"destroy","apis":[{"api_url":"/api/v1/users/:id","http_method":"DELETE","short_description":"Delete a user account","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003ePermanently delete your user account\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/users/update_email","name":"update_email","apis":[{"api_url":"/api/v1/users/:id/update_email","http_method":"POST","short_description":"Update email address","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eUpdate email address for a user\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_password","full_name":"current_password","description":"\n\u003cp\u003eCurrent password\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email","full_name":"email","description":"\n\u003cp\u003eNew email address\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/users/update_password","name":"update_password","apis":[{"api_url":"/api/v1/users/:id/update_password","http_method":"POST","short_description":"Update password","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eUpdate password for a user\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_password","full_name":"current_password","description":"\n\u003cp\u003eCurrent password\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"password","description":"\n\u003cp\u003eNew password\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password_confirmation","full_name":"password_confirmation","description":"\n\u003cp\u003eNew password confirmation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/docs/1.0/users/update_user_flag","name":"update_user_flag","apis":[{"api_url":"/api/v1/users/:id/update_user_flag","http_method":"POST","short_description":"Set a flag icon for your user","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"flag","full_name":"flag","description":"\n\u003cp\u003eISO code for flag\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"zones":{"doc_url":"/api/v1/docs/1.0/zones","id":"zones","api_url":"","name":"Zones","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/v1/docs/1.0/zones/index","name":"index","apis":[{"api_url":"/api/v1/region/:region/zones.json","http_method":"GET","short_description":"Fetch zones for a single region","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"region","full_name":"region","description":"\n\u003cp\u003eName of the Region you want to see zones for\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null}}}}