Merge pull request #240 from plantbreeding/issue-164

standardized location documentation
plantbreeding · Apr 18, 2018 · d4e53ca · d4e53ca
2 parents 7b2c951 + c62180b
commit d4e53ca
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 19 deletions.
diff --git a/Specification/GeneralInfo/Location_Encoding.md b/Specification/GeneralInfo/Location_Encoding.md
@@ -1,5 +1,16 @@
 
 ### Location coordinate encoding
 
-To encode locations as coordinates, the ISO 6709 standard is used. Importantly, the decimal notation is used. Example
-latitude: +40.20361, longitude: -075.00417. Note that plus and minus signs are always required, and latitude has two digits before the decimal separator (with leading zeroes when necessary), and longitude has three digits.
+To encode locations as coordinates, the ISO 6709 standard is used, degree notation only. WGS84 is used as the geodetic datum spatial reference system.
+
+||Unit|Format|Example|
+|---|---|---|---|
+|latitude|degrees|±DD.D|"+40.20361"|
+|longitude|degrees|±DDD.D|"-075.00417"|
+|altitude|meters|±M|"+127"|
+
+Note:
+ + Plus and minus signs are always required
+ + Latitude has two digits before the decimal separator (with leading zeros when necessary)
+ + Longitude has three digits before the decimal separator (with leading zeros when necessary)
+ + Altitude is recorded in meters above the WGS84 reference ellipsoid (no leading zeros) 
diff --git a/Specification/Locations/ListLocations.md b/Specification/Locations/ListLocations.md
@@ -55,9 +55,9 @@ Get a list of locations.
                         "abbreviation": "IB",
                         "countryCode": "NGA",
                         "countryName": "Nigeria",
-                        "latitude": -21.5,
-                        "longitude": 165.5,
-                        "altitude": 12,
+                        "latitude": "+9.0820",
+                        "longitude": "+8.6753",
+                        "altitude": "+12",
                         "instituteName": "INRA - GDEC",
                         "instituteAddress": "route foo, Clermont Ferrand, France",
                         "additionalInfo": 
@@ -73,9 +73,9 @@ Get a list of locations.
                         "abbreviation": "GO",
                         "countryCode": "IND",
                         "countryName": "India",
-                        "latitude": 28.36,
-                        "longitude": 77.12,
-                        "altitude": 10,
+                        "latitude": "+17.3850",
+                        "longitude": "+78.4867",
+                        "altitude": "+515",
                         "additionalInfo": {
                             "name1" : "value1",
                             "name2" : "value2"

diff --git a/Specification/Locations/LocationDetails.md b/Specification/Locations/LocationDetails.md
@@ -33,9 +33,9 @@ Get details for a location.
                     "abbreviation": "IB",
                     "countryCode": "NGA",
                     "countryName": "Nigeria",
-                    "latitude": -21.5,
-                    "longitude": 165.5,
-                    "altitude": 12,
+                    "latitude": "+9.0820",
+                    "longitude": "+8.6753",
+                    "altitude": "+12",
                     "instituteName": "INRA - GDEC",
                     "instituteAddress": "road foo, nigeria",
                     "additionalInfo": 

diff --git a/Specification/README.md b/Specification/README.md
@@ -204,8 +204,17 @@ Timestamp UTC|yyyy-MM-ddThh:mm:ssZ|2017-06-16T20:47:23Z
 
 ### Location coordinate encoding
 
-To encode locations as coordinates, the ISO 6709 standard is used. Importantly, the decimal notation is used. Example
-latitude: +40.20361, longitude: -075.00417. Note that plus and minus signs are always required, and latitude has two digits before the decimal separator (with leading zeroes when necessary), and longitude has three digits.
+To encode locations as coordinates, the ISO 6709 standard is used, degree notation only.
+
+||Format|Example|
+|---|---|---|
+|latitude|±DD.D|"+40.20361"|
+|longitude|±DDD.D|"-075.00417"|
+
+Note:
+ + Plus and minus signs are always required
+ + Latitude has two digits before the decimal separator (with leading zeroes when necessary)
+ + Longitude has three digits before the decimal separator (with leading zeroes when necessary)
 
 
 ### Search Services

diff --git a/Specification/Studies/Studies_GET.md b/Specification/Studies/Studies_GET.md
@@ -38,9 +38,9 @@ More linked data:
 | location.instituteName  | string          | Study location institute/laboratory name                |          |
 | **deprecated** location.instituteAdress| string          | **Use location.instituteAddress**        |          |
 | location.instituteAddress| string          | Study location institute/laboratory address            |          |
-| location.latitude       | number          | Study location latitude                                 |          |
-| location.longitude      | number          | Study location longitude                                |          |
-| location.altitude       | number          | Study location altitude in meters                       |          |
+| location.latitude       | string          | Study location latitude                                 |          |
+| location.longitude      | string          | Study location longitude                                |          |
+| location.altitude       | string          | Study location altitude in meters                       |          |
 | location.additionalInfo | object          | Additional arbitrary info on the study location         |          |
 | contacts                | array of object | List of study contacts                                  |          |
 | contacts.contactDbId    | string          | Study contact database identifier                       |          |
@@ -100,9 +100,9 @@ More linked data:
                     "countryName": "Nigeria",
                     "instituteName"; "INRA - GDEC",
                     "instituteAddress"; "route foo, Clermont Ferrand, France",
-                    "latitude": -21.5,
-                    "longitude": 165.5,
-                    "altitude": 12,
+                    "latitude": "+9.0820",
+                    "longitude": "+8.6753",
+                    "altitude": "+12",
                     "additionalInfo": {
                         "AnnualMeanRain": "value",
                         "SoilDescription": "23",