ParksnPeaks API

Created On
Last Updated On
byAllen Harvie
You are here:
< All Topics

We have made available a number of APIs which make ParksnPeaks dataavailable to use for integration into applications.

This is a RESTful service. External applications will access then manipulate textual representations (XML (RSS), HTML or JSON format) of ParksnPeaks data using a predefined set of stateless operations.By making use of a stateless protocol and standard operations, this interface will provide fast and reliable access to data and be managed and updated without affecting ParksnPeaks as a whole

API calls are supported by Key Words:

SPOTS

Spots are current activity. This is the data displayed on ParksnPeaks;

<Screen Shot>

Default requests returns Spots either all or by class. The class keyword is passed;

Keywords will return current spots filtered by activity and in JSON or RSS format.

  • ALL
  • SOTA
  • WWFF
  • SPOTS

Keyword 

  • VK

This command returns last 10 instances of activations where the activator callsign VK or ZL.

Keyword 

  • SPOTS

This will return filtered SPOTS in RSS format;

  • SOTA Spots – http://parksnpeaks.org/api/SPOTS
  • More information – http://vk3zpf.com/vk3zpf-sota-logger-app

SPOTS Return Format

  • RSS
  • JSON

APIs will return JSON data by default. RSS is supported for some calls. 

  • SOTA Spots – http://www.parksnpeaks.org/api/SOTA
  • WWFF Spots – http://www.parksnpeaks.org/api/WWFF
  • All Spots – http://www.parksnpeaks.org/api/ALL

To receive SPOT data in RSS format add RSS keyword;

  • SOTA Spots – http://www.parksnpeaks.org/api/SOTA/RSS
  • WWFF Spots – http://www.parksnpeaks.org/api/WWFF/RSS
  • All Spots – http://www.parksnpeaks.org/api/ALL/RSS

RSS Feed

RSS feed is available 

This command supports VK3ZPF ‘VK port-a-log’ application. 

Peter VK3ZPF’s VK port-a-log is an andriod based application that exploits ParksnPeaks to support portable logging and spotting.  For more information – https://au.groups.yahoo.com/vk3zpf_logger.

SPOT  

Keyword 

  • SPOT

This provides the ability POST spots. A JSON string of variables is passed; 

  • {“actClass”:”WWFF”,”actCallsign”:”vk3arh”,”actSite”:”VKFF-0619″,”mode”:”SSB”,”freq”:”7.095″,”comments”:”Test%20spot%20from%20vk3arh”,”userID”:”VK3ARH”,”APIKey”:”XXXXYYYYY”

Required Input:

All variables are case sensative and rerquired;

NameDescStatusNotes
actClassClass for SpotRSOTA,WWFF, SHIRES,SANPCPA,KRMNPA
actSiteSite keyRVKFF-0024,VK1/AC-001,AS3
modemodeRSSB,CW
freqFrequencyR7.144,7.032,14.062
actCallsignactivator CallsignRCallsign of the activator
userIDID of user making spotR
APIKeyKey fro user authenticationRAPI Key is required for this feature. Users API key is available on the sites User Option page. 
commentsCommentsR120 characters max

Example of setting a SPOT;

  •  Returns -curl –header ‘content-type:application/json’ -X POST –data ‘{“actClass”:”WWFF”,”actCallsign”:”vk3arh”,”actSite”:”VKFF-0619″,”mode”:”SSB”,”freq”:”7.095″,”comments”:”Test%20spot%20from%20vk3arh”,”userID”:”testing”,”APIKey”:”ABCDE12345″}’ http://parksnpeaks.org/api/SPOT/DEBUG

This is a POST request

Host: parksnpeaks.org

User-Agent: curl/7.43.0

Accept: */*

Content-Type: application/json

Content-Length: 169

print_r – stdClass Object

(

    [actClass] => WWFF

    [actCallsign] => vk3arh

    [actSite] => VKFF-0619

    [mode] => SSB

    [freq] => 7.095

    [comments] => Test%20spot%20from%20vk3arh

    [userID] => testing

    [APIKey] => ABCDE12345

)

in setupSpot.

Passed -> {“actClass”:”WWFF”,”actCallsign”:”vk3arh”,”actSite”:”VKFF-0619″,”mode”:”SSB”,”freq”:”7.095″,”comments”:”Test%20spot%20from%20vk3arh”,”userID”:”test”,”APIKey”:”ABCD1234″}

about to display passed variables.

actClass:WWFF

actCallsign:vk3arh

actSite:VKFF-0619

mode:SSB

freq:7.095

comments:Test%20spot%20from%20vk3arh

userID:testing

APIKey:ABCDE12345

<p>In processParkSpot. Ready to add – INSERT INTO activations (actClass,actTime,actCallsign,actLocation,actFreq,actMode,actComments,actSpoter,WWFFid) VALUES (‘WWFF’,’2017-03-18 04:58:59′,’VK3ARH’,’Alpine National Park’,’7.095′,’SSB’,’Test spot from vk3arh’,’TE1ST’,’VKFF-0619′)

Success!

ALERTS  

Alerts are upcoming activity. 

Keyword 

  • ALERTS

This will return current alerts for upcoming activations in JSON format. 

Examples of alerts requests;

  • Alerts in JSON – http://parksnpeaks.org/api/ALERTS/
  • Alerts – curl –header ‘content-type:application/json’ -X GET http://parksnpeaks.org/api/ALERTS/
    • Returns – [{“alID”:”2489″,”WWFFID”:”VKFF-1572″,”CallSign”:”VK4AAC\/P”,”Class”:”WWFF”,”Location”:”King Conservation Park”,”alDay”:”2″,”alTime”:”2017-03-18 00:00:00″,”Freq”:”7.139″,”MODE”:”SSB”,”Comments”:”First time activation of this park.  Shire GY4″,”Alerter”:”VK4AAC”},{“alID”:”2483″,”WWFFID”:”VKFF-0280″,”CallSign”:”VK4HNS”,”Class”:”WWFF”,”Location”:”Lamington National Park”,”alDay”:”3″,”alTime”:”2017-03-18 00:00:00″,”Freq”:”7.135″,”MODE”:”SSB”,”Comments”:”20m also Shire SR4 and JMMFD Contest 6Hr”,”Alerter”:”VK4HNS”},{“alID”:”2488″,”WWFFID”:”VKFF-0269″,”CallSign”:”VK1AT\/P2″,”Class”:”WWFF”,”Location”:”Kosciuszko National Park”,”alDay”:”3″,”alTime”:”2017-03-18 00:00:00″,”Freq”:”144.150″,”MODE”:”SSB”,”Comments”:”John Moyle FD: 2m, 6m, 70cm, 40m”,”Alerter”:”VK1AT”},{“alID”:”2428″,”WWFFID”:”VKFF-0629″,”CallSign”:”VK3PAT\/P”,”Class”:”WWFF”,”Location”:”Kara Kara National Park”,”alDay”:”3″,”alTime”:”2017-03-18 00:00:00″,”Freq”:”7.144″,”MODE”:”SSB”,”Comments”:””,”Alerter”:”VK3PAT”},{“alID”:”2491″,”WWFFID”:”VKFF-0264″,”CallSign”:”VK3SG\/P”,”Class”:”WWFF”,”Location”:”Kinglake National Park”,”alDay”:”3″,”alTime”:”2017-03-18 00:00:00″,”Freq”:”144.150″,”MODE”:”SSB”,”Comments”:”John Moyle Field Day + Shire NS3, also 146.500 FM”,”Alerter”:”VK3SG”},{“alID”:”2468″,”WWFFID”:”VKFF-0475″,”CallSign”:”VK4JAZ”,”Class”:”WWFF”,”Location”:”Tamborine National Park”,”alDay”:”0″,”alTime”:”2017-03-18 01:00:00″,”Freq”:”144.150″,”MODE”:”SSB”,”Comments”:”Also 50.150 SSB and 146.50 FM.”,”Alerter”:”VK4JAZ”},{“alID”:”2482″,”WWFFID”:”VKFF-1707″,”CallSign”:”VK5AFZ \/P”,”Class”:”SANPCPA”,”Location”:”Encounter Marine National Park”,”alDay”:”0″,”alTime”:”2017-03-18 02:00:00″,”Freq”:”7.090″,”MODE”:”SSB”,”Comments”:”Also 3.5, 14 & 21 MHz \/ John Moyle Field Day Contest”,”Alerter”:”VK5AFZ”},{“alID”:”2492″,”WWFFID”:””,”CallSign”:””,”Class”:””,”Location”:”Gawler Ranges Conservation Park”,”alDay”:”0″,”alTime”:”2017-03-18 04:31:14″,”Freq”:””,”MODE”:””,”Comments”:””,”Alerter”:””},{“alID”:”2432″,”WWFFID”:”VKFF-1754″,”CallSign”:”VK5PAS\/P”,”Class”:”WWFF”,”Location”:”Totness Recreation Park”,”alDay”:”0″,”alTime”:”2017-03-18 06:00:00″,”Freq”:”7.144″,”MODE”:”SSB”,”Comments”:”John Moyle Memorial Field Day”,”Alerter”:”VK5PAS”},{“alID”:”2487″,”WWFFID”:”VKFF-0115″,”CallSign”:”VK5AYL”,”Class”:”SANPCPA”,”Location”:”Coorong National Park”,”alDay”:”2″,”alTime”:”2017-03-20 00:00:00″,”Freq”:”21.185″,”MODE”:”SSB”,”Comments”:”TEST ALERT FROM IPHONE APP”,”Alerter”:”VK5AYL”},{“alID”:”2490″,”WWFFID”:”VKFF-0933″,”CallSign”:”VK5PL”,”Class”:”WWFF”,”Location”:”Sandy Creek Conservation Park”,”alDay”:”0″,”alTime”:”2017-03-24 06:00:00″,”Freq”:”7.135″,”MODE”:”SSB”,”Comments”:”will try 80, 20 and maybe 15 – David”,”Alerter”:”VK5PL”},{“alID”:”2460″,”WWFFID”:”VKFF-1038″,”CallSign”:”VK5GJ”,”Class”:”SANPCPA”,”Location”:”Hesperilla Conservation Park”,”alDay”:”1″,”alTime”:”2017-04-01 00:00:00″,”Freq”:”7.135″,”MODE”:”SSB”,”Comments”:””,”Alerter”:”VK5GJ”},{“alID”:”2458″,”WWFFID”:””,”CallSign”:”VK3XV\/5″,”Class”:”SHIRES”,”Location”:”GD5 – “,”alDay”:”1″,”alTime”:”2017-04-01 00:00:00″,”Freq”:”7.100″,”MODE”:”SSB”,”Comments”:”VK5 Parks Activation weekend”,”Alerter”:”VK3VTH”},{“alID”:”2227″,”WWFFID”:”VKFF-0905″,”CallSign”:”VK3XV\/5″,”Class”:”SANPCPA”,”Location”:”Lower Glenelg River Conservation Park”,”alDay”:”2″,”alTime”:”2017-04-01 00:00:00″,”Freq”:”7.100″,”MODE”:”SSB”,”Comments”:”VK5 activation weekend”,”Alerter”:”VK3VTH”},{“alID”:”2246″,”WWFFID”:”VKFF-0790″,”CallSign”:”VK5PAS\/P”,”Class”:”SANPCPA”,”Location”:”Talisker Conservation Park”,”alDay”:”2″,”alTime”:”2017-04-01 00:00:00″,”Freq”:”7.144″,”MODE”:”SSB”,”Comments”:”4th year anniversary weekend”,”Alerter”:”VK5PAS”},{“alID”:”2228″,”WWFFID”:”VKFF-0802″,”CallSign”:”VK3XV\/5″,”Class”:”SANPCPA”,”Location”:”Penambol Conservation Park”,”alDay”:”3″,”alTime”:”2017-04-01 00:00:00″,”Freq”:”7.100″,”MODE”:”SSB”,”Comments”:”VK5 activation weekend”,”Alerter”:”VK3VTH”},{“alID”:”2247″,”WWFFID”:”VKFF-0780″,”CallSign”:”VK5PAS\/P”,”Class”:”SANPCPA”,”Location”:”Deep Creek Conservation Park”,”alDay”:”3″,”alTime”:”2017-04-01 00:00:00″,”Freq”:”7.144″,”MODE”:”SSB”,”Comments”:”4th year anniversary weekend”,”Alerter”:”VK5PAS”},{“alID”:”2448″,”WWFFID”:”VKFF-0360″,”CallSign”:”VK5HYZ”,”Class”:”WWFF”,”Location”:”Mount Remarkable National Park”,”alDay”:”3″,”alTime”:”2017-04-01 00:00:00″,”Freq”:”7.150″,”MODE”:”SSB”,”Comments”:”Activation weekend, will also use 14.310″,”Alerter”:”VK5HYZ”},{“alID”:”2462″,”WWFFID”:”VKFF-0936″,”CallSign”:”VK5GJ”,”Class”:”SANPCPA”,”Location”:”Stipiturus Conservation Park”,”alDay”:”1″,”alTime”:”2017-04-02 00:00:00″,”Freq”:”7.135″,”MODE”:”SSB”,”Comments”:””,”Alerter”:”VK5GJ”},{“alID”:”2459″,”WWFFID”:””,”CallSign”:”VK3XV\/5″,”Class”:”SHIRES”,”Location”:”GD5 – “,”alDay”:”1″,”alTime”:”2017-04-02 00:00:00″,”Freq”:”7.100″,”MODE”:”SSB”,”Comments”:”VK5 Parks Activation weekend”,”Alerter”:”VK3VTH”},{“alID”:”2229″,”WWFFID”:”VKFF-0796″,”CallSign”:”VK3XV\/5″,”Class”:”SANPCPA”,”Location”:”Ewens Ponds Conservation Park”,”alDay”:”2″,”alTime”:”2017-04-02 00:00:00″,”Freq”:”7.100″,”MODE”:”SSB”,”Comments”:”VK5 activation weekend”,”Alerter”:”VK3VTH”},{“alID”:”2248″,”WWFFID”:”VKFF-0940″,”CallSign”:”VK5PAS\/P”,”Class”:”SANPCPA”,”Location”:”Waitpinga Conservation Park”,”alDay”:”2″,”alTime”:”2017-04-02 00:00:00″,”Freq”:”7.144″,”MODE”:”SSB”,”Comments”:”4th year anniversary weekend”,”Alerter”:”VK5PAS”},{“alID”:”2481″,”WWFFID”:”VKFF-0826″,”CallSign”:”VK5AFZ \/P”,”Class”:”SANPCPA”,”Location”:”Kyeema Conservation Park”,”alDay”:”3″,”alTime”:”2017-04-02 00:00:00″,”Freq”:”7.100″,”MODE”:”SSB”,”Comments”:”+\/- QRM “,”Alerter”:”VK5AFZ”},{“alID”:”2230″,”WWFFID”:”VKFF-0927″,”CallSign”:”VK3XV\/5″,”Class”:”SANPCPA”,”Location”:”Piccaninnie Ponds Conservation Park”,”alDay”:”3″,”alTime”:”2017-04-02 00:00:00″,”Freq”:”7.100″,”MODE”:”SSB”,”Comments”:”VK5 activation weekend”,”Alerter”:”VK3VTH”},{“alID”:”2249″,”WWFFID”:”VKFF-0877″,”CallSign”:”VK5PAS\/P”,”Class”:”SANPCPA”,”Location”:”Eric Bonython Conservation Park”,”alDay”:”3″,”alTime”:”2017-04-02 00:00:00″,”Freq”:”7.144″,”MODE”:”SSB”,”Comments”:”4th year anniversary weekend”,”Alerter”:”VK5PAS”},{“alID”:”2238″,”WWFFID”:”VKFF-0630″,”CallSign”:”VK3XV”,”Class”:”KRMNPA”,”Location”:”Terrick Terrick National Park”,”alDay”:”0″,”alTime”:”2017-06-10 06:00:00″,”Freq”:”7.100″,”MODE”:”SSB”,”Comments”:”VK shires contest & park activation”,”Alerter”:”VK3VTH”},{“alID”:”2267″,”WWFFID”:””,”CallSign”:”VK3XV\/P”,”Class”:”SHIRES”,”Location”:”LS3 – Loddon Shire Council”,”alDay”:”0″,”alTime”:”2017-06-10 06:00:00″,”Freq”:”7.100″,”MODE”:”SSB”,”Comments”:”Rover section  –   VK Shires Contest”,”Alerter”:”VK3VTH”},{“alID”:”2239″,”WWFFID”:”VKFF-0739″,”CallSign”:”VK3XV”,”Class”:”KRMNPA”,”Location”:”Barmah National Park”,”alDay”:”1″,”alTime”:”2017-06-11 00:00:00″,”Freq”:”7.100″,”MODE”:”SSB”,”Comments”:”VK shires contest & park activation”,”Alerter”:”VK3VTH”},{“alID”:”2268″,”WWFFID”:””,”CallSign”:”VK3XV\/P”,”Class”:”SHIRES”,”Location”:”MO3 – Moira Shire Council”,”alDay”:”1″,”alTime”:”2017-06-11 00:00:00″,”Freq”:”7.100″,”MODE”:”SSB”,”Comments”:”Rover section  –   VK Shires Contest”,”Alerter”:”VK3VTH”}]

ALERT

Keyword 

  • ALERT

This will provide the ability POST an alert. 

  • {“actClass”:”WWFF”,”actCallsign”:”vk3arh”,”actSite”:”VKFF-0619″,”mode”:”SSB”,”freq”:”7.095″,”comments”:”Test%20alert%20from%20vk3arh”,”userID”:”testing”,”APIKey”:”ABCDE12345″,”alDate”:”2017-01-17″,”optDate”:”0″,”optTime”:”0″}

Same call format as for sending a spot however additional information is required to sort out the proposed time of activation.

“alDate”:”2016-01-07″,”optDate”:”0″,”optTime”:”0″

Required

Variables are case sensative and if optDate is set then altTime is ignored otherwise required;

NameDescStatusNotes
actClassClass for SpotRSOTA WWFF SHIRES Shires SANPCPA KRMNPA
actSiteSite keyRVKFF-0024,VK1/AC-001,AS3
modemodeRSSB,CW
freqFrequencyR7.144,7.032,14.062
actCallsignactivator CallsignRCallsign of the activator
userIDID of user making spotR
APIKeyKey fro user authenticationRAPI Key is required for this feature. Users API key is available on the sites User Option page. 
commentsCommentsR120 characters max
optDayday timing codeRSupports broad time alerts; All Day  Morning Afternoon Evening Overnight
alDateDate of AlertODate of activation in YYYY-MM-DD -> 2016-01-07
alTimeTime of AlertOUTC time of activation in HH:MM -> 00:00

Examples of setting an Alert;

  • curl –header ‘content-type:application/json’ -X POST –data ‘{“actClass”:”WWFF”,”actCallsign”:”vk3arh”,”actSite”:”VKFF-0619″,”mode”:”SSB”,”freq”:”7.095″,”comments”:”Test%20alert%20from%20vk3arh”,”userID”:”testing”,”APIKey”:”ABCDE12345″,”alDate”:”2017-06-17″,”optDate”:”0″,”optTime”:”0″}’ http://parksnpeaks.org/api/ALERT/DEBUG

Returns – This is a POST request

Host: parksnpeaks.org

User-Agent: curl/7.43.0

Accept: */*

Content-Type: application/json

Content-Length: 220

print_r – stdClass Object

(

    [actClass] => WWFF

    [actCallsign] => vk3arh

    [actSite] => VKFF-0619

    [mode] => SSB

    [freq] => 7.095

    [comments] => Test%20alert%20from%20vk3arh

    [userID] => testing

    [APIKey] => ABCDE12345

    [alDate] => 2017-06-17

    [optDate] => 0

    [optTime] => 0

)

in setupAlert.

Passed -> {“actClass”:”WWFF”,”actCallsign”:”vk3arh”,”actSite”:”VKFF-0619″,”mode”:”SSB”,”freq”:”7.095″,”comments”:”Test%20alert%20from%20vk3arh”,”userID”:”test”,”APIKey”:”ABCD1234″,”alDate”:”2017-06-17″,”optDate”:”0″,”optTime”:”0″}about to display passed variables.

actClass:WWFF

actCallsign:vk3arh

actSite:VKFF-0619

mode:SSB

freq:7.095

comments:Test%20alert%20from%20vk3arh

userID:testing

APIKey:ABCDE12345

alDate:2017-06-17

optDate:0

optTime:0

Success!

DELETE

Allows the user to delete an entry they own

Requires API Key to verify

  • Supports the following entries by entry ID
    • SPOT
    • ALERT
    • REQUEST

Example

  • www.parksnpeaks.org/api/DELETE/SPOT/535371/USERID/APIKEY01

Locations

Location keywords return site information in JSON by class;

  • SUMMIT
  • PARK    
  • SHIRE
  • SITES   

Additional information is required so isolate what site or sites you are looking for. Examples of location requests;

  • VK3 SOTA – http://parksnpeaks.org/api/SUMMIT/VK3
  • VK3 SOTA VN region – http://parksnpeaks.org/api/SUMMIT/VK3/VN
  • Single Summit – http://parksnpeaks.org/api/SUMMIT/VK3/VN-001
  • All VK5 WWFF parks – http://parksnpeaks.org/api/PARK/WWFF/VK5
  • Single Park – http://parksnpeaks.org/api/PARK/WWFF/VKFF-1000
  • Shires in VK3 – http://parksnpeaks.org/api/SHIRE/VK3

The SITES command will return JSON on all sites (Currently VK & ZL) sutiable for filling lookup boxs’ ;

  • SITES
AwardIDNameState
KRMNPA3NP-008ChurchillVK3
SANPCPA5CP-001AberdourVK5
WWFFVKFF-0994Aberdour VK5
SOTAVK1/AC-001Bimberi PeakVK1
SHIRESAC2Albury City CouncilVK2

SITES supports sub commands to allow for update to site data.

  • SITES
    • CHECK
    • WWFF
    • SOTA
    • KRMNPA
    • SANPCPA
    • SHIRES

CHECK returns the dates of last update;

  • parksnpeaks.org/api/SITES/CHECK
    • {“Class”:”SOTA”,”LastUpdate”:”24\/04\/2017″},{“Class”:”WWFF”,”LastUpdate”:”24\/04\/2017″}]

whilst the commands WWFF,SOTA,KRMNPA,SANPCPA or SHIRES returns the data for only that Class;

  • parksnpeaks.org/api/SITES/WWFF
    • [{“Award”:”WWFF”,”ID”:”VKFF-0567″,”Name”:”Amery Station (ANARE)”,”State”:”VK0″,”Latitude”:”-69.7500″,”Longitude”:”71.0000″},{“Award”:”WWFF”,”ID”:”VKFF-0568″,”Name”:”Davis Station (ANARE)”,”State”:”VK0″,”Latitude”:”-68.5763″,”Longitude”:”77.9688″},{“Award”:”WWFF”,”ID”:”VKFF-0569″,”Name”:”Douglas Mawson Station (ANARE)”,”State”:”VK0″,”Latitude”:”-67.6000″,”Longitude”:”62.8666″},{“Award”:”WWFF”,”ID”:”VKFF-0565″,”Name”:”Heard and McDonald Islands”,”State”:”VK0″,”Latitude”:”-53.1333″,”Longitude”:”73.0000″},{“Award”:”WWFF”,”ID”:”VKFF-0570″,”Name”:”lonospherical Research Station (ANARE)”,”State”:”VK0″,”Latitude”:”-80.3666″,”Longitude”:”77.3666″},{“Award”:”WWFF”,”ID”:”VKFF-0566″,”Name”:”Macquarie Island Station (ANARE)”,”State”:”VK0″,”Latitude”:”-54.5000″,”Longitude”:”158.9500″},{“Award”:”WWFF”,”ID”:”VKFF-0571″,”Name”:”Richard Casey Station (ANARE)”,”State”:”VK0″,”Latitude”:”-66.2818″,”Longitude”:”110.5276″},{“Award”:”WWFF”,”ID”:”VKFF-0572″,”Name”:”Wilkes Station (ANARE)”,”State”:”VK0″,”Latitude”:”-66.2571″,”Longitude”:”110.5256″},{“Award”:”WWFF”,”ID”:”VKFF-0833″,”Name”:”Aranda Bushland”,”State”:”VK1″,”Latitude”:”-35.2690″,”Longitude”:”149.0805″}, and so on

Location Data

This group of commands will provide information as to sites for a given location.

Given a position (latitude & longitude) exact information (Local Government Area or Gridsquare) or lists of sites surrounding the position can be obtained.

Keywords 

  • SUMMITID
  • SHIRESID
  • SITESHIRESID
  • GRIDSQUARE
  • PARKS 
  • PEAKS
  • CLOSE

Location keywords require Latitude and Longitude and will return site information as a string,

  • SUMMITID
  • SHIRESID
  • GRIDSQUARE

SHIRESID returns the ID for the given cordinates

  • http://www.parksnpeaks.org/api/SHIRESID/-37.5666/144.0166
    • Returns – MZ3

SITESHIRESID returns the ID of a site if known.

     NOTE: Requires SiteID not Lat / Long

  • http://www.parksnpeaks.org/api/SITESHIRESID/VKFF-2348
    • Returns – SG3
  • http://www.parksnpeaks.org/api/SITESHIRESID/VK1/AC-001
    • Returns – CT1

GRIDSQUARE returns 6 digit gridsquare for the given cordinates.

  •  http://www.parksnpeaks.org/api/GRIDSQUARE/-35.65944000/148.795000
    • Returns – QF44ji

SUMMITID returns the SOTA Summit within 125 meters of the given cordinates.

  • http://parksnpeaks.org/api/SUMMITID/-35.65944000/148.790000
    • Returns – (VK1/AC-001) Bimberi Peak
  • http://parksnpeaks.org/api/SUMMITID/-35.65944000/148.795000
    • Returns – No SOTA reference within 125 metres

PARKID returns the WWFF Park within 5km meters of the given cordinates.

  • http://parksnpeaks.org/api/PARKID/-37.5721/149.3627
    • Returns – (VKFF-0618) Alfred National Park.

The next group of location keywords again require Latitude and Longitude and optionally Distance in km, will return site information as JSON.

  • PARKS
  • PEAKS 
  • CLOSE

PARKS returns JSON with the IDs and name of Parks within distance or by default 80Km of the given coordinates.

  • http://www.parksnpeaks.org/api/PARKS/-37.6833/144.0167/
    • Returns – [{“siteID”:”VKFF-0757″,”SANPCPAID”:””,”KRMNPAID”:””,”siteName”:”Enfield”,”siteDistance”:”24.8km WSW”},{“siteID”:”VKFF-0964″,”SANPCPAID”:””,”KRMNPAID”:””,”siteName”:”Creswick”,”siteDistance”:”25.4km NNW”},{“siteID”:”VKFF-0055″,”SANPCPAID”:””,”KRMNPAID”:”3NP-005″,”siteName”:”Brisbane Ranges”,”siteDistance”:”26.3km SE”},{“siteID”:”VKFF-0775″,”SANPCPAID”:””,”KRMNPAID”:””,”siteName”:”Werribee Gorge”,”siteDistance”:”30.2km E”},{“siteID”:”VKFF-0763″,”SANPCPAID”:””,”KRMNPAID”:””,”siteName”:”Lerderderg”,”siteDistance”:”34.2km ENE”},{“siteID”:”VKFF-0968″,”SANPCPAID”:””,”KRMNPAID”:””,”siteName”:”Hepburn”,”siteDistance”:”43.5km NNE”},{“siteID”:”VKFF-0982″,”SANPCPAID”:””,”KRMNPAID”:””,”siteName”:”You Yangs”,”siteDistance”:”45.8km SE”},{“siteID”:”VKFF-0972″,”SANPCPAID”:””,”KRMNPAID”:””,”siteName”:”Macedon”,”siteDistance”:”59.5km NE”},{“siteID”:”VKFF-0627″,”SANPCPAID”:””,”KRMNPAID”:”3NP-035″,”siteName”:”Organ Pipes”,”siteDistance”:”66.2km E”}]

PEAKS returns JSON with the IDs and name of Peaks within distance or by default 80Km of the given coordinates.

  • curl –request GET ‘http://www.parksnpeaks.org/api/PEAKS/-37.6833/144.0167/25’
    • Returns – [{“siteID”:”VK3\/VC-018″,”siteName”:”Mt Buninyong”,”siteDistance”:”8.6km WNW”},{“siteID”:”VK3\/VC-019″,”siteName”:”Mt Warrenheip”,”siteDistance”:”12.9km NNW”}]

CLOSE returns JSON containing WWFF Parks and SOTA Peaks within 80Km. Maximum of 5 entries for each class are returned for a maximum of 10 entries despite distance. This command is intended to allow quick list of opportunities in the surrounding area.

CLOSE requires the given coordinates either Lat then Long or 6 figure Grid square

For detailed list of sites use direct class requests PARKS or PEAKS.

  • curl –request GET ‘http://parksnpeaks.org/api/CLOSE/-37.6833/144.0167’
    • Returns – [{“awardID”:”SOTA”,”siteID”:”VK3\/VC-018″,”siteName”:”Mt Buninyong”,”siteDistance”:”8.6km WNW”},{“awardID”:”SOTA”,”siteID”:”VK3\/VC-019″,”siteName”:”Mt Warrenheip”,”siteDistance”:”12.9km NNW”},{“awardID”:”WWFF”,”siteID”:”VKFF-0757″,”siteName”:”Enfield SP”,”siteDistance”:”24.8km WSW”},{“awardID”:”WWFF”,”siteID”:”VKFF-0964″,”siteName”:”Creswick REP”,”siteDistance”:”25.4km NNW”},{“awardID”:”WWFF”,”siteID”:”VKFF-0055″,”siteName”:”Brisbane Ranges NP”,”siteDistance”:”26.3km SE”},{“awardID”:”SOTA”,”siteID”:”VK3\/VC-032″,”siteName”:”VK3\/VC-032″,”siteDistance”:”29.7km NE”},{“awardID”:”WWFF”,”siteID”:”VKFF-0775″,”siteName”:”Werribee Gorge SP”,”siteDistance”:”30.2km E”},{“awardID”:”SOTA”,”siteID”:”VK3\/VC-020″,”siteName”:”Forest Hill”,”siteDistance”:”32.6km N”},{“awardID”:”WWFF”,”siteID”:”VKFF-0763″,”siteName”:”Lerderderg SP”,”siteDistance”:”34.2km ENE”},{“awardID”:”SOTA”,”siteID”:”VK3\/VC-021″,”siteName”:”Mt Kooroocheang\/Smeaton Hill”,”siteDistance”:”43.0km N”}]
  • curl –request GET ‘http://parksnpeaks.org/api/CLOSE/QF22ah’
    • Returns – [{“awardID”:”SOTA”,”siteID”:”VK3\/VC-018″,”siteName”:”Mt Buninyong”,”siteDistance”:”8.6km WNW”},{“awardID”:”SOTA”,”siteID”:”VK3\/VC-019″,”siteName”:”Mt Warrenheip”,”siteDistance”:”12.9km NNW”},{“awardID”:”WWFF”,”siteID”:”VKFF-0757″,”siteName”:”Enfield SP”,”siteDistance”:”24.8km WSW”},{“awardID”:”WWFF”,”siteID”:”VKFF-0964″,”siteName”:”Creswick REP”,”siteDistance”:”25.4km NNW”},{“awardID”:”WWFF”,”siteID”:”VKFF-0055″,”siteName”:”Brisbane Ranges NP”,”siteDistance”:”26.3km SE”},{“awardID”:”SOTA”,”siteID”:”VK3\/VC-032″,”siteName”:”VK3\/VC-032″,”siteDistance”:”29.7km NE”},{“awardID”:”WWFF”,”siteID”:”VKFF-0775″,”siteName”:”Werribee Gorge SP”,”siteDistance”:”30.2km E”},{“awardID”:”SOTA”,”siteID”:”VK3\/VC-020″,”siteName”:”Forest Hill”,”siteDistance”:”32.6km N”},{“awardID”:”WWFF”,”siteID”:”VKFF-0763″,”siteName”:”Lerderderg SP”,”siteDistance”:”34.2km ENE”},{“awardID”:”SOTA”,”siteID”:”VK3\/VC-021″,”siteName”:”Mt Kooroocheang\/Smeaton Hill”,”siteDistance”:”43.0km N”}]

User

USERS with no arguments will return the user table in JSON

  • http://parksnpeaks.org/api/users/
    • Returns –  [{“callSign”:”VK3ARH”,”name”:”Allen”},{“callSign”:”VK5AYL”,”name”:”Sue”}]

USERS passed a callsign will return name for a given callsign

  • http://parksnpeaks.org/api/users/VK3ARH
    • Returns – [{“callSign”:”VK3ARH”,”name”:”Allen”}]

Debug option and Examples

VERSION will return the current version

  • http://parksnpeaks.org/api/version
    • Returns – 1.0 (c) Allen Harvie 2017

‘DEBUG’  appended to the request will return debug info and log the request for review later.

  • http://parksnpeaks.org/api/sota/rss/debug

Examples

Using GET to test SITES data;

  • http://parksnpeaks.org/api/SITES/DEBUG
  • curl –request GET ‘http://parksnpeaks.org/api/SITES’

Using CURL to verify PUT

  • curl –request PUT ‘http://parksnpeaks.org/api/SITES’

Using HTTP GET to test receiving current SPOT activity in RSS

  • http://www.parksnpeaks.org/api/SPOTS/DEBUG

Using CURL to test ALERT via POST

  • curl –header ‘content-type:application/json’ -X POST –data ‘{“actClass”:”WWFF”,”actCallsign”:”vk3arh”,”actSite”:”VKFF-0619″,”mode”:”SSB”,”freq”:”7.095″,”comments”:”Test%20alert%20from%20vk3arh”,”userID”:”testing”,”APIKey”:”ABCDE12345″,”alDate”:”2017-01-17″,”optDate”:”0″,”optTime”:”0″}’ http://parksnpeaks.org/api/ALERT/DEBUG

Using CURL to test SPOT via POST

  • curl –header ‘content-type:application/json’ -X POST –data ‘{“actClass”:”WWFF”,”actCallsign”:”vk3arh”,”actSite”:”VKFF-0619″,”mode”:”SSB”,”freq”:”7.095″,”comments”:”Test%20spot%20from%20vk3arh”,”userID”:”testing”,”APIKey”:”ABCDE12345″}’ http://parksnpeaks.org/api/SPOT/DEBUG

Using CURL to test SPOT with PUT

  • curl –request PUT ‘http://parksnpeaks.org/api/DEBUG/SPOT’ –data ‘{“actClass”:”WWFF”,”actCallsign”:”vk3arh”,”actSite”:”VKFF-0619″,”mode”:”SSB”,”freq”:”7.095″,”comments”:”Test%20spot%20from%20vk3arh”,”userID”:”testing”,”APIKey”:”ABCDE12345″}’ –header ‘content-type:application/json’

Location Testing

  • http://parksnpeaks.org/api/PARKID/-37.5721/149.3627 – (VKFF-0618) Alfred National Park.
  • http://parksnpeaks.org/api/PARKID/-38.1144/141.4400 – (VKFF-0728) Cobboboonee National Park.
  • http://www.parksnpeaks.org/api/SHIRESID/-37.5666/144.0166 – (MZ3) Moorabool Shire Council
  • http://www.parksnpeaks.org/api/SHIRESID/-38.1144/141.4400 – (GL3) Glenelg Shire Council
  • http://parksnpeaks.org/api/SUMMITID/-35.65944000/148.790000 – (VK1/AC-001) Bimberi Peak.

These cordinates should return ‘Currently not within a Park.’ else there are entries in the database with GISID =”.

  • http://parksnpeaks.org/api/PARKID/-38.05653854/145.38711821
    • Returns – Currently not within a Park.

Other Links;

  • To Do list – http://parksnpeaks.org/todo.html
  • Return sent JSON – http://parksnpeaks.org/api/testJSON.php?json={%22A%22:1,%22B%22:2,%22C%22:3,%22D%22:4,%22E%22:5}
  • Test API to SotaWatch – http://parksnpeaks.org/api/testSOTAAPI.php
  • Audio and Environment – http://parksnpeaks.org/testAudio.php
  • Test 1 Download
  • Test 2 Download
Table of Contents