{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1031cb4d-155b-442f-9836-12ee054d46be","name":"Online Scout Manager","description":"Online Scout Manager is a highly useful set of tools provided by Online Youth Manager.\n\nWith API Access, you can do so much more with your data. However, there is no documentation for the API and is provided \"as-is\". This will hopefully help bridge some of that documentation gap.\n\n# Overview\n**This is a community documentation project and is not supported or endorsed by Online Youth Manager** (the company responsible for Online Scout Manager). This doumentation is intended for use by existing OSM Customers with an API key (available on request from OYM) to enable creation of their own automated processes.\n\nThis documentation project is provided as a guide to the API calls and is created by parties interested in the use of OSM API for automating workloads. If you are looking for code examples, this is not the place for them. Please visit the OSM Forum and navigate to the relevant subforum.\n\nThe OSM API itself is not supported and is subject to change at any time. Please use this documentation as a guide only.\n\n# Authentication\nTo obtain access via API you will first need to request an API key from OSM Support. Simply login to OSM and then navigate to the forum (www.onlinescoutmanager.co.uk/forum).\n\nWhen you receive your API key, you will need to set up access for it in Settings >> External Access. If you don't allow the key access to something, its relevant API Calls will not work and won't tell you why.\n\nYou will need 4 values sending with your header for all POST requests. These are:\n\n#### Secret Key\nAll requests need a Secret Key. You will get this by running Authenticate User for the first time using your API Key, your API ID, your Email and your Password. \n\nThe result will return your Secret Key and User ID. These will replace your Email and Password in future POST requests.\n\n#### User ID\nObtain this with your Secret Key by Authenticating User. You can also find this in OSM if you read the Members List information. It's your OSM Scout ID.\n\n#### Token\nThis is your API Key provided to you by Support.\n\n#### API ID\nThis is the ID for your API Key, also provided to you by Support.\n\n\n# Gotchas\nWhen writing your automation, there are some things that we have found that would be great to pass on to you, dear developer...\n\n#### White Space\nWhen you are using the API you might want to add little things like trimming to your calls (as the DB stores trailling white spaces to things like Scout Names).\n\n#### Section IDs\nGet your Section ID's first, maybe store them somewhere as a KV pair - it gets very annoying to try and work out your SectionID as it's needed pretty much everywhere.\n\n#### OSM Access\nDon't forget to give your API Access key the right level of access in OSM. If you have not, for instance, provided even Read Only access to Programmes then you will get a 403 error with no further information when trying to run a query. It will return 'false' to some calls.\n\n# Rate limit\nThere is a limit to flooding the service, set by OSM. Try to be careful with your requests.\n\n# Lockout\nIf you post too many 4xx errors (it's easy to do as the interface doesn't give you much feedback) it's very possibly you will get your API key locked. Be careful and verify your parameters against those you are supposed to be sending.\n\nWe are told that you will need to leave the API untouched for over 15 mins once you are blocked, any time you try to access with your key while its locked will get your block extended.\n\nMaybe go make a cup of tea and fume silently into it while you think about what might be wrong.\n\n# Contribution\nIf you wish to contribute to the project, please contact the project creator.\n\n# Restrictions\nWe are currently restricted to 25 documented calls on the free version of Postman. We will have to make some hard choices what to do about this soon. Watch this space.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1618329","team":695050,"collectionId":"1031cb4d-155b-442f-9836-12ee054d46be","publishedId":"SWTHbEzb","public":true,"publicUrl":"https://documenter-api.postman.tech/view/1618329/SWTHbEzb","privateUrl":"https://go.postman.co/documentation/1618329-1031cb4d-155b-442f-9836-12ee054d46be","customColor":{"top-bar":"4E2077","right-sidebar":"D5DAE4","highlight":"41485B"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2020-02-08T11:04:28.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/e9e4fc07a82e4db2d76eaf07e76917530e1ebfa183d2a951418b169fe75d3f7f","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/SWTHbEzb"}