Email: CS/ADU no: Password:  

CWAC API reference: public data access functions


Available calls

/cards/single/get
/cards/single/list
/dictionary/get
/DwC
/site/boundary/get
/site/cards/list
/site/information/get
/sites/list

Function Call: /cards/single/get

Description: Retrieve the full data of a CWAC survey by card number

Call: http://api.adu.org.za/cwac/cards/single/get

Call type: SELECT

Call method: GET

Call parameters: card: cwac survey card number

Call example:

http://api.adu.org.za/cwac/cards/single/get?card=508082

Call example return:

{
  "header": {
    "ID": "17435",
    "Card": "508082",
    "Loc_Code": "25202830",
    "startDate": "2019-07-31",
    "Season": "W",
    "TimeStart": "10h00",
    "TimeEnd": "12h39",
    "Compiler": "1764",
    "CountType": "4",
    "Shoreline": "100",
    "OpenWater": "100",
    "WetlandCondition": "3",
    "CountCondition": "4",
    "TotalCount": "2",
    "Notes": "",
    "tstamp": "2019-09-25",
    "Unusable": null,
    "Error_code": null,
    "NoCount": "0",
    "Survey_notes": null,
    "api": "api"
  },
  "status": {
    "result": "success",
    "notes": "Card call successful"
  },
  "siteinfo": {
    "Loc_Code": "25202830",
    "Loc_Code_Alias": "25202830",
    "Loc_Web_Allowed": "Yes",
    "Loc_Web_Date": "2009-01-07",
    "QDGC": "2528DB",
    "Name": "Leeuwfontein Drainage",
    "Near_Town": "KWA-PHAKE",
    "CWAC_Status": "REGISTERED-COUNTED REGULARLY",
    "Data_Ownership": "Gauteng Department of Agriculture, Conservation and Environment",
    "Compiler": "1764",
    "Province": "Gauteng",
    "Area": "",
    "Date_registered": "2006-07-28",
    "Brief_description": "Five dams and a borrow pit comprise the main waterbird habitat on Leeuwfontein Collaborative Nature Reserve.",
    "Physical_features": "",
    "Hydrological_features": "",
    "Ecological_features": "",
    "Conservation_status": "UNKNOWN",
    "Management_status": "UNKNOWN",
    "PA_name": "",
    "IBA_Code": "",
    "Ramsar_Code": "",
    "Ramsar_Parent": "",
    "Heritage_Code": "",
    "FP_Photos": null,
    "Gen_notes": "",
    "Last_Updated": "2009-08-03",
    "ID": "600",
    "X": "28.6162",
    "Y": "-25.3676",
    "Country": "South Africa"
  },
  "observers": [
    
  ],
  "records": [
    {
      "count_id": "357429",
      "card": "508082",
      "spp": "89",
      "count": "2",
      "breeding": "0",
      "pairs": "0",
      "api": "api",
      "taxon": {
        "order": "Anseriformes",
        "Family": "Anatidae",
        "Genus": "Alopochen",
        "Species": "aegyptiacus",
        "Common_group": "Goose",
        "Common_species": "Egyptian",
        "iucn_status": ""
      }
    },
    {
      "count_id": "357430",
      "card": "508082",
      "spp": "245",
      "count": "1",
      "breeding": "0",
      "pairs": "0",
      "api": "api",
      "taxon": {
        "order": "Charadriiformes",
        "Family": "Charadriidae",
        "Genus": "Vanellus",
        "Species": "armatus",
        "Common_group": "Lapwing",
        "Common_species": "Blacksmith",
        "iucn_status": ""
      }
    }
  ]
}

Function Call: /cards/single/list

Description:

A summary of the species reported for a CWAC site during survey.

Field descriptions:

  • "ref": CWAC species reference number,
  • "common": Common name,
  • "taxonomic": Taxonomic name,
  • "mn": Maximum number recorded on a survey,
  • "mx": Minumim number recorded on a survey when present,
  • "av": Average number recorded on a survey,
  • "ramsar": The number of birds required to meet RAMSAR status,
  • "global_iba": The number of birds required to meet GLOBAL IBA status,
  • "subregional_iba": The number of birds required to meet SUBREGIONAL IBA status,
  • "wet_intl": The Wetlands interantional code of the species

Call: http://api.adu.org.za/cwac/cards/single/list

Call type: SELECT

Call method: GET

Call parameters: locationcode: CWAC assigned location code for the site

Call example:

http://api.adu.org.za/cwac/cards/single/list?locationcode=27123242

Call example return:

// 20190926165333
// http://api.adu.org.za/cwac/cards/single/list?locationcode=27123242

{
  "data": {
    "list": [
      {
        "ref": "212",
        "common": "Coot, Red-knobbed",
        "taxonomic": "Fulica cristata",
        "mn": "6",
        "mx": "6",
        "av": "6.0000",
        "ramsar": "10000",
        "global_iba": "5000",
        "subregional_iba": "2500",
        "wet_intl": "FULCR"
      },
      {
        "ref": "50",
        "common": "Cormorant, Reed",
        "taxonomic": "Phalacrocorax africanus",
        "mn": "8",
        "mx": "138",
        "av": "55.0000",
        "ramsar": "10000",
        "global_iba": "5000",
        "subregional_iba": "2500",
        "wet_intl": "PHAAF"
      },
      {
        "ref": "203",
        "common": "Crake, Black",
        "taxonomic": "Amaurornis flavirostris",
        "mn": "24",
        "mx": "24",
        "av": "24.0000",
        "ramsar": null,
        "global_iba": null,
        "subregional_iba": null,
        "wet_intl": "PORFL"
      }
    ],
    "status": {
      "result": "success",
      "notes": "Site list call successful"
    }
  }
}

Function Call: /dictionary/get

Description: A dictionary of all the codes used in the CWAC data

Call: http://api.adu.org.za/cwac/dictionary/get

Call type: SELECT

Call method: GET

Call parameters: N/A

Call example:

http://api.adu.org.za/cwac/dictionary/get

Call example return:

This call returns all the lookup references for the various fields, as well as as basic site list and the CWAC species list

Function Call: /DwC

Description: A Darwin Core data extraction (JSON format). 2 Options are offered, extract by location code or extract by species code

Call: http://api.adu.org.za/cwac/DwC

Call type: SELECT

Call method: GET

Call parameters: location code as last element of the url (/locationcode/27123242); or species code as last element (/species/305)

Call example:

http://api.adu.org.za/cwac/DwC/locationcode/27123242

Call example return:

{
  "meta": {
    "call_date": "1569506737",
    "verbatum date": "2019-09-26 16:05:37"
  },
  "status": {
    "result": "success",
    "comment": "Species reference list ",
    "records": 83
  },
  "data": [
    {
      "institutionCode": "ADU",
      "collectionCode": "CWAC",
      "datasetName": "Coordinated Waterbird Counts",
      "basisOfRecord": "HumanObservation",
      "recordNumber": "4641:6",
      "catalogNumber": "urn:catalog:adu:CWAC:4641-6",
      "year": "2002",
      "month": "7",
      "day": "13",
      "verbatimEventDate": "2002-07-13",
      "collectedBy": "Mr A. Sutherland",
      "occurenceRemarks": "Count type: 4, Shoreline covered: 75%, Openwater covered: 65%, wetland condition: 2, Count condition: 4, Total count: 711",
      "eventRemarks": null,
      "kingdom": "Animalia",
      "phylum": "Chordata",
      "class": "Aves",
      "order": "Ciconiiformes",
      "family": "Podicipedidae",
      "genus": "Tachybaptus",
      "specificEpithet": "ruficollis",
      "locus": "2732BA",
      "verbatimLocality": "Vasi Pan (27123242)",
      "decimalLongitude": "32.7046",
      "decimalLatitude": "-27.2059",
      "stateProvince": "KwaZulu-Natal",
      "country": "South Africa",
      "continent": "Africa",
      "individualCount": "25"
    },
    {
      "institutionCode": "ADU",
      "collectionCode": "CWAC",
      "datasetName": "Coordinated Waterbird Counts",
      "basisOfRecord": "HumanObservation",
      "recordNumber": "4641:50",
      "catalogNumber": "urn:catalog:adu:CWAC:4641-50",
      "year": "2002",
      "month": "7",
      "day": "13",
      "verbatimEventDate": "2002-07-13",
      "collectedBy": "Mr A. Sutherland",
      "occurenceRemarks": "Count type: 4, Shoreline covered: 75%, Openwater covered: 65%, wetland condition: 2, Count condition: 4, Total count: 711",
      "eventRemarks": null,
      "kingdom": "Animalia",
      "phylum": "Chordata",
      "class": "Aves",
      "order": "Ciconiiformes",
      "family": "Phalacrocoracidae",
      "genus": "Phalacrocorax",
      "specificEpithet": "africanus",
      "locus": "2732BA",
      "verbatimLocality": "Vasi Pan (27123242)",
      "decimalLongitude": "32.7046",
      "decimalLatitude": "-27.2059",
      "stateProvince": "KwaZulu-Natal",
      "country": "South Africa",
      "continent": "Africa",
      "individualCount": "138"
    }
  ]
}

Function Call: /site/boundary/get

Description: Retrieve the boundary polygon coordinates for a CWAC location

Call: http://api.adu.org.za/cwac/site/boundary/get

Call type: SELECT

Call method: GET

Call parameters: locationcode: CWAC assigned location code for the site

Call example:

http://api.adu.org.za/cwac/site/boundary/get?locationCode=32481810

Call example return:

{
  "site": [
    {
      "id": "155",
      "sitecode": "32481810",
      "sitename": "Berg River 2: Cerebos Saltpans",
      "coordinates": " 18.168568038367766,-32.79841778778893,0 18.168811275054395,-32.7881888381259,0 18.167229501335896,-32.78852778969453,0 18.16598779799085,-32.78891934813372,0 18.164774398776217,-32.7892856465754,0 18.16335957235367,-32.78940878694402,0 18.162140634523666,-32.78947723746513,0 18.16025135070572,-32.78939318520727,0 18.158181822040206,-32.78983335480653,0 18.156832873022722,-32.79042709770519,0 18.15586415027633,-32.79115973225259,0 18.154739527710262,-32.7920487561904,0 18.153870108302044,-32.79274515295484,0 18.152661255064913,-32.79342656497721,0 18.151235769754862,-32.79368995775833,0 18.149779759399962,-32.79366610119428,0 18.14888723996046,-32.79317723357558,0 18.14818710315842,-32.79269706717777,0 18.1480276618895,-32.79215887115229,0 18.147637318803163,-32.79140630678959,0 18.147033229541535,-32.79097099397814,0 18.1464775952777,-32.7905378427219,0 18.14583533575319,-32.78993747117092,0 18.144854154774066,-32.78932207405772,0 18.144005558432355,-32.78891680849129,0 18.143030419919455,-32.78822025580286,0 18.141963607082516,-32.78739642728378,0 18.141081850240653,-32.78675363054964,0 18.14085457087822,-32.78658251698472,0 18.140221539192794,-32.78561624868819,0 18.140092962742642,-32.78512939971379,0 18.13682216156053,-32.7887899254246,0 18.139539372932063,-32.78841181293436,0 18.138576015100853,-32.79054079061547,0 18.137769865457017,-32.79260523537396,0 18.137304702427514,-32.79360284203828,0 18.13698470896304,-32.79449522660534,0 18.13620222995098,-32.79592615128076,0 18.13787655771489,-32.79595249130489,0 18.13835936073201,-32.79682334486996,0 18.139243680836216,-32.79757849124021,0 18.140507311426518,-32.7981649292696,0 18.141145560114182,-32.79881972392717,0 18.139939774508093,-32.80187867856225,0 18.140057578973142,-32.8025346351985,0 18.13941941502287,-32.80422223846662,0 18.14019946898702,-32.80406063806701,0 18.141026621947844,-32.80168126260054,0 18.142161430498504,-32.79969467754774,0 18.143462074387458,-32.79879014817294,0 18.145850469229117,-32.79869001910165,0 18.14959728629492,-32.7984995601696,0 18.15097716400635,-32.7979795105292,0 18.153417856194665,-32.79799158805923,0 18.153585692174147,-32.79705082506295,0 18.15443107288729,-32.79721556980594,0 18.155314602473823,-32.79758543316884,0 18.156402615446723,-32.7983116930986,0 18.15759253082922,-32.79914483058398,0 18.158437819752862,-32.79942851663191,0 18.161082026271174,-32.79939347538384,0 18.164802762386785,-32.79918315959631,0 18.166460276505745,-32.79898125353422,0 18.168551245670983,-32.79907928400528,0 18.168568038367766,-32.79841778778893,0",
      "gate1": "18.16824056091309,-32.798682770903795,0",
      "gate2": "18.139487280273443,-32.785370564616635,0",
      "gate3": "",
      "info_office": "18.16755391540528,-32.79743821817735,0",
      "api": "api"
    }
  ],
  "status": {
    "result": "success",
    "notes": "Site coordinates call successful"
  }
}

Function Call: /site/cards/list

Description: List oll th ecrads submitted for a CWAC site

Call: http://api.adu.org.za/cwac/site/cards/list

Call type: SELECT

Call method: GET

Call parameters: locationcode: CWAC assigned location code for the site

Call example:

http://api.adu.org.za/cwac/site/cards/list?locationCode=32481810

Call example return:

{
  "cards": [
    {
      "ID": "16927",
      "Card": "507591",
      "Loc_Code": "32481810",
      "startDate": "2019-02-03",
      "Season": "S",
      "TimeStart": "09:50",
      "TimeEnd": "13:40",
      "Compiler": "107",
      "CountType": "1",
      "Shoreline": "60",
      "OpenWater": "90",
      "WetlandCondition": "1",
      "CountCondition": "5",
      "TotalCount": "1634",
      "Notes": "",
      "tstamp": "2019-02-04",
      "Unusable": null,
      "Error_code": null,
      "NoCount": "0",
      "record_status": "Accepted",
      "Survey_notes": null,
      "api": "api"
    }
  ],
  "status": {
    "result": "success",
    "notes": "Site coordinates call successful"
  }
}

Function Call: /site/information/get

Description: Retrieve the available site information for a CWAC site

Call: http://api.adu.org.za/cwac/site/information/get

Call type: SELECT

Call method: GET

Call parameters: locationcode: CWAC assigned location code for the site

Call example:

http://api.adu.org.za/cwac/site/information/get?locationCode=32481810

Call example return:

{
  "site": [
    {
      "Loc_Code": "32481810",
      "Loc_Code_Alias": "32481812",
      "Loc_Web_Allowed": "Yes",
      "Loc_Web_Date": "2008-04-16",
      "QDGC": "3218CC",
      "Name": "Berg River 2: Cerebos Saltpans",
      "Near_Town": "VELDDRIF",
      "CWAC_Status": "REGISTERED-COUNTED REGULARLY",
      "Data_Ownership": "Private",
      "Compiler": "1899",
      "Province": "Western Cape",
      "Area": null,
      "Date_registered": "1994-01-16",
      "Brief_description": "An IBA. The lower reaches and mouth of the Berg River, incorporating the open estuary, mudflats and lagoon, various saltpans, permanent marshes and riparian reedbeds, floodplains at Kruispad, Langrietvlei and Kersfontein, the Kliphoek River, and Doornfontein pan. A very important wetland system, with large concentrations of many waterbird species in summer and winter, with globally significant numbers of seven species, nationally significant numbers of six more, and large counts of White Pelican, cormorants, ibises, waterfowl, Blacksmith Plover, Avocet and terns. Saltpans are being enlarged at the expense of mud flats and reedbeds (Kliphoek). Other important threats include boating, water- skiing, dam construction (Kliphoek River), and gill net fishing; there is some pollution and hunting.",
      "Physical_features": null,
      "Hydrological_features": null,
      "Ecological_features": null,
      "Conservation_status": "UNPROTECTED",
      "Management_status": "PRIVATE LAND",
      "PA_name": null,
      "IBA_Code": "SA104 - LOWER BERG RIVER WETLANDS",
      "Ramsar_Code": null,
      "Ramsar_Parent": null,
      "Heritage_Code": null,
      "FP_Photos": null,
      "Gen_notes": "Keith Harrison taken over from Michael Byrnes as compiler from Jan 2003",
      "Last_Updated": "2008-01-31",
      "ID": "205",
      "X": "18.1594",
      "Y": "-32.7954",
      "Country": "South Africa",
      "api": "api"
    }
  ],
  "status": {
    "result": "success",
    "notes": "Site information call successful"
  }
}

Function Call: /sites/list

Description: Retrieve a full list of all the active CWAC sites registered in the system

Call: http://api.adu.org.za/cwac/sites/list

Call type: SELECT

Call method: GET

Call parameters: province: name of the province of intersest. (Options: Northern Province, Mpumalanga, North West, Gauteng, KwaZulu-Natal, Free State, Northern Cape, Western Cape, Eastern Cape, Kenya, Angola, Tanzania, Limpopo)

Call example:

http://api.adu.org.za/cwac/sites/list?province=western%20cape

Call example return:

[
  {
    "Loc_code": "26192720",
    "Name": "Abe Bailey Nature Reserve: Mooirivier Loop 1",
    "Province": "Gauteng",
    "counts": "31",
    "FirstCount": "2001-07-14",
    "LatestCount": "2019-02-19"
  },
  {
    "Loc_code": "26212716",
    "Name": "Abe Bailey Nature Reserve: Mooirivier Loop 2",
    "Province": "Gauteng",
    "counts": "29",
    "FirstCount": "2001-07-14",
    "LatestCount": "2018-08-07"
  },
  {
    "Loc_code": "26212715",
    "Name": "Abe Bailey Nature Reserve: Mooirivier Loop 3",
    "Province": "Gauteng",
    "counts": "26",
    "FirstCount": "2003-02-08",
    "LatestCount": "2018-08-07"
  },
  {
    "Loc_code": "26182830",
    "Name": "Anglo Reserve",
    "Province": "Gauteng",
    "counts": "36",
    "FirstCount": "1999-07-26",
    "LatestCount": "2019-07-28"
  }
]

FITZ logo Ramsar Wetlands International http://www.sanbi.org/

Sunday 19 September 2021 01:44
FitzPatrick Institute of African Ornithology
Department of Biological Sciences - University of Cape Town

Creative Commons License
This work is licensed under a
Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License